Você está na página 1de 557

SmartPlant Instrumentation Administration

Users Guide

Version 2007.3 (8.0)

September 2007

DINS-08.00.0001D

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

Restricted Rights Legend


Use, duplication, or disclosure by the government is subject to restrictions as set forth below. For civilian agencies:
This was developed at private expense and is restricted computer software submitted with restricted rights in
accordance with subparagraphs (a) through (d) of the Commercial Computer Software - Restricted Rights clause at
52.227-19 of the Federal Acquisition Regulations (FAR) and its successors, and is unpublished and all rights are
reserved under the copyright laws of the United States. For units of the Department of Defense (DoD): This is
commercial computer software as defined at DFARS 252.227-7014 and the rights of the Government are as
specified at DFARS 227.7202-3.
Unpublished rights reserved under the copyright laws of the United States.
Intergraph Corporation
Huntsville, Alabama 35894-0001

Warranties and Liabilities


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

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

Table of Contents

Table of Contents
Preface...............................................................................................................................14
Working with Administration Module: An Overview .................................................15
SmartPlant Instrumentation Database Setup for Oracle: An Overview....................16
SmartPlant Instrumentation Database Setup for SQL Server: An Overview...........17
Setting Up a SmartPlant Instrumentation Database Common Tasks ........................18
SQL Server Database Server Filegroups for SmartPlant Instrumentation........................ 19
Set Up a SmartPlant Instrumentation Database for SQL Server....................................... 21
Oracle Database Server Tablespaces for SmartPlant Instrumentation.............................. 23
Set Up a SmartPlant Instrumentation Database for Oracle............................................... 26
Create a SmartPlant Instrumentation Database by Running the DB Setup SQL
Script File.......................................................................................................................... 29

Domain Backup: An Overview .......................................................................................30


Domain Backup Common Tasks ................................................................................32
Back Up a Domain............................................................................................................ 32
Back Up a Domain from the Command Line ................................................................... 33

Backing up Files Containing Audit Trail Data: An Overview ....................................36


Backing up Audit Trail Data on Oracle: An Overview ..............................................37
Back Up Files When Creating a New Database on Same Oracle Server.......................... 38
Back Up Files When Moving a Database from One Oracle Server to Another................ 38

Backing up Audit Trail Data on SQL Server: An Overview......................................39


Back Up Files Containing Audit Trail Data on SQL Server............................................. 40

Backing up Audit Trail Data on Sybase Adaptive Server Anywhere: An


Overview.....................................................................................................................41
Back Up Files on Sybase Adaptive Server Anywhere...................................................... 42

Domain Initialization: An Overview ..............................................................................43


Prerequisites for Domain Initialization ............................................................................. 44

Domain Initialization Common Tasks........................................................................46


Add User-Defined Database Views .................................................................................. 47
Initialize an Empty Domain in Sybase Adaptive Server Anywhere ................................. 48
Initialize a Domain in Sybase Adaptive Server Anywhere Using Another Domain
as a Source ........................................................................................................................ 50
Initialize an Empty Domain in Oracle .............................................................................. 52
Initialize a Domain in Oracle Using Another Domain as a Source .................................. 56
Initialize an Empty Domain in SQL Server ...................................................................... 59
Initialize a Domain in SQL Server Using Another Domain as a Source .......................... 62

SmartPlant Instrumentation Administration Users Guide 3

Table of Contents
Initialize a Domain from the Command Line ................................................................... 66
Initialization Log Files...................................................................................................... 68

Domain Deletion Common Tasks ..............................................................................69


Delete a Domain ............................................................................................................... 70
Delete an Invalid Domain on Oracle................................................................................. 71
Delete an Invalid Domain on SQL Server ........................................................................ 72

Troubleshooting Domain Initialization Common Tasks ............................................73


Handle an Initialization Failure ........................................................................................ 74
Workaround for the ORA-01722 Error............................................................................. 75
Workaround for the Grant to View Creation Error........................................................... 76

Backing Up and Restoring Projects: An Overview ......................................................78


Backing Up and Restoring Projects Common Tasks..................................................79
Back Up a Project ............................................................................................................. 80
Specify Log File Path for Project Backup ........................................................................ 81
Restore a Project ............................................................................................................... 81
Specify Log File Path for Restoring a Project .................................................................. 82

Accessing the Administration Module Common Tasks .............................................84


Log on as System Administrator....................................................................................... 85
Log on as Domain Administrator ..................................................................................... 86
Switch from System Administration to Domain Administration...................................... 86
Switch from Domain Administration to System Administration...................................... 87

Create and Manage User Profiles and Departments Common Tasks.........................88


Create and Manage Departments ...................................................................................... 89
Define a SmartPlant Instrumentation User ....................................................................... 90
Assign a Domain Administrator ....................................................................................... 92

User Groups: An Overview ........................................................................................93


Users and Groups Common Tasks .............................................................................94
Create a New Group.......................................................................................................... 95
Modify the Profile of a Group .......................................................................................... 96
Delete a Group .................................................................................................................. 96
Assign Users to Groups .................................................................................................... 97
Remove Users from Groups.............................................................................................. 98

Windows Authentication Logon Method: An Overview............................................99


Create a Group for Windows Authentication Logon Method......................................... 100
Remove Deleted Windows Users from SmartPlant Instrumentation User Groups ........ 101
Workflow of Switching to a Different Logon Method ................................................... 102

System Administration: An Overview .........................................................................103


System Administration Common Tasks ...................................................................104
Domain Management Common Tasks .....................................................................106
Create an Operating Owner Domain............................................................................... 107
Make Domain Definitions............................................................................................... 109
Enable Cable Type Dependency ..................................................................................... 111
Enable Workflow ............................................................................................................ 112
Activate the Audit Trail Functionality ............................................................................ 113
Enable Item Registry....................................................................................................... 113
Specify a Global Path...................................................................................................... 114

4 SmartPlant Instrumentation Administration Users Guide

Table of Contents
Activity Tracking Management Common Tasks......................................................115
Set the Activity Tracking Mode...................................................................................... 116
Clear Activity Tracking Data.......................................................................................... 116
Generate a Grid-Style Activity Tracking Report ............................................................ 117
Generate a Graph-Style Activity Tracking Report ......................................................... 118

Database Security Common Tasks ...........................................................................120


Change System Administrator Password........................................................................ 121
Encrypt the Admin Schema Logon Password................................................................. 121
Encrypt All User Passwords ........................................................................................... 122
Set Security Options ....................................................................................................... 122

Database Locking Mode (for Multi-User Versions).................................................123


Set Database Locking Mode ........................................................................................... 124

Maintaining the SmartPlant Instrumentation Database ............................................125


General Database Maintenance Common Tasks ......................................................126
Define Databases for Logging On to SmartPlant Instrumentation ................................. 127
Rebuild Default Views in Domains ................................................................................ 129
Rebuild Stored Procedures and Triggers ........................................................................ 130
Rebuild Catalog Tables................................................................................................... 131

Database Maintenance on SQL Server Common Tasks...........................................132


Add a Filegroup .............................................................................................................. 133
Add a Datafile to the TEMPDB Database ...................................................................... 133
Print Filegroup Information ............................................................................................ 134
Add a Log File ................................................................................................................ 134
Optimize Indexes ............................................................................................................ 135

Database Maintenance on Oracle Common Tasks ...................................................136


View Tablespace Data .................................................................................................... 137
Add Datafiles to Oracle Tablespaces .............................................................................. 137
Optimize Indexes ............................................................................................................ 138
Update Statistics ............................................................................................................. 139

Accounting, Contractors, and Clients Common Tasks.............................................140


Add and Manage Accounting Information ..................................................................... 140
Add and Manage Contractors ......................................................................................... 141
Add and Manage Clients................................................................................................. 142
Associate Accounting, Client, and Contractor Information with a Domain ................... 143
Import Interface Languages ............................................................................................ 143
Print Database Connection Information.......................................................................... 145
Report Generation (System Administration) .................................................................. 145

Domain Administration: An Overview........................................................................146


Domain Administration Common Tasks ..................................................................147
Plant Design: An Overview ...........................................................................................149
Plant Design and Structure Common Tasks .............................................................151
Create a Plant Hierarchy ................................................................................................. 152
Define a <Plant> Owner ................................................................................................. 153
Create a Plant Hierarchy Item on the Highest Level....................................................... 154
Create a Plant Hierarchy Item on an Intermediate Level................................................ 155
Create a Plant Hierarchy Item on the Lowest Level ....................................................... 156
Delete a Plant Hierarchy Item......................................................................................... 157

SmartPlant Instrumentation Administration Users Guide 5

Table of Contents
Operating Owner Domain (As-Built and Projects): An Overview ...........................158
Flow of Activities for Defining a Project Administrator..........................................159
Operating Owner Domain (As-Built and Projects) Common Tasks ........................160
Create a Project ............................................................................................................... 162
Assign User Groups to a Project ..................................................................................... 164
Select a Project Logo When the Domain Type is Operating Owner .............................. 165
Make As-Built Definitions.............................................................................................. 166
Display Formats of Item Categories ............................................................................... 166
Modify the Display Format for an Item Category .......................................................... 167
Copy the Display Format from Another Project............................................................. 168
Reserve Tags and Loops for a Project or As-Built ......................................................... 168
Generate Reserved Items Report .................................................................................... 170
Set the Project Status for an Integrated Environment ..................................................... 170
Rebuild a Project............................................................................................................. 171

Off-Site Project Creation and Implementation: An Overview..................................172


Off-Site Project Implementation Workflow .............................................................173
Off-Site Project Creation Prerequisites ....................................................................174
Off-Site Project Restrictions.....................................................................................175
Import an Off-Site Project .............................................................................................. 177
Specify Log File Path for Importing an Off-Site Project................................................ 178

Project Deletion Common Tasks ..............................................................................180


Delete a Single Project.................................................................................................... 181
Delete Data from a Single Project .................................................................................. 182
Delete Projects or Project Data in Batch Mode .............................................................. 182

Explorer Windows: An Overview ................................................................................183


Working with Explorer Windows Common Tasks ..................................................184
Search for Items .............................................................................................................. 185
Find a Specific Item in the Tree View ............................................................................ 186
Filter the Display of Items in an Explorer Window........................................................ 187
Filter Cables .................................................................................................................... 189
Filter Loops According to Blocks................................................................................... 192
Add Items to My List in the Items Pane ......................................................................... 194

Scoping Data for Projects: An Overview.....................................................................195


Settings and Conditions for Claiming Items.............................................................197
Scoping Data for Projects Common Tasks...............................................................203
Display Items in the As-Built Explorer........................................................................... 205
Display Items in the Source Project Explorer................................................................. 206
Set Preferences for the Scope of a Project ...................................................................... 207
Copy Items to the Claim Buffer...................................................................................... 208
Copy Items to the Target Project Buffer......................................................................... 209
Generate Reports of Items Copied to the Buffer............................................................. 210
Remove Items from the Buffer ....................................................................................... 211
Claim Items from the Buffer........................................................................................... 212
Claim Items Directly from the As-Built Explorer or Source Project Explorer............... 213
Claim As-Built Items from the Command Line.............................................................. 214

6 SmartPlant Instrumentation Administration Users Guide

Table of Contents
Prerequisites for Claiming Documents ........................................................................... 215
Claim Documents ........................................................................................................... 216
Show Projects Containing Claimed Items ...................................................................... 217

Merging Project and As-Built Data: An Overview.....................................................218


Open the Project Explorer and Merge Buffer ................................................................. 220
Item and Sub-Item Selection Options for Merging with As-Built.................................. 220

Generating Reports for Merging Data Common Tasks............................................222


Generate Comparison List Reports ................................................................................. 223
Generate Reports of Changed Items ............................................................................... 224
Generate Reports of Changed Documents ...................................................................... 225
Generate Reports of Items Copied to the Merge Buffer ................................................. 225

Copy Items to the Merge Buffer Common Tasks.....................................................226


Copy All Items to the Merge Buffer as Merge Now....................................................... 227
Copy Selected Items to the Merge Buffer as Merge Now .............................................. 227
Copy All Items to the Merge Buffer as Release Claim................................................... 228
Copy Selected Items to the Merge Buffer as Release Claim .......................................... 228
Remove Items from the Merge Buffer............................................................................ 229

Merging Project and As-Built Data Common Tasks................................................230


Set Preferences for Merging Project Items with As-Built .............................................. 232
Compare Project Data with As-Built Data...................................................................... 232
Item Comparison Options ............................................................................................... 234
Actions for Merging Items.............................................................................................. 235
Specify an Action for Merging a Group of Items ........................................................... 236
Merge Items from the Merge Buffer............................................................................... 238
Merge Items Directly from the Project Explorer ............................................................ 239
Merge Items from the Command Line............................................................................ 240

Naming Conventions: An Overview.............................................................................241


Compatibility with Instrumentation Standards ............................................................... 242

Naming Conventions Common Tasks ......................................................................243


Notes for Creating Naming Conventions for Wiring Items ............................................ 244
Define Naming Conventions........................................................................................... 245
Copy Naming Conventions to Other <Units> ................................................................ 248
Copy Naming Conventions from Another <Unit> ......................................................... 249
Document Number Naming Convention Examples........................................................ 249
Generate Naming Convention Reports ........................................................................... 252

Wire End Naming Conventions: An Overview ...........................................................253


Wire End Naming Conventions Common Tasks......................................................254
Enable the Use of Wire End Naming Conventions......................................................... 254
Define Wire End Naming Conventions .......................................................................... 254
Duplicate Wire End Naming Conventions...................................................................... 256
Modify Wire End Naming Conventions ......................................................................... 256
Delete Wire End Naming Conventions........................................................................... 257

SmartPlant Instrumentation Administration Users Guide 7

Table of Contents

Access Rights: An Overview .........................................................................................258


Access Rights Common Tasks .................................................................................259
Access Rights Descriptions............................................................................................. 260
Grant Access Rights for Selected Items or Activities..................................................... 270
Grant the Same Access Rights for All Items .................................................................. 271
Workflow Access Rights ................................................................................................ 272
Copy Access Rights ........................................................................................................ 274
View the Items in the Current Domain ........................................................................... 274
Generate Access Rights Report ...................................................................................... 275

Preferences Management: An Overview .....................................................................276


Managing Preferences Common Tasks ....................................................................277
Set Domain Preferences.................................................................................................. 278
Set Project Preferences ................................................................................................... 279
Copy Project Preferences................................................................................................ 280
Export Preferences .......................................................................................................... 281
Import Preferences .......................................................................................................... 281

Managing Reports: An Overview.................................................................................282


Managing Reports Common Tasks ..........................................................................283
Associate a New Title Block with a Report.................................................................... 284
Title Block Descriptions ................................................................................................. 285
Set Archiving Options for Report Comparison............................................................... 287
Define Report Revision Management Settings............................................................... 289

Working with Add-Ins: An Overview..........................................................................290


Working with Add-Ins Common Tasks....................................................................291
Import Hook-Up Libraries .............................................................................................. 293
Import System Interfaces ................................................................................................ 294
Import Browser Views.................................................................................................... 295
Import DCS Hardware I/O Library Data ........................................................................ 296
Import DDP Library Data for PDS ................................................................................. 297
Export Macros................................................................................................................. 298
Import Macros................................................................................................................. 299

Miscellaneous Domain Administration Tasks..........................................................300


Define Panel Location Levels ......................................................................................... 302
Assign Icons to Telecom Device Types.......................................................................... 303
Define Custom Fields ..................................................................................................... 304
Sequence Numbers and Process Data Custom Fields ..................................................... 305
Copy Custom Fields........................................................................................................ 306
Browsers That Can Contain Custom Fields.................................................................... 306
Define Custom Tables..................................................................................................... 309
Generate Domain Administration Reports...................................................................... 309
Select a Logo .................................................................................................................. 311
Define Field Personnel Profiles ...................................................................................... 312
Modify Domain Notes .................................................................................................... 312
Modify Printer Settings................................................................................................... 313

8 SmartPlant Instrumentation Administration Users Guide

Table of Contents
Managing Audit Trail Data: An Overview..................................................................314
Managing Audit Trail Data Common Tasks ............................................................315
Load Audit Trail Data..................................................................................................... 316
Trim Audit Trail Data ..................................................................................................... 317
External Files with Trimmed Audit Trail Data ............................................................... 318
Define Paths When Using Oracle ................................................................................... 318
Define Paths When Using SQL Server ........................................................................... 319
Define Paths When Using Sybase Adaptive Server Anywhere ...................................... 320

Clearing Locking: An Overview...................................................................................321


Clearing Locking Common Tasks ............................................................................322
Clear Locking per User................................................................................................... 323
Clear Blocked Sessions on Oracle .................................................................................. 323
Clear Blocking Sessions on SQL Server......................................................................... 324
Clear Locking in All Sessions......................................................................................... 324
Clear SmartPlant Instrumentation Session Records........................................................ 324

Copying Data: An Overview .........................................................................................325


Copying Data Common Tasks..................................................................................326
Copy Data from Another Lowest Plant Hierarchy Item ................................................. 327
Set Options for Copying Specific Data........................................................................... 328
Set Options for Copying All Module Data ..................................................................... 330
Set Wiring Naming Options for Target Plant Hierarchy Item ........................................ 331
Set Revisions for Target Plant Hierarchy Item ............................................................... 332

SmartPlant Instrumentation KKS Overview..............................................................334


Flow of Activities for Working in KKS Mode.........................................................338
System Administrator Activities..................................................................................... 338
Domain Administrator Activities.................................................................................... 338
Import Utility Activities.................................................................................................. 339

Define KKS Naming Convention Using KKS Segments.........................................340


Example of a KKS Naming Convention for Loops ........................................................ 341
Loop Number Representation in the Domain Explorer of SmartPlant
Instrumentation ............................................................................................................... 341

Configuring SmartPlant Instrumentation for Integration .........................................343


Integration Common Tasks.......................................................................................344
Configure SmartPlant Instrumentation for Integration ................................................... 344
Define an IDEAL User ................................................................................................... 347
Retrieve a Plant Hierarchy .............................................................................................. 348
Register a Plant ............................................................................................................... 349
Define Settings for an Integrated Environment .............................................................. 350

Item Registry Activities: An Overview ........................................................................351


Item Registry Activities Common Tasks..................................................................352
Register Items ................................................................................................................. 352
Clean Up Item Registry .................................................................................................. 353

Tool Requirements for Integrating SmartPlant Instrumentation ..............................354

SmartPlant Instrumentation Administration Users Guide 9

Table of Contents
General Integration Requirements .................................................................................. 354
Naming Convention Integration Requirements .............................................................. 355
Working with SmartPlant P&ID ..................................................................................... 359
Working with SmartPlant Electrical ............................................................................... 361
Using Projects in an Integrated Environment ................................................................. 363
Naming Convention Mapping......................................................................................... 364

SmartPlant Instrumentation Interface Language: An Overview .............................365


Working with the Interface Language Common Tasks............................................366
Edit Interface Text Phrases ............................................................................................. 367
Replace the Interface Language with a Language from the Database ............................ 368
Replace the Interface Language with a Language from an External File ....................... 368
Create New Customized Text Phrases ............................................................................ 369
Prefixes and Suffixes in the Interface Text..................................................................... 370

Commands and Controls...............................................................................................372


Access Rights Window Toolbar ..................................................................................... 372
Access Rights Window ................................................................................................... 373
Accounting Dialog Box .................................................................................................. 375
Active Database Connections Dialog Box...................................................................... 375
Activity Tracking Report Settings (Graph) Dialog Box ................................................. 376
Activity Tracking Report Settings (Grid) Dialog Box.................................................... 378
Add Accounting Dialog Box .......................................................................................... 379
Add Client Dialog Box ................................................................................................... 379
Add Contractor Dialog Box ............................................................................................ 380
Add Database Views Dialog Box ................................................................................... 380
Add Datafiles (SQL Server) Dialog Box ........................................................................ 380
Add Datafiles (Oracle) Dialog Box ................................................................................ 382
Admin Schema Password Encryption Dialog Box ......................................................... 383
Administration Window.................................................................................................. 383
Advanced Domain Preferences Dialog Box ................................................................... 384
Advanced Filter Definition (Cables) Dialog Box ........................................................... 385
Advanced Filter Definition (Loops) Dialog Box ............................................................ 386
Advanced Project Preferences Dialog Box..................................................................... 388
<Area> Properties Dialog Box ....................................................................................... 389
Assign Groups to Project Dialog Box............................................................................. 391
Assign Users to Groups Dialog Box ............................................................................... 392
Back Up Domain Dialog Box ......................................................................................... 393
Backup Repository Dialog Box ...................................................................................... 394
Change Password Dialog Box ........................................................................................ 395
Clear Activity Tracking Data Dialog Box ...................................................................... 396
Clear Locking in Selected Sessions Dialog Box............................................................. 396
Client Dialog Box ........................................................................................................... 397
Colors Dialog Box .......................................................................................................... 398
Comparison List Dialog Box .......................................................................................... 399
Comparison List Filter Dialog Box................................................................................. 400
Comparison List Report Dialog Box .............................................................................. 402
Contractor Dialog Box.................................................................................................... 402
Copy Data from Source Dialog Box ............................................................................... 403
Copy Access Rights Dialog Box..................................................................................... 408

10 SmartPlant Instrumentation Administration Users Guide

Table of Contents
Copy From Dialog Box................................................................................................... 409
Copy from Project Dialog Box ....................................................................................... 409
Copy from Project Dialog Box ....................................................................................... 409
Copy Naming Conventions From Dialog Box................................................................ 409
Copy Naming Conventions Dialog Box ......................................................................... 410
Copy to Projects Dialog Box .......................................................................................... 410
Custom Fields Dialog Box.............................................................................................. 411
Custom Tables Dialog Box............................................................................................. 413
Database Upgrade Dialog Box........................................................................................ 413
Data Files to Delete Manually Dialog Box..................................................................... 414
Delete Invalid Domain Dialog Box ................................................................................ 415
Delete Projects Dialog Box............................................................................................. 416
Department Dialog Box .................................................................................................. 417
Domain Data and Indexes Dialog Box ........................................................................... 417
Dimensional Data Settings Dialog Box .......................................................................... 419
Domain Administration Window.................................................................................... 420
Domain Definition Window (Domain Administration).................................................. 420
Domain Definition Window Toolbar (Domain Administration) .................................... 424
Domain Definition Window (System Administration) ................................................... 425
Domain Definition Window Toolbar (System Administration) ..................................... 430
Domain Tablespace Definition Dialog Box.................................................................... 431
List of Duplicate Items Dialog Box ................................................................................ 432
Edit Translation Text Dialog Box................................................................................... 433
Items and Activities for Access Rights Dialog Box ....................................................... 434
Export Macros Dialog Box ............................................................................................. 434
Field Personnel Profile Dialog Box ................................................................................ 435
Filegroup List Dialog Box .............................................................................................. 435
Filter Definition Dialog Box........................................................................................... 436
Find Item Dialog Box ..................................................................................................... 438
Generate Access Rights Report Dialog Box ................................................................... 438
Global Access Rights Dialog Box .................................................................................. 440
Group Dialog Box........................................................................................................... 441
Import Browser Views Dialog Box ................................................................................ 443
Import DCS Hardware I/O Library Dialog Box ............................................................. 444
Import DDP Library Data for PDS Dialog Box.............................................................. 444
Import Hook-Up Library Dialog Box ............................................................................. 445
Import Interface Language Dialog Box .......................................................................... 445
Import Macros Dialog Box ............................................................................................. 446
Import System Interfaces Dialog Box............................................................................. 446
Initialize (Oracle) Dialog Box ........................................................................................ 447
Initialize (SQL Server) Dialog Box ................................................................................ 449
Load Audit Trail Data Dialog Box ................................................................................. 451
Log File Dialog Box ....................................................................................................... 452
Naming Conventions Dialog Box................................................................................... 453
Microsoft SQL Server Connection Dialog Box.............................................................. 456
Open Administration Module Dialog Box...................................................................... 457
Optimize Indexes (Oracle) Dialog Box .......................................................................... 457
Optimize Indexes (SQL Server) Dialog Box .................................................................. 458
Oracle Server Connection Dialog Box............................................................................ 459
Owner Dialog Box .......................................................................................................... 460
Page Setup Dialog Box ................................................................................................... 460

SmartPlant Instrumentation Administration Users Guide 11

Table of Contents
Panel Location Levels Dialog Box ................................................................................. 461
Plant Hierarchy Dialog Box............................................................................................ 462
Plant Hierarchy Explorer ................................................................................................ 464
<Plant> Properties Dialog Box ....................................................................................... 466
Preferences for Scoping and Merging Data Dialog Box................................................. 468
Preferences Management Dialog Box............................................................................. 475
Preferences Management (General) Dialog Box ............................................................ 477
Print Options ................................................................................................................... 480
Print Preview Dialog Box ............................................................................................... 481
Project Activities Dialog Box ......................................................................................... 482
Rebuild Catalog Tables Dialog Box ............................................................................... 486
Rebuild Default Views in Domains Dialog Box............................................................. 487
Rebuild Projects in Domain Dialog Box......................................................................... 488
Rebuild Stored Procedures and Triggers Dialog Box ..................................................... 489
Remove Deleted Windows Users Dialog Box................................................................ 489
Report Management Dialog Box .................................................................................... 490
Required Wiring Equipment Report Dialog Box............................................................ 494
Reserve Tags and Loops Dialog Box.............................................................................. 494
Scope Definition Dialog Box.......................................................................................... 496
Search Dialog Box .......................................................................................................... 497
Security Options Dialog Box .......................................................................................... 498
Select Columns for Sorting Dialog Box ......................................................................... 499
Select Columns for Viewing Dialog Box ....................................................................... 499
Select Item Types for Comparison Dialog Box .............................................................. 500
Select Item Types for Reports Dialog Box ..................................................................... 500
Select Language Dialog Box .......................................................................................... 501
Select Logo Dialog Box.................................................................................................. 501
Select Dialog Box ........................................................................................................... 502
Select Dialog Box ........................................................................................................... 503
Select Plant ..................................................................................................................... 503
Select Plant ..................................................................................................................... 503
Select Source Database Dialog Box ............................................................................... 504
Select Source for Claiming Dialog Box.......................................................................... 505
Select Target Database Dialog Box ................................................................................ 506
Set Color Dialog Box...................................................................................................... 507
Source Data Connection Dialog Box .............................................................................. 507
System Administration Window..................................................................................... 510
Tablespace List Dialog Box............................................................................................ 510
Target Database Parameters (Oracle) Dialog Box .......................................................... 511
Target Database Parameters (SQL Server) Dialog Box.................................................. 512
Target Revisions Dialog Box.......................................................................................... 515
Telecom Device Panel Icons Dialog Box ....................................................................... 516
To Do List Dialog Box ................................................................................................... 516
Trim Audit Trail Data Dialog Box.................................................................................. 517
<Unit> Properties Dialog Box ........................................................................................ 518
Update Statistics Dialog Box .......................................................................................... 521
User-Defined Database Views Dialog Box .................................................................... 521
User (Domain Administration) Dialog Box.................................................................... 522
User (System Administration) Dialog Box..................................................................... 523
Initialize (Sybase Adaptive Server Anywhere) Dialog Box ........................................... 524
Wire End Naming Conventions Dialog Box................................................................... 526

12 SmartPlant Instrumentation Administration Users Guide

Table of Contents
Wire End Naming Convention Properties Dialog Box ................................................... 527
Wiring Item Naming Options Dialog Box...................................................................... 529
Zoom............................................................................................................................... 530
As-Built Explorer............................................................................................................ 531
Claim Buffer ................................................................................................................... 533
Claimed Items ................................................................................................................. 535
Merge Buffer................................................................................................................... 535
Project Explorer .............................................................................................................. 538
Source Project Explorer .................................................................................................. 540
Target Project Buffer ...................................................................................................... 542
Item Indicators ................................................................................................................ 544
Cable Hierarchy Example ............................................................................................... 544
Panel by Category Hierarchy Example........................................................................... 545
Panel by Location Hierarchy Example ........................................................................... 546

Index................................................................................................................................547

SmartPlant Instrumentation Administration Users Guide 13

Preface

Preface
This user's guide describes concepts, procedures, and interface features of the
SmartPlant Instrumentation Administration module.
Send documentation comments or suggestions to PPMdoc@intergraph.com.
4

14 SmartPlant Instrumentation Administration Users Guide

Working with Administration Module: An Overview

Working with Administration Module: An


Overview
The Administration module provides you with administrative tools for keeping track
of your resources and maintaining user access security.
There are two mutually exclusive levels of administration System Administration
and Domain Administration that provide you with a greater degree of control over
security and resource management.
The system must first be set up at the System Administration level before resources
can be allocated at the Domain Administration level.
Related Topics

Accessing the Administration Module Common Tasks, page 84

Domain Administration Common Tasks, page 147

Domain Administration: An Overview, page 146

Operating Owner Domain (As-Built and Projects) Common Tasks,


page 160

System Administration Common Tasks, page 104

System Administration: An Overview, page 103

SmartPlant Instrumentation Administration Users Guide 15

SmartPlant Instrumentation Database Setup for Oracle: An Overview

SmartPlant Instrumentation Database Setup


for Oracle: An Overview
The database setup stage involves configuring SmartPlant Instrumentation database
for your Oracle database server by adding the database schemas,
INTOOLS_ENGINEER role, logon information, and associated database objects into
the Oracle database.
You can also configure the database using an SQL script file which contains the
appropriate database statements. The DB Setup Utility creates the SQL script file at
the end of the configuration process. After the SQL script file is created, you can run
that script file automatically by letting the DB Setup Utility run the file at the end of
the database setup. You can also run that script file manually in the Server Manager
dialog box.
You perform the database setup procedure after you finish installing the Oracle
database server, Oracle client, and SmartPlant Instrumentation for Oracle.
The DB Setup Utility performs the following operations (in the indicated order):
1. Creates Oracle database server tablespaces.
2. Creates the INTOOLS_ENGINEER role and SmartPlant Instrumentation database
schemas containing logon information required for connection to the Oracle
database server.
3. Creates database objects in the Admin schema of SmartPlant Instrumentation and
fills these objects with data that appears in the IN_TEMPL template database,
supplied with SmartPlant Instrumentation.
Note

During the database setup, the INTOOLS_ENGINEER role receives


system privileges and privileges for database objects included in the
Admin schema. These objects are shared for all domains you initialize.
When initializing a new domain, other database schemas of SmartPlant
Instrumentation receive the INTOOLS_ENGINEER role.
Important

If you use an existing Oracle server (where you intend to keep your
database) which was not installed according to the instructions in the
SmartPlant Instrumentation Installation and Upgrade Guide, make sure
the Oracle database parameters comply with the parameters required to
use SmartPlant Instrumentation. See Oracle Database Server Installation
in the SmartPlant Instrumentation Installation and Upgrade Guide for
additional information about the required Oracle server parameters.

16 SmartPlant Instrumentation Administration Users Guide

SmartPlant Instrumentation Database Setup for SQL Server: An Overview

SmartPlant Instrumentation Database Setup


for SQL Server: An Overview
The DB Setup Utility creates an individual SmartPlant Instrumentation database in a
SQL Server instance and enables you to configure this instance for working with
SmartPlant Instrumentation. You perform the database setup procedure after
successfully installing the SQL Server database server, SQL Server client, and
SmartPlant Instrumentation for SQL Server.
The DB Setup Utility performs the following operations (in the indicated order):
1. Creates a SmartPlant Instrumentation database with SQL Server filegroups in the
instance you installed on the SQL Server database server.
2. Creates SmartPlant Instrumentation database schemas and the
INTOOLS_ENGINEER role.
3. Creates logon information at the instance level and associates the logon
information with the SmartPlant Instrumentation database schemas.
4. Creates database objects in the Admin schema of SmartPlant Instrumentation and
fills these objects with data that appears in the IN_TEMPL template database,
supplied with SmartPlant Instrumentation.
Notes

During the database setup, the INTOOLS_ENGINEER role receives


system privileges and privileges for database objects included in the
Admin schema. These objects are shared for all domains you initialize.
When initializing a new domain, other database schemas of SmartPlant
Instrumentation receive the INTOOLS_ENGINEER role.
If your SmartPlant Instrumentation database is created in an SQL Server named
instance, make sure that in the [DATABASE] section of the Intools.ini file the
servername parameter value is as follows:
servername=<Server Windows name>\<named instance>

Related Topics

Domain Initialization: An Overview, page 43

Setting Up a SmartPlant Instrumentation Database Common Tasks,


page 18

SQL Server Database Server Filegroups for SmartPlant Instrumentation,


page 19

SmartPlant Instrumentation Administration Users Guide 17

Setting Up a SmartPlant Instrumentation Database Common Tasks

Setting Up a SmartPlant Instrumentation


Database Common Tasks
The following tasks allow the System Administrator to create and configure a
SmartPlant Instrumentation database for SQL Server or Oracle by running the DB
Setup Utility, supplied with SmartPlant Instrumentation. You can create one
SmartPlant Instrumentation database per database setup session. After a successful
database setup session, you can log on to the Administration module of SmartPlant
Instrumentation as System Administrator and initialize SmartPlant Instrumentation
domains in your database.
Set Up a SmartPlant Instrumentation Database for SQL Server
Use this procedure to run SmartPlant Instrumentation database setup in your SQL
Server instance. You define filegroups and other parameters required for the
SmartPlant Instrumentation database. The setup provides default parameters and
values that you can accept or modify. The default file sizes are recommended as
initial values. When connecting to the SQL Server database, you provide a logon
name and a logon password. This logon information is different from the logon
information required to log on to SmartPlant Instrumentation. You define the SQL
Server database server logon information during this procedure. For more
information, see Set Up a SmartPlant Instrumentation Database for SQL Server,
page 21.
Set Up a SmartPlant Instrumentation Database for Oracle
Use this procedure to run SmartPlant Instrumentation database setup in your Oracle
database server. You define tablespaces and other parameters required for the
SmartPlant Instrumentation database. The setup provides default parameters and
values that you can accept or modify. The default tablespace sizes are recommended
as initial values. When connecting to the Oracle database, you provide a logon name
and a logon password. This logon information is different from the logon information
required to log on to SmartPlant Instrumentation. You define the Oracle database
server logon information during this procedure. For more information, see Set Up a
SmartPlant Instrumentation Database for Oracle, page 26.
Create a SmartPlant Instrumentation Database by Running the DB Setup
SQL Script File
Using this procedure, you set up the SmartPlant Instrumentation database for Oracle
manually, by running an SQL file which the DB Setup Utility generates. This way
you can review and modify (if required) the SmartPlant Instrumentation database
setup parameters, and also perform a step-by-step process of the SmartPlant
Instrumentation database setup. The execution of the SQL file automatically creates
the appropriate tablespaces, the Admin schema, the Administration tables, indexes
and the Administration primary key. For more information, see Create a SmartPlant
Instrumentation Database by Running the DB Setup SQL Script File, page 29.

18 SmartPlant Instrumentation Administration Users Guide

Setting Up a SmartPlant Instrumentation Database Common Tasks

SQL Server Database Server Filegroups for SmartPlant


Instrumentation
An SQL Server filegroup is a logical category that connects a database with operating
system data files. The DB Setup Utility for SQL Server creates the following
filegroup types:

Admin data used for the Administration schema logon settings (see
the following paragraph). The database contains the Admin schema logon
data.

Index data used for the Administration schema logon settings. The
database contains the SmartPlant Instrumentation domain index of a single
domain.

Domain used for the Domain schema logon information. The


database contains domain data of a single domain (there is a different
schema logon setting for each domain).

Index used for the Domain schema logon information.

Log file used internally by SQL Server to resume any previous


sessions that were stopped.

View-Only Domain schema (an individual schema for each domain)

The DB Setup Utility creates SmartPlant Instrumentation domain files using the
following default file values:
Parameter

Admin Datafile

Index Datafile

Log Datafile

Filegroup name:

primary

intools_dba_index

log

Data file name:

intools_pr.db

intools_ix.db

intools_l.db

File size:

15 MB

5 MB

50 MB

Administration data (admin data files and index data files), SmartPlant
Instrumentation database log file and history data are based on four filegroups: two
SmartPlant Instrumentation default filegroups and two SQL Server filegroups. The
SQL Server filegroups cannot be edited. The default total file size in these filegroups
is 70 MB. Each filegroup is based on an auto-extended data file. Such a file
automatically extends to the limits of your disk.

SmartPlant Instrumentation Administration Users Guide 19

Setting Up a SmartPlant Instrumentation Database Common Tasks


The following table lists important statistical data that you can use as a guide when
selecting the domain file sizes (the disc space required for such a domain is 650 MB):
Item Types

Quantity (Average)

Instrument tags

45058

Loops

16616

CAD loop drawing blocks

1381

Device panels

11384

Junction boxes

504

Marshaling racks

45 (208366 total number of terminals)

Cabinets

36

DCSs and PLCs

108

Channels

16880

Specifications

111

P&ID drawings

855

Lines

3132

The above item type quantities populate a domain whose file sizes are as follows:
Admin
Datafile

Admin Index
Datafile

Domain
Datafile

Domain Index
Datafile

Log
Datafile

15 MB

5 MB

350 MB

180 MB

50 MB

Later, if you receive an indication that the available free space in the filegroup is low,
or encounter a message that there is insufficient space while working in SmartPlant
Instrumentation, you need to increase the filegroup size for the appropriate domain.
For details, see Add a Filegroup, page 133.
Notes

Make sure the total file size that you specify does not exceed the available
empty space on your selected disks. The default is 70 MB, which includes
the size of the file for the recommended initial size of the Admin data and
indexes, and SmartPlant Instrumentation database Log file

Each of the file names must be a legal name. Each file name must be
unique within your database. Special characters are not supported.

Related Topics

Setting Up a SmartPlant Instrumentation Database Common Tasks,


page 18

SmartPlant Instrumentation Database Setup for SQL Server: An


Overview, page 17

20 SmartPlant Instrumentation Administration Users Guide

Setting Up a SmartPlant Instrumentation Database Common Tasks

Set Up a SmartPlant Instrumentation Database for SQL


Server
Important
The paths you specify in this procedure refer to the database server local
folders (non-network folders). Do not use network drives or network
server names in the paths.
1. On your Windows Start menu, navigate to the Intergraph SmartPlant
Instrumentation program icons and click DB Setup Utility.

Caution
When starting the DB Setup Utility, the Sybase Adaptive Server
Anywhere database engine starts as well (in minimized mode). Do not
close the database engine, as this causes the database setup process to
stop.
2. On the Microsoft SQL Server Connection dialog box, under Server name, do
one of the following:

Accept the server name (or the instance name if the instance is not the
default instance) that the software retrieves from the Intools.ini file,
created during SmartPlant Instrumentation installation.

Type the required name of the target database server machine or


another named instance to which you want to connect for the
SmartPlant Instrumentation database setup.
3. Under System Administrator logon password, type the appropriate password if
required or leave this field empty if the password is not required.

4. Click Connect to connect to the SQL Server database on your server machine and
open the Target Database Parameters dialog box, where you can set parameters
for the target SmartPlant Instrumentation database and start the database setup
process.
Note
If you changed the Server name setting, when you click Connect, in
the [DATABASE] section of the Intools.ini file, the software changes
the ServerName parameter, and also updates the Server parameter in
the current SQL Server ODBC profile.
5. Under Target database name, type the name of the SmartPlant Instrumentation
database for which you want to run the setup process.

Tip

The SmartPlant Instrumentation database name must be unique within


your SQL Server that you specified on the Microsoft SQL Server
Connection dialog box.

SmartPlant Instrumentation Administration Users Guide 21

Setting Up a SmartPlant Instrumentation Database Common Tasks


6. Under Admin schema, accept the default Admin schema logon name
SPI_DBAMN or modify the name as you require, provided that you type a setting
that is different from the Admin schema logon password.
Tips

The logon name can only start with a letter and may not contain
spaces. You can use an underscore (_) to indicate a space.

If this is the first database setup session for SmartPlant Instrumentation


2007 in the current SQL Server database, the logon name must be
unique in the SQL Server database server.

If this is not the first database setup session, you can use an existing
Admin schema logon name but in this case, you must also use the
existing Admin schema logon password. You can only use an existing
Admin schema logon name if the password in that Admin schema is
different. For example, if in another SmartPlant Instrumentation
database, the Admin schema logon name is IN_DBAMN, and the
password is also IN_DBAMN, you cannot use IN_DBAMN for the
Admin schema in the new SmartPlant Instrumentation database.

If you want to define a new logon name, you must also define a new
logon password, different from the logon name.
7. Accept the default Admin schema logon password SPI_DBA or modify the
password as you require, provided that you type a setting that is different from the
Admin schema logon name.

Tips

The logon password can only start with a letter and may not contain
spaces. You can use an underscore ( _ ) to indicate a space. If you
want to encrypt the password, See Encrypt the Admin Schema Logon
Password, page 121.

If this is the first database setup session for SmartPlant Instrumentation


2007 in the current SQL Server database, the logon password must be
unique in the SQL Server database server.

If this is not the first database setup session, you can either use the
existing Admin schema logon password or type a new password. If
you want to use the existing password, you must also use the existing
logon name. If you want to define a new password, you must also
define a new logon name.

The software automatically converts all the password characters to


upper case. This means that after completing the database setup, if
you need to connect to the SmartPlant Instrumentation database
externally, you must enter the Admin schema logon password using
upper-case characters.

22 SmartPlant Instrumentation Administration Users Guide

Setting Up a SmartPlant Instrumentation Database Common Tasks


8. In the subsequent boxes, accept the default parameters or modify them as needed.
Tips

If you change the default file size definitions, make sure the total file
size that you specify does not exceed the available empty space on
your selected disks. The default is 70 MB, which includes the size of
the file for the recommended initial size of the Admin data and
indexes, and SmartPlant Instrumentation database log file.

Each of the file names must be a legal name.

Each file name must be unique within your database. Special


characters are not supported.
9. Click OK and make sure the database setup process is completed successfully. If
the database setup process is not successful, you cannot use the SmartPlant
Instrumentation database.

Related Topics

Setting Up a SmartPlant Instrumentation Database Common Tasks,


page 18

SmartPlant Instrumentation Database Setup for SQL Server: An


Overview, page 17

SQL Server Database Server Filegroups for SmartPlant Instrumentation,


page 19

Oracle Database Server Tablespaces for SmartPlant


Instrumentation
In the preliminary Oracle database, created during the Oracle server installation, the
DB Setup Utility allocates tablespaces associated with the SmartPlant Instrumentation
Admin schema. Oracle uses these tablespaces to store your SmartPlant
Instrumentation database information. This means that Oracle allocates disk space on
the selected server drive to be used only for your SmartPlant Instrumentation
database. The DB Setup Utility creates three tablespaces (see the table below for
additional information about these tablespaces):

Admin data used for the Admin schema.

Index data used for the Admin schema.

Temporary tablespace used for internal Oracle operations (for


example, sorting). For the temporary operation of Oracle in each domain,
one tablespace is created automatically for all domains during the database
setup.

Each tablespace can contain one or more datafiles. SmartPlant Instrumentation


database keeps your data in the following schemas:

SmartPlant Instrumentation Administration Users Guide 23

Setting Up a SmartPlant Instrumentation Database Common Tasks

Admin schema contains the administration data and indexes.

Domain schema (a separate schema for each domain) contains the


domain and index data of a SmartPlant Instrumentation domain.

View-Only Domain schema (an individual schema for each domain)

The DB Setup Utility creates tablespaces for the Admin schema using the following
tablespace default values:
Parameter

Admin Data Tablespace

Index Data Tablespace

Tablespace name

main_ts

index_main_ts

Database filename:

in_main.db

ix_main.db

Tablespace size

10 MB

ix_main.db

However, you may need to create either larger tablespaces or indexes. During the
lifetime of the instrumentation data, you may also need to increase the size of existing
index tablespace. The following table lists important statistical data which you can
use as a guide when selecting the domain tablespace and index sizes:
Item Types

Quantity (Average)

Instruments

45058

Loops

16616

CAD drawing blocks

1381

Device panels

11384

Junction boxes

504

Marshaling racks

45

Cabinets

36

DCSs and PLCs

108

Channels

16880

Specifications

111

P&ID drawings

855

Lines

3132

24 SmartPlant Instrumentation Administration Users Guide

Setting Up a SmartPlant Instrumentation Database Common Tasks


The above item type quantities populate a domain whose tablespace and index sizes
are as follows:
Admin Data Admin Index
Tablespace Tablespace

Domain Data
Tablespace

Domain Index
Data
Tablespace

Domain
Temporary Data
Tablespace

30 MB

350 MB

180 MB

100 MB
(autoextended)

10 MB

Later on, you may receive an indication that the available free space in the tablespace
is low, or you may encounter a message that there is insufficient space while working
in SmartPlant Instrumentation. If this happens, SmartPlant Instrumentation System
Administrator can increase the size of the tablespace for the specific domain. For
details, see Add Datafiles to Oracle Tablespaces, page 137.
Notes

For better performance, it is highly recommended that you locate the data
tablespaces and index tablespaces on different physical disks. You can
also locate the system file, database tables and the index data on different
physical drives to speed up your work in the Oracle Database. See your
Oracle User Guide for more information.

Each of the file names must be a legal name. Each tablespace name must
be unique within your database.

Related Topics

Setting Up a SmartPlant Instrumentation Database Common Tasks,


page 18

SmartPlant Instrumentation Database Setup for Oracle: An Overview,


page 16

SmartPlant Instrumentation Administration Users Guide 25

Setting Up a SmartPlant Instrumentation Database Common Tasks

Set Up a SmartPlant Instrumentation Database for Oracle


Important

Paths you specify in this procedure refer to the database server local
folders (non-network folders). Do not use network drives or network
server names in the paths.

Make sure you have an available Oracle instance. It is not possible to set
up more than one SmartPlant Instrumentation database in a given Oracle
instance.
1. On your Windows Start menu, navigate to the Intergraph SmartPlant
Instrumentation program icons and click DB Setup Utility.

Caution
When starting the DB Setup Utility, the Sybase Adaptive Server
Anywhere database engine starts as well (in minimized mode). Do not
close the database engine, as this causes the database setup process to
stop.
2. On the Oracle Server Connection dialog box, from the Oracle version list,
select the version of your Oracle server.

3. Under DBMS identifier in the INtools.ini file, accept or change the displayed
compatible DBMS parameter for the Oracle server version that you selected from
the Oracle version list.
Tip
If you want to change the DBMS parameter, make sure it is
compatible with SmartPlant Instrumentation. For more details about
all compatible combinations of Oracle and SmartPlant Instrumentation
versions, see SmartPlant Configuration and Maintenance Guide,
Compatibility of Oracle and SmartPlant Instrumentation Versions.
4. In the Oracle database name box, do one of the following:

Accept displayed database name.

Change the displayed value if it does not match the value you defined
for the DB_NAME parameter in the Oracle Instance Configuration
file.
5. In the Server name box, accept or modify the displayed Oracle server connection
string.

6. In the System Administrator logon password box, accept the given default
value manager (the password is masked), or type the appropriate password.

26 SmartPlant Instrumentation Administration Users Guide

Setting Up a SmartPlant Instrumentation Database Common Tasks


Tip
If you cannot connect to the Oracle database server using the default
password, contact your Oracle Database Administrator, who has rights
to create a new SmartPlant Instrumentation System Administrator
logon password for connection to the Oracle database server.
7. Click Connect to connect to your Oracle database server and open the Target
Database Parameters dialog box, where you can set parameters for the target
SmartPlant Instrumentation database and start the database setup session.

8. Under Admin schema, accept the default Admin schema logon name and
password IN_DBAMN or modify the name or password as needed.
Tip
The logon name must be unique in the Oracle database server. The
logon name and password can only start with a letter and contain no
spaces. You can use an underscore to replace a space. If you want to
encrypt the password, See Encrypt the Admin Schema Logon
Password, page 121.
9. In the Admin data and Admin index sections, accept the default settings or
modify them as needed.

Tips

If you want to create more than four SmartPlant Instrumentation


domains, for the Admin data tablespace, specify a size larger than 25
MB, and for the Admin index tablespace, specify a size larger than 10
MB.

If you change the default tablespace definitions when, for better


performance, it is highly recommended that you locate the data
tablespaces and index tablespaces on different physical disks. You can
also locate the system file, database tables and the index data on
different physical drives to speed up your work in the Oracle Database.
See your Oracle User Guide for more information.

Each of the file names must be a legal name.

Each tablespace name must be unique within your database.


10. In the Admin index section, accept the default settings or modify them as needed.

Tip

If you want to create more than four SmartPlant Instrumentation


domains, for the Admin index tablespace, you need to specify a size
larger than 10 MB.

SmartPlant Instrumentation Administration Users Guide 27

Setting Up a SmartPlant Instrumentation Database Common Tasks


11. Click Run and make sure the database setup process is completed successfully. If
the database setup process is not successful, you cannot use the SmartPlant
Instrumentation database.
Tip

Clicking Create File only generates the Oracle orasetup.log and


orasetup.sql files in the SmartPlant Instrumentation home folder
without carrying out the actual database creation process. See Create
a SmartPlant Instrumentation Database by Running the DB Setup SQL
Script File, page 29 to learn how to run the SQL commands and create
the SmartPlant Instrumentation database on the Oracle database server
manually.

Important
After completing the database setup, contact your Oracle Database Administrator,
who must specify the super user logon password. To specify this password, from
the SQL Plus utility, in the Oracle server database, connect to the sys super user
as sysdba and then run the following command:
grant execute on DBMS_PIPE to public;

We recommend that you specify the super user logon password before initializing
a SmartPlant Instrumentation domain. If you initialize a domain in Oracle 9i
without specifying the super user logon password, the SmartPlant Instrumentation
System Administrator must rebuild stored procedures and triggers before using
the domain. For details, see Rebuild Stored Procedures and Triggers, page 130.
Related Topics
Oracle Database Server Tablespaces for SmartPlant Instrumentation,
page 23

Setting Up a SmartPlant Instrumentation Database Common Tasks,


page 18

SmartPlant Instrumentation Database Setup for Oracle: An Overview,


page 16

28 SmartPlant Instrumentation Administration Users Guide

Setting Up a SmartPlant Instrumentation Database Common Tasks

Create a SmartPlant Instrumentation Database by Running


the DB Setup SQL Script File
1. Run the DB Setup Utility and on the Oracle Server Connection dialog box,
connect to the new Oracle instance.
2. Ensure that the configuration settings file Intools.ini in the SmartPlant
Instrumentation home folder contains the following value of the DBParm
parameter in the [DATABASE] section: 'DBparm=DisableBind=1'
Tip
If 'DisableBind=1' is not the only value of the DBParm parameter,
make sure that it is not enclosed by single quotes and is separated from
other values by a comma. For example,
DBParm=DisableBind=1,PBDBMS=1
3. On the Target Database Parameters dialog box, enter the required values and
click Create File.

4. After the script file is created, make sure that the orasetup.sql file is located in the
SmartPlant Instrumentation home folder.
5. Run the SQL*Plus utility.
6. Connect as the System Manager.
7. In the SQL*Plus utility, run the following set of commands:
SET ECHO OFF
SET SCAN OFF
SPOOL C:\TEMP\ORASETUP.TXT
@<SmartPlant Instrumentation home folder>ORASETUP.SQL
COMMIT;
SPOOL OFF

Related Topics

Oracle Database Server Tablespaces for SmartPlant Instrumentation,


page 23

Setting Up a SmartPlant Instrumentation Database Common Tasks,


page 18

SmartPlant Instrumentation Database Setup for Oracle: An Overview,


page 16

SmartPlant Instrumentation Administration Users Guide 29

Domain Backup: An Overview

Domain Backup: An Overview


It is possible to back up an entire SmartPlant Instrumentation domain to the backup
repository in Sybase Adaptive Server Anywhere. You must use the
INtools_Backup.db databases as the backup repository. INtools_Backup.db is a
Sybase Adaptive Server Anywhere database supplied with SmartPlant
Instrumentation. You can use the INtools_Backup.db even if you do not have a full
version of Sybase Adaptive Server Anywhere database engine. The
INtools_Backup.db database enables you to back up a domain and then use it as a
source for initializing another domain in Oracle or SQL Server. This way, you can
restore the backed up data in another domain in your database platform. You cannot
work in the backed up domain.
If your domain type is Operating owner, and you want to create an off-site project,
you must back up the entire Operating owner domain. For details about off-site
project, see Off-Site Project Creation and Implementation: An Overview, page 172.
To the backup repository, you can only back up data from a single domain.
Therefore, to be able to make several backups, you need to have several copies of
INtools_Backup.db. If you have already used the INtools_Backup.db for a backup
and forgot to make a clean copy of INtools_Backup.db, you can obtain another
INtools_Backup.db from Intergraph Support, and then use it as a master database for
making copies. The name of the clean copy must always be INtools_Backup.db.
The backup repository and its copies are only compatible with the current version of
SmartPlant Instrumentation. After you install a new service pack for the current
version, you can only use the backup repository that is supplied with the service pack.
When you back up a domain, the software records the backup session information in
the InitLog.txt file. The software creates this file in the SmartPlant Instrumentation
home folder when you initialize your first domain, and then, uses this file for
recording information during any subsequent initialization or backup session.
Information in this file includes information about errors that can occur when backing
up data into the Domain schema of the INtools_Backup.db database.
Caution

When backing up a domain, the software does not back up the audit trail
data. Therefore, before performing the domain backup, you must make
sure that you trimmed all the audit trail data. Then, you can back up the
trimmed audit trail data manually. For details, see SmartPlant
Instrumentation Installation and Upgrade Guide, Backup and Restore,
Backing up Files Containing Audit Trail Data.

30 SmartPlant Instrumentation Administration Users Guide

Domain Backup: An Overview


The backup procedure involves the following operations:

Connecting to the target Sybase Adaptive Server Anywhere database.

Connecting to the database containing a domain you want to back up.

Selecting a domain for backup.

Backing up the domain to the backup repository.

Related Topics

Domain Backup Common Tasks, page 32

Domain Initialization: An Overview, page 43

Managing Audit Trail Data: An Overview, page 314

Off-Site Project Implementation Workflow, page 173

Prerequisites for Domain Initialization, page 44

SmartPlant Instrumentation Administration Users Guide 31

Domain Backup: An Overview

Domain Backup Common Tasks


As System Administrator, you are responsible for backing up a domain to the backup
repository. It is only possible to back up one domain at a time.
Back Up a Domain
This procedure enables the System Administrator to select an existing domain on the
server database on SQL Server or Oracle and then back up this domain to the backup
repository. The backup repository is the INtools_Backup.db database, which is a
Sybase Adaptive Server Anywhere database, created automatically during SmartPlant
Instrumentation setup. For more information, see Back Up a Domain, page 32.
Back Up a Domain from the Command Line
This topic explains how to back up a domain to INtools_Backup.db database without
using the Administration module options of SmartPlant Instrumentation. For more
information, see Back Up a Domain from the Command Line, page 33.
Related Topics

Domain Backup: An Overview, page 30

Back Up a Domain
Important
If you work in thin client environment, for example, Citrix, you must copy
the INtools.ini file to the SmartPlant Instrumentation home folder on the
server machine to be able to perform a backup procedure. On backup
completion, remove the INtools.ini file from the server machine.
1. With the System Administration window open, click File > Backup.

2. On the Backup Repository dialog box, click Browse to select the


INtools_Backup.db database file, and display it in the Target database name
and path box.
3. Click Connect to connect to the backup repository and to the current database.
4. On the Back Up Domain dialog box, from the Domain list, select the domain
which you want to back up.
5. Select Save last created ID for merging renamed items to save the ID of the
last item that was created in the domain. You can select this option if you later
intend to merge items in the Merger Utility. For details, the check box description
in the Help topic for the Back Up Domain dialog box.
6. If required, select Copy users to target domain to copy the user definitions from
the source domain to the target Sybase Adaptive Server Anywhere database file.

32 SmartPlant Instrumentation Administration Users Guide

Domain Backup: An Overview


7. If required, select Copy departments to target domain to copy the department
definitions from the source domain to the target Sybase Adaptive Server
Anywhere database file.
8. Click OK to start the backup process and monitor the progress on the Backup
Information dialog box.
Tips

The name of the backed up domain is INtools_Backup. The Domain


schema name and password are also INtools_Backup. You cannot
change these settings.

On completion of the backup process, the software records errors that


might occur during the domain backup in the InitLog.txt file, located
in the SmartPlant Instrumentation home folder.

In the target database, the domain type is the same as in the source
database.
9. Click Close after the backup is completed.

Note

When backing up an Operating owner domain, you need to rebuild the


projects after the backup process is complete.

Related Topics

Domain Backup Common Tasks, page 32

Domain Backup: An Overview, page 30

Managing Audit Trail Data: An Overview, page 314

Back Up a Domain from the Command Line


You can perform a domain backup without using the Administration module options
of SmartPlant Instrumentation. To do so, you, you need to specify additional
parameters. For example, if your Operating System is Windows 2000, you specify
these parameters in your Windows Server Task Scheduler.
Parameter String for Backup
Init.exe BKC,<Copy users flag>,<Copy departments flag>,<Save last created ID
flag>,<Domain schema name of the source domain>,<path to the target database
INtools_Backup.db>
Important

You must only use commas as parameter separators.

Use upper case for the Y and N settings.

SmartPlant Instrumentation Administration Users Guide 33

Domain Backup: An Overview


The following table describes the parameters in the order of their appearance in the
parameter string.
Parameter

Description

Possible Settings

Init.exe

The initial parameter, which


allows you to start the database
engine.

INIT.EXE

BKC

Stands for the name of the


operation

BKC

<Copy
users flag>

The Yes/No parameter for


copying user definitions from
the source domain to the target
Sybase Adaptive Server
Anywhere database file

Y or N

<Copy
The Yes/No parameter for
departments copying the department
definitions from the source
flag>
domain to the target Sybase
Adaptive Server Anywhere
database file.

Y or N

<Save last
created ID
flag>

The Yes/No parameter for


Y or N
saving the ID of the last item
that was created in the domain.
Set this parameter to Y (yes) if
you later intend to merge items
in the Merger utility. Set this
parameter to N (no) if you
previously backed up the domain
and you want to merge data that
was modified since this previous
backup.

<Source
Domain
schema
name>

The Domain schema name of the IN_DEMO


schema that you use as a source
for backup.

<Path to the The full path to


target
INtools_Backup.db, which is the
only database you can use as a
database>
target database for a domain
backup. INtools_Backup.db is a
Sybase Adaptive Server
Anywhere database that comes
shipped with SmartPlant
Instrumentation.

34 SmartPlant Instrumentation Administration Users Guide

d:\Program Files\SmartPlant\
Instrumentation\INtools_Backup.db

Domain Backup: An Overview


Example
Init.exe BKC,Y,Y,N,IN_DEMO,
d:\Program Files\SmartPlant\Instrumentation\INtools_Backup.db
Note

After completing the backup process, you can check the InitLog.txt file for
errors that might have occurred during the domain backup. The
InitLog.txt file appears in the SmartPlant Instrumentation home folder. In
this log file, the software automatically records errors that do not cause the
backup process to fail.

Related Topics

Domain Backup Common Tasks, page 32

Domain Backup: An Overview, page 30

Initialize a Domain from the Command Line, page 66

SmartPlant Instrumentation Administration Users Guide 35

Backing up Files Containing Audit Trail Data: An Overview

Backing up Files Containing Audit Trail Data:


An Overview
The SmartPlant Instrumentation System Administrator can trim audit trail data and
save the data to external files. The format, location and path configuration of these
files depends on the platform you are using (Oracle, SQL Server, or Sybase Adaptive
Server Anywhere 7.0).

When using Oracle, these files appear as .sql files on your Windows
server.

When using SQL Server, these files appear as .txt files on your Windows
server.

When using Sybase Adaptive Server Anywhere, these files appear as .txt
files on a client machine where you have installed SmartPlant
Instrumentation.

You need to back up these files to enable loading of the trimmed audit trail data to the
CHANGES_LOG table of a particular domain. The software records the audit trail
data in the CHANGES_LOG table that exists in each domain. To learn more about
trimming and loading audit trail data, see For more information, see Audit Trail: An
Overview in the Administration User's Guide, under Domain Administration.
The external file containing audit trail data has a filename made up of the date range
within which the data was trimmed, the domain schema name, the CHANGES_LOG
table name, and the filename which the System Administrator has defined in the
Administration module before trimming. The following is an example of an external
file with audit trail data:
20010614_20011015_<domain schema>#CHANGES_LOG#<user-defined
filename>.
The audit trail period segment displays the date range in the following order: year,
month, and day.
Related Topics
Backing up Audit Trail Data on Oracle: An Overview, page 37

Backing up Audit Trail Data on SQL Server: An Overview, page 39

Backing up Audit Trail Data on Sybase Adaptive Server Anywhere: An


Overview, page 41

Domain Backup Common Tasks, page 32

Managing Audit Trail Data: An Overview, page 314

36 SmartPlant Instrumentation Administration Users Guide

Backing up Files Containing Audit Trail Data: An Overview

Backing up Audit Trail Data on Oracle: An Overview


Trimmed audit rail data is stored in .sql files located on your Windows server in a
predefined folder. For example, <drive>:\INTOOLSTORAGE\ORC1, where ORC1
is your Oracle server database name. You have set the path and specified the
INTOOLSTORAGE folder when creating a new Oracle instance.
Note

When creating additional Oracle instances, we recommend that you do not


change the name INTOOLSTORAGE for any of the SmartPlant
Instrumentation databases. For details about creating the
INTOOLSTORAGE folder in the source Oracle server, see Installing
SmartPlant Instrumentation on Oracle, Creating a New Oracle 8.1.7
Instance with SmartPlant Instrumentation Specifications.

To enable loading of the audit trail data saved to the SQL files in the
<drive>:\INTOOLSTORAGE\ORC1 folder, you must create a backup of these files
on your Windows server in the following cases:

When moving a SmartPlant Instrumentation database from one Oracle


server to another.

When creating a new SmartPlant Instrumentation database on the same


Oracle server.

Related Topics

Back Up Files When Creating a New Database on Same Oracle Server,


page 38

Back Up Files When Moving a Database from One Oracle Server to


Another, page 38

Backing up Files Containing Audit Trail Data: An Overview, page 36

Managing Audit Trail Data: An Overview, page 314

SmartPlant Instrumentation Administration Users Guide 37

Backing up Files Containing Audit Trail Data: An Overview

Back Up Files When Creating a New Database on Same


Oracle Server
1. On your Windows server, create a subfolder <drive>:\INtoolStorage\<name of
new Oracle database>.
Tip
The name of the new Oracle database appears as the value of the
db_name parameter in the Oracle Instance Configuration file. For
example, orc2.
2. In the target Oracle database, open the Oracle Instance Configuration file init.ora.

3. In the Oracle Instance Configuration file, add the following parameter line:
utl_file_dir=<drive>:\INtoolStorage\orc2
4. Copy the content of the folder orc1 in the path <drive>:\INtoolStorage\ to the
folder orc2.
5. Restart your computer.

Back Up Files When Moving a Database from One Oracle


Server to Another
1. On your target Windows server, select a disk drive with 300 MB free disk space
for the storage of about 1 million records.
2. Create a folder INtoolStorage.
3. Create a subfolder <drive>:\INtoolStorage\<name of new Oracle database
server>.
Tip
The name of the new Oracle database appears as the value of the
db_name parameter in the Oracle Instance Configuration file. For
example, orc2.
4. Open the Oracle Instance Configuration file init.ora.

5. In the Oracle Instance Configuration file, add the following parameter line:
utl_file_dir=<drive>:\INtoolStorage \orc2.
6. Copy the content of the folder orc1 in the source path <drive>:\INtoolStorage to
the folder orc2 in the target path <drive>:\INtoolStorage.
7. Restart your computer.

38 SmartPlant Instrumentation Administration Users Guide

Backing up Files Containing Audit Trail Data: An Overview

Backing up Audit Trail Data on SQL Server: An


Overview
The software allows you to back up the files containing trimmed audit trail data for
SQL Server database server 2000 and 2005 in your Windows environment.
The file with the audit trail data is a .txt file that appears on your Windows server in a
path that depends on your SQL Server version as follows:

When using a SQL Server with a SmartPlant Instrumentation database


created in a default instance, the system creates the file in the following
path: <drive>:\INtoolStorage\>default instance name>\<SmartPlant
Instrumentation database name>
For example: e:\INtoolStorage\Develop1\INtools1
where the default instance name Develop1 corresponds to your source Windows
server name.

When using a SQL Server with a SmartPlant Instrumentation database


created in a named instance, the system creates the file in the following
path: <drive>:\INtoolStorage\<SQL Server server name>\<named instance
name>\<SmartPlant Instrumentation database name>
For example: e:\INtoolStorage\Develop1\INtools53\INtools1
where the SQL Server server name Develop1 corresponds to your source
Windows server name.

To enable loading of the audit trail data after moving a SmartPlant Instrumentation
database from one SQL Server server database to another, you must make a backup
of the .txt files with the trimmed audit trail data on your Windows server.
Related Topics

Back Up Files Containing Audit Trail Data on SQL Server, page 40

Backing up Files Containing Audit Trail Data: An Overview, page 36

Managing Audit Trail Data: An Overview, page 314

SmartPlant Instrumentation Administration Users Guide 39

Backing up Files Containing Audit Trail Data: An Overview

Back Up Files Containing Audit Trail Data on SQL Server


1. On your target Windows server, select a disk drive with 300 MB free disk space
for the storage of about 1 million records.
2. Create a folder INtoolStorage.
3. Do one of the following:

On the SQL Server with a SmartPlant Instrumentation database


created in a default instance, create the following path:
<drive>:\INtoolStorage\<default instance name of the new SQL Server
server>\<SmartPlant Instrumentation database name>.
For example:
e:\INtoolStorage\Develop2\SPI_1
where the default instance name Develop2 corresponds to your target
Windows server name.

On the SQL Server with a SmartPlant Instrumentation database


created in a named instance, create the following path:
<drive>:\INtoolStorage\<new SQL Server server name>\<named
instance name of the new SQL Server server>\<SmartPlant
Instrumentation database name>.
For example:
e:\INtoolStorage\Develop2\SPI2007\SPI_1
where the new SQL Server server name Develop2 corresponds to your
target Windows server name.
4. Do one of the following:

When using SQL Server with a SmartPlant Instrumentation database


created in a default instance, copy the content of the folder SPI_1 in
the source path e:\INtoolStorage\Develop1\ to the folder SPI_2 in the
target path e:\INtoolStorage\Develop2\.

When using SQL Server with a SmartPlant Instrumentation database


created in a named instance, copy the content of the folder SPI_1 in
the source path e:\INtoolStorage\Develop1\SPI2007 to the folder
SPI_2 in the target path e:\INtoolStorage\Develop2\SPI2007.
5. Restart your computer.

Related Topics

Domain Backup Common Tasks, page 32

Domain Backup: An Overview, page 30

Managing Audit Trail Data: An Overview, page 314

40 SmartPlant Instrumentation Administration Users Guide

Backing up Files Containing Audit Trail Data: An Overview

Backing up Audit Trail Data on Sybase Adaptive


Server Anywhere: An Overview
The software enables you to back up the files containing trimmed audit trail data on
Sybase Adaptive Server Anywhere in the Windows environment.
The file with the audit trail data is a .txt file that appears on a client machine where
SmartPlant Instrumentation is installed. The default path for this file is created
automatically with SmartPlant Instrumentation setup. Setup creates the following
default path: <drive>:\<SmartPlant Instrumentation home folder>\INtoolStorage. The
drive value corresponds to the drive where you have installed SmartPlant
Instrumentation.
You can view the file path as the value of the WatINstorageDir parameter in the
[database] section of the Intools.ini file.
File path value example:
WatINstorageDir=c:\Program Files\SmartPlant\Instrumentation\INtoolStorage
To enable loading of the audit trail data after moving a SmartPlant Instrumentation
database from one client machine to another, you must make a backup of the .txt files
with the trimmed audit trail data on the target client machine.
Related Topics

Back Up Files on Sybase Adaptive Server Anywhere, page 42

Backing up Files Containing Audit Trail Data: An Overview, page 36

Managing Audit Trail Data: An Overview, page 314

SmartPlant Instrumentation Administration Users Guide 41

Backing up Files Containing Audit Trail Data: An Overview

Back Up Files on Sybase Adaptive Server Anywhere


1. On the target client machine, select a disk drive with 300 MB free disk space for
the storage of about 1 million records.
2. Do one of the following:

Copy the content of the default folder in the source client machine, for
example, c:\Program Files\SmartPlant\Instrumentation\INtoolStorage
to the default folder in the new client machine. For example: Program
Files\SmartPlant\Instrumentation\INtoolStorage

If you do not have enough disk space for copying audit trail data to the
target drive where you have installed SmartPlant Instrumentation, do
the following:
3. In the required drive on the target client machine, create a folder INtoolStorage.

4. Open the Intools.ini file, and then, in the [database] section, set the file path value
of the parameter WatINstorageDir so that it matches the path you have created.
For example: WatINstorageDir="d:\SmartPlant\Instrumentation\
INtoolStorage"

5. Copy the content of the default folder in the source client machine. For example:
c:\Program Files\SmartPlant\Instrumentation\ INtoolStorage to the
default folder in the new client machine, for example,
d:\SmartPlant\Instrumentation\INtoolStorage.

42 SmartPlant Instrumentation Administration Users Guide

Domain Initialization: An Overview

Domain Initialization: An Overview


In SmartPlant Instrumentation, the working environment for your instrumentation
activities is known as a domain. The domain type can be either an Engineering
company an Operating owner. The System Administrator is responsible for
initializing (creating) domains. After initializing a domain, it is possible to define
users, access rights, naming conventions, and so forth. When initializing a domain,
the software creates the Domain schema, which contains all the database objects that
allow you to work with SmartPlant Instrumentation.
On Oracle or SQL Server, you can initialize a domain only after completing the
SmartPlant Instrumentation database setup. You can create several domains (one
domain at a time). These domains share the Admin schema, created during the
database setup. The Admin schema already contains the SmartPlant Instrumentation
database tables, but you cannot use these tables until the software creates a Domain
schema, with various object references necessary for working in SmartPlant
Instrumentation. For example, the Admin schema contains the table USERS but you
cannot create users, assign them to groups, and grant access rights until a Domain
schema exists because you can only perform these activities at a domain level. When
initializing a domain, the Domain schema, receives the INTOOLS_ENGINEER role,
which is created during the database setup. This role has system privileges and
privileges for database objects included in the Admin schema. These objects are
shared for all domains you initialize.
If you have a full version of Sybase Adaptive Server Anywhere database engine, you
can initialize a domain in any of the Sybase Adaptive Server Anywhere database
supplied databases, apart from the INtools_Backup.db, which must only be used for
backing up and restoring a domain. All of these database files contain the Admin
schema and, therefore, you do not need to set up the SmartPlant Instrumentation
database for Sybase Adaptive Server Anywhere. However, since only the INtools.db
database does not include any domain schemas, we recommend that you initialize a
domain in INtools.db. Also, it is recommended that you initialize only one domain in
a Sybase Adaptive Server Anywhere database. You are strongly advised to make
copies of the target database file before initializing a domain in this file.
You can initialize a domain in one of the following ways:

Initialize an empty domain. When initializing an empty domain in Oracle


or SQL Server, you can perform the initialization procedure without using
the Administration module options of SmartPlant Instrumentation. For
details, see Initialize a Domain from the Command Line, page 66.

Initialize a new domain using another domain as a source. This way, in


the target database, you restore a domain with all existing data.

Related Topics

Domain Initialization Common Tasks, page 46

SmartPlant Instrumentation Administration Users Guide 43

Domain Initialization: An Overview

Prerequisites for Domain Initialization


Before initializing a domain, familiarize yourself with the following prerequisites:
General Prerequisites for Initializing a Domain Using Another Domain as
a Source

When initializing a domain using another domain as a source, run the DB


Checker Utility for the source domain.

Make sure the database version of the source domain is the same as the
database version where you want to initialize a new domain, that is
Version 2007. If not, you must upgrade the source domain to Version
2007, or the target Admin schema to Version 2007.

When initializing a domain using another domain as a source, in the


source domain, make a list of all user-defined database views that are used
in the source domain. You need to log on as Domain Administrator to add
user-defined database views in the list. When initializing a domain, the
software only creates those user-defined views that the Domain
Administrator added in the list.

If you intend to use a Sybase Adaptive Server Anywhere database as an


intermediate database for initializing a domain from another source
domain, you must back up the INtools_Backup.db database, and then
restore this domain by using it as a source for a new domain initialization
in Oracle or SQL Server. The INtools_Backup.db database does not
require a full version of Sybase Adaptive Server Anywhere database
engine.

Domain Initialization in Sybase Adaptive Server Anywhere

We recommend that you initialize only one domain in a given Sybase


Adaptive Server Anywhere database. Therefore, make copies of the target
database so that you can use one copy per initialization. You can copy the
target database to another location, and then use this database as a
standard database file for new domains. You can use as a target database
any Sybase Adaptive Server Anywhere database supplied with SmartPlant
Instrumentation, apart from INtools_Backup.db, which you must only use
for backing up a domain. However, it is recommended that you use
INtools.db because this database it does not contain any Domain schemas
(only the Admin schema).

44 SmartPlant Instrumentation Administration Users Guide

Domain Initialization: An Overview


Domain Initialization in Oracle

If your Oracle client language environment is other than English, Far


Eastern, Middle Eastern, or Spanish (Latin American), you must configure
the NLS_NUMERIC_CHARACTERS parameter in the client registry
prior to initializing a domain in Oracle. For details, see Workaround for
the ORA-01722 Error, page 75

If you intend to initialize an SmartPlant Instrumentation domain from one


Oracle database to another, make sure that the database character set and
the national character set in the source Oracle database correspond to the
database character set and the national character set in the target Oracle
database. SmartPlant Instrumentation Version 2007 only supports the
AL32UTF8 database character set. If the character set in the source
Oracle database is different, contact Intergraph Support before initializing
domains. The national character set must be AL16UTF16.

If the source domain resides in Oracle 8i, and the target database platform
is Oracle 9i or 10g, initialize the domain in Sybase Adaptive Server
Anywhere first, then, upgrade the domain to Version 2007 before
initializing this domain in Oracle 9i or 10g.

If the source domain resides in SQL Server, initialize the domain in


Sybase Adaptive Server Anywhere first, then, upgrade the domain to
Version 2007 before initializing this domain in Oracle 9i or 10g.

Domain Initialization in SQL Server

Regardless of the source domain platform, make sure that in the


INtools.ini file, the [DATABASE] section has the following statement:
AutoCommit=TRUE

If the source domain resides in SQL Server 2000, upgrade the SmartPlant
Instrumentation database to Version 2007, and then, use this domain as a
source for initializing a new domain in SQL Server 2000 or 2005.

If the source domain resides in Oracle, initialize the domain in Sybase


Adaptive Server Anywhere first, then, upgrade the domain to Version
2007 before initializing this domain in SQL Server 2000 or 2005.

If the source domain resides in SQL Server 2000 and the target database is
in SQL Server 2005, the current client machine mast have two SQL Server
client installations: SQL Server 2000 client and SQL Server 2005 client.

If the source domain resides in SQL Server 2005 and the target database is
in SQL Server 2000, the current client machine mast have two SQL Server
client installations: SQL Server 2000 client and SQL Server 2005 client.

Related Topics

Domain Backup: An Overview, page 30

Domain Initialization Common Tasks, page 46

Domain Initialization: An Overview, page 43

SmartPlant Instrumentation Administration Users Guide 45

Domain Initialization: An Overview

Domain Initialization Common Tasks


The following tasks allow the System Administrator to initialize an empty domain, or
initialize a domain using another domain as a source.
Add User-Defined Database Views
Using this procedure, you make a list of user-defined database views prior to
initializing another domain when using the current domain as a source. The userdefined database views that appear in the list that you make also appear in the target
domain after the domain initialization. For more information, see Add User-Defined
Database Views, page 47.
Initialize an Empty Domain in Sybase Adaptive Server Anywhere
Use this procedure to initialize an empty domain in a Sybase Adaptive Server
Anywhere database supplied with SmartPlant Instrumentation, provided that you have
a full version of Sybase Adaptive Server Anywhere database engine. For more
information, see Initialize an Empty Domain in Sybase Adaptive Server Anywhere,
page 48.
Initialize a Domain in Sybase Adaptive Server Anywhere Using Another
Domain as a Source
Use this procedure to initialize a domain in a Sybase Adaptive Server Anywhere
database using another domain as a source, provided that you have a full version of
Sybase Adaptive Server Anywhere database engine. The source domain can reside in
any database platform that SmartPlant Instrumentation supports. For more
information, see Initialize a Domain in Sybase Adaptive Server Anywhere Using
Another Domain as a Source, page 50.
Initialize an Empty Domain in Oracle
Use this procedure to initialize an empty domain in Oracle 9i or 10g. For more
information, see Initialize an Empty Domain in Oracle, page 52.
Initialize a Domain in Oracle Using Another Domain as a Source
Use this procedure to initialize a domain in Oracle using another domain as a source.
The source domain can reside in the same or another Oracle database, or in a Sybase
Adaptive Server Anywhere database, provided that you have a full version of Sybase
Adaptive Server Anywhere database engine. For more information, see Initialize a
Domain in Oracle Using Another Domain as a Source, page 56.
Initialize an Empty Domain in SQL Server
Use this procedure to initialize an empty domain in SQL Server 2000 or 2005. For
more information, see Initialize an Empty Domain in SQL Server, page 59.

46 SmartPlant Instrumentation Administration Users Guide

Domain Initialization: An Overview


Initialize a Domain in SQL Server Using Another Domain as a Source
Use this procedure to initialize a domain in SQL Server using another domain as a
source. The source domain can reside in the same or another SQL Server database, or
in a Sybase Adaptive Server Anywhere database, provided that you have a full
version of Sybase Adaptive Server Anywhere database engine. For more
information, see Initialize a Domain in SQL Server Using Another Domain as a
Source, page 62.
Initialize a Domain from the Command Line
This topic describes how to initialize a domain without using the Administration
module options of SmartPlant Instrumentation. To do so, you, you need to specify
additional parameters. For example, if your Operating System is Windows 2000, you
specify these parameters in your Windows Server Task Scheduler. When initializing
a domain without using SmartPlant Instrumentation, you do not use any source
domain, and, therefore, the software creates a new empty domain in your database
platform (that is, Oracle or SQL Server). For more information, see Initialize a
Domain from the Command Line, page 66.
Related Topics

Domain Initialization: An Overview, page 43

Initialization Log Files, page 68

Prerequisites for Domain Initialization, page 44

Add User-Defined Database Views


1. Start the Administration module and log on as Domain Administrator.
2. With the Domain Administration window open, on the DBA menu, click UserDefined Database Views.
3. In the dialog box that opens, click Add.
4. In the Add Database Views dialog box data window, select one or more views
and click Apply.
Tip

Prior to initializing a target domain by using the current domain as a


source, you can add or remove user-defined database views any time
you need.

Note

After you click Apply in the Add Database Views dialog box, the
software allocates the database views that you selected to the data window
of the User-Defined Database Views. These database views become
available in a target domain after initializing that domain using the current
domain as a source.

SmartPlant Instrumentation Administration Users Guide 47

Domain Initialization: An Overview

Initialize an Empty Domain in Sybase Adaptive Server


Anywhere
Important
Before initializing a domain, familiarize yourself with domain
initialization prerequisites. For details, see Prerequisites for Domain
Initialization, page 44.
1. Start the Administration module to open the Logon Information dialog box with
DBA displayed in the User name box. This user name is the default user name
that enables you to log on to the Admin schema.

2. In the Password box, type DBA, which is the default password you use to log on
to the Admin schema.
3. Click OK to open the System Administration window.
4. Click File > Initialize.
5. On the Initialize dialog box, in the Domain box, type the domain name, which
must be unique in the current database, start with a letter, and contain only
alphanumeric characters without spaces. You can use an underscore ( _ ) to
indicate a space.
Tips

You are allowed to use a name of previously deleted domain.

You can modify the domain name after completing the initialization.
For details, see Make Domain Definitions, page 109.
6. In the Domain schema name box, type the logon name of the Domain schema,
which must be unique in the current database, start with a letter, and contain only
alphanumeric characters without spaces. You can use an underscore ( _ ) to
indicate a space. The software needs to use this name internally to connect to this
domain.

7. In the Domain schema password box, type the logon password of the Domain
schema, which must be unique in the current database, start with a letter, and
contain only alphanumeric characters without spaces. You can use an underscore
( _ ) to indicate a space.
Tip

The schema password must be different from the domain name. We


recommend that you write down the schema password and keep it in a
safe place. When initializing a domain, the software changes all the
password characters to upper case. This means that if the Domain
schema name is MY_DOMAIN, you cannot use my_domain as the
password string.

48 SmartPlant Instrumentation Administration Users Guide

Domain Initialization: An Overview


8. In the View-Only Domain schema password box, accept the default password of
the View-Only Domain schema or change it as appropriate, provided that the
setting is unique in the current database, starts with a letter, and contains only
alphanumeric characters without spaces. You can use an underscore (_) to
indicate a space.
Tip
The default password and the characters that you type when changing
the password appear masked.
9. Under Domain type, to determine the type of the domain that you want to
initialize, select one of the following options:

Operating owner Allows you to initialize the domain as a domain


with As-Built functionality. The database is partitioned into several
schemas: a single schema for As-Built and separate schemas for
projects.

Engineering company Allows you to initialize the domain as a


domain contracted to design and build plants based on process
information. A domain of the Engineering company type usually
involves one set of data which may be revised extensively during the
life cycle of the plant. In this case, the data for each project is
maintained within a single database schema. Once a plant is
operational, the domain type can be changed to Operating owner if
required, and the owner can perform the necessary maintenance and
modernization.
Tip

During the initialization process, the software might display various


error message that do not cause the initialization process to fail. If
want to prevent the software from displaying these message, select the
Do not display error messages check box. After completing the
initialization process, you can view the error messages recorded in the
InitLog.txt file, which appears in the SmartPlant Instrumentation home
folder.
10. Click OK to start the initialization process.

Related Topics

Domain Initialization Common Tasks, page 46

Domain Initialization: An Overview, page 43

Initialization Log Files, page 68

Prerequisites for Domain Initialization, page 44

Troubleshooting Domain Initialization Common Tasks, page 73

SmartPlant Instrumentation Administration Users Guide 49

Domain Initialization: An Overview

Initialize a Domain in Sybase Adaptive Server Anywhere


Using Another Domain as a Source
Important
Before initializing a domain, familiarize yourself with domain
initialization prerequisites. For details, see Prerequisites for Domain
Initialization, page 44.
1. Start the Administration module to open the Logon Information dialog box with
DBA displayed in the User name box. This user name is the default user name
that enables you to log on to the Admin schema.

2. In the Password box, type DBA, which is the default password you use to log on
to the Admin schema.
3. Click OK to open the System Administration window.
4. Click File > Initialize.
5. On the Initialize dialog box, in the Domain box, type the domain name, which
must be unique in the current database, start with a letter, and contain only
alphanumeric characters without spaces. You can use an underscore ( _ ) to
indicate a space.
Tips

You are allowed to use a name of previously deleted domain.

You can modify the domain name after completing the initialization.
For details, see Make Domain Definitions, page 109.
6. In the Domain schema name box, type the logon name of the Domain schema,
which must be unique in the current database, start with a letter, and contain only
alphanumeric characters without spaces. You can use an underscore ( _ ) to
indicate a space. The software needs to use this name internally to connect to this
domain.

7. In the Domain schema password box, type the logon password of the Domain
schema, which must be unique in the current database, start with a letter, and
contain only alphanumeric characters without spaces. You can use an underscore
( _ ) to indicate a space.
Tip

The schema password must be different from the domain name. We


recommend that you write down the schema password and keep it in a
safe place. When initializing a domain, the software changes all the
password characters to upper case. This means that if the Domain
schema name is MY_DOMAIN, you cannot use my_domain as the
password string.

50 SmartPlant Instrumentation Administration Users Guide

Domain Initialization: An Overview


8. In the View-Only Domain schema password box, accept the default password of
the View-Only Domain schema or change it as appropriate, provided that the
setting is unique in the current database, starts with a letter, and contains only
alphanumeric characters without spaces. You can use an underscore (_) to
indicate a space.
Tip
The default password and the characters that you type when changing
the password appear masked.
9. Click Source.

10. On the Source Data Connection dialog box, from the Database type list, select
one of the following options:

Sybase Adaptive Server Anywhere Allows you to click Browse


and select another Sybase Adaptive Server Anywhere database as a
source (a file with the .db extension).

Oracle 9i or Oracle 10g Allows you to use a domain residing in


Oracle. After selecting the Oracle version, the Server box becomes
available. You must type the source Oracle instance alias name.

SQL Server 2000 or SQL Server 2000 Allows you to use a


domain residing in SQL Server. After selecting the SQL Server
version, the ODBC profile (DSN) select list becomes available. From
this list, you need to select an ODBC profile (data source name) you
want to use for connecting to your SQL Server database server from
the current client machine.
Tip

The source and target versions of the SmartPlant Instrumentation


database must be the same.
11. Click Connect to connect to the source database.

12. From the Domain list, select a domain to be used as a source.


13. Select the Copy users to target domain if you want to copy all the existing
SmartPlant Instrumentation user definitions to the new domain.
14. Select the Copy departments to target domain if you want to copy all the
existing SmartPlant Instrumentation department definitions to the new domain.

SmartPlant Instrumentation Administration Users Guide 51

Domain Initialization: An Overview


15. In the Source Data Connection dialog box, click OK to return to the Initialize
dialog box.
Tips

The domain type of the source and target domain must be the same.
After you connect to the source database, the software automatically
detects the source domain type and selects the appropriate option on
the Initialize dialog box, under Domain type.

During the initialization process, the software might display various


error message that do not cause the initialization process to fail. If
want to prevent the software from displaying these message, select the
Do not display error messages check box. After completing the
initialization process, you can view the error messages recorded in the
InitLog.txt file, which appears in the SmartPlant Instrumentation home
folder.
16. Click OK to start the initialization process.

Related Topics

Domain Initialization Common Tasks, page 46

Domain Initialization: An Overview, page 43

Initialization Log Files, page 68

Prerequisites for Domain Initialization, page 44

Troubleshooting Domain Initialization Common Tasks, page 73

Initialize an Empty Domain in Oracle


Important
Before initializing a domain, familiarize yourself with domain
initialization prerequisites. For details, see Prerequisites for Domain
Initialization, page 44.
1. Start the Administration module to open the Logon Information dialog box with
DBA displayed in the User name box. This user name is the default user name
that enables you to log on to the Admin schema.

2. In the Password box, type DBA, which is the default password you use to log on
to the Admin schema.
3. Click OK to open the System Administration window.
4. Click File > Initialize.

52 SmartPlant Instrumentation Administration Users Guide

Domain Initialization: An Overview


5. On the Initialize dialog box, in the Domain box, type the domain name, which
must be unique in the current database, start with a letter, and contain only
alphanumeric characters without spaces. You can use an underscore ( _ ) to
indicate a space.
Tips

You are allowed to use a name of previously deleted domain.

You can modify the domain name after completing the initialization.
For details, see Make Domain Definitions, page 109.
6. In the Domain schema name box, type the logon name of the Domain schema,
which must be unique in the current database, start with a letter, and contain only
alphanumeric characters without spaces. You can use an underscore ( _ ) to
indicate a space. The software needs to use this name internally to connect to this
domain.

7. In the Domain schema password box, type the logon password of the Domain
schema, which must be unique in the current database, start with a letter, and
contain only alphanumeric characters without spaces. You can use an underscore
( _ ) to indicate a space.
Tip
The schema password must be different from the domain name. We
recommend that you write down the schema password and keep it in a
safe place. When initializing a domain, the software changes all the
password characters to upper case. This means that if the Domain
schema name is MY_DOMAIN, you cannot use my_domain as the
password string.
8. In the View-Only Domain schema password box, accept the default password of
the View-Only Domain schema or change it as appropriate, provided that the
setting is unique in the current database, starts with a letter, and contains only
alphanumeric characters without spaces. You can use an underscore (_) to
indicate a space.

Tip

The default password and the characters that you type when changing
the password appear masked.

SmartPlant Instrumentation Administration Users Guide 53

Domain Initialization: An Overview


9. Under Domain type, to determine the type of the domain that you want to
initialize, select one of the following options:

Operating owner Allows you to initialize the domain as a domain


with As-Built functionality. The database is partitioned into several
schemas: a single schema for As-Built and separate schemas for
projects.

Engineering company Allows you to initialize the domain as a


domain contracted to design and build plants based on process
information. A domain of the Engineering company type usually
involves one set of data which may be revised extensively during the
life cycle of the plant. In this case, the data for each project is
maintained within a single database schema. Once a plant is
operational, the domain type can be changed to Operating owner if
required, and the owner can perform the necessary maintenance and
modernization.
Tip

During the initialization process, the software might display various


error message that do not cause the initialization process to fail. If
want to prevent the software from displaying these message, select the
Do not display error messages check box. After completing the
initialization process, you can view the error messages recorded in the
InitLog.txt file, which appears in the SmartPlant Instrumentation home
folder.
10. Click OK to open the Domain Tablespace Definition dialog box, where you can
define the tablespace data of the domain for initialization.

11. To define the domain tablespace data, under Domain data, accept all the given
default values or modify them as follows:
a. In the Tablespace name box, type the appropriate domain tablespace name.
b. In the Datafile name and path box, type the full path and filename of the
tablespace database file.
c. In the Tablespace size (MB) box, type the appropriate domain tablespace
size.

54 SmartPlant Instrumentation Administration Users Guide

Domain Initialization: An Overview


12. To define the domain index tablespace data, under Index data, accept the given
default values or modify them as follows:
a. In the Tablespace name box, type the appropriate domain tablespace name.
b. In the Datafile name and path box, type the full path and filename of the
tablespace database file.
c. In the Tablespace size (MB) box, type the appropriate domain index
tablespace size. The recommended size is 50% of the domain tablespace size.
Tip
It is recommended that the domain datafile and the domain index
datafile are stored on separate physical disks.
13. Click OK to start the initialization process.

Important

After completing the initialization process, it is strongly recommended


that you update the current database statistics for the initialized domain.
Updating statistics improves the database performance. For details, see
Update Statistics, page 139.

Related Topics

Domain Initialization Common Tasks, page 46

Domain Initialization: An Overview, page 43

Initialization Log Files, page 68

Initialize a Domain from the Command Line, page 66

Prerequisites for Domain Initialization, page 44

Troubleshooting Domain Initialization Common Tasks, page 73

SmartPlant Instrumentation Administration Users Guide 55

Domain Initialization: An Overview

Initialize a Domain in Oracle Using Another Domain as a


Source
Important

Before initializing a domain, familiarize yourself with domain


initialization prerequisites. For details, see Prerequisites for Domain
Initialization, page 44.

If you intend to initialize an SmartPlant Instrumentation domain from one


Oracle database to another, note that the database character set and the
national character set in the source Oracle database must correspond to the
database character set and the national character set in the target Oracle
database. SmartPlant Instrumentation Version 2007 only supports the
AL32UTF8 database character set. If the character set in the source
Oracle database is different, contact Intergraph Support before performing
this procedure. The national character must be AL16UTF16.
1. Start the Administration module to open the Logon Information dialog box with
DBA displayed in the User name box. This user name is the default user name
that enables you to log on to the Admin schema.

2. In the Password box, type DBA, which is the default password you use to log on
to the Admin schema.
3. Click OK to open the System Administration window.
4. Click File > Initialize.
5. On the Initialize dialog box, in the Domain box, type the domain name, which
must be unique in the current database, start with a letter, and contain only
alphanumeric characters without spaces. You can use an underscore ( _ ) to
indicate a space.
Tips

You are allowed to use a name of previously deleted domain.

You can modify the domain name after completing the initialization.
For details, see Make Domain Definitions, page 109.
6. In the Domain schema name box, type the logon name of the Domain schema,
which must be unique in the current database, start with a letter, and contain only
alphanumeric characters without spaces. You can use an underscore ( _ ) to
indicate a space. The software needs to use this name internally to connect to this
domain.

56 SmartPlant Instrumentation Administration Users Guide

Domain Initialization: An Overview


7. In the Domain schema password box, type the logon password of the Domain
schema, which must be unique in the current database, start with a letter, and
contain only alphanumeric characters without spaces. You can use an underscore
( _ ) to indicate a space.
Tip
The schema password must be different from the domain name. We
recommend that you write down the schema password and keep it in a
safe place. When initializing a domain, the software changes all the
password characters to upper case. This means that if the Domain
schema name is MY_DOMAIN, you cannot use my_domain as the
password string.
8. In the View-Only Domain schema password box, accept the default password of
the View-Only Domain schema or change it as appropriate, provided that the
setting is unique in the current database, starts with a letter, and contains only
alphanumeric characters without spaces. You can use an underscore (_) to
indicate a space.

Tip
The default password and the characters that you type when changing
the password appear masked.
9. Click Source.

10. On the Source Data Connection dialog box, from the Database type list, select
one of the following options:

Sybase Adaptive Server Anywhere Allows you to click Browse


and select a Sybase Adaptive Server Anywhere database as a source (a
file with the .db extension). If you do no not have a full version of
Sybase Adaptive Server Anywhere database engine, you must select
the INtools_Backup.db database, to which you backed up a domain
you want to restore in your Oracle database.

Oracle 8.1 Allows you to initialize a domain in Oracle 9i or 10g if


the source domain resides in Oracle 8i, provided that the current
Oracle client machine uses Oracle 9i.

Oracle 9i Allows you to initialize a domain in Oracle 9i or 10g if


the source domain resides in Oracle 9i.

Oracle 10g Allows you to initialize a domain in Oracle 9i or 10g if


the source domain resides in Oracle 10g.

SmartPlant Instrumentation Administration Users Guide 57

Domain Initialization: An Overview


Tips

The source and target versions of the SmartPlant Instrumentation


database must be the same.

From SmartPlant Instrumentation 2007, Oracle 8i is not supported.


Therefore, if your source SmartPlant Instrumentation database resides
in Oracle 8i, familiarize yourself with SmartPlant Instrumentation
upgrade scenarios.
11. In the Admin schema name and Admin schema password boxes, if your source
domain resides in a different database, type the Admin schema name and
password of the source database to which you want to connect.

12. Click Connect to connect to the selected source database.


13. From the Domain list, select a domain to be used as a source.
14. Select the Copy users to target domain if you want to copy all the existing
SmartPlant Instrumentation user definitions to the new domain.
15. Select the Copy departments to target domain if you want to copy all the
existing SmartPlant Instrumentation department definitions to the new domain.
16. In the Source Data Connection dialog box, click OK to return to the Initialize
dialog box.
Tips

The domain type of the source and target domain must be the same.
After you connect to the source database, the software automatically
detects the source domain type and selects the appropriate option on
the Initialize dialog box, under Domain type.

During the initialization process, the software might display various


error message that do not cause the initialization process to fail. If
want to prevent the software from displaying these message, select the
Do not display error messages check box. After completing the
initialization process, you can view the error messages recorded in the
InitLog.txt file, which appears in the SmartPlant Instrumentation home
folder.
17. Click OK to open the Domain Tablespace Definition dialog box, where you can
define the tablespace data of the domain for initialization.

18. To define the domain tablespace data, under Domain data, accept all the given
default values or modify them as follows:
a. In the Tablespace name box, type the appropriate domain tablespace name.
b. In the Datafile name and path box, type the full path and filename of the
tablespace database file.
c. In the Tablespace size (MB) box, type the appropriate domain tablespace
size.

58 SmartPlant Instrumentation Administration Users Guide

Domain Initialization: An Overview


19. To define the domain index tablespace data, under Index data, accept the given
default values or modify them as follows:
a. In the Tablespace name box, type the appropriate domain tablespace name.
b. In the Datafile name and path box, type the full path and filename of the
tablespace database file.
c. In the Tablespace size (MB) box, type the appropriate domain index
tablespace size. The recommended size is 50% of the domain tablespace size.
Tip
It is recommended that the domain datafile and the domain index
datafile are stored on separate physical disks.
20. Click OK to start the initialization process.

Important

After completing the initialization process, it is strongly recommended


that you update the current database statistics for the initialized domain.
Updating statistics improves the database performance. For details, see
Update Statistics, page 139.

Related Topics

Domain Initialization Common Tasks, page 46

Domain Initialization: An Overview, page 43

Initialization Log Files, page 68

Prerequisites for Domain Initialization, page 44

Troubleshooting Domain Initialization Common Tasks, page 73

Initialize an Empty Domain in SQL Server


Important
Before initializing a domain, familiarize yourself with domain
initialization prerequisites. For details, see Prerequisites for Domain
Initialization, page 44.
1. Start the Administration module to open the Logon Information dialog box with
DBA displayed in the User name box. This user name is the default user name
that enables you to log on to the Admin schema.

2. In the Password box, type DBA, which is the default password you use to log on
to the Admin schema.
3. Click OK to open the System Administration window.
4. Click File > Initialize.

SmartPlant Instrumentation Administration Users Guide 59

Domain Initialization: An Overview


5. On the Initialize dialog box, in the Domain box, type the domain name, which
must be unique in the current database, start with a letter, and contain only
alphanumeric characters without spaces. You can use an underscore ( _ ) to
indicate a space.
Tips

You are allowed to use a name of previously deleted domain.

You can modify the domain name after completing the initialization.
For details, see Make Domain Definitions, page 109.
6. In the Domain schema name box, type the logon name of the Domain schema,
which must be unique in the current database, start with a letter, and contain only
alphanumeric characters without spaces. You can use an underscore ( _ ) to
indicate a space. The software needs to use this name internally to connect to this
domain.

7. In the Domain schema password box, type the logon password of the Domain
schema, which must be unique in the current database, start with a letter, and
contain only alphanumeric characters without spaces. You can use an underscore
( _ ) to indicate a space.
Tip
The schema password must be different from the domain name. We
recommend that you write down the schema password and keep it in a
safe place. When initializing a domain, the software changes all the
password characters to upper case. This means that if the Domain
schema name is MY_DOMAIN, you cannot use my_domain as the
password string.
8. In the View-Only Domain schema password box, accept the default password of
the View-Only Domain schema or change it as appropriate, provided that the
setting is unique in the current database, starts with a letter, and contains only
alphanumeric characters without spaces. You can use an underscore (_) to
indicate a space.

Tip

The default password and the characters that you type when changing
the password appear masked.

60 SmartPlant Instrumentation Administration Users Guide

Domain Initialization: An Overview


9. Under Domain type, to determine the type of the domain that you want to
initialize, select one of the following options:

Operating owner Allows you to initialize the domain as a domain


with As-Built functionality. The database is partitioned into several
schemas: a single schema for As-Built and separate schemas for
projects.

Engineering company Allows you to initialize the domain as a


domain contracted to design and build plants based on process
information. A domain of the Engineering company type usually
involves one set of data which may be revised extensively during the
life cycle of the plant. In this case, the data for each project is
maintained within a single database schema. Once a plant is
operational, the domain type can be changed to Operating owner if
required, and the owner can perform the necessary maintenance and
modernization.
Tip

During the initialization process, the software might display various


error message that do not cause the initialization process to fail. If
want to prevent the software from displaying these message, select the
Do not display error messages check box. After completing the
initialization process, you can view the error messages recorded in the
InitLog.txt file, which appears in the SmartPlant Instrumentation home
folder.
10. Click OK to open the Domain Data and Indexes dialog box, where you need to
perform the next step of defining initialization settings for your domain data and
indexes prior to starting the initialization process.

11. On the Domain Data and Indexes dialog box, in the Datafile folder path box,
type the folder path or accept the displayed default.
Tip
If you change the folder path in this box, the software automatically
updates the datafile name and path settings specified for the domain
and index data.
12. Under Domain data, accept or type the required values.

Tip

The values in the Domain file name and Filegroup boxes must be
must be unique in the database.

SmartPlant Instrumentation Administration Users Guide 61

Domain Initialization: An Overview


13. Under Index data, accept or type the required values.
Tip
The values in the Index file name and Filegroup boxes must be
unique in the database. For example, if you have six domains in one
database, you must have six different index file names.
14. Click OK to start the initialization process.

Tip

If, during the process, you receive a Grant to view Creation Error
message, see Workaround for the Grant to View Creation Error, page
76.

Important

After completing the initialization process, it is strongly recommended


that you update the current database statistics for the initialized domain.
Updating statistics improves the database performance. Start the Query
Analyzer and run the SP_UPDATESTATS procedure.

Related Topics

Domain Initialization Common Tasks, page 46

Domain Initialization: An Overview, page 43

Initialization Log Files, page 68

Initialize a Domain from the Command Line, page 66

Prerequisites for Domain Initialization, page 44

Troubleshooting Domain Initialization Common Tasks, page 73

Initialize a Domain in SQL Server Using Another Domain as


a Source
Important
Before initializing a domain, familiarize yourself with domain
initialization prerequisites. For details, see Prerequisites for Domain
Initialization, page 44.
1. In the INtools.ini file, located in the SmartPlant Instrumentation home folder, in
the [DATABASE] section, add the following statement:
AutoCommit=TRUE

2. Start the Administration module to open the Logon Information dialog box with
DBA displayed in the User name box. This user name is the default user name
that enables you to log on to the Admin schema.
3. In the Password box, type DBA, which is the default password you use to log on
to the Admin schema.
4. Click OK to open the System Administration window.

62 SmartPlant Instrumentation Administration Users Guide

Domain Initialization: An Overview


5. Click File > Initialize.
6. On the Initialize dialog box, in the Domain box, type the domain name, which
must be unique in the current database, start with a letter, and contain only
alphanumeric characters without spaces. You can use an underscore ( _ ) to
indicate a space.
Tips

You are allowed to use a name of previously deleted domain.

You can modify the domain name after completing the initialization.
For details, see Make Domain Definitions, page 109.
7. In the Domain schema name box, type the logon name of the Domain schema,
which must be unique in the current database, start with a letter, and contain only
alphanumeric characters without spaces. You can use an underscore ( _ ) to
indicate a space. The software needs to use this name internally to connect to this
domain.

8. In the Domain schema password box, type the logon password of the Domain
schema, which must be unique in the current database, start with a letter, and
contain only alphanumeric characters without spaces. You can use an underscore
( _ ) to indicate a space.
Tip
The schema password must be different from the domain name. We
recommend that you write down the schema password and keep it in a
safe place. When initializing a domain, the software changes all the
password characters to upper case. This means that if the Domain
schema name is MY_DOMAIN, you cannot use my_domain as the
password string.
9. In the View-Only Domain schema password box, accept the default password of
the View-Only Domain schema or change it as appropriate, provided that the
setting is unique in the current database, starts with a letter, and contains only
alphanumeric characters without spaces. You can use an underscore (_) to
indicate a space.

Tip
The default password and the characters that you type when changing
the password appear masked.
10. Click Source.

SmartPlant Instrumentation Administration Users Guide 63

Domain Initialization: An Overview


11. On the Source Data Connection dialog box, from the Database type list, select
one of the following options:

Sybase Adaptive Server Anywhere Allows you to click Browse


and select a Sybase Adaptive Server Anywhere database as a source (a
file with the .db extension). If you do no not have a full version of
Sybase Adaptive Server Anywhere database engine, you must select
the INtools_Backup.db database, to which you backed up a domain
you want to restore in your SQL Server database.

SQL Server 2000 You can select it as a source if the target


database is in SQL Server 2000. If the target database is in SQL
Server 2005, you can select SQL Server 2000 only if the current
machine has two SQL Server client installations: SQL Server 2000
client and SQL Server 2005 client.

SQL Server 2005 You can select it as a source if the target


database is in SQL Server 2005. If the target database is in SQL
Server 2000, you can select SQL Server 2005 only if the current
machine has two SQL Server client installations: SQL Server 2000
client and SQL Server 2005 client.
Tip

The source and target versions of the SmartPlant Instrumentation


database must be the same.

From SmartPlant Instrumentation 2007, SQL Server 7.0 is not


supported. Therefore, if your source SmartPlant Instrumentation
database resides in SQL Server 7.0, familiarize yourself with
SmartPlant Instrumentation upgrade scenarios.
12. From the ODBC profile (DSN) box, select an ODBC profile (data source name)
you want to use for connecting to your SQL Server database server from the
current client machine.

13. In the Admin schema logon name and Admin schema logon password boxes, if
your source domain resides in a different database, type the Admin schema name
and password of the source database to which you want to connect.
14. Click Connect to connect to the selected source database.
15. From the Domain list, select a domain to be used as a source.
16. Select the Copy users to target domain if you want to copy all the existing
SmartPlant Instrumentation user definitions to the new domain.
17. Select the Copy departments to target domain if you want to copy all the
existing SmartPlant Instrumentation department definitions to the new domain.

64 SmartPlant Instrumentation Administration Users Guide

Domain Initialization: An Overview


18. In the Source Data Connection dialog box, click OK to return to the Initialize
dialog box.
Tips

The domain type of the source and target domain must be the same.
After you connect to the source database, the software automatically
detects the source domain type and selects the appropriate option on
the Initialize dialog box, under Domain type.

During the initialization process, the software might display various


error message that do not cause the initialization process to fail. If
want to prevent the software from displaying these message, select the
Do not display error messages check box. After completing the
initialization process, you can view the error messages recorded in the
InitLog.txt file, which appears in the SmartPlant Instrumentation home
folder.
19. Click OK to open the Domain Data and Indexes dialog box, where you need to
perform the next step of defining initialization settings for your domain data and
indexes prior to starting the initialization process.

20. On the Domain Data and Indexes dialog box, in the Datafile folder path box,
type the folder path or accept the displayed default.
Tip
If you change the folder path in this box, the software automatically
updates the datafile name and path settings specified for the domain
and index data.
21. Under Domain data, accept or type the required values.

Tip
The values in the Domain file name and Filegroup boxes must be
must be unique in the database.
22. Under Index data, accept or type the required values.

Tip

The values in the Index file name and Filegroup boxes must be
unique in the database. For example, if you have six domains in one
database, you must have six different index file names.

SmartPlant Instrumentation Administration Users Guide 65

Domain Initialization: An Overview


23. Click OK to start the initialization process.
Tip

If, during the process, you receive a Grant to view Creation Error
message, see Workaround for the Grant to View Creation Error,
page 76.

Important

After completing the initialization process, it is strongly recommended


that you update the current database statistics for the initialized domain.
Updating statistics improves the database performance. Start the Query
Analyzer and run the SP_UPDATESTATS procedure.

Related Topics

Domain Initialization Common Tasks, page 46

Domain Initialization: An Overview, page 43

Initialization Log Files, page 68

Prerequisites for Domain Initialization, page 44

Initialize a Domain from the Command Line


You can initialize a domain without using the Administration module options of
SmartPlant Instrumentation. To do so, you, you need to specify additional
parameters. For example, if your Operating System is Windows 2000, you specify
these parameters in your Windows Server Task Scheduler.
When initializing a domain without using SmartPlant Instrumentation, you do not use
any source domain, and, therefore, the software creates a new empty domain in your
database platform (that is, Oracle or SQL Server).
Parameter String for Backup
Init.exe INT,<new domain name>,<new Domain schema name>,<new Domain
schema password>
Notes

You must only use commas as parameter separators.

The parameters are not case-sensitive.

66 SmartPlant Instrumentation Administration Users Guide

Domain Initialization: An Overview


The following table describes the parameters in the order of their appearance in the
parameter string.
Parameter

Description

Possible
Settings

Init.exe

The initial parameter, which allows you to


start the database engine.

INIT.EXE

INT

Stands for the name of the operation

INT

<New domain name>

The name of your target domain

DEMO

<New Domain schema


name>

The name of the target Domain schema

DEMO

<New Domain schema


password>

The password of the target Domain schema

DEMO

Example
INIT.EXE INT,DEMO,DEMO,DEMO
Note

After completing the initialization process, you can check the InitLog.txt
file for errors that might have occurred during the domain initialization.
The InitLog.txt file appears in the SmartPlant Instrumentation home
folder. In this log file, the software automatically records errors that do
not cause the initialization process to fail.

Related Topics

Domain Initialization Common Tasks, page 46

Domain Initialization: An Overview, page 43

Initialization Log Files, page 68

Prerequisites for Domain Initialization, page 44

SmartPlant Instrumentation Administration Users Guide 67

Domain Initialization: An Overview

Initialization Log Files


During the initialization process, the software generates the following log files:
InitLog.txt Contains information about errors that occurred when inserting data
into the Domain schema. The software creates this file in the SmartPlant
Instrumentation home folder automatically, on completion of the initialization
process. When you initialize another domain in the same database, the software
appends the new initialization session details in the file. If the initialization process
completes without any errors, the file only contains information about the database
platform and the session date.
Note

The software also uses the InitLog.txt file when you back up a domain to
the INtools_Backup.db database, and adds information about errors that
can occur when backing up data into the Domain schema of the
INtools_Backup.db database.

<number indicating the order of domain initialization>.log Contains


information about database structure-related problems found during the initialization
process. You should expect a 4.5 MB file to be created as a log file. The file name
comprises the number of the domain and the .log extension. The number of the
domain designates the order of domain initialization in your SmartPlant
Instrumentation database. For example, if you initialize your first domain, the
software creates the log file with name 1.LOG. In the event of any problem occurring
during the domain initialization, you must provide this file to Intergraph Support with
your request for assistance.
This file is not created automatically. If you want to create this file, add the following
line of the [DATABASE] section of the INtools.ini file (located in the SmartPlant
Instrumentation home folder): TRACE=1.
Related Topics

Domain Backup: An Overview, page 30

Domain Initialization Common Tasks, page 46

Domain Initialization: An Overview, page 43

68 SmartPlant Instrumentation Administration Users Guide

Domain Initialization: An Overview

Domain Deletion Common Tasks


The System Administrator can use the following set of procedures to delete
SmartPlant Instrumentation domains. Domain is a term used in SmartPlant
Instrumentation to define the working environment for various instrumentation
activities. When deleting a domain, the software deletes the Domain schema, which
was created during the domain initialization. The Domain schema contains
SmartPlant Instrumentation domain data. When deleting a domain, the software
deletes all the database tables and views associated with the current Domain schema.
It is only possible to delete one domain at a time.
Delete a Domain
Use this procedure to delete a domain that is no longer in use. When deleting an
Operating owner domain, the software deletes all the project schemas and the AsBuilt schema. You do not have to delete the projects first. For more information, see
Delete a Domain, page 70.
Delete an Invalid Domain on SQL Server
An invalid domain is a domain whose initialization process failed to complete. You
can use this option to delete an invalid domain and also automatically delete all
database files associated with this domain. You must exercise an extreme caution
when performing this procedure. For more information, see Delete an Invalid
Domain on SQL Server, page 72.
Delete an Invalid Domain on Oracle
An invalid domain is a domain whose initialization process failed to complete. You
can use this option to delete an invalid domain. For more information, see Delete an
Invalid Domain on Oracle, page 71.

SmartPlant Instrumentation Administration Users Guide 69

Domain Initialization: An Overview

Delete a Domain
Caution
Deletion is an operation you should consider very carefully before
attempting to perform it. If you delete a domain, the software deletes the
Domain schema with all the database objects associated with it. Since this
operation is irreversible, you should consider backing up your domain first
(or even the entire database, if required). See Installation Guide, Backup
and Restore to learn more about database backup procedures.
1. Do one of the following to open the Domain Definition window:

Click File > Domain Definition.

Click .
2. Do one of the following

Click Options > Delete.

Click

Notes

When deleting a domain in Oracle and if the software detects a rollback


segment problem, an appropriate message appears. In this case, click OK
and then click Delete again. If this kind of message reappears, click OK
each time and then restart the deletion process until you receive a message
notifying you that the domain has been deleted successfully. The possible
problems that cause the occurrence of the error messages are insufficient
disk space, non-optimal storage clause, or insufficient number of rollback
segments.

After deleting a domain in Oracle, a message is displayed with a list of


physical tablespace data files you need to delete manually.

In SQL Server, deleting a domain automatically deletes the filegroup and


data files associated with the domain.

In Sybase Adaptive Server Anywhere, after a domain is deleted, the


Sybase Adaptive Server Anywhere database engine automatically
optimizes the database size of INtools.db.

Related Topics

Domain Backup Common Tasks, page 32

Domain Deletion Common Tasks, page 69

70 SmartPlant Instrumentation Administration Users Guide

Domain Initialization: An Overview

Delete an Invalid Domain on Oracle


Caution
If an initialization process fails to complete, this domain becomes invalid
(cannot be used). We recommend that you delete the invalid domain
before initializing a new one.
1. With the System Administration window open, click DBA > Delete Invalid
Domain.

2. In the Delete Invalid Domain dialog box, from the Domain Name list, select the
invalid domain.
Tip
If the list is empty, there are no corrupted domains in the current
database.
3. Click OK.

Notes

After you click OK, you cannot stop the deletion process.

The duration of the deletion process depends on the stage at which the
domain initialization failed: the later the stage, the longer the deletion
process.

On Oracle, SmartPlant Instrumentation does not automatically delete all


the data files associated with a deleted domain. You need to delete the
remaining data files manually. You can view and print out the list of these
data files in the Data Files to Delete Manually dialog box, which opens
after SmartPlant Instrumentation completes the invalid domain deletion.

Related Topics

Domain Deletion Common Tasks, page 69

SmartPlant Instrumentation Administration Users Guide 71

Domain Initialization: An Overview

Delete an Invalid Domain on SQL Server


Cautions

If an initialization process fails to complete, this domain becomes invalid


(cannot be used). We recommend that you delete the invalid domain
before initializing a new one.

In addition to displaying invalid domains, the Delete Invalid Domain


dialog box displays all valid schemas of other databases residing in your
database server. SmartPlant Instrumentation cannot verify whether you
selected an invalid domain or a valid schema of another database. If you
selected an invalid domain schema, you can safely proceed with the
domain deletion. Deleting a schema that does not part of SmartPlant
Instrumentation results in deleting data in the database to which the
schema belongs.
1. With the System Administration window open, click DBA > Delete Invalid
Domain.

2. In the Delete Invalid Domain dialog box, from the Domain Name list, select the
invalid domain.
Tip
If the list is empty, there are no corrupted domains in the current
database.
3. Click OK.

Notes

After you click OK, you are prompted to verify your selection to make
sure you have selected a schema of an invalid domain and not a schema
that is not part of SmartPlant Instrumentation.

The duration of the deletion process depends on the stage at which the
domain initialization failed: the later the stage, the longer the deletion
process.

In SQL Server, SmartPlant Instrumentation automatically deletes all the


data files associated with an invalid domain.

Related Topics

Domain Deletion Common Tasks, page 69

72 SmartPlant Instrumentation Administration Users Guide

Domain Initialization: An Overview

Troubleshooting Domain Initialization Common


Tasks
The following tasks allow the System Administrator to troubleshoot initialization in
case of an error occurring during the initialization process or handle initialization
failure.
Handle an Initialization Failure
Use this procedure if the software cannot complete successfully a specific
initialization process. For more information, see Handle an Initialization Failure,
page 74.
Workaround for the ORA-01722 Error
This workaround enables you to prevent occurrence of ORA-01722 error messages
when initializing a domain in Oracle. You must complete this workaround if your
Oracle client language environment is other than English, Far Eastern, Middle
Eastern, or Spanish (Latin American). This workaround involves creating and
configuring the NLS_NUMERIC_CHARACTERS parameter in the client registry.
We recommend that you perform this workaround before you start domain
initialization to prevent any occurrence of the ORA-01722 error. It is possible,
however, to perform this procedure after you come across this error message. In this
case, you must cancel the current domain initialization process, complete a
workaround and then initialize a new domain. For more information, see
Workaround for the ORA-01722 Error, page 75.
Workaround for the Grant to View Creation Error
If, when initializing a domain in SQL Server, you receive a Grant to view Creation
Error message, you must first complete a workaround to resolve the problem, and
then run the initialization process again. For more information, see Workaround for
the Grant to View Creation Error, page 76.
Related Topics

Domain Initialization: An Overview, page 43

Initialization Log Files, page 68

Prerequisites for Domain Initialization, page 44

SmartPlant Instrumentation Administration Users Guide 73

Domain Initialization: An Overview

Handle an Initialization Failure


1. Start running the initialization process that was interrupted in a previous session.
2. When you receive a message "This process was interrupted in a previous session
during the following operation. Do you want to resume this process?", do one of
the following:

If you want to resume the initialization process from the same place
where the process was interrupted, click Yes and keep running the
process until it is completed successfully.

If you want to restart the process, click No to exist the initialization


utility and then, before you restart the process, in the [DATABASE]
section of the INtools.ini file, located in the SmartPlant
instrumentation home folder, add the following string:
CONTINUE=N
Tip

When restarting the initialization process, you cannot define the same
domain name because it is in use in the domain that became invalid
when the previous initialization session was interrupted. If you want
to use the same domain name, you must first delete the invalid domain.
For details, see Domain Deletion Common Tasks, page 69.
3. If, during the initialization process, you receive the same error that caused the
process to stop previously, press the Print Screen key. You must make a screen
capture of both the Initialize dialog box, and the error message.

4. Send the screen capture and the InitLog.txt file, located in the SmartPlant
Instrumentation home folder, to Intergraph Support.
Related Topics

Domain Initialization Common Tasks, page 46

Initialization Log Files, page 68

Troubleshooting Domain Initialization Common Tasks, page 73

Workaround for the Grant to View Creation Error, page 76

Workaround for the ORA-01722 Error, page 75

74 SmartPlant Instrumentation Administration Users Guide

Domain Initialization: An Overview

Workaround for the ORA-01722 Error


When initializing a domain in Oracle, ORA-01722 error messages is likely to occur
on a client machine belonging to any of the following language groups:

French

Slav Russian, Polish, and so forth

Western European and Scandinavian German, Dutch, Norwegian, and


so forth

Spanish Spanish of Spain

Portuguese

Italian

Baltic Latvian, Lithuanian, and so forth

If you ignore ORA-01722 error messages and complete the domain initialization, the
domain does not initialize correctly. To prevent the problem from occurring or to
resolve the problem if it has already occurred, do the following:
1. In the Registry Editor, under My Computer, expand the
KEY_LOCAL_MACHINE folder hierarchy.
2. Expand the SOFTWARE folder hierarchy.
3. Expand the ORACLE folder hierarchy.
4. Depending on your oracle client version, do one of the following:

When using Oracle 9i, right-click the HOME0 folder.

When using Oracle 10g, Right-click the KEY_OraDb10g_home1


folder.
5. On the pop-up menu, point to New and click String Value.

6. Under Name, type the parameter NLS_NUMERIC_CHARACTERS.


7. Right-click the NLS_NUMERIC_CHARACTERS parameter string and then, on
the pop-up menu, click Modify.

SmartPlant Instrumentation Administration Users Guide 75

Domain Initialization: An Overview


8. In the Edit String dialog box, under Value data, enter the following values: .,
(dot and comma)
9. Click OK.
Note

If you performed this workaround after you have received an ORA-01722


error message, when you try to run the interrupted initialization process
again, the software might prompt you to resume or restart the process. For
details about resuming or restarting the process, see Handle an
Initialization Failure, page 74.

Related Topics

Initialize a Domain in Oracle Using Another Domain as a Source, page 56

Initialize an Empty Domain in Oracle, page 52

Prerequisites for Domain Initialization, page 44

Troubleshooting Domain Initialization Common Tasks, page 73

Workaround for the Grant to View Creation Error


If you use SQL Server 2005 client machine to initialize a domain, during
initialization, you might receive a Grant to view Creation Error message with a
reference to a SmartPlant Instrumentation table. This problem is not related to
SmartPlant Instrumentation; rather it means that you either enabled Multiple Active
Result Sets (MARS) in SQL Server or there is a compatibility problem between your
SQL Server 2005 client and Microsoft .NET.
To resolve the problem, you must cancel the initialization process and then do one of
the following:

Disable Multiple Active Result Sets (MARS) in your SQL Server


database.
Tip

By default, MARS functionality is not enabled and is not required for


SmartPlant Instrumentation. You have probably enabled MARS
within a connection string, when connecting to SQL Server 2005 with
SQL Native Client. Refer to your SQL Server documentation to learn
how to disable the use of MARS.

If you cannot disable MARS in your SQL Server database, do the


following on the client machine you are using for a domain initialization:
a. Uninstall all the SQL Server 2005 components.
b. Uninstall all the Microsoft .NET components.
c. Restart the client machine.

76 SmartPlant Instrumentation Administration Users Guide

Domain Initialization: An Overview


d. Reinstall SQL Server 2005 client as described in the Install SQL Server 2005
Client topic of the SmartPlant Instrumentation Installation and Upgrade
Guide.
Tip

When installing SQL Server 2005 client, a compatible version of


Microsoft .NET Framework is installed automatically.

Note

After you resolve the problem and run the interrupted initialization process
again, the software might prompt you to resume or restart the process. For
details about resuming or restarting the process, see Handle an
Initialization Failure, page 74.

Related Topics

Initialize a Domain in SQL Server Using Another Domain as a Source,


page 62

Initialize an Empty Domain in SQL Server, page 59

Troubleshooting Domain Initialization Common Tasks, page 73

SmartPlant Instrumentation Administration Users Guide 77

Backing Up and Restoring Projects: An Overview

Backing Up and Restoring Projects: An


Overview
You can back up a specific project by exporting it to the INtoolsAB.db database. The
software backs up data of an entire project, apart from the CHANGES_LOG table
and external files. When you need to restore the project, you import the project from
the INtoolsAB.db database and, provided that the project in the target project has the
same database ID as the backed up project. The import process overwrites all the
data that the target project contains. You backup and restore projects using the
Export and Import options of the Project Activities dialog box.
You can only use the INtoolsAB.db database for a project backup. The INtoolsAB.db
is a Sybase Adaptive Server Anywhere database, shipped with SmartPlant
Instrumentation; the database file appears in the SmartPlant Instrumentation home
folder. This database already contains an Operating owner domain. It is not possible
to use any other database for backing up project data. Since you cannot export data
from more than one project to the INtoolsAB.db database, we recommend that you
create several copies of the empty INtoolsAB.db database. We recommend that you
rename INtoolsAB.db to <Master>.db, and then, for each export process, make a
copy of the <Master>.db database with the name INtoolsAB.db. After exporting
project data, you should rename INtoolsAB.db. For example, if your source project
name is Project1, you can rename INtoolsAB.db to Project1.db.
It is not possible to restore a project that has been merged with As-Built. It is not
possible to back up As-Built without backing up the entire Operating owner domain.
Cautions

You must not work in the backed-up project. To prevent accidental


unintentional access to the backed up project data in the INtoolsAB.db
database, before exporting the project, set access rights for the target
project as view-only or access denied.

If you need to create an off-site project, do not use the project Export
option of the Project Activities dialog box. This option is not intended
for off-site engineering but only for backing up a specific project. For
details about off-site projects, see Off-Site Project Creation and
Implementation: An Overview, page 172.

Related Topics

Backing Up and Restoring Projects Common Tasks, page 79

Off-Site Project Creation and Implementation: An Overview, page 172

Operating Owner Domain (As-Built and Projects) Common Tasks,


page 160

78 SmartPlant Instrumentation Administration Users Guide

Backing Up and Restoring Projects: An Overview

Backing Up and Restoring Projects Common Tasks


The following tasks are used frequently when backing up an restoring projects in an
Operating owner domain:
Back Up a Project
Perform this procedure to make a backup of your current project data. First, you
connect to the INtoolsAB.db database, which is supplied with SmartPlant
Instrumentation. Then, you can export the current project to the Operating owner
domain residing in the INtoolsAB.db database. In this domain, the software creates a
project with the same name as the project you selected in the Project Activities
dialog box. For more information, see Back Up a Project, page 80.
Specify Log File Path for Project Backup
Prior to backing up a project, you can change the default name and path of the log
file. The software creates a log file automatically on completing the project export
into the INtoolsAB.db database. The log file contains all information about the
project backup process. For more information, see Specify Log File Path for Project
Backup, page 81.
Restore a Project
This procedure allows you to restore project data that you previously backed up. You
can import project data either from the Operating owner domain residing in the
INtoolsAB.db database. This procedure outlines how to connect to the source
database and import backed up data to the project you selected in the Project
Activities dialog box and must restore. For more information, see Restore a Project,
page 81.
Specify Log File Path for Restoring a Project
Prior to restoring project data by importing it from the INtoolsAB.db database, you
can change the default name and path of the log file. The software creates a log file
automatically on completing the import process. The log file contains all information
about the project import process. For more information, see Specify Log File Path for
Restoring a Project, page 82.
Related Topics

Backing Up and Restoring Projects: An Overview, page 78

Off-Site Project Creation and Implementation: An Overview, page 172

SmartPlant Instrumentation Administration Users Guide 79

Backing Up and Restoring Projects: An Overview

Back Up a Project
Important
SmartPlant Instrumentation is shipped with the INtoolsAB.db database,
which already contains an Operating owner domain. It is not possible to
use any other database for backing up project data. You cannot export
data from more than one project to the INtoolsAB.db database. Therefore,
before performing this procedure, we recommend that you rename
INtoolsAB.db to <Master>.db, and then, for each export process, make a
copy of the <Master>.db database with the name INtoolsAB.db. After
exporting project data, you should rename INtoolsAB.db. For example, if
your source project name is Project1, you can rename INtoolsAB.db to
Project1.db.
1. Start the Administration module and log on as Domain Administrator.

2. Do one of the following:

Click Activities > Project Activities.

Click .
3. In the Project Activities dialog box, from the Project list, select a project you
want to use as a source for data export.

4. Click Export to open the Select Target Database dialog box.


5. Beside Target database name and path, click Browse to select a copy of the
INtoolsAB.db database.
6. Click Connect to connect to the target database.
7. From the Domain list, select the Operating owner domain.
8. Before exporting data, click Log File to open the Log File dialog box and specify
the log file name and path.
9. Click Export to create the project in the Operating owner domain in target
database.
Note

To restore the project data, see the Restore a Project procedure.

Related Topics

Backing Up and Restoring Projects Common Tasks, page 79

Backing Up and Restoring Projects: An Overview, page 78

Specify Log File Path for Project Backup, page 81

80 SmartPlant Instrumentation Administration Users Guide

Backing Up and Restoring Projects: An Overview

Specify Log File Path for Project Backup


Important
If you do not specify a log file name and path, the software does not create
any log file during the project backup process.
1. Start the Administration module and log on as Domain Administrator.

2. Do one of the following:

Click Activities > Project Activities.

Click .
3. On the Project Activities dialog box, from the Project list, select a project whose
data you want to export to another database.

4. Click Export.
5. On the Select Target Database dialog box, click Log File.
6. On the Log File dialog box, do one of the following:

Accept the default path and name of the log file <SmartPlant
Instrumentation home folder>\Exportlog.txt. At this stage, the log file
is not created yet. If you do not want a log file to be created, clear the
Log file name and path box.

Type a different log file path and name as you require.

Click Browse to select the desired log file. The log file must be a .txt
file.
7. Click OK to save the changes and return to the Select Target Database dialog
box, where you can export the current project data to another database.

Related Topics
Backing Up and Restoring Projects Common Tasks, page 79

Restore a Project
Important
You can perform the following procedure successfully only if the source
and the target projects have the same database ID.
1. Start the Administration module and log on as Domain Administrator.

2. Do one of the following:

Click Activities > Project Activities.

Click .
3. In the Project Activities dialog box, from the Project list, select a target project
to which you want to import data.

SmartPlant Instrumentation Administration Users Guide 81

Backing Up and Restoring Projects: An Overview


4. Click Import to open the Select Source Database dialog box.
5. In the Database type list, select the default profile INTOOLSAB=Adaptive
Server Anywhere for the INtoolsAB.db database.
Tip
If you renamed the INtoolsAB.db source database, or moved it to
another folder, to another folder, you must create a new ODBC profile
using the Internal Setup Utility.
6. Click Connect.

7. From the Domain list, select a source domain.


Tip
After selecting the source domain, the software detects the source
project with the same database ID as in the target project, and
automatically displays the source project in the Project box.
8. Before importing data, click Log File to open the Log File dialog box and specify
the log file name and path.

9. Click Report to open the List of Duplicate Items dialog box where you can view
the list of items in the projects of the target domain that appear as duplicate in the
target project after import.
10. Click OK when done.
11. Click Import to restore the project by overwriting the data in the target project.
12. On the Project Activities dialog box, click Close.
Related Topics
Backing Up and Restoring Projects Common Tasks, page 79

Backing Up and Restoring Projects: An Overview, page 78

Specify Log File Path for Restoring a Project, page 82

Specify Log File Path for Restoring a Project


Important
If you do not specify a log file name and path, the software does not create
any log file when restoring the project.
1. Start the Administration module and log on as Domain Administrator.

2. Do one of the following:

Click Activities > Project Activities.

Click .
3. On the Project Activities dialog box, from the Project list, select a target project
which you want to restore by importing data from a backed up project.

82 SmartPlant Instrumentation Administration Users Guide

Backing Up and Restoring Projects: An Overview


4. Click Import. to open the Select Source Database dialog box.
5. In the Database type list, select the default profile INTOOLSAB=Adaptive
Server Anywhere for the INtoolsAB.db database.
6. Click Connect.
7. On the Select Source Database dialog box, click Log File.
8. On the Log File dialog box, do one of the following:

Accept the default path and name of the log file <SmartPlant
Instrumentation home folder>\importlog.txt. At this stage, the log file
is not created yet. If you do not want a log file to be created, clear the
field.

Type a different log file path and name.

Click Browse to navigate to the required log file. The log file must be
a .txt file.
9. Click OK to save the changes and return to the Select Source Database dialog
box, where you can restore the backed up project in your Operating owner
domain.

Related Topics
Backing Up and Restoring Projects Common Tasks, page 79

SmartPlant Instrumentation Administration Users Guide 83

Backing Up and Restoring Projects: An Overview

Accessing the Administration Module Common


Tasks
The following tasks are used when you need to access the Administration module.
Log on as System Administrator
Every user is required to log on to the application using a designated user name and
password. Any user can log on to the Administration module, however, only a user
designated as System Administrator can have access to the System Administration
options. This procedure explains how to start the Administration module with
System Administrator privileges. For more information, see Log on as System
Administrator, page 85.
Log on as Domain Administrator
This option explains how to enter the Administration module with Domain
Administrator privileges. For more information, see Log on as Domain
Administrator, page 86.
Switch from System Administration to Domain Administration
Where the same person is responsible for both System Administration and Domain
Administration activities, it is possible to switch between the two functions (provided
that the user has an identical user name and password for both functions) without
exiting the Administration module. For more information, see Switch from System
Administration to Domain Administration, page 86.
Switch from Domain Administration to System Administration
This option explains how to switch from Domain Administration to System
Administration without exiting the Administration module. This is possible if you
have a valid System Administration use name and password. For more information,
see Switch from Domain Administration to System Administration, page 87.
Related Topics

Domain Administration Common Tasks, page 147

System Administration Common Tasks, page 104

Working with Administration Module: An Overview, page 15

84 SmartPlant Instrumentation Administration Users Guide

Backing Up and Restoring Projects: An Overview

Log on as System Administrator


1. Start the Administration module.
2. In the Logon Information dialog box, from the Database list, select the database
you want to connect to.
3. In the User name and Password text boxes, enter your System Administrator's
user name and password.
Tips

The list of databases appears in the INTOOLS.INI file. For each


database, you need to define a database profile.

The System Administrator user name and password are defined per
installation. DBA is the default user name and password that you use
to log on to SmartPlant Instrumentation for the first time. The
password is entered in upper case characters, regardless of the
keyboard setting. After you log on for the first time, you should
change your password.
4. In the Open Administration Module dialog box, click System Administrator.

Note

If you are currently logged on as the Domain Administrator, you can


switch to the system administration level without the need to log on again.
You can do this only if the System Administrator user name and password
are the same as the Domain Administrator's.

Related Topics

Accessing the Administration Module Common Tasks, page 84

System Administration Common Tasks, page 104

Working with Administration Module: An Overview, page 15

SmartPlant Instrumentation Administration Users Guide 85

Backing Up and Restoring Projects: An Overview

Log on as Domain Administrator


1. Start the Administration module.
2. In the User name and Password boxes of the Logon Information dialog box,
enter your Domain Administrator's user name and password.
Tip
The Domain Administrator user name and password are defined per
domain by the System Administrator.
3. In the Open Administration Module dialog box, select the required domain from
the list.

4. Click OK to open the Domain Administration window.


Note

If you are currently logged on as the System Administrator, you can


switch to the Domain Administrator level without the need to log on
again. You can do this only if the Domain Administrator user name and
password are the same as the System Administrator's

Related Topics

Accessing the Administration Module Common Tasks, page 84

Domain Administration Common Tasks, page 147

Domain Administration: An Overview, page 146

Working with Administration Module: An Overview, page 15

Switch from System Administration to Domain


Administration
1. Click

to close the current window.

2. Click

3. In the Open Administration Module dialog box, click Domain Administrator.


Related Topics

Accessing the Administration Module Common Tasks, page 84

System Administration Common Tasks, page 104

Working with Administration Module: An Overview, page 15

86 SmartPlant Instrumentation Administration Users Guide

Backing Up and Restoring Projects: An Overview

Switch from Domain Administration to System


Administration
1. Click

to close the current domain.

2. Click

3. In the Open Administration Module dialog box, click System Administrator.


Related Topics

Accessing the Administration Module Common Tasks, page 84

Domain Administration Common Tasks, page 147

Domain Administration: An Overview, page 146

Working with Administration Module: An Overview, page 15

SmartPlant Instrumentation Administration Users Guide 87

Backing Up and Restoring Projects: An Overview

Create and Manage User Profiles and Departments


Common Tasks
As System Administrator, you are responsible for the creation of all SmartPlant
Instrumentation users and for the management of their profiles. Also, you assign
them to various departments and determine who of the users will function as the
Domain Administrator.
You can perform the following tasks:
Create and Manage Departments
Departments are used to provide extra information about your users. Department
names appear in the Users dialog box only. For more information, see Create and
Manage Departments, page 89.
Create and Manage User Profiles
The System Administrator must define all the users that can work in SmartPlant
Instrumentation. The System Administrator can also assign users to departments and
edit the user profile information, including user passwords. For more information,
see Define a SmartPlant Instrumentation User, page 90.
Assign a Domain Administrator
As System Administrator, you must assign a Domain Administrator when associating
a new domain. You can change the Domain Administrator later if required. For
more information, see Assign a Domain Administrator, page 92.
Related Topics

System Administration Common Tasks, page 104

Working with Administration Module: An Overview, page 15

88 SmartPlant Instrumentation Administration Users Guide

Backing Up and Restoring Projects: An Overview

Create and Manage Departments


1. Start the Administration module and log on as System Administrator.
2. With the System Administration window open, do one of the following to open
the Domain Definition window:

Click Activities > Department.

Click .
3. Click New.

4. Under Department, Description, and Note, type the appropriate values.


5. Click Apply.
6. To edit or delete an existing department, from the Department list, select a
department.
7. Click Edit or Delete as you require.
8. Click Close when done.
Note

Note that the software creates a default department with each new domain.
If required, you can assign all your users to this department.

Related Topics

Create and Manage User Profiles and Departments Common Tasks, page
88

Log on as System Administrator, page 85

System Administration Common Tasks, page 104

SmartPlant Instrumentation Administration Users Guide 89

Backing Up and Restoring Projects: An Overview

Define a SmartPlant Instrumentation User


1. Start the Administration module and log on as System Administrator.
2. With the System Administration window open, do one of the following to open
the Domain Definition window:

Click Activities > User.

Click .
3. In the User dialog box, click New.

4. Under User, type a unique user name.


Tips

The user name can contain up to thirty characters. The software


applies upper case to all alphabetic characters. You can use any
combination of characters.

If you intend to use Windows authentication logon method, you must


define a user group with the same name as a user group defined in
Windows. In this case, you do not have to define users at all. Then,
whenever a user that belongs to the Windows group accesses
SmartPlant Instrumentation for the first time, the software logs on this
user and assigns the user to the SmartPlant Instrumentation group.
The user name appears in the User dialog box automatically.
5. Under User initials, type the appropriate initials. The software uses this value to
identify the reviewer in all the revisions created in the software.

6. From the Department list, select a department to which you want to assign the
user.
7. Under Password, type a unique login password for the user.
Tip
A password can contain up to 15 characters (not case-sensitive). The
password that you type appears masked.
8. Under Verify new password, retype the password you just entered.

9. Select the System Administrator check box if you want to grant System
Administrator rights to the new user.
Tip

In SmartPlant Instrumentation, there can be more than one user with


System Administrator access rights.

90 SmartPlant Instrumentation Administration Users Guide

Backing Up and Restoring Projects: An Overview


10. Select the IDEAL user check box if you want this user to generate reports using
IDEAL. After defining an IDEAL user, the software can make a connection
between the SmartPlant Instrumentation Server and the SmartPlant
Instrumentation database.
Tips

You must log on to SmartPlant Instrumentation using the IDEAL user


name and password to be able to set the preferences for IDEAL report
generation that the software can recognize.

Only one IDEAL user can be defined per domain.


11. Under Note, type a brief note as required.

12. Click Apply.


Notes

To edit the profile of an existing user, select the required user from the
User list and click Edit.

To delete a user from the system, select the required user from the User
list and click Delete.

Deleting a user means that this individual will no longer be able to access
SmartPlant Instrumentation. However, the history and activity tracking
information associated with that user will continue to exist in the database.
For this reason, every user should have a name that is unique in the
system.

If you want to delete a user who is a System Administrator or Domain


Administrator, you must first assign a different user as the System or
Domain Administrator.

Related Topics

Create and Manage User Profiles and Departments Common Tasks, page
88

Log on as System Administrator, page 85

System Administration Common Tasks, page 104

SmartPlant Instrumentation Administration Users Guide 91

Backing Up and Restoring Projects: An Overview

Assign a Domain Administrator


1. Log on to the Administration module as System Administrator.
2. Do one of the following to open the Domain Definition window:

Click File > Domain Definition.

On the menu bar, click .


3. From the Domain list, select a domain.

4. On the toolbar, click

5. From the Administrator list, select a user you want to set as Domain
Administrator for the current domain.
Tip
The Domain Administrator name password remain the same that you
have set in the User dialog box when you created that user's profile.
6. Repeat steps 2 through 4 to assign additional Domain Administrators if needed.

7. On the toolbar, click

Related Topics

Create and Manage User Profiles and Departments Common Tasks,


page 88

Log on as System Administrator, page 85

System Administration Common Tasks, page 104

92 SmartPlant Instrumentation Administration Users Guide

Backing Up and Restoring Projects: An Overview

User Groups: An Overview


A SmartPlant Instrumentation user group is a group in which all users share the same
access rights. After the System Administrator defines new users, the Domain
Administrator needs to assign the users to groups so that they can be granted access
rights to various items or activities. As access rights are defined at the level of a
group, the Domain Administrator needs to define user groups and then assign
appropriate users to these groups. A user can belong to several groups with different
access rights.
When the domain type is Operating owner, in a project, access rights granted on the
domain level do not apply. If you want to grant access rights to a group assigned to a
project, you must also assign this group to As-Built.
If the System Administrator enables the use of Windows authentication logon
method, the software can create and assign users to groups automatically. For more
information, see Windows Authentication Logon Method: An Overview, page 99.
Related Topics

Access Rights Descriptions, page 260

Create a Group for Windows Authentication Logon Method, page 100

Create a New Group, page 95

Users and Groups Common Tasks, page 94

SmartPlant Instrumentation Administration Users Guide 93

Backing Up and Restoring Projects: An Overview

Users and Groups Common Tasks


The Domain Administrator can perform the following tasks to manage user groups:
Create a New Group
Access rights are defined at the level of a group; therefore, for each access rights
profile that you can assign to users, you need to define a group and then assign the
appropriate users to one or more groups. For more information, see Create a New
Group, page 95.
Create a Group for Windows Authentication Logon Method
A group for Windows authentication logon method is a user group that exists in
Windows and is associated with a SmartPlant Instrumentation group. The names of
the Windows and SmartPlant Instrumentation groups must be identical. All users
defined in a Windows domain who belong to this Windows group can access
SmartPlant Instrumentation without having to provide any logon information, such as
user name and password. When such a user starts SmartPlant Instrumentation, the
software detects the user's Windows group settings, matches the Windows group
name to the corresponding SmartPlant Instrumentation group name, and assigns the
user to the SmartPlant Instrumentation group automatically. For more information,
see Create a Group for Windows Authentication Logon Method, page 100.
Modify the Profile of a Group
This option explains how you can edit the profile of an existing group. For more
information, see Modify the Profile of a Group, page 96.
Assign Users to Groups
In the current domain, the Domain Administrator can assign an existing user to one or
more groups. Assigning users to groups is needed because access rights to the
domain items are granted per group. Therefore, users who are not assigned to any
group have no access rights to the domain. For more information, see Assign Users
to Groups, page 97.
Remove Users from Groups
This procedure enables the Domain Administrator to remove users from a group. For
more information, see Remove Users from Groups, page 98.

94 SmartPlant Instrumentation Administration Users Guide

Backing Up and Restoring Projects: An Overview


Remove Deleted Windows Users from SmartPlant Instrumentation User
Groups
This procedure enables the System Administrator to remove from SmartPlant
Instrumentation those users who have been deleted from their Windows groups. Such
users remain assigned to the SmartPlant Instrumentation group but can no longer
access SmartPlant Instrumentation if the Windows authentication logon method is
switched on. For more information, see Remove Deleted Windows Users from
SmartPlant Instrumentation User Groups, page 101.
Delete a Group
This procedure enables the Domain Administrator to delete a group that has no users.
For more information, see Delete a Group, page 96.
Related Topics
Domain Administration Common Tasks, page 147

User Groups: An Overview, page 93

Windows Authentication Logon Method: An Overview, page 99

Create a New Group


1. With the Domain Administration window open, click Activities > Group.
2. In the Group dialog box, click New.
3. Type the new group name, description and note as you require.
4. Click Apply.
5. When prompted whether to copy access rights from another group, do one of the
following:

Click No to create a new group in which all members have full access
rights to all SmartPlant Instrumentation features.

Click Yes select a source group for copying access rights to the group
that you are creating.

Related Topics

Access Rights: An Overview, page 258

Create a Group for Windows Authentication Logon Method, page 100

User Groups: An Overview, page 93

Users and Groups Common Tasks, page 94

SmartPlant Instrumentation Administration Users Guide 95

Backing Up and Restoring Projects: An Overview

Modify the Profile of a Group


1. With the Domain Administration window open, click Activities > Group.
2. In the Group dialog box, from the SmartPlant Instrumentation group list,
select the group you require.
3. Click Edit.
4. Make all the changes that you need.
5. Click Apply to save the changes you have made.
Note

When modifying the profile of a group, the group access rights remain
unchanged.

Related Topics

User Groups: An Overview, page 93

Users and Groups Common Tasks, page 94

Delete a Group
Important
You can only delete a group that has no users.
1. Start the Administration module and log on as Domain Administrator.

2. Click Activities > Group.


3. From the Group list, select the group that you want to delete.
4. Click Delete.
Related Topics

Remove Users from Groups, page 98

User Groups: An Overview, page 93

Users and Groups Common Tasks, page 94

96 SmartPlant Instrumentation Administration Users Guide

Backing Up and Restoring Projects: An Overview

Assign Users to Groups


Important
If you created groups for Windows authentication logon method, you do
not need to add any users to the groups. Whenever a new user with
Windows authentication logon method credentials starts SmartPlant
Instrumentation for the first time, the software assigns this user to the
appropriate SmartPlant Instrumentation group automatically. For more
information, see Create a Group for Windows Authentication Logon
Method, page 100.
1. Start the Administration module and log on as Domain Administrator.

2. Click Activities > Assign Users to Groups.


3. From the Group list, select the group to which you want to assign the required
user.
Tip
The users who have already been assigned to the selected group appear
in the Group users pane.
4. In the User list pane, select the user you want to assign to the selected group.

5. Drag the selected user from the User list pane to the Group users pane.
6. Repeat steps 3 through 5 in this procedure for each user you want to assign to a
group.
7. Click Apply to save the selections.
8. Click Close to close the dialog box.
Note

If a user does not see the plant hierarchy after starting SmartPlant
Instrumentation, this means that this particular user is not assigned to any
group in the domain.

Related Topics

Access Rights: An Overview, page 258

User Groups: An Overview, page 93

Users and Groups Common Tasks, page 94

Windows Authentication Logon Method: An Overview, page 99

SmartPlant Instrumentation Administration Users Guide 97

Backing Up and Restoring Projects: An Overview

Remove Users from Groups


Caution

If you remove a user who belongs to a group that is also a Windows


group, you cannot prevent this user from accessing SmartPlant
Instrumentation using Windows authentication logon method. For more
information, see Create a Group for Windows Authentication Logon
Method, page 100.

Users who are not assigned to any group have no access rights in the
domain.
1. Start the Administration module and log on as Domain Administrator.

2. Click Activities > Assign Users to Groups.


3. From the Group list, select the group from which you want to remove the
required user.
4. In the Group users pane, select the user you want to remove from the selected
group.
5. Drag the selected user from the Group users pane to the User list pane.
6. Repeat steps 3 through 5 in this procedure for each user you want to remove from
a group.
7. Click OK to save changes.
Related Topics

Remove Deleted Windows Users from SmartPlant Instrumentation User


Groups, page 101

User Groups: An Overview, page 93

Users and Groups Common Tasks, page 94

98 SmartPlant Instrumentation Administration Users Guide

Backing Up and Restoring Projects: An Overview

Windows Authentication Logon Method: An


Overview
Windows authentication logon method allows the software to create SmartPlant
Instrumentation users automatically and assign them to existing SmartPlant
Instrumentation groups as soon as these users start SmartPlant Instrumentation.
First, in a specific domain, the Domain Administrator must associate a global group
that exists in Windows with a SmartPlant Instrumentation group. To do so, the
Domain Administrator creates a SmartPlant Instrumentation group and assigns to this
group an existing Windows group (the group name characters are case-sensitive).
After that, any user who belongs to this Windows group can access this SmartPlant
Instrumentation domain automatically without having to provide any logon
information. This is because the user's Windows and SmartPlant Instrumentation
logon information is the same. When such a user starts SmartPlant Instrumentation,
the software bypasses the Logon Information dialog box, and displays directly the
Open dialog box, where you select a <unit>. To access SmartPlant Instrumentation,
in the Open dialog box, the user needs to select a domain in which the Domain
Administrator has associated the user's Windows group with the SmartPlant
Instrumentation group.
Notes

The System Administrator can enable or disable the use of Windows


authentication logon method when setting security options. After
switching from the Windows authentication logon method back to the
SmartPlant Instrumentation logon method, all the users remain in
SmartPlant Instrumentation but each user must provide a personal
SmartPlant Instrumentation user name and password when logging on.

To be able to access SmartPlant Instrumentation using Windows


authentication logon method, a user must be connected to the appropriate
Windows domain. Only after the user receives the Windows group
privileges can the software match the user's Windows domain name with
the SmartPlant Instrumentation domain name.

Users who do not belong to any Windows user group or who are not
defined in any SmartPlant Instrumentation group cannot access the
domain.

After the software creates users in a SmartPlant Instrumentation group by


using Windows authentication logon method, these users remain in the
SmartPlant Instrumentation group even if they are removed from the
Windows group. These users can no longer access SmartPlant
Instrumentation. The System Administrator needs to remove deleted
Windows users from SmartPlant Instrumentation.
SmartPlant Instrumentation Administration Users Guide 99

Backing Up and Restoring Projects: An Overview

Create a Group for Windows Authentication Logon Method


1. With the Domain Administration window open, click Activities > Group.
2. In the Group dialog box, click New.
3. Under SmartPlant Instrumentation group, type the new group name.
4. Type the group description and note as you require.
5. Under Windows group, using case-sensitive characters, enter the group name
exactly as it appears in your Windows domain.
6. Click Apply.
7. When prompted whether to copy access rights from another group, do one of the
following:

Click No to create a new group in which all members have full access
rights to all SmartPlant Instrumentation features.

Click Yes select a source group for copying access rights to the group
that you are creating.

Note

The System Administrator can enable or disable the use of Windows


authentication logon method at any stage of the domain life-cycle. For
more information, see Workflow of Switching to a Different Logon
Method, page 102.

Related Topics

Access Rights: An Overview, page 258

User Groups: An Overview, page 93

Users and Groups Common Tasks, page 94

Windows Authentication Logon Method: An Overview, page 99

100 SmartPlant Instrumentation Administration Users Guide

Backing Up and Restoring Projects: An Overview

Remove Deleted Windows Users from SmartPlant


Instrumentation User Groups
Note
You can only perform this procedure if the Enable Windows
authentication logon method check box is selected on the Security
Options dialog box.
1. Start the Administration module and log on as System Administrator.

2. Click Activities > Remove Deleted Windows Users.


3. Do one of the following:

Select Remove for those users you want to remove from SmartPlant
Instrumentation.

Select Remove all if you want to remove all the users displayed on the
dialog box.
Tip

The dialog box only displays those users who have been deleted from
their Windows groups.
4. Click OK.

Related Topics

Remove Users from Groups, page 98

User Groups: An Overview, page 93

Users and Groups Common Tasks, page 94

Windows Authentication Logon Method: An Overview, page 99

SmartPlant Instrumentation Administration Users Guide 101

Backing Up and Restoring Projects: An Overview

Workflow of Switching to a Different Logon Method


Switching to Windows Authentication Logon Method
Use this workflow if you already have user groups in SmartPlant Instrumentation and
want to enable the existing users to log on to SmartPlant Instrumentation using the
Windows authentication.
1. Log on to the Administration module as System Administrator and do the
following:
a. On the menu bar, click Activities > Security Options.
b. Select Enable windows authentication logon method check box.
c. Click OK.
2. Log on to the Administration module as Domain Administrator and do the
following:
a. On the menu bar, click Activities > Group.
b. For each group in the list, including the default ADMINISTRATORS group,
define the corresponding Windows group as defined in your Windows
domain.
c. Click OK.
Switching to SmartPlant Instrumentation Authentication Logon Method
Use this workflow to switch from Windows Authentication logon method back to
SmartPlant Instrumentation logon method.
1. Log on to the Administration module as System Administrator and do the
following:
a. On the menu bar, click Activities > Security Options.
b. Clear Enable windows authentication logon method check box.
c. Click OK.
2. Open the User dialog box and specify SmartPlant Instrumentation logon name
and password for every user.
Related Topics

User Groups: An Overview, page 93

Users and Groups Common Tasks, page 94

Windows Authentication Logon Method: An Overview, page 99

102 SmartPlant Instrumentation Administration Users Guide

System Administration: An Overview

System Administration: An Overview


System Administration is a set of activities that provide for the management of the
database infrastructure. These activities include creating and defining a working
environment, creating and managing user profiles (including the Domain
Administrator), setting audit trail options, setting up database security, generating
certain reports, and managing user sessions on multi-user versions.
Related Topics

Domain Administration: An Overview, page 146

System Administration Common Tasks, page 104

Working with Administration Module: An Overview, page 15

SmartPlant Instrumentation Administration Users Guide 103

System Administration: An Overview

System Administration Common Tasks


The System Administrator is responsible for defining and managing a domain, setting
up the security definitions, for example, password encryption, whether user names are
required to be unique, and how the software responds to users who log on with
incorrect passwords. The System Administrator is also responsible for setting audit
trail options, generating certain reports, and managing user sessions on multi-user
versions.
As System Administrator, you can perform the following sets of tasks:
Domain Management Common Tasks
The System Administrator has to define and manage the SmartPlant Instrumentation
domains. For more information, see Domain Management Common Tasks, page 106.
Manage Database Security
This set of procedures explains how to define your database security . For more
information, see Database Security Common Tasks, page 120.
Create and Manage User Profiles and Departments
This set of procedures deals with defining SmartPlant Instrumentation users and
assigning them to various departments. For more information, see Create and
Manage User Profiles and Departments Common Tasks, page 88.
Manage Accounting, Contractors and Clients
The System Administrator can create and maintain a list of accountants, contractors,
and clients that you can associate with the domain. This information is used for
reference only it is not accessed elsewhere in the software. For more information,
see Accounting, Contractors, and Clients Common Tasks, page 140.
Import Interface Languages
This feature enables the System Administrator to add an interface language which is
currently not supported in SmartPlant Instrumentation. For more information, see
Import Interface Languages, page 143.
Generate Reports
As System Administrator, you can generate domain and activity reports. For more
information, see Report Generation (System Administration), page 145.

104 SmartPlant Instrumentation Administration Users Guide

System Administration: An Overview


Maintain the Database
As System Administrator, you are required to deal with certain tasks that keep the
integrity of your database in tact. SQL Server and Oracle require different
maintenance tasks. However, there are a number of procedures that are common to
all platforms. For more information, see Maintaining the SmartPlant Instrumentation
Database, page 125.
Related Topics

Domain Administration Common Tasks, page 147

Working with Administration Module: An Overview, page 15

SmartPlant Instrumentation Administration Users Guide 105

System Administration: An Overview

Domain Management Common Tasks


The following set of procedures deal with creating, defining, and managing a
SmartPlant Instrumentation domain. You can perform the following actions:
Make Domain Definitions
After initializing and associating a domain, you can set the definitions of the new
domain in the Domain Definition window. Later on, if required, you can change
some of these definitions. For example, you can change the domain type, activate or
deactivate the audit trail options, set the workflow option, set a plant hierarchy
separator, and so forth. For more information, see Make Domain Definitions, page
109.
Manage Activity Tracking
The domain activity tracking feature monitors the usage of every module in the
domain (except for the Administration module). For more information, see Activity
Tracking Management Common Tasks, page 115.
Activate the Audit Trail Functionality
This option allows the System Administrator to activate the audit trail mechanism.
As a result, the Domain Administrator will be able to trim and load audit trail records.
The System Administrator, however, can switch the audit trail functionality on or off
as required at any stage of the plant life-cycle. For more information, see Activate the
Audit Trail Functionality, page 113.
Enable Item Registry
The Item Registry is a table that can hold references to all items (tag and loop
numbers, wiring items, and so forth), and records with information about user
operations such as deleting, inserting, updating the domain data and so forth. When
the System Administrator activates the item registry options, the Domain
Administrator can register items in the Item Registry so that other applications can
retrieve SmartPlant Instrumentation data in an integrated environment. The System
Administrator can switch the item registry on or off as required at any stage of the
plant life-cycle. For more information, see Enable Item Registry, page 113.
Enable Cable Type Dependency
Cable type dependency is a method of managing cable data in the Wiring module.
Using this method, it is possible to create plant cables only by copying default cables,
where each default cable represents a specific cable type. As a result, certain cable
properties are fixed because they are cable type-dependent. This procedure explains
how the System Administrator can enable or disable cable type dependency at any
stage of the plant life-cycle. For more information, see Enable Cable Type
Dependency, page 111.

106 SmartPlant Instrumentation Administration Users Guide

System Administration: An Overview


Enable Workflow
This procedure explains how to activate the SmartPlant Instrumentation workflow
setup. When activated, the software displays the Workflow Browser in SmartPlant
Instrumentation to enable instrument engineers to implement the workflow setup. For
more information, see Enable Workflow, page 112.
Specify a Global Path
The System Administrator can use this procedure to specify a global path in
SmartPlant Instrumentation. It is useful to specify a common global path for all users
if you want the software to retrieve data from different users when performing a
domain backup. The System Administrator can set or change the global path any
time, at any stage of the plant life-cycle. For more information, see Specify a Global
Path, page 114.
Related Topics

System Administration Common Tasks, page 104

Working with Administration Module: An Overview, page 15

Create an Operating Owner Domain


Important
We do not recommend working in an Operating owner domain if it resides
in a stand-alone database. It is known that when using the Sybase
Adaptive Server Anywhere database engine, certain options in an
Operating owner domain are liable to work incorrectly.
1. Start the Administration module and log on as System Administrator.

2. Do one of the following to open the Domain Definition window:

Click File > Domain Definition.

Click .
3. From the Domain list, select a domain.

4. Click

Tip

The domain schema name and domain schema password values are set
only once, when you initialize the domain; therefore, you cannot edit
these values.

SmartPlant Instrumentation Administration Users Guide 107

System Administration: An Overview


5. From the Standard list, select a naming convention standard.
Tip
You can select a naming convention standard in the Standard box
only if you have not yet created the first instrument tag. For further
information about naming convention standards, see Define Naming
Conventions, page 245.
6. Under Domain type, click Operating owner.

Important
The options under Operating owner become permanently fixed in the
current domain after creating the first project.
7. Do one of the following:

Select Exclusive claim mode to enable SmartPlant Instrumentation


users to work in exclusive claim mode.

Clear Exclusive claim mode to enable SmartPlant Instrumentation


users to work in non-exclusive claim mode.
8. Do one of the following:

Select Merge without deleting from project to allow a Project


Administrator to merge a particular item with As-Built and retain a
copy of that item in the project.

Clear Merge without deleting from project to set the software to


delete the item from the project when merging this item with As-Built.
Tip

If you selected both the Excusive claim mode and Merge without
deleting from project check boxes, after a Project Administrator
merges project items with As-Built, it is still possible to claim these
item for a another project even though there are copies of these items
remaining in the project from which the items were merged with AsBuilt.
9. Set or update the remaining domain definitions as you require. For a detailed
description of domain features, see the Help topic Domain Definition Window.

10. On the window toolbar, click

Related Topics

Domain Management Common Tasks, page 106

Make Domain Definitions, page 109

Operating Owner Domain (As-Built and Projects) Common Tasks,


page 160

Operating Owner Domain (As-Built and Projects): An Overview, page 158

108 SmartPlant Instrumentation Administration Users Guide

System Administration: An Overview

Make Domain Definitions


1. Start the Administration module and log on as System Administrator.
2. Do one of the following to open the Domain Definition window:

Click File > Domain Definition.

Click

3. Click

.
to associate the domain in the database.

4. From the Domain list, select the required domain.


5. Click

Tip
The domain schema name and domain schema password values are set
only once, when you initialize the domain; therefore, you cannot edit
these values.
6. From the Standard list, select a naming convention standard.

Tip
You can select a naming convention standard in the Standard box
only if you have not yet created the first instrument tag. For further
information about naming convention standards, see Define Naming
Conventions, page 245.
7. Do one of the following to specify the domain type:

Click Operating owner to set the domain type as Operating owner


and enable users to work in projects or in As-Built. For further
information, see Create an Operating Owner Domain, page 107.

Click Engineering company to define the domain as an engineering


company if you do not need the As-Built functionality.
Caution

We do not recommend working in an Operating owner domain if it


resides in a stand-alone database. It is known that when using the
Sybase Adaptive Server Anywhere database engine, certain options in
an Operating owner domain are liable to work incorrectly.
8. Under Domain features, enable or disable the available domain features.

9. Under Workflow, select a desired option. For more information, see Enable
Workflow, page 112.
Tip

Workflow options are available only when the domain type is defined
as Engineering company. For an Operating owner domain, the
workflow is defined at the level of the projects in the domain.

SmartPlant Instrumentation Administration Users Guide 109

System Administration: An Overview


10. Under Specification title block, from the Custom title block assignment
method, select on of the following methods:

Standard (used in all modules) Allows the Domain


Administrator to select one specific custom title block to be assigned
to all specifications. After selecting this option, the software hides all
the title block assignment options that are available in the
Specifications module.

Special (used in Specifications module only) Allows users to


assign individual title blocks to any specification, using the title block
assignment options available in the Specifications module.
11. In the Plant hierarchy separator box, enter a single-character separator for all or
part of a plant hierarchy is displayed as a string. For example, if the separator
character is &, and you have plant hierarchy items My Plant, My Area, and My
Unit, in the Properties dialog box for the My Unit item, the software displays the
parent hierarchy as follows:
My Plant&My Area

12. Under Global path, click Browse to navigate to a folder which you want to set as
a global path folder. For more information, see Specify a Global Path, page 114.
13. On the window toolbar, click

Related Topics

Domain Management Common Tasks, page 106

Log on as System Administrator, page 85

System Administration Common Tasks, page 104

Title Block Descriptions, page 285

110 SmartPlant Instrumentation Administration Users Guide

System Administration: An Overview

Enable Cable Type Dependency


Important
Selecting the Cable type dependency option makes it impossible to
duplicate internal connections when duplicating cables or copying cables
from Domain Explorer to Reference Explorer in SmartPlant
Instrumentation. Also, the Cable type dependency option becomes
unavailable if a SmartPlant Instrumentation user selected the Copy
internal connections preference option on the Copy Items page of the
Wiring module preferences.
1. Start the Administration module and log on as System Administrator.

2. With the System Administration window open, do one of the following to open
the Domain Definition window:

Click File > Domain Definition.

Click .
3. From the Domain list, select a domain.

4. Do one of the following:

Click Options > Edit.

Click .
5. Under Domain features, select the Cable type dependency check box.

6. Click

to save the current domain data to the database.

Related Topics

Domain Management Common Tasks, page 106

Log on as System Administrator, page 85

System Administration Common Tasks, page 104

SmartPlant Instrumentation Administration Users Guide 111

System Administration: An Overview

Enable Workflow
Important
Your Domain Administrator needs to define access rights at the level of
individual instrument tags in order to implement workflow (for details, see
Workflow Access Rights, page 272).
1. Start the Administration module and log on as System Administrator.

2. With the System Administration window open, do one of the following to open
the Domain Definition window:

Click File > Domain Definition.

Click .
3. From the Domain list, select a domain.

4. Do one of the following:

Click Options > Edit.

Click .
5. In the Workflow section, from the Instrumentation and Process Data list,
select the required workflow from the following:

Full - the software activates all the workflow options, and marks
instrument tags for release as a formal issue in a binder package. The
Release to Spec option becomes available in the Document Binder
module and in the Spec Change Notification Options dialog box.

Without Document Binder - the software activates all the workflow


options except for the option to release instrument tags as a formal
issue in a binder package.

None - No workflow options are activated.

6. Click

to save the current domain data to the database.

Related Topics

Domain Management Common Tasks, page 106

Log on as System Administrator, page 85

System Administration Common Tasks, page 104

Workflow Access Rights, page 272

112 SmartPlant Instrumentation Administration Users Guide

System Administration: An Overview

Activate the Audit Trail Functionality


1. Start the Administration module and log on as System Administrator.
2. With the System Administration window open, do one of the following to open
the Domain Definition window:

Click File > Domain Definition.

Click .
3. From the Domain list, select a domain.

4. Click

to enable editing of the domain definitions.

5. Under Domain features, select Audit trail options.


6. Click

Related Topics

Domain Management Common Tasks, page 106

Log on as System Administrator, page 85

System Administration Common Tasks, page 104

Enable Item Registry


Important
Note that the following procedure does not register the items, but only
makes the item registry commands available on the DBA menu for the
Domain Administrator, who performs all the item registry activities.
1. Start the Administration module and log on as System Administrator.

2. With the System Administration window open, do one of the following to open
the Domain Definition window:

Click File > Domain Definition.

Click .
3. From the Domain list, select a domain.

4. Do one of the following:

Click Options > Edit.

Click .
5. Under Domain features, select the Item registry check box.

6. Click

to save the current domain data to the database.

Related Topics

Domain Management Common Tasks, page 106


SmartPlant Instrumentation Administration Users Guide 113

System Administration: An Overview

Specify a Global Path


Important
If you change the existing global path, all user-defined paths remain linked
to the previous global path. For example, if you change the global path
from \\APP_SERVER\SmartPlant\Instrumentation to
\\APP_SERVER_1\SmartPlant\Instrumentation, and a user has already
specified a path to the PSR folder, in the appropriate box, the user-defined
path is displayed as a full path
\\APP_SERVER\SmartPlant\Instrumentation\PSR.
1. Start the Administration module and log on as System Administrator.

2. With the System Administration window open, do one of the following to open
the Domain Definition window:

Click File > Domain Definition.

Click .
3. From the Domain list, select a domain.

4. Do one of the following:

Click Options > Edit.

Click .
5. In the Global path group box, click Browse to navigate to the folder which you
want to set as a global path.

Tips

We recommend that you specify a path that complies with universal


naming conventions (that is, it starts with \\). If you want to use
mapped drives, make sure that all SmartPlant Instrumentation users
have the same drive mapping.

A global path does not apply to individual temporary folder settings.

Select Allow to overwrite the global path if you want to allow users
to set user-defined paths in addition to the specified global path.
When this check box is selected, users are not restricted to setting new
paths in SmartPlant Instrumentation only within the global path folder.

6. Click

to save the current domain data to the database.

Related Topics

Domain Management Common Tasks, page 106

Log on as System Administrator, page 85

System Administration Common Tasks, page 104

114 SmartPlant Instrumentation Administration Users Guide

System Administration: An Overview

Activity Tracking Management Common Tasks


The domain activity tracking feature monitors the usage of every module in the
domain (except for the Administration module). You can perform the following
actions:
Set the Activity Tracking Mode
You can use the activity tracking functionality to log user activity, that is, to show
which modules users have worked in and the length of time for which they were
logged on. You can also switch off activity tracking to obtain faster performance.
For more information, see Set the Activity Tracking Mode, page 116.
Clear Activity Tracking Data
You can delete some or all of the activity-tracking data, if required. You can delete
the activity-tracking according to a selected time period, user, domain, or module.
For more information, see Clear Activity Tracking Data, page 116.
Generate a Grid-Style Activity Tracking Report
This option enables you to generate a report in tabular format showing usage of
SmartPlant Instrumentation according to domain, module, and user. For more
information, see Generate a Grid-Style Activity Tracking Report, page 117.
Generate a Graph-Style Activity Tracking Report
This option enables you to generate a report in graphical format showing usage of
SmartPlant Instrumentation according to domain, module, and user. For more
information, see Generate a Graph-Style Activity Tracking Report, page 118.
Related Topics

Domain Management Common Tasks, page 106

System Administration Common Tasks, page 104

Working with Administration Module: An Overview, page 15

SmartPlant Instrumentation Administration Users Guide 115

System Administration: An Overview

Set the Activity Tracking Mode


1. With the System Administration window open, do one of the following:

Click File > Domain Definition.

Click .
2. From the Domain list, select the required domain.

3. Do one of the following:

Click Options > Edit.

Click .
4. Under Domain features, select or clear the Activity Tracking check box.

5. Click

to save the current domain data to the database.

Related Topics

Activity Tracking Management Common Tasks, page 115

Domain Management Common Tasks, page 106

System Administration Common Tasks, page 104

Clear Activity Tracking Data


1. With the System Administration window open, click DBA > Clear Activity
Tracking.
2. To delete the activity tracking data according to a selected time period, select the
Period check box to include the time period in the deletion criteria.
3. In the From and To data fields, type the appropriate date range.
4. To delete the activity tracking data according to a selected user, select the User
check box to include a user in the deletion criteria. (Clearing the User check box
allows you to delete the activity tracking data for all users.)
5. From the User list, select the user whose activity tracking data you want to delete.
6. To delete the activity tracking data according to a selected domain, select the
Domain name check box to include the domain name in the deletion criteria.
(Clearing the Domain name check box allows you to delete the activity tracking
data for all domains.)

116 SmartPlant Instrumentation Administration Users Guide

System Administration: An Overview


7. From the Domain name list, select the domain whose activity tracking data you
want to delete.
8. To delete the activity tracking data according to a selected module, select the
Module check box to include the module name in the deletion criteria. (Clearing
the Module check box allows you to delete the activity tracking data for all
modules.)
9. From the Module list, select the module whose activity tracking data you want to
delete.
Tip
To clear activity tracking, you must select at least one check box.
10. Click OK.

Related Topics

Activity Tracking Management Common Tasks, page 115

Domain Management Common Tasks, page 106

System Administration Common Tasks, page 104

Generate a Grid-Style Activity Tracking Report


1. Click Report > Activity Tracking - Grid.
2. From the Main category list, select the main category according to which you
want to display the information.
3. From the Secondary category list, select the secondary category according to
which you want to display the information.
4. In the Period section, type the range of dates (From, To) for which you want to
generate the report.
Important
The date format must comply with the one defined in your system.
See your Windows User Guide for additional information about the
date format supported by your system.
5. In the Deleted domains section, do one of the following:

Click Ignore to display only current domains in the report.

Click Include to display deleted domains in the report.

SmartPlant Instrumentation Administration Users Guide 117

System Administration: An Overview


6. In the Terminated activities section, do one of the following:

Click Include to display terminated activities (these are activities


where the software closed down due to a power failure or restarting the
workstation by pressing Ctrl + Alt + Del).

Click Exclude to exclude terminated activities from the report.

Click Only to display only terminated activities in the report.


7. Click OK to open the Print Preview dialog box, from where you can view and
print the report.

Note

If Domain and User are selected as the main and secondary categories,
the hours shown in the third column are divided per module. In all other
cases, only the total number of hours is shown.

Related Topics

Activity Tracking Management Common Tasks, page 115

Domain Management Common Tasks, page 106

Generate a Graph-Style Activity Tracking Report, page 118

Report Generation (System Administration), page 145

System Administration Common Tasks, page 104

Generate a Graph-Style Activity Tracking Report


1. Click Report > Activity Tracking - Graph.
2. From the Main category list, select the main category according to which you
want to display the information.
3. From the Secondary category list, select the secondary category according to
which you want to display the information.
Tips

Selecting the Domain option from either of the category lists enables
you to select up to ten domains to show in the report.

Selecting the User option from either of the category lists enables you
to select up to ten users to show in the report.

For the secondary category, selecting the General option means that
the activities will be divided according to the main category only.

118 SmartPlant Instrumentation Administration Users Guide

System Administration: An Overview


4. In the Period section, type the range of dates (From, To) for which you want to
generate the report.
Important
The date format must comply with the one defined in your system.
See your Windows User Guide for additional information about the
date format supported by your system.
5. In the Deleted domains section, do one of the following:

Click Ignore to display only current domains in the report.

Click Include to display deleted domains in the report.


6. In the Terminated activities section, do one of the following:

Click Include to display terminated activities (these are activities


where the software closed down due to a power failure or restarting the
workstation by pressing Ctrl + Alt + Del).

Click Exclude to exclude terminated activities from the report.

Click Only to display only terminated activities in the report.


7. In the Graph type section, select one of the following graph types:

Area - filled-area graph.

Bar - horizontal bar graph.

Column - vertical graph.

Pie - pie graph.


8. Click OK to open the Print Preview dialog box, from where you can view and
print the report.

Related Topics

Activity Tracking Management Common Tasks, page 115

Domain Management Common Tasks, page 106

Generate a Grid-Style Activity Tracking Report, page 117

Report Generation (System Administration), page 145

System Administration Common Tasks, page 104

SmartPlant Instrumentation Administration Users Guide 119

System Administration: An Overview

Database Security Common Tasks


As System Administrator, you are responsible for setting up the general security
definitions, for example, password encryption, whether user names are required to be
unique, and how the software responds to users who log on with incorrect passwords.
You are also responsible for managing multiple user connections and database
locking options for multi-user platforms.
You can perform the following procedures:
Change the System Administrator Password
After logging on to SmartPlant Instrumentation for the very first time, it is
recommenced that you change the default System Administrator logon password,
which is DBA. This procedure explains how to do it. For more information, see
Change System Administrator Password, page 121.
Encrypt the Admin Schema Logon Password
This procedure allows you to encrypt the Admin schema logon password to prevent
unauthorized connections to the Admin schema. After you encrypt the password,
users who do not know the Admin schema logon password cannot connect to the
Admin schema to view names and passwords of other users, modify or deleting data
in the Admin schema tables. For more information, see Encrypt the Admin Schema
Logon Password, page 121.
Encrypt All User Password
This option allows you to encrypt all user passwords and prevent other users,
including the System Administrator or any other database super user, from logging on
other than under their own logon name. For more information, see Encrypt All User
Passwords, page 122.
Set Security Options
You can increase security when logging on to SmartPlant Instrumentation by
ensuring that every user logs on using a unique password. You can also specify a
minimum length of five characters for passwords. For more information, see Set
Security Options, page 122.
Set the Database Locking Mode
This option enables you to work faster in a multi-user version of SmartPlant
Instrumentation by disabling database locking. For more information, see Set
Database Locking Mode, page 124.
Related Topics

System Administration Common Tasks, page 104

Working with Administration Module: An Overview, page 15

120 SmartPlant Instrumentation Administration Users Guide

System Administration: An Overview

Change System Administrator Password


1. With the System Administration window open, click File > Change Password.
2. In the Current password field, type the current System Administrator logon
password.
3. In the New password field, type the new System Administrator logon password.
4. In the Confirm new password field, retype the new password, and click OK.
Notes

The passwords that you type appear masked.

The System Administrator logon password is not case-sensitive.

Related Topics

Database Security Common Tasks, page 120

Working with Administration Module: An Overview, page 15

Encrypt the Admin Schema Logon Password


1. With the System Administration window open, click DBA > Security Options
> Admin Schema Password Encryption.
2. Type the new Admin schema logon password.
3. Click OK.
Notes

This option is not available in Sybase Adaptive Server Anywhere.

After you select to encrypt the Admin schema logon password the values
of the LogId and LogPassword are automatically cleared from the
[Database] section of intools.ini file on the System Administrator's
workstation. On all other workstations, the System Administrator has to
delete the values of these parameters, including the equal sign (=).
For example, where the parameters are displayed as shown:
LogId=IN_DBAMN
LogPassword=IN_DBAMN
You should delete the string =IN_DBAMN in each of the lines.

To revert to the previous password settings, replace the text


=IN_DBAMN for the above parameters in the intools.ini file.

Related Topics

Database Security Common Tasks, page 120

Encrypt All User Passwords, page 122

System Administration Common Tasks, page 104

Working with Administration Module: An Overview, page 15

SmartPlant Instrumentation Administration Users Guide 121

System Administration: An Overview

Encrypt All User Passwords


1. With the System Administration window open, click DBA >
Security Options > User Password Encryption.
2. Click OK to encrypt all SmartPlant Instrumentation user passwords.
Note

The Database System Administrator or any user with the appropriate


database access rights can access the users' logon information stored in the
USERS table. See your database platform User Guide for further
information about the available facilities to access the database tables.

Related Topics

Database Security Common Tasks, page 120

Encrypt the Admin Schema Logon Password, page 121

Set Security Options, page 122

System Administration Common Tasks, page 104

Working with Administration Module: An Overview, page 15

Set Security Options


1. With the System Administration window open, click Activities > Security
Options.
2. In the Security Options dialog box, select the check boxes as required.
Note

If you want to select or clear the Enable Windows authentication logon


method check box, we strongly recommend that you read the Windows
Authentication Logon Method: An Overview, page 99 topic. Enabling or
disabling this option can prevent certain users from accessing SmartPlant
Instrumentation.

Related Topics

Database Security Common Tasks, page 120

System Administration Common Tasks, page 104

Windows Authentication Logon Method: An Overview, page 99

Working with Administration Module: An Overview, page 15

122 SmartPlant Instrumentation Administration Users Guide

System Administration: An Overview

Database Locking Mode (for Multi-User Versions)


This option enables you to work faster in a multi-user version of SmartPlant
Instrumentation by disabling database locking. Normally, when working in a multiuser environment such as Oracle or SQL Server, all database objects, for example,
triggers, stored procedures, and so forth become automatically locked. Locking
objects prevents sharing violation problems from happening when several users try to
access the same instrumentation data item at the same time. Note that this locking
mechanism slows down your work.
In multi-user versions of SmartPlant Instrumentation (Oracle and SQL Server), all
database objects are locked by default. However, depending on the way you manage
your database, you can unlock all database objects, thus making the software work
faster. You can also revert to the default mode and lock the database objects any time
you need.
To learn how to set your database locking mode, see Set Database Locking Mode,
page 124.
Notes

Remember that once you unlock your database objects, there is no


mechanism which prevents sharing violation problems from happening.
In this case database problems can occur when more than one user tries to
work on the same item.

Related Topics

Database Maintenance on SQL Server Common Tasks, page 132

Database Security Common Tasks, page 120

Set Database Locking Mode, page 124

Working with Administration Module: An Overview, page 15

SmartPlant Instrumentation Administration Users Guide 123

System Administration: An Overview

Set Database Locking Mode


1. Start the Administration module and enter as System Administrator.
2. In the System Administration window, do one of the following:

Click File > Domain Definition.

Click .
3. In the Domain Definition window, from the Domain list, select the domain
whose locking mode you want to change.

4. Click
5. Under Domain features, select Single mode to enable locking of items and to
switch to multi-user mode.
6. Click
Related Topics

Database Locking Mode (for Multi-User Versions), page 123

Database Security Common Tasks, page 120

Working with Administration Module: An Overview, page 15

124 SmartPlant Instrumentation Administration Users Guide

System Administration: An Overview

Maintaining the SmartPlant Instrumentation


Database
As System Administrator, you are required to deal with certain tasks that keep the
integrity of your database in tact. Maintenance tasks differ from database platform to
database platform. However, there are a number of procedures are common to all
platforms. The maintenance procedures are grouped according to the following
categories.

General Database Maintenance Common Tasks, page 126

Database Maintenance on SQL Server Common Tasks, page 132

Database Maintenance on Oracle Common Tasks, page 136

Related Topics

System Administration Common Tasks, page 104

System Administration: An Overview, page 103

Working with Administration Module: An Overview, page 15

SmartPlant Instrumentation Administration Users Guide 125

System Administration: An Overview

General Database Maintenance Common Tasks


The following tasks are used frequently when you need to perform general database
maintenance tasks.
Define Databases for Logging On to SmartPlant Instrumentation
This procedure allows you to enable SmartPlant Instrumentation users to select a
database when logging on to SmartPlant Instrumentation. After performing this
procedure, users can select a database from the Database list on the Logon
Information dialog box and connect to this database. All the databases that you want
to make available for connection must belong to the same database platform: Oracle,
SQL Server, or Sybase Adaptive Server Anywhere. For more information, see Define
Databases for Logging On to SmartPlant Instrumentation, page 127.
Rebuild Default Views in Domains
The System Administrator can rebuild the default views of all the database objects for
a domain that you specify. You must rebuild the default views after upgrading
SmartPlant Instrumentation to Version 7. This is because during the upgrade, the
software makes changes to certain tables, and as a result, the default views associated
with these tables might become invalid. For more information, see Rebuild Default
Views in Domains, page 129.
Rebuild Stored Procedures and Triggers
The System Administrator performs this procedure if the software displays
inappropriate SQL messages. This procedure allows to identify abnormal database
behavior and solve it by rebuilding the stored procedures and triggers in the database.
You can recreate stored procedures either for the Admin schema or for the Domain
schema. For more information, see Rebuild Stored Procedures and Triggers,
page 130.
Rebuild Catalog Tables
The software uses catalog tables to enable users to work with multi-tag specifications
in the Specifications module. The software creates the catalog tables during the
SmartPlant Instrumentation database setup. If the software encounters a database
problem when creating the catalog tables, you can try to rebuild them to resolve the
problem. If such a problem occurs, the software displays a message notifying you
that you cannot work with multi-tag specifications due to a problem with the catalog
tables. For more information, see Rebuild Catalog Tables, page 131.
Related Topics
Maintaining the SmartPlant Instrumentation Database, page 125

System Administration Common Tasks, page 104

System Administration: An Overview, page 103

126 SmartPlant Instrumentation Administration Users Guide

System Administration: An Overview

Define Databases for Logging On to SmartPlant


Instrumentation
Prerequisite for SQL Server
You must define a separate ODBC profile for each database you want to make
available for selection on the Logon Information dialog box of SmartPlant
Instrumentation. This is required because SQL Server uses an ODBC profile to
connect to the SmartPlant Instrumentation database. When you install SmartPlant
Instrumentation on a client machine, in the client Windows registry, the software
creates an empty profile. Depending on your SQL Server version, the default ODBC
profile is either MSS2000 or MSS2005. After running the DB Setup Utility, the
software automatically fills in the profile setting in the client Windows Registry and
adds a database connection string in the [Database] section of the Intools.ini file. If
you run the DB Setup Utility again to create another SmartPlant Instrumentation
database in SQL Server, the software overwrites the previous connection settings in
the Intools.ini file. Therefore, you cannot use the same ODBC profile for connection
to different databases. You create a new ODBC profile using the Windows Data
Sources (ODBC) option and define a unique DSN value, for example, MSS2005_1.
Prerequisite for Sybase Adaptive Server Anywhere
You must define an ODBC profile for each database you want to make available for
selection on the Logon Information dialog box of SmartPlant Instrumentation. You
can create ODBC profiles using the Internal Setup Utility or Windows Data Sources
(ODBC) option.
1. In the Intools.ini file, create a [Profiles] section and define the list of databases
you want to display on the Logon Information dialog box in the Database list:
[Profiles]
Database1=My_Database1
Database2=My_Database2
Database3=My_Database3
Default=My_Database1
Tips

The Database<number> parameter does not have to be the actual


name of the database (or profile names if the database type is SQL
Server or Sybase Adaptive Server Anywhere). This value is a display
name that appears in the in the Database list on the Logon
Information dialog box.

The Default parameter value is the database that appears selected by


default in the Database list on the Logon Information dialog box.

SmartPlant Instrumentation Administration Users Guide 127

System Administration: An Overview


2. For each database that appears in the [Profiles] section, create a separate
[Database<number>] section and define the connection parameters. The
following table shows one example for each database type.
Example for Oracle

Example for SQL Server


2005

Example for Sybase Adaptive


Server Anywhere

[Database1]
DBMS=O90
LogId=IN_DBAMN
LogPassword=IN_DBAMN
ServerName=Oracle
Database=ORC1
UserId=
DatabasePassword=
TableDir=0
StayConnected=1
AutoCommit=0
DBParm='DisableBind=1'
Prompt=110
Commit=100

[Database1]
DBMS=MSS
LogId=SPI_DBAMN
LogPassword=SPI_DBA
ServerName=
Database=
UserId=
DatabasePassword=
TableDir=0
StayConnected=1
AutoCommit=0
DBParm="ConnectString=
'DSN=MSS2005;UID=SPI_DBAMN;
PWD=SPI_DBA',DisableBind=1"
DSN=MSS2005
Prompt=110
Commit=100

[Database1]
DBMS=ODBC
LogId=IN_DBAMN
LogPassword=IN_DBAMN
ServerName=
Database=
UserId=
DatabasePassword=
TableDir=0
StayConnected=1
AutoCommit=0
DBParm=
ConnectString='DSN=IN_DEMO;
UID=IN_DBAMN;PWD=IN_DBAMN'
Prompt=110
Commit=100

Tips

When the database type is SQL Server, the DisableBind=1 is not the
only value of the DbParm parameter. Make sure that it is not
enclosed by single quotes and is separated from other values by a
comma, as shown in the example in the table.

The LogId parameter value corresponds to the default Admin schema


logon name. When your database resides in SQL Server, the default
Admin schema logon name is SPI_DBAMN. This setting must be
different from the Admin schema logon password, which is the value
of the LogPassword parameter.
3. Save and close the Intools.ini file.

4. Test the software by opening Logon Information dialog box and checking the
Database list values.
Tip

The databases that appear in the Logon Information dialog box are
specific to the platform to which you have connected; databases
belonging to other platforms do not appear.

Note

When the user, on the Logon Information dialog box, selects a database
and click OK, the software populates the [Database] section of the
Intools.ini file with information you specified in the Intools.ini file for the
selected database.

128 SmartPlant Instrumentation Administration Users Guide

System Administration: An Overview

Rebuild Default Views in Domains


Important

You can only rebuild the default views supplied with the SmartPlant
Instrumentation database. You cannot rebuild any user-defined views.

Make sure that all users have logged out of the database before starting
this procedure.
1. With the System Administration window open, click DBA > Rebuild Default
Views in Domains.

2. From the Domain list, select the domain whose database views you want to
rebuild.
3. In the View-Only Domain schema password box, enter the logon password of
the View-Only Domain schema. The password characters appear masked.
Tip
You can change the password only once, when initializing a new
domain. If you did not change the password when initializing the
selected domain, enter the default logon password, which is <Domain
schema logon name>_VIEW.
4. If working on SQL Server, type the SQL Server System Administrator's
password.

5. Click OK to start rebuilding the views of the selected domain.


Related Topics

Database Maintenance on SQL Server Common Tasks, page 132

General Database Maintenance Common Tasks, page 126

SmartPlant Instrumentation Administration Users Guide 129

System Administration: An Overview

Rebuild Stored Procedures and Triggers


Cautions

This procedure should not be handled without Intergraph Support


supervision.

Make sure that all users have logged out of the SmartPlant Instrumentation
database before starting this procedure. When you start rebuilding stored
procedures and triggers, no users should attempt to log on to SmartPlant
Instrumentation.
1. With the System Administration window open, click DBA > Rebuild
Procedures and Triggers.

2. Do one of the following:

Click Admin schema to rebuild stored procedures and triggers of the


Admin schema.

Click Domain schema and then, under Domain, select a domain for
which you can rebuild stored procedures and triggers.
3. Click OK.

Tips

When upgrading the Admin schema, the Domain list is redundant as


its value is DEFAULT.

At this point you can select the default LOG.TXT file. This file will
contain the update process information of your current update session
and any errors that may have occurred. The log file is incremented if
you use the same log file name.

If the upgrade stops for any reason (for example, insufficient memory),
you can restart the process and the upgrade will continue from where it
stopped. If you get an error that cannot be corrected, contact Customer
Support with the error description. It is recommended that you have
your log file available when calling Customer Support.
4. In the Database Upgrade dialog box, click OK to start updating the stored
procedures and triggers of the selected schema. At the end of the upgrade process,
an appropriate message is displayed and the LOGERROR.TXT and the
LOG.TXT files are generated.

Note

The LOGERROR.TXT file is created automatically and lists any errors


that may have occurred. The data in this file is incremented between
sessions. Please send the LOGERROR.TXT file (if created) to Intergraph
Support after you complete the upgrade process.

130 SmartPlant Instrumentation Administration Users Guide

System Administration: An Overview

Rebuild Catalog Tables


Important
Make sure that all users have logged out of the SmartPlant Instrumentation
database before starting this procedure.
1. With the System Administration window open, click DBA > Rebuild Catalog
Tables.

2. Click OK to start rebuilding all the catalog tables.


Related Topics
General Database Maintenance Common Tasks, page 126

Rebuild Catalog Tables Dialog Box, page 486

SmartPlant Instrumentation Administration Users Guide 131

System Administration: An Overview

Database Maintenance on SQL Server Common


Tasks
SQL Server uses data files which are resized automatically as the data grows, until
the disk is full. When this happens, you can add another data file on a different disk.
The following tasks are used frequently when you need to perform database
maintenance tasks on SQL Server.
Add a Filegroup
Filegroups are used as containers for datafiles. A filegroup can be connected to one
database only. Usually, two filegroups are used for each domain: one for data tables
and the other for table indexes. You can backup and restore data for a filegroup. A
primary filegroup contains stored procedures and triggers. When deleting a domain,
the entire filegroup and the datafiles it contains are deleted, resulting in cleaner data,
without causing damage to the database. For more information, see Add a Filegroup,
page 133.
Print Filegroup Information
This procedure explains how the System Administrator can display the list of all the
existing SQL Server filegroups and print out the filegroup information. For more
information, see Print Filegroup Information, page 134.
Add a Log File
The database log file is used internally by SQL Server to backtrack aborted user
sessions. This way you can resume any previous sessions that you stopped or
canceled. This procedure explains how to add a log file. For more information, see
Add a Log File, page 134.
Add a Datafile to the TEMPDB Database
This option enables the System Administrator to add a datafile to the SQL Server
TEMPDB Database. This database is used internally by the SQL Server to make all
the required temporary operations. Such operations are needed when SmartPlant
Instrumentation brings data in a certain order, and the database needs to sort this set
of data after retrieving it. For more information, see Add a Datafile to the TEMPDB
Database, page 133.

132 SmartPlant Instrumentation Administration Users Guide

System Administration: An Overview


Optimize Indexes
You can use this option to optimize fragmented SQL Server indexes. The SQL
Server indexes become fragmented during the domain lifetime and contribute to
database under-performance. In this case you can rearrange your SQL Server indexes
to optimize them. As you keep storing and deleting domain data, the SQL Extents
become disordered thus slowing down SQL command execution. SmartPlant
Instrumentation solves this problem by reordering the indexes stored in these Extents.
For more information, see Optimize Indexes, page 135.
Related Topics

Maintaining the SmartPlant Instrumentation Database, page 125

System Administration Common Tasks, page 104

System Administration: An Overview, page 103

Add a Filegroup
1. With the System Administration window open, click DBA > Add Datafiles.
2. Click the Filegroup tab.
3. In the System Admin. Password field, type the password to log on as the
Database System Administrator (this field is empty by default).
4. In the New file information section, type the datafile name, the datafile location,
and the initial size (in MB).
5. Click Add to add the filegroup.
Related Topics

Database Maintenance on SQL Server Common Tasks, page 132

System Administration Common Tasks, page 104

Add a Datafile to the TEMPDB Database


Important
On SQL Server, TEMPDB is automatically incremented and depends on a
disk size. If TEMPDB reaches the disk limit, you can increase the
TEMPDB database size by adding a datafile to another disk.
1. With the System Administration window open, click DBA > Add Datafiles.

2. Click the Tempdb tab.


3. In the New file information section, type the datafile name, the datafile location,
and the initial size (in MB).
4. Click Add to add the datafile to the TEMPDB database.
Related Topics

Database Maintenance on SQL Server Common Tasks, page 132

SmartPlant Instrumentation Administration Users Guide 133

System Administration: An Overview

Print Filegroup Information


1. Start the Administration module and log on as System Administrator.
2. With the System Administration window open, click DBA > Filegroup List.
3. In the Filegroup List dialog box, review the existing filegroup information.
4. Click Print to print out the information displayed in the data window of the
Filegroup List dialog box.
5. Click Close.
Related Topics

Database Maintenance on SQL Server Common Tasks, page 132

System Administration Common Tasks, page 104

Add a Log File


Caution
You should exercise caution when adding a log file, as doing so affects the
entire SQL Server.
1. With the System Administration window open, click DBA > Add Datafiles.

2. Click the Log tab.


3. In the System Admin. Password field, type the password to log on as the
Database System Administrator (this field is empty by default).
4. In the New file information section, type the datafile name, the datafile location,
and the initial size (in MB).
5. Click Add to add the filegroup.
Related Topics
Database Maintenance on SQL Server Common Tasks, page 132

System Administration Common Tasks, page 104

134 SmartPlant Instrumentation Administration Users Guide

System Administration: An Overview

Optimize Indexes
Important
Before starting the optimization process, make sure that no other user is
using the currently selected domain. If you attempt to optimize the
indexes of a domain which is currently being used by another user, the
software displays a message warning you that the domain is currently in
use.
1. With the System Administration window open, click DBA > Optimize Indexes.

2. From the Domain list, select the required domain.


3. Do one of the following to define the tables you want to include in the
optimization process:

Click All tables to optimize the indexes of all the existing tables in the
defined domain.

Click Selected tables to display the database indexes in the Table


Name data window and optimize the indexes of the highlighted tables
in the defined domain.
4. Do one of the following to define the index source on which you base the
optimization:

Click Current database to optimize indexes using the current


database indexes.

Click Template database to optimize indexes using the


IN_TEMPL.DB template database indexes. Use the Template
database option if your current database indexes have been deleted or
become unusable.
5. Click OK.

Note

To enable better performance after completing the index optimization


process, you need to update statistics. Start the Query Analyzer and run
the SP_UPDATESTATS procedure.

Related Topics

Database Maintenance on SQL Server Common Tasks, page 132

System Administration Common Tasks, page 104

SmartPlant Instrumentation Administration Users Guide 135

System Administration: An Overview

Database Maintenance on Oracle Common Tasks


The following tasks are used frequently when you need to perform database
maintenance tasks on Oracle.
View Tablespace Data
Tablespaces are database domains where Oracle keeps your SmartPlant
Instrumentation database information. The tablespace data is physically stored in one
or more files. This option allows you to view a list of tablespaces in which there is
still free space to store data. For more information, see View Tablespace Data,
page 137.
Add Datafiles to Tablespaces
If your system reports that you ran out of space in the database tablespaces or if the
system fails to perform, you can use this option to increase the database tablespace by
attaching additional datafiles to an existing tablespace. For more information, see
Add Datafiles to Oracle Tablespaces, page 137.
Optimize Indexes
You can use this option to optimize fragmented Oracle database indexes. Oracle
database indexes become fragmented during the domain lifetime and contribute to
database under-performance. In this case, you can rearrange your database indexes to
optimize them. The domain index data is generated during the initialization phase.
The index data is grouped into one or more Extents which may account for the index
fragmentation level. As you keep storing and deleting domain data, the Oracle
Extents become disordered thus slowing down SQL command execution. SmartPlant
Instrumentation solves this problem by reordering the indexes stored in these Extents.
For more information, see Optimize Indexes, page 135.
Update Statistics
This option enables you to improve the Oracle SQL command processing
performance, especially after a large data import or after optimizing indexes, or after
initializing a domain on Oracle. During updating the statistics, SmartPlant
Instrumentation executes an ANALYZE SQL command which retrieves the statistical
data for the SmartPlant Instrumentation tables. That statistical information is later
used by the Oracle Cost-based Optimizer to optimize SQL command execution. For
more information, see Update Statistics, page 139.
Related Topics

System Administration Common Tasks, page 104

System Administration: An Overview, page 103

Working with Administration Module: An Overview, page 15

136 SmartPlant Instrumentation Administration Users Guide

System Administration: An Overview

View Tablespace Data

With the System Administration window open, click DBA > Tablespaces
List to display the data for all filegroups that have free space for storing
data.
Note

To learn about Oracle tablespaces, user logins, and how they are used in
SmartPlant Instrumentation, see Installation Guide, Installing SmartPlant
Instrumentation on Oracle > Running Oracle Database Setup > Oracle
Database Server Tablespaces.

Related Topics

Database Maintenance on Oracle Common Tasks, page 136

System Administration Common Tasks, page 104

Add Datafiles to Oracle Tablespaces


Important
This procedure enables you to the add a datafile to a tablespace.
Therefore, make sure you have enough free disk space on the drive where
the tablespace is stored.
1. With the System Administration window open, click DBA > Add Datafiles.

2. From the Tablespace list, select the tablespace you want to resize.
3. In the Datafile name box, type the full path and name of a new additional datafile
(.DB file format) that you want to attach to the currently selected tablespace.
Tip
Ensure that you select a datafile which is not currently in use.
4. In the Datafile size box, type the size of the additional datafile.

5. Click OK.
Note

The software displays an appropriate message notifying you that the


selected tablespace was increased successfully.

Related Topics

Database Maintenance on Oracle Common Tasks, page 136

System Administration Common Tasks, page 104

SmartPlant Instrumentation Administration Users Guide 137

System Administration: An Overview

Optimize Indexes
Important

Before optimizing indexes in SmartPlant Instrumentation tables, make


sure that in the Oracle Instance Configuration file, the
OPTIMIZER_MODE parameter value is either CHOOSE (default) or
COST. This way, you activate the Oracle Cost-based Optimizer, which
determines the quality of the SmartPlant Instrumentation database
performance.

Before starting the optimization process, make sure that no other user is
using the currently selected domain. If you attempt to optimize the
indexes of a domain which is currently being used by another user, the
software displays a message warning you that the domain is currently in
use.
1. With the System Administration window open, click DBA > Tuning >
Optimize Indexes.

2. From the Domain list, select the domain in which you want to optimize indexes.
Tips

The Fragmentation column displays the number of Extents of each


index.

It is recommended to optimize all database indexes whose


fragmentation level is higher than 4.
3. Do one of the following:

Click All tables to optimize the indexes for all the tables in the
selected domain.

Click Selected tables to display in the data window all the tables in
the current domain and optimize the indexes for the required tables.
4. Click OK to start the optimization process.

Note

To enable better performance after completing the index optimization


process, you need to update statistics. Without updating statistics, the
Oracle Cost-based Optimizer cannon use the reordered indexes.

Related Topics

Database Maintenance on Oracle Common Tasks, page 136

System Administration Common Tasks, page 104

138 SmartPlant Instrumentation Administration Users Guide

System Administration: An Overview

Update Statistics

With the System Administration window open, click DBA > Tuning >
Update Statistics.
Notes

This option is available to both System and Domain Administrator when


using SmartPlant Instrumentation on Oracle.

Related Topics

Database Maintenance on Oracle Common Tasks, page 136

System Administration Common Tasks, page 104

SmartPlant Instrumentation Administration Users Guide 139

System Administration: An Overview

Accounting, Contractors, and Clients Common


Tasks
As System Administrator, you can create lists of accountants, contractors, and clients.
This information is used for reference only it is not accessed anywhere else in the
software.
You can perform the following tasks:
Add and Manage Accounting Information
This option explains how to add and manage accounting information. For more
information, see Add and Manage Accounting Information, page 140.
Add and Manage Contractors
This option explains how to add and manage accounting information. For more
information, see Add and Manage Contractors, page 141.
Add and Manage Clients
This option explains how to add and manage accounting information. For more
information, see Add and Manage Clients, page 142.
Associate Accounting, Client, and Contractor Information with a Domain
This procedure deals with associating client, accounting, and contractor information
with a domain. For more information, see Associate Accounting, Client, and
Contractor Information with a Domain, page 143.
Related Topics

System Administration Common Tasks, page 104

Working with Administration Module: An Overview, page 15

Add and Manage Accounting Information


1. Start the Administration module and log on as System Administrator.
2. Do one of the following to open the Domain Definition window:

Click File > Domain.

Click .
3. From the Domain list, select the required domain.

4. Click Options > Add Accounting.


5. Click Accounting.
6. Click New.

140 SmartPlant Instrumentation Administration Users Guide

System Administration: An Overview


7. Type in the accounting name, number, and note as required.
8. Click Apply.
9. Click Close when done.
10. To associate an accounting item with the current domain, in the Add Accounting
dialog box, select the required accounting in the General list and drag it to the
Domain list.
Notes

To edit the properties of existing accounting information, select the


required accounting from the Accounting name list and click Edit.

To delete existing accounting information from the system, select the


required accounting from the Accounting name list and click Delete.

Related Topics

Accounting, Contractors, and Clients Common Tasks, page 140

Log on as System Administrator, page 85

System Administration Common Tasks, page 104

Add and Manage Contractors


1. Start the Administration module and log on as System Administrator.
2. Do one of the following to open the Domain Definition window:

Click File > Domain.

Click .
3. From the Domain list, select the required domain.

4. Click Options > Add Contractor.


5. Click Contractor.
6. Click New.
7. Type in the contractor name, number, and note as required.
8. Click Apply.
9. Click Close when done.
10. To associate a contractor with the current domain, in the Add Contractor dialog
box, select the required contractor in the General list and drag it to the Domain
list.
Notes

To edit the properties of existing contractor, select the required contractor


from the Contractor list and click Edit.

To delete existing contractor from the system, select the required


contractor from the Contractor list and click Delete.
SmartPlant Instrumentation Administration Users Guide 141

System Administration: An Overview

Add and Manage Clients


1. Start the Administration module and log on as System Administrator.
2. Do one of the following to open the Domain Definition window:

Click File > Domain.

Click .
3. From the Domain list, select the required domain.

4. Click Options > Add Client.


5. Click Client.
6. Click New.
7. Type in the client name, number, and note as required.
8. Click Apply.
9. Click Close when done.
10. To associate a client with the current domain, in the Add Client dialog box, select
the required client in the General list and drag it to the Domain list.
Notes

To edit the properties of existing client, select the required client from the
Client list and click Edit.

To delete existing client from the system, select the required client from
the Client list and click Delete.

Related Topics

Accounting, Contractors, and Clients Common Tasks, page 140

Log on as System Administrator, page 85

System Administration Common Tasks, page 104

142 SmartPlant Instrumentation Administration Users Guide

System Administration: An Overview

Associate Accounting, Client, and Contractor Information


with a Domain
1. Start the Administration module and log on as System Administrator.
2. Do one of the following to open the Domain Definition window:

Click File > Domain.

Click .
3. From the Domain list, select the required domain.

4. Click Options > Add Accounting (or Add Contractor or Add Client).
5. In the General list pane, select an item and drag it to the Domain pane.
6. Click Apply.
Notes

To dissociate an accounting, client, or contractor item from a domain,


select the item in the Domain pane and drag it back to the General list
pane.

Related Topics

Accounting, Contractors, and Clients Common Tasks, page 140

Log on as System Administrator, page 85

System Administration Common Tasks, page 104

Import Interface Languages


This feature enables the System Administrator to add an interface language which is
currently not supported in SmartPlant Instrumentation. Afterwards, it can be used in
all the domains in your SmartPlant Instrumentation installation. To do this, you must
first add the required language which can be purchased separately as an add-on.
Then, when the required language has already been defined in the software, you can
switch to it.
The following languages are currently available:

English (by default)

French

German

Custom (see Getting Started, Selecting the Interface Language, Creating


New Customized Phrases for details).

SmartPlant Instrumentation Administration Users Guide 143

System Administration: An Overview


Prior to switching to another interface language, you must add this language to the
database. This process is referred to as importing a language into the database. You
import the language from a language database file provided to you as an add-in to
SmartPlant Instrumentation.
1. With the System Administration window open, click Add-Ins > Language.
Tip
If you have not purchased the appropriate language add-in, the
Language menu item will be inactive. In this case the only available
interface language is English.
2. Locate the path and filename of the language database file in one of the following
ways:

In the File name and path box, type the path and filename of the
language database file (the default file is IN_CTLOG.DB).

Click Browse to navigate to the required language database file.


3. Click Connect to display the languages available in the language database file in
the Language data window.

Important
If you get a message stating that the connection has failed, make sure
you typed in the correct path and filename of the database file (see step
2 of this procedure).
4. In the Language section, do one of the following:

Select the required language to add.

Select Custom to be able to replace the phrases in the current


SmartPlant Instrumentation user interface with your own phrases.
5. If you have already imported the selected language before, do one of the
following:

Select the Overwrite previously imported items check box to


overwrite the existing interface terms and phrases.

Clear this check box if you want to add new terms and phrases to the
previously imported language without overwriting any existing terms
or phrases.
6. Click Import to add the selected language to the database.

Related Topics

SmartPlant Instrumentation Interface Language: An Overview, page 365

System Administration Common Tasks, page 104

144 SmartPlant Instrumentation Administration Users Guide

System Administration: An Overview

Print Database Connection Information


1. Start the Administration module and log on as System Administrator.
2. With the Domain Administration window open, on the menu bar, click DBA >
Active Database Connections.
3. Click Print.
Related Topics
Active Database Connections Dialog Box, page 375

Clearing Locking Common Tasks, page 322

Clearing Locking: An Overview, page 321

Report Generation (System Administration)


As System Administrator, you can generate domain and activity reports.
The following table describes the reports that are available on the Report menu.
Report

Description

Domain Information

Accounting, client, and contractor information.

Domain List

Information about every domain in the database as


shown in the Domain Definition window.

User List per Department

SmartPlant Instrumentation users listed according to


departments.

Activity Tracking Grid

A tabulated print-out activities of a given user on the


basis of each domain or each module where that user
works, a given domain or module. The system
actually tracks the time between the user entering and
leaving a module.

Activity Tracking Graph

A graphical print-out activities of a given user on the


basis of each domain or each module where that user
works, a given domain or module. The system
actually tracks the time between the user entering and
leaving a module.

Note

The Administration module is not included in the Activity Tracking report


options.

Related Topics

Generate a Graph-Style Activity Tracking Report, page 118

Generate a Grid-Style Activity Tracking Report, page 117

System Administration Common Tasks, page 104

SmartPlant Instrumentation Administration Users Guide 145

Domain Administration: An Overview

Domain Administration: An Overview


Domain Administration is a set of activities that provide for the management of
database resources defined by a System Administrator. These activities include
defining projects where the working environment is an Operating owner domain,
managing a working environment which is defined as an Engineering company
domain, and so forth.
Related Topics

Domain Administration Common Tasks, page 147

Working with Administration Module: An Overview, page 15

146 SmartPlant Instrumentation Administration Users Guide

Domain Administration: An Overview

Domain Administration Common Tasks


The Domain Administrator is responsible for managing the resources that have been
set up by the System Administrator. The responsibilities of the Domain Administrator
include defining projects when the domain type is an Operating owner, or manage a
working environment which of an Engineering company domain. The Domain
Administration can grant access privileges for users, define item naming conventions,
set plant structure, set preferences, create custom tables, custom fields, and so forth.
As Domain Administrator, you can perform the following sets of tasks:
Plant Design and Structure
As the software organizes all the information in SmartPlant Instrumentation on a very
specific hierarchy level, users must access a particular unit when they start
SmartPlant Instrumentation. The Domain Administrator is responsible for setting up
and organizing the plant hierarchy that constitutes the structure of every plant. For
more information, see Plant Design and Structure Common Tasks, page 151.
Operating Owner Domain (As-Built and Projects)
The Operating owner domain is a domain with As-Built and projects. The database is
partitioned into several schemas: a single schema for As-Built and separate schemas
for projects. An operational plant exists and most of the activities are concerned with
routine maintenance or plant modernization (revamps). To facilitate plant
modernization, you can create a number of projects within an Operating owner
domain. Each project is defined for one plant only, and a plant can have several
associated projects. For more information, see Operating Owner Domain (As-Built
and Projects): An Overview, page 158.
Naming Conventions
This set of procedures deals with naming conventions. Naming conventions define
the parameters which will be the rule for building tag, loop, device panel, and device
cable names. For more information, see Naming Conventions: An Overview,
page 241.
Copying <Unit> Data
This set of procedures explains how to copy data from one <unit> to another. For
more information, see Copying Data: An Overview, page 325.
Users and Groups
This set of procedures deals with creating and managing user groups in a domain.
Also, there are topics that deal with Windows authentication logon method. For more
information, see User Groups: An Overview, page 93.

SmartPlant Instrumentation Administration Users Guide 147

Domain Administration: An Overview


Access Rights
After assigning users to groups, one of the key roles of the Domain Administrator is
to define user access rights. This set of procedures deals with setting and managing
access rights for all the users in the current domain on the appropriate access rights
level. For more information, see Access Rights: An Overview, page 258.
Preferences Management
This set of procedures deals with the management of preferences in SmartPlant
Instrumentation. The Domain Administrator can control the management of
preferences in the current domain as well as in all the projects if the domain type is
Operating owner. For more information, see Preferences Management: An Overview,
page 276.
Report Management
This set of procedures deals with tasks like associating a new title block with a report,
selecting archiving options, and defining revision management settings. For more
information, see Managing Reports: An Overview, page 282.
Working with Add-Ins
This set of procedures deals with various add-ins that are available after purchasing
the appropriate license. The add-ins include various libraries that contain item
resources, such as hook-ups, DCS hardware, DDP data for PDS, and so forth. For
more information, see Working with Add-Ins: An Overview, page 290.
Miscellaneous Tasks
This set of topics deals with various miscellaneous tasks that are performed by the
Domain Administrator. For more information, see Miscellaneous Domain
Administration Tasks, page 300.
Managing Audit Trail Data
The software provides for the ability to mark history changes and save information
about various user operations. These actions comprise the audit trail activities. For
more information, see Managing Audit Trail Data: An Overview, page 314.
Clearing Locking
This option enables the Domain Administrator to clear locking in multi-user
databases SQL Server or Oracle. For more information, see Clearing Locking: An
Overview, page 321.
Item Registry
This set of procedures deals with item registry activities for the integrated
environment. For more information, see Item Registry Activities: An Overview,
page 351.

148 SmartPlant Instrumentation Administration Users Guide

Plant Design: An Overview

Plant Design: An Overview


The software provides you with the flexibility of specifying your working
environment so that, whether you are designing and building an entirely new plant, or
modernizing an existing plant, you can use the software to maximum effect when
managing data.
In SmartPlant Instrumentation, the working environment is known as a domain,
which the System Administrator is responsible for setting up in the Administration
module. The type of domain depends on the starting point for your activities:

New plant design and construction The System Administrator selects


the domain type Engineering company, and you can create as many plants
as required within each domain. For details, see Plant Design and
Structure Common Tasks, page 151.

Plant modernization The System Administrator selects the domain


type Operating owner that includes As-Built. Within the domain, you
define projects for modifying the data in each plant. For details, see
Operating Owner Domain (As-Built and Projects): An Overview, page
158.

Once the System Administrator has set up the working environment, the Domain
Administrator is responsible for performing the activities.
The Domain Administrator is responsible for defining plant hierarchy levels and then
setting up and organizing the plant hierarchy level items. For example, on the Plant
level, it is possible to create several items such as Plant1, Plant2, Plant3, and so forth.
When you enter a domain for the first time, and open the Plant Hierarchy Explorer,
the software only displays the plant DEFAULT, provided that the System
Administrator has enabled the use of the default plant. The System Administrator has
rights to switch the default plant on or off until you create a plant hierarchy with more
than three levels.

SmartPlant Instrumentation Administration Users Guide 149

Plant Design: An Overview


When a user starts a module to access information, such as loops or tag numbers in
the Instrument Index module, the information is grouped on a per <unit> basis. For
this reason, users must select a <unit> before entering a module. Instrument tags are
therefore unique on the <unit> level. Wiring data, for example, equipment, line,
custom fields, and so forth, are defined per <plant> and are usable in all <units> that
belong to that <plant>. These items are, therefore, unique on the <plant> level.
Notes

When working in an integrated environment, there are certain


requirements relating to As-Built and projects.

It is recommended that you back up your database before performing any


engineering activities.

You must be granted full access rights for the ENGINEERING PROJECT
DEFINITION activity in order to be able to perform engineering
activities. To learn how to grant access rights, see Grant Access Rights for
Selected Items or Activities, page 270.

Related Topics

Domain Administration Common Tasks, page 147

Plant Design and Structure Common Tasks, page 151

Plant Hierarchy Explorer, page 464

150 SmartPlant Instrumentation Administration Users Guide

Plant Design: An Overview

Plant Design and Structure Common Tasks


The Domain Administrator can perform plant structure design tasks after the System
Administrator defines the domain type and sets all the necessary domain settings
using the options of the Domain Definition window. When designing a plant
structure, the Domain Administrator performs the following tasks
Create a Plant Hierarchy
A plant hierarchy consists of a minimum of three levels, to which you can assign as
many items as you require. For example, you can create a level My_Unit and then,
using the Plan t Hierarchy Explorer, create items Unit1, Unit2, Unit3, and so forth,
and assign these items to the My-Unit level.
Creating a plant hierarchy is the first stage of your plant structure design. This is
because after creating a first <plant> in the Plant Hierarchy Explorer, you cannot
change the plant hierarchy levels until you delete that plant. For more information,
see Create a Plant Hierarchy, page 152.
Define a Plant Owner
You define owners of <plants> prior to creating plant hierarchy items in the Plant
Hierarchy Explorer. When creating a new <plant> on the highest plant hierarchy
level, you need to assign this <plant> to an owner. For more information, see Define
a <Plant> Owner, page 153.
Create a Plant Hierarchy Item on the Highest Level
This procedure deals with creating and modifying a plant hierarchy item on the
highest level using the Plant Hierarchy Explorer. Plant is the default highest level
in a hierarchy that has three levels. For details, see Create a Plant Hierarchy Item on
the Highest Level, page 154.
Create a Plant Hierarchy Item on an Intermediate Level
This procedure deals with creating and modifying a plant hierarchy item on an
intermediate level using the Plant Hierarchy Explorer. Area is the default
intermediate level in a hierarchy that has three levels.
The number of intermediate levels depends on the level definitions you made in the
Plant Hierarchy dialog box. For example, if your plant hierarchy has four levels,
both Level 2 and Level 3 are intermediate levels. You can create items on any of
these levels. However, only on Level 3, which is the lowest intermediate level item,
you can create multiple <units>. For more information, see Create a Plant
Hierarchy Item on an Intermediate Level, page 155.

SmartPlant Instrumentation Administration Users Guide 151

Plant Design: An Overview


Create a Plant Hierarchy Item on the Lowest Level
This procedure deals with creating and modifying an item on the lowest plant
hierarchy level using the Plant Hierarchy Explorer. Unit is the default lowest level
in a hierarchy that has three levels. This procedure allows you to create a <unit> with
no module data. For more information, see Create a Plant Hierarchy Item on the
Lowest Level, page 156.
Copy Unit Data
This set of procedures deals with copying engineering data from one <unit> to
another. For more information, see Copying Data: An Overview, page 325.
Delete a Plant Hierarchy Item
Use this procedure to delete a plant hierarchy item. For more information, see Delete
a Plant Hierarchy Item, page 157.
Related Topics

Domain Administration Common Tasks, page 147

Plant Design: An Overview, page 149

Create a Plant Hierarchy


1. With the Domain Administration window open, on the Activities menu, click
Plant Hierarchy.
2. Using the options in the Plant hierarchy dialog box, set up the number of
hierarchy levels and name the levels as needed. You can set up your plant
hierarchy using the options as follows:

Click Add to add the lowest level in the plant hierarchy (the default
lowest level is Level 3).

Select a level, and then click Insert to add a new level above the
selected level.

Select a level, and then click Delete to delete the level that you do not
require.

Under Name, change or enter a new name for the level. The name that
you enter appears as the name of the appropriate folder in the Plant
Hierarchy Explorer.

152 SmartPlant Instrumentation Administration Users Guide

Plant Design: An Overview


Tips

You can delete any levels as long as three levels remain in the dialog
box after deletion. Three levels in the minimum number of plant
hierarchy levels.

You can add or insert levels only before creating the first plant in the
Plant Hierarchy Explorer.

You can change the level names at any stage of your domain life cycle.

Related Topics

Plant Design and Structure Common Tasks, page 151

Plant Design: An Overview, page 149

Plant Hierarchy Dialog Box, page 462

Plant Hierarchy Explorer, page 464

Define a <Plant> Owner


1. Start the Administration module and log on as Domain Administrator.
2. With the Domain Administration window open, do one of the following:

Click Activities > Owner.

Click .
3. Click New.

4. In the boxes, for the new owner profile, enter data as required.
5. Click Apply to save the new owner profile in SmartPlant Instrumentation.
Notes

To edit the profile of an existing owner, from the Owner list, select an
owner and click Edit.

To delete an owner, from the Owner list, select an owner and click
Delete.

Related Topics

Domain Administration Common Tasks, page 147

Log on as Domain Administrator, page 86

Plant Design and Structure Common Tasks, page 151

Plant Hierarchy Explorer, page 464

SmartPlant Instrumentation Administration Users Guide 153

Plant Design: An Overview

Create a Plant Hierarchy Item on the Highest Level


1. Start the Administration module and log on as Domain Administrator.
2. With the Domain Administration window open, on the toolbar, click

3. Right-click Plant Hierarchy Explorer.


4. Click New.
Tips

To modify properties of an existing highest level item, right-click the


, and then, on the shortcut
item itself, which is indicated by the icon
menu, click Properties.

To delete an item, right-click the item itself, and then, on the shortcut
menu, click Delete. To delete an item that has child items, you must
first delete the child items.
5. In General tab of the Plant Properties dialog box, in the <Plant> box, type the
new <plant> name.

Tip
The name must contain at least one character that is not space. The
maximum name length is fifty characters.
6. From the Owner list, select the appropriate owner for the new <plant>.

7. In the boxes, enter data as required.


8. If needed, click the Custom Fields tab to define custom field values to be
associated with the current <plant>.
Related Topics

Custom Fields Tab (Plant Hierarchy Item Properties Dialog Box),


page 390

General Tab (<Plant> Properties Dialog Box), page 466

Plant Design and Structure Common Tasks, page 151

Plant Design: An Overview, page 149

154 SmartPlant Instrumentation Administration Users Guide

Plant Design: An Overview

Create a Plant Hierarchy Item on an Intermediate Level


1. Start the Administration module and log on as Domain Administrator.
.

2. With the Domain Administration window open, on the toolbar, click

3. In the Plant Hierarchy Explorer, right-click any level under which the software
displays the icon
.
4. Click New.
Tips

To modify properties of an existing intermediate level item, expand


the plant hierarchy, right-click the appropriate item, which is indicated
by the icon
, and then, on the shortcut menu, click Properties.

The highest plant hierarchy level items are indicated by the icon

To delete an item, right-click the item itself, and then, on the shortcut
menu, click Delete. To delete an item that has child items, you must
first delete the child items.
5. From the Plant list, select a plant.

6. Click New.
7. In the <Area> data field, type a new <area> name.
Tips

The intermediate level item name must be unique within the current
node of the parent level.

The name must contain at least one character that is not space. The
maximum name length is fifty characters.
8. In the boxes, enter data as required.

9. If needed, click the Custom Fields tab to define custom field values to be
associated with the current intermediate level item.
Related Topics

Custom Fields Tab (Plant Hierarchy Item Properties Dialog Box),


page 390

General Tab (<Area> Properties Dialog Box), page 390

Plant Design and Structure Common Tasks, page 151

SmartPlant Instrumentation Administration Users Guide 155

Plant Design: An Overview

Create a Plant Hierarchy Item on the Lowest Level


1. Start the Administration module and log on as Domain Administrator.
2. With the Domain Administration window open, on the toolbar, click

3. In the Plant Hierarchy Explorer, expand the plant hierarchy until you display
the lowest level icon
.
4. Right-click the intermediate level above the icon

Tips

Intermediate level items are indicated by the icon

To modify properties of an existing item, right-click the item itself,


and then, on the shortcut menu, click Properties.

To delete an item, right-click the item itself, and then, on the shortcut
menu, click Delete. To delete an item that has child items, you must
first delete the child items.
Caution

Make sure you select the appropriate plant hierarchy node before you
click New. After creating a <unit>, you cannot move it to another
plant hierarchy node.
5. On the shortcut menu, click New.

6. In the General tab of the <Unit> Properties dialog box, in the Name box, type a
unit name which is unique within the current node of the parent level.
Tip

The name must contain at least one character that is not space. The
maximum name length is fifty characters.

156 SmartPlant Instrumentation Administration Users Guide

Plant Design: An Overview


7. In the Number field, type a unit number which is unique within the current node
of the parent level.
Tips

The value you type in the Number data field is generally used in the
prefix part of the tag number naming conventions. For further
information, see Define Naming Conventions, page 245. You do not
have to define the unit number if you plant to define naming
conventions without using the <unit> number segment. However, you
must define the <unit> number if you want to copy data from another
<unit> even if in the source <unit>, naming conventions do not
include the <unit> number segment.

If you change the unit number of a unit which already has naming
conventions with the unit number segment, the new naming
convention applies to existing items as well as for new items.

In the Custom Fields tab, you can define custom field values to be
associated with the current <unit>.
8. Do one of the following:

Click Copy From to copy data from another existing unit.

Click OK to create the empty unit and display it in the Plant


Hierarchy Explorer.

Related Topics
Copy Naming Conventions to Other <Units>, page 248

Copying Data Common Tasks, page 326

Custom Fields Tab (Plant Hierarchy Item Properties Dialog Box),


page 390

General Tab (<Unit> Properties Dialog Box), page 518

Plant Design and Structure Common Tasks, page 151

Delete a Plant Hierarchy Item


1. In the tree view pane, expand the hierarchy.
2. Select and right-click a plant hierarchy item.
3. On the shortcut menu, click Delete.
Tip

You can only delete a plant hierarchy item that does not have child
items.

Related Topics

Plant Design and Structure Common Tasks, page 151

Plant Hierarchy Dialog Box, page 462

Plant Hierarchy Explorer, page 464


SmartPlant Instrumentation Administration Users Guide 157

Operating Owner Domain (As-Built and Projects): An Overview

Operating Owner Domain (As-Built and


Projects): An Overview
Operating owner domain is a domain with As-Built functionality. Such a domain is
partitioned into several schemas: a single schema for As-Built and separate schemas
for projects. An operational plant exists and most of the activities are concerned with
routine maintenance or plant modernization (revamps). To facilitate plant
modernization, you can create one or more projects using existing instrumentation
data for the operating plant as a starting point for plant modernizations (revamps).
Each project is defined for one plant only, and a plant can have several associated
projects. Plant modernization may involve the modification of a single instrument tag
or loop or hundreds of loops or any other item in SmartPlant Instrumentation.
The System Administrator can create an Operating owner domain on the fly, when
initializing a new domain in the database platform (Oracle, or SQL Server). Also, the
System Administrator can convert an existing empty Engineering company domain to
an Operating owner domain using the Domain Definition window options. When
making domain definitions, the System Administrator sets the claim mode (exclusive
or non-exclusive) and sets the software to delete merged items from the project or
keep view-only records of the merged items in the project. After creating the first
project, these definitions become fixed in the current domain. When creating an
Operating owner domain, As-Built is created automatically. Then, the Domain
Administrator needs to create project schemas and assign Project Administrators to
each project. After that, SmartPlant Instrumentation users can define As-Built data
and then claim this data for the existing projects.
When users complete working in a project, the Project Administrator can merge the
project data back with As-Built and then delete the project. It is not possible to delete
As-Built. After merging project data with As-Built, you cannot reverse the process.
For this reason, at all stages of plant modernization, you should ensure that there is
full coordination of engineering activities between As-Built and other projects within
your Operating owner domain, to avoid inadvertent loss of data.
Important

We do not recommend that you work in an Operating owner domain


residing in a stand-alone database. It is known that when using the Sybase
Adaptive Server Anywhere database engine, certain options in an
Operating owner domain are liable to work incorrectly.

Related Topics

Backing Up and Restoring Projects: An Overview, page 78

Explorer Windows: An Overview, page 183

Merging Project and As-Built Data: An Overview, page 218

Off-Site Project Creation and Implementation: An Overview, page 172

158 SmartPlant Instrumentation Administration Users Guide

Operating Owner Domain (As-Built and Projects): An Overview

Flow of Activities for Defining a Project


Administrator
This topic describes the primary flow of activities that allows Domain Administrator
to define a Project Administrator in an Operating owner domain and assign the
Project Administrator to a specific project. It is possible to define more than one
Project Administrator for a project but you can assign only one Project Administrator
per project. You can use the same flow of activities to define other Project
Administrators for the same project, or define Project Administrators for any other
projects that exist in the current domain.
1. Create a Project
In your Operating owner domain, create a project, with or without the project schema.
For details, see Create a Project, page 162.
2. Create a User
Create a new user you want to define as Project Administrator for the project the
Domain Administrator created. A procedure for creating a Project Administrator user
is the same as for any other user. User creation is performed by System
Administrator. For details, see Define a SmartPlant Instrumentation User, page 90.
3. Create a User Group
Create a new group which you can then use for assigning your Project Administrator.
If you intend to define several Project Administrators in your domain, it is sufficient
to create one user group and then assign all of the Project Administrators to this
group. For details about a user group creation, see Create a New Group, page 95.
4. Assign the User to the Group
You need to assign the Project Administrator to the group that you created. For more
information, see Assign Users to Groups, page 97.
5. Grant Full Access Rights for Project Definition to the User Group
Project Administrators in the user group that you created must have full access rights
for project definition. In the Access Rights window, the Project Definition access
right setting appears at the domain level. For details about granting access rights, see
Grant Access Rights for Selected Items or Activities, page 270.
6. Assign the User Group to the Project
This procedure enables you to displays your Project Administrator in the Project
Administrator list of the Project Activities dialog box. For details, see Assign User
Groups to a Project, page 164.

SmartPlant Instrumentation Administration Users Guide 159

Operating Owner Domain (As-Built and Projects): An Overview

Operating Owner Domain (As-Built and Projects)


Common Tasks
The following tasks are used frequently when working with an Operating owner
domain:
Create an Operating Owner Domain
When making domain definitions, System Administrator specifies the domain type as
Operating owner. At this stage, before any projects are created, System
Administrator determines whether the same SmartPlant Instrumentation item can be
claimed for more that one project. For more information, see Create an Operating
Owner Domain, page 107.
Create a Project
After System Administrator creates an Operating owner domain, the first stage of
revamping an owner operator facility is defining a project within which the
revamping engineering activities will take place. Each project has to be defined
within a specific plant, but may overlap several areas and units. More than one
project can be defined for the same plant, and several projects may cover the same
areas or units. In projects, you can create new items and also claim As-Built items.
Prior to creating a project, your System Administrator needs to define a domain and
specify the domain type as Operating owner. For more information, see Create a
Project, page 162.
Assign User Groups to a Project
After creating a project, the Domain Administrator needs to assign user groups to the
project. By assigning user groups to the project, the Domain Administrator
determines whether certain users can only work in the project or also perform project
maintenance activities. We recommend that one of the user groups only contains
Project Administrators. After assigning such a group to a particular project, the
names of Project Administrators become available in the Project Administrator list
of the Project Activities dialog box. For more information, see Assign User Groups
to a Project, page 164.

160 SmartPlant Instrumentation Administration Users Guide

Operating Owner Domain (As-Built and Projects): An Overview


Select a Logo for the Project
This option enables you to define a logo for a selected project when the domain type
is Operating owner. You can select a .bmp format graphic file that you want to
appear as the logo in most printed documents, such as some reports and
specifications.
When your Operating owner domain contains more than one project, you can assign a
distinctive logo for each project. In this case, when you switch from one project to
another, the logo assigned to that project is retrieved from the SmartPlant
Instrumentation database. For details, see Select a Project Logo When the Domain
Type is Operating Owner, page 165.
Make As-Built Definitions
After the System Administrator has defined a domain with domain type Operating
owner, that includes As-Built, the Domain Administrator can make a number of
definitions which include assigning a Project Administrator, selecting a workflow
option, and adding notes. For more information, see Make As-Built Definitions,
page 166.
Display Item Categories
When viewing or selecting items in the scope definition and merge activities in the
Administration module or for As-Built and project engineering data in the main
SmartPlant Instrumentation application, you can specify how to display the data to
distinguish between different categories of items. The software allows you to modify
the display format and copy the display format from another project. For more
information, see Display Formats of Item Categories, page 166.
Reserve Tags and Loops for a Project or As-Built
This procedure enables you to reserve for a project or As-Built tag numbers and loop
numbers within specified ranges. After you reserve a range of numbers, SmartPlant
Instrumentation users who work in this project or As-Built can create only those
loops and tags whose numbers belong to the specified range. On the other hand,
users in other projects in the same Operating owner domain cannot create tags and
loops that belong to the specified range. For more information, see Reserve Tags and
Loops for a Project or As-Built, page 168.
Generate Reserved Items Report
You can generate reports that display all the tag numbers or loop numbers that have
been reserved for As-Built or projects available in the current domain. For more
information, see Generate Reserved Items Report, page 170.

SmartPlant Instrumentation Administration Users Guide 161

Operating Owner Domain (As-Built and Projects): An Overview


Set the Project Status for an Integrated Environment
After the System Administrator has enabled the Item Registry options, the Domain
Administrator can set project status for an integrated environment. A status
determines the availability of various activities that users can perform for a
SmartPlant Instrumentation project in an integrated environment. For more
information, see Set the Project Status for an Integrated Environment, page 170.
Rebuild a Project
Related Topics

Domain Administration Common Tasks, page 147

Flow of Activities for Defining a Project Administrator, page 159

Merging Project and As-Built Data Common Tasks, page 230

Operating Owner Domain (As-Built and Projects): An Overview, page 158

Scoping Data for Projects Common Tasks, page 203

Create a Project
Important
You may also want to define a <plant> before creating a project. For
details, see Create a Plant Hierarchy Item on the Highest Level, page 154.
1. Start the Administration module and log on as Domain Administrator.

2. Do one of the following:

Click Activities > Project Activities.

Click .
3. In the Project Activities dialog box, click New.

4. Type a name and description for the project as required.


5. From the Project Administrator list, select a user you want to set as Project
Administrator.
Tip
By default, the Project Administrator list displays users belonging to
the ADMINISTRATORS group because only such a user can create
the first project. Before starting to scope data for this project, you may
want to create a special user group that only includes Project
Administrators. After you assign this group to the project, the Project
Administrator users become available for selection the Project
Administrator list. Therefore, before you create such a group, you
can consider the currently selected Project Administrator as temporary.
For details about defining Project Administrators, see Flow of
Activities for Defining a Project Administrator.
6. From the Plant list, select a plant to which the project is to be assigned.

162 SmartPlant Instrumentation Administration Users Guide

Operating Owner Domain (As-Built and Projects): An Overview


7. If required, select a workflow option for the project.
8. Do one of the following:

Select the Do not propagate wire tag names check box if you want to
suppress the tag number name propagation along the signal path
this way you will be able to customize wire tag names along the
propagated signal path.

Clear the Do not propagate wire tag names check box to propagate
wire tag names this way, all the wires along the propagated signal
path will be named according to the tag number from which the signal
originates.
9. If needed, select a logo for the current project.

10. Click Apply.


11. When prompted to copy user groups from As-Built, do one of the following:

Click Yes to copy all the As-Built user groups to the current project.

Click No to create the project with only one user group (that is, the
group to which the current Project Administrator belongs).
12. click Yes if you want to proceed immediately.

13. When prompted to create the project schema, click Yes if you want to proceed
immediately.
Tip
Creation of the project schema can take a considerable time, therefore,
if you do not need to implement your project right away, click No
when prompted. You can then create the project schema when you
claim items for the project.
14. Click Close

Related Topics

Operating Owner Domain (As-Built and Projects): An Overview, page 158

Scoping Data for Projects Common Tasks, page 203

Scoping Data for Projects: An Overview, page 195

Select a Project Logo When the Domain Type is Operating Owner,


page 165

SmartPlant Instrumentation Administration Users Guide 163

Operating Owner Domain (As-Built and Projects): An Overview

Assign User Groups to a Project


1. Start the Administration module and log on as Domain Administrator.
2. On the Domain Administration window menu bar, click Activities > Assign
Groups to Project.
3. From the Project list, select a project you created using the Project Activities
dialog box options.
4. From the Group list pane, drag a group to the Project groups pane.
Tips

To remove a group from the selected project, drag this group from the
Project groups pane to the Group list pane.

By default, all users of the ADMINISTRATORS group are assigned to


As-Built and projects. This is because only a user belonging to the
ADMINISTRATORS group can create the first project. After creating
projects using the Project Activities dialog box options, you can
remove the ADMINISTRATORS from the Project groups if needed.
5. Click OK.

Tip

After you click OK, users of a group with full access rights for project
activities become available on the Project Activities dialog box, in the
Project Administrator list. You can select a specific user and assign
this user to the project as Project Administrator.

Related Topics

Flow of Activities for Defining a Project Administrator, page 159

Operating Owner Domain (As-Built and Projects) Common Tasks,


page 160

Users and Groups Common Tasks, page 94

164 SmartPlant Instrumentation Administration Users Guide

Operating Owner Domain (As-Built and Projects): An Overview

Select a Project Logo When the Domain Type is Operating


Owner
1. On the Project Activities dialog box, do one of the following:

From the Project list, select a project for which you want to assign a
logo and click Edit.

Click New to create a new project.


2. Click Logo to open the Browse Logo Files dialog box.

Tip
The first time you open the Browse Logo Files dialog box the Logo
Preview data window displays a message notifying you that no logo is
currently assigned to the selected project.
3. Click Browse to open the Select Logo File dialog box.

Tip
You can select only the .bmp file format. You can create a .bmp file
using a graphic editing application such as Windows Paintbrush.
Since most reports are printed out in black-and-white, we recommend
that you select Bitmap files in black-and-white to save system
resources.
4. Navigate to the required .bmp file which you want to assign as the project logo
and click OK.

5. On the Browse Logo Files dialog box, click Assign to assign the selected bitmap
to the current project and save the new project logo to the database.
Related Topics

Operating Owner Domain (As-Built and Projects) Common Tasks,


page 160

Operating Owner Domain (As-Built and Projects): An Overview, page 158

SmartPlant Instrumentation Administration Users Guide 165

Operating Owner Domain (As-Built and Projects): An Overview

Make As-Built Definitions


1. Start the Administration module and log on as Domain Administrator.
2. Do one of the following:

Click Activities > Project Activities.

Click .
3. On the Project Activities dialog box, select As-Built.

4. Click Edit.
5. From the Project Administrator list, select a Project Administrator.
Tip
The Plant box displays All Plants. This option is view-only because
As-Built is always associated with all the plants that exist in the
current domain.
6. If needed, select a workflow option for As-Built.

7. If needed, type additional information in the Notes box.


8. Click Apply.
Related Topics

Operating Owner Domain (As-Built and Projects) Common Tasks,


page 160

Operating Owner Domain (As-Built and Projects): An Overview, page 158

Select a Project Logo When the Domain Type is Operating Owner,


page 165

Display Formats of Item Categories


When viewing or selecting items in the scope definition and merge activities in the
Administration module or for As-Built and project engineering data in the main
SmartPlant Instrumentation application, you can specify how to display the data to
distinguish between different categories of items. For example, when users open
SmartPlant Instrumentation and view both project and As-Built data, the items that
belong to the project can be displayed with a different color from the As-Built items
among the places where this applies in SmartPlant Instrumentation are Instrument
Index Standard Browser views, the Domain Explorer, the lists that are retrieved in
the Find Item dialog boxes, and so forth.

166 SmartPlant Instrumentation Administration Users Guide

Operating Owner Domain (As-Built and Projects): An Overview


Display formats are available for the following categories:

Claimed items In As-Built, items that have been claimed for projects.
This category is only available when you select As-Built from the Project
list of the Project Activities dialog box.

As-Built items In the project that you selected, indicates As-Built


items when SmartPlant Instrumentation users open the current project with
As-Built items displayed.

Project items In the project that you selected, indicates project items
when SmartPlant Instrumentation users open the current project with AsBuilt items displayed.

Dummy items In the project that you selected, indicates dummy


items.

To modify the display format of an item category, see Modify the Display Format for
an Item Category, page 167
To copy the display format of an item category from another project, see Copy the
Display Format from Another Project, page 168
Related Topics

Merging Project and As-Built Data: An Overview, page 218

Modify the Display Format for an Item Category, page 167

Operating Owner Domain (As-Built and Projects) Common Tasks, page


160

Specify an Action for Merging a Group of Items, page 236

Modify the Display Format for an Item Category


1. In the Project Activities dialog box, from the Project list, select one of the
following:

Select As-Built to indicate in As-Built those items that you claim for
projects.

Select a project in which you want to set the display format for dummy
items. Also, for users working in the current project with As-Built
items displayed, you can set the display format for As-Built items and
project items.
2. Click Edit.

3. In the Colors dialog box, for a desired item category, click Change in the
Display Format column.
4. Move the sliders for the red, green, and blue components to obtain the required
color.
5. If required, click Bold or Italic (or both) to format the text.

SmartPlant Instrumentation Administration Users Guide 167

Operating Owner Domain (As-Built and Projects): An Overview


6. Click OK to return to the Color Display Options dialog box.
7. Click Apply.
Related Topics

Copy the Display Format from Another Project, page 168

Display Formats of Item Categories, page 166

Operating Owner Domain (As-Built and Projects) Common Tasks, page


160

Copy the Display Format from Another Project


1. On the Project Activities dialog box, click Colors to open the Color Display
Options dialog box.
2. Click Copy From.
3. Select the source project from the list and click OK.
4. Click Apply to accept the changes.
Related Topics

Display Formats of Item Categories, page 166

Modify the Display Format for an Item Category, page 167

Operating Owner Domain (As-Built and Projects) Common Tasks, page


160

Reserve Tags and Loops for a Project or As-Built


Notes
Loop or tag reservation does not apply to loop or tag claiming procedures
that users can perform within SmartPlant Instrumentation.
1. With the Domain Administration window open, do one of the following:

Click Activities > Project Activities.

Click .
2. On the Project Activities dialog box, do one of the following:

From the Project list, select As-Built if you want to reserve tags and
loops for As-Built.

From the Project list, select an existing project or enter a name for a
new project if you want to reserve tags and loops for a project.
3. Click Reserve.

4. Click the appropriate tab.


5. Click Add.

168 SmartPlant Instrumentation Administration Users Guide

Operating Owner Domain (As-Built and Projects): An Overview


6. Do one of the following:

If you clicked the Loop Numbers tab, under Measured Variable,


select the measured variable of the loop numbers for which you want
to define the reservation.

If you clicked the Tag Numbers tab, under Instrument Type, select
the instrument type of the tag numbers for which you want to define
the reservation.
7. Under From Number, type the first number for the range.

Tips

When defining a range of loop numbers, the number of digits that you
type must be smaller or the same as the number defined on the
Naming Conventions dialog box for the Loop Number segment in
the Loop Number segment category.

When defining a range of tag numbers, the number of digits that you
type must be smaller or the same as the number defined on the
Naming Conventions dialog box for the Loop Identifier segment in
the Tag Number segment category.
8. Under To Number, type the last number for the range. The number of digits that
you type must be smaller or the same as the number defined on the Naming
Conventions dialog box, for the Loop Number segment.

Tips

When defining a range of loop numbers, the number of digits that you
type must be smaller or the same as the number defined on the
Naming Conventions dialog box for the Loop Number segment.

When defining a range of tag numbers, the number of digits that you
type must be smaller or the same as the number defined on the
Naming Conventions dialog box for the Loop Identifier segment.
9. Click Apply.

Tip

Click Add to add a new row and define another range of numbers.

Related Topics

Generate Reserved Items Report, page 170

Naming Conventions Common Tasks, page 243

Operating Owner Domain (As-Built and Projects) Common Tasks, page


160

SmartPlant Instrumentation Administration Users Guide 169

Operating Owner Domain (As-Built and Projects): An Overview

Generate Reserved Items Report

With the Domain Administration window open, on the Reports menu,


point to Reserved Items and do one of the following:

Click Tag Numbers to generate a report that displays all the reserved
tag numbers in the current domain.

Click Loop Numbers to generate a report that displays all the reserved
tag numbers in the current domain.

Related Topics

Operating Owner Domain (As-Built and Projects) Common Tasks, page


160

Reserve Tags and Loops for a Project or As-Built, page 168

Set the Project Status for an Integrated Environment


1. Start the Administration module and log on as Domain Administrator.
2. Do one of the following:

Click Activities > Project Activities.

Click .
3. On the Project Activities dialog box, select the project for which you want to set
the status.

4. From the SmartPlant project status list, select one of the following statuses:

Active Select to enable publishing and retrieving of documents.

Completed Select to indicate that activities in an integrated


environment for the project have been successfully completed and
disable data retrieval.

Canceled Select to indicate that the project is no longer in use and


that you can delete it if needed.

Merged Select to indicate that after completion of the project, the


project engineering data has been merged back with As-Built.
5. Click OK.

Notes

The Active status is the default status assigned automatically to every new
project that you create.

Project deletion is only available for projects with Canceled or Merged


status.

For a project with Completed or Merged status, users cannot publish or


retrieve documents.

170 SmartPlant Instrumentation Administration Users Guide

Operating Owner Domain (As-Built and Projects): An Overview

Rebuild a Project
1. As Domain Administrator, enter the Operating owner domain.
2. Click DBA > Rebuild Projects in Domain.
3. In the data window, select As-Built and those projects for which you want to
rebuild the schemas.
Tip
Selecting As-Built is required after initializing an Operating owner
domain in Sybase Adaptive Server Anywhere (full engine version).
4. Click OK to rebuild the selected projects.

Note

Without rebuilding the As-Built and project schemas, you cannot use an
Operating owner domain initialized in Sybase Adaptive Server Anywhere
(full engine version) because during the domain initialization, only the
Domain schema is created.

Related Topics

Operating Owner Domain (As-Built and Projects) Common Tasks, page


160

Operating Owner Domain (As-Built and Projects): An Overview, page 158

SmartPlant Instrumentation Administration Users Guide 171

Off-Site Project Creation and Implementation: An Overview

Off-Site Project Creation and Implementation:


An Overview
If you work with As-Built and projects in Owner operator domain, SmartPlant
Instrumentation allows you to execute engineering projects remotely off-site.
The use of an off-site project is recommended for units or plant equipment design
typical of the grass-root projects and not for modifications of the existing equipment
typically required in the DCS upgrade or replacement projects. In an off-site project,
users then create new items and make changes to the items that have been claimed for
the project in the master domain. After engineering changes are completed in the offsite project, the synchronization can be accomplished by importing the project from
the off-site database into the master domain. The import process overwrites all
engineering data existing in the project in the master domain with the content of the
off-site project. After the off-site project data is imported into the master database,
the Project Administrator can merge the project data with As-Built.
To create an off-site project, the system Administrator must back up the entire
Operating owner domain to a Sybase Adaptive Server Anywhere database and then
send the database to the appropriate contractor, who will then initialize the Operating
owner domain in another database.
Since the CHANGES_LOG table is not part of the domain backup, audit-trail
information from the master database is not available in the off-site project and the
audit-trail of the changes in the project is not available in the master database after
synchronization.
Caution

We do not recommend that you use the project Export option of the
Project Activities dialog box to export partial master domain information.
This option is not intended for off-site engineering but only for backing up
a specific project within the master domain. The use of the Export option
for engineering changes may result in severe data integrity violations in
the master database. For details about backing up and restoring projects,
see Backing Up and Restoring Projects: An Overview, page 78.

Related Topics

Domain Backup: An Overview, page 30

Off-Site Project Creation Prerequisites, page 174

Off-Site Project Implementation Workflow, page 173

Off-Site Project Restrictions, page 175

Operating Owner Domain (As-Built and Projects) Common Tasks, page


160

172 SmartPlant Instrumentation Administration Users Guide

Off-Site Project Creation and Implementation: An Overview

Off-Site Project Implementation Workflow


Use the following workflow to implement an off-site project.
Important
Before starting an off-site project implementation, make sure you have
completed all the prerequisites. For details, see Off-Site Project Creation
Prerequisites, page 174.
1. Back up the entire master domain, including As-Built and all projects to the
INtools_Backup.db database, which comes shipped with SmartPlant
Instrumentation.

Caution
At this stage, in the master domain, it is strongly recommended that no
changes whatsoever be done to the project until the off-site project
changes are imported. Failure to prevent changes may result in the
database corruption or synchronization problems. Therefore, to
prevent accidental changes to the project data in the master domain,
the Domain Administrator can set all access rights of the project user
groups as Access-Denied or View-Only.
2. Send the database with the backed up domain to the appropriate contractor.

3. In the contractor's database, initialize a new off-site domain that has both As-Built
and project data using the Ntools_Backup.db as a source.
4. Define or modify the project data as you require.
5. Back up the entire domain with the off-site project to the contractor's empty copy
of the INtools_Backup.db database or create the database dump if the database
type is Oracle or SQL Server.
6. Connect to the database containing the off-site project and import the off-site
project to the Operating owner domain in the master database. For details, see
Import an Off-Site Project, page 177
7. In the Operating owner domain in the master database, merge the project data
with As-Built.
Related Topics

Back Up a Domain, page 32

Domain Backup: An Overview, page 30

Domain Initialization: An Overview, page 43

Merging Project and As-Built Data: An Overview, page 218

Off-Site Project Creation and Implementation: An Overview, page 172

Off-Site Project Creation Prerequisites, page 174

Off-Site Project Restrictions, page 175

SmartPlant Instrumentation Administration Users Guide 173

Off-Site Project Creation and Implementation: An Overview

Off-Site Project Creation Prerequisites


To facilitate correct synchronization between the off-site and master databases, you
must adhere to the following prerequisites and recommendations:
In the master database, implement the following procedures prior to backing up the
Operating owner domain:

Define the plant hierarchy levels.

Define all plant hierarchy items that will be involved in the off-site
project.

In As-Built, make all engineering definitions, including naming


conventions, supporting tables, specification forms, instrument types,
browsers and browser views, wiring reference data, and so forth.

Create projects and claim As-Built items that you need for the projects.

If you want to enable the use of revisions in the off-site project, save the
revisions to the database. If the project you want to use as a source for
creating an off-site project already has documents and revisions saved as
files, change the revision storage method to Database using the Manage
Spec Revisions dialog box of the Specifications module.

Related Topics

Create a Plant Hierarchy, page 152

Off-Site Project Creation and Implementation: An Overview, page 172

Off-Site Project Implementation Workflow, page 173

Off-Site Project Restrictions, page 175

Scoping Data for Projects Common Tasks, page 203

174 SmartPlant Instrumentation Administration Users Guide

Off-Site Project Creation and Implementation: An Overview

Off-Site Project Restrictions


Before you start working with an off-site project, you should familiarize yourself with
activities that you can perform and those that you should not perform does to existing
restrictions.
Feature or
Activity

Restrictions

Important Notes

Plant
hierarchy

Adding or
modifying is not
allowed.

Such changes are ignored and discarded when


importing and synchronizing data with the
master database; these changes may also create
severe data integrity violations in the
engineering project data.

Naming
conventions

Defining or
modifying is not
allowed

Such changes are ignored and discarded when


importing and synchronizing data with the
master database; these changes may also create
severe data integrity violations in the
engineering project data.

Supporting
tables

Changing
supporting table
values that exist in
the master domain
is not allowed.

These changes are ignored if the same values


exist in both off-site project and master domain
project. You can, however, add values in
supporting tables, provided that you then
associate these values with items. Values that
are not associated with any item in the off-site
project are not imported into the master
database.

Spec forms
and pages

Changing spec
forms or pages that
are present in the
master database is
not allowed.

When synchronizing data, these changes are


ignored; the data comparison is made by
matching the source and target name and
description of the spec page or form. Therefore,
if you must make changes to spec form or
pages, always use the Save As option in the offsite project.

SmartPlant Instrumentation Administration Users Guide 175

Off-Site Project Creation and Implementation: An Overview


Feature or
Activity

Restrictions

Important Notes

Creating and No restrictions


claiming
items

The uniqueness of these items must be manually


maintained between the off-site project and
master domain including master domain AsBuilt and all other projects. SmartPlant
Instrumentation automated duplication
validation is not available between the master
and off-site domains. When the project is being
implemented off-site, what might happen is that
when a user creates a particular item in the offsite project, at the same time, another user
creates the same item in As-Built in the master
domain. In this case, synchronizing the off-site
project and then merging it back with As-Built
creates duplicate items. This needs to be
prevented through the work process control or
cleaned up manually after the project items are
imported and merged back with As-Built.

Deleting
items

No restrictions

After importing the off-site project, the deleted


item is deleted in the master project even if the
item was claimed from master As-Built.

Changing
items
properties

No restrictions

After importing the off-site project, all the


property changes are preserved.

Merging
items

Not allowed

The software ignores these activities and your


changes are lost when the data is imported back
into the master domain. You should only merge
items in the master domain, after importing the
off-site project.

Related Topics

Off-Site Project Creation and Implementation: An Overview, page 172

Off-Site Project Creation Prerequisites, page 174

Off-Site Project Implementation Workflow, page 173

176 SmartPlant Instrumentation Administration Users Guide

Off-Site Project Creation and Implementation: An Overview

Import an Off-Site Project


Important
You can perform the following procedure successfully only if the source
and the target projects have the same database ID.
1. Start the Administration module and log on as Domain Administrator.

2. Do one of the following:

Click Activities > Project Activities.

Click .
3. On the Project Activities dialog box, from the Project list, select a target project
to which you want to import data.

4. Click Import to open the Select Source Database dialog box.


5. In the Database type list, select the source SmartPlant Instrumentation database.
6. In the Server box, depending on your database platform where the off-site project
resides, do one of the following:

When using Oracle or SQL Server, type your database server name.

When using Sybase Adaptive Server Anywhere, select the required


database profile from the list.
Tip

If the profile of your Sybase Adaptive Server Anywhere database is


not available you must create a new ODBC profile using the Internal
Setup Utility.
7. In the Admin schema logon name box, accept or type the required user name to
connect to the admin schema of the source domain.

Tip
When using Sybase Adaptive Server Anywhere, the Admin schema
login boxes are view-only.
8. In the Admin schema logon password box, accept or type the required password.

9. Click Connect.
10. From the Domain list, select a source domain.
Tip

After selecting the source domain, the software detects the source
project with the same database ID as in the target project, and
automatically displays the source project in the Project box.

SmartPlant Instrumentation Administration Users Guide 177

Off-Site Project Creation and Implementation: An Overview


11. Before importing data, click Log File to open the Log File dialog box and specify
the log file name and path.
12. Click Report to open the List of Duplicate Items dialog box where you can view
the list of items in the projects of the target domain that appear as duplicate in the
target project after import.
13. Click OK when done.
14. Click Import.
15. On the Project Activities dialog box, click Close.
Related Topics
Off-Site Project Creation and Implementation: An Overview, page 172

Off-Site Project Creation Prerequisites, page 174

Off-Site Project Implementation Workflow, page 173

Specify Log File Path for Importing an Off-Site Project


Important
If you do not specify a log file name and path, the software does not create
any log file during the project import process.
1. Start the Administration module and log on as Domain Administrator.

2. Do one of the following:

Click Activities > Project Activities.

Click .
3. On the Project Activities dialog box, from the Project list, select a target project
to which you want to import data.

4. Click Import to open the Select Source Database dialog box.


5. On the Database type list, select the source SmartPlant Instrumentation database.
6. In the Server box, depending on your database platform, do one of the following:

When using Oracle or SQL Server, type your database server name.

When using Sybase Adaptive Server Anywhere, select the required


database profile from the list.
7. In the Admin schema logon name box, accept or type the required user name to
connect to the admin schema of the source domain.

Tip
When using Sybase Adaptive Server Anywhere, the Admin schema
logon boxes are view-only.
8. In the Admin schema logon password box, accept or type the required password.

9. Click Connect.

178 SmartPlant Instrumentation Administration Users Guide

Off-Site Project Creation and Implementation: An Overview


10. On the Select Source Database dialog box, click Log File.
11. On the Log File dialog box, do one of the following:

Accept the default path and name of the log file <SmartPlant
Instrumentation home folder>\importlog.txt. At this stage, the log file
is not created yet. If you do not want a log file to be created, clear the
field.

Type a different log file path and name.

Click Browse to navigate to the required log file. The log file must be
a .txt file.
12. Click OK to save the changes and return to the Select Source Database dialog
box, where you can import the data from the off-site project to the current project.

Related Topics
Import an Off-Site Project, page 177

Off-Site Project Creation and Implementation: An Overview, page 172

SmartPlant Instrumentation Administration Users Guide 179

Off-Site Project Creation and Implementation: An Overview

Project Deletion Common Tasks


In an Operating owner domain, the Domain Administrator or Project Administrator
can delete empty projects. Also, the Domain Administrator can delete projects along
with the project data or just delete project data without deleting the project. The
Domain Administrator might want to delete the projects that contain corrupted data or
projects for which the Project schema creation process failed to complete.
Also, if SmartPlant Instrumentation users are working in an integrated environment,
the Domain Administrator can delete projects with Canceled or Merged status. For
more information on project statuses, see Set the Project Status for an Integrated
Environment.
The actions that you perform are:
Delete a Single Project
This procedure allows the Domain Administrator or Project Administrator to delete a
particular empty project in an Operating owner domain. It is only possible to delete a
project after merging all of the project items with As-Built. If the target project no
longer contains any data but SmartPlant Instrumentation users previously deleted
claimed items from the project, the Project Administrator must still perform a merge
process to delete these items from As-Built as well. If System Administrator set the
software to merge items without deleting them from the project, view-only copies of
merged items remains in the project. Although it is not possible to delete these copies
or update their properties, existence of view-only copies does not prevent you from
deleting the project. For details, see Delete a Single Project, page 181.
Delete Data from a Single Project
Use this procedure to delete project data without deleting the project. This can be
useful if you want to use the same project schema when creating new engineering
data. For more information, see Delete Data from a Single Project, page 182.
Delete Projects or Project Data in Batch Mode
This procedure deals with deleting several projects at a time or deleting engineering
data from several projects without deleting the projects themselves. For more
information, see Delete Projects or Project Data in Batch Mode, page 182.
Related Topics

Operating Owner Domain (As-Built and Projects) Common Tasks, page


160

Operating Owner Domain (As-Built and Projects): An Overview, page 158

180 SmartPlant Instrumentation Administration Users Guide

Off-Site Project Creation and Implementation: An Overview

Delete a Single Project


Note

You can perform the following procedure if you have Project


Administrator rights in the current domain.

1. On the Domain Administration window menu bar, click

2. On the Project Activities dialog box, under Project, select an empty project you
want to delete.
Tip
In an integrated environment, you can only delete an empty project
whose is set as Cancelled or Completed. To set the project status,
before deleting the project on the Project Activities dialog box, under
SmartPlant project status, select Cancelled or Completed.
3. Click Delete.

Note
You can perform the following procedure if you have Domain
Administrator rights in the current domain and the Project Administrator
cannot perform this operation due to a technical problem.
1. On the Domain Administration window menu bar, click DBA > Delete
Projects.

2. On the Delete Projects dialog box, select the Delete project schema check box.
3. Under Project List, select the project that you want to delete.
4. Click OK.
Related Topics

Operating Owner Domain (As-Built and Projects) Common Tasks, page


160

Project Deletion Common Tasks, page 180

SmartPlant Instrumentation Administration Users Guide 181

Off-Site Project Creation and Implementation: An Overview

Delete Data from a Single Project


Note
If you delete project data using this procedure, the software deletes all data
from the project, including items you claimed for the project. However,
after deleting project data using this procedure, you cannot use this project
to run a merge process to delete previously claimed items from As-Built.
If you want to delete project data and then run a merge process, you must
delete the data manually from SmartPlant Instrumentation. Then, you can
run a merge process to delete claimed items from As-Built. After that,
you can delete the project itself on the Project Activities dialog box
(Activities > Project Activities). From the Project list, select a project
and click Delete.
1. With the Domain Administration window open, click DBA > Delete Projects.

2. On the Delete Projects dialog box, clear the Delete project schema check box.
3. Under Project List, select the project for which you want to delete project data.
4. Click OK.
Related Topics
Operating Owner Domain (As-Built and Projects) Common Tasks, page
160

Project Deletion Common Tasks, page 180

Delete Projects or Project Data in Batch Mode


Caution
When deleting project data together with the Project schema, the software
permanently deletes the projects from your SmartPlant Instrumentation
database.
1. With the Domain Administration window open, click DBA > Delete Projects.

2. On the Delete Projects dialog box, do one of the following:

Select the Delete project schema check box to delete project data
together with the project schema.

Clear the Delete project schema check box if you only want to delete
the engineering data and be able to use the same projects for creating
new data.
3. Under Project List, select the projects you want to delete.

4. Click OK.

182 SmartPlant Instrumentation Administration Users Guide

Explorer Windows: An Overview

Explorer Windows: An Overview


In an Operating owner domain, the Project Administrator uses explorer windows to
claim items for projects or merge items with As-Built. The explorers displays
instrumentation items according to hierarchical structure. You can arrange the
hierarchical structure of the data according to item types or according to the physical
location of the items.
The explorer toolbar enables you to find a specific or multiple items, or to filter the
display of items. All the explorer windows are accessible from the Project Activities
dialog box. The following explorer windows are available:

As-Built Explorer Opens when defining a scope of items for a project


using As-Built as a claim source. Displays all items that exist in As-Built.

Claim Buffer Opens when defining a scope of items for a project using
As-Built as a claim source. Displays items that you copied from As-Built
for claiming for a particular project, and allows you to claim all items in
batch mode.

Claimed Items Opens when defining a scope of items for a project


using As-Built as a claim source. Displays items that you have already
claimed for the current project, and also displays dummy items.

Source Project Explorer (only available when working in non-exclusive


claim mode Opens when defining a scope of items for a project using
another project as a claim source. Displays all items that exist in the
source project.

Target Project Buffer (only available when working in non-exclusive


claim mode) Opens when defining a scope of items for a project using
another project as a claim source. Displays items that you copied from the
source project for claiming for a particular project, and allows you to
claim all items in batch mode.

Project Explorer Opens when defining a scope of project items for


merging with As-Built. Displays items that exist in a specific <plant> of
a project you use as a source for merging items. The Project Explorer
also displays items that have been deleted from the project but exist in AsBuilt.

Merge Buffer Opens when defining a scope of project items for


merging with As-Built. Displays items that you copied from the Project
Explorer, and allows you to merge all items in batch mode.

Related Topics

Merging Project and As-Built Data Common Tasks, page 230

Merging Project and As-Built Data: An Overview, page 218

Scoping Data for Projects Common Tasks, page 203

Scoping Data for Projects: An Overview, page 195


SmartPlant Instrumentation Administration Users Guide 183

Explorer Windows: An Overview

Working with Explorer Windows Common Tasks


In an Operating owner domain, the following tasks are used frequently when the
Project Administrator works with explorer windows (that is, Claim Buffer or Merge
Buffer, As-Built Explorer, and so forth).
Find a Specific Item in the Tree View
This feature enables you to find an item in the tree view of an explorer window. 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 a Specific Item in
the Tree View, page 186.
Search for Items
You use this feature to find items that you want to work with. You can search for
multiple items in the current highest plant hierarchy level, or the current lowest plant
hierarchy level. For more information about searching for items, see Search for
Items, page 185.
Filter the Items in the Tree View Pane
You can filter the display of items in the tree view of an explorer window. Filter
settings take effect only for the user who defined the filter and only for the current
explorer window. That is, if you define a filter in the Claim Buffer, these settings do
not apply in the As-Built Explorer, and so forth. For more information, see Filter
the Display of Items in an Explorer Window, page 187.
Filter Cables
Use this procedure to set additional filter definitions for the Cables and the Cross
Cables folders in an explorer window. You can filter cables according to their
connections and cables that are connected to a specific Foundation or Profibus
segment. For more information, see Filter Cables, page 189.
Filter Loops According to Blocks
Allows you to set additional filter definitions for the Loops folder in an explorer
window. You can filter loops according to CAD drawing blocks associated with loop
instruments. For more information, see Filter Loops According to Blocks, page 192.

184 SmartPlant Instrumentation Administration Users Guide

Explorer Windows: An Overview


Use My List in the Items Pane
This procedure explains how to add various items to the My List view of the Items
pane. My List allows you to create a special view of the Items pane where you can
keep items that belong to various folders in the tree view. The software retains all the
items in the My List view until you remove them from that list. Exiting the current
project and the Administration module, 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 194.
Related Topics
Explorer Windows: An Overview, page 183

Merging Project and As-Built Data Common Tasks, page 230

Scoping Data for Projects Common Tasks, page 203

Search for Items


1. On the toolbar of an explorer window, click

to open the Search dialog box.

2. 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.
3. 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 the this field.
4. Under Search in, select a plant hierarchy level on which the software searches for
items:

Current highest plant hierarchy level the highest plant


hierarchy level that you in the Project Activities dialog box.

Current lowest plant hierarchy level the lowest plant hierarchy


level that appears in the current <plant>.

SmartPlant Instrumentation Administration Users Guide 185

Explorer Windows: An Overview


5. 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.
6. Click Search Now.

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

Explorer Windows: An Overview, page 183

Merging Project and As-Built Data Common Tasks, page 230

Scoping Data for Projects Common Tasks, page 203

Working with Explorer Windows Common Tasks, page 184

Find a Specific Item in the Tree View


1. On the toolbar of an explorer window, click

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

186 SmartPlant Instrumentation Administration Users Guide

Explorer Windows: An Overview


4. Do one of the following:

Under Item, type a name and click Find.

Select As typed and then under Item type a name. The software looks
for the item as you type. You can set the search delay to determine
how long the software will wait after the last time you press a key on
your keyboard.
5. Click Close.

Related Topics

Explorer Windows: An Overview, page 183

Merging Project and As-Built Data Common Tasks, page 230

Scoping Data for Projects Common Tasks, page 203

Working with Explorer Windows Common Tasks, page 184

Filter the Display of Items in an Explorer Window


1. In an Explorer window, select a hierarchy level or a folder containing the items
that you want to filter 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 folder or at the hierarchy level that you
selected in the Explorer tree view, 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
Note that the value that you enter in this box overrides all other filter
criteria in this dialog box.
3. Type a filter name.

4. Select an item type appropriate for the folder that you selected. You must select
an item type to be able to perform the filter operation.
5. Do one of the following:

Select Selected node definition to filter the child items that belong to
a folder or the items at any hierarchy level that you selected in the
Explorer tree view.

Select Global definition to define a filter for the entire tree view of
the active Explorer. The software applies this definition to the item
type you selected. If you defined a filter definition for a specific
folder, the filter for the folder override the settings for the global filter
definition.

SmartPlant Instrumentation Administration Users Guide 187

Explorer Windows: An Overview


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 Verify to check the validity of the current filtering condition.

8. Click OK.
Note

Clicking Advanced allows you to define a special filter for the Cables,
Cross Cables, and Loops folders. For details, see Filter Cables, page 189
and Filter Loops According to Blocks, page 192.

To reset the filter, delete the filter definition.

Related Topics

Explorer Windows: An Overview, page 183

Merging Project and As-Built Data Common Tasks, page 230

Scoping Data for Projects Common Tasks, page 203

Working with Explorer Windows Common Tasks, page 184

188 SmartPlant Instrumentation Administration Users Guide

Explorer Windows: An Overview

Filter Cables
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. To filter according to an item name in the folder that you selected, under Item
name, type a valid name or part of a name. You can use wildcard characters to
specify partial strings: asterisk (*) or percent (%) for multiple characters and
underscore (_) for single characters.

Tip
The value that you enter in this box overrides all other filter criteria in
this dialog box.
3. Type a filter name.

4. Do one of the following:

Select Selected node definition to filter the child items that belong to
a folder or the items at any hierarchy level that you selected in the
Explorer tree view.

Select Global definition to define a filter for the entire tree view of
the active Explorer. The software applies this definition to the item
type you selected. If you defined a filter definition for a specific
folder, the filter for the folder overrides the settings for the global filter
definition.

SmartPlant Instrumentation Administration Users Guide 189

Explorer Windows: An Overview


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 the Cables folder.


8. In the Advanced Filter Definition (Cables) dialog box, do one of the following:

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.

Select the Look for connections check box to include and select
connection criteria in the filter condition.
9. To select a connection criterion, in the Connection group box, click the
following:

No connections on either end Includes the cables that are not


connected to anything on both ends.

At least one wire connected on one end only Includes the cables
that contain at least one wire that is only connected on one of its ends.

At least one wire connected to both ends - Includes the cables that
contain at least one wire that is connected on its both ends.

190 SmartPlant Instrumentation Administration Users Guide

Explorer Windows: An Overview


10. 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 Includes all the cables that are connected to


junction boxes.

Marshaling racks Includes all the cables that are connected to


marshaling racks.

Cabinets Includes all the cables that are connected to cabinets.

Device panels - Includes all the cables that are connected to device
panel.

DCS panels Includes all the cables that are connected to DCS
panel.

PLC panels Includes all the cables that are connected to DCS
panel.
11. In the Cable associations group box, select an appropriate Foundation Fieldbus
or Profibus segment if you want to include cables that are associated with a
specific Fieldbus segment.

12. Select the Display telecom cables only if you want to filter the Cables folder so
that it displays telecom cables only.
13. Click OK in the Advanced Filter Definition dialog box.
14. Click OK in the Filter Definition dialog box.
Related Topics

Advanced Filter Definition (Cables) Dialog Box, page 385

Merging Project and As-Built Data Common Tasks, page 230

Scoping Data for Projects Common Tasks, page 203

Working with Explorer Windows Common Tasks, page 184

SmartPlant Instrumentation Administration Users Guide 191

Explorer Windows: An Overview

Filter Loops According to Blocks


1. In an Explorer window, select the Loops folder and do one of the following:

Right-click the folder, and then click Filter.

On the Explorer window toolbar, click .


2. To filter according to an item name in the Loops folder, under Item name, type a
valid name or part of a name. You can use wildcard characters to specify partial
strings: asterisk (*) or percent (%) for multiple characters and underscore (_) for
single characters.

Tip
The value that you enter in this box overrides all other filter criteria in
this dialog box.
3. Type a filter name.

4. Do one of the following:

Select Selected node definition to filter the child items that belong to
a folder or the items at any hierarchy level that you selected in the
Explorer tree view.

Select Global definition to define a filter for the entire tree view of
the active Explorer. The software applies this definition to the item
type you selected. If you defined a filter definition for a specific
folder, the filter for the folder overrides the settings for the global filter
definition.
5. In the Filter definition group box, define the criteria that you use to filter the
items displayed:

Property select a property to use for filtering the items.

Operator select the required comparison operator to determine


how the header selected under Property will relate to the expression
you select for Value.

Value select or type a required value for the item you selected
under Property. The available values depend on the specific property
that you select.

Logic You use this option when you specify more than one filter
condition. The option allows you to select the required logical
operator (And or Or) to determine how the next filter expression will
relate to the current expression. When you have a mixture of logical
operators for several conditions, the software performs the expressions
on the conditions in order, for example:
(A and B) or C
(A or B) and C

192 SmartPlant Instrumentation Administration Users Guide

Explorer Windows: An Overview


6. Click Verify to check the validity of the current filtering condition.
7. Click Advanced to define a filter for loops according to loop blocks.
8. In the dialog box that opens, if needed, under Display level for blocks, click one
of the following to filter the blocks displayed in the data windows:

Highest plant hierarchy level Displays blocks on the highest level


of the plant hierarchy defined by the Domain Administrator. The
default level is Plant.

Lowest plant hierarchy level Displays blocks on the lowest level


of the plant hierarchy defined by the Domain Administrator. The
default level is Unit.
9. To filter the loops according to blocks, do one of the following:

Under Blocks associated with tags, select one or more blocks that are
associated with loop tags. After you select these blocks, in the current
explorer window, the software only displays loops whose blocks are
assigned to tags using the block-tag assignment method.

Under Blocks associated with instrument type, select one or more


blocks that are associated with the instrument type of the loop tags.
After you select these blocks, in the current explorer window, the
software only displays loops whose blocks are assigned to tags using
the block-instrument type assignment method.
Tip

In the Administration module, explorer windows do not include


blocks. Blocks only appear in the Domain Explorer, which you can
open in SmartPlant Instrumentation. In the Domain Explorer, blocks
associated with instruments 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

Advanced Filter Definition (Loops) Dialog Box, page 386

Merging Project and As-Built Data Common Tasks, page 230

Scoping Data for Projects Common Tasks, page 203

Working with Explorer Windows Common Tasks, page 184

SmartPlant Instrumentation Administration Users Guide 193

Explorer Windows: An Overview

Add Items to My List in the Items Pane

In an explorer windows, do one of the following:

In the 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 the item, 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 from My List.

Related Topics

Explorer Windows: An Overview, page 183

Merging Project and As-Built Data Common Tasks, page 230

Scoping Data for Projects Common Tasks, page 203

Working with Explorer Windows Common Tasks, page 184

194 SmartPlant Instrumentation Administration Users Guide

Scoping Data for Projects: An Overview

Scoping Data for Projects: An Overview


After creating a project, the next stage is to define the scope of the items to be used in
the project. Scoping data involves selecting a claim source, selecting the <plant>
where the target project is carried out, and then, claiming items for the target project.
Depending on the claim source, it is possible to claim items either from As-Built or
from one project to another, provided that the System Administrator has set the
current domain definition so that the same item can be claimed for more than one
project. If the claim source is As-Built, you can claim As-Built items either from the
As-Built Explorer or from the Claim Buffer. After you claim items, they remain
fully operational in As-Built. If the claim source is another project, you can claim
project items either from the Source Project Explorer or from the Target Project
Buffer. After you claim items, they remain fully operational in the source project.
Claim Modes
You can claim items using one of the two modes: exclusive or non-exclusive. System
Administrator specifies a claim mode when making domain definitions. After
creating the first project in the domain, the defined claim mode becomes fixed in that
domain.
Sequence of Procedures for Scoping Data
Scoping data includes the following sequence of procedures:
1. Select a claim source: As-Built or another project.
2. Depending on the claim source and claim mode, open the appropriate explorer
windows for a specific project. Although you can claim items directly from the
As-Built Explorer (or Source Project Explorer if the claim source is another
project), you can only claim specific items belonging to a particular item type.
Therefore, if you want to claim items belonging to different types, and also claim
the associated sub-items and the parent items in batch mode, you need to use the
buffer.
3. Set preferences for scoping data (shared for all projects available in a particular
Operating owner domain).
4. From the As-Built Explorer (or Source Project Explorer if the claim source is
another project), copy all or selected items to the buffer. According to the
preferences that you set, the software determines which items to copy as fully
operational, or as dummy items. At this stage, you can also generate a report of
the items that you copied to the buffer for the current project scope.

SmartPlant Instrumentation Administration Users Guide 195

Scoping Data for Projects: An Overview


5. Claim the copied items for the current project.
Alternatively, it is possible to claim items from the command line, provided that you
previously copied the items to the buffer.
Notes

A dummy item is an As-Built item that is displayed in a project but it is not


part of the project scope. A dummy item is always associated with one or
more items that have been claimed for a project as fully-functional items.
For example, if you claim tag numbers directly from the Instruments
folder of the As-Built Explorer, in the project, the tag loop appears in the
project as a dummy item. Dummy items are view-only and marked with a
specific color in browser views or with a specific icon the Domain
Explorer in SmartPlant Instrumentation. If you claim an As-Built item
that already exists in the project as a dummy item, the software updates
project the item properties and changes the dummy item to a fullyfunctional project item.

When claiming an instrument tag, the software always claims the


associated basic engineering data, such as process data, calculation,
calibration, dimensional data for piping, and specification sheets, and
hook-up associations. Basic engineering data is not displayed in the AsBuilt Explorer or Source Project Explorer.

If you want to claim fieldbus tags, you only need to claim the associated
fieldbus segments with their sub-items and the fieldbus tags are claimed
automatically. It is not possible to claim fieldbus tags manually, although
they are displayed in the As-Built Explorer or Source Project Explorer
under loops and fieldbus segments.

Related Topics
Claim As-Built Items from the Command Line, page 214

Create an Operating Owner Domain, page 107

Merging Project and As-Built Data Common Tasks, page 230

Merging Project and As-Built Data: An Overview, page 218

Operating Owner Domain (As-Built and Projects) Common Tasks, page


160

Operating Owner Domain (As-Built and Projects): An Overview, page 158

Scoping Data for Projects Common Tasks, page 203

Settings and Conditions for Claiming Items, page 197

196 SmartPlant Instrumentation Administration Users Guide

Scoping Data for Projects: An Overview

Settings and Conditions for Claiming Items


There are various possible actions that determine whether the software claims AsBuilt items as fully-functional items or dummy items. These actions depend on your
domain settings, certain preferences for claiming, and conditions. The following is a
list of settings and conditions that influence claiming items:

Claim mode (exclusive or non-exclusive)

Claim parent items as dummy preference check box

Reclaim items preference check box

Number of projects in your domain

Items you select in as As-Built for claiming or reclaiming

Claimed items that already exist in projects as dummy or fully-functional


items

Handling Claimed Items in Exclusive Claim Mode


The following table contain possible actions that you perform when working in
exclusive claim mode, with As-Built and two projects, depending on the preferences
settings and conditions.
Claim
Parent
Items as
Dummy
Check
Box

Reclaim
Items
Check
Box

Possible
Action

Condition

Result

Selected

N/A

Claim a
strip for
Project1.

The strip does not


exist in either
Project1 or
Project2.

In Project1, the strip


appears as a fullyfunctional item and its
parent panel appears as a
dummy item.

Selected

N/A

Claim a
strip for
Project2.

The same strip


exists in Project1
as a fullyfunctional item
and its parent
panel exists in
Project1 as a
dummy item.

In Project2, both the strip


and the panel appear as
dummy items.

SmartPlant Instrumentation Administration Users Guide 197

Scoping Data for Projects: An Overview


Claim
Parent
Items as
Dummy
Check
Box

Reclaim
Items
Check
Box

Possible
Action

Condition

Result

Selected

N/A

Claim a
strip for
Project1.

The strip and its


panel already exist
in Project1 as
dummy items.
Neither of them
exist in Project2.

In Project1, the strip is


converted to a fullyfunctional item. The
software updates the strip
properties using the AsBuilt strip properties as a
source. The strip panel
remains as a dummy item.

Selected

N/A

Claim a
strip for
Project1.

The strip and its


panel already exist
in Project1 as
dummy items.
The strip and its
panel exist in
Project2 as fullyfunctional items.

There is no change in
Project1. This action is
not allowed because only
one project can contain a
fully-functional strip when
working in exclusive claim
mode.

Selected

Selected

Reclaim a
strip for
Project1.

The strip exists in


Project1 as a
fully-functional
item and its panel
exist in Project1
as a dummy item.

In Project1, the strip


remains a fully-functional
item, with the properties
updated using the As-Built
strip properties as a source.
The strip panel remains as
a dummy item without any
changes.

Selected

Selected

Reclaim a
strip for
Project1.

Both the strip and


its panel exist in
Project1 as fullyfunctional items.

In Project1, the strip


remains a fully-functional
item, with the properties
updated using the As-Built
strip properties as a source.
The strip panel remains as
a fully-functional item
without any changes. The
Claim parent items as
dummy check box does
not apply.

198 SmartPlant Instrumentation Administration Users Guide

Scoping Data for Projects: An Overview


Claim
Parent
Items as
Dummy
Check
Box

Reclaim
Items
Check
Box

Possible
Action

Condition

Result

Cleared

N/A

Claim a
strip for
Project1.

The strip does not


exist in either
Project1 or
Project2.

In Project1, both the strip


and the panel appear as
fully-functional items.

Cleared

N/A

Claim a
strip for
Project2.

The same strip


exists in Project1
as a fullyfunctional item
and its parent
panel exists in
Project1 as a
dummy item.

In Project2, the strip


appears as a dummy item
and the panel appears as a
fully-functional item.

Cleared

N/A

Claim a
strip for
Project1.

The strip and its


panel already exist
in Project1 as
dummy items.

In Project1, both the strip


and its panel are converted
to fully-functional items.
The software updates the
item properties using the
As-Built item properties as
a source.

Cleared

N/A

Claim a
strip for
Project1.

The strip and its


panel already exist
in Project1 as
dummy items.
The strip and its
panel exist in
Project2 as fullyfunctional items.

There is no change in
Project1. This action is
not allowed because only
one project can contain
fully-functional strip and
panel when working in
exclusive claim mode.

Cleared

Selected

Reclaim a
strip for
Project1.

The strip exists in


Project1 as a
fully-functional
item and its panel
exists in Project1
as a dummy item.

In Project1, the strip


remains a fully-functional
item, with the properties
updated using the As-Built
strip properties as a source.
The strip panel is
converted to a fullyfunctional item, with the
properties updated using
the As-Built panel
properties as a source.

SmartPlant Instrumentation Administration Users Guide 199

Scoping Data for Projects: An Overview


Claim
Parent
Items as
Dummy
Check
Box

Reclaim
Items
Check
Box

Possible
Action

Condition

Result

N/A

Selected

Reclaim a
strip for
Project1.

The strip exists in


Project1 as a
dummy item and
as a fullyfunctional item in
Project2.

There is no change in
Project1. This action is
not allowed because
reclaiming a dummy item
converts it to a fullyfunctional item. You
cannot have the same
fully-functional strip in
more than one project
when working in exclusive
claim mode.

Important

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 Claim parent items as dummy
preference does not apply..

Handling Claimed Items in Non-Exclusive Claim Mode


The following table contain possible actions that you perform when working in nonexclusive claim mode, with As-Built and two projects, depending on the preferences
settings and conditions.
Claim
Parent
Items as
Dummy
Check
Box

Reclaim
Items
Check
Box

Possible
Action

Condition

Result

Selected

N/A

Claim a
strip for
Project1.

The strip does not


exist in either
Project1 or
Project2.

In Project1, the strip


appears as a fullyfunctional item and its
parent panel appears as a
dummy item.

200 SmartPlant Instrumentation Administration Users Guide

Scoping Data for Projects: An Overview


Claim
Parent
Items as
Dummy
Check
Box

Reclaim
Items
Check
Box

Possible
Action

Condition

Result

Selected

N/A

Claim a
strip for
Project2.

The same strip


exists in Project1
as a fully-functional
item and its parent
panel exists in
Project1 as a
dummy item.

In Project2, the strip


appears as a fullyfunctional item and its
panel as a dummy item.

Selected

N/A

Claim a
strip for
Project1.

The strip and its


panel already exist
in Project1 as
dummy items. The
strip and its panel
exist in Project2 as
fully-functional
items.

In Project1, the strip is


converted to a fullyfunctional item. The
software updates the
strip properties using the
As-Built strip properties
as a source. The strip
panel remains in
Project1 as a dummy
item.

Selected

Selected

Reclaim a
strip for
Project1.

Both the strip and


its panel exist in
Project1 as dummy
items and as fullyfunctional items in
Project2.

In Project1, the strip is


converted to a fullyfunctional item. The
software updates the
strip properties using the
As-Built strip and panel
properties as a source.
The panel remains in
Project1 as a dummy
item.

Cleared

N/A

Claim a
strip for
Project1.

The strip does not


exist in either
Project1 or
Project2.

In Project1, both the


strip and its panel appear
as fully-functional items.

SmartPlant Instrumentation Administration Users Guide 201

Scoping Data for Projects: An Overview


Claim
Parent
Items as
Dummy
Check
Box

Reclaim
Items
Check
Box

Possible
Action

Condition

Result

Cleared

N/A

Claim a
strip for
Project1.

The strip and its


panel already exist
in Project1 as
dummy items. The
strip and its panel
exist in Project2 as
fully-functional
items.

In Project1, both the


strip and its panel appear
as fully-functional items.

Cleared

N/A

Claim a
strip for
Project2.

The same strip


In Project2, the strip and
exists in Project1
its panel appear as fullyas a fully-functional functional items.
item and its parent
panel exists in
Project1 as a
dummy item.

Cleared

Selected

Reclaim a
strip for
Project1.

Both the strip and


its panel exist in
Project1 as dummy
items and as fullyfunctional items in
Project2.

In Project1, both the


strip and its panel are
converted to fullyfunctional items. The
software updates the
strip and panel properties
using the As-Built strip
and panel properties as a
source.

Important

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 Claim parent items as dummy
preference does not apply..

Related Topics

Claim Buffer, page 533

Claim Tab (Preferences Dialog Box), page 471

Scoping Data for Projects Common Tasks, page 203

202 SmartPlant Instrumentation Administration Users Guide

Scoping Data for Projects: An Overview

Scoping Data for Projects Common Tasks


The following tasks are used frequently when you define the scope of items for a
project using As-Built or project items as a source and then claim the items for the
target project. Procedures that you perform depend on a claim source, which can be
either As-Built or a project. When a claim source is As-Built, you can claim As-Built
items for a project. When a claim source is another project, you can claim the items
you created in the source project or As-Built items you previously claimed for the
source project. It is only possible to claim items from one project to another when
working in non-exclusive claim mode.
Display Items in the As-Built Explorer
Use this procedure to display items that belong to As-Built. After you open the AsBuilt Explorer, you can define a scope of items for the project by claiming the AsBuilt items. It is either possible to claim items directly from the As-Built Explorer,
or copy the appropriate items to the Claim Buffer first. The Claim Buffer opens
automatically together with the As-Built Explorer. For more information, see
Display Items in the As-Built Explorer, page 205.
Display Items in the Source Project Explorer
Use this procedure to display source project items that you can claim for another
project, provided that the System Administrator cleared the Exclusive claim mode
check box when making the current domain definitions. After you open the Source
Project Explorer, you can define a scope of items for the target project by claiming
the items that the source project contains. It is either possible to claim items directly
from the Source Project Explorer, or copy the appropriate items to the Target
Project Buffer first. The Target Project Buffer opens automatically together with
the Source Project Explorer. For more information, see Display Items in the Source
Project Explorer, page 206.
Set Preferences for the Scope of a Project
This topic deals with setting preferences for claiming items, the associated parent
items, sub-items, and revision when defining the scope of a project. For more
information, see Set Preferences for the Scope of a Project, page 207.
Copy Items to the Claim Buffer
If a claim source is As-Built, use this procedure to copy As-Built items to the Claim
Buffer from the As-Built Explorer. After you copy the items, the Project
Administrator can claim all the items available in the Claim Buffer. When you make
item selections, the software automatically applies preferences that you set in the
Preferences for Scoping and Merging Data dialog box. These preferences
determine how the software copies to the buffer sub-items that are associated with the
items you select. For more information, see Copy Items to the Claim Buffer, page
208.

SmartPlant Instrumentation Administration Users Guide 203

Scoping Data for Projects: An Overview


Copy Items to the Target Project Buffer
If a claim source is a project, use this procedure to copy items to the Target Project
Buffer from the Source Project Explorer. After you copy the project items, the
Project Administrator can claim all the items available in the Target Project Buffer.
When you make item selections, the software automatically applies preferences that
you set in the Preferences for Scoping and Merging Data dialog box. These
preferences determine how the software copies to the buffer sub-items that are
associated with the items you select. For more information, see Copy Items to the
Target Project Buffer, page 209.
Generate Reports of Items Copied to the Buffer
If a claim source is As-Built, use this procedure to generate reports of As-Built items
available for claiming from the Claim Buffer. As long as the Claim Buffer contains
items, you cannot claim items directly from the As-Built Explorer. If a claim source
is a project, use this procedure to generate reports of project items available for
claiming from the Target Project Buffer. As long as the Target Project Buffer
contains items, you cannot claim items directly from the Source Project Explorer.
For more information, see Generate Reports of Items Copied to the Buffer, page 210.
Remove Items from the Buffer
This procedure allows you to remove all or specific As-Built items from the Claim
Buffer or project items from the Target Project Buffer before you claim items. Use
this procedure if you need to modify your item selection in the buffer. After claiming
items, the software removes all the items from the buffer automatically. For more
information, see Remove Items from the Buffer, page 211.
Claim Items from the Buffer
If a claim source is As-Built, use this procedure to claim all the As-Built items you
copied to the Claim Buffer from the As-Built Explorer. If a claim source is a
project, use this procedure to claim all the project items you copied to the Target
Project Buffer from the Source Project Explorer. For more information, see Claim
Items from the Buffer, page 212.
Claim Items Directly from the As-Built Explorer or Source Project
Explorer
This topic deals with claiming specific As-Built items from the As-Built Explorer or
project items from the Source Project Explorer. If you want to use this procedure,
make sure the buffer does not contain any items. For more information, see Claim
Items Directly from the As-Built Explorer or Source Project Explorer, page 213.
Claim As-Built Items from the Command Line
After copying As-Built items to the Claim Buffer it is possible to claim these items
for the current project without using the Administration module options. For more
information, see Claim As-Built Items from the Command Line, page 214.

204 SmartPlant Instrumentation Administration Users Guide

Scoping Data for Projects: An Overview


Claim Documents
The Project Administrator uses this procedure to claim documents from As-Built for a
project when defining the scope of a project. The software claims documents
together with associated revision data. Claiming documents is different from
claiming items. Even if you do not claim any documents that exist in As-Built, the
software claims the documents automatically whenever users in projects of the same
domain generate reports. Claiming documents manually enables you to select
multiple documents and then claim them all at once. Also, when claiming documents
manually from the Administration module, you do not experience any locking
problems, while in SmartPlant Instrumentation, it is possible for a document to be
unavailable for claiming when locked by another user. For more information, see
Prerequisites for Claiming Documents, page 215 and Claim Documents, page 216.
Show Projects Containing Claimed Items
If you previously claimed an As-Built item for other projects in the current Operating
owner domain, you can display a list of projects that contain this item. For more
information, see Show Projects Containing Claimed Items, page 217.
Related Topics

Operating Owner Domain (As-Built and Projects): An Overview, page 158

Scoping Data for Projects: An Overview, page 195

Settings and Conditions for Claiming Items, page 197

Working with Explorer Windows Common Tasks, page 184

Display Items in the As-Built Explorer


1. Start the Administration module and log on as Domain Administrator.
2. Do one of the following:

Click Activities > Project Activities.

Click .
3. In the Project Activities dialog box, select a project for which you want to claim
data from As-Built.

4. Click Scope.
5. On the Select Source for Claiming dialog box, under Claim source, select AsBuilt.
6. Click OK.

SmartPlant Instrumentation Administration Users Guide 205

Scoping Data for Projects: An Overview


7. On the Scope Definition dialog box, do one of the following:

Select Include to make items from selected units available for use in
the project.

Select Select all to make items from all the units available for use in
the project (or clear this check box to clear the selection for all the
items).
8. Click Continue.

9. In the As-Built Explorer, expand the hierarchy to display the item type folders.
Related Topics

As-Built Explorer, page 531

Scoping Data for Projects Common Tasks, page 203

Scoping Data for Projects: An Overview, page 195

Display Items in the Source Project Explorer


1. Start the Administration module and log on as Domain Administrator.
2. Do one of the following:

Click Activities > Project Activities.

Click .
3. On the Project Activities dialog box, select a project for which you want to claim
data from another project.

4. Click Scope.
5. On the Select Source for Claiming dialog box, under Claim source, select the
source project.
Tips

It is possible to claim items from one project to another only if the


System Administrator cleared the Exclusive claim mode check box in
the Domain Definition window.

The source and target projects must be carried out in the same <plant>.

The source project must not be empty.


6. Click OK.

7. On the Scope Definition dialog box, do one of the following:

Select Include to make items from selected units available for use in
the project.

Select Select all to make items from all the units available for use in
the project (or clear this check box to clear the selection for all the
items).

206 SmartPlant Instrumentation Administration Users Guide

Scoping Data for Projects: An Overview


8. Click Continue.
9. In the Source Project Explorer, expand the hierarchy to display the item type
folders.
Related Topics

Scoping Data for Projects Common Tasks, page 203

Scoping Data for Projects: An Overview, page 195

Source Project Explorer, page 540

Set Preferences for the Scope of a Project


1. On the Project Activities dialog box, select a project.
2. Click Scope.
3. Select a claim source and click OK.
Tips

It is possible to select a project as a claim source only if the System


Administrator cleared the Exclusive claim mode check box in the
Domain Definition window.

The source and target projects must be carried out in the same <plant>.
4. On the Scope Definition dialog box, do one of the following:

Select Include to make items from selected units available for use in
the project.

Select Select all to make items from all the units available for use in
the project (or clear this check box to clear the selection for all the
items).
5. Click Continue.

6. Depending on the claim source, do one of the following:

If the claim source is As-Built, in the As-Built Explorer or the Claim


Buffer, right-click the highest hierarchy node.

If the claim source is a project, in the Source Project Explorer or the


Target Project Buffer, right-click the highest hierarchy node.
7. On the shortcut menu, click Preferences.

SmartPlant Instrumentation Administration Users Guide 207

Scoping Data for Projects: An Overview


8. In the dialog box that opens, set preferences for the scope of the current project as
you require, and then click Apply.
Tips

For details on preferences options, see Help topics for the Preferences for
Scoping and Merging Data dialog box.

The software saves the preferences that you define for the entire Operating
owner domain, so that the same preferences apply in all the projects and
As-Built. These preferences do not affect user preferences defined in the
Preferences Management dialog box.

Preferences you define on the General tab also apply to merging data
options.

Related Topics

Preferences for Scoping and Merging Data Dialog Box, page 468

Preferences Management (General) Dialog Box, page 477

Preferences Management Dialog Box, page 475

Scoping Data for Projects Common Tasks, page 203

Scoping Data for Projects: An Overview, page 195

Settings and Conditions for Claiming Items, page 197

Copy Items to the Claim Buffer


1. In the As-Built Explorer, expand the hierarchy to display folders of item types.
2. In the tree view pane, click an item type folder to display the items.
3. Do one of the following:

In the tree view pane, right-click a specific item, and then, on the
shortcut menu, click Copy to Claim Buffer.

In the Items pane, select and right-click one or more items, and then,
on the shortcut menu, click Copy to Claim Buffer.

From the tree view or Items pane, drag the items to the Claim Buffer.

Tips

When you select the items for defining the scope of a project, 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 on
the General tab of the Preferences for Scoping and Merging Data
dialog box.

The Claim Buffer does not show engineering data associated with the
instrument tags that you copied.

208 SmartPlant Instrumentation Administration Users Guide

Scoping Data for Projects: An Overview

If you copied to the Claim Buffer a loop or instrument together with


the wiring items, the software only copies those wiring items that have
a signal propagated to the loop or instrument. If you placed a device
panel inside a cabinet or junction box, when claiming the loop, this
device panel is not copied together with the cabinet or junction box
because this device panel does not have a signal propagated to the
loop. You must select and copy such a device panel manually.

You cannot select basic engineering data manually or set the software
to claim instruments without including the associated basic
engineering data.

Related Topics

Claim Buffer, page 533

Operating Owner Domain (As-Built and Projects) Common Tasks, page


160

Operating Owner Domain (As-Built and Projects): An Overview, page 158

Scoping Data for Projects Common Tasks, page 203

Copy Items to the Target Project Buffer


1. In the Source Project Explorer, expand the hierarchy to display folders of item
types.
2. In the tree view pane, click an item type folder to display the items.
3. Do one of the following:

In the tree view pane, right-click a specific item, and then, on the
shortcut menu, click Copy to Target Project Buffer.

In the Items pane, select and right-click one or more items, and then,
on the shortcut menu, click Copy to Target Project Buffer.

From the tree view or Items pane, drag the items to the Copy to
Target Project Buffer.

Tips

When you select the items for defining the scope of a project, 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 on
the General tab of the Preferences for Scoping and Merging Data
dialog box.

The Target Project Buffer does not show engineering data associated
with the instrument tags that you copied.

SmartPlant Instrumentation Administration Users Guide 209

Scoping Data for Projects: An Overview

If you copied to the Copy to Target Project Buffer a loop or


instrument together with the wiring items, the software only copies
those wiring items that have a signal propagated to the loop or
instrument. If you placed a device panel inside a cabinet or junction
box, when claiming the loop, this device panel is not copied together
with the cabinet or junction box because this device panel does not
have a signal propagated to the loop. You must select and copy such a
device panel manually.

You cannot select basic engineering data manually or set the software
to claim instruments without including the associated basic
engineering data.

Related Topics

Operating Owner Domain (As-Built and Projects) Common Tasks, page


160

Operating Owner Domain (As-Built and Projects): An Overview, page 158

Scoping Data for Projects Common Tasks, page 203

Generate Reports of Items Copied to the Buffer


1. Depending on a claim source, do one of the following:

If the claim source is As-Built, in the Claim Buffer, right-click the


Claim Buffer node at the top of the hierarchy.

If the claim source is another project, in the Target Project Buffer,


right-click the Target Buffer node at the top of the hierarchy.
2. On the shortcut menu, click Reports of Copied Items.

3. In the Select Item Types for Reports dialog box, use the check boxes to select
item types for which you want to generate reports.
4. Click OK to display the report print preview for the first item type you selected.
5. In the print preview, under Reports, click arrow keys to display reports for other
item types you selected.
Tips

The software generates an individual reports for each item type that you
selected. For example, if you selected Line, Loop, and Tag, the software
first displays a report of lines that appear in the buffer. After you close
this report, the software displays a report of loops that appear in the buffer,
and so forth.

You can only print or save each report individually.

Related Topics

Copy Items to the Claim Buffer, page 208

Copy Items to the Target Project Buffer, page 209

210 SmartPlant Instrumentation Administration Users Guide

Scoping Data for Projects: An Overview

Remove Items from the Buffer


1. Depending on the claim source, do one on the following:

If the claim source is As-Built, in the Claim Buffer, expand the


hierarchy to display folders of item types.

If the claim source is a project, in the Target Project Buffer, expand


the hierarchy to display folders of item types.
2. Do one of the following:

To remove all items that appear in the buffer, in the tree view pane,
right-click the highest hierarchy node, and then, on the shortcut menu,
click Remove All.

To remove one specific item, in the tree view pane, select and rightclick an item, and then, on the shortcut menu, click Remove.

To remove one or more items, in the Items pane, select and right-click
one or more items, and then, on the shortcut menu, click Remove.

Note

On removing the items, the software removes the associated sub-items


according to the settings you defined on the General tab of the
Preferences for Scoping and Merging Data dialog box.

Related Topics

Claim Buffer, page 533

Scoping Data for Projects Common Tasks, page 203

Target Project Buffer, page 542

SmartPlant Instrumentation Administration Users Guide 211

Scoping Data for Projects: An Overview

Claim Items from the Buffer


1. Depending on a claim source, do one of the following:

If the claim source is As-Built, in the Claim Buffer, right-click the


Claim Buffer node (the highest hierarchy node).

If the claim source is another project, in the Target Project Buffer,


right-click the Target Buffer node (the highest hierarchy node).
2. On the shortcut menu, click Claim All.

Tips

The buffer only contains items that you copied from the claim source.

On completing claiming the items, the software clears the buffer.


However, if you copied items to My List, you need to remove the
items manually.

A log file and .psr files that include a list of claimed items appear in
the path that you specified when setting the preferences for claiming
items.

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 As-Built Items from the Command Line, page 214

Claim Buffer, page 533

Claim Tab (Preferences Dialog Box), page 471

Item Indicators, page 544

Scoping Data for Projects Common Tasks, page 203

Settings and Conditions for Claiming Items, page 197

Target Project Buffer, page 542

212 SmartPlant Instrumentation Administration Users Guide

Scoping Data for Projects: An Overview

Claim Items Directly from the As-Built Explorer or Source


Project Explorer
Notes

Claiming items from the As-Built Explorer is only possible if the Claim
Buffer has no items.

Claiming items from the Source Project Explorer is only possible if the
Target Project Buffer has no items.
1. Depending on a claim source, do one of the following:

If the claim source is As-Built, in the As-Built Explorer, expand the


hierarchy to display folders of item types.

If the claim source is a project, in the Source Project Explorer,


expand the hierarchy to display folders of item types.
2. In the tree view pane, click an item type folder to display the items in the Items
pane.

3. In the Items pane, select and right-click one or more items.


4. On the shortcut menu, click Claim.
Tip

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

As-Built Explorer, page 531

Claim As-Built Items from the Command Line, page 214

Claim Tab (Preferences Dialog Box), page 471

Item Indicators, page 544

Scoping Data for Projects Common Tasks, page 203

Settings and Conditions for Claiming Items, page 197

Source Project Explorer, page 540

SmartPlant Instrumentation Administration Users Guide 213

Scoping Data for Projects: An Overview

Claim As-Built Items from the Command Line


You can claim items for a project without using the Administration module options of
SmartPlant Instrumentation. To do so, you, you need to specify additional
parameters. For example, if your Operating System is Windows 2000, you specify
these parameters in your Windows Server Task Scheduler.
Notes

You can only claim items from the command line after copying the items
from the As-Built Explorer to the Claim Buffer. For details, see Copy
Items to the Claim Buffer.

After copying the items, you must close the Administration module prior
to claming the items from the command line.

It is not possible to claim items from the command line using another
project as a claim source.

Parameter String for Claiming Items


Main <user name>,<user password>,<Operating owner domain
name>,<target project name>,<claim flag>

Important

Use a space character between the Main and <user name> parameters.
For other parameters, you must only use commas as parameter separators.

Use upper case for the claim flag C parameter.

The following table describes the parameters in the order of their appearance in the
parameter string.
Parameter

Description

Possible
Settings

Main

The initial parameter, which opens the Administration


module

Main

<user name>

The name of the user with full Project Activities access


rights. The user group must be assigned to the target project.

User1

<user password>

The user password defined by System Administrator.

User1

<Operating owner
domain name>

The name of the Operating owner domain in which you


copied items from the As-Built Explorer to the Claim
Buffer.

SPI1

<target project
name>

The name of the project for which you want to claim As-Built
items from the Claim Buffer.

Project1

<claim flag>

The C parameter that allows you to claim items you copied to


the Claim Buffer.

Example
Main User1,User1,SPI1,Project1,C

214 SmartPlant Instrumentation Administration Users Guide

Scoping Data for Projects: An Overview

Prerequisites for Claiming Documents


If you want to publish SmartPlant Instrumentation data from the current project, you
can claim documents for the project so that they become available for publishing. A
document is a saved copy of a list-type report, or a non-list-type report for which the
revision setting is set as Per Document. For example, in the As-Built Explorer, you
can select for claiming such documents as Document Binder packages, browser
views, instrument index documents, hook-up-related documents, and so forth. A
complete list of reports for which you can claim documents appears in the Report
Management dialog box.
The software claims a document automatically if the revision management setting in
the Report Management dialog box is Per Item. When claiming a loop number, the
software always claims the associated loop drawings. When claiming an instrument,
the software always claims documents that belong to basic engineering data
associated with the tag number. Such documents can be calculation, dimensional
data, process data or calibration sheets, or instrument specifications. Also, the
software automatically claims multi-tag (SEE LIST) specs, specs created for tag
cases, and non-instrument specifications, such as panel specs, hook-up item specs,
and so forth.
Prior to claiming documents, whether the Project Administrator claims the documents
manually or whether the software claims them automatically, you must perform the
following activities in As-Built in the order shown:
1. In the Report Management dialog box, the Domain Administrator must define
the revision setting as per document for non-list-type reports to be used as a
source for claiming documents. All list-type reports are assigned to the per
document revision management setting by default. For more information, see
Define Report Revision Management Settings, page 289.
2. In SmartPlant Instrumentation, for a report with a per document revision
management setting, a user has to create a document number in the Revisions
dialog box and then save this number to the database.
Tip

To make the document available for claiming, you do not actually


have to create a report revision, but just specify the document number.

Related Topics

Claim Documents, page 216

Operating Owner Domain (As-Built and Projects) Common Tasks, page


160

Operating Owner Domain (As-Built and Projects): An Overview, page 158

Scoping Data for Projects Common Tasks, page 203

SmartPlant Instrumentation Administration Users Guide 215

Scoping Data for Projects: An Overview

Claim Documents
Important
Prior to claiming documents we recommend that you read the
Prerequisites for Claiming Documents, page 215 topic.
1. Depending on a claim source, do one of the following:

If the claim source is As-Built, in the As-Built Explorer, expand the


hierarchy to display folders of item types.

If the claim source is a project, in the Source Project Explorer,


expand the hierarchy to display folders of item types.
2. Click the Documents folder to display the source documents in the Items pane.

3. In the Items pane, select one or more documents.


4. Right-click the selected documents and then, on the shortcut menu, click Claim.
Tips

Claiming documents or any other items from the As-Built Explorer is


only possible if the Claim Buffer has no data.

Claiming documents or any other items from the Source Project


Explorer is only possible if the Target Project Buffer has no data.

You can copy documents to the buffer first, and then, claim all the
documents together with all other items that you copied to the buffer.

When claiming a cable block diagram, you must also claim panels the
cable block diagram references. These panels must be claimed as
fully-functional items.

Related Topics

Operating Owner Domain (As-Built and Projects) Common Tasks, page


160

Operating Owner Domain (As-Built and Projects): An Overview, page 158

Prerequisites for Claiming Documents, page 215

Scoping Data for Projects Common Tasks, page 203

216 SmartPlant Instrumentation Administration Users Guide

Scoping Data for Projects: An Overview

Show Projects Containing Claimed Items


1. Depending on a claim source, do one of the following:

If the claim source is As-Built, in the As-Built Explorer, right-click


expand the hierarchy to display folders of item types.

If the claim source is another project, in the Source Project Explorer,


right-click expand the hierarchy to display folders of item types.
2. In the tree view pane, click an item type folder to display the items.

3. In the tree view, right-click an item.


4. On the shortcut menu, click Claimed For to display a list of projects that already
contain the selected item.
Tips

After clicking Claimed For, the software changes the lower pane name
from Items to Projects.

The Projects pane can display several projects containing the same item
only if the System Administrator cleared the check box Exclusive claim
mode in the Domain Definition window when creating an Operating
owner domain. If the Exclusive claim mode is selected, it is not possible
to claim the same item for more than one project.

If the Projects pane is empty, this means that the selected item has not
been claimed for any project.

The Projects pane does not display items that you claimed for a project
and then deleted from that project.

Related Topics

As-Built Explorer, page 531

Create an Operating Owner Domain, page 107

Item Indicators, page 544

Scoping Data for Projects Common Tasks, page 203

SmartPlant Instrumentation Administration Users Guide 217

Merging Project and As-Built Data: An Overview

Merging Project and As-Built Data: An


Overview
After modifying existing items or creating new items in Operating owner domain
projects in SmartPlant Instrumentation, a Project Administrator can merge some or
all of the items with As-Built. To merge project data with As-Built, a Project
Administrator uses the Project Explorer and the Merge Buffer options, which are
only available in the Administration module. It is possible, however, to copy items to
the Merge Buffer directly from a project opened in SmartPlant Instrumentation.
Merge Modes
You can merge items using one of the two modes: with deletion from the project or
without deletion from the project. System Administrator specifies a merge mode
when making domain definitions. After creating the first project in the domain, the
defined merge mode becomes fixed in that domain. If System Administrator set the
software to merge items without deleting them from the project, on merging project
data with As-Built view-only copies of the merged items remains 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.
Existence of view-only copies does not prevent you from deleting the project.
Sequence of Procedures for Merging Data
To merge project data with As-Built, the Project Administrator needs to perform the
following sequence of procedures:
1. Open the Project Explorer and the Merge Buffer for a specific project.
Although you can merge items directly from the Project Explorer, you can only
merge specific items belonging to a particular item type. Therefore, if you want
to merge items belonging to different types, and also merge the associated subitems and the parent items in batch mode, you need to use the Merge Buffer.
2. Set preferences for merging data (shared for all projects available in a particular
Operating owner domain).
3. From the Project Explorer, (or directly from a project opened in SmartPlant
Instrumentation), select a merge action for all or selected items and copy the items
to the Merge Buffer accordingly. At this stage, the software applies the merge
action to the items and also applies the preferences options that you have set.
Several merge actions are available for each item. For details, see Actions for
Merging Items, page 235. You can either change a merge action for a specific
item or for all items and sub-items in batch mode, regardless of the item type.
4. Merge the copied items with As-Built.
5. After merging all of the items with As-Built, delete the project if it becomes
obsolete.

218 SmartPlant Instrumentation Administration Users Guide

Merging Project and As-Built Data: An Overview


Alternatively, it is possible to merge items from the command line, provided that you
previously copied the items to the Merge Buffer.
Notes

Merging specific items directly from the Project Explorer is only


possible if the Merge Buffer contains no items.

Using a Comparison List, available from the Project Explorer, is an


alternative way to change a merge action. The software applies the
changes after you close the Comparison List. The changes only take
effect in the Merge Buffer. For example, if you change the action from
Merge Later to Merge Now, the software does not merge the item but only
copies it and the associated sub-items to the Merge Buffer.

When working in an integrated environment, there are certain


requirements relating to As-Built and projects.

When merging project data with As-Built, you can ignore dummy items.
After merging all items that have a parent dummy item, the software
removes the dummy item from the project automatically.

If you want to merge fieldbus tags, you only need to merge the associated
fieldbus segments with their sub-items and the fieldbus tags are merged
automatically. It is not possible to merge fieldbus tags manually, although
they are displayed in the Project Explorer under loops and fieldbus
segments.

Related Topics
Actions for Merging Items, page 235

Copy Items to the Merge Buffer Common Tasks, page 226

Delete a Single Project, page 181

Generating Reports for Merging Data Common Tasks, page 222

Integration Common Tasks, page 344

Item and Sub-Item Selection Options for Merging with As-Built, page 220

Merge Items from the Command Line, page 240

Merging Project and As-Built Data Common Tasks, page 230

Operating Owner Domain (As-Built and Projects) Common Tasks,


page 160

Operating Owner Domain (As-Built and Projects): An Overview, page 158

Scoping Data for Projects Common Tasks, page 203

Scoping Data for Projects: An Overview, page 195

Working with Explorer Windows Common Tasks, page 184

SmartPlant Instrumentation Administration Users Guide 219

Merging Project and As-Built Data: An Overview

Open the Project Explorer and Merge Buffer


1. Start the Administration module and log on as Domain Administrator.
2. Do one of the following:

Click Activities > Project Activities.

Click .
3. In the Project Activities dialog box, select a project whose data you want to
merge with which As-Built.

4. Click Merge.
Related Topics

Generating Reports for Merging Data Common Tasks, page 222

Merge Buffer, page 535

Merging Project and As-Built Data Common Tasks, page 230

Merging Project and As-Built Data: An Overview, page 218

Project Explorer, page 538

Item and Sub-Item Selection Options for Merging with AsBuilt


When you select items for merging with As-Built, 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 on
the General tab of the Preferences for Scoping and Merging Data dialog box.
These preferences apply whether you merge the items or only copy them from the
Project Explorer to the Merge Buffer. The following table shows the related data
or items that the software can merge when you select a main item belonging to a
specific item type.
Main Item Type

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

Tag

Basic engineering data, wiring items that have a signal


propagated to tag

Wiring item (Panel,


Rack, Wiring
Equipment, and so
forth

All wiring sub-items that appear in the appropriate wiring item


folder in the As-Built Explorer.

220 SmartPlant Instrumentation Administration Users Guide

Merging Project and As-Built Data: An Overview


Main Item Type

Related Items/Data Included with the Main Item

Terminal Strip

Terminals

Cable

Cable sets, wires

Wire

Cables, cable sets

Note

You cannot select basic engineering data manually or set the software to
merge tags without including the associated basic engineering data.

Related Topics

Generating Reports for Merging Data Common Tasks, page 222

Merging Project and As-Built Data Common Tasks, page 230

Merging Project and As-Built Data: An Overview, page 218

SmartPlant Instrumentation Administration Users Guide 221

Merging Project and As-Built Data: An Overview

Generating Reports for Merging Data Common


Tasks
Use the following tasks to generate reports from the Project Explorer, which
displays all the items available in the current project. Also, in the Merge Buffer, it is
possible to generate a report of items that you have copied from the Project
Explorer. You copy items to the Merge Buffer to merge items in batch mode with
As-Built.
Generate Comparison List Reports
This procedure allows you to create comprehensive reports as saved files showing the
changes for items belonging to a specific item type. When generating a Comparison
List for a specific item type, you can also display and generate Comparison List
reports for the sub-items associated with the main item.
After you have modified data in your project in SmartPlant Instrumentation, it can be
useful to review the changes (insertion, deletion, and updating of items) by generating
comparison list reports for the items you modified. This way you can mark the
reports to follow up how you intend to merge the items, and after merging, you can
regenerate a new set of reports summarizing the merging actions.
First, you select the item types and display the available items in the in the
Comparison List dialog box. Then, you can specify the columns available for
viewing, sort or filter the list of items. After that, you can print or save the report in a
variety of formats, including PowerSoft reports, text files, or Excel format. For more
information, see Generate Comparison List Reports, page 223.
Generate Reports of Changed Items
Use this procedure to generate reports of items that have been changed in the project
or As-Built, new items that have been created in the project or As-Built, or items that
have been deleted from the project or As-Built.
As opposed to Comparison List reports, Changed Items reports only display the
actual changes that were made in the project or As-Built. However, to be able to
generate a Changed Items report, the System Administrator must activate the audit
trail options in the current domain. Also, note that you can generate a Changed Items
report only for the item type that you select. If you need to generate a report of
changed made to associated sub-items, use the Comparison list report options. For
details on the Changed Items report generation, see Generate Reports of Changed
Items, page 224.

222 SmartPlant Instrumentation Administration Users Guide

Merging Project and As-Built Data: An Overview


Generate Reports of Changed Documents
Use this procedure to generate reports of documents that have been changed in the
project or As-Built, new documents that have been created in the project or As-Built,
or documents that have been deleted from the project or As-Built. Also, these reports
show other projects for which you have claimed the items associated with the
documents. Prior to generating a report, make sure that in the Preferences for
Scoping and Merging Data dialog box, under Merge option for revisions, the
setting is either Merge by revision ID or Merge by revision ID. For details on the
Changed Documents report generation information, see Generate Reports of Changed
Documents, page 225.
Generate Reports of Items Copied to the Merge Buffer
Use this procedure to generate reports of items available for merging with As-Built
from the Merge Buffer. Note that as long as the Merge Buffer contains items, you
cannot merge items directly from the Project Explorer. For more information, see
Generate Reports of Items Copied to the Merge Buffer, page 225.
Related Topics
Domain Administration Common Tasks, page 147

Merge Buffer, page 535

Merging Project and As-Built Data Common Tasks, page 230

Merging Project and As-Built Data: An Overview, page 218

Operating Owner Domain (As-Built and Projects): An Overview, page 158

Project Explorer, page 538

Generate Comparison List Reports


1. In the Project Explorer, right-click the folder at the top of the hierarchy, Project
Explorer.
2. On the shortcut menu, click Comparison List.
3. In the Select Item Types for Comparison dialog box, use the check boxes to
select item types for which you want to generate comparison list reports.
4. Click OK to display the Comparison List dialog box.
Tip
A Comparison List dialog box opens separately for each item type
that you select. For example, if you selected Loop, Tag, and Wiring
Equipment, the software first displays a Comparison List dialog box
for loops. After you close this dialog box, the software opens another
dialog box for tags, and so forth.
5. If required, click View to open the Select Columns for Viewing dialog box and
select the columns for viewing. By default, all the available columns are
displayed.

SmartPlant Instrumentation Administration Users Guide 223

Merging Project and As-Built Data: An Overview


6. Drag the required columns in the order you want them to appear from Column
list to Columns to view.
7. To remove a column, drag it from Columns to view to Column list.
8. Click Include modified columns if you want to ensure that where items were
updated, the columns where the changes were made will appear in the report.
9. If required, click Sort to open the Select Columns for Sorting dialog box to
select the sort order of the columns.
10. Drag the required columns for sorting from Column list to Sorted Columns.
The list will be sorted according to the selected columns in ascending priority.
11. Click Report.
12. Do one of the following:

Click Print to print out a report for the current item.

Click Save As to save the report in a format that you specify.


13. Repeat the steps 5-12 to generate a comparison list report for another item type (if
you selected more than one item type in the Select Item Types for Comparison
dialog box).

Related Topics

Operating Owner Domain (As-Built and Projects) Common Tasks, page


160

Operating Owner Domain (As-Built and Projects): An Overview, page 158

Generate Reports of Changed Items


1. In the Project Explorer, right-click the folder at the top of the hierarchy, Project
Explorer.
2. On the shortcut menu, click to Reports > Changed Data.
3. In the Select Item Types for Reports dialog box, use the check boxes to select
item types for which you want to generate reports.
4. Click OK to display the report print preview for the first item type you selected.
5. In the print preview, under Reports, click arrow keys to display reports for other
item types you selected.
Tips

The software generates an individual reports for each item type that you
selected. For example, if you selected Line, Loop, and Tag, the software
first displays a report of changes made to the lines. After you close this
report, the software displays a report of changes made to the loops, and so
forth.

You can only print or save each report individually.

224 SmartPlant Instrumentation Administration Users Guide

Merging Project and As-Built Data: An Overview

Generate Reports of Changed Documents


1. In the Project Explorer, right-click the folder at the top of the hierarchy, Project
Explorer.
2. On the shortcut menu, point to Reports and click Changed Documents.
3. In the Select Item Types for Reports dialog box, use the check boxes to select
item types for which you want to generate reports of changed documents.
4. Click OK to display the report print preview for the first item type you selected.
5. In the print preview, under Reports, click arrow keys to display reports for other
item types you selected.
Tips

The software generates an individual reports for each item type that you
selected. For example, if you selected Cable, Terminal Strip, and Tag,
the software first displays a report of changes made to the cables. After
you close this report, the software displays a report of changes made to the
terminal strips, and so forth.

You can only print or save each report individually.

Related Topics

Generating Reports for Merging Data Common Tasks, page 222

Merge Tab (Preferences Dialog Box), page 473

Merging Project and As-Built Data Common Tasks, page 230

Generate Reports of Items Copied to the Merge Buffer


1. In the Merge Buffer, right-click the folder at the top of the hierarchy, Merge
Buffer.
2. On the shortcut menu, click Reports of Copied Items.
3. In the Select Item Types for Reports dialog box, use the check boxes to select
item types for which you want to generate reports.
4. Click OK to display the report print preview for the first item type you selected.
5. In the print preview, under Reports, click arrow keys to display reports for other
item types you selected.
Tips

The software generates an individual reports for each item type that you
selected. For example, if you selected Line, Loop, and Tag, the software
first displays a report of lines that appear in the Merge Buffer. After you
close this report, the software displays a report of loops that appear in the
Merge Buffer, and so forth.

You can only print or save each report individually.

SmartPlant Instrumentation Administration Users Guide 225

Merging Project and As-Built Data: An Overview

Copy Items to the Merge Buffer Common Tasks


Use the following tasks to copy items from the Project Explorer to the Merge
Buffer prior to merging the items from the Merge Buffer. When copying the items,
the software also assigns a merge action (Merge Now or Release Claim) to the items.
After copying items, you can either user the Administration module options to merge
the items, or merge the items from the command line. Note that the Merge Buffer
does not show engineering data associated with the instrument tags that you copy.
Copy All Items to the Merge Buffer as Merge Now
Use this procedure to copy all the items available in the current project to the Merge
Buffer and assign a Merge Now action to all the items. For more information, see
Copy All Items to the Merge Buffer as Merge Now, page 227.
Copy Selected Items to the Merge Buffer as Merge Now
Use this procedure to copy specific items to the Merge Buffer and assign a Merge
Now action to these items. For more information, see Copy Selected Items to the
Merge Buffer as Merge Now, page 227.
Copy All Items to the Merge Buffer as Release Claim
Use this procedure to copy all the items available in the current project to the Merge
Buffer and assign a Release Claim action to all the items. For more information, see
Copy All Items to the Merge Buffer as Release Claim, page 228.
Copy Selected Items to the Merge Buffer as Release Claim
Use this procedure to copy specific items to the Merge Buffer and assign a Release
Claim action to these items. For more information, see Copy Selected Items to the
Merge Buffer as Release Claim, page 228.
Related Topics

Actions for Merging Items, page 235

Generate Reports of Items Copied to the Merge Buffer, page 225

Item and Sub-Item Selection Options for Merging with As-Built, page 220

Merge Buffer, page 535

Merge Items from the Command Line, page 240

Merging Project and As-Built Data Common Tasks, page 230

Merging Project and As-Built Data: An Overview, page 218

Project Explorer, page 538

Specify an Action for Merging a Group of Items, page 236

226 SmartPlant Instrumentation Administration Users Guide

Merging Project and As-Built Data: An Overview

Copy All Items to the Merge Buffer as Merge Now


1. In the Project Explorer, right-click the folder at the top of the hierarchy, Project
Explorer.
2. On the shortcut menu, click Copy All as Merge Now.
Note

When copying the items, the software also changes the merge action to
Merge Now for those items that already appear in the Merge Buffer.

Related Topics

Copy Items to the Merge Buffer Common Tasks, page 226

Item and Sub-Item Selection Options for Merging with As-Built, page 220

Remove Items from the Merge Buffer, page 229

Copy Selected Items to the Merge Buffer as Merge Now


1. In the Project Explorer, expand the hierarchy to display folders of item types.
2. In the tree view pane, click an item type folder to display the items.
3. Do one of the following:

In the tree view pane, right-click a specific item, and then, on the
shortcut menu, click Copy to Buffer as Merge Now.

In the Items pane, select and right-click select one or more items, and
then, on the shortcut menu, click Copy to Buffer as Merge Now.

From the tree view or Items pane, drag the items to the Merge Buffer.
Tip

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.

Related Topics

Copy Items to the Merge Buffer Common Tasks, page 226

Item and Sub-Item Selection Options for Merging with As-Built, page 220

Remove Items from the Merge Buffer, page 229

SmartPlant Instrumentation Administration Users Guide 227

Merging Project and As-Built Data: An Overview

Copy All Items to the Merge Buffer as Release Claim


1. In the Project Explorer, right-click the folder at the top of the hierarchy, Project
Explorer.
2. On the shortcut menu, click Copy All as Release Claim.
Note

When copying the items, the software also changes the merge action to
Release Claim for those items that already appear in the Merge Buffer.

Related Topics

Copy Items to the Merge Buffer Common Tasks, page 226

Item and Sub-Item Selection Options for Merging with As-Built, page 220

Remove Items from the Merge Buffer, page 229

Copy Selected Items to the Merge Buffer as Release Claim


1. In the Project Explorer, expand the hierarchy to display folders of item types.
2. In the tree view pane, click an item type folder to display the items.
3. Do one of the following:

In the tree view pane, right-click a specific item, and then, on the
shortcut menu, click Copy to Buffer as Release Claim.

In the Items pane, select and right-click select one or more items, and
then, on the shortcut menu, click 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.

Do not drag the items to the Merge Buffer. This is because the
software automatically applies the Merge Now action to the items that
you drag.

Related Topics

Copy Items to the Merge Buffer Common Tasks, page 226

Item and Sub-Item Selection Options for Merging with As-Built, page 220

Remove Items from the Merge Buffer, page 229

228 SmartPlant Instrumentation Administration Users Guide

Merging Project and As-Built Data: An Overview

Remove Items from the Merge Buffer


1. In the Merge Buffer, expand the hierarchy to display folders of item types.
2. Do one of the following:

To remove all items that appear in the Merge Buffer, in the tree view
pane, right-click the highest hierarchy node (the Merge Buffer node),
and then, on the shortcut menu, click Remove All.

To remove one specific item, in the tree view pane, select and rightclick an item, and then, on the shortcut menu, click Remove.

To remove one or more items, in the Items pane, select and right-click
one or more items, and then, on the shortcut menu, click Remove.

Note

On removing the items, the software removes the associated sub-items


according to the settings you defined on the General tab of the
Preferences for Scoping and Merging Data dialog box.

Related Topics

Merge Buffer, page 535

Scoping Data for Projects Common Tasks, page 203

SmartPlant Instrumentation Administration Users Guide 229

Merging Project and As-Built Data: An Overview

Merging Project and As-Built Data Common Tasks


The following tasks are used frequently when you merge project data with As-Built:
Open the Project Explorer and Merge Buffer
Use this procedure to open the Project Explorer and the Merge Buffer for a
particular project in an Operating owner domain. This is the first stage of defining a
scope of items you want to merge with As-Built. The Project Explorer contains all
of the items available in the project. You can use Merge Buffer to create a selection
of items you want to merge with As-Built. For more information, see Open the
Project Explorer and Merge Buffer, page 220.
Set Preferences for Merging Project Items with As-Built
This topic deals with setting preferences for merging items, the associated parent
items, sub-items, and revision data. For more information, see Set Preferences for
Merging Project Items with As-Built, page 232.
Copy Items to the Merge Buffer Common Tasks
Copying items from the Project Explorer to the Merge Buffer is the first step of
merging current project with As-Built. After that, the Project Administrator can
merge the current project items with As-Built. When you make item selections, the
software automatically applies preferences that you set in the Preferences for
Scoping and Merging Data dialog box. These preferences determine how the
software copies to the Merge Buffer sub-items that are associated with the items you
select. You can set a merge action for the items that you copy, that is Merge Now or
Release Claim. In the Merge Buffer, these actions take effect when you start merging
the items. For more information, see Copy Items to the Merge Buffer Common Tasks,
page 226.
Remove Items from the Merge Buffer
This procedure allows you to remove all or specific items from the Merge Buffer
before you merge items. Use this procedure if you need to modify your item
selection in the Merge Buffer. After merging items, the software removes all the
items from the Merge Buffer automatically. For more information, see Remove
Items from the Merge Buffer, page 229.
Compare Project Data with As-Built Data
Before merging data, it is recommended that you compare for each item type the
differences between the items in the current project and As-Built. The comparison list
shows whether a particular item was changed, and if so the type of change (insert,
update, delete, or no change) that was made. In the case of an update, the comparison
list shows the old and new values for the appropriate fields in the database. For more
information, see Compare Project Data with As-Built Data, page 232.

230 SmartPlant Instrumentation Administration Users Guide

Merging Project and As-Built Data: An Overview


Item Comparison Options
When you run the comparison list on certain specific items, you can compare changes
for additional items associated with the main item. For more information, see Item
Comparison Options, page 234.
Actions for Merging Items
This topic provides information about the actions that you can take when merging
project and As-Built data. For more information, see Actions for Merging Items, page
235.
Specify an Action for Merging a Group of Items
For a large number of modified items, you can specify a merge action according to
the type of modification made to the items. For example, you can decide to merge
only updated items in the project, while retaining the original items in As-Built if they
are new or were deleted in the project. For more information, see Specify an Action
for Merging a Group of Items, page 236.
Merge Items from the Merge Buffer
Use this procedure to merge with As-Built the items that you copied to the Merge
Buffer from the current project. When you start merging the items, the software
applies merge actions assigned to the items. Items whose merge action is Merge Now
are merged with As-Built. Items whose merge action is Release Claim appear in AsBuilt in their original state (that is, as they appeared in As-Built before being claimed
for the current project). For details, see Merge Items from the Merge Buffer, page
238.
Merge Items Directly from the Project Explorer
After modifying existing items or creating new items in your project in SmartPlant
Instrumentation, you can merge some or all of the items with As-Built. Several
merging actions are available for each item. Also, you can change a merging action
for all items and sub-items in batch mode, regardless of a specified item type. For
more information, see Merge Items Directly from the Project Explorer, page 239.
Merge Items from the Command Line
After copying items to the Merge Buffer it is possible to merge these items with AsBuilt from the command line, without using the Administration module options. For
more information, see Merge Items from the Command Line, page 240.
Related Topics

Domain Administration Common Tasks, page 147

Generating Reports for Merging Data Common Tasks, page 222

Merge Buffer, page 535

Merging Project and As-Built Data: An Overview, page 218

Operating Owner Domain (As-Built and Projects): An Overview, page 158

Project Explorer, page 538

SmartPlant Instrumentation Administration Users Guide 231

Merging Project and As-Built Data: An Overview

Set Preferences for Merging Project Items with As-Built


1. In the Project Activities dialog box, select a project.
2. Click Merge.
3. In the Project Explorer or the Merge Buffer, right-click the folder at the top of
the hierarchy.
4. On the shortcut menu, click Preferences.
5. In the dialog box that opens, set preferences for merging data of the current
project with As-Built, and then click Apply.
Tips

For details on specific preferences options, see Help topics for the
Preferences for Scoping and Merging Data dialog box.

The software saves the preferences that you define for the entire Operating
owner domain, so that the same preferences apply in all the projects and
As-Built. These preferences do not affect user preferences defined in the
Preferences Management dialog box.

Preferences you define on the General tab also apply to defining a scope
of items for projects.

Related Topics

Item and Sub-Item Selection Options for Merging with As-Built, page 220

Merge Tab (Preferences Dialog Box), page 473

Merging Project and As-Built Data Common Tasks, page 230

Merging Project and As-Built Data: An Overview, page 218

Preferences for Scoping and Merging Data Dialog Box, page 468

Preferences Management (General) Dialog Box, page 477

Preferences Management Dialog Box, page 475

Compare Project Data with As-Built Data


1. In the Project Explorer, right-click the folder at the top of the hierarchy, Project
Explorer.
2. On the shortcut menu, click Comparison List.
3. In the Select Item Types for Comparison dialog box, use the check boxes to
select item types for which you want to generate comparison list reports.

232 SmartPlant Instrumentation Administration Users Guide

Merging Project and As-Built Data: An Overview


4. Click OK to display the Comparison List dialog box.
Tip
A Comparison List dialog box opens separately for each item type
that you select. For example, if you selected Loop, Tag, and Wiring
Equipment, the software first displays a Comparison List dialog box
for loops. After you close this dialog box, the software opens another
dialog box for tags, and so forth.
5. If required, click View, and in a dialog box that opens, select the database fields
for viewing. By default, all the available fields are displayed in the Comparison
List.

Tip
From Column list to Columns to view, drag columns in the order you
want them to appear in the Comparison List for the current item type.
To remove a column, drag it from Columns to view to Column list.
6. If required, click Sort, and in a dialog box that opens, select the sort order of the
database fields.

Tip
In the Comparison List, the software sorts the fields in ascending
priority, according to the fields that you drag from Column list to
Sorted Columns.
7. In the Comparison List, view the change for each of the selected items. The
Mode column can display the following change indicators:

I Indicates a new item inserted in the project.

D Indicates an item claimed for the project and then deleted from
the project.

U Indicates an item updated in the project or changed in As-Built


after claiming, resulting in either case in non-identical data. The
database fields that were updated are shown with a light blue
background, and the old and new values appear. Renaming an item is
the equivalent of updating the item.

N Indicates that no change was made to the item in the project.


8. Click Options to display a list of additional items for comparison the items
that are available depend on the selected item type. For details, see Item
Comparison Options, page 234.

Related Topics

Generate Comparison List Reports, page 223

Generating Reports for Merging Data Common Tasks, page 222

Item Comparison Options, page 234

Merging Project and As-Built Data: An Overview, page 218

SmartPlant Instrumentation Administration Users Guide 233

Merging Project and As-Built Data: An Overview

Item Comparison Options


When you run the comparison list on certain specific items, you can compare changes
for additional items associated with the main item. The following table summarizes
options available for each of the items.
To access these options, on the Comparison List dialog box for the main item, click
Options.
Main Item

Additional Items Available for Comparison

Line

Process Data

Document

None

Process Equipment

None

Loop

None

Tag

Signal, Process Data, Specification

Fieldbus Segment

None

Connector

None

Panel

1 Side, 2 Side, Cross Wire, Jumper

Controller

None

Rack

None

Slot

None

Wiring Equipment

None

Terminal Strip

1 Side, 2 Side

Channel

None

Terminal

1 Side, 2 Side

Cable

1 Side

Cable set

1 Side

Wire

1 Side

Control System Tag

None

Related Topics

Compare Project Data with As-Built Data, page 232

Operating Owner Domain (As-Built and Projects) Common Tasks, page


160

Operating Owner Domain (As-Built and Projects): An Overview, page 158

Prerequisites for Claiming Documents, page 215

234 SmartPlant Instrumentation Administration Users Guide

Merging Project and As-Built Data: An Overview

Actions for Merging Items


When merging project and As-Built data, the following actions are available per item.
If needed, you or can apply a merge action to items belonging to a specific item type
in the Comparison List dialog box.
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 AsBuilt, 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.

SmartPlant Instrumentation Administration Users Guide 235

Merging Project and As-Built Data: An Overview


Merge later The default action applied to all the items that appear in the Project
Explorer. Leaves the item in the currently selected project for merging at a later
time.
Note

You 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. Existence of view-only copies does not prevent
you from deleting the project.

Related Topics

Copy Items to the Merge Buffer Common Tasks, page 226

Merging Project and As-Built Data: An Overview, page 218

Operating Owner Domain (As-Built and Projects) Common Tasks, page


160

Specify an Action for Merging a Group of Items, page 236

Specify an Action for Merging a Group of Items


1. In the Project Explorer, right-click the folder at the top of the hierarchy, Project
Explorer.
2. On the shortcut menu, click Comparison List.
3. In the Select Item Types for Comparison dialog box, use the check boxes to
select item types for which you want to display comparison reports.
4. Click OK to display the Comparison List dialog box.
Tip
A Comparison List dialog box opens separately for each item type
that you select. For example, if you selected Loop, Tag, and
Equipment, the software first displays a Comparison List dialog box
for the loop item type. After you close this dialog box, the software
opens another dialog box for the tag item type, and so forth.
5. Select the merge action you want to apply to the items that belong to the
displayed item type.

6. Select one or more of the types of changes for applying the action, for example,
Inserted, Deleted, and Not changed.

236 SmartPlant Instrumentation Administration Users Guide

Merging Project and As-Built Data: An Overview


7. Click Options to display a list of additional items for comparison the available
associated items depend on the selected item type.
Tip
The merge action for the additional items you view by clicking
Options are identical to the action you select for the main item; you
cannot select the merge action for the associated items independently.
8. Click OK to save the changes and return to Comparison List dialog box
displayed for another item type (if you selected more than one item type in the
Project Explorer), and then, repeat the steps 6-9.

Tips

After you click OK, the software applies the merge action and affects
the display of items that already appear in the Merge Buffer.

If you change a merge action from Merge Now or Release Claim to


Merge Later, the software automatically removes this item from the
Merge Buffer.

If you change the action from Merge Later to Merge Now, the
software does not merge the item but only copies it and the associated
sub-items to the Merge Buffer.

Related Topics

Actions for Merging Items, page 235

Item Comparison Options, page 234

Merging Project and As-Built Data: An Overview, page 218

Operating Owner Domain (As-Built and Projects) Common Tasks, page


160

Operating Owner Domain (As-Built and Projects): An Overview, page 158

SmartPlant Instrumentation Administration Users Guide 237

Merging Project and As-Built Data: An Overview

Merge Items from the Merge Buffer


1. In the Merge Buffer, right-click the folder at the top of the hierarchy, Merge
Buffer.
2. On the shortcut menu, click Merge All.
Notes

The Merge Buffer does not contain any items assigned to the Merge Later
action.

During the process of merging data, the software merges all the items
assigned to the Merge Now action in the Merge Buffer, and also release
claim for those items that are assigned to the Release Claim action. For
details on merge action descriptions and examples, see Actions for
Merging Items.

On completing merging the items, the software clears the Merge Buffer.
However, if you copied items to My List, you need to remove the items
manually.

A log file and .psr files that include a list of merged items appear in the
path that you specified when setting the preferences for merging items.

Related Topics

Actions for Merging Items, page 235

Item Indicators, page 544

Merge Buffer, page 535

Merge Items from the Command Line, page 240

Merge Tab (Preferences Dialog Box), page 473

Merging Project and As-Built Data Common Tasks, page 230

Merging Project and As-Built Data: An Overview, page 218

238 SmartPlant Instrumentation Administration Users Guide

Merging Project and As-Built Data: An Overview

Merge Items Directly from the Project Explorer


Note
Merging items from the Project Explorer is only possible if the Merge
Buffer has no items.
1. In the Project Explorer, expand the hierarchy to display folders of item types.

2. In the tree view pane, click an item type folder to display the items in the Items
pane.
3. In the Items pane, select and right-click one or more items, and then do one of the
following:

On the shortcut menu, click Merge to apply the Merge Now action to
all the items that you selected.

On the shortcut menu, click Release Claim to apply the Release Claim
action to all the items that you selected.

Tip

When clicking Merge or Release Claim, the software applies the merge
action all the items that you selected, regardless of the merge action that
was previously assigned to the items. If you want to preserve the merge
action of the selected items, we recommend that you first copy the items to
the Merge Buffer as Merge Now or Release Claim, and then, in the
Merge Buffer, use the Merge All option.

Related Topics

Actions for Merging Items, page 235

Item Indicators, page 544

Merge Items from the Command Line, page 240

Merge Tab (Preferences Dialog Box), page 473

Merging Project and As-Built Data Common Tasks, page 230

Merging Project and As-Built Data: An Overview, page 218

Project Explorer, page 538

SmartPlant Instrumentation Administration Users Guide 239

Merging Project and As-Built Data: An Overview

Merge Items from the Command Line


You can merge project items with As-Built without using the Administration module
options of SmartPlant Instrumentation. To do so, you, you need to specify additional
parameters. For example, if your Operating System is Windows 2000, you specify
these parameters in your Windows Server Task Scheduler.
Notes

You can only merge items from the command line after copying the items
from the Project Explorer to the Merge Buffer. For details, see Copy
Items to the Merge Buffer Common Tasks.

After copying the items, you must close the Administration module prior
to merging the items from the command line.

Parameter String for Merging Items


Main <user name>,<user password>,<Operating owner domain
name>,<source project name>,<merge flag>

Important

Use a space character between the Main and <user name> parameters.
For other parameters, you must only use commas as parameter separators.

Use upper case for the merge flag M parameter.

The following table describes the parameters in the order of their appearance in the
parameter string.
Parameter

Description

Possible
Settings

Main

The initial parameter, which opens the Administration


module

Main

<user name>

The name of the user with full Project Activities access


rights. The user group must be assigned to the target project.

User1

<user password>

The user password defined by System Administrator.

User1

<Operating owner
domain name>

The name of the Operating owner domain in which you


copied items from the Project Explorer to the Merge
Buffer.

SPI1

<target project
name>

The name of the project from which you want to merge items
with As-Built.

Project1

<merge flag>

The M parameter that allows you to merge items you copied


to the Merge Buffer.

Example
Main User1,User1,SPI1,Project1,M

Related Topics

Actions for Merging Items, page 235


240 SmartPlant Instrumentation Administration Users Guide

Naming Conventions: An Overview

Naming Conventions: An Overview


Naming conventions define the parameters which the software uses when creating
tags, loops, device panels, cables, or other items in SmartPlant Instrumentation. Each
of these items has it's own instrument type to which you manually set the naming
conventions from the Admin module. The naming conventions are flexible and
follow no limitations, so you can build and maintain the instrumentation data
according to your specific instrumentation needs. The maximum length of a naming
convention is 50 characters.
Before you start defining naming conventions, we recommend that you familiarize
yourself with the following general guidelines:

You define naming conventions on a per <unit> basis. Therefore, if you


want certain items (for example, panels) to share naming conventions on
the highest plant hierarchy level, for example, you can define a naming
convention for panels in a specific <unit>, and then, copy this convention
to all other units available in the same <plant>.

The naming is performed according to item types. For an item type, it is


only possible to define one naming convention. You set the naming for
each item type and thus affect the creation of new items in SmartPlant
Instrumentation. All items inherit the naming convention of the item type
they belong to. Examples for item types are Instrument, Loop, Cabinet,
DCS, Control System Tag, and so forth.

You can define the naming convention freely without any limitation, or set
it to include different segments, separators, dashes and any other character
that serves your purposes. The maximum length of a naming convention is
50 characters, including separators. This length applies for all naming
convention standards.

You can copy naming conventions only on the lowest plant hierarchy
level, for example, from Unit1 to Unit2, within the same domain.

When defining a naming convention for wiring equipment, note the


following limitation: you cannot include a slot name or an I/O card name
together with the rack name. The software can only retrieve the name of
the actual parent item. For example, when a card is a child item of a slot,
only the slot name can be retrieved but not the rack name.

SmartPlant Instrumentation Administration Users Guide 241

Naming Conventions: An Overview

Compatibility with Instrumentation Standards


SmartPlant Instrumentation allows you to freely set your own standards and naming
convention. This way you can build and maintain the instrumentation data according
to your specific instrumentation needs.
The tag and loop number naming convention options depend on the standard that the
Domain Administrator has selected in the Naming Conventions dialog box. The
default standard is the Flexible standard which allows the Domain Administrator
complete flexibility when setting up unit naming conventions. However, the Domain
administrator can use traditional ISA or Loop standards to set the naming conventions
automatically and then modify the conventions as required.
Notes

The ISA standard is based on the Instrument Society of America


ANSI/ISA-S5.1-1975 standard as published in:
Instrument Society of America. Standards and Practices of
Instrumentation, Instrumentation Symbols and Identification. 7th ed. NC,
1983.

You can use some parts of the Flexible standard with the Power Station
Designation System (KKS) standard.

Related Topics

Document Number Naming Convention Examples, page 249

Domain Administration Common Tasks, page 147

Naming Conventions Common Tasks, page 243

Notes for Creating Naming Conventions for Wiring Items, page 244

Wire End Naming Conventions: An Overview, page 253

242 SmartPlant Instrumentation Administration Users Guide

Naming Conventions: An Overview

Naming Conventions Common Tasks


The following tasks are used when you need to define naming conventions for a
<unit> in SmartPlant Instrumentation:
Define Naming Conventions
This procedure enables you to define naming conventions in a <unit>. For details,
see Define Naming Conventions.
Copy Naming Conventions from Another <Unit>
This procedure explains how you can copy the naming conventions from a selected
source <unit> in the current domain to the current <unit>. You can use this
procedure after creating a new <unit> for which no naming convention definitions
have been made yet. The software does not let you copy naming conventions to a
<unit> that already contains instrument tag numbers. For details, see Copy Naming
Conventions from Another <Unit>.
Copy Naming Conventions to Other <Units>
This procedure explains how you can copy naming conventions to <units> that exist
in the current domain but have no naming convention definitions yet. Also, you can
use the procedure tips if you want to set the software to copy naming conventions
automatically to all new <units> on creating the <units> in the Plant Hierarchy
Explorer. The software does not let you copy naming conventions to a <unit> that
already contains instrument tag numbers. For details, see Copy Naming Conventions
to Other <Units>.
Document Number Naming Convention Examples
The following topic provides examples of document number naming conventions:
Document Number Naming Convention Examples.
Generate Naming Convention Reports
This procedure enables you to generate and print a naming convention report. This
report contains information about the naming conventions for each item in all the
<units> of the current domain. For details, see Generate Naming Convention
Reports.
Wire End Naming Conventions Common Tasks
This set of procedures allows you to define wire end naming conventions so that
SmartPlant Instrumentation users can assign a wire end naming convention to the
ends of one or more wires belonging to a cable. For details, see Wire End Naming
Conventions Common Tasks.
Related Topics

Naming Conventions: An Overview, page 241


SmartPlant Instrumentation Administration Users Guide 243

Naming Conventions: An Overview

Notes for Creating Naming Conventions for Wiring Items


General Note
Naming conventions of wiring items do not depend on the naming convention
standard set by the System Administrator per domain. You define a naming
convention for wiring items (apart from wire ends) using the options available in the
Naming Conventions dialog box. In this dialog box, a complete list of wiring items
for which you can define naming conventions appears in the Convention box.
When applying a naming convention that includes a rack segment, a slot segment or
both to a wiring item that does not have a rack or a slot as its immediate parent item,
the software omits this segment.
Wire End Naming Conventions
Options for defining wire end naming conventions are available in the Wire End
Naming Conventions dialog box.
Panel Naming Conventions
If your panel naming convention segments contain levels of panel locations, the
software does not display the lowest level in SmartPlant Instrumentation in the
following scenario:
1. In the Panel Location Levels dialog box, create several levels, for example,
Building, Floor, and Room.
2. In the Naming Conventions dialog box, define a naming convention for a panel,
for example, for a DCS. For the naming convention, use the panel location
segments, for example, Building\Floor\Room\XX,
where XX represents a free segment.
3. In SmartPlant Instrumentation, create a new DCS at the Floor level. When
creating the DCS name, the software automatically replaces the Room segment
with spaces so that the new DCS name appears as follows:
Building\Floor\ \XX
If, when defining the naming convention, you selected the Remove trailing
spaces in each segment check box, the name appears as follows:
Building\Floor\\XX
Related Topics

Define Panel Location Levels, page 302

Naming Conventions Common Tasks, page 243

Naming Conventions: An Overview, page 241

Wire End Naming Conventions: An Overview, page 253

244 SmartPlant Instrumentation Administration Users Guide

Naming Conventions: An Overview

Define Naming Conventions


1. Start the Administration module and log on as Domain Administrator.
2. With the Domain Administration window or Domain Definition window, do
one of the following:

Click Activities > Naming Conventions.

Click .
3. Beside Parent hierarchy, click Browse to specify a <unit> for which you want
to define naming conventions.

Tip
Naming conventions are always defined per <unit>.
4. From the Convention list, select the item for which you want to define a naming
convention.

Tips

If you modify either tag or loop naming conventions in a <unit> which


already contains tags or loops, the software prompts you to confirm the
naming convention change.

When you duplicate a loop in SmartPlant Instrumentation, the


duplicated loop inherits the naming convention from the original loop.
5. Click Add as many times as the number of segments you want to specify for the
naming convention.

6. From the Segment Category list, select a segment category in each of the data
rows.
7. From the Segment list, select a segment for each category.
8. In the Separator box, type a character to separate the current segment from the
next.
Tips

By default, the software assigns the C- prefix to all the device cable
names. However, when you select device cable from the Convention
list, the Separator data field is empty. If you define new naming
conventions for the device cable but do not type any separator in the
Tag Number row, cable names appear without the C- prefix. You
need to type C in the Separator field of the Tag Number row to make
the C- prefix available again.

If a separator is the last character in the control system tag name, the
software retains the separator when applying the control system tag
naming convention.

SmartPlant Instrumentation Administration Users Guide 245

Naming Conventions: An Overview

If a separator is the last character in the name of an item that is not a


control system tag, the software removes the separator from the name.
For example, if your instrument naming convention includes a /
separator before the COMPONENT SUFFIX segment, the FT-100
tag number with the A suffix appears as FT-100/A and without any
suffix as FT-100.

If you want a separator to appear at the end of the item name, add
another data row and select Free Segment as both segment category
and segment, define a separator, and then, define the Free Segment
length as 0.
9. In the Start data field, type the starting position of the current segment, that is, the
leftmost character of the description which appears in the segment descriptor.

10. In the Length data field, type the total number of characters (from the starting
character) which appears in the segment descriptor.
Tips

You can select a part of a segment by specifying the appropriate Start


and Length values.

When defining naming conventions for instruments or loops, if you


want to use the ISA or Loop standard, click ISA Standard or Loop
Standard to load the naming convention segments that comply with
the ISA or Loop standards.
Caution

If you already defined a naming convention for instrument tags or


loops and want to modify an existing convention, do not click the ISA
Standard or Loop Standard button again. Clicking any of these
buttons resets your instrument or loop naming convention to the
default settings for the current standard.
11. When defining a naming convention for wiring items, control system tags, or
document numbers, do one of the following:

Select Remove trailing spaces in each segment to set the software to


remove trailing spaces from each segment of an item name created
according to the naming convention if the actual number of characters
in a segment is smaller than the segment length.

Clear Remove trailing spaces in each segment to set the software to


adds trailing spaces to match the segment length.

246 SmartPlant Instrumentation Administration Users Guide

Naming Conventions: An Overview


Tips

The software does not remove spaces that are part of separators or
appear at the beginning or in the middle of a segment.

When a wiring item or control system tag naming convention includes


free segments, the software removes spaces only from the first and last
free segment.
12. When defining a naming convention for a document number, for documents you
intend to save as files, do one of the following:

Select Remove spaces in file names to removes spaces from the name
of the document files.

Clear Remove spaces in file names to save documents with the name
of the source document item.
Tip

A document file has spaces if the source document item has spaces.
For example, when you generate a loop drawing without opening the
drawing, the software automatically saves the drawing file with the
name of the source loop number. If the source loop number has spaces
and you selected this check box, the software removes the spaces from
the drawing file name when saving the drawing as a file.
13. If you are prompted to change the naming convention (if a naming convention
already exists for the unit), do one of the following in the displayed message:

Click Yes to modify the current unit naming conventions.

Click No to retain the current unit naming conventions without


modifying them.
14. When done, click Apply to save the naming conventions to the database.

15. Click Close to close the dialog box.


Related Topics

Log on as Domain Administrator, page 86

Naming Conventions Common Tasks, page 243

Naming Conventions: An Overview, page 241

SmartPlant Instrumentation Administration Users Guide 247

Naming Conventions: An Overview

Copy Naming Conventions to Other <Units>


1. Start the Administration module and log on as Domain Administrator.
2. With the Domain Administration window or Domain Definition window, do
one of the following:

Click Activities > Naming Conventions.

Click .
3. Beside Parent hierarchy, click Browse to specify a source <unit>.

Tips

Naming conventions are always defined per instrument type in a


specific unit. Select the types and their appropriate conventions in the
Conventions list .

You can select Copy all conventions from the current <unit> to
copy all the naming conventions that exist in the current <unit> to
every new <unit> that you create using the Plant Hierarchy
Explorer. This option does not apply to units that already exist in
your domain.
4. Click Copy To.

5. In the Copy Naming Conventions dialog box, select a check box beside the
target <units> to which you want to copy the naming conventions of the source
<unit>.
6. Click Copy and then Close.
7. In the Naming Conventions dialog box, click Apply and then Close.
Related Topics

Log on as Domain Administrator, page 86

Naming Conventions Common Tasks, page 243

Naming Conventions: An Overview, page 241

248 SmartPlant Instrumentation Administration Users Guide

Naming Conventions: An Overview

Copy Naming Conventions from Another <Unit>


1. Start the Administration module and log on as Domain Administrator.
2. With the Domain Administration window or Domain Definition window, do
one of the following:

Click Activities > Naming Conventions.

Click .
3. Beside Parent hierarchy, click Browse to specify a target <unit>.

4. Click Copy From to select a source <unit>.


5. In the dialog box Copy Naming Conventions From, expand the plant hierarchy
and select a source <unit> from which you want to copy the naming conventions.
6. Click OK to return to the dialog box where you can view the naming conventions
you copied.
7. In the Naming Conventions dialog box, click Apply and then Close.
Related Topics

Log on as Domain Administrator, page 86

Naming Conventions Common Tasks, page 243

Naming Conventions: An Overview, page 241

Document Number Naming Convention Examples


In SmartPlant Instrumentation, it is possible to assign a document number to a
process data, dimensional data, or calculation sheet, item specification, loop drawing,
or panel-strip report. In the Administration module, you can define a document
number naming convention individually for each document type available in
SmartPlant Instrumentation. On the Naming Conventions dialog box, the document
types appear in the Convention list, in parenthesis beside the Document Number
string. This topic provides examples of document number naming conventions for
instrument specifications and loop drawings.

SmartPlant Instrumentation Administration Users Guide 249

Naming Conventions: An Overview


Segment Definition Example for the Instrument Specification Document
Number

Implementation Example in SmartPlant Instrumentation


The following example shows a spec document number in the Domain Explorer.
The software created this number according to the naming convention that you
defined. After you set the appropriate instrument type profiles to include
specification data, the software applies the convention when you do any of the
following:

Create a new instrument specification the software displays the


document number automatically in the New Specification dialog box.

Edit properties of an existing loop or tag, and then, on the Tag Number
Properties dialog box, select the Update document numbers check box.

Segment Definition Example for the Loop Drawing Document Number

250 SmartPlant Instrumentation Administration Users Guide

Naming Conventions: An Overview


Implementation Example in SmartPlant Instrumentation
The following example shows a loop drawing document number in the Loop
Drawing List dialog box, which displays various properties of loop drawings that
you can generate . The software created this number according to the naming
convention that you defined. The software applies the convention when you do any
of the following:

Create a new loop the software assigns automatically the document


number to the drawing that you can generate for the loop.

Edit properties of an existing loop, and on the Loop Number Properties


dialog box, select the Update document numbers check box.

Notes

If you do not define a naming convention for instrument specification


document numbers, the software creates the default document number
<tag number>-SP.

If you do not define a naming convention for calculation sheet document


numbers, the software creates the default document number
<tag number>-CL.

If you do not define a naming convention for process data sheet document
numbers, the software creates the default document number
<tag number>-PD.

If you do not define a naming convention for document numbers of


dimensional data sheets, the software creates the default document number
<tag number>-DDP.

If you do not define a naming convention for loop drawing document


numbers, the software creates the default document number
LD <loop number>.

For other documents, the software only create document numbers when
naming conventions exist.

In SmartPlant Instrumentation, it is always possible to change the


document number associated with a particular document, for example, on
the Revisions dialog box.

If needed, when editing properties of a tag or loop number, you can update
the document number for the associated documents. In this case, the
software assigns document numbers according to the document number
naming conventions.
SmartPlant Instrumentation Administration Users Guide 251

Naming Conventions: An Overview

Generate Naming Convention Reports

With the Domain Administration window open, click Report > Naming
Convention.

Related Topics

Naming Conventions Common Tasks, page 243

Naming Conventions: An Overview, page 241

252 SmartPlant Instrumentation Administration Users Guide

Wire End Naming Conventions: An Overview

Wire End Naming Conventions: An Overview


SmartPlant Instrumentation users can assign a wire end naming convention to the
ends of one or more wires belonging to a cable. A convention can consist of free
segments as well as segments that designate properties of certain wiring items. A
convention can also have separators between segments. The total length of a wire
end naming convention can be up to 50 characters.
The Domain Administrator is responsible for defining and managing wire end naming
conventions. Also, the Domain Administrator has rights to enable or disable the use
of the wire end naming conventions in the Wiring module.
To use the wire end naming convention options, you need to enter the Administration
module as the Domain Administrator and then, with the Domain Administration
window open, on the Activities menu, click Wire End Naming Conventions.
Related Topics

Domain Administration Common Tasks, page 147

Log on as Domain Administrator, page 86

Wire End Naming Conventions Common Tasks, page 254

SmartPlant Instrumentation Administration Users Guide 253

Wire End Naming Conventions: An Overview

Wire End Naming Conventions Common Tasks


The following tasks are used when you need to access the Administration module.
Enable the Use of Wire End Naming Conventions
Use this procedure to allow users to assign naming conventions to wire ends in the
Wiring module. For more information, see Enable the Use of Wire End Naming
Conventions, page 254.
Define Wire End Naming Conventions
You can use this procedure to define new wire end naming conventions. For more
information, see Define Wire End Naming Conventions, page 254.
Duplicate Wire End Naming Conventions
This procedure describes how to duplicate wire end naming conventions. For more
information, see Duplicate Wire End Naming Conventions, page 256.
Modify Wire End Naming Conventions
You can use this procedure to modify wire end naming conventions. For more
information, see Modify Wire End Naming Conventions, page 256.
Delete Wire End Naming Conventions
This option you to delete wire end naming conventions. For more information, see
Delete Wire End Naming Conventions, page 257.

Enable the Use of Wire End Naming Conventions

With the Wire End Naming Conventions dialog box open, select Enable
using wire end naming conventions.

Related Topics
Wire End Naming Conventions Common Tasks, page 254

Wire End Naming Conventions: An Overview, page 253

Define Wire End Naming Conventions


1. In the Wire End Naming Conventions dialog box, click New.
2. In the Wire End Naming Convention Properties (New) dialog box, under
Convention, type a unique name.
3. Under Description, type a description, if needed.
4. Click Add to add a new row in the data window.

254 SmartPlant Instrumentation Administration Users Guide

Wire End Naming Conventions: An Overview


5. Under Segment definitions, in the data window, select a segment from the list.
Tip
A segment can be either free or can designate properties of certain
wiring items. If you select a free segment as part of a naming
convention, in the Wiring module, SmartPlant Instrumentation users
can type any string up to the length allocated for the free segment.
6. To determine all or part of the naming convention string by the actual name of the
item that appears in the segment that you selected under Trim Trailing Spaces,
select the check box.

7. To define the start position and length of segments, under Start accept or modify
the value that designates the starting character in the segment from which the
segment appears in the naming convention.
8. Under Length, accept or modify the default number of characters allocated for
the selected segment string in the naming convention (starting from the position
defined in the Start box).
Tip
When you select a segment, the software automatically displays the
maximum length that can be used for the segment. If the total length
exceeds the maximum permitted value of 50 characters, the software
automatically truncates the number of characters in the segment to
maintain the permitted total length or displays a message if the total
length of the segment has already reached the maximum value.
9. If you need to define a separator between the segments in the naming convention
string, in the Separator column, type separator characters (up to 30 characters of
any kind).

10. Repeat steps 4 through 9 for each segment that you want to define.
Tips

You can change the sequence of segments in the naming convention


using the Up and Down buttons.

The Sample box shows a preview of the naming convention. The


value that appears in the Total length box represents the total value of
characters in the naming convention segments, including the separator
characters. All naming convention strings can have a maximum length
of 50 characters.

SmartPlant Instrumentation Administration Users Guide 255

Wire End Naming Conventions: An Overview


11. Select Remove spaces from wire end names if you defined your naming
convention in any of the following ways:

You used a naming convention segment that includes spaces, for


example, panel name 101-FT -200.

You increased the default length of a segment. For example, if the


default segment length is 20 characters and you changed it to 30
characters, the software automatically adds the additional characters to
the naming convention as trailing spaces, provided that the entire
naming convention does not exceed 50 characters.
12. Click OK.

Related Topics

Naming Conventions Common Tasks, page 243

Wire End Naming Conventions Common Tasks, page 254

Wire End Naming Conventions: An Overview, page 253

Duplicate Wire End Naming Conventions


1. In the Wire End Naming Conventions dialog box, select a naming convention to
be used as a source.
2. Click Duplicate.
3. In the Wire End Naming Convention Properties (Duplicate) dialog box, type a
unique name for the target convention.
Note

You can modify any existing segment definitions as you need. These
settings only apply to the target naming convention.

Related Topics

Naming Conventions Common Tasks, page 243

Wire End Naming Conventions Common Tasks, page 254

Wire End Naming Conventions: An Overview, page 253

Modify Wire End Naming Conventions


1. In the Wire End Naming Conventions dialog box, select a naming convention.
2. Click Properties.
3. In the Wire End Naming Convention Properties dialog box, modify the settings
as you need.
Note

If the convention is already in use in SmartPlant Instrumentation, you can


modify only the convention name and description.

256 SmartPlant Instrumentation Administration Users Guide

Wire End Naming Conventions: An Overview

Delete Wire End Naming Conventions


1. In the Wire End Naming Conventions dialog box, select a naming convention.
2. Click Delete.
Note

You can delete only those conventions that are not in use in SmartPlant
Instrumentation.

Related Topics

Naming Conventions Common Tasks, page 243

Wire End Naming Conventions Common Tasks, page 254

Wire End Naming Conventions: An Overview, page 253

SmartPlant Instrumentation Administration Users Guide 257

Access Rights: An Overview

Access Rights: An Overview


One of the key roles of the Domain Administrator is to define user access rights. If
the domain type is Operating owner, access rights are also defined at the level of
individual projects.
To grant access rights to each SmartPlant Instrumentation user group, the Domain
Administrator chooses the items and activities, and the level of access granted. When
the domain type is Operating owner, in a project, access rights granted on the domain
level do not apply. If you want to grant access rights to a group assigned to a project,
you must also assign this group to As-Built. For the description of the items and
activities, see Access Rights Descriptions, page 260.
In SmartPlant Instrumentation, items (for example, tags, cables, loops, and so forth)
and activities (for example, modules) are defined on a specific level: highest or lowest
plant hierarchy level (for example, plant or unit), or on the level of the entire domain.
When data is defined on a specified level, it contains data which is unique on the
specified level.
For example:
The cable item type is defined per <plant>. This means that any cable data is
described in the current domain on the <plant> level. This is so because tag numbers
associated with wiring can propagate to more than one <unit> or <area>.
On each level you can grant to a group one of the following access rights:

Full users in the corresponding group can add, delete, and update the
data of the selected item type.

Modify users in the corresponding group can only add or update the
data of the selected item type (deletion is prohibited).

View Only users in the corresponding group can only view the data of
the selected item type without being able to modify it.

Access Denied users in the corresponding group cannot access the data
of the selected item type.
Note

If you assign a user to more than one group, you can specify whether to
grant maximum or minimum access rights for that user over all the groups,
by respectively selecting or clearing Grant maximum access rights.

Related Topics

Access Rights Common Tasks, page 259

Domain Administration Common Tasks, page 147

Users and Groups Common Tasks, page 94

Windows Authentication Logon Method: An Overview, page 99

258 SmartPlant Instrumentation Administration Users Guide

Access Rights: An Overview

Access Rights Common Tasks


The Domain Administrator can perform the following tasks to define and manage
access rights:
Access Rights Descriptions
This topic describes the items and activities for which the Domain Administrator can
grant access rights. For more information, see Access Rights Descriptions, page 260.
Grant Access Rights for Selected Items or Activities
This option enables the Domain Administrator to grant access rights for selected
items/activities to a specific group. For more information, see Grant Access Rights
for Selected Items or Activities, page 270.
Grant the Same Access Rights for All Items
This option allows the Domain Administrator to grant the same access right to a
group of users on a specified level of the plant hierarchy in the current domain. The
Domain Administrator can also grant the same access rights to all user groups on a
specified level. If you select the plant or unit level, you can also grant the same
access rights to all plants or units or only to the selected plant or unit. The selected
access right mode will then apply to the selected user group or to all the user groups
in the current domain. For more information, see Grant the Same Access Rights for
All Items, page 271.
Copy Access Rights
The Domain Administrator can use this procedure to copy access rights from a source
group to a target group for SmartPlant Instrumentation items at the required level.
The Domain Administrator can copy access rights at a domain level, at the highest
level of the plant hierarchy, or at the lowest level of the plant hierarchy. If the
domain type is Operating owner domain, the Domain Administrator can only copy
access rights from one project to another. For more information, see Copy Access
Rights, page 274.
Workflow Access Rights
In addition to defining access rights at the module level, you can also define access
rights at the level of individual instrument tags for use with the workflow option. For
more information, see Workflow Access Rights, page 272.
View the Items in the Current Domain
This option enables you to open the Items pop-up window to view the items in the
current domain and the levels on which they are defined. Only those items for which
you can grant access rights are displayed. Note that you cannot edit the displayed
item data. For more information, see View the Items in the Current Domain, page
274.

SmartPlant Instrumentation Administration Users Guide 259

Access Rights: An Overview


Generate Access Rights Report
You can generate a report that displays access rights granted to user groups that you
select. You can either generate a report on a specific plant hierarchy level or on the
domain level, or on all levels. For more information, see Generate Access Rights
Report, page 275.
Related Topics

Access Rights: An Overview, page 258

Domain Administration Common Tasks, page 147

Access Rights Descriptions


The following table describes the items and activities for which the Domain
Administrator can grant access rights. The Parent column displays an access right
entry whose setting overrides the setting defined for the current item type or activity.
All access rights that apply at the module level automatically apply to the appropriate
options available in the Domain Explorer.
For example, the entry Instrument Index Module Access is the parent of Tag
Definition. If the Tag Definition access right definition is Full, and the Instrument
Index Module Access is Access Denied, you cannot create, modify, or delete tag
numbers in the Instrument Index module.
Item or
Activity

Description

Level

Access Rights
Management

Manage access rights for the current


domain (Domain Administrator
activity).

Domain

Add-Ins

Access rights for the add-in options


available in the current domain, that is,
importing catalogues, browser views,
system interfaces, external libraries,
and so forth.

Domain

Administration
Reports

Access rights for various reports that


can be generated in the Administration
module.

Domain

Assign Groups
to Projects

Access rights for the assignment of


Domain
user groups to As-Built and projects
existing in the Operating owner domain
(Domain Administrator or Project
Administrator activity).

260 SmartPlant Instrumentation Administration Users Guide

Parent

Access Rights: An Overview


Item or
Activity

Description

Level

Assign Users to
Groups

Access rights for the assignment of


users to groups. (Domain
Administrator activity, or Project
Administrator activity when the
domain type is Operating owner).

Domain

Auto Cross
Wiring

Access rights for the Automatic


Cross-Wiring feature in the Wiring
module.

Plant

Auto Wiring

Access rights for the auto wiring tasks


in the Wring module.

Plant

Binder Package
Deletion

Access rights to delete binder packages


in the Document Binder module.

Plant

Browser Buffer
Use

Access rights to copy to and paste data


from a browser buffer in any browser
view.

Unit

Browser
Manager

Access rights for the Browser


Manager. Users with View Only
access rights can expand browser
groups, display filter, sort, and style
settings, and open a browser view.
Users with the Access Denied setting
can only expand browser groups, and
then select and open a browser view.

Plant

Browser
Manager Filter

Access rights for the Filter options in


the Browser Manager.

Plant

Browser
Manager Sort

Access rights for the Sort options in


the Browser Manager.

Plant

Browser
Manager Style

Access rights for the Style options in


the Browser Manager.

Plant

Browser
Manager Style
Headers

Access rights for the Style Headers


option in the Browser Manager.

Plant

Browser
Module Access

Access rights for the Browser module.

Domain

Browser User
Name, Change
Date

Access rights to include the User


Name and Change Date fields in a
browser view.

Unit

Parent

Wiring Module
Access

SmartPlant Instrumentation Administration Users Guide 261

Access Rights: An Overview


Item or
Activity

Description

Level

Cable Routing
and Drums

Access rights for the Wiring module


Associations menu commands related
to cable routing and cable drum, and
for the appropriate supporting tables
accessible on the Tables of the Wiring
module. These access rights do not
apply to the Cable Routing Options
command available on the
Associations menu.

Plant

Cable Routing
Options
Command

Access rights for Cable Routing


Options command available on the
Associations menu of the Wiring
module.

Plant

Calculation
Activities

Access rights to perform calculations

Unit

Calculation
Module Access

Access rights for the Calculation


module.

Unit

Calibration
History Editing

Access rights for editing data in the


Calibration History window of the
Calibration module. To grant full
access rights, under Mode in the Item
or activity section of the Access
Rights window, select Full (Add /
Delete / Update). To grant view-only
access rights, select View Only. Note
that the Modify (Add / Update) option
functions as full, while the Access
Denied option functions as view-only.

Unit

Calib. Options
& Maint.
Events

Calib. & Maint.


Event
Supervisor

Access rights for the calibration


supervisor activities in the Calibration
module and for completing and
deleting maintenance even records in
the Instruments folder of the Domain
Explorer.

Unit

Calib. Options
& Maint.
Events

Calib. Options
& Maint.
Events

Access rights for the Calibration


module and for creating and editing
maintenance event records in the
Instruments folder of the Domain
Explorer.

Unit

262 SmartPlant Instrumentation Administration Users Guide

Parent

Calculation
Module Access

Access Rights: An Overview


Item or
Activity

Description

Level

Parent

Calibration
Result Modif.

Access rights to modify calibration


results or enter calibration data.

Unit

Calib. Options
& Maint.
Events

Claim Items for


Project

Access rights for claiming items from


SmartPlant Instrumentation when the
domain type is Operating owner.
These access rights do not apply to
claiming options available in the
Administration module.

Domain

Clear Locking

Access rights for the Clear Locking


option on the DBA menu (Oracle and
SQL Server only).

Domain

Connection
Type

Access rights for the definition of


Plant
connection types in the Wiring module.

Construction
Module Access

Access rights for the Construction


module.

Unit

Construction
Revision Cables

Access rights to define Formal Issue


for project cables in the Construction
module.

Plant

Construction
Module Access

Construction
Revision Instr.

Access rights to define Formal Issue


for project instruments in the
Construction module.

Plant

Construction
Module Access

Construction
Revision Panels

Access rights to define Formal Issue


for project panels in the Construction
module.

Plant

Construction
Module Access

Construction
Revision Wires

Access rights to define Formal Issue


for the project wires in the
Construction module.

Plant

Construction
Module Access

Construction
Supporting
Tables

Access rights for the Construction


module supporting tables.

Domain Construction
Module Access

Control System
Tag Operations

Access rights for all I/O assignment


options in the Wiring module and also
for modifying information associated
with control system tags in the
Instrument Index module.

Plant

Custom Field
Definition

Access rights for the Custom Fields


option in the Domain Administration
window (Domain Administrator
activity).

Domain

Wiring Module
Access

SmartPlant Instrumentation Administration Users Guide 263

Access Rights: An Overview


Item or
Activity

Description

Level

Parent

DDP Module
Supporting
Tables

Access rights for the Dimensional Data


for Piping module supporting tables.

Plant

Dimensional
Data Module
Access

Define User
Groups

Access rights for the Group option in


the Domain Administration window.

Domain

DeltaV Data

Access rights for the DeltaV interface


options.

Domain

Dimensional
Data Module
Access

Access rights for the Dimensional Data


for Piping module.

Unit

Document
Binder Module
Access

Access rights for the Document Binder


module.

Plant

Domain Cable
Management

Access rights for managing cables in


the Domain Explorer.

Plant

Domain
Definition
Notes

Access rights for the Notes section in


the Domain Definition window Domain Administrator activity.

Domain

Domain Panel
Management

Access rights for managing panels in


the Domain Explorer.

Plant

Drawing Block
Management

Access rights to create block types and


group CAD drawing blocks in these
block types.

Domain Loop Drawings


Module Access

Enhanced
Report Chg.
(Layout)

Access rights for changes to enhanced Plant


reports at the layout level (macro
attributes, redlining). Enhanced reports
are reports generated by the Enhanced
Report Utility.

Enhanced
Report Chg.
(Report)

Access rights for changes to enhanced Plant


reports at the report level (repositioning
of drawing objects, SmartText,
redlining). Enhanced reports are
reports generated by the Enhanced
Report Utility.

Equipment
Supporting
Table

Access rights for the Equipment


supporting table in the Instrument
Index module.

Plant

Field Personnel

Access rights for the Field Personnel


Profile option in the Domain
Administration window.

Domain

264 SmartPlant Instrumentation Administration Users Guide

Wiring Module
Access

Wiring Module
Access

Access Rights: An Overview


Item or
Activity

Description

Level

Parent

Form Data
Template

Access rights for managing form data


templates in the Specifications module.

Domain

Global
Revision
Management

Access rights to manage global


revisions using the options of the
Global Revisions dialog box.

Unit

Hook-Up
Definition

Access rights to create, edit, or modify


hook-ups in the Domain Explorer.

Plant

Hook-Ups
Module Access

Hook-Up Item
Management

Access rights to create and manage


hook-up items in the Reference
Explorer and to associate hook-up
items with hook-ups. These access
rights also apply when you create and
manage item manufacturers on the
Tables menu of the Hook-Ups module.

Plant

Hook-Ups
Module Access

Hook-Ups
Module Access

Access rights for the Hook-Ups


module.

Unit

Import Utility
Access

Access rights for the Import utility.

Domain

Instal. Index
Manager

Access rights for the Installation Index


Manager in the Construction module.

Domain

Instr. Index
Supporting
Tables

Access rights for the Instrument Index


module supporting tables that allow
you to modify information associated
with tag numbers. These access rights
also apply to typical loop management.
These access rights do not apply to the
supporting tables Lines, P&ID, and
Equipment.

Domain Instrument
Index Module
Access

Instrument
Index Module
Access

Access rights for the Instrument Index


module.

Unit

Instrumentation
Workflow Flag

Access rights to define selected users


as instrumentation engineers who will
work in the workflow mode provided
that the System Administrator has
selected the Instrument/Process Data
Workflow check box in the Domain
Definition window.

Unit

Intrinsic Safety
Definition

Access rights for intrinsic safety


definition in the Wiring module.

Plant

Wiring Module
Access

SmartPlant Instrumentation Administration Users Guide 265

Access Rights: An Overview


Item or
Activity

Description

Level

Line Definition

Access rights to create, edit, or modify


lines in the Instrument Index and
Process Data modules.

Plant

Logo
Definition

Access rights for the domain logo


definition (Domain Administrator
activity), or a project log definition if
the domain type is Operating owner.

Domain

Loop - External
Macro Source

Access rights to connect to an external


macro source and use external macros
during loop drawing generation.

Unit

Loop Drawings
Module Access

Loop
Definition

Access rights to create, modify, or


delete a loop number in the Instrument
Index module.

Unit

Instrument
Index Module
Access

Loop Drawings
Module Access

Access rights for the Loop Drawings


module.

Unit

Macro
Definitions

Access rights for managing macro


Domain
definitions for loop drawings and hookup drawings.

Maintenance
Module Access

Access rights for the Maintenance


module.

Unit

Maintenance
Supporting
Tables

Access rights for modifying


information associated with the
Maintenance module supporting tables.

Plant

Management of
Local
Revisions

Access rights for adding, updating, and Unit


deleting revisions in a Revisions dialog
box. These access rights do not apply
to revision management options
available in the Global Revisions
dialog box.

Naming
Convention
Definition

Access rights for defining and


managing item naming conventions
(Domain Administrator activity).

Domain

P&ID
Supporting
Table

Access rights for the P&ID drawing


number supporting table in the
Instrument Index module.

Plant

Plant Hierarchy
Management

Access rights for creating and


managing plant hierarchy items in the
Plant Hierarchy Explorer (Domain
Administrator activity).

Domain

266 SmartPlant Instrumentation Administration Users Guide

Parent

Maintenance
Module Access

Access Rights: An Overview


Item or
Activity

Description

Level

Parent

Plant Owner
Definition

Access rights for the Owner option in


the Domain Definition window Domain Administrator activity.

Domain

Prevent. Maint.
- Supervisor

Access rights for the Preventive


Maintenance supervisor activities in
the Maintenance module.

Unit

Maintenance
Module Access

Prevent. Maint.
- Technician

Access rights for the Preventive


Unit
Maintenance technician activities in the
Maintenance module.

Maintenance
Module Access

Process Data
Change in
Specs

Access rights to change process data


values in an instrument specification.
(Specifications module.)

Unit

Process Data
Definition

Access rights to create, modify, or


delete a process data sheet.

Unit

Process Data
Module Access

Access rights for the Process Data


module.

Unit

Process Data
Supporting
Tables

Access rights for the Process Data


module supporting tables, that is,
Cases, Insulation Types, Pipe/Orifice
Materials, and Fluid Components.

Domain Process Data


Module Access

Process Data
Workflow Flag

Access rights to define selected users


as process engineers who will work in
the workflow mode provided that the
System Administrator has selected the
Instrument/Process Data Workflow
check box in the Domain Definition
window.

Unit

Project
Definition

Access rights that apply to all activities


that you can perform on the Project
Activities dialog box in the
Administration module. For example,
project creation, scope definition, tag
and loop number reservation, merging
items with As-Built, and so forth.

Domain

Publish

Access rights for publishing


documents.

Plant

Reference
Cable
Management

Access rights for managing reference


cables in the Reference Explorer.

Domain

Process Data
Module Access

SmartPlant Instrumentation Administration Users Guide 267

Access Rights: An Overview


Item or
Activity

Description

Level

Reference
Panel
Management

Access rights for managing reference


panels in the Reference Explorer.

Domain

SmartPlant
Registration

Access rights that enable the Domain


Administrator to register plants. This
option enables or disables the Register
menu command on the SmartPlant
menu on the Domain Administration
window menu bar.

Domain

Repair Supervisor

Access rights for the Repair


Maintenance supervisor activities in
the Maintenance module.

Unit

Retrieve

Access rights for retrieving documents.

Plant

Repair Technician

Access rights for the Repair


Unit
Maintenance technician activities in the
Maintenance module.

Revision
Deletion

Access right to delete saved revisions.

Unit

SAP Interface
Access

Access rights for the SAP interface.

Domain

Segment-Wide
Parameters

Access rights for creation of segmentwide parameter profiles of fieldbus


items in the Wiring module.

Unit

Fieldbus
Segments

Access rights for creating and


managing fieldbus items in the
Fieldbus Segments folder of the
Domain Explorer.

Plant

SP Electrical
Interface

Access rights for SmartPlant Electrical


interface options.

Unit

Specification
Definition

Access rights to create, modify, or


delete item specifications.

Unit

Specification
Form Access

Access rights to create, delete, or


modify specification forms in the
Specifications module.

Domain

Specifications
Module Access

Access rights for the Specifications


module.

Unit

Tag Category
Definition

Access rights for the Tag Category


Domain
feature in the Instrument Index module.

268 SmartPlant Instrumentation Administration Users Guide

Parent

Maintenance
Module Access

Maintenance
Module Access

Wiring Module
Access

Specifications
Module Access

Access Rights: An Overview


Item or
Activity

Description

Level

Parent

Tag Definition

Access rights to create, modify, or


delete tag numbers.

Unit

Instrument
Index Module
Access

Telecom Panel
Management

Access rights for the creation, deletion,


and editing of telecom panels in the
Domain Explorer and Reference
Explorer.

Plant

Telecom
Supporting
Tables

Access rights for the telecom


supporting tables in the Wiring
module.

Plant

To Do List

Access rights for running tasks in the


Domain
To Do List after retrieving a document.

Unit of
Measure
Definition

Access rights for the options available


in the Units of Measure and
Accuracy dialog box in SmartPlant
Instrumentation.

Domain

Update
Statistics
(Oracle)

Access rights for the Update Statistics


option on the DBA menu (System
Administrator activity).

Domain

Wire Group

Access rights for signal re-propagation. Plant

Wiring Module
Access

Wiring
Connections

Access rights for the connection


options in the Wiring module,
including batch connection and crosswiring.

Wiring Module
Access

Wiring Module
Access

Access rights for the Wiring module.


Unit
These access rights also disable various
wiring options that you can access
from without the Wiring module, for
example, when right-clicking an
instrument in the Browser View
window of the Instrument Index
module.

Wiring
Supporting
Tables

Access rights for wiring supporting


tables accessed using the Tables menu
of the Wiring module. These rights do
not affect telecom, cable routing and
cable drum options available on the
Tables menu.

Plant

Domain Wiring Module


Access

SmartPlant Instrumentation Administration Users Guide 269

Access Rights: An Overview


Item or
Activity

Description

Level

Parent

Work Request Supervisor

Access rights for the Work Request


supervisor activities in the
Maintenance module.

Unit

Maintenance
Module Access

Work Request Technician

Access rights for the Work Request


Unit
technician activities in the Maintenance
module.

Maintenance
Module Access

Related Topics

Access Rights Common Tasks, page 259

Access Rights: An Overview, page 258

Grant Access Rights for Selected Items or Activities


1. With the Domain Administration window open, do one of the following:

Click File > Domain Definition.

Click .
2. In the Domain Definition window, do one of the following:

Click Options > Access Rights.

Click .
3. In the Access Rights dialog box, in the Group list pane, select the desired user
group for which you want to define access rights.

4. Double-click the group to expand the tree.


5. Select the level at which you want to grant access rights (Domain level, Plant
level, or Unit level). If selecting at the plant or unit level, expand the tree further
to select a specific plant or unit.
6. In the Item or activity pane, click the Mode field next to the desired item or
activity in the Name column to open a list of available modes of access rights.
7. Select the required access rights mode from one of the following:

Full (Add / Delete / Update)

Modify (Add / Update)

View Only

Access Denied
8. Repeat steps 5 through 7 to grant access rights to the same group for another item
or activity. Repeat steps 3 through 7 grant access rights to another group for the
required item or activity.

270 SmartPlant Instrumentation Administration Users Guide

Access Rights: An Overview


9. Click

to save your selection to the database.

Note

Certain items or activities at the domain level relate to Domain


Administration. The access rights mode for these items is set for all users
to Access Denied by default. The Domain Administrator always has full
access rights to these items, regardless of the access rights mode set for
them in the group to which the Domain Administrator belongs.

Related Topics

Access Rights Common Tasks, page 259

Access Rights: An Overview, page 258

Grant the Same Access Rights for All Items


1. With the Domain Definition window open, do one of the following:

Click Options > Access Rights.

Click .
2. Do one of the following:

Click Options > Global Access Rights.

Click .
3. In the Global Access Rights dialog box, in the Access mode list, select the access
mode that you require.

4. From the Group name list, select a user group to which you want to apply the
access rights.
Tip
To apply the access rights to all the groups, select All.
5. To choose the level at which the software grants access rights, select the
appropriate Enable item selection check boxes.

Tips

At the Domain level, you can grant the selected access rights for all the
items at the domain level for the current domain.

At the <Plant> level, you can grant the selected access rights for all
the items at the <plant> level for a selected <plant>, or for all <plants>
in the domain.

At the <Unit> level, you can grant the selected access rights for all
the items at the <unit> level for a selected <unit>, or for all <units> in
the domain.

SmartPlant Instrumentation Administration Users Guide 271

Access Rights: An Overview


6. If you selected the <Plant> or <Unit> level, from the <Plant> an <Unit> lists,
select as specific <plant> or <unit>.
Tips
To apply the access rights an entire plant hierarchy level, from the
<Plant> or <Unit> lists, select All. The labels <Plant> and <Unit>
change dynamically according to your highest and lowest plant
hierarchy level definitions.
7. From the Item or activity list, make a selection.

Tip
To apply the access rights to all the items at a particular level, from the
Item or activity list, select All.
8. Click Apply.

9. Repeat steps 3 through 7 for each item or activity whose access rights you want to
define.
10. Close the Global Access Rights dialog box and then, in the Access Rights
window, click .
Note

You can also modify any selections you make in the Access Rights
window.

Related Topics

Access Rights Common Tasks, page 259

Access Rights: An Overview, page 258

Workflow Access Rights


Important
Workflow can only be implemented in SmartPlant Instrumentation after
being enabled by your System Administrator.
1. Start the Administration module and log on as Domain Administrator.

2. Define two engineering groups, one for instrumentation, and one for process data
with their users.
3. With the System Administration window open, do one of the following to open
the Domain Definition window:

Click File > Domain Definition.

Click

4. Click

.
to open the Access Rights window.

272 SmartPlant Instrumentation Administration Users Guide

Access Rights: An Overview


5. Select the instrument engineering group in the left area and expand the tree by
double-clicking it.
6. Double-click the Unit level icon to expand the list of units and select the unit
where you want to grant workflow access.
7. From the Name column, select Instrumentation Workflow Flag.
8. From the Mode column, select Full (Add / Delete / Update).
9. From the Name column, select Process Data Workflow Flag.
10. From the Mode column, select Access Denied.
11. Select the process engineering group in the left area and expand the tree by
double-clicking it.
12. Double-click the Unit level icon to expand the list of units and select the required
unit where you want to grant access.
13. From the Name column, select Process Data Workflow Flag.
14. From the Mode column, select Full (Add / Delete / Update).
15. From the Name column, select Instrumentation Workflow Flag.
16. In the Mode column, select Access Denied.
17. When done, do one of the following:

Click Options > Save.

Click

Related Topics

Access Rights Common Tasks, page 259

Access Rights: An Overview, page 258

SmartPlant Instrumentation Administration Users Guide 273

Access Rights: An Overview

Copy Access Rights


1. Start the Administration module and log on as Domain Administrator for the
required domain.
2. On the Domain Definition toolbar, click
3. On the Access Rights toolbar, click
box.

to open the Access Rights window.

to open the Copy Access Rights dialog

4. Under Project and group selection, do the following:

When the domain type is Operating owner, select source and target
projects. To copy access rights within one project, from the Source
project and Target project lists, select the same project.

Select source and target groups.


5. Under Access rights level, do the following:

Select a check box to specify the level at which you want to copy
access rights.

According to your level selection, select source and target domains,


highest plant hierarchy level items, or lowest plant hierarchy level
items.
6. Click Apply.

Related Topics

Access Rights Common Tasks, page 259

Access Rights: An Overview, page 258

View the Items in the Current Domain


With the Access Rights window open, do one of the following:

On the menu bar, click Options > Items.

On the toolbar, click

Related Topics

Access Rights Common Tasks, page 259

Access Rights: An Overview, page 258

274 SmartPlant Instrumentation Administration Users Guide

Access Rights: An Overview

Generate Access Rights Report


1. With the Domain Administration window open, on the Reports menu, click
Access Rights.
2. Do one of the following:

To generate a report on all levels of the plant hierarchy, on the domain


level, and, if the domain type is Operating owner, on the project level,
click the All Levels tab.

To generate a report on a specific level, click any tab other that All
Levels.
3. Under Group Name, select user groups that you want to include in the Access
Rights report.

Related Topics

Access Rights Common Tasks, page 259

Access Rights: An Overview, page 258

SmartPlant Instrumentation Administration Users Guide 275

Preferences Management: An Overview

Preferences Management: An Overview


The software allows the Domain Administrator to manage SmartPlant
Instrumentation preferences in the current domain, or in As-Built and projects if the
domain type is Operating owner. For details, see Preferences Management Dialog
Box: An Overview.
Related Topics

Managing Preferences Common Tasks, page 277

276 SmartPlant Instrumentation Administration Users Guide

Preferences Management: An Overview

Managing Preferences Common Tasks


The Domain Administrator can perform the following tasks when managing
preferences:
Set Domain Preferences
This option enables the Domain Administrator to set SmartPlant Instrumentation
preferences in the current domain. By setting domain preferences you determine
which preferences can be set by individual users and which preferences become
default preferences that are shared by all users and cannot be modified in SmartPlant
Instrumentation. For more information, see Set Domain Preferences, page 278.
Set Project Preferences
This option enables the Domain Administrator to set SmartPlant Instrumentation
preferences in As-Built and projects in your Operating owner domain. By setting
project preferences you determine which preferences can be set by individual users
and which preferences become default preferences that are shared by all users and
cannot be modified in SmartPlant Instrumentation. For more information, see Set
Project Preferences, page 279.
Copy Project Preferences
This option enables the Domain Administrator to copy preferences from one project
to one or more projects at a time, within your Operating owner domain. Also, you
can copy the default preference settings that you have defined in the Preferences
Management dialog box. For more information, see Copy Project Preferences, page
280.
Export Preferences
Use this procedure to export domain preferences (or project preferences when the
domain type is Operating owner) to an external .dmp file. For more information, see
Export Preferences, page 281.
Import Preferences
Use this procedure to import preferences from an external .dmp file to the current
domain (or specific project if the domain type is Operating owner). For more
information, see Import Preferences, page 281.
Related Topics

Domain Administration Common Tasks, page 147

Preferences Management: An Overview, page 276

SmartPlant Instrumentation Administration Users Guide 277

Preferences Management: An Overview

Set Domain Preferences


1. Start the Administration module and log on as Domain Administrator.
2. With the Domain Administration window open, click Activities > Preferences
Management.
3. Click the tabs in the Preferences Management dialog box to define various
default preference settings.
Tip
To learn more about SmartPlant Instrumentation module preferences,
click Help in the in the Preferences Management dialog box on the
appropriate tabs.
4. Click Advanced.

5. On the Advanced Domain Preferences dialog box, for the preferences that you
modified and want to set as default, clear the Enabled check box.
Tips

Clearing the Enabled check box for a particular option prevents new
and existing users from modifying this preference in SmartPlant
Instrumentation.

Selecting Enable all allows you to make all the domain preferences
available for customization in SmartPlant Instrumentation.
Caution

We recommend that you do not disable the temporary folder path


option. This is because in the temporary folder, the software creates
temporary files during various activities that users perform in
SmartPlant Instrumentation, for example, when creating specifications,
generating CAD drawings, hook-up drawings, reports, and so forth. If
you prevent users from specifying individual temporary folder paths,
the temporary folder path becomes shared among several users. This
can cause problems with data display when users perform the same
activity at the same time, for example, when creating two
specifications at the same time.
6. Click OK to save the settings and close the Advanced Domain Preferences
dialog box.

Related Topics

Managing Preferences Common Tasks, page 277

Preferences Management: An Overview, page 276

278 SmartPlant Instrumentation Administration Users Guide

Preferences Management: An Overview

Set Project Preferences


1. Start the Administration module and log on as Domain Administrator.
2. With the Domain Administration window open, click Activities > Preferences
Management.
3. On the Preferences Management dialog box, select a project, from the Project
list.
Tip
If you have not created any projects yet, select the DEFAULT
PREFERENCES option from the Project list and set the default
preferences, which the software then copies automatically to every
project that you create.
4. Click the tabs on the Preferences Management dialog box to define various
preference settings.

Tip
To learn more about SmartPlant Instrumentation module preferences,
click Help in the in the Preferences Management dialog box on the
appropriate tabs.
5. Click Advanced.

6. On the Advanced Project Preferences dialog box, for the preferences that you
modified and want to set as default, clear the Enabled check box.
Tips

Clearing the Enabled check box for a particular option prevents


project users from modifying this preference in SmartPlant
Instrumentation.

Selecting Enable all allows you to make all the project preferences
available for customization in SmartPlant Instrumentation.
7. Click OK to save the settings and close the Advanced Project Preferences
dialog box.

Related Topics

Managing Preferences Common Tasks, page 277

Preferences Management: An Overview, page 276

SmartPlant Instrumentation Administration Users Guide 279

Preferences Management: An Overview

Copy Project Preferences


1. Start the Administration module and log on as Domain Administrator.
2. With the Domain Administration window open, click Activities > Preferences
Management.
3. On the Preferences Management dialog box, from the Project list, select a
project.
Tip
You can also select the DEFAULT PREFERENCES option from the
Project list and set the default preferences which you can use when
copying preferences to existing projects or As-Built. When you create
a new project, it automatically receives the default preferences.
4. Click Advanced.

5. On the Advanced Project Preferences dialog box, do the following:

To allow users to set a preference for a SmartPlant Instrumentation


option in the current project, select Enabled next to the appropriate
preference option.

To prevent users from setting a preference for a SmartPlant


Instrumentation option in the current project, clear the Enabled check
box next to the appropriate option.

Select the Enable all check box to make all the preference options
available for customization in the current project.
6. Do one of the following:

Copy To to copy the current project preferences to other projects


in the Operating owner domain.

Copy From to overwrite the preferences in the project you have


selected in the Preferences Management dialog box.
7. Click Copy.

8. Click OK to save the settings and close the Advanced Project Preferences
dialog box.
Related Topics

Managing Preferences Common Tasks, page 277

Preferences Management: An Overview, page 276

280 SmartPlant Instrumentation Administration Users Guide

Preferences Management: An Overview

Export Preferences
1. Start the Administration module and log on as Domain Administrator.
2. With the Domain Administration window open, click Activities > Preferences
Management.
3. If the domain type is Operating owner, form the Project list, select a source
project.
4. Click Export.
5. On the dialog box that opens, enter the name of the target .dmp file, and then,
click Save to export the current preferences to the .dmp file.
Tips

It is only possible to export preferences to a .dmp file.

In the created .dmp file, you can modify preferences as you require,
and then, import them to a domain or project residing in another
database.

Related Topics

Import Preferences, page 281

Managing Preferences Common Tasks, page 277

Preferences Management: An Overview, page 276

Import Preferences
1. Start the Administration module and log on as Domain Administrator.
2. With the Domain Administration window open, click Activities > Preferences
Management.
3. If the domain type is Operating owner, form the Project list, select a target
project.
4. Click Import.
5. On the dialog box that opens, select the .dmp file that contains previously
exported preferences, and then, click Open.
6. On the Preferences Management dialog box, click OK to save the settings.
Related Topics

Export Preferences, page 281

Managing Preferences Common Tasks, page 277

Preferences Management: An Overview, page 276

SmartPlant Instrumentation Administration Users Guide 281

Managing Reports: An Overview

Managing Reports: An Overview


The Domain Administrator can manage SmartPlant Instrumentation reports. This
activity involves associating a customized title block with a report, and setting
archiving options for report comparison within the SmartPlant Instrumentation
environment. Using these options, you manage all the available reports in most of
SmartPlant Instrumentation modules. When managing reports, you filter and sort the
report data as needed.
Also, you can define revision management settings. In the database, each report is
assigned to the report type, which can be list or non-list. The report type determines
how SmartPlant Instrumentation users 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 users to manage revisions either per document or per item.
In accordance with the revision management setting, users 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).
Related Topics

Domain Administration Common Tasks, page 147

Managing Reports Common Tasks, page 283

Report Management Dialog Box, page 490

Title Block Descriptions, page 285

282 SmartPlant Instrumentation Administration Users Guide

Managing Reports: An Overview

Managing Reports Common Tasks


The Domain Administrator can perform the following tasks when managing reports:
Associate a New Title Block with a Report
The Domain Administrator can associate a default title block supplied with
SmartPlant Instrumentation, or a custom title block created in InfoMaker and added
to SmartPlant Instrumentation using the options in the Title Blocks dialog box (this
dialog box is only accessible from SmartPlant Instrumentation).
The software filters the title blocks that you can associate with a certain report
according to the report units of measure (PB units or inches). For more information,
see Associate a New Title Block with a Report, page 284.
Set Archiving Options for Report Comparison
This feature allows the Domain Administrator to set archiving options for SmartPlant
Instrumentation reports. A revision archive enables users to view a backup copy of a
report with the information contained in that report at the time of revision. Users can
compare an archived report with a previewed report or with another archived report.
You set an archiving option for each report. This way you determine how users save
report revisions, and from what source the software retrieves the archived report
revisions for report comparison. For more information, see Set Archiving Options for
Report Comparison, page 287.
Define Report Revision Management Settings
For most reports, revision management setting are set automatically and fixed in the
database. However, for certain non-list-type reports, using the options in the Report
Management dialog box, the Domain Administrator can change the revision
management setting. When the domain type is Operating owner domain, you can
only change the revision management settings for reports available in As-Built. For
more information, see Define Report Revision Management Settings, page 289.
Related Topics

Domain Administration Common Tasks, page 147

Managing Reports: An Overview, page 282

Title Block Descriptions, page 285

SmartPlant Instrumentation Administration Users Guide 283

Managing Reports: An Overview

Associate a New Title Block with a Report


1. Start the Administration module and log on as Domain Administrator.
2. With the Domain Administration window open, click Activities > Report
Management.
Tip
In the Report Management dialog box, sort and filter the report data
if needed.
3. Select the Title Block check box for each report want to associate with a title
block.

4. From the Title Block Customization list, select a title block for each relevant
report. For details on the available title blocks, see Title Block Descriptions.
Tips

For specifications, the System Administrator has rights to select a title


block assignment method when setting the domain options. If in the
Report Name column, you selected Specification but the Title Block
Customization column options are disabled, this means that
SmartPlant Instrumentation users can associate different title blocks
with specifications using the options available in the Specifications
module itself (as in SmartPlant Instrumentation versions prior to
Version 7).

If you want to associate a custom title block with all specifications,


make sure that in the Domain Definition window, the selected custom
title block assignment method is Standard (used in all modules).

Related Topics

Domain Definition Window (Domain Administration), page 420

Managing Reports Common Tasks, page 283

Managing Reports: An Overview, page 282

Report Management Dialog Box, page 490

284 SmartPlant Instrumentation Administration Users Guide

Managing Reports: An Overview

Title Block Descriptions


This topic describes the title blocks that are available in the Title Block
Customization column of the Report Management window. The Domain
Administrator can select the appropriate title block and assign it to a SmartPlant
Instrumentation report.
Template Title Blocks
Template title blocks come shipped with SmartPlant Instrumentation. The users need
to associate template title blocks with SmartPlant Instrumentation manually, as any
custom title block. The default location of the template title blocks is <SmartPlant
Instrumentation home folder>\Psr. After users associate the template title blocks with
SmartPlant Instrumentation, they become available for selection in the Title Block
Customization column of the Report Management dialog box.
The following template title blocks are available:
DEFAULT Associated by default with a SmartPlant Instrumentation report.
You can use this title block in any module.
Default TB with IN units This title block is the file Default TB with IN
Units.psr, created using 1/1000 inch units. You can use this title block in any
module.
Default TB with IN units (with signed By field) This title block is the file
Default TB with IN Units (with Signed By field).psr, which contains the Signed By
field for revisions. This title block is created using 1/1000 inch units. You can use
this title block in any module.
Default TB with PB units This title block is the file Default TB with PB
Units.psr, created using PowerBuilder units. This title block is not suitable for
specifications.
Default TB with PB units (with Signed By field) This title block is the file
Default TB with PB Units (with signed By field).psr, which contains the Signed By
field for revisions. This title block is created using PowerBuilder units. This title
block is not suitable for specifications.

SmartPlant Instrumentation Administration Users Guide 285

Managing Reports: An Overview


Specs Default TB with PB units This title block is the file Specs Default TB
with PB Units.psr, created using PowerBuilder units. This title block is only suitable
for specifications, after the System Administrator, when making or modifying the
current domain definitions, selects the Standard title block assignment method. If
you print specs using the A4 sheet size, this title block is fully compatible with all the
library forms and does not require any manual adjustments. Note, however, that if
you want to print specs using the Letter sheet size, you must first modify the Specs
Default TB with PB Units.psr title block in InfoMaker by reducing the title block
height. Removing two revision rows from the title block is enough to make it appear
correctly in a printout of any spec based on a library form.
Custom Title Blocks
These are title blocks that users created using InfoMaker, and then added to
SmartPlant Instrumentation using the options in the Title Blocks dialog box. You
can use custom title blocks in any module. You can assign a custom title block to a
particular report only when the units of measure with which the selected title block
has been created are the same as the units of measure defined for that report. Title
blocks whose units of measure are different from the units of measure defined for the
report do not appear in the Title Block Customization list. When creating a title
block in InfoMaker, you can use either 1/1000 inch units, or PowerBuilder units.
Some reports do not support custom title blocks. For these reports, the value Default
appears in the Title Block Customization, and the option to select a custom title
block from this list is disabled.
Notes

As a basis for custom title blocks, it is recommended to use the supplied


template title blocks.

If in the Plant Hierarchy dialog box, you define too long names of the
plant hierarchy levels (up to 50 characters are allowed), in the default title
blocks, truncation may occur in the fields that display the names of the
plant hierarchy levels and the specific level items. If you must use long
name strings, to prevent truncation, we recommend that users create
custom title blocks and provide enough room in the PLANT_NAME,
AREA_NAME, and UNIT_NAME fields.

Related Topics

Managing Reports Common Tasks, page 283

Managing Reports: An Overview, page 282

Report Management Dialog Box, page 490

286 SmartPlant Instrumentation Administration Users Guide

Managing Reports: An Overview

Set Archiving Options for Report Comparison


The following archiving options are available:

Do not save (not available for the Document Binder module reports)
Sets the software not to keep a revision archive. After saving the report
revision, SmartPlant Instrumentation users cannot see the information
contained in that report at the time of revision, and the report comparison
is not available.

Save to database Sets the software to keep a revision archive in the


database. This way you eliminate the need for file sharing and
management. Note, however, that this option can slow down your work.

Save as File Sets the software to keep a revision archive as an external


.psr file (or as an .sma file when using the Enhanced Report Utility and
adding revisions to an open report, not with global revisions). Selecting
this option can speed up your work.

Compress as ZIP file Sets the software to keep a revision archive as


an external .psr file in a compressed .zip format. This feature is
useful, for example, before backing up a database when you have made a
large number of report revisions. Selecting this option reduces the size of
the backup database.
Note

When changing an archiving option for a Document Binder module report,


the software assigns the same archiving option to all the other Document
Binder reports as well. This is because in the Document Binder module,
you can only create revisions for the entire binder package). You can,
however, apply a different custom title block to any Document Binder
module report.
1. Start the Administration module and log on as Domain Administrator.

2. With the Domain Administration window open, click Activities > Report
Management.
3. In the Report Management dialog box, under Sort by, select one of the
following options to sort the reports in the Report Name column:

Report sort the reports in the data window by the report names.

Module sort the reports in the data window by modules.


4. To filter the reports by specific module, under Filter by, select a module.

SmartPlant Instrumentation Administration Users Guide 287

Managing Reports: An Overview


5. Select Apply to view the reports belonging to the specified module.
Tip
To return from the filtered view to the normal view, clear the Apply
check box.
6. For a specific report displayed in the Report Name column, select a desired
archiving option from the list in the Archiving Options column.

Tip
To use the Save as File, or Compress as Zip file options, you need to
set an archive path (see step 7 below). If you have selected Save to
database, or Do not save, skip step 6 in this procedure.
7. To define the default archive path for all the report revisions to be saved as files
or compressed as .zip files, click
next to the Path field in the Default archive
path group box, and enter the required path.

Tip

If needed, you can define a different path for a particular report by


entering the required path in the Archive Path field of the data
window.

Related Topics

Managing Reports Common Tasks, page 283

Managing Reports: An Overview, page 282

Title Block Descriptions, page 285

288 SmartPlant Instrumentation Administration Users Guide

Managing Reports: An Overview

Define Report Revision Management Settings


1. With the Domain Administration window open, click Activities > Report
Management.
2. If the domain type is Operating owner, from the Project list, select As-Built.
3. In the Revision Management column, beside a non-list-type report, select one of
the following settings:
Setting

Description

Example

Per Item

Allows users to share the document


number and revision in documents
created for a specific item and in all
reports generated for that item. This
means that the document number and the
revision number that users apply to an
item in the item properties dialog box are
the same as in a print preview of any
report generated for this item.

In the Wiring module, after creating a


revision for a specific strip from the item
properties dialog box, the document
number and revision number are assigned
to the revision opened from a print
preview of any report generated for this
strip (panel-strip report with or without
adjacent connections, I/O assignment
report, and so forth).

Per
Document

Allows users to apply a unique document


number and revision to a specific report
generated for a specific item, and also
allows to make global revisions.

After creating two reports for a particular


strip: a report with adjacent connections
and a report without adjacent connections,
the document and revision numbers of the
two reports cannot be shared. Likewise,
after creating two panel-strip reports for
two different strips, each report has a
unique document number and revision. As
a result, the document number and
revision added from the report print
preview is different from the document
number and revision added in the
Revisions dialog box opened from the
item properties dialog box.

Notes

A revision management setting of all list-type reports is always per


document. A revision management setting of certain non-list-type reports
is set permanently as per item, while for other non-list-type reports you
can define the revision management setting as either per item or per
document.

In an Operating owner domain, after you change the revision management


setting from per item to per document, the report becomes available for
claiming. The project Administrator can claim the document using the
Project Activities dialog box options.

Related Topics

Managing Reports Common Tasks, page 283

Managing Reports: An Overview, page 282

SmartPlant Instrumentation Administration Users Guide 289

Working with Add-Ins: An Overview

Working with Add-Ins: An Overview


After the System Administrator initiates a domain, a number of item resources (for
example, hook-up items, links, and so forth) become available in the software. These
items allow you to get started with building your domain without having to create all
the required items from scratch. However, these resources are rather limited and do
not provide for all your needs. You can enhance your item resources by appending
add-ins to your domain. Add-ins are available on purchasing the appropriate
SmartPlant Instrumentation license. Contact your local SmartPlant Instrumentation
dealer or Intergraph for further information.
Related Topics

Domain Administration Common Tasks, page 147

Working with Add-Ins Common Tasks, page 291

290 SmartPlant Instrumentation Administration Users Guide

Working with Add-Ins: An Overview

Working with Add-Ins Common Tasks


The Domain Administrator can perform the following tasks when working with addins:
Import Hook-Up Libraries
You can import a hook-up item library from an external database file to your
database. After you import the hook-up item library, you can assign the new
imported items to your existing hook-ups from the Hook-Up Item List. You can
also use prepared hook-up drawings which are stored in the HOOK-UP sub-folder of
your SmartPlant Instrumentation home folder.
You import the required hook-up library first by connecting to a catalog database file
and then by importing the required hook-up libraries to the appropriate plant in your
database. You can only import the link groups that you purchased the appropriate
license for. For more information, see Import Hook-Up Libraries, page 293.
Import System Interfaces
You can import link groups from an external database file to the SmartPlant
Instrumentation database. After you import these linked groups you can use them in
the Import utility to import data from external databases.
You import the required external links first by connecting to a database file and then
by importing the required link groups to your database. For more information, see
Import System Interfaces, page 294.
Import Browser Views
This option enables you to import predefined view profiles into your database. After
being imported into SmartPlant Instrumentation, these views will be available to you
in the Browser module Browser Manager.
You import the required views first by connecting to a database file and then by
importing the required views to your database. For more information, see Import
Browser Views, page 295.

SmartPlant Instrumentation Administration Users Guide 291

Working with Add-Ins: An Overview


Import DCS Hardware I/O Library Data
This option enables you import DCS hardware I/O data from one of the following
libraries:

Yokogawa - CENTUM CS 1000

Yokogawa - CENTUM CS 3000

Honeywell - TDC 3000 - PM - FTAs

Foxboro - I/A - FBMs

For more information, see Import DCS Hardware I/O Library Data, page 296.
Import DDP Library Data for PDS
This option enables you import process connection data for the Dimensional Data for
Piping (DDP) module. For more information, see Import DDP Library Data for
PDS, page 297.
Export Macros
This option enables you to export macros from a current SmartPlant Instrumentation
database or domain to a text file. Then, from another database or domain, you import
data contained in this file. Note that you can also include all the existing typical tags
in the target text file. For more information, see Export Macros, page 298.
Import Macros
This option enables you to import macros into SmartPlant Instrumentation from a
predefined intermediate text file that already contains macros exported from another
database or domain to the current database or domain. When importing macros, this
text file serves as the source file. Note that you can also import all the typical tags
that have been included in the text file. For more information, see Import Macros,
page 299.
Related Topics

Domain Administration Common Tasks, page 147

Working with Add-Ins: An Overview, page 290

292 SmartPlant Instrumentation Administration Users Guide

Working with Add-Ins: An Overview

Import Hook-Up Libraries


1. Start the Administration module and log on as Domain Administrator.
2. With the Domain Administration window open, click Add-Ins > Import HookUp Library.
3. In the Import Hook-Up Library dialog box, under Source database, locate the
database file in one of the following ways:

In the File name and path box, type the path and filename of the
required database file (the default file is IN_CTLOG.DB).

Click Browse to navigate to the required database file.


4. Click Connect to retrieve the libraries available in the database file.

Important
If you get a message stating that the connection has failed, make sure
you typed in the correct path and filename of the database file (see step
3 of this procedure).
5. Do one of the following:

Click Standard to select the library which contains standard


Intergraph compatible hook-ups.

Click SHELL to select the library which contains Shell International


compatible hook-ups.
6. In the Hook-up drawing path box, do one of the following:

Type the drawing path for the items in the imported library (the default
location is <SmartPlant Instrumentation home folder>HOOK-UP).
This is useful if you don't want to type the path every you retrieve a
drawing from this library.

Leave the data field empty. This way you will have to type the path
when retrieving each drawing. For this option, you will still be able to
assign a path to the drawings in the Hook-Ups module in batch mode.
7. In the Plant Name data window, select the name of the plant in which the
appended hook-up items will be used.

8. Click Import to append the selected hook-up item library to the database.
Note

The software does not allow you to import a hook-up item library which
already exists in the database. If you attempt to import such a hook-up
item library, the software displays an appropriate message.

Related Topics

Working with Add-Ins Common Tasks, page 291

SmartPlant Instrumentation Administration Users Guide 293

Working with Add-Ins: An Overview

Import System Interfaces


System interfaces are available for the following link groups:

PDS/SmartPlant P&ID

FirstVue

Performance Spec #1

Performance Spec #71

Masoneilan Spec #1

Masoneilan Spec #75

See SmartPlant Instrumentation Online Guide, Import Utility, Using a Predefined


Link to Import Data, Working with Grouped Links to learn how to use grouped links.
1. Start the Administration module and log on as Domain Administrator.
2. With the Domain Administration window open, click Add-Ins > Import
System Interfaces.
3. Under Source database, locate the database file in one of the following ways:

In the File name and path box, type the path and filename of the
database file IN_CTLOG.DB.

Click Browse to navigate to IN_CTLOG.DB.


4. Click Connect to connect to the source database file.

Important
If you get a message stating that the connection has failed, make sure
you typed in the correct path and filename of the database file (see step
3 of this procedure).
5. Under the Select link group section, select one or more of the link groups to
import.

6. Locate the source path of all the links in the imported group in one of the
following ways:

In the Source file path data field, type the source path.

Click Browse to navigate to the required source path. Note that


setting he source path in the current dialog box is the same as setting it
in the Import utility Source - Target Link dialog box. See
SmartPlant Instrumentation Online Guide, Import Utility, Using a
Predefined Link to Import Data, Changing an Existing Link's Source
Path to learn how to set the source path of the imported links.
7. Clear the Import only source codes check box if it was selected.

294 SmartPlant Instrumentation Administration Users Guide

Working with Add-Ins: An Overview


8. Click Import to add the selected link group to the database.
Note

You can import only those link groups for which you purchased an
appropriate license.

Related Topics

Working with Add-Ins Common Tasks, page 291

Working with Add-Ins: An Overview, page 290

Import Browser Views


1. Start the Administration module and log on as Domain Administrator.
2. With the Domain Administration window open, click Add-Ins > Import
Browser Views.
3. Under Source database, locate the database file in one of the following ways:

In the File name and path box, type the path and filename of the
required database file (the default file is IN_CTLOG.DB).

Click Browse to navigate to the required database file.


4. Click Connect to retrieve the libraries available in the database file.

Important
If you get a message stating that the connection has failed, make sure
you typed in the correct path and filename of the database file (see step
3 of this procedure).
5. From the Target plant list, select the plant to which you want to add the imported
views.

6. Under the Select Views section, select views that you want to import.
7. Click Import to append the selected views to the database.
Note

You can import only those views for which you purchased an appropriate
license.

Related Topics

Working with Add-Ins Common Tasks, page 291

Working with Add-Ins: An Overview, page 290

SmartPlant Instrumentation Administration Users Guide 295

Working with Add-Ins: An Overview

Import DCS Hardware I/O Library Data


1. With the Domain Administration window open, click Add-Ins > Import DCS
Hardware I/O Library.
2. Under Source database, locate the database file in one of the following ways:

In the File name and path box, type the path and filename of the
required database file (the default file is IN_CTLOG.DB).

Click Browse to navigate to the required database file.


3. Click Connect to retrieve the libraries available in the database file.

Important
If you get a message stating that the connection has failed, make sure
you typed in the correct path and filename of the database file (see step
3 of this procedure).
4. Under Select panel library, highlight the required library to be imported.

5. Click Import to import the process connection data to your database.


Note

The software does not allow you to import the same connection data more
than once. If you attempt such an import, the software displays an
appropriate message stating that the data import has failed because at least
some of the connection data already exists.

Related Topics

Working with Add-Ins Common Tasks, page 291

Working with Add-Ins: An Overview, page 290

296 SmartPlant Instrumentation Administration Users Guide

Working with Add-Ins: An Overview

Import DDP Library Data for PDS


1. Start the Administration module and log on as Domain Administrator.
2. With the Domain Administration window open, click Add-Ins > Import DDP
Library Data for PDS.
3. Under Source database, locate the database file in one of the following ways:

In the box, type the path and filename of the required database file (the
default file is IN_CTLOG.DB).

Click Browse to navigate to the required database file.


4. Click Connect to retrieve the libraries available in the database file.

Important
If you get a message stating that the connection has failed, make sure
you typed in the correct path and filename of the database file (see step
3 of this procedure).
5. Click Import to import the process connection data to your database.

Note

The software does not allow you to import the same DDP Library data
more than once. If you attempt such an import, the software displays an
appropriate message stating that the data import has failed because at least
some of the data already exists.

Related Topics

Working with Add-Ins Common Tasks, page 291

Working with Add-Ins: An Overview, page 290

SmartPlant Instrumentation Administration Users Guide 297

Working with Add-Ins: An Overview

Export Macros
Important
Exporting macros requires the existence of an sppid_macro component
table in the source database or domain, Domain Administrator access
rights, and a database target .txt file.
1. Start the Administration module and log on as Domain Administrator.

2. With the Domain Administration window open, click Add-Ins >


Import/Export Macros > Export Macros.
3. In the Export Macros dialog box, click Browse.
4. In the Select file for Export dialog box, select a target .txt file from the list or
create a new file.
5. Click Save to return to the Export Macros dialog box.
Tip
If there are typical tags in the current source database or domain, you
can select Include typical tags to export all typical tags to the target
.txt file.
6. Click OK in the Export Macros dialog box.

7. Click OK in the notification box that appears if macros have been exported
successfully.
8. Click Close in the Export Macros dialog box.
Related Topics

Access Rights: An Overview, page 258

Working with Add-Ins Common Tasks, page 291

Working with Add-Ins: An Overview, page 290

298 SmartPlant Instrumentation Administration Users Guide

Working with Add-Ins: An Overview

Import Macros
Important
Importing macros requires the existence of an sppid_macro component
table in the target database or domain, Domain Administrator access
rights, and a predefined source .txt file.
1. Start the Administration module and log on as Domain Administrator.

2. With the Domain Administration window open, click Add-Ins >


Import/Export Macros > Import Macros.
3. In the Import Macros dialog box, click Browse.
4. In the Select file for Export dialog box, select a .txt file from the list.
5. Click Save to return to the Export Macros dialog box.
Tips

Select the Include typical tags check box to import all typical tags to
the current database or domain from the source .txt file, if required.

Before selecting Include typical tags, ensure that the source .txt file
contains the required typical tags; otherwise, the macro import process
will fail.
6. Click OK in the Import Macros dialog box.

7. Click OK in the notification box that appears if macros have been imported
successfully.
8. Click Close in the Import Macros dialog box.
Related Topics
Access Rights: An Overview, page 258

Working with Add-Ins Common Tasks, page 291

Working with Add-Ins: An Overview, page 290

SmartPlant Instrumentation Administration Users Guide 299

Working with Add-Ins: An Overview

Miscellaneous Domain Administration Tasks


The Domain Administrator can perform the following miscellaneous tasks:
Define Panel Location Levels
You can define multiple levels for your panel locations. For example, you can define
three levels with Building as the highest level (Level 1), Floor as the second level,
and Room as the lowest level (Level 3). Then, in the Domain Explorer, users can
create specific locations on any of the levels and assign panels to the locations. Panel
location is defined per domain; therefore, all the panel location definitions that you
make become available throughout the entire current domain. For more information,
see Define Panel Location Levels, page 302.
Assign Icons to Telecom Device Types
Use this procedure to assign icons to telecom device types available in the current
domain. This way the software can indicate the telecom device type of specific
device panels displayed in the Domain Explorer (or Wiring Explorer, accessible
from the Wiring module). For more information, see Assign Icons to Telecom Device
Types, page 303.
Define Custom Fields
Custom fields are database fields for which the Domain Administrator defines default
labels on the plant level in the Custom Fields dialog box. Custom fields enable users
to define characteristics for SmartPlant Instrumentation items according to their own
needs.
For calibration custom fields, the user enters values in the Calibration module. If the
Domain Administrator enables process data custom fields, the user can then enter
values for these fields in process data sheets. For all other custom fields, the user
enters values in the relevant browser views, and can also edit the default labels. For
more information, see Define Custom Fields, page 304.
Copy Custom Fields
You can copy custom field definitions from one highest plant hierarchy item to
another within the same domain. When copying definitions, you can overwrite or
keep the definitions that exist in the target plant hierarchy item. For more
information, see Copy Custom Fields, page 306.

300 SmartPlant Instrumentation Administration Users Guide

Working with Add-Ins: An Overview


Define Custom Tables
A custom table is an additional supporting table that holds user-defined information
for an instrument tag. The Domain Administrator uses this procedure to define
custom tables for tag numbers at the highest level of the plant hierarchy. For each
plant hierarchy item, you can define up to sixteen custom tables. Custom tables
enable SmartPlant Instrumentation users to set additional attributes for tag numbers in
the Instrument Index module. You can add the Name field of a custom table to a
specification page. For more information, see Define Custom Tables, page 309.
Generate Domain Administration Reports
This topic deals with the various reports that a Domain Administrator can generate.
For more information, see Generate Domain Administration Reports, page 309.
Select a Logo
You can select a .bmp format graphic file which will appear as a logo in most printed
documents such as some reports and specifications.
You can build a number of domains in your database, each having a different logo. In
this case, when you switch to a domain, the software retrieves the logo assigned to
that domain from the database. If all your domains use the same logo, you can make
the logo retrieval operation faster by selecting the PROJLOGO.BMP file located in
the <SmartPlant Instrumentation home folder>\Temp folder as the default source logo
file for all domains in the database. This file is automatically generated by the
software during the Setup process. For more information, see Select a Logo, page
311.
Define Field Personnel Profiles
This procedure enables you to maintain a list of employees who are in-charge of
carrying out the actual instrument field-maintenance. For more information, see
Define Field Personnel Profiles, page 312.
Modify Domain Notes
This topic explains how to modify your domain notes. Note that this option is
available to both System and Domain Administrators. For more information, see
Modify Domain Notes, page 312.
Related Topics

Domain Administration Common Tasks, page 147

Domain Administration: An Overview, page 146

SmartPlant Instrumentation Administration Users Guide 301

Working with Add-Ins: An Overview

Define Panel Location Levels


1. Start the Administration module and log on as Domain Administrator.
2. In the Domain Administration window, on the Activities menu, click Panel
Location Levels.
3. For the first location level, enter a location level name and an optional separator
to indicate the highest level of the hierarchy.
For example, create the level Building and enter a back slash separator ( \ ).
Tips

The level separators and user-defined level names appear in the Panel
Properties dialog box of the Wiring module.

The level separator can contain a single alphanumeric or special


character.

For a panel location name, you can use any number of alphanumeric or
special characters. The name can include spaces.
4. Click Add and then enter another location level name and a separator.
For example, create the level Room and enter an ampersand separator ( & ).

Important
The location level names must be unique.
5. Do one of the following:

Click Add to append another row below the Room level.

Select the row with the Room level and click Insert to add another
row above the Room level.
Tips

You can insert or delete levels only before users create panel locations
on the level that you select.

At any stage of your domain life cycle, you can click Add to define a
new lowest level in your panel location hierarchy.

If you defined three levels, for example, Building as the highest level,
with separator \, Floor as the second level, with separator , and
Room as the lowest level (Level 3), with separator &, in the Wiring
module, in the Panel Properties dialog box, the location string
appears as follows:
<user-defined location name on the Building level>\<user-defined
location name on the Floor level> <user-defined location name on
the Room level>&.

302 SmartPlant Instrumentation Administration Users Guide

Working with Add-Ins: An Overview

The level names that you define only appear in the Domain Explorer,
and do not affect specific location names that users define. Therefore,
you can change the level names any time you require.

Related Topics
Miscellaneous Domain Administration Tasks, page 300

Panel Location Levels Dialog Box, page 461

Assign Icons to Telecom Device Types


1. Start the Administration module and log on as Domain Administrator.
2. With the Domain Administration window open, click Activities > Telecom
Device Panel Icons.
3. For each telecom device type to which you want to assign an icon, beside Icon
File Name and Path, click Browse to select an icon.
Notes

You can only select icon files with the extension .ico.

Icons that you assign will appear in SmartPlant Instrumentation


instead of the default icons:
for conventional device panels, and
for plug-and-socket device panels.

In SmartPlant Instrumentation, a new icon can only appear after a user


creates a telecom tag belonging to the device type to which you have
assigned the icon.

Related Topics

Miscellaneous Domain Administration Tasks, page 300

SmartPlant Instrumentation Administration Users Guide 303

Working with Add-Ins: An Overview

Define Custom Fields


1. Start the Administration module and log on as Domain Administrator.
2. With the Domain Administration window open, do one of the following:

Click Activities > Custom Fields.

Click .
3. From the <Plant> list, select a <plant> in which you want to make custom field
definitions.

4. From the Item type list, select a target item or data type.
Tips

If you intend to use custom fields in browser views, note that custom
field definitions appear as column headers. For details about the use
of special characters in browser view column headers and for a list of
browsers which can contain custom fields that you define per item or
data type, see Browsers That Can Contain Custom Fields.

You can select a plant hierarchy level name as an item and modify the
default custom field definitions for each of the twenty custom fields.
A custom field definition is a label that appears in the Custom Fields
tab of the Plant Hierarchy Item Properties dialog box. The default
label is Custom field<number incremented from 1 to 20>. For
example, if your highest plant hierarchy level is Plant, for Row
Number 1, enter text My Custom Fields for PlantA. In the Custom
Fields tab of the <Plant> Properties dialog box, for the first custom
field, the software displays My Custom Fields for PlantA instead of
the default definition Custom field 1.
5. In the data window, under Definitions, type or edit custom field labels.

Tips

For each field, the Length field displays the maximum number of
characters that users can specify in the field in SmartPlant
Instrumentation. If needed, you can type a smaller value, and thus,
decrease the maximum allowed number of characters.

If from the Item type list, you selected Process Data, you can disable
the use of certain custom fields by clearing check box in the Visible
column.
6. Click Apply.

304 SmartPlant Instrumentation Administration Users Guide

Working with Add-Ins: An Overview


7. Repeat the procedure to make custom field definitions for another <plant> or for
another item or data type.
Note
For process data custom fields, the values in the Number column do not
correspond to the custom fields sequentially. For details, see Sequence
Numbers and Process Data Custom Fields

Related Topics

Miscellaneous Domain Administration Tasks, page 300

Sequence Numbers and Process Data Custom Fields


For process data custom fields, the values in the Number column of the Custom
Fields dialog box correspond to the process data sections in the Section Name
column, and do not correspond to the custom fields sequentially. The following table
displays correspondence of the numbers to process data custom fields.
Number

Custom Field

PD_UDF_C05

PD_UDF_C06

PD_UDF_C09

PD_UDF_C10

PD_UDF_C11

PD_UDF_C12

PD_UDF_C07

PD_UDF_C08

PD_UDF_C01

10

PD_UDF_C02

11

PD_UDF_C03

12

PD_UDF_C04

13

PD_UDF_C13

14

PD_UDF_C14

15

PD_UDF_C15

16

PD_UDF_C16

17

PD_UDF_C17

SmartPlant Instrumentation Administration Users Guide 305

Working with Add-Ins: An Overview

Copy Custom Fields


1. With the Domain Administration window open, do one of the following

Click Activities > Custom Fields.

Click .
2. From the <Plant> list, select a target <plant>.

3. Click Copy From.


4. In the dialog box that opens, select a source <plant> and then click OK.
5. In the Custom Fields dialog box, click Apply.
Related Topics

Miscellaneous Domain Administration Tasks, page 300

Browsers That Can Contain Custom Fields


You can add custom fields per item/data type for a number of the browsers that are
available in the Browser module in SmartPlant Instrumentation. The following table
lists item and data types that you can select in the Custom Fields dialog box, and also
lists the browsers whose views can contain custom fields that you define per item
type. When defining a browser view style, users can change the definitions that you
make.
Note

It is not possible to display an apostrophe in a custom field header. If your


definition includes an apostrophe character, this character changes in the
header to a double quote character ". If your definition includes a double
quite character, it changes in the header to a tilde character ~. Other
special characters appear in custom field header as defined.

Item/Data Type

Browser

Cable

Cable Browser
Cable Schedule Instal. Index
Cable Schedule Instal. Index Changes
Cable Set Browser
Wire Browser
Wiring Schedule Instal. Index
Wiring Schedule Instal. Index Changes

Cable Set

Cable Set Browser


Wire Browser
Wiring Schedule Instal. Index
Wiring Schedule Instal. Index Changes

Calibration Result

Calibration Results Browser

306 SmartPlant Instrumentation Administration Users Guide

Working with Add-Ins: An Overview


Item/Data Type

Browser

Calibration Setting

Calibration Settings Browser

Control System Tag

Control System Tag Browser


NIM Analog Input Browser
NIM Analog Output Browser
NIM Digital Input Browser
NIM Digital Output Browser
NIM General Browser

Document

Drawing Browser
General Process Data Browser
Loop Browser
Loop Drawing Browser
Revision Browser
Specifications Browser
Tag Number Browser

Equipment

Equipment Browser

Hook-Up

Hook-Up Browser

Hook-Up Item

Item List Browser

Instrument

Analyzer Browser
Calibration Results Browser
Calibration Settings Browser
Control Valve Browser
DDP and Index Browser
Drawing Summary Browser
Fieldbus Tag Number List Browser
Flow Instrument Browser
General Process Data Browser
Instr. Conn. Pre-assignment (Advanced)
Instrument Connection Pre-assignment
Instrument Index Standard Browser
Instrument Instal. Index
Instrument Instal. Index Changes
Instrumentation/Process Data Browser
Level Instrument Browser
Maintenance Schedule Browser
Pressure Instrument Browser
Relief Valve Browser
Spec Binder Package Browser
Specifications Browser
Tag Category Browser
Tag Number Browser
Temperature Instrument Browser

SmartPlant Instrumentation Administration Users Guide 307

Working with Add-Ins: An Overview


Item/Data Type

Browser

Line

Line Browser
Line Component Browser
Line PD Data Browser

Loop

Block Browser
Enhanced SmartLoop Browser
Loop Browser
Loop Drawing Browser

Panel

General Panel Browser


I/O Card Browser
I/O Terminal Browser
Local Signal Browser
Panel Termination Instal. Index
Panel Termination Instal. Index
Rack Browser
Slot Browser
Strip Browser
Terminal Browser

Process Data

General Process Data Browser

Revision

Revision Browser

Strip

I/O Card Browser


I/O Terminal Browser
Local Signal Browser
Strip Browser
Terminal Browser
Terminal Schedule Instal. Index
Terminal Schedule Instal. Index Changes

Terminal

I/O Terminal Browser


Terminal Browser
Terminal Schedule Instal. Index
Terminal Schedule Instal. Index Changes

Wire

Wire Browser
Wire Schedule Instal. Index
Wire Schedule Instal. Index Changes

Related Topics

Custom Fields Dialog Box, page 411

Define Custom Fields, page 304

308 SmartPlant Instrumentation Administration Users Guide

Working with Add-Ins: An Overview

Define Custom Tables


1. Start the Administration module and log on as Domain Administrator.
2. With the Domain Administration window open, click Activities > Custom
Tables.
3. From the Plant list, select a plant.
4. Select the desired number of Custom table check boxes and then, in the adjacent
fields, type table names.
Important

A custom table name must be unique.

Do not use the single quote (`) character in custom table names
because doing so causes the label to be displayed incorrectly in the
Tag Number Properties dialog box.
5. Click Apply and, if needed, repeat the procedure for another plant.

Related Topics

Miscellaneous Domain Administration Tasks, page 300

Generate Domain Administration Reports


As Domain Administrator you can generate domain and activity reports. The
following table describes the main activity reports which are available to the Domain
Administrator on the Reports menu.
Report

Description

User List

A list of SmartPlant Instrumentation users for the domains for which you
have access rights (those which have been assigned to you as Domain
Administrator). When you select this option, the list is printed in
ascending alphanumeric sequence.

User List SmartPlant Instrumentation users of the domains for which you have
per Group access rights, listed according to the groups to which they belong.

SmartPlant Instrumentation Administration Users Guide 309

Working with Add-Ins: An Overview


Report

Description

Domain
Statistics

Quantities of the following items in the current domain:


Instruments instrument tags in calculation sheets, process
data sheets, and specs.
Records in supporting tables I/O Type, Location, Model,
Status.
Wiring data cables, panels, terminals, wires, connections, and
I/O channels.
Panels by categories marshaling racks, PLCs, DCSs, junction
boxes, device panels, and cabinets.
Other items loop drawings, CAD drawing blocks, P&ID
drawing references, hook-ups, lines, and spec forms.
Maintenance statistical data calibration settings, and
calibration results.
A list of signals per largest group sequence number.

Access
Rights

Access rights information for selected user groups. This information


includes a list of selected user groups, the items for which those user
groups were granted access rights, and the access type to every item.
You can generate this report on the domain, plant, and unit levels.

Related Topics

Miscellaneous Domain Administration Tasks, page 300

310 SmartPlant Instrumentation Administration Users Guide

Working with Add-Ins: An Overview

Select a Logo
1. Start the Administration module and log on as Domain Administrator.
2. With the Domain Administration window open, do one of the following:

Click File > Domain.

Click .
3. Do one of the following:

Click Options > Select Logo.

Click .
4. Click Browse to open the Select Logo File dialog box.

Tip
You can only select the BMP (Bitmap) file format. You can create a
Bitmap file using a graphic editing application such as Windows
Paintbrush. Since most reports are printed out in black-and-white, it is
recommended that you select Bitmap files in black-and-white to save
system resources.
5. Navigate to the required BMP file to which you want to assign as the domain logo
and click OK.

6. In the Browse Logo Files dialog box, click Assign to assign the selected bitmap
to the current domain.
7. Click

to save the new domain logo to the database.

8. Click

to close the Domain Definition window.

Related Topics

Miscellaneous Domain Administration Tasks, page 300

SmartPlant Instrumentation Administration Users Guide 311

Working with Add-Ins: An Overview

Define Field Personnel Profiles


1. Start the Administration module and log on as Domain Administrator.
2. With the Domain Administration window open, click Activities > Field
Personnel Profile.
3. Click New to add a new personnel profile to the current domain.
4. Type the required profile data and then click Apply.
5. Click Edit to modify a personnel profile.
6. Edit the selected personnel data and click Apply.
7. Click Delete if you want to delete a selected profile.
8. When prompted to confirm the personnel profile deletion, click Yes to delete the
currently selected personnel profile or click No to retain the currently selected
personnel profile.
Related Topics

Miscellaneous Domain Administration Tasks, page 300

Modify Domain Notes


1. Start the Administration module and log on as Domain Administrator.
2. With the Domain Administration window open, do one of the following:

Click File > Domain.

Click .
3. Do one of the following:

Click Options > Notes.

Click .
4. In the Notes field, edit the text as required.

5. Click

6. Click

Related Topics

Miscellaneous Domain Administration Tasks, page 300

312 SmartPlant Instrumentation Administration Users Guide

Working with Add-Ins: An Overview

Modify Printer Settings


It is possible to modify the current printer settings. 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.
When saving your settings as default, the software stores the values in the [printer]
section of the Intools.ini file. If you want the software to calculate the required paper
size from the Windows printer driver settings, open the Intools.ini file and then, in 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.
Notes

All your page settings apply to all reports and documents that you print
and they are true on all the 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.

Some reports have their orientation hard-coded, therefore only the hardcoded settings apply.

Related Topics

Log on as Domain Administrator, page 86

Plant Design and Structure Common Tasks, page 151

Plant Design: An Overview, page 149

SmartPlant Instrumentation Administration Users Guide 313

Managing Audit Trail Data: An Overview

Managing Audit Trail Data: An Overview


In SmartPlant Instrumentation, audit trail is a mechanism that enables the Domain
Administrator to mark history changes and save information about user operations
such as deleting, inserting, and updating SmartPlant Instrumentation data in the
domain. As soon as a user performs one of these operations, information appears in
the appropriate tables. The software records all these operations in the audit trail
repository.
You can trim this information in a particular domain by defining the time of
operation. The time of operation appears in the audit trail repository.
Also note that the System Administrator has the privileges to activate and deactivate
the audit trail functionality.
Related Topics

Activate the Audit Trail Functionality, page 113

Domain Administration Common Tasks, page 147

Managing Audit Trail Data Common Tasks, page 315

314 SmartPlant Instrumentation Administration Users Guide

Managing Audit Trail Data: An Overview

Managing Audit Trail Data Common Tasks


The Domain Administrator can perform the following tasks when managing audit
trail data:
Trim Audit Trail Data
This option allows the Domain Administrator to trim the excessive audit trail data
contained in the audit trail repository in the current domain. When removing the
audit trail data from the domain, you can save it to an external file on your Windows
server if needed. If you save the audit trail data, you can then load it to the audit trail
repository in a required domain. For more information, see Trim Audit Trail Data,
page 317.
Load Audit Trail Data
This option allows the Domain Administrator to load the audit trail data to the audit
trail repository in a selected target domain. This data has been removed from the
audit trail repository in a particular domain and saved to an external file. Your target
domain can be the same domain where you have trimmed this data. You can also
load audit trail data trimmed in a different domain. For more information, see Load
Audit Trail Data, page 316.
External Files with Trimmed Audit Trail Data
This topic explains how the Domain Administrator can define a file to which the
system saves the trimmed audit trail data. For more information, see External Files
with Trimmed Audit Trail Data, page 318.
Define Paths When Using Oracle
This topic explains how to define a path when using Oracle. For more information,
see Define Paths When Using Oracle, page 318.
Define Paths When Using MS SQL Server
This topic explains how to define a path when using MS SQL Server. For more
information, see Define Paths When Using SQL Server, page 319.
Define Paths When Using Sybase Adaptive Server Anywhere
This topic explains how to define a path when using Sybase Adaptive Server
Anywhere. For more information, see Define Paths When Using Sybase Adaptive
Server Anywhere, page 320.
Related Topics

Activate the Audit Trail Functionality, page 113

Domain Administration Common Tasks, page 147

Managing Audit Trail Data: An Overview, page 314

SmartPlant Instrumentation Administration Users Guide 315

Managing Audit Trail Data: An Overview

Load Audit Trail Data


Important
To successfully load audit trail data trimmed in a different domain, you
must ensure that the values in the primary key fields in the external source
file differ from those in the audit trail repository of the current domain.
1. Start the Administration module and log on as Domain Administrator.

2. With the Domain Administration window open, click DBA > Data
Maintenance > Load Audit Trail.
3. In the From box, type the initial date of the period (month, day, and year).
4. In the To box, type the last date of the period (month, day, and year).
5. In the Load from file box, type the file name segment as it appears in the external
file containing the audit trail data.
Tips

You can type all of the required variables using information contained
in the complete name of the file. The following is an example of a
complete file name: 20010501_20010503_<DOMAIN
NAME>#CHANGES_LOG#<FILE NAME SEGMENT>.TXT (or .sql
on Oracle).

Note that in the complete file name, the audit trail period is displayed
in the following order: year, month, and day.
6. Click Load.

Tip
After loading the audit trail data, the external file remains on your
server. If needed, you can load the same data onto another domain, or
delete the external file manually.
7. Click Close.

Related Topics

Activate the Audit Trail Functionality, page 113

Managing Audit Trail Data Common Tasks, page 315

Managing Audit Trail Data: An Overview, page 314

316 SmartPlant Instrumentation Administration Users Guide

Managing Audit Trail Data: An Overview

Trim Audit Trail Data


Important
Note that the Document Binder and Construction modules use the audit
trail repository to record information about previous revisions. If you
generate a Change report, the information recorded in audit trail repository
within the period for which the audit trail data is trimmed, will be missing
in this report.
1. Start the Administration module and log on as Domain Administrator.

2. With the Domain Administration window open, click DBA > Data
Maintenance > Trim Audit Trail Data.
3. If your domain type is Operating owner, from the Project list, a project in which
you want to trim audit trail data, or select As-Built.
4. To define the period of the audit trail data that you want to remove from the audit
trail repository in the current domain, in the From box, type the initial date of the
period (month, day, and year).
5. In the To box, type the last date of the period (month, day, and year).
6. To trim the audit trail data contained within the defined period and save it to an
external file, select Save to file.
7. In the File name box, type a file name segment that will become part of the name
of the external file to which you are saving the defined audit trail data.
8. Click Trim to save the audit trail data to the defined file and remove this data
from audit trail repository in the selected domain.
Tip
The external file name contains information about the initial date of
the defined period (year, month, and day), the last date (year, month,
and day), the domain name, and the file name segment you have typed
in the File name box.
9. To trim the audit trail data without saving it to an external file, clear the Save to
file check box.

10. Click Trim to permanently remove the audit trail data from the audit trail
repository in the current domain.
Related Topics

Activate the Audit Trail Functionality, page 113

Managing Audit Trail Data Common Tasks, page 315

Managing Audit Trail Data: An Overview, page 314

SmartPlant Instrumentation Administration Users Guide 317

Managing Audit Trail Data: An Overview

External Files with Trimmed Audit Trail Data


When trimming audit trail data, the Domain Administrator can define a file to which
the system saves the trimmed audit trail data. The file name contains information
about the initial date of the defined period, the last date, the source domain name, and
the file name segment you have typed in the File name field of the Trim Audit Trail
Data dialog box.
The following is an example of a complete file name:
20010501_20010503_<domain schema>#CHANGES_LOG#<file name
segment>.TXT (or .sql on Oracle).
The audit trail period segment displays the period in the following order: year, month,
and day.
The format, location and path configuration of files containing audit trail data
depends on the platform you are using (Oracle, SQL Server, or Sybase Adaptive
Server Anywhere).
For details, see the following Help topics:

Define Paths When Using Oracle, page 318

Define Paths When Using SQL Server, page 319

Define Paths When Using Sybase Adaptive Server Anywhere, page 320

Related Topics
Activate the Audit Trail Functionality, page 113

Managing Audit Trail Data Common Tasks, page 315

Managing Audit Trail Data: An Overview, page 314

Define Paths When Using Oracle


When using Oracle, files containing audit trail data appear as SQL files on your
Windows server. To enable saving audit trail data to an external file, you need to
open the Oracle Instance Configuration file and set the path value of the parameter
UTL_FILE_DIR.
For details about setting the file path value in the Oracle Instance Configuration file
on your Windows server, see Installation and Upgrade Guide, Installing SmartPlant
Instrumentation on Oracle, Oracle 9i or 10g Instance Creation.
File path value example on a Windows server:
utl_file_dir=e:\INtoolStorage\Orc1

318 SmartPlant Instrumentation Administration Users Guide

Managing Audit Trail Data: An Overview


Notes

In the path value, the folder name Orc1 corresponds to a possible instance
name. INtoolStorage is a user-defined name. For convenience, we
recommend that you always use this name in the file path.

On Oracle 9.2, the software might append numbers to the name of the
Oracle Instance Configuration File init.ora. For example, the file name
might be as follows:
init.ora.2242004153249
Prior to trimming audit trail data, you need to delete the numbers together
with the dot that are appended to the init.ora file. Then, you must restart
the Oracle instance manually, that is, not from the Oracle interface but
using appropriate SQL commands.

Related Topics

Activate the Audit Trail Functionality, page 113

Managing Audit Trail Data Common Tasks, page 315

Managing Audit Trail Data: An Overview, page 314

Define Paths When Using SQL Server


When using SQL Server, files containing audit trail appear as .txt files on your
Windows server. When trimming audit trail data for the first time, the system
chooses the drive with maximum free disk space and creates a folder INtoolStorage in
that drive.
If you do not want the system to choose the target drive, before trimming audit trail
data, you can create the folder INtoolStorage on a different drive. After you click
Trim in the Trim Audit Trail Data dialog box, the system locates the folder
INtoolStorage and configures the path for the file with the audit trail data.
Depending on your SQL Server instance, the system creates the following paths for
the files containing the trimmed audit trail data:
SQL Server with a SmartPlant Instrumentation database created in a default
instance:
<drive>:INtoolStorage\<default instance name>\<SmartPlant Instrumentation
database name>.
For example:
e:\INtoolStorage\Engineering1\Build3, where the default instance name Engineering1
corresponds to your Windows server name.

SmartPlant Instrumentation Administration Users Guide 319

Managing Audit Trail Data: An Overview


SQL Server with a SmartPlant Instrumentation database created in a named
instance:
<drive>:INtoolStorage\<SQL Server server name>\<named instance
name>\<SmartPlant Instrumentation database name>.
For example:
e:\INtoolStorage\Engineering1\SPI2007\Build3, where the SQL Server server name
Engineering1 corresponds to your Windows server name.
Related Topics

Activate the Audit Trail Functionality, page 113

Managing Audit Trail Data Common Tasks, page 315

Managing Audit Trail Data: An Overview, page 314

Define Paths When Using Sybase Adaptive Server


Anywhere
When using Sybase Adaptive Server Anywhere, files containing audit trail data
appear as .txt files on a client machine where you have installed SmartPlant
Instrumentation. The default path to these files is created automatically with
SmartPlant Instrumentation setup. Setup creates the following default path:
<drive>:\<SmartPlant Instrumentation home folder>INtoolStorage. The drive value
corresponds to the drive where you have installed SmartPlant Instrumentation.
You can view the file path as the value of the WatINstorageDir parameter in the
[DATABASE] section of the intools.ini file.
File path value example:
WatINstorageDir="c:\Program Files\SmartPlant\ Instrumentation\INtoolStorage"
If you do not have enough disk space for saving audit trail data to the drive where you
have installed SmartPlant Instrumentation, you need to manually change the drive
value to another drive the intools.ini file. In the intools.ini file, you can also modify
the default path values as required, provided that you have configured this path on
your machine.
1. On the required drive of your client machine, create a folder INtoolStorage.
2. Open the intools.ini file.
3. In the [DATABASE] section, set the file path value of the parameter
WatINstorageDir so that it matches the path you have created.
For example:
WatINstorageDir="d:\SmartPlant\Instrumentation\INtoolStorage"

320 SmartPlant Instrumentation Administration Users Guide

Clearing Locking: An Overview

Clearing Locking: An Overview


This option enables the Domain Administrator to clear locking in SQL Server or
Oracle databases.
Clearing locking is useful in the following cases:

A SmartPlant Instrumentation user has locked a certain item for use in


other sessions and remains connected to the database for a long time.

There in an inactive locking session. For example, there is a session in


which SmartPlant Instrumentation stopped responding, or a user has
closed the locking session from the Window Task Manager, or the locking
session closed down as result of an application error. These session
records remain on the server database and keep locking other sessions.

There is an external application whose session is locking a SmartPlant


Instrumentation session in the current domain.

Related Topics

Clearing Locking Common Tasks, page 322

Domain Administration Common Tasks, page 147

Print Database Connection Information, page 145

SmartPlant Instrumentation Administration Users Guide 321

Clearing Locking: An Overview

Clearing Locking Common Tasks


The Domain Administrator can perform the following tasks when clearing locking:
Clear Locking per User
This option enables the Domain Administrator to clear locking per user by
disconnecting a user from SmartPlant Instrumentation and closing all the user's
sessions in the current domain. You can use this option on either a SQL Server or
Oracle server database platform.
After disconnecting a user, the records of the user's sessions remain in the
CURRENT_INFO table of your server database. If needed, you can manually clear
the session records to improve SmartPlant Instrumentation performance. For more
information, see Clear Locking per User, page 323.
Clear Blocked Sessions on Oracle
On Oracle, this procedure allows the Domain Administrator to stop the sessions in the
current domain which have been blocked by other sessions in a SmartPlant
Instrumentation database, and remove the session records from the CURRENT_INFO
table. For more information, see Clear Blocked Sessions on Oracle, page 323.
Clear Blocking Sessions on SQL Server
On SQL Server, this option allows the Domain Administrator to end the sessions in
the current domain which are blocking other sessions in a SmartPlant Instrumentation
database, and remove the session records from the CURRENT_INFO table. For more
information, see Clear Blocking Sessions on SQL Server, page 324.
Clear Locking in All Sessions
This option allows the Domain Administrator to clear locking in all the sessions
(inactive and active) in the current domain, and remove the session records from the
CURRENT_INFO table. For more information, see Clear Locking in All Sessions,
page 324.
Clear SmartPlant Instrumentation Session Records
On Oracle and SQL Server, when a user logs out from SmartPlant Instrumentation,
the software does not clear records of the sessions which are no longer in use from the
CURRENT_INFO table of the current database. These records hold the user name,
the domain and session IDs, and the flags used by the sessions to activate or
deactivate the SmartPlant Instrumentation triggers. The Domain Administrator needs
to clear these records manually.
Clearing SmartPlant Instrumentation sessions manually enables the Domain
Administrator to improve the performance of SmartPlant Instrumentation. For more
information, see Clear SmartPlant Instrumentation Session Records, page 324.

322 SmartPlant Instrumentation Administration Users Guide

Clearing Locking: An Overview

Clear Locking per User


Important
This clearing locking option stops all at once the SmartPlant
Instrumentation application session, the Administration module session,
the Import and Merger utility sessions. Clearing locking in active sessions
results in losing all the data which was being imported or merged at that
time.
1. Start the Administration module and log on as Domain Administrator.

2. With the Domain Administration window open, click DBA > Locking > Clear
Locking in Selected Sessions.
3. In the Clear Locking in Selected Sessions dialog box, from the User list, select
the user whose SmartPlant Instrumentation sessions you want to stop in the
database.
Tips
View the current database name in the Database field.
4. Click OK.

Related Topics

Clearing Locking Common Tasks, page 322

Clearing Locking: An Overview, page 321

Clear Blocked Sessions on Oracle


Important
Ending active blocked sessions and disconnecting the users from these
sessions results in the loss of all the data which was being imported or
merged at that time.
1. Start the Administration module and log on as Domain Administrator.

2. With the Domain Administration window open, click DBA > Locking > End
Blocked Sessions.
Related Topics
Clearing Locking Common Tasks, page 322

Clearing Locking: An Overview, page 321

Print Database Connection Information, page 145

SmartPlant Instrumentation Administration Users Guide 323

Clearing Locking: An Overview

Clear Blocking Sessions on SQL Server


Important
Ending active blocking sessions and disconnecting the users from these
sessions results in the loss of all the data which was being imported or
merged at that time.
1. Start the Administration module and log on as Domain Administrator.

2. With the Domain Administration window open, click DBA > Locking > End
Blocking Sessions.
Related Topics

Clearing Locking Common Tasks, page 322

Clearing Locking: An Overview, page 321

Print Database Connection Information, page 145

Clear Locking in All Sessions


Important
Clearing active sessions results in ending these sessions, disconnecting the
users, and losing all the data which was being imported or merged at that
time.
1. Start the Administration module and log on as Domain Administrator.

2. With the Domain Administration window open, click DBA > Locking > Clear
Locking in All Sessions.
Note

This action does not affect your Administration module session.

Related Topics

Clearing Locking Common Tasks, page 322

Clearing Locking: An Overview, page 321

Clear SmartPlant Instrumentation Session Records


Important
On Oracle, the Domain Administrator can clear SmartPlant
Instrumentation session records when working with Oracle Server
database version 9i or later.
1. Start the Administration module and log on as Domain Administrator.

2. With the Domain Administration window open, click DBA > Data
Maintenance > Clear Session Records.

324 SmartPlant Instrumentation Administration Users Guide

Copying Data: An Overview

Copying Data: An Overview


When creating a new lowest plant hierarchy item, you can copy data from another
existing lowest plant hierarchy item within the same domain. In the plant hierarchy,
the lowest source item can belong to any highest item in the current domain. The
default lowest plant hierarchy item is <unit>. The default highest plant hierarchy
item is <plant>. When the domain type is an Operating owner, you can select a
specific project to which you want to copy <unit> data from the source project.
Before copying data, we recommend that you familiarize yourself with naming
convention definitions.
Copying data to another <unit> involves three major steps:
1. Defining the name and number of the target lowest plant hierarchy item.
2. Selecting the source <unit>.
3. Selecting the source <unit> module data to copy. The following table lists the
modules and the module data which you can copy:
Module

Module Data

Instrument Index

Tag number
Loop
P&ID drawing
Line
Equipment
Document association
Calculation

Process Data and


Calculation

Process data
Calculation

Specifications

All module data (you can only copy the specification data
in its entirety.)

Wiring

Wiring items
Connection data (excluding cross wiring)

Loop Drawings

All module data (you can only copy the loop drawing data
in its entirety.)

Hook-Ups

All module data (you can only copy the hook-up data in
its entirety.)

Related Topics

Copying Data Common Tasks, page 326

Plant Design and Structure Common Tasks, page 151

Plant Design: An Overview, page 149

SmartPlant Instrumentation Administration Users Guide 325

Copying Data: An Overview

Copying Data Common Tasks


The following tasks are used when you need to copy data from one lowest plant
hierarchy item to another. The default lowest plant hierarchy item is <unit>.
Copy Data from Another Lowest Plant Hierarchy Item
This procedure enables the Domain Administrator to copy engineering data from one
lowest plant hierarchy item to another. For more information, see Copy Data from
Another Lowest Plant Hierarchy Item, page 327.
Set Options for Copying All Module Data
When copying data from one lowest plant hierarchy item to another, you can select a
module and copy all of its data to the target lowest plant hierarchy item. You set the
options for copying all module data in the upper-right section of the Copy Data from
Source dialog box. For more information, see Set Options for Copying All Module
Data, page 330.
Set Options for Copying Specific Data
When copying data from one lowest plant hierarchy item to another, you can select
data of a specific module, and set the options for copying the specific data in the
lower-right section of the Copy Data from Source dialog box. For more
information, see Set Options for Copying Specific Data, page 328.
Set Revisions for Target Plant Hierarchy Item
When copying data, you can use this option to set drawing and document revisions to
be used in the target lowest plant hierarchy item. You can set revisions for all module
documents or selected module documents. Setting revisions is available for the
following modules Process Data and Calculation, Specifications, and Loop Drawings.
For more information, see Set Revisions for Target Plant Hierarchy Item, page 332.
Set Wiring Naming Options for Target Plant Hierarchy Item
Use this procedure to set naming options for wiring items in the target lowest plant
hierarchy item when copying data from one lowest plant hierarchy item to another.
For details, see Set Wiring Naming Options for Target Plant Hierarchy Item, page
331.
Related Topics

Copying Data: An Overview, page 325

Create a Plant Hierarchy Item on the Lowest Level, page 156

Domain Administration Common Tasks, page 147

Plant Hierarchy Explorer, page 464

326 SmartPlant Instrumentation Administration Users Guide

Copying Data: An Overview

Copy Data from Another Lowest Plant Hierarchy Item


1. In the Plant Hierarchy Explorer, open the <Unit> Properties dialog box. For
details, see Create a Plant Hierarchy Item on the Lowest Level, page 156.
Tips

If you want to copy data to an existing <unit>, in the Plant Hierarchy


Explorer, select a <unit> that does not have naming conventions.

In the <unit> that you selected, you must define the <unit> number
even if in the source <unit>, the naming conventions do not include
the <unit> number segment.
2. Click Copy From.

3. In the dialog box that opens, select a source <unit>, and then, click OK to open
the Copy Data from Source dialog box.
Tips

When the domain type is Operating owner, select the required project
from the Source project list, and then select the <unit> whose data
you want to copy.

The Copy Data from Source dialog box can display previously used
settings that you used the last time when you were copying data. You
can use the same settings, discard some of them, or discard them all.
Click Clear All to discard all the displayed settings.
4. In the left section of the Copy Data from Source dialog box, do one of the
following:

To copy all module data of the required module, select a module to


access the fields in the upper-right section of the Copy Data from
Source dialog box. For details, see Set Options for Copying All
Module Data, page 330.

To copy specific data, expand the module hierarchy, and select the
required module data to access the fields in the lower-right section.
For details, see Set Options for Copying Specific Data, page 328.
5. Repeat step 4 in this procedure for each source <unit> module or module data.

6. Click Options to set naming options for wiring items in the target <unit>.
Caution
Make sure that you define the settings described in this procedure for
all the required modules and module items before clicking OK. After
you click OK, canceling the copying process can corrupt the data in
the target <unit> and render the <unit> unusable.
7. Click OK to close the Copy Data from Source dialog box and monitor the
progress of the copying process.

SmartPlant Instrumentation Administration Users Guide 327

Copying Data: An Overview

Set Options for Copying Specific Data


1. Start copying the <unit> data and select specific module data from the source
<unit>. For details, see Copy Data from Another Lowest Plant Hierarchy Item,
page 327.
2. In the lower-right section of the Copy Data from Source dialog box, select Copy
selected data.
Tips

The lower-right section of the Copy Data from Source dialog box
displays only the options that are required for copying data, depending
on the specific module data you select in the left section. The options
that are irrelevant to the selected module are read-only.

Make sure that you do not select the Copy all module data check
box. If you do, click Clear All. Clicking this button discards all the
settings you have made and you have to start again.
3. In the Name prefix field, type a new name prefix to be applied to all the copied
items.

4. In the Name suffix field, type a new name suffix to be applied to all the copied
items.
Tip
Specifying a prefix, a suffix, or both is required when copying module
data within the same <plant>. This way you avoid creating duplicate
module item names.
5. If required, set revision copying options.

6. To avoid having duplicate module item names, in the Char. location data field,
type the number of characters from the start of the name string where you want
the substitution to start from.
7. In the No. of chars. data field, type the number of characters in the name string to
be substituted.
8. In the Value field, type a new value that will substitute a part of the module item
name string.

328 SmartPlant Instrumentation Administration Users Guide

Copying Data: An Overview


9. In the Prefix field, to avoid creating duplicate loop and tag number prefixes in the
units of the same <plant>, type a loop or tag number prefix to be used in the target
<unit>.
Tips

This option is available when copying loop or tag number data from a
<unit> within the same <plant>. Also, it is available only for those
items for which the prefix naming convention segment is set as
COMPONENT PREFIX in the ISA or Loop standard.

For loop items, the option is accessible only if the ISA or Loop
standard naming convention for the prefix segment description of
loops is LOOP PREFIX.

This option is not applicable if you use Flexible naming conventions in


the source <unit>. For Flexible naming conventions, you can define
your target loop and tag number prefixes in the Name prefix field.
10. In the Suffix field, type a loop or tag number suffix to define a distinctive loop or
tag number suffix to be used in the target <unit>.

Tips

This option is available when copying loop or tag number data from a
<unit> within the same <plant>. For tag number items, the option is
accessible only if the ISA or Loop standard naming convention for the
suffix segment description of tags is COMPONENT SUFFIX.

For loop items, the option is accessible only if the ISA or Loop
standard naming convention for the suffix segment description of
loops is LOOP SUFFIX.

If, in your source <unit>, there are loop names or tag numbers that
differ only in their suffix segments, these loop names and tag numbers
become identical in the target <unit>. The new suffix value in the
target <unit> overwrites all the suffix values of the source <unit>. For
example, if in the Suffix field, you type 5, loop names 101-F-100\1,
101-F-100\2, 101-F-100\3 in the source <unit> become 101-F-100\5 in
the target <unit>. This option is not applicable if you use Flexible
naming conventions in the source <unit>. For Flexible naming
conventions, you can define your target loop and tag number suffixes
in the Name suffix field.
11. In the left section, select other specific data, and repeat steps 2 through 10.

Related Topics

Copying Data Common Tasks, page 326

Copying Data: An Overview, page 325

SmartPlant Instrumentation Administration Users Guide 329

Copying Data: An Overview

Set Options for Copying All Module Data


1. Start copying the <unit> data and select specific module data from the source
<unit>. For details, see Copy Data from Another Lowest Plant Hierarchy Item,
page 327.
2. In the upper-right section of the Copy Data from Source dialog box, select Copy
all module data.
Tip
The upper-right section of the Copy Data from Source dialog box
displays only the options that are required for copying data, depending
on the module you select in the left section. The options that are
irrelevant to the selected module are read-only.
3. In the Name prefix field, type a new name prefix to be applied to all the copied
items of the selected module.

4. In the Name suffix field, type a new name suffix to be applied to all the copied
items of the selected module.
Tip
Specifying a prefix, a suffix, or both is required when copying the
<unit> module data within the same <plant>. This way you avoid
creating duplicate module item names.
5. To avoid having duplicate module item names, in the Char. location data field,
type the number of characters from the start of the name string where you want
the substitution to start from.

6. In the No. of chars. data field, type the number of characters in the name string to
be substituted.
7. In the Value field, type a new value that will substitute a part of the module item
name string.
8. If required, set revision copying options.
9. Do one of the following to define the level on which you want to copy the Wiring
module data:

Click Highest when copying data from units belonging to different


plants. You must select the highest plant hierarchy level when
copying data from <units> belonging to different <plants>. This is
required because most wiring data is defined either per <area> or per
<plant>.

Click Lowest when copying the source and the target <units>
belonging to the same <plant>.

330 SmartPlant Instrumentation Administration Users Guide

Copying Data: An Overview


Tip
When the source and the target <units> belong to the same <plant>,
you can select either the highest or the lowest plant hierarchy level.
However, if you select to copy data on the lowest level, you have to
modify the name strings to avoid duplicate names in the Wiring
module (see steps 5 through 7 in this procedure to learn how to modify
the name string).
10. In the left section, select another module, and repeat steps 2 through 8.

Caution

Make sure to set the copying options for all the required modules and
module items before clicking OK. After you click OK, canceling the
copying process can corrupt the data in the target <unit> and render the
<unit> unusable.

Related Topics

Copying Data Common Tasks, page 326

Copying Data: An Overview, page 325

Set Wiring Naming Options for Target Plant Hierarchy Item


1. On the Copy Data from Source dialog box, click Options.
2. On the Wiring Item Naming Options dialog box, do one of the following to set
naming options for control system tags:

Select Control system tag to name new control system tags according
to target tag names.

Clear Control system tag to name new controls system tags according
to source tag names.
3. Do one of the following to set naming options for device panels:

Select Device panel, and from the Like list, and then select Default to
copy the device cables with the default names (identical with tag
number names) or Naming Convention to copy the device panels with
the naming convention of the target <unit>.

Clear Device panel to copy all device panels without changing the
source names, according to the settings you make for copying wiring
items in the Copy Data from Source dialog box.
4. Clear the Device cable check box to set the naming convention options for device
cables and to copy all device cables without changing the source names,
according to the settings you make for copying wiring items in the Copy Data
from Source dialog box.

SmartPlant Instrumentation Administration Users Guide 331

Copying Data: An Overview


5. Select the Device cable check box and then select one of the following options:

Default to copy the device cables with the default names, for
example,
C-<TAG NUMBER>.

Naming Convention to copy the device cables with the naming


convention of the target <unit>.
6. Do one of the following to set naming options for signal names:

Select Signal name to copy signals using target tag names.

Clear Signal name to copy signals according to the settings you make
for copying wiring items in the Copy Data from Source dialog box.
7. Do one of the following to set naming options for wire tags:

Select Wire tag to copy wire tags using target tag names.

Clear Wire tag to copy wire tags according to the settings you make
for copying wiring items in the Copy Data from Source dialog box.
8. Click OK to accept the settings, and return to the Copy Data from Source dialog
box.

Related Topics

Copying Data Common Tasks, page 326

Copying Data: An Overview, page 325

Set Revisions for Target Plant Hierarchy Item


When setting revisions, you can do one of the following:

Copy all revisions from the source <unit> to the new <unit>.

Create new revisions for the new <unit>. This option allows you to start a
new set of revisions for the copied <unit> data.

Forgo creating any revisions for the target <unit>. This option resembles
the creation of new revisions. You can assign revisions to the documents
in the new <unit>.
1. Start copying the <unit> data and select specific module data from the source
<unit>. For details, see Copy Data from Another Lowest Plant Hierarchy Item.

2. In the left section of the Copy Data from Source dialog box, do one of the
following:

Select Specifications, Loop Drawings, or Process Data &


Calculation.

Expand Process Data & Calculation and select specific data (Process
Data or Calculation).

332 SmartPlant Instrumentation Administration Users Guide

Copying Data: An Overview


3. Do one of the following:

If you selected a module, in the upper-right section of the dialog box,


select the Copy all module data check box.

If you selected specific data, in the lower-right section of the dialog


box, select the Copy selected data check box.
4. Do one of the following:

Click Skip not to copy any revisions.

Click All existing to copy all revisions from the selected module data
to the new module data.
5. To set new revisions, click Set new.

6. Click New Revisions.


7. In the dialog box that opens, click the appropriate Revision method option button
to select the required revision numbering, for example, P0, P1, P2,... 0,1,2,... and
so forth.
8. To add a new revision line, click New and type the required data in the Revision
data window.
9. To edit a revision, select the revision you want to edit and click Edit.
10. When done, click OK to return to the Copy Data from Source dialog box.
Important
Make sure to set the copying options for all the required modules and
module items before clicking OK. After you click OK, canceling the
copying process can corrupt the data in the target unit and render the
unit unusable.
11. If you have finished setting all other copying options, in the Copy Data from
Source dialog box, click OK to assign the new revision settings to the copied
module data.

Related Topics

Copying Data Common Tasks, page 326

Copying Data: An Overview, page 325

SmartPlant Instrumentation Administration Users Guide 333

SmartPlant Instrumentation KKS Overview

SmartPlant Instrumentation KKS Overview


SmartPlant Instrumentation supports KKS naming conventions for process-related
identification of the following item types:

Instruments (including functional requirement tags and virtual tags)

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

Equipment
Unit
Numbering

Three-digit number with


leading zeros.

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
Optional character
Unit Additional (alphabetic).
Code

334 SmartPlant Instrumentation Administration Users Guide

SmartPlant Instrumentation KKS Overview


KKS Level
Name

Property

Description

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

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.

Single digit (0-9) representing the


application area of a cable (voltage
levels).

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.

SmartPlant Instrumentation Administration Users Guide 335

SmartPlant Instrumentation KKS Overview


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

Total Plant

System Code Prefix

System Classification

BBA

System Numbering

01

Equipment Unit Classification

(Not used)

Equipment Unit Numbering

(Not used)

336 SmartPlant Instrumentation Administration Users Guide

Description

MV distribution board

SmartPlant Instrumentation KKS Overview


For a flow transmitter, the KKS identification 1 0PAE01 CF013 B01 could be
used, where the values are designated as follows:
Property

Value Description

Total Plant

System Code Prefix

System Classification

PAE

System Numbering

01

Equipment Unit
Classification

CF

Equipment Unit Numbering

001

Component Classification

-B

Component Numbering

01

Circulating (main cooling) water pump


system
Open flow loops

Transducer

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.

Not all items use all the described segments. For example, DCS and PLC
panels do not use equipment unit code and component code segments.
Marshaling racks, junction boxes, process equipment, and lines do not use
component code segments.

Related Topics

Flow of Activities for Working in KKS Mode, page 338

SmartPlant Instrumentation Administration Users Guide 337

SmartPlant Instrumentation KKS Overview

Flow of Activities for Working in KKS Mode


To work in KKS mode in SmartPlant Instrumentation, you must use the
Administration Module. This ensures that the software populates the target database
with KKS segment code lists and representative KKS instrument types.

System Administrator Activities


1. Log on to the Administration Module as System Administrator, and using the
in_kks.db database as a source, initialize a domain.
Tips

You can obtain in_kks.db from Intergraph Support.

For information on how to initialize domains in your database


platform, see Installation Guide, Initializing a SmartPlant
Instrumentation Domain in the appropriate section for the database
platform you are working with (Oracle, SQL Server, or Sybase
Adaptive Server Anywhere).
2. Click File > Domain Definition.

3. In the Domain Definition window, under Domain features, select KKS mode.

Domain Administrator Activities


1. Log on as Domain Administrator, and on the Administration dialog box, select
the domain that you initialized.
2. Define the plant hierarchy and add plant groups (for details, see the appropriate
topics in the Administration Module Online Help).
3. Click Activities > Naming Conventions.
4. On the Naming Conventions dialog box, copy the naming conventions from the
Default lowest plant group of the Default plant and make necessary adjustments
to define the naming conventions using KKS segment properties. For details, see
Define KKS Naming Convention Using KKS Segments, page 340.

338 SmartPlant Instrumentation Administration Users Guide

SmartPlant Instrumentation KKS Overview

Import Utility Activities


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
SmartPlant Instrumentation KKS Overview, page 334

SmartPlant Instrumentation Administration Users Guide 339

SmartPlant Instrumentation KKS Overview

Define KKS Naming Convention Using KKS


Segments
1. On the Naming Conventions dialog box, copy the naming conventions from the
Default lowest plant group of the Default plant and make necessary adjustments
to define the naming conventions using KKS segment properties.
2. On the Naming Conventions dialog box, from the Convention box, select an
item type.
3. Accept the default segment definitions or change them as appropriate.
4. Define the separators as you require.
Tips

The Naming Conventions dialog box opens with the KKS naming
conventions already defined. You can delete segment properties that
you do not require or add freeform properties in addition to the KKS
segments; however, note that in KKS mode, SmartPlant
Instrumentation does not propagate properties of non-KKS segments.

If you have an existing KKS naming convention in another plant


hierarchy that you want to copy, click Copy From to copy that
naming convention to your domain.

When the value of a numeric or optional segment is less than the


maximum length, the software adds leading zeros in the segment. An
optional segment is a segment in which you do not have to enter the
value.

340 SmartPlant Instrumentation Administration Users Guide

SmartPlant Instrumentation KKS Overview

Example of a KKS Naming Convention for Loops

Loop Number Representation in the Domain Explorer of


SmartPlant Instrumentation

SmartPlant Instrumentation Administration Users Guide 341

SmartPlant Instrumentation KKS Overview


Notes

When creating a loop, you can also create instrument tags on the fly, using
the loop naming as a source. Also, when you connect a cable to a panel,
the cable inherits the naming from the panel according to KKS convention
rules. In both cases, the software copies the naming from the source item
segments to the appropriate target item segments. For these reasons, in the
naming convention of a target item, you should not delete segments that
are likely to receive values by propagation. Non-relevant segments in the
target item are left blank or not displayed.

After creating an item in SmartPlant Instrumentation, you cannot change


its naming convention.

Related Topics

Flow of Activities for Working in KKS Mode, page 338

SmartPlant Instrumentation KKS Overview, page 334

342 SmartPlant Instrumentation Administration Users Guide

SmartPlant Instrumentation KKS Overview

Configuring SmartPlant Instrumentation for


Integration
After installing SmartPlant Instrumentation and the prerequisite software needed for
working in an integrated environment, you must perform the following configurations
on the SmartPlant Instrumentation client machine:
1. Configure SmartPlant Instrumentation. For more information, see Configure
SmartPlant Instrumentation for Integration, page 344.
2. Prepare SmartPlant Instrumentation to work in an integrated environment. For
more information, see Tool Requirements for Integrating SmartPlant
Instrumentation, page 354.

SmartPlant Instrumentation Administration Users Guide 343

SmartPlant Instrumentation KKS Overview

Integration Common Tasks


Before you can work with options in an integrated environment, you need to perform
certain tasks in the SmartPlant Instrumentation Administration module.
The System Administrator performs the following task:
Configure SmartPlant Instrumentation for Integration
Use this procedure to configure SmartPlant Instrumentation to enable publish and
retrieve. For more information, see Configure SmartPlant Instrumentation for
Integration, page 344.
The Domain Administrator performs the following tasks:
Retrieve a Plant Hierarchy
Use this procedure to retrieve a plant hierarchy and apply it in SmartPlant
Instrumentation. For more information, see Retrieve a Plant Hierarchy, page 348.
Register a Plant
Use this procedure as a one-time operation, to register each highest level plant
hierarchy item (for example a SmartPlant Instrumentation plant) using the SmartPlant
Registration Wizard. For more information, see Register a Plant, page 349.
Related Topics

Item Registry Activities: An Overview, page 351

Configure SmartPlant Instrumentation for Integration


1. Log on as System Administrator to the Administration module of SmartPlant
Instrumentation.
2. On the Open Administration Module dialog box, select System Administrator.
Important

The domain to be used with SmartPlant integration must be initialized


from the Intoolsef.db file to ensure the correct mapping of a number of
supporting tables with the enumerated lists in the SmartPlant schema.

344 SmartPlant Instrumentation Administration Users Guide

SmartPlant Instrumentation KKS Overview


3. To initialize a new domain, do the following:
a. Click File > Initialize.
b. Type the appropriate domain information in the Domain, Domain schema
name, and Domain schema password text boxes. The View Only Domain
Schema password text box is filled automatically.
c. Click Source.
d. Select Sybase Adaptive Server Anywhere from the Database type list.
e. Click Browse.
f. Click the IntoolsEF.db database file and click Open.
g. Select INITIALTEF from the Domain list.
h. Click OK on the Source Data Connection dialog box.
i. Click OK on the Initialize Database dialog box.
j. On the Domain Tablespace Definition dialog box, change any settings if
necessary and click OK.
4. Click File > Domain Definition.
5. In the Domain Definition window, select the desired domain.
6. On the Module Toolbar, click Edit

7. Under Domain features, select the Item registry check box.


Tips

Selecting this option does not register the items, but only makes the
item registry commands available on the DBA menu for the Domain
Administrator, who performs all the item registry activities. Note that
the System Administrator has rights to switch the item registry on or
off at any stage of the plant life-cycle. If the System Administrator
switches off the item registry after the items are registered, and then
switches it on again, you must re-register the items. This is required
so that the software can update the references to the items in the item
registry table. When updating the table, the software registers all the
changes that were made to the items in SmartPlant Instrumentation,
including the period when the item registry options were switched off.

With this option selected, the software prevents SmartPlant


Instrumentation users from using internal SmartPlant Instrumentation
revision options. During report publishing, the software first checks
whether the report has an integrated revision and then assigns the
appropriate revision scheme automatically.

SmartPlant Instrumentation Administration Users Guide 345

SmartPlant Instrumentation KKS Overview


8. Beside Path for SmartPlant XML files, click Browse to navigate to the location
of the SmartPlant Instrumentation map files: ContextMap.xml and
IntoolsMap.xml.
Tips

The SmartPlant Instrumentation map files must be located in a path


that all users in an integrated environment can access using the same
drive letter mapping.

By default, when you install SmartPlant Instrumentation, these files


are placed in the path <SmartPlant Instrumentation home
folder>\XML\.
9. Save the changes and then close the Domain Definition window.

10. On the Module Toolbar, click User


see Define an IDEAL User, page 347.

and define an IDEAL user. For details,

Tip
To be able to define an IDEAL user, you must first define a
department.
11. Click File > Close.

12. From the Administration window, click File > Open.


13. On the Open Administration Module dialog box, select Domain Administrator
and select the desired SmartPlant domain, configured for an integrated
environment.
14. Click DBA > Data Maintenance > Register Items.
Important
If your domain type is Operating owner, you must perform item
registration prior to claiming any As-Built items. This is because in
the item registry, the software duplicates items that appear both in AsBuilt and projects. If you already claimed items for your projects, you
must merge these items back to As-Built.
15. Create a plant hierarchy in SmartPlant Instrumentation to match the source plant
hierarchy of each plant for which you want to retrieve or publish data. For
details, see Retrieve a Plant Hierarchy, page 348.

346 SmartPlant Instrumentation Administration Users Guide

SmartPlant Instrumentation KKS Overview


16. Register each SmartPlant Instrumentation plant that you want to use in an
integrated environment. For details, see Register a Plant, page 349.
Tip
If you create a new plant, you should rename it and all of its plant
hierarchy items to exactly match the plant hierarchy items that you
want to map to in SmartPlant Foundation (the names are casesensitive). After that, you just need to register SmartPlant
Instrumentation, retrieve the plant hierarchy from SmartPlant
Foundation, and correlate the two plant hierarchies.
17. Log on to SmartPlant Instrumentation as the IDEAL user and define the necessary
settings for working in an integrated environment. For details, see Define Settings
for an Integrated Environment, page 350.

Related Topics

Set the Project Status for an Integrated Environment, page 170

Define an IDEAL User


When external users need to connect to the SmartPlant Instrumentation database, you
must define an IDEAL user through which the software establishes the connections.
1. Log on to the SmartPlant Instrumentation Administration module as System
Administrator.
2. Click Activities > User.
Tip
To be able to define an IDEAL user, you must first define a
department.
3. On the User dialog box, do one of the following:

From the User list, select an existing user.

Click New, and in the User box, define a new user.


4. Select the IDEAL user check box.

SmartPlant Instrumentation Administration Users Guide 347

SmartPlant Instrumentation KKS Overview


5. Click Apply.
Note

When you first define an IDEAL user on a Windows 2003 server, the
Operating System automatically assigns the following policy for that user:

Deny log on locally

Deny access to this computer from the network

You need to remove the IDEAL user from the above policy list, and then add the
IDEAL user to the following policy list:

Allow log on locally

Access this computer from the network

Retrieve a Plant Hierarchy


1. Log on as Domain Administrator and select the desired domain that has been
configured for an integrated environment.
2. Click SmartPlant > Retrieve.
3. On the Select Plant dialog box, select the plant that you want to use as the seed
plant for retrieving the plant hierarchy.
4. Do one of the following:

Select Create new plant to create an entirely new plant hierarchy with
the same names as the source plant hierarchy items.

Select Correlate plant to create under the selected plant new plant
hierarchy items with the same names as the source plant hierarchy
items.
Tip

If you choose the option Create new plant, you must register the
newly-created plant before you can use it for integration. For details,
see Register a Plant, page 349.
5. On the SmartPlant Foundation Login dialog box, type the appropriate user
name and password.

6. On the Retrieve dialog box, in the Document type list, select All.
7. Under Show, select All documents.
8. Under Documents to retrieve, select the PBS document for the desired plant.
9. Click OK to retrieve the document.
10. At the confirmation prompt, click Close.
11. On the Select Plant dialog box, click Cancel to close the dialog box.

348 SmartPlant Instrumentation Administration Users Guide

SmartPlant Instrumentation KKS Overview


12. Click SmartPlant > To Do List.
13. On the To Do List dialog box, select all the tasks that appear in the list.
14. Click Run to create the plant hierarchy in SmartPlant Instrumentation.
Tip
You cannot defer tasks or view To Do List task properties when
retrieving a plant hierarchy in the Administration module.
15. Click Close to close the To Do List dialog box.

Register a Plant
1. Log on as Domain Administrator and select the desired domain, configured for an
integrated environment.
2. Click SmartPlant > Register.
Important
You cannot unregister a plant after it is registered.
3. On the Select Plant dialog box, select the plant that you want to register.

4. On the SmartPlant Foundation URL page of the SmartPlant Registration


Wizard, type the node name and virtual directory of the SmartPlant Foundation
database to which you want to register your project. Use the following format:
http://<SPFServer>/<VirtualDirectory>.

For example:
http://<SPFServer>/SPFASP.

Tips

You can click the Browse button to search for the node name.
However, you must append the virtual directory to that node name by
typing it in the SmartPlant Foundation URL box.

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.
5. Click Next.

6. On the SmartPlant Foundation Plant page, select from the Plant name list the
SmartPlant Foundation plant with which you want to register your SmartPlant
Instrumentation plant.

SmartPlant Instrumentation Administration Users Guide 349

SmartPlant Instrumentation KKS Overview


7. Click Next.
8. If desired, select the auto-retrieve option.
9. Click Finish to register your plant. The registration process also compares the
authoring tool's schema release number against the list of supported release
numbers on the SmartPlant Foundation server. If the tool map schema is
compatible, the tool is granted registration.
10. On the Select Plant dialog box, click Cancel to close the dialog box.

Define Settings for an Integrated Environment


1. Log on to the SmartPlant Instrumentation application as the IDEAL user.
2. Click File > Preferences.
3. On the Preferences dialog box tree-view pane, click General.
4. From the PDF generator list, select the PDF generator that is installed on your
server machine: Acrobat Distiller or Generic PostScript Printer.
5. Beside Output document folder, click Browse to specify an output document
folder in which the software places all SmartPlant Instrumentation documents that
can be published.
Tip

If you do not intend to publish documents through the Web, we


recommend that you specify as the output location a sub-folder of the
folder where the Intools.ini file is located.

350 SmartPlant Instrumentation Administration Users Guide

Item Registry Activities: An Overview

Item Registry Activities: An Overview


After registering the items, as soon as a user performs any of the item registry
operations, the appropriate references appear in the item registry automatically. This
way, the software keeps SmartPlant Instrumentation data up-to-date for integration.
After registering the items, users of other applications who have access to integration
options can use information held in the item registry to retrieve SmartPlant
Instrumentation data.
Important

If your domain type is Operating owner, you must perform item


registration prior to claiming any As-Built items. This is because in the
item registry, the software duplicates items that appear both in As-Built
and projects. If you already claimed items for your projects, you must
merge these items back to As-Built.
Note

The System Administrator has rights to switch the item registry on or off at
any stage of the plant life-cycle.

Related Topics

Domain Administration Common Tasks, page 147

Enable Item Registry, page 113

Integration Common Tasks, page 344

Item Registry Activities Common Tasks, page 352

Merging Project and As-Built Data: An Overview, page 218

SmartPlant Instrumentation Administration Users Guide 351

Item Registry Activities: An Overview

Item Registry Activities Common Tasks


The Domain Administrator can perform the following tasks when performing item
registry activities:
Register Items
This topic explains how the Domain Administrator with access rights to the item
registry options can register all of the SmartPlant Instrumentation items that exist in
the current domain. For more information, see Register Items, page 352.
Clean Up Item Registry
This procedure describes how to clean up the item registry table. When performing a
clean-up, the software removes from the item registry all references to items that were
deleted in the current domain. For more information, see Clean Up Item Registry,
page 353.
Related Topics

Domain Administration Common Tasks, page 147

Integration Common Tasks, page 344

Item Registry Activities: An Overview, page 351

Register Items
Important

The System Administrator needs to enable the item registry options as a


prerequisite to this procedure.

Prior to registering items, make sure that no users are connected to the
SmartPlant Instrumentation database. It is recommended that you clear all
SmartPlant Instrumentation sessions before performing item registration.
1. Start the Administration module and log on as Domain Administrator.

2. With the Domain Administration window open, click DBA > Data
Maintenance > Register Items.
Note

The System Administrator has rights to switch the item registry on or off
as required at any stage of the plant life-cycle. If the System
Administrator switched the item registry off after you registered the items,
and then switched it on again, you must re-register the items. This is
required so that the software can update the references to the items in the
item registry table. When updating the table, the software registers all the
changes that were made to the items in SmartPlant Instrumentation,
including the period when the item registry options were switched off.

352 SmartPlant Instrumentation Administration Users Guide

Item Registry Activities: An Overview

Clean Up Item Registry


1. Start the Administration module and log on as Domain Administrator.
2. With the Domain Administration window open, click DBA > Data
Maintenance > Item Registry Clean-Up.
Related Topics
Item Registry Activities Common Tasks, page 352

Item Registry Activities: An Overview, page 351

SmartPlant Instrumentation Administration Users Guide 353

Item Registry Activities: An Overview

Tool Requirements for Integrating SmartPlant


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

General Integration Requirements


The following is a list of best practice scenarios for using SmartPlant Instrumentation
so data will migrate correctly to the other SmartPlant tools.
As Domain Administrator, perform the following tasks:

Assign the access right for SmartPlant Registration (under Domain


Level) to Full (Add / Delete / Update).

Assign the access rights for Publish and Retrieve (under each registered
plant) to Full (Add / Delete / Update).

354 SmartPlant Instrumentation Administration Users Guide

Item Registry Activities: An Overview

Naming Convention Integration Requirements


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, page 364.
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

InstrTagPrefix

MeasuredVariable+InstrFuncModifier

InstrTagSequenceNo

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.

SmartPlant Instrumentation Administration Users Guide 355

Item Registry Activities: An Overview


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

LoopPrefix

LoopIdentifier

3
4

LoopSequenceNo

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

MeasuredVariable

Left side of segment 2

InstrFuncModifier

Right side of segment 2

InstrTagSequenceNo

InstrTagSuffix

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

356 SmartPlant Instrumentation Administration Users Guide

Item Registry Activities: An Overview


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

LoopIdentifier

2+3

LoopSequenceNo

LoopSuff

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.

SmartPlant Instrumentation Administration Users Guide 357

Item Registry Activities: An Overview


An example of an instrument naming convention:

358 SmartPlant Instrumentation Administration Users Guide

Item Registry Activities: An Overview


An example of a loop naming convention:

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

SmartPlant Instrumentation Administration Users Guide 359

Item Registry Activities: An Overview


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.

360 SmartPlant Instrumentation Administration Users Guide

Item Registry Activities: An Overview


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

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.

Working 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.
SmartPlant Instrumentation Administration Users Guide 361

Item Registry Activities: An Overview


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

362 SmartPlant Instrumentation Administration Users Guide

Item Registry Activities: An Overview

Using Projects in an Integrated Environment


When working in an integrated environment with a plant that has projects, you need
to perform the procedures below in the SmartPlant Instrumentation Administration
module so that data will migrate correctly to the other SmartPlant tools.
Caution

When using projects in an integrated environment, do not change As-Built


data in As-Built itself.

System Administrator Tasks

If needed, convert the domain type of an existing SmartPlant


Instrumentation domain from EPC to Operating Owner. For more
information, see System Administration > Domain Management > Create
an Operating Owner Domain in the SmartPlant Instrumentation
Administration User's Guide.

In the Domain Definition window, under Domain type, choose


Operating owner and select Exclusive claim mode. SmartPlant
integration does not support having the same item claimed for different
projects.

Domain Administrator Tasks

Assign the access right for Project Definition (under Domain Level) to
Full (Add / Delete / Update).

Create one or more projects. For more information, see Domain and
Project Administration > Operating Owner: General Activities > Create a
Project in the SmartPlant Instrumentation Administration User's Guide.

Scope and claim items from As-Built for a project. For more information,
see Scoping Data for Projects: An Overview in the SmartPlant
Instrumentation Administration Guide.

Set the necessary status for the project. For more information, see Set the
Project Status for an Integrated Environment in the SmartPlant
Instrumentation Administration Guide.

Complete and merge a project in SmartPlant Instrumentation For more


information, see the SmartPlant Instrumentation Administration Guide,
Merging Project and As-Built Data: An Overview.

SmartPlant Instrumentation Administration Users Guide 363

Item Registry Activities: An Overview

Naming Convention Mapping


The NamingConventionMap.xml file can be edited by users. The file contains the
following code format:
<NAMING_CONVENTIONS>
<Publish>
<ObjectDefName>
<Segment Seq="N/C Segment Number"
InterfaceDefUID="TEF TargetInterface"
PropertyDefUID="TEF TargetProperty"
StartPos="0" Length="0 - ignore, >0 length"/>
...
</ObjectDefName>
</Publish>
<Retrieve>
<ObjectDefName>
<Segment Seq="N/C Segment Number"
InterfaceDefUID="TEF SourceInterface"
PropertyDefUID="TEF SourceProperty"
StartPos="0" Length="0 - ignore, >0 length"/>
...
</ObjectDefName>
</Retrieve>
<NAMING_CONVENTIONS>

Notes

Mapping two adjacent segments to the same property results in


concatenation of the values when you publish.

If you use the value 'Exception' for the InterfaceDefUID property, the
software looks for the <Exception Name> tag with a value equivalent to
the PropertyDefUID attribute. For example:
<Instrument>
...
<Segment Seq="2"
InterfaceDefUID="Exception"
PropertyDefUID="INSTRUMENT_TYPE"
StartPos="1" Length="1" />
...
<Exception Name="INSTRUMENT_TYPE"
INSTR_TYPE_SegmentSeq="2"
A_InterfaceDefUID="INamedInstrument"
A_PropertyDefUID="MeasuredVariable"
B_InterfaceDefUID="INamedInstrument"
B_PropertyDefUID="InstrFuncModifier" />
</Instrument>

364 SmartPlant Instrumentation Administration Users Guide

SmartPlant Instrumentation Interface Language: An Overview

SmartPlant Instrumentation Interface


Language: An Overview
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. See Import Interface Languages, page 143 to learn
how the System Administrator adds an interface language. 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.

Related Topics

Import Interface Languages, page 143

Working with the Interface Language Common Tasks, page 366

SmartPlant Instrumentation Administration Users Guide 365

SmartPlant Instrumentation Interface Language: An Overview

Working with the Interface Language Common


Tasks
The Domain Administrator or the System Administrator can perform the following
tasks when working with the interface language of SmartPlant Instrumentation:
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 368.
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 368.
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 367.
Create New Customized Text Phrases
This option enables you to replace the phrases in the current interface text 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 New
Customized Text Phrases, page 369.
Related Topics

Import Interface Languages, page 143

SmartPlant Instrumentation Interface Language: An Overview, page 365

366 SmartPlant Instrumentation Administration Users Guide

SmartPlant Instrumentation Interface Language: An Overview

Edit Interface Text Phrases


Important

The System Administrator must first add the required language to the
database. You can purchase a language that you require as a separate addin.

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.
1. Start SmartPlant Instrumentation or the Administration module.

2. Click Tools > Edit Translation Text.


3. Do one of the following:

Click Open to navigate to the language file that contains the interface
text.

Click Retrieve to retrieve the interface text from the database.


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

Tips

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.

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 368.
5. Click Save File to save the edited interface text to a language file (a file with a
.psr extension).

6. Type the path and filename of the language file or navigate to an existing
language file.
7. Click OK in the displayed message and restart SmartPlant Instrumentation or the
Administration module for the changes to take effect.
8. Click OK to save the changes and return to the Edit Translation Text dialog
box.
9. Click Close.

SmartPlant Instrumentation Administration Users Guide 367

SmartPlant Instrumentation Interface Language: An Overview

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


4. Do one of the following:

Select the Optimize speed check box to speed up the translation


process. This allows the software to load the interface text to your
computer memory and retrieve it from there.

Clear the Optimize Speed check box to retrieve the interface text from
the database. This frees the memory resources but decreases the
performance.
5. Click OK to close the dialog box and change the interface language.

Related Topics

Working with the Interface Language Common Tasks, page 366

Replace the Interface Language with a Language from an


External File
Important
Use this procedure only if you experience memory problems while
working on your local computer.
1. Start SmartPlant Instrumentation or the Administration module.

2. Click Tools > Select Language.


3. Select Optimize speed.
4. Select Use file to retrieve the interface text from a previously saved file (saved in
.PSR format), and then do one of the following:

In the data field, type the path and filename of the appropriate
language file.

Click Browse to navigate to the language file.

368 SmartPlant Instrumentation Administration Users Guide

SmartPlant Instrumentation Interface Language: An Overview


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.
6. Click OK to close the dialog box and change the interface language.

Related Topics

Working with the Interface Language Common Tasks, page 366

Create New Customized Text Phrases


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.
1. Start SmartPlant Instrumentation or the Administration module.

2. Click Tools > Edit Translation Text.


3. Do one of the following:

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

SmartPlant Instrumentation Administration Users Guide 369

SmartPlant Instrumentation Interface Language: An Overview


5. To view the changes, switch to the appropriate language. For details, see Replace
the Interface Language with a Language from the Database.
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

Working with the Interface Language Common Tasks, page 366

Prefixes and Suffixes in the Interface Text


The following table contains information about the prefixes and suffixes that you can
use when customizing new interface text phrases.
Prefix/Suffix

Function

Syntax

&

Specifies a menu item.


Underlines the letter
following the '&'
symbol.

&[interface text] &Action

&&

Displays the '&'


symbol.

&&

~n

Starts a new line.

interface
~nContinue?
text]~n[interface
text]

~r

Starts a new paragraph


(functions like the
Enter key in Microsoft
Word). It is usually
used in conjunction
with ~n.

interface
text]~r[interface
text]

Warning~n~r

~t

Adds a tab entry

interface
text]~t[interface
text]

&Action~tCtrl+A

370 SmartPlant Instrumentation Administration Users Guide

Example

Operators &&
Functions

SmartPlant Instrumentation Interface Language: An Overview

SmartPlant Instrumentation Administration Users Guide 371

Commands and Controls

Commands and Controls


Access Rights Window Toolbar
Enables the Domain Administrator to access the most common commands available
when the Access Rights window is open.
Icon

Description
Saves the access rights definitions in the current domain.
Opens a pop-up window that displays all the available items and the level on
which they are defined.
Opens a dialog box where you can select a user group and grant access rights
globally.
Opens a dialog box where you can copy access rights from plants to plants,
from units to units, or from projects to projects if the domain type is Operating
owner.

372 SmartPlant Instrumentation Administration Users Guide

Commands and Controls

Access Rights Window


Enables the Domain Administrator to grant or deny access rights to SmartPlant
Instrumentation items and activities. Access rights are defined per user group and are
set for a particular plant hierarchy level. Examples of items include components of
SmartPlant Instrumentation, such as specifications, panels, cables, wires,
manufacturer, or location for the Instrument Index module, and so forth.
Project name (only available when the domain type is Operating owner) Allows
you to select a target project where you can define access rights for user groups.
Also, you can select As-Built to define access rights for user groups that exist in AsBuilt. If you want to grant access rights to a group assigned to a project, you must
also assign this group to As-Built.
Grant maximum access rights When a user belongs to more than one group,
you can grant the maximum level for all the access rights available to the user in all
the groups. If you clear the check box, the user receives minimum access rights
granted by all the groups.
Toolbar
Group list
Displays all the user groups defined in the current domain. For each group, access
rights are defined on three levels: domain, highest plant hierarchy level , and lowest
plant hierarchy level. The Domain Administrator defines plant hierarchy level name
in the Plant Hierarchy dialog box. The default highest level is Plant. The default
lowest level is Unit. Double-click a group to display the access levels.
Domain level Allows you to grant or deny access to the domain administration
tools and global items, such as supporting tables, default cable and panel managers,
UOM definitions, and so forth. When the domain type is Operating owner, in a
project or As-Built, access rights granted on the domain level do not apply.
<Plant> Level Allows you to grant or deny access to specific items and activities
that are defined on the highest plant hierarchy level. The label <Plant> changes
dynamically according to your highest plant hierarchy level definition.
Double-click the icon
to display the existing highest plant hierarchy level items,
and then select a specific item.
<Unit> Level Allows you to grant or deny access to specific items and activities
that are defined on the lowest plant hierarchy level. The label <Unit> changes
dynamically according to your lowest plant hierarchy level definition.
to display the existing lowest plant hierarchy levels, and
Double-click the icon
then select a specific item.

SmartPlant Instrumentation Administration Users Guide 373

Commands and Controls


Item or activity
Displays all the items and activities that are associated with the selected access rights
level. Each item or activity is then associated with a specific access mode. For more
details about the available items and activities, see Access Rights Descriptions.
Name Displays the items and activities for which you are defining access rights.
The contents of this list depend on the level you selected.
Mode Allows you to select the appropriate access mode to the selected item or
activity for the user group you chose in the Group list pane.
You can select one the following access modes to granted per item or activity:

Full Allows group users to add, delete, and modify data for the item
that you selected.

Modify Allows group users to add and modify data for the item that
you selected. Deletion is prohibited.

View Only Allows group users to view data for the item that you
selected, but does not allow editing the item in any way.

Access Denied Prevents group users from accessing the item that you
selected. You can apply this mode at the domain level if you need to deny
access to an entire module.

374 SmartPlant Instrumentation Administration Users Guide

Commands and Controls

Accounting Dialog Box


Enables the System Administrator to create a new accounting profile, or to modify or
delete an existing one. To access this dialog box, open the Domain Definition
window, select a domain, on the Options menu, click Add Accounting and then, in
the Add Accounting dialog box click Accounting.
Accounting name Allows you to select an existing account from this list or type
a new name after clicking New or Edit. Account names must be unique.
Accounting number Allows you to enter the account number, if needed.
Note Allows you to enter a short note if needed. To insert a carriage return, press
Ctrl + Enter.
Command Buttons
Apply Saves all the changes you have made.
New Allows you to define a new account. Clicking this button makes all the
fields accessible for editing.
Edit Allows you to modify the current account properties.
Delete Deletes the selected account.

Active Database Connections Dialog Box


This dialog box allows the System Administrator to view and print out a list of all the
active connections to the SmartPlant Instrumentation database on Oracle or SQL
Server.
Connections to the SmartPlant Instrumentation database
User Displays all the users who are connected to the SmartPlant Instrumentation
database. For each user, several database connections can exist.
Schema Name Displays the database schema name to which the user is
connected.
Client Machine Displays the name of the client machine from which the user is
connected to the database.
Application Displays the application name or executable file name of the
application that has a user connection to the SmartPlant Instrumentation database.

SmartPlant Instrumentation Administration Users Guide 375

Commands and Controls


Logon Data and Time Displays the date and time at which the connection has
been established. The date and time are displayed according to the regional settings
and date format defined on the database server.
Session ID Displays the connection session ID recorded in the SmartPlant
Instrumentation database. The Domain Administrator can then refer to the session ID
when clearing blocked sessions on Oracle or blocking sessions on SQL Server. For
details, see Clearing Locking Common Tasks, page 322 .
Print
Prints the list of the connected users without opening a print preview.

Activity Tracking Report Settings (Graph) Dialog Box


Enables you to select the options for generating a report in graphical format showing
usage of SmartPlant Instrumentation according to domain, module, and user. To
open this dialog box, with the System Administration window open, on the Reports
menu, point to Activity Tracking and click Graph.
Main category Allows you to select the main display information category:
Module, Domain, or User.
Secondary category Allows you select the secondary display information
category: Module, Domain, or User.
Period These options allow you to set the range of dates for the report you are
generating.
Domain list If you selected Domain from the Main category list, you can select
domains (up to a maximum of 10) to be included in the report.
User list If you selected User from the Secondary category list, you can select
users (up to a maximum of 10) to be included in the report.
Deleted domains The following options are available:

Ignore Allows you to display only the current domains in the report.

Include Allows you to include activity of a domain that has been


deleted from the system.

376 SmartPlant Instrumentation Administration Users Guide

Commands and Controls


Terminated activities These are activities where SmartPlant Instrumentation has
not been exited properly due to a power failure or re-booting the station; they only
have an estimated closing time. The options are:

Include Allows you to include terminated activities in the report.

Exclude Allows you to exclude terminated activities from the report.

Only Allows you to include only terminated activities in the report.

Graph type The following options are available:

Area Allows you to display a filled-area graph.

Bar Allows you to display a horizontal bar graph.

Column Allows you to display a vertical graph.

Pie Allows you to display a pie graph.

OK Opens the Print Preview window from which you can view and print out
the report.

SmartPlant Instrumentation Administration Users Guide 377

Commands and Controls

Activity Tracking Report Settings (Grid) Dialog Box


Enables you to set options for generating a report in tabular format showing usage of
SmartPlant Instrumentation according to domain, module, and user. To open this
dialog box, with the System Administration window open, on the Reports menu,
point to Activity Tracking and click Grid.
Main category Allows you to select the main display information category:
Module, Domain, or User.
Secondary category Allows you select the secondary display information
category: Module, Domain, or User.
Period These options allow you to set the range of dates for the report you are
generating.
Deleted domains The following options are available:

Ignore Allows you to display only the current domains in the report.

Include Allows you to include activity of a domain that has been


deleted from the system.

Terminated activities These are activities where SmartPlant Instrumentation has


not been exited properly due to a power failure or re-booting the station; they only
have an estimated closing time. The options are:

Include Allows you to include terminated activities in the report.

Exclude Allows you to exclude terminated activities from the report.

Only Allows you to include only terminated activities in the report.

OK Opens the Print Preview window from which you can view and print out
the report.

378 SmartPlant Instrumentation Administration Users Guide

Commands and Controls

Add Accounting Dialog Box


Enables the System Administrator to associate accounts with a domain or to
dissociate accounts from a domain. To access this dialog box, open the Domain
Definition window, select a domain, and then, on the Options menu, click Add
Accounting.
General List Displays all the accounts defined in your database. You can drag
an account to the Domain data window to associate this account with the current
domain.
Domain Displays a list of accounts associated with the current domain. You can
drag an account to the General List data window to dissociate this account from the
domain.
Apply Saves the definitions.
Accounting Opens a dialog box where you can define or modify accounting
information.

Add Client Dialog Box


Enables the System Administrator to associate clients with a domain or to dissociate
clients from a domain. To access this dialog box, open the Domain Definition
window, select a domain, and then, on the Options menu, click Add Client.
General List Displays all the clients defined in your database. You can drag an
client to the Domain data window to associate this client with the current domain.
Domain Displays a list of clients associated with the current domain. You can
drag a client to the General List data window to dissociate this client from the
domain.
Apply Saves the definitions.
Client Opens a dialog box where you can define or modify a client profile.

SmartPlant Instrumentation Administration Users Guide 379

Commands and Controls

Add Contractor Dialog Box


Enables the System Administrator to associate contractors with a domain or to
dissociate contractors from a domain. To access this dialog box, open the Domain
Definition window, select a domain, and then, on the Options menu, click Add
Contractor.
General List Displays all the contractors defined in your database. You can drag
a contractor to the Domain data window to associate this contractor with the current
domain.
Domain Displays a list of contractors associated with the current domain. You
can drag a contractor to the General List data window to dissociate this contractor
from the domain.
Apply Saves the definitions.
Contractor Opens a dialog box where you can define or modify contractor
properties.

Add Database Views Dialog Box


Displays user-defined database views that you can make available in a target domain
when initializing that domain using the current domain as a source.
Data Window Displays all the user-defined database views available in the
current domain. You can select one or more database views.
Apply Allocates the selected database views to the list in the User-Defined
Database views dialog box.

Add Datafiles (SQL Server) Dialog Box


Enables you to add new datafiles to a filegroup, Log group, and Tempdb group for
SQL Server.
To open this dialog box, with the System Administration window open, on the DBA
menu, click Add Datafiles.
System Admin. Password Allows you specify the appropriate SQL Server
Database System Administrator password. By default, the password box is empty.
Filegroup
This tab allows you to add new datafiles to a filegroup.

380 SmartPlant Instrumentation Administration Users Guide

Commands and Controls


Filegroup Allows you to select the filegroup to which you want to add a new
datafile.
Data Window Displays the read-only filegroup, file name, and data file location
information.
New file information Allows you to specify name and location, and the initial
size of the datafile. The options are:

Datafile name Allows you to enter the name of the new datafile that
you want to add.

Datafile location Allows you to specify the path on the file server
where the new datafile will be located. The file path must include the
drive and the datafile name.

Initial size Allows you to enter the initial size of the new datafile, in
MB.

Log Group
This tab folder allows you to add new datafiles to the Log group. For the option
descriptions, see the information for the Filegroup tab.
Tempdb
This tab folder allows you to add new datafiles to the Tempdb group. For the option
descriptions, see the information for the Filegroup tab.
Add
Adds the defined datafile to the filegroup, Log group, or Tempdb group.

SmartPlant Instrumentation Administration Users Guide 381

Commands and Controls

Add Datafiles (Oracle) Dialog Box


Enables you to increase the tablespaces on Oracle. You increase the database
tablespace by attaching additional datafiles to an existing tablespace if the system
reports that it has run out of space or fails to perform.
Tablespaces are database domains where Oracle stores your SmartPlant
Instrumentation database information. The tablespace data is physically stored in one
or more files. Increasing the tablespace size adds a file to that tablespace. Therefore,
make sure you have enough free disk space on the drive where the tablespace
datafiles are located.
To access this dialog box, with the System Administration window open, on the
DBA menu, click Add Datafiles.
Tablespace Allows you to select the required tablespace to which you want to
add a datafile.
Datafile name Allows you to enter the full path and name of the additional
datafile (in .db file format).
Note

The current tablespace datafile path appears by default. Make sure that
you select a datafile which is not currently in use.

Datafile size Allows you to enter the size of the additional datafile.

382 SmartPlant Instrumentation Administration Users Guide

Commands and Controls

Admin Schema Password Encryption Dialog Box


Enables the System Administrator to encrypt the Admin schema logon password.
When you install SmartPlant Instrumentation in a multi-user platform and configure
your database for the first time, the default Admin schema logon name and password
are automatically set as IN_DBAMN / IN_DBAMN and kept in the INTOOLS.INI
file. This file is accessible to all users. When encrypted, the Admin schema logon
name and password are kept away from the INTOOLS.INI file. This security
measure is especially useful in multi-user platforms as it will not allow users who log
on from external database utilities (using the default data) to view and modify logon
names and passwords. See Installation Guide, SmartPlant Instrumentation Database
Technical Review > Logon Data and Database Connection Security for more
information about database schemas in SmartPlant Instrumentation:
To access this dialog box, on the DBA menu, point to Security and click Admin
Schema Password Encryption.
Note

This dialog box is not available when using SmartPlant Instrumentation in


Sybase Adaptive Server Anywhere.

Admin schema logon name Displays the Admin schema logon name.
Admin schema logon password Allows you to type a new password for the
Admin schema.

Administration Window
Enables you to end the Administration module session or to re-enter the module
either as System Administrator or Domain Administrator. Clicking the toolbar icon
re-opens the Open Administration Module dialog box.

SmartPlant Instrumentation Administration Users Guide 383

Commands and Controls

Advanced Domain Preferences Dialog Box


Enables the Domain Administrator to set restrictions on preferences for the current
domain users. After setting the default preferences for this domain on the
Preferences Management dialog box, you set restrictions on various preferences by
enabling or disabling them on the Advanced Domain Preferences dialog box.
After you disable a preference option on the Advanced Domain Preferences dialog
box, the software automatically disables this option in the Preferences dialog box in
SmartPlant Instrumentation environment. Also, the software overwrites the user
setting with a setting that you define.
Users in the current domain can view the disabled preference options as read-only
default settings. However, individual users can customize the enabled preferences as
they need. They can do this in SmartPlant Instrumentation environment.
Data Window
Module/Feature Contains a list of SmartPlant Instrumentation modules and
features whose preferences the user can customize, within the SmartPlant
Instrumentation environment, on the Preferences dialog box.
Category Contains a list of categories. On the Preferences Management dialog
box, the category names correspond to the names of pages displayed after you expand
the hierarchy in the tree view pane. For example, the New Tag category corresponds
to the New Tag page of the Instrument Index preferences.
Sub Category Name Contains a list of preference options that users can
customize within the SmartPlant Instrumentation environment, on the Preferences
dialog box. The sub category names correspond to the names of the options within a
specific page of the Preferences Management dialog box.
Enabled When selected, indicates that users can customize the option that is
displayed beside this check box. You can select as many check boxes as you require.
By clearing a certain check box, you disable the adjacent preference option
customization in the current domain, so that the users working in that domain will
view these options as read-only.
Note

When you clear the Enabled check box for an property in a particular
domain, the user is unable to change the value of that item. If you enable
the same item in another domain and the user logs onto that domain, the
user sees the value that was set in the domain where the property was
disabled, and not the value from the current domain.

384 SmartPlant Instrumentation Administration Users Guide

Commands and Controls


Important

We recommend that you do not disable the temporary folder path option.
This is because in the temporary folder, the software creates temporary
files during various activities that users perform in SmartPlant
Instrumentation, for example, when creating specifications, generating
CAD drawings, hook-up drawings, reports, and so forth. If you prevent
users from specifying individual temporary folder paths, the temporary
folder path becomes shared among several users. This can cause problems
with data display when users perform the same activity at the same time,
for example, when creating two specifications at the same time.

Enable all Makes all the preference options available for customization in the
current domain.

Advanced Filter Definition (Cables) Dialog Box


Allows you to set additional filter definitions for the Cables and Cross Cables folder.
You can filter for cables according to their connections and for cables that are
connected to a specific Foundation or Profibus segment.
Connection criteria
Allows you to filter the cables according to their connections.
Look for connections Allows you to include the connection criteria in the filter
condition. This activates the check boxes under Connection and under Connected
to.
Note

Clear this check box if you do not want to include any of the connection
criteria in the filter condition. Clearing this check box disables the
Connection and the Connected to check boxes..

Connection Allows you to define a filter according to the cable connection:

No connections on either end Includes the cables that are not


connected to anything on both ends.

At least one wire connected on one end only Includes the cables that
contain at least one wire that is only connected on one of its ends.

At least one wire connected to both ends Includes the cables that
contain at least one wire that is connected on its both ends.

SmartPlant Instrumentation Administration Users Guide 385

Commands and Controls


Connected to Allows you to define a filter according to the type of panel that is
connected to the cable. This selection sets connection criteria for cables that have at
least one wire connected to one or both ends.

Junction boxes Includes all the cables that are connected to junction
boxes.

Marshaling racks Includes all the cables that are connected to


marshaling racks.

Cabinets Includes all the cables that are connected to cabinets.

Device panels Includes all the cables that are connected to device
panel.

DCS panels Includes all the cables that are connected to DCS panel.

PLC panels Includes all the cables that are connected to DCS panel.

Cable associations
Allows you to filter the cables according to their associations.
Fieldbus segment Allows you to filter for cables associated with a specific
Foundation Fieldbus or Profibus segment.
Display telecom cables only Allows you to filter for cables connected to
telecom items.
Related Topics

Explorer Windows: An Overview, page 183

Filter Definition Dialog Box, page 436

Merging Project and As-Built Data Common Tasks, page 230

Scoping Data for Projects Common Tasks, page 203

Advanced Filter Definition (Loops) Dialog Box


Allows you to set additional filter definitions for loop numbers that appear in the
Loops folder of the current explorer window. You can select one or more CAD
drawing blocks and only display those loops that contain the selected blocks as
associated sub-items.
Filter loops according to blocks
Blocks associated with tags Displays CAD drawing blocks that are associated
with loop tags. After you select one or more blocks, in the Loops folder of the
current explorer window, the software only displays loops whose blocks are
associated with the tags using the block-tag assignment method.

386 SmartPlant Instrumentation Administration Users Guide

Commands and Controls


Blocks associated with instrument types Displays CAD drawing blocks that are
associated with the instrument type of the loop tags. After you select these blocks, in
the Loops folder of the current explorer window, the software only displays loops
whose blocks are associated with the tags using the block-instrument type assignment
method.
Notes

If you need, you can select blocks from both data windows, that is, any
combination of blocks associated with instrument types and blocks
associated with instrument tag numbers.

In the Administration module, explorer windows do not include blocks.


Blocks only appear in the Domain Explorer, which you can open in
SmartPlant Instrumentation. In the Domain Explorer, blocks associated
with instruments 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 .

Display level for blocks


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

Explorer Windows: An Overview, page 183

Filter Definition Dialog Box, page 436

Merging Project and As-Built Data Common Tasks, page 230

Scoping Data for Projects Common Tasks, page 203

SmartPlant Instrumentation Administration Users Guide 387

Commands and Controls

Advanced Project Preferences Dialog Box


Enables the Domain Administrator to set restrictions on preferences for the users who
work in As-Built or projects. You select a project on the Preferences Management
dialog box, and define the default preferences for that project. Then, on the
Advanced Project Preferences dialog box, you set various restrictions by enabling
or disabling certain preference options for the selected project. Also, you can copy
project preference settings from the default preferences you have defined on the
Preferences Management dialog box. It is possible to copy project preferences to
one or more projects at a time.
After you disable a preference option on the Advanced Project Preferences dialog
box, the software automatically disables this option on the Preferences dialog box in
SmartPlant Instrumentation environment. Also, the software overwrites the user
setting with a setting that you define.
Project users can view the disabled preference options as read-only default settings.
However, individual users can customize the enabled preferences as they need. They
can do this in SmartPlant Instrumentation environment.
Data Window
Module/Feature Contains a list of SmartPlant Instrumentation modules and
features whose preferences the user can customize, within the SmartPlant
Instrumentation environment, on the Preferences dialog box.
Category Contains a list of categories. On the Preferences Management dialog
box, the category names correspond to the names of pages displayed after you expand
the hierarchy in the tree view pane. For example, the New Tag category corresponds
to the New Tag page of the Instrument Index preferences.
Sub Category Name Contains a list of preference options that users can
customize within the SmartPlant Instrumentation environment, on the Preferences
dialog box. The sub category names correspond to the names of the options within a
specific page of the Preferences Management dialog box.
Enabled When selected, indicates that users in the current project can customize
the option that is displayed beside this check box. You can select as many check
boxes as you require.

388 SmartPlant Instrumentation Administration Users Guide

Commands and Controls


By clearing a certain check box, you disable the adjacent preference option
customization in the current project, so that the users working in this project will view
these options as read-only.
Note

When you clear the Enabled check box for an property in a particular
project, the user is unable to change the value of that item. If you enable
the same item in another project and the user opens that project, the user
sees the value that was set in the project where the property was disabled,
and not the value from the current project.
Important

We recommend that you do not disable the temporary folder path option.
This is because in the temporary folder, the software creates temporary
files during various activities that users perform in SmartPlant
Instrumentation, for example, when creating specifications, generating
CAD drawings, hook-up drawings, reports, and so forth. If you prevent
users from specifying individual temporary folder paths, the temporary
folder path becomes shared among several users. This can cause problems
with data display when users perform the same activity at the same time,
for example, when creating two specifications at the same time.

Enable all Makes all the preference options available for customization in the
current project.
Copy To Opens the Copy to Projects dialog box, where you can copy the
current project preference settings to other projects in the Operating owner domain.
Copy From Opens the Copy from Projects dialog box, where you can overwrite
the current project preference settings with other project preferences.

<Area> Properties Dialog Box


Enables you to create a new item on an intermediate level of your plant hierarchy, or
modify properties of an existing item. You define the number of intermediate
hierarchy levels in the Plant hierarchy dialog box.
Also, you can assign custom field values to a specific item. The default intermediate
level item name is <area>.
Related Topics

<Plant> Properties Dialog Box, page 466

<Unit> Properties Dialog Box, page 518

Plant Design and Structure Common Tasks, page 151

Plant Hierarchy Explorer, page 464

SmartPlant Instrumentation Administration Users Guide 389

Commands and Controls

General Tab (<Area> Properties Dialog Box)


Enables the Domain Administrator to create a new intermediate level item or edit a
profile of an existing intermediate level item. The default intermediate level item
name is <area>.
Parent hierarchy Displays the plant hierarchy to which the current intermediate
level item belongs.
<Area> Allows you to enter or modify the name of the intermediate level item.
The name must be unique within the current node of the parent level. The name must
contain at least one character that is not space. The maximum name length is fifty
characters.
Note Allows you to enter a short note.
Related Topics

<Area> Properties Dialog Box, page 389

Custom Fields Tab (Plant Hierarchy Item Properties Dialog Box), page
390

Plant Design and Structure Common Tasks, page 151

Plant Hierarchy Explorer, page 464

Custom Fields Tab (Plant Hierarchy Item Properties Dialog Box)


Enables you to define up to twenty custom field values for the current plant hierarchy
item. 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.
For example, you can define custom field values for the current <units>, and then
select the appropriate custom field value when defining item naming conventions, so
that in SmartPlant Instrumentation, this field value appears as part of an item name
instead of the actual name of the <unit>.
Also, custom field values can appear associated with the appropriate plant hierarchy
items whenever the software runs macros:

In custom title blocks (macro hierarchy_udf_y_x_t for custom field


headers and macro hierarchy_udf_y_x for custom field values)

In CAD drawings

In drawings generated using the Enhanced Report Utility.

Parent hierarchy (not available for the highest plant hierarchy item) Displays
the plant hierarchy string to which the current item belongs.

390 SmartPlant Instrumentation Administration Users Guide

Commands and Controls


<Current plant hierarchy item> Displays the plant hierarchy item for which
you opened the Properties dialog box.
Custom fields from 1 to 15 Allow you to enter up to fifty characters in each box.
You can edit the definitions above the boxes using the options in the Custom Fields
dialog box. The default definitions are Custom field 1, Custom field 2, and so
forth.
Custom fields from 16 to 20 Allow you to enter up to one hundred characters in
each box. You can edit the definitions above the boxes using the options in the
Custom Fields dialog box. The default definitions are Custom field 16, Custom
field 17, and so forth.
Note

The software copies the custom fields (values and definitions) when
copying <unit> data.

Related Topics

<Area> Properties Dialog Box, page 389

<Plant> Properties Dialog Box, page 466

<Unit> Properties Dialog Box, page 518

Plant Hierarchy Explorer, page 464

Assign Groups to Project Dialog Box


Enables the Domain Administrator to assign group access rights to a particular
project. If you assign a group whose with full access rights for project activities,
these users become available for selection on the Project Activities dialog box, in the
Project Administrator list. You can then select a specific user and assign this user
to the project as Project Administrator.
To access this dialog box, on the Activities menu, click Assign Groups to Project.
Group list Contains all the groups created by the Domain Administrator. To
assign a group to the project displayed in the Project box, select a group name and
drag it to the Project groups pane.
Project Allows you to select a target project for assigning groups.
Project groups Contains the groups belonging to the project that you selected in
the Project list. To remove a group from the project displayed in the Project box,
select a group name and drag it to the Group list pane.

SmartPlant Instrumentation Administration Users Guide 391

Commands and Controls

Assign Users to Groups Dialog Box


Enables the Domain Administrator to assign SmartPlant Instrumentation users to a
group for the purpose of assigning the access rights that apply to the group to
individual users who belong to that group. If you use Windows authentication logon
method in the current domain, the software can assign users to groups automatically.
Note

When the domain type is Operating owner, the Project Administrator can
define user groups in As-Built and then, when creating a project using the
Project Activities dialog box, copy all the user groups from As-Built
automatically.

To access this dialog box, on the Activities menu, click Assign Users to Groups.
User list Contains all the users created by the System Administrator. To assign a
user to the group displayed in the Group box, select a user name and drag it to the
Group users pane.
Note

You can assign the same user to more than one group.

Group Allows you to select a target group for assigning users.


Group users Contains the users belonging to the group that you selected in the
Group list. To remove a user from the group displayed in the Group box, select a
user name and drag it to the User list pane.
Apply Saves the settings.
User Displays information about the selected user.

392 SmartPlant Instrumentation Administration Users Guide

Commands and Controls

Back Up Domain Dialog Box


Enables you to select a source domain for backup and start the backup process. You
can also view the current Oracle or SQL Server database properties.
To open this dialog box, in the Backup Repository dialog box, click Connect.
Notes

When backing up a domain, the software does not back up the audit trail
data. Therefore, before performing the domain backup, you must make
sure that you trimmed all the audit trail data. Then, you can back up the
trimmed audit trail data manually. For details, see SmartPlant
Instrumentation Installation and Upgrade Guide, Backup and Restore,
Backing up Files Containing Audit Trail Data.

Backup process is irreversible.

Database type Displays the source database type: SQL Server or a specific
Oracle version.
Server When using SQL Server, displays the name of the server machine where
the source data is located. When using Oracle, displays your Oracle instance alias.
Database name (only available when the source database type is SQL Server)
Displays your SQL Server database name located on the server machine that contains
the source data.
Administrator schema name Displays the Admin schema logon name of the
SmartPlant Instrumentation database.
Administrator schema password Displays the Admin schema logon password.
Domain Allows you to select a domain for a backup.
Save last created ID for merging renamed items Save the ID of the last created
item in the domain. The software allocates a unique sequential ID to each item that
you create. On merging data at a later stage, if the ID of an item is less than or equal
to the ID of the last created item, this indicates that the item was created in the
database prior to making the backup. Consequently, the Merger Utility is able to
identify the item by its ID, and can update renamed items if required, by selecting the
Include renamed items check box in the Merger dialog box.
If you clear this check box, the Merger Utility ignores any items that were renamed
since the backup, even if you select the Include renamed items check box, and
inserts the items as new records.

SmartPlant Instrumentation Administration Users Guide 393

Commands and Controls


Copy users to target domain Copies the SmartPlant Instrumentation user
definitions from the source domain to the target Sybase Adaptive Server Anywhere
database file.
Copy departments to target domain Copies the department definitions from the
source domain to the target Sybase Adaptive Server Anywhere database file.
OK Opens the Backup Information dialog box and starts the backup back
process. The Backup Information dialog box displays the domain name and the
Domain schema name of the backed up domain. The name that the software assigns
to the backed up domain is INtools_Backup. The Domain schema name and
password of the backed up domain are also INtools_Backup. You cannot change
these settings.
Notes

On completion of the backup process, the software records the errors in


the InitLog.txt file, located in the SmartPlant Instrumentation home folder.

In the target database, the domain type is the same as in the source
database.

Backup Repository Dialog Box


Using this dialog box, you select the INtools_Backup.db database or its copy as the
backup repository. You connect to the backup repository and to your the current
database that contains a domain you intend to back up.
You can back up any domain existing in an Oracle or SQL server source database to
the backup repository. The backup repository and its copies are only compatible with
the current version of SmartPlant Instrumentation. After you install a new service
pack for the current version, you can only use the backup repository that is shipped
with the service pack.
To open the dialog box, with the System Administration window open, on the File
menu, click Backup.
Important

The INtools_Backup.DB database can only contain one backed up


domain. Therefore, before backing up a domain data, we recommend that
you rename INtools_Backup.DB to <Master>.DB, and then, for each
backup process, make a copy of the <Master>.DB database with the name
INtools_Backup.DB. After backing up a domain, you should rename
INtools_Backup.DB. For example, if your source domain name is
Domain1, rename INtools_Backup.DB to Domain1.DB.

394 SmartPlant Instrumentation Administration Users Guide

Commands and Controls


If you have already used the INtools_Backup.db for a backup and forgot to make a
clean copy of INtools_Backup.db, you can obtain another INtools_Backup.db from
Intergraph Support, and then use it as a master database for making copies.
Notes

When backing up SmartPlant Instrumentation data, the software does not


back up all the audit trail data that was previously trimmed. If you want to
backup audit trail data, see SmartPlant Instrumentation Installation and
Upgrade Guide, Backup and Restore, Backing up Files Containing Audit
Trail Data.

If you work in thin client environment, for example, Citrix, you must copy
the INtools.ini file to the SmartPlant Instrumentation home folder on the
server machine to be able to perform a backup procedure. On backup
completion, remove the INtools.ini file from the server machine.

Target database name and path Allows you to specify the path for the
INtools_Backup.db database.
Browse Allows you to select the INtools_Backup.db database.
Connect Connects to the backup repository and opens the Source Database
dialog box, where you can select a domain for backup and start the backup process.

Change Password Dialog Box


Enables SmartPlant Instrumentation users to customize the SmartPlant
Instrumentation logon passwords. After changing the password you must notify your
System Administrator that you have done so. This is important because the System
Administrator can override your change and you will not be able to log on to
SmartPlant Instrumentation.
To access this dialog box, on the File menu, click Change Password.
Current password Type your current SmartPlant Instrumentation password.
New password Type the new password. You can use alphanumeric values in
either upper or lowercase (it is not case-sensitive). The maximum length of your
password can be 15 characters.
Verify new password Type the new password again.

SmartPlant Instrumentation Administration Users Guide 395

Commands and Controls

Clear Activity Tracking Data Dialog Box


Enables the System Administrator to clear activity tracking data which can be
selected according to time periods, users, domains, or modules. To open this dialog
box, on the DBA menu, click Clear Activity Tracking. To clear activity tracking,
you must select at least one check box.
Period Allows you to define a period of time for which you want delete activity
tracking data. In the From and To boxes, type the time range for which you want
delete activity tracking data.
Clearing this check box disables time restriction.
User Allows you to select a user whose tracking activity data you want to delete.
If you want to delete the tracking activity data of all users, clear this check box.
Domain name Allows you to select a domain whose tracking activity data you
want to delete.
If you want to delete the tracking activity data in all domains, clear this check box.
Module Allows you to select a module whose tracking activity data you want to
delete.
If you want to delete the tracking activity data in all modules, clear this check box.

Clear Locking in Selected Sessions Dialog Box


This dialog box allows the Domain Administrator to disconnect a user from
SmartPlant Instrumentation and close all the user's SmartPlant Instrumentation
sessions. You can use this option on SQL Server or on Oracle. When disconnecting
a user, you immediately stop all the following sessions of that user:

SmartPlant Instrumentation application session

The Administration module session

Import Utility

Merger Utility

The user's sessions in other applications are not affected. After disconnecting a user,
the records of the user's SmartPlant Instrumentation sessions remain in the
CURRENT_INFO table of your server database. If needed, you can manually clear
the session records. For more information, see Clear SmartPlant Instrumentation
Session Records.

396 SmartPlant Instrumentation Administration Users Guide

Commands and Controls


To access this dialog box, on the DBA menu, point to Locking and click Clear
Locking in Selected Sessions.
Database Displays the name of the current database.
User Allows you to select the user whose sessions you want to stop.
User initials Displays the user's initials.
Department Displays the department to which the user is assigned.
Note Displays the note the System Administrator has assigned to the user when
defining the user.
System Administrator Displays whether the user you want to disconnect has
been granted the System Administrator rights.
Apply Disconnects the selected user from SmartPlant Instrumentation.

Client Dialog Box


Enables the System Administrator to create a new client profile, or to modify or
delete an existing one. To access this dialog box, open the Domain Definition
window, select a domain, on the Options menu, click Add Client and then, in the
Add Client dialog box click Client.
Client Allows you to select a client name from this list or type a new client name
after clicking New or Edit. Client names must be unique.
Address 1 / Address 2 / City / State / Zip Code / Country Allows you to enter
the client's address in these fields after clicking New or Edit.
Phone / Fax / Email Allows you to enter the client's email, phone, and fax
numbers.
Note Allows you to enter a short note if needed. To insert a carriage return, press
Ctrl + Enter.
Command Buttons
Apply Saves all the changes you have made.
New Allows you to define a new client. Clicking this button makes all the fields
accessible for editing.
Edit Allows you to modify the current client definition.
Delete Deletes the selected client definition.

SmartPlant Instrumentation Administration Users Guide 397

Commands and Controls

Colors Dialog Box


Enables you to set the characteristic format (colors, bold, or italic) applied to the text
that is used to identify the item in various locations in SmartPlant Instrumentation
(for example, tag numbers listed in the Find Item dialog boxes).
Note

Color options do not apply to fieldbus segments or binder packages.


Fieldbus segments and binder packages that exist in As-Built are indicated
by bold font.

Item Category Shows the category of the item to be displayed in SmartPlant


Instrumentation using the characteristics shown in the Display Format column.
Display formats are available for the following categories:

Claimed items In As-Built, items that have been claimed for projects.
This category is only available when you select As-Built from the Project
list of the Project Activities dialog box.

As-Built items In the project that you selected, indicates As-Built


items when SmartPlant Instrumentation users open the current project with
As-Built items displayed.

Project items In the project that you selected, indicates project items
when SmartPlant Instrumentation users open the current project with AsBuilt items displayed.

Dummy items In the project that you selected, indicates dummy


items.

Display Format Shows a sample of the text characteristics (color, bold and
italic) used to display the item corresponding to the scope definition category. Click
Change to modify the display color for the appropriate item.
Copy From Allows you to select a project for copying its color display options
to the current project.

398 SmartPlant Instrumentation Administration Users Guide

Commands and Controls

Comparison List Dialog Box


Enables you to display the changes between data in the current project and in AsBuilt. To access this dialog box, in the Project Explorer, click Comparison List,
select one or more item types, and then click OK. A separate Comparison List
dialog box opens for each item type that you select. Changes are shown with a light
blue background with the upper value for As-Built and the lower value for the current
project.
When you run a comparison list for items belonging to a specific item type, you can
also compare changes for additional items associated with the main item. For details,
see Item Comparison Options.
Change action to Allows you to specify the action to be performed for a batch of
items on merging data. For details about the available merge actions and their
description, see Actions for Merging Items.
After you click OK in the dialog box, the changes to merge actions take effect in the
Merge Buffer. The software updates the display of items in the Merge Buffer as
follows:

If you change a merge action from Merge Now or Release Claim to Merge
Later, the software automatically removes this item from the Merge
Buffer.

If you change the action from Merge Later to Merge Now, the software
does not merge the item but only copies it and the associated sub-items to
the Merge Buffer.

For mode Allows you to select modes where the specified action is to be
applied. The modes refer to the changes made in the current project. The following
modes are available:

Inserted Indicates that a new record was inserted in the current project
which does not exist in As-Built. Deleting an existing record from AsBuilt is also equivalent to this.

Deleted Indicates that an existing record was deleted from the current
project. Inserting a new record from As-Built is also equivalent to this.

Updated Indicates that a record was modified in the current project or


As-Built.

Not changed Indicates that the record in the current project is identical
to the record in As-Built.

Data Window The data window columns show various data values for the item,
where changes are indicated by a light blue background.

SmartPlant Instrumentation Administration Users Guide 399

Commands and Controls


Command Buttons
Filter Opens a dialog box where you can filter items for the comparison list.
View Opens a dialog box where you can display data columns for the current
item.
Sort Opens a dialog box where you can sort the list of items by specified data
columns.
Report Opens a Comparison List Report print preview.
Info Displays summary information about the number of rows for each mode,
and the number of rows for each action to be performed (Merge Now or Release
Claim).
Options Opens a pop-up window for selecting sub-items (where available) for
which additional comparison reports can be generated. For sub-items, the specified
merge action is the same as the action set for the main item.

Comparison List Filter Dialog Box


Enables you to filter the items that are displayed in the Comparison List dialog box.
Data Window Allows you to enter filter parameters, or use the field list and
operators to build a filter condition.
Field list Displays all the available fields in the current source table. Doubleclick a field that you want to include in your filter condition, so that the field name
appears in the data window.
Operators & functions
Allows you to use built-in operators and functions. Click the appropriate operator or
function button to be added to the filter expression. The result is displayed in the data
window. The following options are available:
AND Includes the specified expression in the filter combination.
Example: (name <> '') AND (num <> 0)
OR Accepts either the previous or the following expression in the filter
combination.
Example: (loop = '') OR (line = '')
NOT Allows you to select the value opposite to the following expression.
Example: NOT (item_price = 0)

400 SmartPlant Instrumentation Administration Users Guide

Commands and Controls


LIKE Allows you to select a similar value that is similar to the one in the [value]
field. You can use wildcard characters: % for any combination of characters, or _
(underscore) for any single character.
Example: cmpnt_num LIKE '%AA%'
IN Allows you to select a value that is equal to one of those specified in the
parentheses.
Example: cpmnt_num = IN (101,103)
IS NULL Contains an undefined value. Select this option from the list and then
right-click it to add it to the filter expression.
Example: loop_name IS NULL
IS NOT NULL Indicates that the value is not equal to NULL. Select this option
from the list and then right-click it to add it to the filter expression.
Example: cpmnt_name IS NOT NULL
BETWEEN Allows you to select a value which is within the following interval.
Example: item_price BETWEEN 100 AND 500
=
Equal to.
Example: cpmnt_mfr = 'Shell'
>
Greater than.
Example: cmpnt_num > 101
<
Less than.
Example: item_price < 100
<>
Not equal to.
Example: prefix <>'AA'
>=
Greater or equal to.
Example: cmpnt_num >= 10
=<
Less than or equal to.
Example: item_price =< 30
SQL Functions drop-down list This drop-down list contains special functions
which are native to the source database. Select a function from this list and then
right-click it to be added to the filter expression.

SmartPlant Instrumentation Administration Users Guide 401

Commands and Controls

Comparison List Report Dialog Box


Displays a preview of the comparison list for specified items
Page Allows you to navigate back and forward through a multi-page report.
Print Sends the report to a printer.
Save As Saves the report in a format you specify.
Zoom Allows you to change the magnification of the report preview.

Contractor Dialog Box


Enables the System Administrator to create a new contractor profile, or to modify or
delete an existing one. To access this dialog box, open the Domain Definition
window, select a domain, on the Options menu, click Add Contractor and then, in
the Add Contractor dialog box click Contractor.
Contractor Allows you to select a contractor from this list or type a new
contractor name after clicking New or Edit. Contactor names must be unique.
Description Allows you to enter the contractor description, if needed.
Address 1 / Address 2 / City / State / Zip Code / Country Allows you to enter
the contractor's address in these fields after clicking New or Edit.
Phone / Fax / Email Allows you to enter the contractor's email, phone, and fax
numbers.
Note Allows you to enter a short note if needed. To insert a carriage return, press
Ctrl + Enter.
Command Buttons
Apply Saves all the changes you have made.
New Allows you to define a new contractor. Clicking this button makes all the
fields accessible for editing.
Edit Allows you to modify the current contractor definition.
Delete Deletes the selected contractor definition.

402 SmartPlant Instrumentation Administration Users Guide

Commands and Controls

Copy Data from Source Dialog Box


Enables you to create a new <unit> by copying data from an existing <unit>. You
can either copy all the source <unit> data, or define criteria for copying data from the
source <unit> modules, specific module items, or specific data, for example,
calibration.
To access this dialog box, in the Plant Hierarchy Explorer, open the <Unit>
Properties dialog box, click Copy From. Then, in the Select dialog box, select the
source <unit> from which you want to copy data and click OK.
The dialog box consists of the following sections:
Command Buttons
OK Copies the <unit> data to the target <unit>. Click this button only after you
have finished making data selection. Before clicking OK, you must select all the
module data that you want to be copied, make the required item name modifications,
revision and level settings.
Clear All Clears the copying settings for all the modules. Also, you need to click
this button if you have previously copied data to another <unit>, and access the Copy
Data from Source dialog box again. The software displays the previously defined
settings in the upper-right and lower-right sections.
Options Opens a dialog box where you can set new naming options for wiring
items.

Left Section (Copy Data from Source Dialog Box)


Contains the source unit modules, module items and data that you can select for
copying. The hierarchy of some modules is expandable like in the Windows
Explorer. The expandable modules allow you to select a specific module item, for
example, equipment, or tag number, and copy data only from this item. If you select
a module item, the lower-right section of the dialog box becomes available. Your
selection affects the option availability in the upper-right section and lower-right
section of the Copy Data from Source dialog box.
Related Topics

Copy Data from Source Dialog Box, page 403

Lower-Right Section (Copy Data from Source Dialog Box), page 405

Upper-Right Section (Copy Data from Source Dialog Box), page 404

SmartPlant Instrumentation Administration Users Guide 403

Commands and Controls

Upper-Right Section (Copy Data from Source Dialog Box)


Enables you to determine how to copy <unit> data from a module.
Module Shows the module data name that you selected in the left section of the
Copy Data from Source dialog box.
Copy all module data Allows you to copy all the module data that you selected
in the left section of the dialog box.
Important

Do not click OK until you have made all your selections.

Name prefix Allows you to enter a new name prefix to be applied to all the
copied items of the selected module. When copying data from a <unit> within the
same plant, you have to make sure that you do not have duplicate names for the
module items that you are going to copy. Therefore, you have to modify the module
item names. You can do this by adding either a prefix or a suffix to the item name.
Name suffix Allows you to enter a new name suffix to be applied to all the
copied items of the selected module. When copying data from a <unit> within the
same <plant>, you have to make sure that you do not have duplicate names for the
module items that you are going to copy. Therefore, you have to modify the module
item names. You can do this by adding either a prefix or a suffix to the item name.
Substituting name values To avoid having duplicate module item names, you
can modify their names by changing a part of the name. You can do this by
substituting a part of the name string with the value that you type in the following
fields:

Char. location Allows you to enter the number of character in the


name string from where you want the substitution to start.

No. of chars. Allows you to enter the number of characters in the name
string to be substituted.

Value Allows you to enter the new value that will substitute the old
one in the name string.

404 SmartPlant Instrumentation Administration Users Guide

Commands and Controls


Revision Copying Options (for the Process Data, Calculation, Specifications, and
Loop Drawings modules only) Determine how the software copies revision data.
The following options are available:

Skip Skips copying the source unit revisions.

Set new Allows you to click Copy Revisions and open a dialog box
where you can set new revisions for the target <unit>.

All existing Allows you to copy all the revisions that exist in the
selected module.

Copy on plant hierarchy level (for the Wiring module only) Determine the level
on which you want to copy the wiring data. You must select the highest level when
copying data from <units> belonging to different <plants>. This is required because
most wiring data is defined either per <area> or per <plant>. When copying data
from <units> belonging to the same <plant>, you can select the highest or the lowest
(recommended) level of your plant hierarchy. However, if you select the lowest
level, you need to modify the name strings to avoid duplicate names in the Wiring
module. The following options are available:

Highest Allows you to copy data from <units> belonging to different


<plants>.

Lowest Allows you to copy data from <units> belonging to the same
<plant>.

Related Topics

Copy Data from Source Dialog Box, page 403

Left Section (Copy Data from Source Dialog Box), page 403

Lower-Right Section (Copy Data from Source Dialog Box), page 405

Lower-Right Section (Copy Data from Source Dialog Box)


Enables you to determine how to copy source data from a specific module item or
specific module data. The options in this section are available after you after you
select and expand a module options in the left section and then select a module item
or specific data. Also, if in the left section, you select Specifications, you can
include all source specifications or specifications associated with specific item types.
Include (only available for the Specifications module) Allows you to copy
specifications associated with specific item types that are not reference item types.
Item Type of Specs (only available for the Specifications module) Displays the
item types available for generating specifications (only Instrument and Loop, which
are not reference item types).
Data Indicates the data or item name selection in the left section of the Copy
Data from Source dialog box.

SmartPlant Instrumentation Administration Users Guide 405

Commands and Controls


Copy selected data Allows you to copy specific data that you select after you
expand the appropriate module in the left section of the dialog box.
Note

Make sure that the Copy all module data check box is not selected. This
way you copy only the selected data and not the entire module data. You
can select specific items in the Instrument Index and Wiring modules.
Also, you can use this option to copy only the Process Data module or
only the Calculation module data by expanding Process Data &
Calculation in the left section and selecting a module.

Name prefix Allows you to enter a new name prefix to be applied to all the
copied items. When copying data from a <unit> within the same <plant>, you have
to make sure that you do not have duplicate names for the module items that you are
going to copy. Therefore, you need to modify the item names. You can do this by
adding either a prefix or a suffix to the item name.
Name suffix Allows you to enter a new name prefix to be applied to all the
copied items. When copying data from a <unit> within the same <plant>, you have
to make sure that you do not have duplicate names for the module items that you are
going to copy. Therefore, you have to modify the item names. You can do this by
adding either a prefix or a suffix to the item name.
Substituting name values To avoid having duplicate item names, you can
modify their names by changing a part of the name. You can do this by substituting a
part of the name string with the value that you type in the following boxes:

Char. location Allows you to enter the number of character in the


name string from where you want the substitution to start.

No. of chars. Allows you to enter the number of characters in the name
string to be substituted.

Value Allows you to enter the new value that will substitute the old
one in the name string.

Revision Copying Options (for process data and calculation data only)
Determine how the software copies revision data. The following options are
available:

Skip Skips copying the source unit revisions.

Set new Allows you to click Copy Revisions and open a dialog box
where you can set new revisions for the target <unit>.

All existing Allows you to copy all the revisions that exist in the
Process Data or Calculation modules.

406 SmartPlant Instrumentation Administration Users Guide

Commands and Controls


Prefix (for loop and tag number data only) Allows you to enter a loop or tag
number prefix to be used in the target <unit>. Use this option when copying loop or
tag number data from a <unit> within the same <plant>. This way you define a
distinctive loop or tag number prefix to be used in the target <unit> and avoid
creating duplicate loop and tag number prefixes in the <units> of the same <plant>.
Notes

For tag number items, the option is accessible only if the ISA or Loop
standard naming convention for the prefix segment description of tags is
COMPONENT PREFIX. For loop items, the option is accessible only if
the ISA or Loop standard naming convention for the prefix segment
description of loops is LOOP PREFIX.

This option is not applicable if you use Flexible standard naming


conventions in the source <unit>. For Flexible standard naming
conventions, you can define your target loop and tag number prefixes in
the Name prefix box.

Suffix (for loop and tag number data only) Allows you to enter a loop or tag
number suffix to be used in the target <unit>. Use this option when copying loop or
tag number data from a <unit> within the same <plant>. This way you define a
distinctive loop or tag number suffix to be used in the target <unit>.
Notes

For tag number items, the option is accessible only if the ISA or Loop
standard naming convention for the suffix segment description of tags is
COMPONENT SUFFIX. For loop items, the option is accessible only if
the ISA or Loop standard naming convention for the suffix segment
description of loops is LOOP SUFFIX.

If in your source unit there are loop names or tag numbers which are
different only in the suffix segment, these loop names and tag numbers
become identical in the target <unit>, for the new suffix value in the target
unit overwrites all the suffix values of the source <unit>.
For example, if in the Suffix box, you type 5, loop names 101-F-100\1,
101-F-100\2, 101-F-100\3 in the source <unit> become 101-F-100\5 in
the target <unit>.

This option is not applicable if you use Flexible standard naming


conventions in the source <unit>. For Flexible standard naming
conventions, you can define your target loop and tag number suffixes in
the Name suffix box.

Related Topics

Copy Data from Source Dialog Box, page 403

Left Section (Copy Data from Source Dialog Box), page 403

Upper-Right Section (Copy Data from Source Dialog Box), page 404

SmartPlant Instrumentation Administration Users Guide 407

Commands and Controls

Copy Access Rights Dialog Box


Enables the Domain Administrator to copy access rights data from one project to
another within a certain domain.
To access this dialog box, open the Access Rights window, and on the Options
menu, click Copy Access Rights.
Project and group selection
Source project (available only when the domain type is Operating owner)
Allows you to select a source project.
Source group Allows you to select the source group whose access rights you
want to copy.
Target project (available only when the domain type is Operating owner)
Allows you to select a target project.
Target group Allows you to the target group that will receive the source access
rights settings.
Access rights level
Domain Copies access rights that apply at the domain level.
<Plant> Copies access rights that apply at the highest plant hierarchy level. The
label <Plant> changes dynamically according to your highest plant hierarchy level
definition.
Source Allows you to select a <plant> to be used as a source for copying access
rights. The <plants> in the list are associated with the selected source project.
Target Allows you to select the target <plant> that will receive the source access
rights settings. The <plants> in the list are associated with the selected target project.
<Unit> Copies access rights that apply at the lowest plant hierarchy level. The
label <Unit> changes dynamically according to your lowest plant hierarchy level
definition.
Source Allows you to select a <unit> to be used as a source for copying access
rights. The <units> in the list are associated with the selected source project.
Target Allows you to select the target <unit> that will receive the source access
rights settings. The <units> in the list are associated with the selected target project.

408 SmartPlant Instrumentation Administration Users Guide

Commands and Controls

Copy From Dialog Box


Enables you to select a source item at a highest plant hierarchy level from which you
can copy your custom field definitions to another highest plant hierarchy level item
within the same domain. To access this dialog box, in the Custom Fields dialog box,
click Copy From.

Copy from Project Dialog Box


Enables you to select a project or As-Built for copying its color display options to the
project specified in the Project Activities dialog box. To open this dialog box, click
Copy From in the Colors dialog box.
Data Window Displays the existing project names. Allows you to select a
project from which you want to copy the color display options. You can also copy
the color display options from As-Built.
OK Copies the color display options to the current project and reopens the
Colors dialog box, where you must click Apply.

Copy from Project Dialog Box


Enables you to select a project in an Operating owner domain and copy its
preferences to the project that you select in the Preferences Management dialog
box.
To open this dialog box, in the Advanced Project Preferences dialog box, click
Copy From.
Project Displays the list of projects from which you can copy preferences to the
project selected in the Preferences Management dialog box. Select a source project.
Copy Copies the source project preferences to the current project.

Copy Naming Conventions From Dialog Box


Enables you to select a source <unit> in the current domain for the purpose of
copying naming conventions to the <unit> displayed in the Parent hierarchy box in
the Naming Conventions dialog box.
To access this dialog box, in the Naming Conventions dialog box, click Copy From.
Data Window Displays all the available plant hierarchy items that exist in the
source domain. The software displays the plant hierarchy items as defined in the

SmartPlant Instrumentation Administration Users Guide 409

Commands and Controls


Plant Hierarchy Explorer. You can expand and collapse the hierarchy by clicking
or beside the icons or by double-clicking the icons in the display.
The following icons indicate the various levels of the plant hierarchy:
Domain
<Plant>
<Area>
<Unit>

Copy Naming Conventions Dialog Box


Enables you to copy the naming conventions from the <unit> displayed in the Parent
hierarchy box in Naming Conventions dialog box to another <unit> that exists in
the current domain.
To access this dialog box, in the Naming Conventions dialog box, click Copy To.
Data Window Displays all the existing <units> in the current domain. Select the
check box beside a <unit> to which you want to copy the naming conventions.
Copy Copies the naming conventions.

Copy to Projects Dialog Box


Enables you to copy the current project preferences to other projects available in the
Operating owner domain.
To open this dialog box, in the Advanced Project Preferences dialog box, click
Copy To.
Project Displays the list of projects whose preferences you can overwrite. You
can select one or more target projects.
Select all Selects all the projects in the data window.
Copy Copies the preferences from the current project to the projects selected in
the Project data window.

410 SmartPlant Instrumentation Administration Users Guide

Commands and Controls

Custom Fields Dialog Box


Enables the Domain Administrator to make default definitions for custom fields
available in SmartPlant Instrumentation. Also, you can enable or disable the use of
custom fields in the Process Data module. In the Process Data module, custom fields
are fields that can be used in addition to the standard fields that appear in process data
sheet sections.
Custom fields are database fields that can be used in addition to the available standard
fields. Using custom fields, SmartPlant Instrumentation users can define additional
characteristics for items according to their own needs. For example, in the Browser
module, users can select custom fields when creating browser view styles. In the
Import Utility, users can select custom fields when setting import link properties.
For the Calibration module options, the domain administration settings determine the
field labels in the Custom frames of the Calibration Settings and Calibration Data
Entry windows.
To access this dialog box, with the Domain Administration window open, on the
Activities menu, click Custom Fields.
Note

The software applies custom fields on a per <plant> basis.

<Plant> Contains highest plant hierarchy level items in which you can make
custom field definitions. The label <Plant> changes dynamically according to your
highest plant hierarchy level definition.
Item type Contains item types and data types which you can select for defining
custom fields. When you define custom fields per item/data type, these fields become
available for selection in certain browsers. For a list of these browsers, see Browsers
That Can Contain Custom Fields.
You can select a plant hierarchy level name as an item and modify the default custom
field definitions for each of the twenty custom fields. A custom field definition is a
label that appears in the Custom Fields Tab (Plant Hierarchy Item Properties Dialog
Box). The default label is Custom field<number incremented from 1 to 20>.
The Item type list contains all the names of the plant hierarchy levels you created in
the Plant Hierarchy dialog box. The default hierarchy is Plant, Area, and Unit.
Items on each plant hierarchy level can contain up to twenty custom field values.
However, when modifying a custom field definition, the software applies the changes
at the hierarchy level to which the item belongs. For example, you can select Plant
and for Row Number 1, enter text My Custom Fields for PlantA. In the Custom
Fields tab of the <Plant> Properties dialog box, for the first custom field, the
software displays My Custom Fields for PlantA instead of the default definition
Custom field 1.

SmartPlant Instrumentation Administration Users Guide 411

Commands and Controls


Data Window
Contains all custom fields available in the SmartPlant Instrumentation database.
Number Displays the custom field sequence numbers in the data window.
Note

For process data custom fields, the values in the Number column do not
correspond to the custom fields sequentially. For details, see Sequence
Numbers and Process Data Custom Fields.

Visible (only available when you select Process Data from the Item type list)
Enables or disables custom fields used in process data sections.
Section Name (only available when you select Process Data from the Item type list)
Displays the default custom field definition in process data sections.
Definition Allows you to type a definition to be used as a new default definition
in SmartPlant Instrumentation.
Notes

When defining a browser view style, users can modify the definitions that
you make.

In browser views, custom field definitions appear as column headers. It is


not possible to display an apostrophe in a custom field header. If your
definition includes an apostrophe character, this character changes in the
heeder to a double quote character ". If your definition includes a double
quite character, it changes in the header to a tilde character ~. Other
special characters appear in custom field header as defined.

In process data sheets, custom field definitions appear to the left of the
custom filed boxes. Although it is possible to enter up to thirty characters
in custom filed definitions for process data sheets, long definitions that
contain wide or capitalized characters may be truncated. Using
engineering abbreviations is recommended to limit the length of the
custom field definitions.

Field Type Indicates the field type in the database.


Length Indicates for each field the maximum number of characters that users can
specify in SmartPlant Instrumentation. If needed, you can type a smaller value, and
thus, decrease the maximum allowed number of characters.

412 SmartPlant Instrumentation Administration Users Guide

Commands and Controls


Command Buttons
Apply Saves the current custom field selection to the database.
Copy From Opens a dialog box where you can select a <plant> from which you
can copy custom field definitions.
Print Prints out all custom field available for the selected item or data type.

Custom Tables Dialog Box


Custom tables are supporting tables that users can use when setting additional
attributes for tag numbers in the Instrument Index module. The Domain
Administrator uses this dialog box to enable users to work with additional supporting
tables for tag numbers at the plant level. Up to sixteen custom tables are available.
To access this dialog box, with the Domain Administration window open, on the
Activities menu, click Custom Tables.
Plant Allows you to select a plant from the list.
Custom table Enables the use of a custom table in the Instrument Index module.
After selecting a check box, type a unique table name in the adjacent box.

Database Upgrade Dialog Box


The System Administrator uses this dialog box to upgrade the Admin schema and the
available domains in the SmartPlant Instrumentation database after installing a newer
version of SmartPlant Instrumentation. For more information about upgrading your
database and application, see SmartPlant Instrumentation Installation and Upgrade
Guide.
The database upgrade is performed in two stages:

At the first stage, from the Logon Information dialog box, you click OK
to enter the Administration module as System Administrator, where the
software prompts you to upgrade the Admin schema and then opens the
Database Upgrade dialog box.

At the second stage, in the Domain Definition window, you select a


domain that you want to upgrade and click
to open the Database
Upgrade dialog box. You must upgrade all the domains in which you
want to work using this SmartPlant Instrumentation version.

SmartPlant Instrumentation Administration Users Guide 413

Commands and Controls


Admin schema upgrade
Admin schema (only available when upgrading the Admin schema) Displays the
Admin schema name that you want to upgrade.
Domain upgrade
Domain (only available when upgrading a domain) Displays the name of the
domain that you want to upgrade.
Miscellaneous Options
Current database version Displays the version of your current database. The
software displays the version number when opening the dialog box.
Upgrade to version Displays the version to which you want to upgrade your
SmartPlant Instrumentation database. The software displays the version number
when opening the dialog box.
Start time Displays the start time of the current upgrade session.
End time Displays the end time of the current upgrade session.
Current upgrade number Displays the number that indicates the database
operation that starts the current upgrade process.
Latest upgrade number Displays the latest upgrade number after beginning the
upgrade process. This number indicates the number of the database operation that
can start a future upgrade process.
Log file name Displays the name of the log file which is created in the default
path if you accept the default LOG.TXT file. As an alternative, you can click Browse
to navigate to an existing .txt file that you want to use as the log file.
Browse Opens the Select Log File dialog box, where you can navigate to the
required .txt file that you want to use as a log file.
OK Starts the upgrade process.

Data Files to Delete Manually Dialog Box


Enables you to view the list of data files that have to be deleted manually after you
delete an invalid domain on Oracle. You can also print out the list of data files. This
dialog box opens automatically, superimposed on the Delete Invalid Domain dialog
box, after the software completes deleting an invalid domain.

414 SmartPlant Instrumentation Administration Users Guide

Commands and Controls

Delete Invalid Domain Dialog Box


Enables the System Administrator to select a domain that needs to be deleted if its
initialization process failed to complete. You can use these options in a multi-user
platform.
Caution

If your database platform is SQL Server, in addition to displaying invalid


domains, the dialog box displays all valid schemas of other databases
residing in your database server. SmartPlant Instrumentation cannot
verify whether you selected an invalid domain or a valid schema of
another database. If you selected an invalid domain schema, you can
safely proceed with the domain deletion. Deleting a schema that does not
part of SmartPlant Instrumentation results in deleting data in the database
to which the schema belongs.

To access this dialog box, with the System Administration window open, on the
DBA menu, click Delete Invalid Domain.
Domain Contains a list of corrupted domains and allows you to select a domain
for deleting.
OK If the database platform is Oracle, the software begins the deletion process.
If the database platform is SQL Server, the software prompts you to check your
selection first.
Note

If the software detects a rollback segment problem, an error message


appears. In this case, click OK to accept the message and then, in the
Delete Invalid Domain dialog box, click OK again. If this kind of
message reappears, accept the message each time and then restart the
deletion process until you receive a message notifying you that the domain
has been deleted successfully.
Possible problems that cause the occurrence of the error messages are
insufficient disk space, non-optimal storage clause, or insufficient number
of rollback segments.

SmartPlant Instrumentation Administration Users Guide 415

Commands and Controls

Delete Projects Dialog Box


Enables the Domain Administrator to delete projects created in the Operating owner
domain. The Domain Administrator might want to delete the projects that contain
corrupted data or projects for which the initialization process failed to complete.
Also, when working in an integrated environment, you can delete projects with
Canceled or Merged status. For more information about the available statuses when
working in an integrated environment, see Set the Project Status for an Integrated
Environment.
To access this dialog box, enter an Operating owner domain as Domain Administrator
and then, on the DBA menu, click Delete Projects.
Delete project schema Determines how the software deletes engineering data:
with or without the project schema. To include deletion of the schema with the
project data, select this check box. If you clear the check box, the software deletes
engineering data only, so that you can then define new engineering data for the
project.
Data Window
Displays all projects available in the current Operating owner domain. If, in the
Operating owner domain, activities for working in an integrated environment are
enabled, this data window displays only projects with Canceled or Merged status.
Project Allows you to select one or more projects for deletion.
Project Administrator Displays the names of the Project Administrator.
Plant Displays the name of the plant associated with the project.
OK
Deletes engineering data for projects selected in the data window.

416 SmartPlant Instrumentation Administration Users Guide

Commands and Controls

Department Dialog Box


Enables the System Administrator to add departments, or to modify or delete existing
department profiles. All users must belong to a department. You assign users to
departments in the User dialog box.
User Displays the name of the user selected in the Assign Users to Groups
dialog box.
Department Select a department name that you want to modify or, type a new
department name after clicking New or Edit.
Description After clicking New or Edit, type a short department description.
Note Type a short note if needed after clicking Edit or New. To insert a carriage
return, press Ctrl + Enter.
Command Buttons
Edit Allows you to edit the profile of the department you selected from the
Department list.
New Allows you to create a new department.
Delete Deletes the department you selected from the Department list.

Domain Data and Indexes Dialog Box


Enables the System Administrator to specify the domain data settings and indexes on
a database server machine prior to starting the domain initialization process on SQL
Server.
Domain Displays the name that you specified in the Initialize dialog box.
Domain data
Domain file name Accept the displayed value or type another unique domain file
name. The name must be unique within the SmartPlant Instrumentation database.
Datafile name and path Accept the displayed value or type the full path and
name of the domain file. The default file extension is .mdf. You can change the file
extension as you require.
Initial size (MB) Accept the displayed size of the domain file. The displayed
size is 40 MB. The SQL Server Autoextend feature automatically increases the size
of this file if needed.

SmartPlant Instrumentation Administration Users Guide 417

Commands and Controls


Filegroup Accept the displayed name or type another unique filegroup name.
The name must be unique within the SmartPlant Instrumentation database. You
cannot use an existing filegroup when initializing a domain, but you can add
additional domain files to this filegroup from the Administration module.
Datafile folder path
Type the required folder path or accept the displayed default. If you change the
folder path in this box, the software automatically updates the datafile name and path
settings specified for the domain and index data.
Index data
Index file name Accept the displayed name or type another unique index file
name. The name must be unique within the SmartPlant Instrumentation database.
For example, if you have six domains in one database, you must have six different
index file names.
Datafile name and path Accept the displayed value or type the full path and
name of the domain file. The default file extension is .mdf. You can change the file
extension as you require.
Initial size (MB) Accept the displayed size of the index file. The displayed size
is 20 MB. The SQL Server Autoextend feature automatically increases the size of
this file if needed.
Filegroup Accept the displayed name or type another unique filegroup name.
The name must be unique within the SmartPlant Instrumentation database. You
cannot use an existing filegroup when initializing a domain, but you can add
additional domain files to this filegroup from the Administration module.
OK
Starts the initialization process.

418 SmartPlant Instrumentation Administration Users Guide

Commands and Controls

Dimensional Data Settings Dialog Box


Enables the System Administrator uses this dialog box to define the required
dimensional data settings for the current domain. These settings include the selection
of the required 3-D CAD application (PDMS, PDS, and so forth) and the selection of
the desired default action when a tag number's instrument type has been changed (in
cases where dimensional data exists for the instrument type).
To access this dialog box, open the Domain Definition window, select a domain, and
then, on the Activities menu, click Dimensional Settings.
3D CAD system Allow you to select a desired 3-D CAD application. The
following options are available:

PDMS Allows the use of a PDMS 3-D CAD application.

PDS Allows the use of a PDS 3-D CAD application.

No support Indicates that no 3-D model is being used in connection


with the dimensional data.

Instrument type change Allow you to set the default action for dimensional data
when a tag number's instrument type has been changed (in cases where dimensional
data exists for the instrument type). The following options are available:
Delete dimensional data Allows you to ensure redefinition of the dimensional
data associated with the tag number after its instrument type has been changed.
Mark data as suspected Keeps the dimensional data and marks it as suspected.

SmartPlant Instrumentation Administration Users Guide 419

Commands and Controls

Domain Administration Window


Enables you to access the domain administration options. This window opens after
you enter as the Domain Administrator in the Administration dialog box.
Toolbar Allows you to access the most common domain administration
commands and options available for Project Administrator.
Icon

Description
Closes the Domain Administration window.
Opens the Domain Definition window, where you can grant access rights,
select the domain logo, and so forth.
Opens the Project Activities dialog box. This icon is only available where the
domain type is Operating owner.
Opens a dialog box where you can define ownership of plants.
Opens a dialog box where you can define naming conventions for various
items.
Opens a window where you can define plant hierarchy items for each
hierarchy level available in the current domain.
Opens the Custom Fields dialog box, where you define custom fields for an
Instrument Index Standard Browser view.

Domain Definition Window (Domain Administration)


Enables the Domain Administrator to grant access rights, edit notes, and select the
logo for the current domain. Domain logo selection is not possible when the domain
type is Operating owner. All the options in this window (except for the Notes box)
are read-only and are accessible only by the System Administrator.
Domain Displays the name of the current domain.
Number Displays the name of the current domain (if specified).
Description Displays the description of the current domain (if specified).
Standard Displays the naming convention standard for the current domain.
Administrator Displays the user whom the System Administrator defined as
Domain Administrator.

420 SmartPlant Instrumentation Administration Users Guide

Commands and Controls


Domain schema name Displays the Domain schema logon name. The System
Administrator cannot change the logon name. It is created during domain
initialization.
Domain type
Displays the domain type defined by the System Administrator for the current
domain.
Operating owner In such a domain, an operational plant exists and most of the
activities are concerned with routine maintenance or plant modernization (revamps).
To facilitate plant modernization, a number of projects can be defined within the
domain. Each project is defined for one plant only, and a plant can have several
projects associated with it. The main body of data in the domain that includes
existing data together with any data that was integrated on completion of projects is
called As-Built. In this case, the database is partitioned into several schemas: a single
schema for As-Built and separate schemas for each project.

Exclusive claim mode Indicates whether a Project Administrator can


claim the same item for more than one project created in an Operating
owner domain or only for one project. If the System Administrator has
selected this check box, it is only possible to claim a particular item for
one project. It is possible, however, to claim this item for another project
after removing the item from the project for which it was claimed first
using the Release Claim merge action, or after merging the item with AsBuilt. If the check box is cleared, a Project Administrator can claim the
same item for more than one project, either directly from one project to
another, or from As-Built. This setting becomes permanently fixed in the
current domain after creating the first project in the current domain.

Merge without deleting from project Indicates whether a view-only


copy of that item remains in the project when the Project Administrator
merges a particular item with As-Built. After merging, it is not possible to
delete view-only copies. Existence of view-only copies does not prevent
the Project Administrator from deleting the project. When the check box
is cleared, the software automatically deletes the item from the project
when merging. This setting becomes permanently fixed in the current
domain after creating the first project in the current domain.

Engineering company Such a domain is usually contracted to design and build


plants based on process information. These are 'grass-roots' projects that usually
involve one set of data which may be revised extensively during the life-cycle of the
plant. In this case, the data for each project is maintained within a single database
schema.
Domain features
Activity tracking Indicates whether activity tracking options are enabled by the
System Administrator. For more information, see Activity Tracking Management
Common Tasks.
SmartPlant Instrumentation Administration Users Guide 421

Commands and Controls


Audit trail options Indicates whether the audit trail options are enabled by the
System Administrator.
Item registry Indicates whether the Domain Administrator can use the item
registry options available on the DBA menu (Data Maintenance sub-menu). To
learn more about the item registry in SmartPlant Instrumentation, see Item Registry
Activities Common Tasks.
Cable type dependency Indicates whether cable type dependency is enabled by
the System Administrator.
Single mode (on Oracle or SQL Server only) When the check box is selected, all
the items are unlocked. This improves the software performance, but enables
multiple users to work with the same item simultaneously. When the check box is
cleared, all the items are locked so that only one user at a time can work with the
same item.
Default plant use Indicates whether in the Plant Hierarchy Explorer, the plant
DEFAULT and all its hierarchy levels are available. If the System Administrator has
cleared this check box when making the domain definitions, SmartPlant
Instrumentation users cannot access the default plant. However, if required, the
System Administrator can switch the use of the default plant on or off when making
or modifying domain definitions.
Important

If you define a plant hierarchy with more than three levels, it is no longer
possible to use the default plant in this domain. In this case, the software
automatically clears the Default plant use check box.

If you intend to use SmartPlant Instrumentation in an integrated


environment, the System Administrator must clear this check box.

KKS mode Indicates whether KKS naming conventions are enabled by the
System Administrator.
Rule Manager Indicates whether the use of Rule Manager is enabled by the
System Administrator.

422 SmartPlant Instrumentation Administration Users Guide

Commands and Controls


Workflow
Instrumentation and process data Displays the workflow status selected by the
System Administrator. Workflow only applies where the selected domain type is
Engineering company. When the domain type is Operating owner, Domain
Administrator defines workflow in the Project Activities dialog box, at the level of
the projects in the domain.
The available workflow options are:

Full Indicates that all workflow options are activated, including


marking instrument tags for release as a formal issue in a binder package.
The Release to Spec option becomes available in the Document Binder
module and in the Spec Change Notification Options dialog box.

Without Document Binder Indicates that all workflow options are


activated, except for the option to release instrument tags as a formal issue
in a binder package.

None No workflow options are activated.

Specification title block


Custom title block assignment method Applies only to title blocks displayed in
specifications. The System Administrator can change this setting at any stage of your
domain life-cycle. The methods are:

Standard (used in all modules) Allows you to select one specific


custom title block to be assigned to all specifications, using the options in
the Report Management dialog box. After selecting this option, the
software hides all the title block assignment options that are available in
the Specifications module. If you assign the title block Specs default TB
with PB units to specifications, you then need to place the title block
correctly in a spec page layout. To do so, in the Preferences
Management 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 created in InfoMaker, you may need
to enter a different value, depending on the settings of the spec page
layout.

Special (used in Specifications module only) Allows users to assign


individual title blocks to any specification, using the title block assignment
options available in the Specifications module.

Plant hierarchy separator Displays the separator set by the System


Administrator. The separator appears where all or part of a plant hierarchy is
displayed as a string. For example, if the separator character is &, and you have plant
hierarchy items My Plant, My Area, and My Unit, in the Properties dialog box for
the My Unit item, the software displays the parent hierarchy as follows:
My Plant&My Area

SmartPlant Instrumentation Administration Users Guide 423

Commands and Controls


Global path
Global path box Displays the global path set by the System Administrator.
Allow to overwrite the global path Indicates whether the System Administrator
has enabled users to set user-defined paths in addition to the specified global path.
When the check box is selected, users are not restricted to setting new paths in
SmartPlant Instrumentation within the global path folder only.
Path for SmartPlant XML files Displays the location of the SmartPlant
Instrumentation map files: ContextMap.xml and IntoolsMap.xml, which are needed
for working in an integrated environment or using the point-to-point interfaces
between tools. The System Administrator can specify the XML path when making
domain definitions.
Miscellaneous Options
Notes Type notes or comments if you need.
Toolbar

Domain Definition Window Toolbar (Domain Administration)


Enables the Domain Administrator to access the most common commands available
when the Domain Definition window is open.
Icon

Description
Saves the changes made to the logo or notes.
Opens the Select Logo dialog box to select a different logo for the current
domain. When the domain is Operating owner, this icon is not available. A
Project Administrator needs to open the Project Activities dialog box, and
click the Logo button to define a project logo.
Makes the Notes box accessible for editing.
Opens the Access Rights window to grant or modify user access rights.

424 SmartPlant Instrumentation Administration Users Guide

Commands and Controls

Domain Definition Window (System Administration)


Enables the System Administrator to define a new domain or modify the definitions
for an existing domain. To access this window, with the System Administration
window open, on the File menu, click Domain. The options in the window become
accessible after you select an existing domain and click .
Domain Select a domain from this list or type a new domain name as needed.
Number Type a number for the domain if required.
Description Type a short description of the domain, if needed.
Standard Select the naming convention standard for the current domain.
Remember that you can do this only before you create the first tag number in any unit
defined in the current domain. You cannot change the naming convention standard
after creating the first loop or tag number. This rule does not apply to typical loops
and tags. For further details on naming conventions, see Naming Conventions
Common Tasks.
Administrator Select a user who will be the Domain Administrator.
Domain schema name Displays the Domain schema logon name. You cannot
change the logon name. It is created during domain initialization.
Domain type
Select the domain type depending on the activities you want to perform in your
engineering plants.
Important

We do not recommend working in an Operating owner domain if it resides


in a stand-alone database. It is known that when using the Sybase
Adaptive Server Anywhere database engine, certain options in an
Operating owner domain are liable to work incorrectly.

SmartPlant Instrumentation Administration Users Guide 425

Commands and Controls


Operating owner In such a domain, an operational plant exists and most of the
activities are concerned with routine maintenance or plant modernization (revamps).
To facilitate plant modernization, a number of projects can be defined within the
domain. Each project is defined for one plant only, and a plant can have several
projects associated with it. The main body of data in the domain that includes
existing data together with any data that was integrated on completion of projects is
called As-Built. In this case, the database is partitioned into several schemas: a single
schema for As-Built and separate schemas for each project.

Exclusive claim mode Allows a Project Administrator to claim a


particular As-Built item only for one project. It is possible, however, to
claim this item for another project after removing the item from the project
for which it was claimed first using the Release Claim merge action, or
after merging the item with As-Built. If you clear the check box, a Project
Administrator can claim the same item for more than one project created
in an Operating owner domain, either from one project to another, or from
As-Built.

Merge without deleting from project Allows a Project


Administrator to merge a particular item with As-Built and retain a copy
of that item in the project. If you select the Excusive claim mode check
box, it is still possible to claim such an item for a different project even
though there is copy of this item remaining in another project. If you clear
the check box, the software automatically deletes the item from the project
when merging.
Important

After creating a project, these settings become fixed in the Operating


owner domain.

Engineering company Such a domain is usually contracted to design and build


plants based on process information. These are 'grass-roots' projects that usually
involve one set of data which may be revised extensively during the life-cycle of the
plant. In this case, the data for each project is maintained within a single database
schema. Once a plant is operational, the domain type can be changed to Operating
owner if needed, and the owner can perform the necessary maintenance and
modernization.
Domain features
Activity tracking Enables the use of activity tracking. For more information,
see Activity Tracking Management Common Tasks.
Audit trail options Enables the use of audit trail options. For more information,
see Managing Audit Trail Data: An Overview.
Item registry Enables the Domain Administrator to use item registry options.

426 SmartPlant Instrumentation Administration Users Guide

Commands and Controls


Cable type dependency Enables cable type dependency. You can only select
this option if all default cables comply with the dependency requirements. You can
generate a Cable Type Dependency Validation report to display a list of all default
cables that do not comply with the dependency requirements. Also, make sure that in
the current domain, the properties of plant cables match the properties of the default
cables.
Single mode (on Oracle or SQL Server only) Improves the software performance
and switches to single mode. Switching to single mode unlocks all the database
objects. Therefore, more than one user can have access to the same item
simultaneously. There is no mechanism that prevents the occurrence of sharing
violation problems. Using the same database resource by more than one user can
cause database problems.
Note

If you want only one user at a time to work with the same item, you must
clear this check box. This way, when a user starts working with a specific
item, the software locks the item for other users.

Default plant use Allows you to enable or disable the use of the default plant in
the current domain. If you clear this check box, the plant DEFAULT and all its
hierarchy levels do not appear in the Plant Hierarchy Explorer. You can switch the
use of the default plant on or off when making or modifying domain definitions.
Important

If the Domain Administrator defines a plant hierarchy with more than


three levels in a particular domain, it is no longer possible to use of the
default plant in that domain. In this case, the software automatically clears
the Default plant use check box.

If you intend to use SmartPlant Instrumentation in an integrated


environment, you must clear this check box. This is because in the
OBJECT_REGISTRY table, all plant group ID numbers must be unique.
The software uses this table to work with the SmartPlant schema. In the
plant DEFAULT, the plant group ID numbers are not unique: the ID
number is 1 in all of the plant groups, that is Plant, Area, and Unit.

KKS mode Activates propagation of KKS names when KKS naming conventions
are used in the project.
Rule Manager Allows consistency and GUI rules created by Rule Manager to be
used in the project. For more information, see SmartPlant Instrument Rule Manager:
An Overview in the SmartPlant Instrumentation User's Guide, under Using Rule
Manager, SmartPlant Instrument Rule Manager: An Overview.

SmartPlant Instrumentation Administration Users Guide 427

Commands and Controls


Workflow
Instrumentation and process data Only applies where the selected domain type
is Engineering company. For the domain type Operating owner, the workflow is
defined at the level of the projects in the domain. The available workflow options
are:

Full Activates all workflow options, including marking instrument


tags for release as a formal issue in a binder package. The Release to
Spec option becomes available in the Document Binder module and in the
Spec Change Notification Options dialog box.

Without Document Binder Activates all workflow options, except for


the option to release instrument tags as a formal issue in a binder package.

None No workflow options are activated.

Specification title block


Custom title block assignment method Applies only to title blocks displayed in
specifications. You can change this setting at any stage of your domain life-cycle.
The methods are:

Standard (used in all modules) Allows the Domain Administrator to


select one specific custom title block to be assigned to all specifications.
After selecting this option, the software hides all the title block assignment
options that are available in the Specifications module.

Special (used in Specifications module only) Allows users to assign


individual title blocks to any specification, using the title block assignment
options available in the Specifications module.

Plant hierarchy separator Allows you to set a single-character separator for all
or part of a plant hierarchy is displayed as a string. For example, if the separator
character is &, and you have plant hierarchy items My Plant, My Area, and My
Unit, in the Properties dialog box for the My Unit item, the software displays the
parent hierarchy as follows:
My Plant&My Area
Global path
Global path box Displays the global path that you set for all users. If you
change the existing global path, all user-defined paths remain linked to the previous
global path. For example, if you change the global path from
\\APP_SERVER\SmartPlant Instrumentation to \\APP_SERVER_1\SmartPlant
Instrumentation, and a user has already specified a path to the PSR folder, in the
appropriate box, the user-defined path is displayed as a full path
\\APP_SERVER\SmartPlant Instrumentation\PSR. A global path does not apply to
individual temporary folder settings.

428 SmartPlant Instrumentation Administration Users Guide

Commands and Controls


Browse Allows you to navigate to the folder that you want to specify as the
global path folder. We recommend that you specify a path that complies with
universal naming conventions (that is, it starts with \\). If you want to use mapped
drives, make sure that all SmartPlant Instrumentation users have the same drive
mapping.
Allow to overwrite the global path Allows users to set user-defined paths in
addition to the specified global path. When the check box is selected, users are not
restricted to setting new paths in SmartPlant Instrumentation within the global path
folder.
Path for SmartPlant XML files Allows you to specify the location of the
SmartPlant Instrumentation map files: ContextMap.xml and IntoolsMap.xml, needed
for working in an integrated environment. These files are also needed when you are
working with interfaces to other tools. Click Browse to select the folder where the
SmartPlant Instrumentation map files are located.
Miscellaneous Options
Notes Type notes or comments if you need.
Toolbar

SmartPlant Instrumentation Administration Users Guide 429

Commands and Controls

Domain Definition Window Toolbar (System Administration)


Enables the System Administrator to access the most common commands available
when the Domain Definition window is open.
Note

All the icons except for


are inactive if DEFAULT is selected from the
Domain list. Select any other domain to make the icons active.
Icon

Description
Saves the definitions of the selected domain.
Upgrades your database after installing a new version of SmartPlant
Instrumentation. This icon is available only if the version of the domain you
selected from the Domain list is different from the Administration version.
Makes the options in this window accessible for editing.
Deletes the current domain and all the database tables associated with the
domain. This operation is irreversible, therefore it is recommended that you
back up a domain before deletion. For more information, see Back up a
Domain.
After domain deletion in Oracle, a message appears with the list of physical
tablespace datafiles that need to be deleted physically from the disk. If a
rollback segment problem occurs, the software displays an appropriate error
message. In this case, you need to restart the deletion process. For more
information, see Delete a Domain.
After domain deletion in SQL Server, the devices are left in place connected to
the database, and can be used for a new domain.

430 SmartPlant Instrumentation Administration Users Guide

Commands and Controls

Domain Tablespace Definition Dialog Box


Enables the System Administrator to define the tablespace data of a domain prior to
initializing this domain on Oracle.
Note
Note that the paths you specify in this dialog box refer to the local folders
(non-network folders) of the computer where Oracle is installed. Do not
use network drives or network server names in the paths.

Domain Displays the name that you specified in the Initialize dialog box.
Domain data
Tablespace name Accept the displayed value or type an appropriate domain
tablespace name.
Datafile name and path Accept the displayed value or type the full path and
name of the domain tablespace database file. The default file extension is .dbf. You
can change the file extension as you require.
Tablespace size (MB) Accept the displayed value or type the required domain
tablespace size.
Index data
Tablespace name Accept the displayed value or type an appropriate index
tablespace name.
Datafile name and path Accept the displayed value or type the full path and
name of the index tablespace database file. The default file extension is .dbf. You
can change the file extension as you require.
Tablespace size (MB) Accept the displayed value or type the required index
tablespace size.
OK
Starts the initialization process.

SmartPlant Instrumentation Administration Users Guide 431

Commands and Controls

List of Duplicate Items Dialog Box


Enables the Domain Administrator to view the items that will become duplicate in the
domain after import. These items will appear as duplicate in the target project.
To open this dialog box, on the Select Source Database dialog box, after connecting
to the source database, selecting the source domain, and before clicking Import, click
Report.
(Data Window)
Contains the items that are in use in other projects of the target domain, and also
appear in the source project. The data window does not display the As-Built items.
Item Displays the names of each duplicate item.
Target Project Displays the name of the target project in which each item will
be duplicates.
Command Buttons
Print Prints a report showing the list of items that will become duplicates after
import.
Save As Allows you to save the data in the dialog box to an external file.

432 SmartPlant Instrumentation Administration Users Guide

Commands and Controls

Edit Translation Text Dialog Box


Enables you to edit the terms and phrases in the interface text and/or create new
customized terms and phrases.
To access this dialog box, on the Tools menu, click Edit Translation Text.
Data Window
Original Phrase Contains the English interface text. You cannot edit the fields
in this column. All other columns in the data window contain phrases in the imported
languages. You can edit these fields if needed.
Custom Phrase Contains phrases from the imported language. Click a phrase
and edit it as needed.
Notes

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.

Make sure that you do not leave any blank fields, as the previous existing
interface language will remain in those fields after switching to the
language you are currently editing. By not leaving blank fields, you
prevent the occurrence of phrases belonging to more than one language
appearing in the interface.

Find phrase Allows you to type a text string that you want to find in the data
window. Press the ENTER key to execute the search.
Command Buttons
Retrieve Retrieves the interface text from the database. This button becomes
disabled after the interface text is retrieved.
Open Allows you to navigate to the language file from which the interface text
will be automatically retrieved. This button becomes disabled after the interface text
appears in the dialog box.
Update Saves the changes to the database. To view the changes, switch to the
appropriate language using the Select Language dialog box.
Save File Saves the data in an external language file.

SmartPlant Instrumentation Administration Users Guide 433

Commands and Controls

Items and Activities for Access Rights Dialog Box


Enables Domain Administrator to configure the items that will appear in the Access
Rights window for a selected project.
To open this dialog box, on the Activities menu, click Project Access Rights.
Note

In a project, access rights granted on the domain level do not apply. If you
want to grant access rights to a group assigned to a project, you must also
assign this group to As-Built.

Project Allows you to select a the project for which you can edit access rights.
Select all Allows you to select all the items and activities available in the data
window. This way, you set the software to display all the available items and
activities in the Access Rights window.
Data Window
Display Sets the software to display of a particular item in the Access Rights
window.
Item name Displays an inventory list of the items that exist within a particular
project. You can click the header to display the items in alphabetical order.
Item level Displays the level of a particular item: the whole project, or just to a
specific unit or plant. You can click the header to display the items by level.

Export Macros Dialog Box


Enables the Domain Administrator to export macros from a source database or
domain to a target database or domain via an intermediate text file. The exported data
can also contain typical tags. When exporting macros, this text file serves as a target
file, whereas when importing macros, the same file becomes a source file.
To access this dialog box, in the Domain Administration window, on the Add-Ins
menu, point to Import/Export Macros and click Export Macros.
Target database file and path Allows you to specify a target .txt file. You can
either create a new file by typing the file path and name or click Browse and navigate
to an existing file.
Include typical tags Allows you to export all existing typical tags along with the
macros into the selected .txt file.

434 SmartPlant Instrumentation Administration Users Guide

Commands and Controls

Field Personnel Profile Dialog Box


Enables the Domain Administrator to maintain a list of field maintenance employees.
It is also possible to add, delete, or modify the profile of any field employee.
To access this dialog box, on the Activities menu, click Field Personnel Profile.
Employee Name Contains names of employees. You can click New to add a
new employee name or click Edit to modify an existing name.
Group Name Contains names of groups to which the employees belong. You
can click New to add a new group name or click Edit to modify an existing name.
Apply Saves the definitions.
Edit Allows you to modify the selected employee name or group.
New Allows you to add a new field employee and group.
Delete Deletes the selected field employee and group.

Filegroup List Dialog Box


Enables you to view the SQL Server filegroups and print out filegroup information.
All the values displayed in this dialog box are read-only.
To access this dialog box, with the System Administration window open, on the
DBA menu, click Filegroup List.
Filegroup Displays the name of the filegroup.
Total Size (MB) Displays the total allocated size for each segment.
Free Space (MB) Displays the amount of free space available for the each
segment.
Free Space (%) Displays the percentage of free space available for the each
segment.
Print Prints out the displayed information.

SmartPlant Instrumentation Administration Users Guide 435

Commands and Controls

Filter Definition Dialog Box


Allows you to filter the display of items in the tree view of an explorer window.
Explorer windows are available in an Operating owner domain, when you define
items for claiming for projects or merging with As-Built. Filter settings take effect
only for the explorer window from which you opened the Filter Definition dialog
box.
You can select a hierarchy level and filter the display of the child items at the selected
level.
Note that the software retains the filter settings for a particular folder until you cancel
the filter for that folder.
Filter according to item name
Allows you to filter items according to an item name in the folder or at the hierarchy
level that you selected in the tree view.
Item name Allows you to type an item name by which to filter items in the tree
view. You can use the following wildcard characters to specify partial strings:
asterisk (*) or percent (%) for multiple characters and underscore (_) for single
characters. The value that you enter in this box overrides all other filter criteria in
this dialog box.
Filter according to item type
Allows you to specify a particular item type by which to activate the filter.
Filter name Allows you to type a name of the filter you are defining. This is a
required field.
Item type - Allows you to select an item type appropriate for the folder that you
selected. You must select an item type to be able to perform the filter operation.

Selected node definition Filters the child items that belong to a folder
or the items at any hierarchy level that you selected in the Explorer tree
view.

Global definition Allows you to define a filter for the entire tree view
of the active Explorer. The software applies this definition to the item
type you selected. Note that if you defined a filter definition for a specific
folder, the filter for the folder override the settings for the global filter
definition.

436 SmartPlant Instrumentation Administration Users Guide

Commands and Controls


Filter definition Allows you to define the criteria that you use to filter the items
displayed:

Property Allows you to select a property to use for filtering the items.

Operator Allows you to select the required comparison operator to


determine how the header selected under Property will relate to the
expression you select for Value.

Value Allows you to 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
Note

To reset the filter, delete the filter definition.

Command Buttons
Add Adds a new line for specifying a filtering condition.
Delete Deletes the selected filtering condition.
Verify Verifies the correctness of the entire filtering expression.
Reset Removes all filtering conditions so that you can re-enter a new filter
definition.
Advanced Allows you to define a special filter for cables or loops.
Related Topics

Advanced Filter Definition (Cables) Dialog Box, page 385

Advanced Filter Definition (Loops) Dialog Box, page 386

Explorer Windows: An Overview, page 183

Merging Project and As-Built Data Common Tasks, page 230

Scoping Data for Projects Common Tasks, page 203

SmartPlant Instrumentation Administration Users Guide 437

Commands and Controls

Find Item Dialog Box


Allows you to find an item in the tree view of an explorer window that you open to
claim items for a project, or merge items with As-Built. This dialog box 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.
Item Allows you to type a name of an item that you want to find.
As typed Makes the software look for an item as you type its name.
Search delay Sets the search delay that determines how long the software waits
after the last time you press a key on your keyboard.
Match case Instructs the software to find items whose names match the
capitalization of the item name you entered.
Find whole name only Instructs the software to search for occurrences that are
whole names and not part of a larger item name.
Related Topics

Explorer Windows: An Overview, page 183

Merging Project and As-Built Data Common Tasks, page 230

Scoping Data for Projects Common Tasks, page 203

Generate Access Rights Report Dialog Box


Enables the Domain Administrator to generate a report on access rights granted to the
selected user groups. You can either generate a report on a specific level or on all
levels. When the domain type is Operating owner, you can also generate a report on
the project level.
To access this dialog box, on the Reports menu, click Access Rights.
Select all Selects all the items displayed in the data window.
All Levels
Allows you to select specific user groups and generate a report on the access rights
granted to them on the domain level and also on all levels of your plant hierarchy.
Data Window The Group Name data window displays all the existing user
groups in the current domain. Select groups that you want to include in the report.

438 SmartPlant Instrumentation Administration Users Guide

Commands and Controls


Domain
Allows you to select specific user groups and generate a report on the access rights
granted to them on the domain level.
Data Window The Group Name data window displays all the existing user
groups in the current domain. Select groups that you want to include in the report.
Project
(only available when the domain type is Operating owner)
Allows you to select specific user groups and generate a report that displays access
rights granted on the project level or for As-Built.
Data Window Under Project Name, displays As-Built and all project that exist
in the Operating owner domain. Under Group Name, displays all user groups
defined in As-Built and in the projects. Select groups that you want to include in the
report.
<Plant>
Allows you to select specific user groups and generate a report on the access rights
granted to them on the <plant> level.
Data Window Displays all the existing user groups and the plants to which they
are assigned. Select groups that you want to include in the report.
<Unit>
Allows you to select specific user groups and generate a report on the access rights
granted to them on the <unit> level.
Data Window Displays all the existing user groups, <plants>, and <units> to
which user groups are assigned. Select groups that you want to include in the report.

SmartPlant Instrumentation Administration Users Guide 439

Commands and Controls

Global Access Rights Dialog Box


Enables the Domain Administrator to grant the same access rights to a group of users
on a specified level (domain level, highest or lowest level of the plant hierarchy).
The default highest level is <plant>. The default lowest level is <unit>.
It is also possible to grant the same access rights to all user groups on a specified
level. If you select the <plant> or <unit> level, you can also grant the same access
rights to all <plants> or <units> or to a specific <plant> or <unit> that you select.
The selected access right mode will then apply to a specific group that you select or to
all the user groups in the domain.
To open this dialog box, with the Access Rights window open, on the Options menu,
click Global Access Rights.
Access mode Allows you to set the appropriate access mode for the group
selected in the Group name list.
The following access modes are available:

Full (Add / Delete / Update) Allows group users to add, delete, and
modify data for the selected item.

Modify (Add / Update) Allows group users to add and modify data for
the selected item and group. Deletion is prohibited..

View Only Allows group users to view data for the selected item, but
cannot edit it in any way.

Access Denied Indicates that group users has no access to the selected
item. You apply this mode at the domain level to deny access to an entire
module, feature, or activity.

Group name Allows you to select a target user group for applying the access
mode you have set in the Access mode list. Also, you can select All to apply the
access mode to all the users in the current domain.
Domain level access rights
Enable item selection Allows you to apply the access mode to a specific item or
to all items belonging to the domain level.
Item Allows you to select a domain level item for which you want to grant global
access rights, according to the specified access mode. Also, you can select All to
grant access rights for all the items belonging to the domain level.

440 SmartPlant Instrumentation Administration Users Guide

Commands and Controls


Access rights on the level <Plant>
Enable item selection Allows you to select a <plant> and then apply the access
mode to a specific item or to all items belonging to the <plant> level.
<Plant> Contains a list of <plants> in the current domain. Select a target
<plant>. The label <Plant> changes dynamically according to your highest plant
hierarchy level definition.
Item Allows you to select a plant level item for which you want to grant global
access rights, according to the specified access mode. Also, you can select All to
grant access rights for all the plant level items.
Access rights on the level <Unit>
Enable item selection Allows you to select a <unit> and then apply the access
mode to a specific item or to all items belonging to the <unit> level.
<Unit> Contains a list of <units> in the current domain. Select a target <unit>.
The label <Unit> changes dynamically according to your lowest plant hierarchy level
definition.
Item Allows you to select a unit level item for which you want to grant global
access rights, according to the specified access mode. Also, you can select All to
grant access rights for all the <unit> level items.

Group Dialog Box


Enables the Domain Administrator to create a new group of users or modify the
profile of an existing group. Also, you can associate an existing Windows group with
a SmartPlant Instrumentation group. After that, any user who belongs to this
Windows group can access SmartPlant Instrumentation automatically, without having
to provide any logon information. This only take effect after the System
Administrator enables the use of Windows authentication logon method. For details,
see Windows Authentication Logon Method: An Overview.
To access this dialog box, on the Activities menu, click Group.
SmartPlant Instrumentation group After you click New or Edit, allows you to
select an existing SmartPlant Instrumentation group or type a new group name.
Description After you click New or Edit, allows you to enter a group
description.

SmartPlant Instrumentation Administration Users Guide 441

Commands and Controls


Windows group After you click New or Edit, allows you to enter the group
name of a Windows group that you want to associate with the specified SmartPlant
Instrumentation group. You need to define a Windows group if the System
Administrator has enabled the use of Windows authentication logon method, which
enables any user who belongs to this Windows group to access SmartPlant
Instrumentation automatically, without having to provide any logon information.
Note

This option only takes effect after the System Administrator enables the
use of Windows authentication logon method.

Apply Saves the group definitions.


Edit Allows you to modify the SmartPlant Instrumentation group definitions.
New Allows you to modify create a new SmartPlant Instrumentation group.
Delete Deletes a SmartPlant Instrumentation group that does not have associated
users. You cannot delete the default group ADMINISTRATORS. For details on
how to remove a user from a group, see Remove Users from Groups.

442 SmartPlant Instrumentation Administration Users Guide

Commands and Controls

Import Browser Views Dialog Box


Enables the Domain Administrator to import predefined browser view profiles. After
the Domain Administrator imports the views into the database, they become available
in the Browser Manager in SmartPlant Instrumentation.
To access this dialog box, open the Domain Administration window and on the
Add-Ins menu, click Import Browser Views.
Note

You can import only those predefined browser views that have been
purchased for an additional fee.

Source database
File name and path Allows you to specify the source database file. You can
type the file name and path or click Browse. The default file is IN_CTLOG.DB.
Connect Connects to the source database file.
Miscellaneous Options
Target plant Allows you to select the plant to which you want to add the
imported predefined browser views.
View Displays all available predefined browser views after you click Connect.
Select a view and click Import.
Import Imports the selected predefined browser views from the source database
file to your database. This button becomes accessible only after you click Connect.

SmartPlant Instrumentation Administration Users Guide 443

Commands and Controls

Import DCS Hardware I/O Library Dialog Box


Enables the Domain Administrator to import DCS hardware I/O data. The following
DCS hardware I/O libraries are available:

Yokogawa - CENTUM CS 1000

Yokogawa - CENTUM CS 3000

Honeywell - TDC 3000 - PM - FTAs

Foxboro - I/A - FBMs


Note

These libraries are add-ins that are supplied for an additional fee.

Source database
File name and path Allows you to specify the source database file. You can
type the file name and path or click Browse. The default file is IN_CTLOG.DB.
Connect Connects to the IN_CTLOG.DB file and displays the available panel
library in the Select panel library data window.
Miscellaneous Options
Select panel library Displays the available panel libraries after you connect to
the IN_CTLOG.DB file. Select the panel library that you want to add to your
database.
Import Imports the selected panel library to the database.

Import DDP Library Data for PDS Dialog Box


Enables you to import process connection data for the Dimensional Data for Piping
module.
Source database file name and path Allows you to specify the source database
file. You can type the file name and path or click Browse. The default file is
IN_CTLOG.DB.
Connect Connects to the source database file.
Import Imports the process connection data from the source database file to your
database.

444 SmartPlant Instrumentation Administration Users Guide

Commands and Controls

Import Hook-Up Library Dialog Box


Enables the Domain Administrator to import a hook-up item library to the database.
To access this dialog box, on the Add-Ins menu, click Import Hook-Up Library.
Source database
File name and path Allows you to specify the source database file. You can
type the file name and path or click Browse. The default file is IN_CTLOG.DB.
Standard Allows you to import standard SmartPlant Instrumentation hook-ups.
SHELL Allows you to import Shell Oil compatible hook-ups.
Connect Connects to the source database file.
Miscellaneous Options
Hook-up drawing path Allows you to specify the path to the drawings (if you
have a folder for the drawings) to avoid typing it each time you open a drawing in the
Hook-Ups module.
Plant Name Allows you to select a target plant in which SmartPlant
Instrumentation users will be able to work with the imported hook-up item library.
Import Imports the selected hook-up library from the source database file to
your database. The button becomes accessible after you click Connect.

Import Interface Language Dialog Box


Enables the System Administrator to import another interface language to SmartPlant
Instrumentation from an external database file. After adding the language, users can
then switch to that language.
To access this dialog box, on the Add-Ins menu, click Language.
Source database
File name and path Allows you to specify the source database file. You can
type the file name and path or click Browse. The default file is IN_CTLOG.DB.
Connect Connects to the source database file.
Miscellaneous Options
Language Displays the languages available in the language database file after
you click Connect.

SmartPlant Instrumentation Administration Users Guide 445

Commands and Controls


Import Allows you to add the selected language to the database. This button
stays disabled until you click Connect.
Overwrite previously imported items Allows you to overwrite the existing
terms and phrases of a language that you imported previously. You need to clear the
check box if you want to add new terms and phrases to the previously imported
language without overwriting any existing terms or phrases.

Import Macros Dialog Box


Enables the Domain Administrator to import macros from one database or domain to
another. Importing macros requires an intermediate text file that contains macros
exported from another database or domain. When importing macros, this file serves
as a source database file. The Domain Administrator can also import typical tags that
have been included in that source text file.
To access this dialog box, in the Domain Administration window, on the Add-Ins
menu, point to Import/Export Macros and click Import Macros.
Source database file and path Allows you to specify a source .txt file by typing
the file path and name or clicking Browse.
Include typical tags Allows you to import all typical tags located in the selected
.txt file.
Note

If the selected .txt file does not contain typical tags, do not select the
Include typical tags check box.

Import System Interfaces Dialog Box


Enables the Domain Administrator to import third party interfaces to SmartPlant
Instrumentation. These interfaces allow the Domain Administrator to transfer data to
and from a third-party system, such as FirstVue, Masoneilan, or SmartPlant P&ID.
You can either import external import links and the appropriate source codes or
import source codes only.
To access this dialog box, on the Add-Ins menu, click Import System Interfaces.
Source database
File name and path Allows you to specify the source database file. You can
type the file name and path or click Browse. The default file is IN_CTLOG.DB.
Connect Connects to the source database file.

446 SmartPlant Instrumentation Administration Users Guide

Commands and Controls


Miscellaneous Options
Source file path Allows you to specify the source file path. You can enter the
full path manually or click Browse.
Select link group Displays all available link groups after you click Connect.
Select a link group and click Import.
Import only source codes Allows you to import only the source codes.
Import typical instruments Allows you to include typical instrument