Professional Documents
Culture Documents
Administration
User's Guide
DSPI2-PE-200002A-Updated
Copyright
Copyright 1995-2009 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 from Intergraph Corporation.
Terms of Use
Use of this software product is subject to the End User License Agreement ("EULA") delivered with this software product unless the licensee
has a valid signed license for this software product with Intergraph Corporation. If the licensee has a valid signed license for this software
product with Intergraph Corporation, the valid signed license shall take precedence and govern the use of this software product. Subject to the
terms contained within the applicable license agreement, Intergraph Corporation gives licensee permission to print a reasonable number of
copies of the documentation as defined in the applicable license agreement and delivered with the software product for licensee's internal,
non-commercial use. The documentation may not be printed for resale or redistribution.
Trademarks
Intergraph, the Intergraph logo, PDS, SmartPlant, SmartMarine, FrameWorks, I-Convert, I-Export, I-Sketch, IntelliShip, INtools, ISOGEN,
MARIAN, SmartSketch, SPOOLGEN, SupportManager, and SupportModeler are trademarks or registered trademarks of Intergraph
Corporation or its subsidiaries in the United States and other countries. Microsoft and Windows are registered trademarks of Microsoft
Corporation. MicroStation is a registered trademark of Bentley Systems, Inc. Other brands and product names are trademarks of their
respective owners.
Contents
Working with the Administration Module.............................................................................................. 13
SmartPlant Instrumentation Database Setup for Oracle ...................................................................... 15
Oracle Database Server Tablespaces for SmartPlant Instrumentation.................................................. 16
Setting Up a Database for Oracle Common Tasks ............................................................................... 18
Set Up a SmartPlant Instrumentation Database for Oracle ................................................................... 19
Create a Database by Running the DB Setup SQL Script File ............................................................. 21
Clean Up the Oracle Database .............................................................................................................. 21
SmartPlant Instrumentation Database Setup for SQL Server ............................................................. 23
SQL Server Database Server Filegroups for SmartPlant Instrumentation ............................................ 24
Setting Up a Database for SQL Server Common Tasks ....................................................................... 25
Set Up a SmartPlant Instrumentation Database for SQL Server .......................................................... 26
Clean Up the SQL Server Database ...................................................................................................... 28
Domain Backup, Initialization, and Deletion .......................................................................................... 31
Domain Backup Common Tasks .......................................................................................................... 32
Back Up a Domain ......................................................................................................................... 33
Back Up a Domain from the Command Line................................................................................. 34
Back Up a Domain in Thin Client Mode ....................................................................................... 35
Workaround for the INtools_Backup.db Connection Problem in Windows Vista ........................ 36
Backing Up Files Containing Audit Trail Data .................................................................................... 37
Backing Up Audit Trail Data on Oracle ......................................................................................... 37
Backing Up Audit Trail Data on SQL Server ................................................................................ 39
Backing Up Audit Trail Data on Sybase Adaptive Server Anywhere ........................................... 40
Domain Initialization ............................................................................................................................ 41
Prerequisites for Domain Initialization .......................................................................................... 42
Domain Initialization Common Tasks ........................................................................................... 43
Domain Deletion Common Tasks......................................................................................................... 59
Delete a Domain ............................................................................................................................. 60
Delete an Invalid Domain on Oracle .............................................................................................. 60
Delete an Invalid Domain on SQL Server...................................................................................... 61
Troubleshooting Domain Initialization Common Tasks....................................................................... 61
Handle an Initialization Failure ...................................................................................................... 62
Workaround for an Initialization Problem in Windows Vista........................................................ 63
Numeric Character Settings for Oracle .......................................................................................... 63
Workaround for the Grant to View Creation Error ........................................................................ 64
Accessing the Administration Module ..................................................................................................... 67
Log on as System Administrator........................................................................................................... 67
Log on as Domain Administrator ......................................................................................................... 68
Switch from System Administration to Domain Administration.......................................................... 68
Contents
Switch from Domain Administration to System Administration.......................................................... 69
Users, Departments, and Groups ............................................................................................................. 71
Create and Manage Departments .......................................................................................................... 71
Define a SmartPlant Instrumentation User ........................................................................................... 72
Assign a Domain Administrator ........................................................................................................... 73
User Groups .......................................................................................................................................... 74
Users and Groups Common Tasks........................................................................................................ 74
Create a New Group ....................................................................................................................... 75
Modify the Profile of a Group ........................................................................................................ 76
Delete a Group ............................................................................................................................... 76
Assign Users to Groups .................................................................................................................. 76
Remove Users from Groups ........................................................................................................... 77
Windows Authentication Logon Method ....................................................................................... 77
Create a Group for Windows Authentication Logon Method ........................................................ 78
Remove Deleted Windows Users from SmartPlant Instrumentation User Groups ........................ 78
Switching to a Different Logon Method ........................................................................................ 79
System Administration.............................................................................................................................. 81
System Administration Common Tasks ............................................................................................... 81
Domain Management Common Tasks.................................................................................................. 82
Create an Owner Operator Domain ................................................................................................ 83
Make Domain Definitions .............................................................................................................. 84
Enable Cable Type Dependency .................................................................................................... 85
Enable Workflow ........................................................................................................................... 86
Activate the Audit Trail Functionality ........................................................................................... 87
Enable Item Registry ...................................................................................................................... 87
Specify a Global Path ..................................................................................................................... 88
Activity Tracking Management Common Tasks .................................................................................. 88
Set the Activity Tracking Mode ..................................................................................................... 89
Clear Activity Tracking Data ......................................................................................................... 89
Generate a Grid-Style Activity Tracking Report............................................................................ 90
Generate a Graph-Style Activity Tracking Report ......................................................................... 91
Managing Database Security ................................................................................................................ 92
SmartPlant Instrumentation Encryption Mechanism...................................................................... 92
Set Security Options ....................................................................................................................... 99
Database Locking Mode (for Multi-User Versions) ...................................................................... 99
Set Database Locking Mode......................................................................................................... 100
Maintaining the SmartPlant Instrumentation Database ...................................................................... 100
General Database Maintenance Common Tasks .......................................................................... 100
Database Maintenance on SQL Server Common Tasks............................................................... 105
Database Maintenance on Oracle Common Tasks ....................................................................... 107
Working in KKS Mode in SmartPlant Instrumentation ...................................................................... 110
Flow of Activities for Working in KKS Mode............................................................................. 112
System Administrator Activities .................................................................................................. 112
Domain Administrator Activities ................................................................................................. 112
Import Utility Activities ............................................................................................................... 113
Contents
Define KKS Naming Convention Using KKS Segments............................................................. 113
Example of a KKS Naming Convention for Loops...................................................................... 114
Loop Number Representation in the Domain Explorer of SmartPlant
Instrumentation............................................................................................................................. 114
Accounting, Contractors, and Clients Common Tasks ....................................................................... 115
Add and Manage Accounting Information ................................................................................... 115
Add and Manage Contractors ....................................................................................................... 116
Add and Manage Clients .............................................................................................................. 117
Associate Accounting, Client, and Contractor Information with a Domain ................................ 117
Print Database Connection Information.............................................................................................. 118
Report Generation (System Administration) ...................................................................................... 118
Domain and Project Administration ..................................................................................................... 119
Domain Administration Common Tasks ............................................................................................ 119
Plant Design and Structure ................................................................................................................. 121
Create a Plant Hierarchy .............................................................................................................. 122
Owner ........................................................................................................................................... 122
Create a Plant Hierarchy Item on the Highest Level .................................................................... 123
Create a Plant Hierarchy Item on an Intermediate Level ............................................................. 123
Create a Plant Hierarchy Item on the Lowest Level..................................................................... 124
Delete a Plant Hierarchy Item ...................................................................................................... 125
Owner Operator Domain (As-Built and Projects) .............................................................................. 125
Flow of Activities for Defining a Project Administrator.............................................................. 126
Owner Operator Domain (As-Built and Projects) Common Tasks .............................................. 128
Project Deletion Common Tasks .................................................................................................. 138
Explorer Windows .............................................................................................................................. 140
Working with Explorer Windows Common Tasks ...................................................................... 141
Search for Items ........................................................................................................................... 142
Find a Specific Item in the Tree View ......................................................................................... 143
Filter the Display of Items in an Explorer Window ..................................................................... 143
Filter Cables ................................................................................................................................. 144
Filter Loops According to Blocks ................................................................................................ 146
Add Items to My List in the Items Pane ....................................................................................... 147
Scoping Data for Projects ................................................................................................................... 147
Settings and Conditions for Claiming Items ................................................................................ 149
Scoping Data for Projects Common Tasks................................................................................... 153
Merging Project and As-Built Data .................................................................................................... 164
Open the Project Explorer and Merge Buffer............................................................................... 166
Item and Sub-Item Selection Options for Merging with As-Built ............................................... 167
Generating Reports for Merging Data Common Tasks ................................................................ 168
Copy Items to the Merge Buffer Common Tasks ........................................................................ 171
Merging Project and As-Built Data Common Tasks .................................................................... 174
Naming Conventions .......................................................................................................................... 182
Compatibility with Instrumentation Standards............................................................................. 182
Naming Conventions Common Tasks .......................................................................................... 183
Notes for Creating Naming Conventions for Wiring Items ......................................................... 184
Define Naming Conventions ........................................................................................................ 184
Copy Naming Conventions to Other <Units> .............................................................................. 187
Contents
Copy Naming Conventions from Another <Unit> ....................................................................... 187
Document Number Naming Convention Examples ..................................................................... 188
Generate Naming Convention Reports......................................................................................... 190
Wire End Naming Conventions ................................................................................................... 190
Access Rights...................................................................................................................................... 193
Access Rights Common Tasks ..................................................................................................... 194
Access Rights Descriptions .......................................................................................................... 195
Grant Access Rights for Selected Items or Activities .................................................................. 204
Grant the Same Access Rights for All Items ................................................................................ 205
Workflow Access Rights .............................................................................................................. 206
Copy Access Rights ..................................................................................................................... 207
View the Items in the Current Domain ........................................................................................ 207
Generate Access Rights Report .................................................................................................... 207
Preferences Management .................................................................................................................... 207
Managing Preferences Common Tasks ........................................................................................ 208
Set Domain Preferences ............................................................................................................... 209
Set Project Preferences ................................................................................................................. 209
Copy Project Preferences ............................................................................................................. 210
Export Preferences ....................................................................................................................... 211
Import Preferences ....................................................................................................................... 211
Report Management ............................................................................................................................ 211
Report Management Common Tasks ........................................................................................... 212
Associate a New Title Block with a Report ................................................................................. 212
Title Block Descriptions............................................................................................................... 213
Set Archiving Options for Report Comparison ............................................................................ 214
Define Report Revision Management Settings ............................................................................ 215
Add-Ins ............................................................................................................................................... 217
Import Hook-Up Libraries ........................................................................................................... 217
Import System Interfaces ............................................................................................................. 218
Import Browser Views ................................................................................................................. 219
Import DCS Hardware I/O Library Data ...................................................................................... 219
Import DDP Library Data ............................................................................................................ 220
Export Macros .............................................................................................................................. 220
Import Macros .............................................................................................................................. 221
Import Spec Forms ....................................................................................................................... 221
Miscellaneous Domain Administration Tasks .................................................................................... 223
Define Panel Location Levels ...................................................................................................... 224
Assign Icons to Telecom Device Types ....................................................................................... 225
Define Custom Fields ................................................................................................................... 226
Sequence Numbers and Process Data Custom Fields .................................................................. 227
Copy Custom Fields ..................................................................................................................... 228
Browsers That Can Contain Custom Fields ................................................................................. 228
Define Custom Tables .................................................................................................................. 230
Generate Domain Administration Reports ................................................................................... 231
Select a Logo ................................................................................................................................ 232
Define Field Personnel Profiles .................................................................................................... 232
Modify Domain Notes .................................................................................................................. 233
Modify Printer Settings ................................................................................................................ 233
Contents
Managing Audit Trail Data ................................................................................................................. 234
Managing Audit Trail Data Common Tasks ................................................................................ 234
Load Audit Trail Data .................................................................................................................. 235
Trim Audit Trail Data .................................................................................................................. 236
External Files with Trimmed Audit Trail Data ............................................................................ 236
Define Paths When Using Oracle ................................................................................................. 237
Define Paths When Using SQL Server ........................................................................................ 237
Define Paths When Using Sybase Adaptive Server Anywhere ................................................... 238
Clearing Locking ................................................................................................................................ 238
Clearing Locking Common Tasks ................................................................................................ 239
Clear Locking per User ................................................................................................................ 240
Clear Blocked Sessions on Oracle................................................................................................ 240
Clear Locking in All Sessions ...................................................................................................... 240
Clear SmartPlant Instrumentation Session Records ..................................................................... 241
Copying Data ...................................................................................................................................... 241
Flow of Activities for Copying Data ............................................................................................ 243
Copying Data Common Tasks ..................................................................................................... 243
Select the Source Plant Hierarchy Item for Copying Data ........................................................... 244
Copy Specific Data....................................................................................................................... 244
Copy All Module Data ................................................................................................................. 246
Set Wiring Naming Options for Target Plant Hierarchy Item ..................................................... 247
Set Revisions for Target Plant Hierarchy Item ............................................................................ 248
Working with SmartPlant Integration .................................................................................................. 251
Configuring SmartPlant Instrumentation for Integration .................................................................... 252
Integration Common Tasks ................................................................................................................. 252
Configure SmartPlant Instrumentation for Integration................................................................. 253
Define an IDEAL User ................................................................................................................. 255
Retrieve a Plant Hierarchy ........................................................................................................... 255
Register a Plant............................................................................................................................. 256
Define Settings for an Integrated Environment .................................................................................. 257
Item Registry Activities ...................................................................................................................... 257
Item Registry Activities Common Tasks ............................................................................................ 258
Register Items ............................................................................................................................... 258
Clean Up Item Registry ................................................................................................................ 259
Tool Requirements for Integrating SmartPlant Instrumentation......................................................... 259
General Integration Requirements................................................................................................ 259
Naming Convention Requirements for Integration ...................................................................... 259
Working with SmartPlant P&ID .................................................................................................. 263
Working with SmartPlant Electrical............................................................................................. 264
Using Projects in an Integrated Environment............................................................................... 265
Naming Convention Mapping ...................................................................................................... 266
Define Revision Source for an Integrated Environment ..................................................................... 267
SmartPlant Instrumentation Interface Languages .............................................................................. 269
Interface Languages Common Tasks .................................................................................................. 270
Import a New Interface Language ...................................................................................................... 270
Contents
Replace the Interface Language with a Language from the Database ................................................ 271
Replace the Interface Language with a Language from an External File ........................................... 271
Translate Interface Text Phrases ......................................................................................................... 272
Prefixes and Suffixes in the Interface Text ......................................................................................... 273
Windows and Dialog Boxes .................................................................................................................... 275
A ......................................................................................................................................................... 275
Access Rights Window Toolbar ................................................................................................... 276
Access Rights Window ................................................................................................................ 276
Accounting Dialog Box ................................................................................................................ 277
Active Database Connections Dialog Box ................................................................................... 278
Activity Tracking Report Settings (Graph) Dialog Box............................................................... 278
Activity Tracking Report Settings (Grid) Dialog Box ................................................................. 279
Add Accounting Dialog Box ........................................................................................................ 280
Add Client Dialog Box ................................................................................................................. 280
Add Contractor Dialog Box ......................................................................................................... 280
Add Database Views Dialog Box ................................................................................................. 281
Add Datafiles (SQL Server) Dialog Box ..................................................................................... 281
Add Datafiles (Oracle) Dialog Box .............................................................................................. 282
Administration Window ............................................................................................................... 282
Advanced Domain Preferences Dialog Box ................................................................................. 282
Advanced Filter Definition (Cables) Dialog Box......................................................................... 283
Advanced Filter Definition (Loops) Dialog Box ......................................................................... 284
Advanced Project Preferences Dialog Box .................................................................................. 285
Area Properties Dialog Box ......................................................................................................... 286
Assign Groups to Project Dialog Box .......................................................................................... 287
Assign Users to Groups Dialog Box ............................................................................................ 287
B .......................................................................................................................................................... 288
Back Up Domain Dialog Box ...................................................................................................... 288
Backup Repository Dialog Box.................................................................................................... 289
C .......................................................................................................................................................... 290
Change Admin Schema Password Dialog Box ............................................................................ 291
Change Domain Schema Password Dialog Box .......................................................................... 291
Change Security Schema Password Dialog Box .......................................................................... 291
Change Password Dialog Box ...................................................................................................... 292
Clear Activity Tracking Data Dialog Box .................................................................................... 292
Clear Locking in Selected Sessions Dialog Box .......................................................................... 292
Client Dialog Box......................................................................................................................... 293
Colors Dialog Box ........................................................................................................................ 293
Comparison List Dialog Box........................................................................................................ 294
Comparison List Filter Dialog Box .............................................................................................. 295
Comparison List Report Dialog Box ............................................................................................ 296
Contractor Dialog Box ................................................................................................................. 296
Copy Data from Source Dialog Box ............................................................................................ 297
Copy Access Rights Dialog Box .................................................................................................. 301
Copy From Dialog Box ................................................................................................................ 302
Copy from Project Dialog Box..................................................................................................... 302
Copy from Project Dialog Box..................................................................................................... 302
Contents
Copy Naming Conventions From Dialog Box ............................................................................. 302
Copy Naming Conventions Dialog Box ....................................................................................... 303
Copy to Projects Dialog Box ........................................................................................................ 303
Custom Fields Dialog Box ........................................................................................................... 303
Custom Tables Dialog Box .......................................................................................................... 305
D ......................................................................................................................................................... 305
Database Upgrade Dialog Box ..................................................................................................... 306
Data Files to Delete Manually Dialog Box .................................................................................. 307
Delete Invalid Domain Dialog Box .............................................................................................. 307
Delete Projects Dialog Box .......................................................................................................... 307
Department Dialog Box ............................................................................................................... 308
Domain Data and Indexes Dialog Box ......................................................................................... 308
Dimensional Data Settings Dialog Box........................................................................................ 309
Domain Administration Window ................................................................................................. 310
Domain Definition Window (Domain Administration) ............................................................... 310
Domain Definition Window Toolbar (Domain Administration).................................................. 314
Domain Definition Window (System Administration) ................................................................ 314
Domain Definition Window Toolbar (System Administration) ................................................... 319
Domain Tablespace Definition Dialog Box ................................................................................. 320
E .......................................................................................................................................................... 321
Export Macros Dialog Box .......................................................................................................... 321
F .......................................................................................................................................................... 322
Field Personnel Profile Dialog Box.............................................................................................. 322
Filegroup List Dialog Box............................................................................................................ 322
Filter Definition Dialog Box ........................................................................................................ 322
Find Item Dialog Box ................................................................................................................... 324
G ......................................................................................................................................................... 324
Generate Access Rights Report Dialog Box ................................................................................ 324
Global Access Rights Dialog Box ................................................................................................ 325
Group Dialog Box ........................................................................................................................ 326
I ........................................................................................................................................................... 327
Import Browser Views Dialog Box .............................................................................................. 327
Import Spec Forms Dialog Box.................................................................................................... 328
Import DCS Hardware I/O Library Dialog Box ........................................................................... 329
Import DDP Library Data Dialog Box ......................................................................................... 329
Import Hook-Up Library Dialog Box .......................................................................................... 329
Import Interface Language Dialog Box........................................................................................ 330
Import Macros Dialog Box .......................................................................................................... 330
Import System Interfaces Dialog Box .......................................................................................... 330
Initialize (Oracle) Dialog Box ...................................................................................................... 331
Initialize (SQL Server) Dialog Box.............................................................................................. 333
Initialize (Sybase Adaptive Server Anywhere) Dialog Box......................................................... 334
Items and Activities for Access Rights Dialog Box ..................................................................... 336
L .......................................................................................................................................................... 337
List of Duplicate Items Dialog Box ............................................................................................. 337
Load Audit Trail Data Dialog Box ............................................................................................... 337
Log File Dialog Box ..................................................................................................................... 338
M ......................................................................................................................................................... 338
Contents
Microsoft SQL Server Connection Dialog Box ........................................................................... 338
N ......................................................................................................................................................... 339
Naming Conventions Dialog Box ................................................................................................ 339
O ......................................................................................................................................................... 342
Open Administration Module Dialog Box ................................................................................... 342
Optimize Indexes (Oracle) Dialog Box ........................................................................................ 342
Optimize Indexes (SQL Server) Dialog Box ............................................................................... 342
Oracle Server Connection Dialog Box ......................................................................................... 343
Owner Dialog Box ....................................................................................................................... 344
P .......................................................................................................................................................... 344
Page Setup Dialog Box ................................................................................................................ 345
Panel Location Levels Dialog Box ............................................................................................... 345
Plant Hierarchy Dialog Box ......................................................................................................... 346
Plant Hierarchy Explorer .............................................................................................................. 347
Plant Properties Dialog Box ......................................................................................................... 348
Preferences for Scoping and Merging Data Dialog Box .............................................................. 350
Preferences Management Dialog Box .......................................................................................... 354
Print Options ................................................................................................................................ 358
Print Preview Dialog Box ............................................................................................................ 358
Project Activities Dialog Box....................................................................................................... 359
R .......................................................................................................................................................... 420
Rebuild Catalog Tables Dialog Box ............................................................................................. 420
Rebuild Default Views in Domains Dialog Box .......................................................................... 420
Rebuild Projects in Domain Dialog Box ...................................................................................... 421
Rebuild Stored Procedures and Triggers Dialog Box .................................................................. 421
Remove Deleted Windows Users Dialog Box ............................................................................. 422
Report Management Dialog Box .................................................................................................. 422
Required Wiring Equipment Report Dialog Box ......................................................................... 425
Reserve Item ID Ranges for Projects Dialog Box ........................................................................ 426
Reserve Tags and Loops Dialog Box ........................................................................................... 426
S .......................................................................................................................................................... 428
Scope Definition Dialog Box ....................................................................................................... 428
Search Dialog Box ....................................................................................................................... 429
Security Options Dialog Box ....................................................................................................... 430
Security Schema Password Encryption Dialog Box .................................................................... 430
Select Columns for Sorting Dialog Box ....................................................................................... 431
Select Columns for Viewing Dialog Box ..................................................................................... 431
Select Item Types for Comparison Dialog Box ........................................................................... 431
Select Item Types for Reports Dialog Box .................................................................................. 431
Select Logo Dialog Box ............................................................................................................... 432
Select (Copy Unit Data) Dialog Box ............................................................................................ 432
Select (Naming Conventions) Dialog Box ................................................................................... 433
Select Plant (for Registering) Dialog Box .................................................................................... 433
Select Plant (for Retrieving Documents) Dialog Box .................................................................. 433
Select Source Database Dialog Box ............................................................................................. 433
Select Source for Claiming Dialog Box ....................................................................................... 434
Set Color Dialog Box ................................................................................................................... 435
Source Data Connection Dialog Box ........................................................................................... 435
10
Contents
System Administration Window .................................................................................................. 437
T .......................................................................................................................................................... 437
Tablespace List Dialog Box ......................................................................................................... 437
Target Database Parameters (Oracle) Dialog Box ....................................................................... 438
Target Database Parameters (SQL Server) Dialog Box ............................................................... 439
Target Revisions Dialog Box ....................................................................................................... 440
Telecom Device Panel Icons Dialog Box..................................................................................... 441
To Do List Dialog Box ................................................................................................................. 441
Trim Audit Trail Data Dialog Box ............................................................................................... 442
U - V ................................................................................................................................................... 443
Unit Properties Dialog Box .......................................................................................................... 443
Update Statistics Dialog Box ....................................................................................................... 445
User-Defined Database Views Dialog Box .................................................................................. 445
User (Domain Administration) Dialog Box ................................................................................. 445
User (System Administration) Dialog Box .................................................................................. 446
W......................................................................................................................................................... 447
Wire End Naming Conventions Dialog Box ................................................................................ 447
Wire End Naming Convention Properties Dialog Box ................................................................ 448
Wiring Item Naming Options Dialog Box ................................................................................... 449
X-Y ..................................................................................................................................................... 450
Zoom ............................................................................................................................................ 450
Owner Operator Domain Explorer Windows ...................................................................................... 453
As-Built Explorer................................................................................................................................ 453
Claim Buffer ....................................................................................................................................... 454
Claimed Items ..................................................................................................................................... 456
Merge Buffer ...................................................................................................................................... 456
Project Explorer .................................................................................................................................. 458
Source Project Explorer ...................................................................................................................... 459
Target Project Buffer .......................................................................................................................... 460
Item Indicators .................................................................................................................................... 462
Cable Hierarchy Example ................................................................................................................... 462
Panel by Category Hierarchy Example ............................................................................................... 463
Panel by Location Hierarchy Example ............................................................................................... 464
Glossary .................................................................................................................................................... 465
Index ......................................................................................................................................................... 469
11
Contents
12
SECTION 1
13
14
SECTION 2
15
Parameter
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:
16
Item Types
Quantity (Average)
Instruments
45058
Loops
16616
1381
Device panels
11384
Junction boxes
504
Marshaling racks
45
Item Types
Quantity (Average)
Cabinets
36
108
Channels
16880
Specifications
111
P&ID drawings
855
Lines
3132
The above item type quantities populate a domain whose tablespace and index sizes are as
follows:
Admin Data
Tablespace
Admin Index
Tablespace
Domain Data
Tablespace
Domain Index
Data
Tablespace
30 MB
10 MB
350 MB
180 MB
Domain
Temporary Data
Tablespace
100 MB (autoextended)
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 (on page 108).
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.
See Also
SmartPlant Instrumentation Database Setup for Oracle (on page 15)
17
18
1.
2.
3.
4.
5.
6.
7.
8.
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.
On your Windows Start menu, navigate to the Intergraph SmartPlant Instrumentation
program icons and click DB Setup Utility.
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.
On the Oracle Server Connection dialog box, from the Oracle version list, select the
version of your Oracle server.
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.
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.
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.
In the Server name box, accept or modify the displayed Oracle server connection string.
In the System Administrator logon password box, accept the given default value manager
(the password is masked), or type the appropriate password.
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.
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.
Under Admin schema, accept the default Admin schema logon name and password
IN_DBAMN or modify the name or password as needed.
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 (on page 97).
19
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.
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.
11. Click Run and make sure the database setup process is completed successfully.
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. To learn how to run the SQL commands and create the SmartPlant
Instrumentation database on the Oracle database server manually, see Create a Database by
Running the DB Setup SQL Script File (on page 21).
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 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 (on page 104).
If the database setup process is not successful, you cannot use the SmartPlant
Instrumentation database and must manually clean up the Oracle database before running
the DB Setup Utility again. For details, see Clean Up the Oracle Database (on page 21).
See Also
Setting Up a Database for Oracle Common Tasks (on page 17)
SmartPlant Instrumentation Database Setup for Oracle (on page 15)
Oracle Database Server Tablespaces for SmartPlant Instrumentation (on page 15)
20
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
See Also
Setting Up a Database for Oracle Common Tasks (on page 17)
SmartPlant Instrumentation Database Setup for Oracle (on page 15)
Oracle Database Server Tablespaces for SmartPlant Instrumentation (on page 15)
21
This command returns both the Admin data and Admin index tablespace names.
Remember the Admin index tablespace name (INDEX_MAIN_TS by default).
In these commands, IN_DBAMN is the default Admin schema logon name. If you
changed the default name during the database setup, you can retrieve it from the [Database]
section of the Intools.ini file, where the Admin schema logon name appears as the LogId
parameter value.
3. Delete the INTOOLS_ENGINEER role using the command
DROP ROLE INTOOLS_ENGINEER CASCADE;
4. Delete the SmartPlant Instrumentation schemas (database users) one by one using the
commands
DROP USER INTOOLS_LOGIN CASCADE;
DROP USER IN_DBAMN CASCADE;
Substitute the default Admin schema logon name IN_DBAMN with your value.
5. Delete the SmartPlant Instrumentation tablespaces one by one using the commands
DROP TABLESPACE MAIN_TS INCLUDING CONTENTS AND DATAFILES;
DROP TABLESPACE INDEX_MAIN_TS INCLUDING CONTENTS AND DATAFILES;
DROP TABLESPACE TEMP1_TS INCLUDING CONTENTS AND DATAFILES;
Use your tablespace names in place of the default names displayed in the SQL
commands.
See Also
Setting Up a Database for Oracle Common Tasks (on page 17)
SmartPlant Instrumentation Database Setup for Oracle (on page 15)
Oracle Database Server Tablespaces for SmartPlant Instrumentation (on page 15)
22
SECTION 3
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>
23
Parameter
Admin Datafile
Index Datafile
Log Datafile
Filegroup name
primary
intools_dba_index
log
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.
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):
24
Item Types
Quantity (Average)
Instrument tags
45058
Loops
16616
1381
Device panels
11384
Junction boxes
504
Marshaling racks
Item Types
Quantity (Average)
Cabinets
36
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 (on page 106).
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.
25
See Also
SmartPlant Instrumentation Database Setup for Oracle (on page 15)
SmartPlant Instrumentation Database Setup for SQL Server (on page 23)
2.
3.
4.
5.
26
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.
On your Windows Start menu, navigate to the Intergraph SmartPlant Instrumentation
program icons and click DB Setup Utility.
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.
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.
Under System Administrator logon password, type the appropriate password if required
or leave this field empty if the password is not required.
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.
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.
Under Target database name, type the name of the SmartPlant Instrumentation database
for which you want to run the setup process.
The SmartPlant Instrumentation database name must be unique within your SQL Server
that you specified on the Microsoft SQL Server Connection dialog box.
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 2009 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.
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 (on page 97).
If this is the first database setup session for SmartPlant Instrumentation 2009 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.
8. In the subsequent boxes, accept the default parameters or modify them as needed.
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.
27
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 and must manually clean up the SQL Server database before
running the DB Setup Utility again. For details, see Clean Up the SQL Server Database (on
page 28).
On SQL Server 2005, the DB Setup Utility automatically clears the Enforce password
policy check box for each SmartPlant Instrumentation schema login created in the instance.
If your company policy requires that this check box is selected, after completing the
database setup, select the Enforce password policy check box for each of the SmartPlant
Instrumentation logins, that is: SPIsuper and SPI_login, which are created automatically and
shared for all SmartPlant Instrumentation databases, and Admin schema login, whose name
you defined during the current database setup. You will have to select the Enforce
password policy check box every time you create other logins for SmartPlant
Instrumentation schemas. The Domain schema and View-Only Domain schema logins are
created when initializing a domain; the As-Built schema login when creating an owner
operator domain; the Project and Combined Project schema logins when creating a
project. For details about database schemas, in the SmartPlant Instrumentation
Configuration and Maintenance Guide, see SmartPlant Instrumentation Database Technical
Review > Logon Data and Database Connection Security > SmartPlant Instrumentation
Database Schemas.
If your SmartPlant Instrumentation database is the only database in the current instance,
right-click and delete the following logins: SPI_login, SPIsuper, and the Admin
schema login.
If you have other SmartPlant Instrumentation databases in the current instance, rightclick and delete only the Admin schema login.
The SPI_login and SPIsuper logins are shared for all SmartPlant Instrumentation
databases created in the current SQL Server instance.
29
30
SECTION 4
You can only back up data to the backup repository once from a single domain or project.
Therefore, to be able to make several backups, you need to have several copies of the
original Intools_backup.db database. If you have already used Intools_backup.db for a
backup and did not make a clean copy of Intools_backup.db, you can obtain another
Intools_backup.db by installing on another machine and then using it as a source 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 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
Backing up Files Containing Audit Trail Data. (see "Backing Up Files Containing Audit
Trail Data" on page 37)
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.
The backup procedure involves the following sequence of operations:
1. Connecting to the target Sybase Adaptive Server Anywhere database
SmartPlant Instrumentation Administration User's Guide
31
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 (on page 32).
32
Back Up a Domain
1.
2.
3.
4.
5.
6.
7.
8.
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.
If you want to back up a domain in Windows Vista, you might need to temporarily turn off
the User Account Control in Windows Vista. For details, see Workaround for the
INtools_Backup.db Connection Problem in Windows Vista (on page 36).
With the System Administration window open, click File > Backup.
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.
Click Connect to connect to the backup repository and to the current database.
On the Back Up Domain dialog box, from the Domain list, select the domain which you
want to back up.
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.
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.
The software can only copy those users who are assigned to groups.
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.
Click OK to start the backup process and monitor the progress on the Backup Information
dialog box.
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.
If you intend to work in the backed up domain in the INtools_Backup.db database
or its copy, you must obtain a full version of Sybase Adaptive Server Anywhere database engine
(dbeng10.exe) and also rebuild stored procedures and triggers for the backed up domain. For
details, see Rebuild Stored Procedures and Triggers (on page 104).
See Also
Managing Audit Trail Data (on page 234)
33
Parameter
Description
Possible Settings
Init.exe
INIT.EXE
BKC
BKC
<Copy users
flag>
<Copy
departments
flag>
<Save last
created ID flag>
Y or N
The Yes/No parameter for 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.
Y or N
<Source Domain The Domain schema name of the schema that you use IN_DEMO
schema name>
as a source for backup.
<Path to the
target database>
d:\Program
Files\SmartPlant\
Instrumentation\
INtools_Backup.db
Example
Init.exe BKC,Y,Y,N,IN_DEMO,
d:\Program Files\SmartPlant\Instrumentation\INtools_Backup.db
34
See Also
Initialize a Domain from the Command Line (on page 57)
Parameter
Description
Possible Settings
Init.exe
INIT.EXE
BKC
BKC
<Copy users
flag>
Y or N
<Copy
departments
flag>
Y or N
<Save last
created ID flag>
The Yes/No parameter for saving the ID of the last item that was Y or N
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 The Domain schema name of the schema that you use as a
schema name>
source for backup.
IN_DEMO
<Path to the
d:\Program
35
Parameter
Description
Possible Settings
target database>
Files\SmartPlant\
Instrumentation\
INtools_Backup.db
<Path to the
target database>
The full path to the Intools.ini file located on the thin client.
u:\Program
Files\SmartPlant\
Instrumentation
Example
Init.exe BKC,Y,Y,N,IN_DEMO,
d:\Program
Files\SmartPlant\Instrumentation\INtools_Backup.db,u:\Program
Files\SmartPlant\Instrumentation
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.
See Also
Initialize a Domain from the Command Line (on page 57)
36
Instead of turning UAC off, it is also possible to manually update the content of the
PATTERN_wat key in your Windows Registry. In the Registry Editor, the key appears in
the path HKEY_LOCAL_MACHINE\SOFTWARE\ODBC\ODBC.INI. You need to define
the correct parameters for the INtools_Backup.db database in the key strings.
When the User Account Control in Windows Vista is set to On, you cannot initialize a
domain either. The same workaround applies.
See Also
Backing up Audit Trail Data on SQL Server (on page 38)
Backing up Audit Trail Data on Sybase Adaptive Server Anywhere (on page 40)
Managing Audit Trail Data (on page 234)
See Also
Managing Audit Trail Data (on page 234)
37
4. Copy the content of the folder orc1 in the path <drive>:\INtoolStorage\ to the folder orc2.
5. Restart your computer.
See Also
Managing Audit Trail Data (on page 234)
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.
See Also
Managing Audit Trail Data (on page 234)
38
See Also
Managing Audit Trail Data (on page 234)
39
See Also
Managing Audit Trail Data (on page 234)
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.
See Also
Managing Audit Trail Data (on page 234)
40
See Also
Managing Audit Trail Data (on page 234)
Domain Initialization
In SmartPlant Instrumentation, the working environment for your instrumentation activities is
known as a domain. The domain type can be either Engineering company or Owner
operator. 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 (dbeng10.exe),
you can initialize a domain in any of the Sybase Adaptive Server Anywhere database supplied
databases, apart from INtools_Backup.db, which must only be used for backing up and restoring
an existing domain. All of these databases 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 INtools.db does not include any domain schemas, we recommend that you
initialize a domain in the INtools.db database. 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 (on page 57).
Initialize a new domain using another domain as a source. This way, in the target database,
you restore a domain with all existing data.
41
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 2009. If not, you must upgrade
the source domain to Version 2009, or the target Admin schema to Version 2009.
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. INtools_Backup.db does not require a full
version of Sybase Adaptive Server Anywhere database engine. However, if you intend to
work in a backed up domain in INtools_Backup.db or its copy, you must obtain a full
version of Sybase Adaptive Server Anywhere database engine (dbeng10.exe) and also
rebuild stored procedures and triggers for the backed up domain. For details, see Rebuild
Stored Procedures and Triggers (on page 104).
When initializing a domain in Windows Vista, you might need to temporarily turn off the
User Account Control in Windows Vista. For details, see Workaround for an Initialization
Problem in Windows Vista (on page 63).
We recommend that you initialize only one domain in a given Sybase Adaptive Server
Anywhere database. Therefore, make copies of the target database file so that you can use
one copy per initialization. You can copy the target database file to another location, and
then use this file as a standard database for initialization of 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 an
existing domain. However, it is recommended that you use INtools.db because this database
it does not contain any Domain schemas, only the Admin schema.
42
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 (see "Numeric
Character Settings for Oracle" on page 63).
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 2009 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 or Oracle 9i and the target database platform is in
Oracle 10g, initialize the domain in Sybase Adaptive Server Anywhere first, then, upgrade
the domain to Version 2009 before initializing this domain in Oracle 10g.
If the source domain resides in SQL Server, initialize the domain in Sybase Adaptive Server
Anywhere first, then, upgrade the domain to Version 2009 before initializing this domain in
Oracle 10g.
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 2009, and then, use this domain as a source for initializing a new
domain in SQL Server 2005.
If the source domain resides in Oracle, initialize the domain in Sybase Adaptive Server
Anywhere first, then, upgrade the domain to Version 2009 before initializing this domain in
SQL Server 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.
See Also
Domain Backup (see "Domain Backup, Initialization, and Deletion" on page 31)
43
See Also
Initialization Log Files (on page 58)
44
See Also
Troubleshooting Domain Initialization Common Tasks (on page 61)
45
See Also
Troubleshooting Domain Initialization Common Tasks (on page 61)
46
6.
7.
8.
9.
10.
47
11.
12.
13.
14.
15.
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.
The source and target versions of the SmartPlant Instrumentation database must be the
same.
Click Connect to connect to the source database.
From the Domain list, select a domain to be used as a source.
Select the Copy users to target domain if you want to copy all the existing SmartPlant
Instrumentation user definitions to the new domain.
The software can only copy those users who are assigned to groups.
Select the Copy departments to target domain if you want to copy all the existing
SmartPlant Instrumentation department definitions to the new domain.
In the Source Data Connection dialog box, click OK to return to the Initialize dialog box.
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.
See Also
Troubleshooting Domain Initialization Common Tasks (on page 61)
48
6.
7.
8.
9.
10.
49
See Also
Troubleshooting Domain Initialization Common Tasks (on page 61)
1.
2.
3.
4.
50
6.
7.
8.
9.
10.
The source and target versions of the SmartPlant Instrumentation database must be the
same.
51
11.
12.
13.
14.
15.
16.
17.
18.
19.
20.
52
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.
Click OK to open the Domain Tablespace Definition dialog box, where you can define the
tablespace data of the domain for initialization.
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 Tablespace size (MB) box, type the appropriate domain tablespace size.
c. In the Datafile name and path box, type the full path and filename of the tablespace
database file.
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 Tablespace size (MB) box, type the appropriate domain index tablespace size.
The recommended size is 50% of the domain tablespace size.
c. In the Datafile name and path box, type the full path and filename of the tablespace
database file.
It is recommended that the domain datafile and the domain index datafile are stored on
separate physical disks.
Click OK to start the initialization process.
See Also
Troubleshooting Domain Initialization Common Tasks (on page 61)
6.
7.
8.
9.
53
Owner operator Allows you to initialize the domain as a domain with As-Built
functionality. The database is partitioned into several schemas: a single schema for AsBuilt 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
Owner operator if required, and the owner can perform the necessary maintenance and
modernization.
During the initialization process, the software might display various error messages that
do not cause the initialization process to fail. If want to prevent the software from
displaying these messages, 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, do the following:
a. In the Datafile folder path box, type the 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.
b. Under Domain data, accept or type the desired values.
The values in the Domain file name and Filegroup boxes must be must be unique
in the database.
c. Under Index data, accept or type the desired values.
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.
12. Click OK to start the initialization process.
If, during the process, you receive a Grant to view Creation Error message, see
Workaround for the Grant to View Creation Error (on page 64).
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.
See Also
Troubleshooting Domain Initialization Common Tasks (on page 61)
54
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.
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.
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.
Unlike in Oracle or SQL Server, in Sybase Adaptive Server Anywhere, the Domain
schema password is not encrypted and cannot be encrypted; after initializing a domain,
the Domain schema logon password becomes set permanently in the software. When
performing a database connection, the software retrieves the logon name and password
from the PROJECT table of the Admin schema.
55
12.
13.
14.
15.
16.
17.
56
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.
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.
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.
Click Connect to connect to the selected source database.
From the Domain list, select a domain to be used as a source.
Select the Copy users to target domain if you want to copy all the existing SmartPlant
Instrumentation user definitions to the new domain.
The software can only copy those users who are assigned to groups.
Select the Copy departments to target domain if you want to copy all the existing
SmartPlant Instrumentation department definitions to the new domain.
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, do the following:
a. In the Datafile folder path box, type the 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.
b. Under Domain data, accept or type the desired values.
The values in the Domain file name and Filegroup boxes must be must be unique
in the database.
c. Under Index data, accept or type the desired values.
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.
21. Click OK to start the initialization process.
If, during the process, you receive a Grant to view Creation Error message, see
Workaround for the Grant to View Creation Error (on page 64).
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.
See Also
Troubleshooting Domain Initialization Common Tasks (on page 61)
57
Parameter
Description
Possible
Settings
Init.exe
INIT.EXE
INT
INT
DEMO
DEMO
DEMO
Example
INIT.EXE INT,DEMO,DEMO,DEMO
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.
See Also
Troubleshooting Domain Initialization Common Tasks (on page 61)
58
See Also
Troubleshooting Domain Initialization Common Tasks (on page 61)
Delete a Domain
Use this procedure to delete a domain that is no longer in use. When deleting an owner operator
domain, the software deletes all the project schemas and the As-Built schema. You do not have
to delete the projects first. For more information, see Delete a Domain (on page 60).
59
Delete a Domain
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.
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
When deleting a domain in Oracle, 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.
See Also
Domain Backup Common Tasks (on page 32)
60
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.
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.
If the list is empty, there are no corrupted domains in the current database.
3. Click OK.
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.
61
See Also
Domain Initialization (on page 41)
Prerequisites for Domain Initialization (on page 42)
Initialization Log Files (on page 58)
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 (on page 59).
62
Instead of turning UAC off, it is also possible to manually update the content of the
PATTERN_wat key in your Windows Registry. In the Registry Editor, the key appears in
the path HKEY_LOCAL_MACHINE\SOFTWARE\ODBC\ODBC.INI. You need to define
the correct source domain parameters in the key strings.
When the User Account Control in Windows Vista is set to On, you cannot perform a
domain backup either. The same workaround applies.
See Also
Initialize a Domain in Oracle Using Another Domain as a Source (on page 50)
Initialize an Empty Domain in Oracle (on page 48)
Prerequisites for Domain Initialization (on page 42)
63
See Also
Initialize a Domain in Oracle Using Another Domain as a Source (on page 50)
Initialize an Empty Domain in Oracle (on page 48)
Prerequisites for Domain Initialization (on page 42)
See Also
Initialize a Domain in SQL Server Using Another Domain as a Source (on page 54)
Initialize an Empty Domain in SQL Server (on page 53)
65
66
SECTION 5
The list of databases appears in the intools.ini file. For each database, you need to
define a database profile.
67
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.
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 Administrators.
See Also
System Administration Common Tasks (on page 81)
Working with Administration Module (see "Working with the Administration Module" on page
See Also
Domain Administration Common Tasks (on page 119)
Working with Administration Module (see "Working with the Administration Module" on page
2. Click .
3. In the Open Administration Module dialog box, click Domain Administrator.
See Also
System Administration Common Tasks (on page 81)
68
2. Click .
3. In the Open Administration Module dialog box, click System Administrator.
See Also
Domain Administration Common Tasks (on page 119)
69
70
SECTION 6
71
5.
6.
7.
8.
9.
10.
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.
Under User initials, type the appropriate initials. The software uses this value to identify
the reviewer in all the revisions created in the software.
From the Department list, select a department to which you want to assign the user.
Under Password, type a unique login password for the user.
A password can contain up to 15 characters (not case-sensitive). The password that you
type appears masked.
Under Verify new password, retype the password you just entered.
Select the System Administrator check box if you want to grant System Administrator
rights to the new user.
In SmartPlant Instrumentation, there can be more than one user with System
Administrator access rights.
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.
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.
72
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.
See Also
Log on as System Administrator (on page 67)
System Administration Common Tasks (on page 81)
See Also
System Administration Common Tasks (on page 81)
Log on as System Administrator (on page 67)
73
User Groups
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.
In a project of an owner operator domain, 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.
When you or back up an existing domain or initialize a domain using another domain as a
source, you can set the software to copy the source domain users. The software only copies
those users who are assigned to groups.
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 (on page 77).
See Also
Access Rights Descriptions (on page 195)
74
Delete a Group
This procedure enables the Domain Administrator to delete a group that has no users. For more
information, see Delete a Group (on page 76).
See Also
Domain Administration Common Tasks (on page 119)
With the Domain Administration window open, click Activities > Group.
In the Group dialog box, click New.
Type the new group name, description and note as you require.
Click Apply.
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.
See Also
Access Rights (on page 193)
75
Delete a Group
1.
2.
3.
4.
See Also
Access Rights (on page 193)
76
1.
2.
3.
4.
5.
6.
7.
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 (on page 78).
Users who are not assigned to any group have no access rights in the domain.
Start the Administration module and log on as Domain Administrator.
Click Activities > Assign Users to Groups.
From the Group list, select the group from which you want to remove the required user.
In the Group users pane, select the user you want to remove from the selected group.
Drag the selected user from the Group users pane to the User list pane.
Repeat steps 3 through 5 in this procedure for each user you want to remove from a group.
Click OK to save changes.
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.
77
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.
See Also
Access Rights (on page 193)
With the Domain Administration window open, click Activities > Group.
In the Group dialog box, click New.
Under SmartPlant Instrumentation group, type the new group name.
Type the group description and note as you require.
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.
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 (see "Switching to a Different Logon Method" on page 79).
See Also
Access Rights (on page 193)
78
79
80
SECTION 7
System Administration
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 multiuser versions.
81
System Administration
Generate Reports
As System Administrator, you can generate domain and activity reports. For more information,
see Report Generation (System Administration) (on page 118).
82
System Administration
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 (on page 86).
83
System Administration
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.
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 As-Built.
8. Set or update the remaining domain definitions as you require. For a detailed description of
domain features, see the Help topic Domain Definition Window (see "Domain Definition
Window (System Administration)" on page 314).
9. On the window toolbar, click
See Also
Owner Operator Domain (As-Built and Projects) (on page 125)
84
System Administration
Workflow options are available only when the domain type is defined as Engineering
company. For an owner operator domain, the workflow is defined at the level of the
projects in the domain.
9. Under Specification title block, from the Custom title block assignment method, select
one 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.
10. 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
11. 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 (on page 88).
12. On the window toolbar, click
See Also
Log on as System Administrator (on page 67)
Title Block Descriptions (on page 213)
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.
After enabling cable type dependency, it is only possible to create new cables in the
Reference Explorer. To create plant cables, you will need to drag reference cables from
the Reference Explorer to the Domain Explorer.
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.
Cable type dependency requires that all plant cables in the Domain Explorer have the same
structure as reference cables in the Reference Explorer. Therefore, before enabling cable
type dependency in a particular domain, we recommend that you initialize a new empty
domain and then let SmartPlant Instrumentation users create all the required cables for that
domain.
1. Start the Administration module and log on as Domain Administrator to the target domain.
2. With the Domain Administration window open, on the menu bar, click Reports > Cable
Type Dependency Validation and make sure that the report is empty.
85
System Administration
It is only possible to enable cable type dependency if all reference cables comply with
the dependency requirements. The Cable Type Dependency Validation report displays only
those reference cables that do not comply with the dependency requirements. If the report
displays such cables, you must delete them in SmartPlant Instrumentation from the
Reference Explorer.
3. Log off from the Domain Administration and then log on as System Administrator. For
details, see Switch from Domain Administration to System Administration (on page 68).
4. With the System Administration window open, do one of the following to open the
Domain Definition window:
Click File > Domain Definition.
Click .
5. From the Domain list, select a domain.
6. Do one of the following:
Click Options > Edit.
Click .
7. Under Domain features, select the Cable type dependency check box.
8. Click
See Also
Log on as System Administrator (on page 67)
Enable Workflow
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 (on
page 206).
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.
86
System Administration
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.
to save the current domain data to the database.
6. Click
See Also
Log on as System Administrator (on page 67)
See Also
Log on as System Administrator (on page 67)
See Also
Item Registry Activities (on page 257)
Log on as System Administrator (on page 67)
87
System Administration
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 userdefined 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
See Also
Log on as System Administrator (on page 67)
88
System Administration
89
System Administration
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.
To clear activity tracking, you must select at least one check box.
10. Click OK.
90
System Administration
4.
5.
6.
7.
8.
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.
In the Period section, type the range of dates (From, To) for which you want to generate
the report.
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.
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.
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.
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.
Click OK to open the Print Preview dialog box, from where you can view and print the
report.
91
System Administration
Logon Process
The logon process in SmartPlant Instrumentation operates at the following levels:
1. The intools.ini file holds the security schema password that provides access to the
intools_login schema.
2. The intools_login schema holds the INTOOLS_Login table, which holds the Admin
schema user password and logon name.
3. The Admin schema holds the PROJECT table, which in turn holds the names of the
existing domains and all the passwords of SmartPlant Instrumentation users.
92
System Administration
Schema
Password
Change
Encryption
Security Schema
Yes
Admin Schema
Yes
Domain Schema
Yes
SmartPlant
Instrumentation Users
Yes
93
System Administration
SQL Server:
Schema
Password
Change
Encryption
Security Schema
Yes
Admin Schema
Yes
Domain Schema
Yes
SmartPlant
Instrumentation Users
Yes
Schema
Password Change
Security Schema
Not applicable
Not applicable
Changes the password in the Not applicable
in the intools.ini file.
Changes the password if the
Admin schema.
Admin Schema
94
Encryption
Domain Schema
Yes
SmartPlant
Instrumentation Users
Yes
System Administration
Encryption Results
Security Schema:
Unencrypted
Encrypted
SecuritySchemaPassword=intools_login
SecuritySchemaPassword=#2f###RG##T
Admin Schema:
Unencrypted
Encrypted
Domain Schema:
All the Domain schema passwords are encrypted in the PROJECT,
ENGINEERING_PROJECT, and SAP_PROJECT tables.
All the user passwords are encrypted in the INTOOLS_USER table. Consequently, none of
the passwords are visible to employees with database access rights.
SmartPlant Instrumentation User Passwords:
All the user passwords are encrypted in the INTOOLS_USER table. Consequently, none of
the passwords are visible to employees with database access rights.
95
System Administration
96
System Administration
97
System Administration
98
System Administration
See Also
Database Maintenance on SQL Server Common Tasks (on page 105)
Working with Administration Module (see "Working with the Administration Module" on page
Domain Administration (see "Domain and Project Administration" on page 119)
System Administration (on page 81)
99
System Administration
100
System Administration
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. For SQL
Server 2005, the default ODBC profile is 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.
101
System Administration
Make sure that in the [Database] section of the Intools.ini file, the MSS value of the DBMS
parameter appears in upper case. Otherwise, it is not possible to work with specifications in
SmartPlant Instrumentation.
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.
Define Databases
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
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 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.
2. For each database that appears in the [Profiles] section, create a separate section with the
appropriate profile name and define the connection parameters.
Do not delete the original [Database] section.
The following table shows one example for each database type.
102
[My_Database1]
DBMS=O10
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
[My_Database2]
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;P
WD=
[My_Database3]
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;P
WD=
System Administration
SPI_DBA',DisableBind=1"
DSN=MSS2005
Prompt=110
Commit=100
IN_DBAMN'
Prompt=110
Commit=100
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.
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.
The database users select on the Logon Information dialog box becomes the default
database.
See Also
Working with Administration Module (see "Working with the Administration Module" on page
Domain Administration (see "Domain and Project Administration" on page 119)
System Administration (on page 81)
1. If the line representing the database that you want to access begins with a semicolon (;),
remove it.
2. Insert a semicolon at the beginning of the line representing the database that you do not
want to access.
103
System Administration
1.
2.
3.
4.
5.
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.
With the System Administration window open, click DBA > Rebuild Default Views in
Domains.
From the Domain list, select the domain whose database views you want to rebuild.
In the View-Only Domain schema password box, enter the logon password of the ViewOnly Domain schema. The password characters appear masked.
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.
If working on SQL Server, type the SQL Server System Administrators password.
Click OK to start rebuilding the views of the selected domain.
This procedure should only be carried out when you are specifically instructed to do so by
Intergraph Support.
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 Stored 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.
When rebuilding stored procedures and triggers of the Admin schema, the Domain list
is redundant as its value is DEFAULT.
If the process stops for any reason, you can restart the process and the process continues
from where it stopped. If you get an error that cannot be corrected, contact Intergraph
Support with the error description. It is recommended that you have your log file
available when contacting Intergraph Support.
4. On the Rebuild Stored Procedures dialog box, if needed, click Browse to specify the log
file path if you do not want to use the default Log.txt file. This file contains the information
of the current session and any errors that may have occurred in previous sessions. The log
file is incremented if you use the same log file name.
104
System Administration
5. Click OK to start rebuilding the stored procedures and triggers of the selected schema.
At the end of the process, an appropriate message is displayed and an additional log file
Logerror.txt is generated in the SmartPlant Instrumentation home folder. The data in the
Logerror.txt file is incremented between sessions. Send the Logerror.txt file to Intergraph
Support after you complete the process.
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 (on page 106).
105
System Administration
Optimize Indexes
This procedure enables you to optimize fragmented SQL Server indexes. The SQL Server
indexes become fragmented during the domain lifetime and contribute to database underperformance. 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 (on page 107).
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.
106
System Administration
Optimize Indexes
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.
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.
107
System Administration
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 underperformance. 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 (on page 109).
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 (on page 109).
With the System Administration window open, click DBA > Tablespaces List to display
the data for all filegroups that have free space for storing data.
To learn about Oracle tablespaces used in SmartPlant Instrumentation, see Oracle
Database Server Tablespaces for SmartPlant Instrumentation (on page 15).
108
System Administration
5. Click OK and make sure the software displays a message notifying you that the selected
tablespace was increased successfully.
Optimize Indexes
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.
Update Statistics
With the System Administration window open, click DBA > Tuning > Update Statistics.
This option is available to both System and Domain Administrator when using
SmartPlant Instrumentation on Oracle.
109
System Administration
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.
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.
110
System Administration
Cable Suffix The fourth position of the cable number can be a numeric or alphabetic
character, mostly used for grouping purposes.
SmartPlant Instrumentation does not auto-increment the numbering of the various segments
in the process identification.
The software does not automatically add leading zeros to imported items whose names
include spaces. You must manually add the leading zeros to the source before importing
KKS data.
Examples
For a medium voltage panel (excluding device panels), only the System Code segments are
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 Classification
BBA
System Numbering
01
(Not used)
Description
MV distribution board
Property
Value Description
Total Plant
System Classification
PAE
System Numbering
01
CF
001
Component Classification
-B
Component Numbering
01
Transducer
111
System Administration
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.
When editing a name using the KKS naming conventions, do not remove any segments from
the name. Removing segments from the KKS name causes problems when creating new
instruments. You can though add more segments to the KKS name created in SmartPlant
Instrumentation.
112
System Administration
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.
113
System Administration
114
System Administration
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.
Click .
From the Domain list, select the required domain.
Click Options > Add Accounting.
Click Accounting.
Click New.
Type in the accounting name, number, and note as required.
115
System Administration
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.
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.
See Also
Log on as System Administrator (on page 67)
System Administration Common Tasks (on page 81)
Click .
From the Domain list, select the required domain.
Click Options > Add Contractor.
Click Contractor.
Click New.
Type in the contractor name, number, and note as required.
Click Apply.
Click Close when done.
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.
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.
See Also
Log on as System Administrator (on page 67)
System Administration Common Tasks (on page 81)
116
System Administration
Click .
From the Domain list, select the required domain.
Click Options > Add Client.
Click Client.
Click New.
Type in the client name, number, and note as required.
Click Apply.
Click Close when done.
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.
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.
See Also
Log on as System Administrator (on page 67)
System Administration Common Tasks (on page 81)
117
System Administration
Report
Description
Domain Information
Domain List
Activity Tracking
Graph
The Administration module is not included in the Activity Tracking report options.
See Also
Generate a Grid-Style Activity Tracking Report (on page 90)
Generate a Graph-Style Activity Tracking Report (on page 90)
System Administration Common Tasks (on page 81)
118
SECTION 8
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 (on page 182).
119
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 (on page 193).
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 Owner operator. For more information, see
Preferences Management (on page 207).
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 (see "Report Management" on page 211).
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 (on
page 222).
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 (on page 238).
120
Item Registry
This set of procedures deals with item registry activities for the integrated environment. For
more information, see Item Registry Activities (on page 257).
When working in an integrated environment, there are certain requirements relating to AsBuilt and projects. For a description of these and other requirements, see Tool Requirements
for Integrating SmartPlant Instrumentation (on page 259).
It is recommended that you back up your database before performing any engineering
activities.
121
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 (on page 204).
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.
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.
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.
122
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.
5.
6.
7.
8.
To modify properties of an existing highest level item, right-click the item itself, which
is indicated by the icon , 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.
In the General tab of the Plant Properties dialog box, in the <Plant> box, type the new
<plant> name.
The name must contain at least one character that is not space. The maximum name
length is fifty characters.
From the Owner list, select the appropriate owner for the new <plant>.
In the boxes, enter data as required.
If needed, click the Custom Fields tab to define custom field values to be associated with
the current <plant>.
123
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.
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.
124
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 (on page 184). 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.
125
1. Create a Project
In your owner operator domain, create a project, with or without the project schema. For details,
see Create a Project (on page 129).
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 (on page 72).
126
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 (on page 204).
See Also
Users and Groups Common Tasks (on page 74)
127
Create a Project
After System Administrator creates an owner operator 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 AsBuilt items. Prior to creating a project, your System Administrator needs to define a domain and
specify the domain type as Owner operator. For more information, see Create a Project (on
page 129).
128
Rebuild a Project
Use this procedure to rebuild a project after performing any of the following activities:
Initializing an owner operator domain. This procedure is required because, during the
initialization process, the As-Built and Project schemas are not fully created in Sybase
Adaptive Server Anywhere.
Upgrading an owner operator domain.
Restoring an owner operator domain from an Oracle .dmp file or SQL Server .bak file.
Rebuilding projects is also required when an existing project is damaged or there is a change in
a process that requires the original basic project. For more information, see Rebuild a Project
(on page 137).
129
Create a Project
You may also want to define a <plant> before creating a project. For details, see
Create a Plant Hierarchy Item on the Highest Level (on page 123).
1. Start the Administration module and log on as Domain Administrator.
2. Do one of the following:
Click Activities > Project Activities.
3.
4.
5.
6.
7.
8.
9.
10.
11.
12.
13.
14.
130
Click .
In the Project Activities dialog box, click New.
Type a name and description for the project as required.
From the Project Administrator list, select a user you want to set as Project Administrator.
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 (on page 126).
From the Plant list, select a plant to which the project is to be assigned.
If required, select a workflow option for the project.
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.
If needed, select a logo for the current project.
Click Apply.
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).
click Yes if you want to proceed immediately.
When prompted to create the project schema, click Yes if you want to proceed immediately.
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.
Click Close
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.
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.
See Also
Users and Groups Common Tasks (on page 74)
Flow of Activities for Defining a Project Administrator (on page 126)
131
6.
7.
8.
Click .
On the Project Activities dialog box, select As-Built.
Click Edit.
From the Project Administrator list, select a Project Administrator.
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.
If needed, select a workflow option for As-Built.
If needed, type additional information in the Notes box.
Click Apply.
132
See Also
Display Formats of Item Categories (on page 132)
3.
4.
5.
6.
Click .
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.
Click Reserve.
Click the appropriate tab.
Click Add.
Do one of the following:
133
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.
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.
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.
Click Add to add a new row and define another range of numbers.
See Also
Naming Conventions Common Tasks (on page 183)
Wire End Naming Conventions Common Tasks (on page 190)
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.
134
You can perform this procedure successfully only if the source and the target projects have
the same database ID.
The import process overwrites all existing data in the target project.
SmartPlant Instrumentation Administration User's Guide
135
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 Import.
14. At the prompt, click Yes to confirm the import.
15. Click Cancel to close the Select Source Database dialog box.
16. On the Project Activities dialog box, click Close.
136
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.
See Also
Configuring SmartPlant Instrumentation for Integration (on page 252)
Integration Common Tasks (on page 252)
Item Registry Activities (on page 257)
Rebuild a Project
1. As Domain Administrator, enter the owner operator 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.
Selecting As-Built is required after initializing an owner operator domain in Sybase
Adaptive Server Anywhere (full engine version).
4. Click OK to rebuild the selected projects.
137
Click Delete.
On the Domain Administration window menu bar, click DBA > Delete Projects.
On the Delete Projects dialog box, select the Delete project schema check box.
Under Project List, select the project that you want to delete.
Click OK.
139
Explorer Windows
In an owner operator domain, the Project Administrator uses Explorer windows to claim items
for projects or merge items with As-Built. The Explorer windows display 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 AsBuilt. 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 As-Built.
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.
140
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 (on page 144).
141
142
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.
3.
4.
5.
6.
143
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.
Clicking Advanced allows you to define a special filter for the Cables, Cross Cables, and
Loops folders. For details, see Filter Cables (on page 144) and Filter Loops According to
Blocks (on page 145).
To reset the filter, delete the filter definition.
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.
2.
3.
4.
5.
144
6.
7.
8.
9.
10.
11.
12.
13.
14.
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
Click Verify to check the validity of the current filtering condition.
Click Advanced to define a filter for the Cables folder.
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.
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.
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 panels.
DCS panels Includes all the cables that are connected to DCS panels.
PLC panels Includes all the cables that are connected to DCS panels.
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.
Select the Display telecom cables only if you want to filter the Cables folder so that it
displays telecom cables only.
Click OK in the Advanced Filter Definition dialog box.
Click OK in the Filter Definition dialog box.
145
3.
4.
5.
6.
7.
8.
146
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.
147
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.
148
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
fully-functional 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 As-Built 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.
Claim
Parent
Items as
Dummy
Check Box
Reclaim
Possible
Items
Action
Check Box
Condition
Result
Selected
N/A
Claim a strip
for Project1.
Selected
N/A
Claim a strip
for Project2.
Selected
N/A
Claim a strip
for Project1.
149
150
Claim
Parent
Items as
Dummy
Check Box
Reclaim
Possible
Items
Action
Check Box
Condition
Result
Selected
N/A
Claim a strip
for Project1.
Selected
Selected
Selected
Selected
Cleared
N/A
Claim a strip
for Project1.
The strip does not In Project1, both the strip and the
panel appear as fully-functional
exist in either
items.
Project1 or
Project2.
Cleared
N/A
Claim a strip
for Project2.
Claim
Parent
Items as
Dummy
Check Box
Reclaim
Possible
Items
Action
Check Box
Condition
Result
Cleared
N/A
Claim a strip
for Project1.
Cleared
N/A
Claim a strip
for Project1.
Cleared
Selected
N/A
Selected
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..
151
152
Claim
Parent
Items as
Dummy
Check Box
Reclaim
Possible
Items
Action
Check Box
Condition
Result
Selected
N/A
Claim a strip
for Project1.
Selected
N/A
Claim a strip
for Project2.
Selected
N/A
Claim a strip
for Project1.
Selected
Selected
Cleared
N/A
Claim a strip
for Project1.
Cleared
N/A
Claim a strip
for Project1.
Claim
Parent
Items as
Dummy
Check Box
Reclaim
Possible
Items
Action
Check Box
Condition
Result
Cleared
N/A
Claim a strip
for Project2.
Cleared
Selected
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..
153
154
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 AsBuilt Explorer or Source Project Explorer (on page 160).
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 (on page 162) and Claim Documents (on page 163).
155
3.
4.
5.
6.
7.
8.
9.
Click .
In the Project Activities dialog box, select a project for which you want to claim data from
As-Built.
Click Scope.
On the Select Source for Claiming dialog box, under Claim source, select As-Built.
Click OK.
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).
Click Continue.
In the As-Built Explorer, expand the hierarchy to display the item type folders.
See Also
As-Built Explorer (on page 453)
6.
7.
8.
9.
156
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.
Click OK.
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).
Click Continue.
In the Source Project Explorer, expand the hierarchy to display the item type folders.
4.
5.
6.
7.
8.
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 owner operator 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.
See Also
Settings and Conditions for Claiming Items (on page 148)
157
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.
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.
158
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 (see "General Tab (Preferences for Scoping and Merging Data Dialog Box)" on
page 350) 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.
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.
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.
159
To remove one specific item, in the tree view pane, select and right-click 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.
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.
If the preference setting is No sub-items and you select a single item for removal, the
software cannot detect whether this item has sub-items in the buffer or not. Therefore,
on clicking Remove, the software prompts you to convert the selected item to a dummy
item in the buffer. The prompt message only appears if the item that you select may
have sub-items, for example, a panel, terminal strip, cable, and so forth.
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.
See Also
Target Project Buffer (on page 460)
Item Indicators (on page 462)
160
1.
2.
3.
4.
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.
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.
In the tree view pane, click an item type folder to display the items in the Items pane.
In the Items pane, select and right-click one or more items.
On the shortcut menu, click Claim.
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.
See Also
As-Built Explorer (on page 453)
Source Project Explorer (on page 459)
Item Indicators (on page 462)
You can only claim As-Built items from the command line after copying them to the Claim
Buffer. For details, see Copy Items to the Claim Buffer (on page 157).
After copying the items, you must close the Administration module prior to claiming the
items from the command line.
It is not possible to claim items from the command line using another project as a claim
source.
161
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
Main
<user name>
User1
<user password>
User1
<Owner operator
domain name>
SPI1
<target project
name>
<claim flag>
Example
Main User1,User1,SPI1,Project1,C
162
Claim Documents
Prior to claiming documents we recommend that you read the Prerequisites for
Claiming Documents (on page 162) 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.
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.
163
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 owner operator 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.
See Also
As-Built Explorer (on page 453)
Item Indicators (on page 462)
Create an Owner Operator Domain (on page 83)
164
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.
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 AsBuilt and projects. For a description of these and other requirements, see Tool Requirements
for Integrating SmartPlant Instrumentation (on page 259).
165
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.
166
Loop
Tag
Terminal Strip
Terminals
Cable
Wire
You cannot select basic engineering data manually or set the software to merge tags
without including the associated basic engineering data.
167
168
See Also
Owner Operator Domain (As-Built and Projects) (on page 125)
Owner Operator Domain (As-Built and Projects) Common Tasks (on page 127)
169
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.
170
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.
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.
171
See Also
Item and Sub-Item Selection Options for Merging with As-Built (on page 167)
Remove Items from the Merge Buffer (on page 173)
See Also
Item and Sub-Item Selection Options for Merging with As-Built (on page 167)
Remove Items from the Merge Buffer (on page 173)
See Also
Item and Sub-Item Selection Options for Merging with As-Built (on page 167)
Remove Items from the Merge Buffer (on page 173)
172
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.
See Also
Item and Sub-Item Selection Options for Merging with As-Built (on page 167)
Remove Items from the Merge Buffer (on page 173)
On removing the items, the software removes the associated sub-items according to the
settings you defined on the General tab (see "General Tab (Preferences for Scoping and
Merging Data Dialog Box)" on page 350) of the Preferences for Scoping and Merging
Data dialog box.
If the preference setting is No sub-items and you select a single item for removal, the
software cannot detect whether this item has sub-items in the Merge Buffer or not.
Therefore, on clicking Remove, the software prompts you to convert the selected item
to a dummy item in the Merge Buffer. The prompt message only appears if the item
that you select may have sub-items, for example, a panel, terminal strip, cable, and so
forth.
173
174
175
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 owner operator 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.
See Also
Item and Sub-Item Selection Options for Merging with As-Built (on page 167)
176
See Also
Generating Reports for Merging Data Common Tasks (on page 167)
Generate Comparison List Reports (on page 169)
Item Comparison Options (on page 177)
Main Item
Line
Process Data
Document
None
Process Equipment
None
Loop
None
Tag
Fieldbus Segment
None
Connector
None
Panel
Controller
None
Rack
None
Slot
None
Wiring Equipment
None
Terminal Strip
1 Side, 2 Side
177
Main Item
Channel
None
Terminal
1 Side, 2 Side
Cable
1 Side
Cable set
1 Side
Wire
1 Side
None
See Also
Owner Operator Domain (As-Built and Projects) (on page 125)
Compare Project Data with As-Built Data (on page 176)
Prerequisites for Claiming Documents (on page 162)
Owner Operator Domain (As-Built and Projects) Common Tasks (on page 127)
178
See Also
Merging Project and As-Built Data (on page 164)
Copy Items to the Merge Buffer Common Tasks (on page 171)
Owner Operator Domain (As-Built and Projects) Common Tasks (on page 127)
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.
179
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 page 178).
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.
See Also
Merging Project and As-Built Data (on page 164)
Merge Buffer (on page 456)
Item Indicators (on page 462)
See Also
Merging Project and As-Built Data (on page 164)
Merging Project and As-Built Data Common Tasks (on page 174)
Project Explorer (on page 457)
Item Indicators (on page 462)
180
You can only merge project items from the command line after copying them to the Merge
Buffer. For details, see Copy Items to the Merge Buffer Common Tasks (on page 171).
After copying the items, you must close the Administration module prior to merging the
items from the command line.
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
Main
<user name>
User1
<user password>
User1
<Owner operator
domain name>
SPI1
Project1
<merge flag>
Example
Main User1,User1,SPI1,Project1,M
181
Naming Conventions
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 its
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.
182
You can use some parts of the Flexible standard with the Power Station Designation System
(KKS) standard.
183
See Also
Define Panel Location Levels (on page 224)
184
Click
5.
6.
7.
8.
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.
Click Add as many times as the number of segments you want to specify for the naming
convention.
The Insert button allows you to insert an empty row above the cell that you click. If
you do not click any cell, the Insert button functions like the Add button: the software adds
an empty row at the bottom.
From the Segment Category list, select a segment category in each of the data rows.
From the Segment list, select a segment for each category.
In the Separator box, type a character to separate the current segment from the next.
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.
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.
You can select a part of a segment by specifying the appropriate Start and Length
values.
185
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.
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.
12.
13.
14.
15.
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.
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.
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.
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.
When done, click Apply to save the naming conventions to the database.
Click Close to close the dialog box.
See Also
Log on as Domain Administrator (on page 68)
186
4.
5.
6.
7.
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.
Click Copy To.
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>.
Click Copy and then Close.
In the Naming Conventions dialog box, click Apply and then Close.
See Also
Log on as Domain Administrator (on page 68)
Click .
Beside Parent hierarchy, click Browse to specify a target <unit>.
Click Copy From to select a source <unit>.
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.
Click OK to return to the dialog box where you can view the naming conventions you
copied.
In the Naming Conventions dialog box, click Apply and then Close.
See Also
Log on as Domain Administrator (on page 68)
187
188
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.
189
With the Domain Administration window open, click Report > Naming Convention.
See Also
Domain Administration Common Tasks (on page 119)
190
With the Wire End Naming Conventions dialog box open, select Enable using wire end
naming conventions.
191
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.
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.
192
Access Rights
One of the key roles of the Domain Administrator is to define user access rights. In an owner
operator, domain, 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
Owner operator, 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 (on
page 195).
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.
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.
193
194
Item or
Activity
Description
Level
Access Rights
Management
Add-Ins
Administration
Reports
Domain
Domain
Assign Users to
Groups
Domain
Auto Cross
Wiring
Access rights for the Automatic CrossWiring feature in the Wiring module.
Plant
Auto Wiring
Binder Package
Deletion
Browser Buffer
Use
Parent
Wiring Module
Access
Plant
195
Item or
Activity
Description
Level
Browser
Manager
Plant
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.
Browser
Manager Filter
Plant
Browser
Manager Sort
Plant
Browser
Manager Style
Plant
Browser
Manager Style
Headers
Plant
196
Parent
Domain
Browser User
Name, Change
Date
Cable Routing
and Drums
Plant
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.
Cable Routing
Options
Command
Calculation
Activities
Unit
Access rights to perform calculations. To
enable calculations, set this option to Full
(Add / Delete / Update) and the 'Calculation
Module Access' option to Full (Add / Delete
/ Update) or Modify (Add / Update).
Calculation
Module Access
Plant
Calculation
Module Access
Unit
Item or
Activity
Description
Level
Parent
Calibration
History Editing
Unit
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.
Calib. Options
& Maint. Events
Unit
Calib. Options
& Maint. Events
Unit
Calibration
Result Modif.
Unit
Domain
Clear Locking
Domain
Calib. Options
& Maint. Events
Plant
Construction
Module Access
Unit
Construction
Access rights to define Formal Issue for
Revision - Cables project cables in the Construction module.
Plant
Construction
Module Access
Construction
Revision - Instr.
Plant
Construction
Module Access
Wiring Module
Access
197
Item or
Activity
Description
Level
Parent
Plant
Construction
Module Access
Construction
Access rights to define Formal Issue for the Plant
Revision - Wires project wires in the Construction module.
Construction
Module Access
Construction
Supporting
Tables
Domain
Construction
Module Access
Control System
Tag Operations
Plant
Custom Field
Definition
Domain
DDP Module
Supporting
Tables
Plant
Define User
Groups
Domain
DeltaV Data
Domain
Dimensional
Data Module
Access
Unit
Document
Binder Module
Access
Plant
Construction
Access rights to define Formal Issue for
Revision - Panels project panels in the Construction module.
Domain
Access rights for the Notes section in the
Definition Notes Domain Definition window - Domain
Administrator activity.
Domain
Drawing Block
Management
Domain
198
Dimensional
Data Module
Access
Loop Drawings
Module Access
Plant
Item or
Activity
Description
Level
Parent
Plant
Equipment
Access rights for the Equipment supporting Plant
Supporting Table table in the Instrument Index module.
Field Personnel
Domain
Form Data
Template
Domain
Global Revision
Management
Unit
Hook-Up
Definition
Plant
Hook-Ups
Module Access
Hook-Up Item
Management
Hook-Ups
Module Access
Hook-Ups
Module Access
Unit
Import Utility
Access
Domain
Instal. Index
Manager
Domain
Instr. Index
Supporting
Tables
Domain
Instrument
Index Module
Access
Unit
199
200
Item or
Activity
Description
Level
Instrumentation
Workflow Flag
Unit
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.
Intrinsic Safety
Definition
Line Definition
Logo Definition
Loop - External
Macro Source
Unit
Loop Drawings
Module Access
Loop Definition
Unit
Instrument
Index Module
Access
Loop Drawings
Module Access
Unit
Macro
Definitions
Domain
Maintenance
Module Access
Unit
Maintenance
Supporting
Tables
Plant
Management of
Local Revisions
Unit
Naming
Convention
Definition
Domain
Plant
Parent
Wiring Module
Access
Maintenance
Module Access
Item or
Activity
Description
Level
Parent
P&ID Supporting Access rights for the P&ID drawing number Plant
Table
supporting table in the Instrument Index
module.
Plant Cable
Management
Plant
Plant Hierarchy
Management
Domain
Plant Panel
Management
Plant
Plant Owner
Definition
Domain
Wiring Module
Access
Wiring Module
Access
Unit
Maintenance
Module Access
Unit
Maintenance
Module Access
Process Data
Change in Specs
Unit
Process Data
Definition
Unit
Process Data
Module Access
Unit
Process Data
Supporting
Tables
Domain
Access rights for the Process Data module
supporting tables, that is, Cases, Insulation
Types, Pipe/Orifice Materials, and Fluid
Components.
Process Data
Workflow Flag
Unit
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.
Process Data
Module Access
Process Data
Module Access
201
202
Item or
Activity
Description
Level
Project
Definition
Publish
Reference Cable
Management
Reference Panel
Management
SmartPlant
Registration
Domain
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.
Repair Supervisor
Unit
Retrieve
Plant
Repair Technician
Unit
Revision
Deletion
Unit
SAP Interface
Access
Domain
Segment- Wide
Parameters
Unit
Fieldbus
Segments
Plant
Parent
Plant
Maintenance
Module Access
Maintenance
Module Access
Wiring Module
Access
Item or
Activity
Description
Level
SP Electrical
Interface
Unit
Specification
Definition
Unit
Specification
Form Access
Domain
Specifications
Module Access
Tag Category
Definition
Tag Definition
Telecom Panel
Management
Plant
Telecom
Supporting
Tables
Plant
To Do List
Unit of Measure
Definition
Parent
Specifications
Module Access
Domain
Instrument
Index Module
Access
Domain
Wire Group
Plant
Wiring Module
Access
Wiring
Connections
Plant
Wiring Module
Access
203
Item or
Activity
Description
Level
Parent
Wiring Module
Access
Wiring
Supporting
Tables
Domain
Wiring Module
Access
Unit
Maintenance
Module Access
Unit
Maintenance
Module Access
6.
204
Click .
In the Access Rights dialog box, in the Group list pane, select the desired user group for
which you want to define access rights.
Double-click the group to expand the tree.
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.
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.
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.
6. If you selected the <Plant> or <Unit> level, from the <Plant> an <Unit> lists, select as
specific <plant> or <unit>.
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.
205
Click
206
Click
Preferences Management
The software allows the Domain Administrator to manage SmartPlant Instrumentation
preferences in the current domain, or in As-Built and projects in an owner operator domain.
207
Export Preferences
Use this procedure to export domain preferences (or project preferences when the domain type is
Owner operator) to an external .dmp file. For more information, see Export Preferences (on
page 210).
Import Preferences
Use this procedure to import preferences from an external .dmp file to the current domain or a
specific project if the domain type is Owner operator. For more information, see Import
Preferences (on page 211).
See Also
Domain Administration Common Tasks (on page 119)
208
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.
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.
209
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.
210
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 Owner operator, from 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.
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 Owner operator, from 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.
Report Management
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).
211
See Also
Domain Administration Common Tasks (on page 119)
212
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).
See Also
Generating Reports for Merging Data Common Tasks (on page 167)
213
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.
See Also
Generating Reports for Merging Data Common Tasks (on page 167)
214
1.
2.
3.
4.
5.
6.
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.
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.
Start the Administration module and log on as Domain Administrator.
With the Domain Administration window open, click Activities > Report Management.
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.
To filter the reports by specific module, under Filter by, select a module.
Select Apply to view the reports belonging to the specified module.
To return from the filtered view to the normal view, clear the Apply check box.
For a specific report displayed in the Report Name column, select the desired archiving
option from the list in the Archiving Options column.
If you have selected the Save to database or Do not save option, skip this step.
To use the Save as File, or Compress as Zip file options, you need to set an archive
path (as described in the next step).
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.
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.
215
Setting
Description
Example
Per Item
216
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 owner operator 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.
Add-Ins
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.
217
218
219
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.
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.
If there are typical tags in the current source database or domain, you can select
Include typical tags to export all typical tags to their target .txt files. Clearing Include
typical tags results in just the loop data being exported.
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.
220
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.
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.
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.
221
222
After importing the spec forms, you must rebuild the catalog tables. Switch to System
Administration and then click DBA > Rebuild catalog tables.
You can import only those spec forms for which you purchased an appropriate license.
In order to use these forms in SmartPlant Instrumentation, you must regenerate the
specifications that are based on these forms. You can do it for a single specification page or
for multiple ones in batch mode, For more information, see the SmartPlant Instrumentation
Help, Specifications > Specification Pages > Regenerate a Specification Page or Regenerate
Pages in Batch Mode.
223
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 (on page 231).
See Also
Domain Administration (see "Domain and Project Administration" on page 119)
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 ( & ).
The location level names must be unique.
5. Do one of the following:
224
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>&.
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.
See Also
Panel Location Levels Dialog Box (on page 345)
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.
225
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 (on page
228).
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.
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.
7. Repeat the procedure to make custom field definitions for another <plant> or for another
item or data type.
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 (on page 226)
226
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
227
Click .
From the <Plant> list, select a target <plant>.
Click Copy From.
In the dialog box that opens, select a source <plant> and then click OK.
In the Custom Fields dialog box, click Apply.
228
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
Calibration Result
Calibration Setting
Item/Data Type
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
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
Line
Line Browser
Line Component Browser
Line PD Data Browser
Loop
Block Browser
Enhanced SmartLoop Browser
Loop Browser
Loop Drawing Browser
229
Item/Data Type
Browser
Panel
Process Data
Revision
Revision Browser
Strip
Terminal
Wire
Wire Browser
Wire Schedule Instal. Index
Wire Schedule Instal. Index Changes
230
Report
Description
User List
Displays 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.
SmartPlant Instrumentation users of the domains for which you have access rights,
listed according to the groups to which they belong.
Domain Statistics
Access Rights
Displays 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.
Cable Type
Dependency
Validation
Displays a list of all reference cables that do not comply with the cable type
dependency requirements. If the report contains any data, the System
Administrator cannot enable cable type dependency in the domain. For details
about cable type dependency, see Enable Cable Type Dependency (on page 85).
See Also
Miscellaneous Domain Administration Tasks (on page 222)
231
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.
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 .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
8. Click
See Also
Miscellaneous Domain Administration Tasks (on page 222)
See Also
Miscellaneous Domain Administration Tasks (on page 222)
232
6. Click
See Also
Miscellaneous Domain Administration Tasks (on page 222)
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.
233
Some reports have their orientation hard-coded, therefore only the hard-coded settings
apply.
See Also
Log on as Domain Administrator (on page 68)
234
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).
In the complete file name, the audit trail period is displayed in the following order: year,
month, and day.
6. Click Load.
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.
235
236
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.
237
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"
Clearing Locking
This option enables the Domain Administrator to clear locking in 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.
238
See Also
Print Database Connection Information (on page 118)
Domain Administration Common Tasks (on page 119)
239
See Also
Print Database Connection Information (on page 118)
240
Copying Data
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 is an
owner operator domain, you can select a specific project to which you want to copy <unit> data
from the source project.
It is only possible to copy data to a <unit> that has no naming conventions. In the target <unit>,
the software creates naming conventions according to the naming convention definitions in the
source <unit>. Therefore, after you copy data to a particular <unit>, it is not possible to copy
any additional data to the same unit again. When copying <unit> data, the software does not
copy the access right definitions set for the source <unit>.
After copying data from one <unit> to another within a <plant> that is registered with
Integration, it is possible to publish data from the new <unit>. When copying data to a <unit> in
another <plant>, the Integration registration information is not copied.
You copy <unit> after making source data selections on the Copy Data from Source dialog
box. Your module data selection is retained when you reopen the Copy Data from Source
dialog box apart from the following options:
Selection of specification item types
Selections on the Wiring Item Naming Options dialog box
Revision copying options
The following table lists the modules and the module data available for selection on the Copy
Data from Source dialog box.
Module
Module Data
Instrument
Index
Tag numbers
Loop numbers
P&ID drawing references
Lines
Equipment
Document associations
Calibration
Custom tables
241
Module
Module Data
Process Data
Process data sheets with or without
and Calculation revisions
Calculation sheets with or without
revisions
Specifications
Wiring
Hook-Ups
You can only copy the Hook- Ups module data in its
entirety.
Hook-ups are not copied to another <plant>. You can
copy hook-ups to another <plant> using the Merger
Utility options.
Hook-u associations with instruments are not copied to
another <plant>, only within the same <plant>.
Browser
Dimensional
All module data
Data for Piping
242
243
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>.
When the domain is an owner operator domain, select the required project from the
Source project list, and then select the <unit> whose data you want to copy.
4. Click OK to open the Copy Data from Source dialog box.
The Copy Data from Source dialog box retains previous settings that you used the last
time when you were copying data, apart from specification item types and wiring item
naming conventions. You can use the same settings, discard some of them, or discard
them all. Click Clear All to discard all the displayed settings.
Now you can either copy all data of a particular module or copy specific data. For
details, see Copy All Module Data (on page 246) or Copy Specific Data (on page 244).
244
2.
3.
4.
5.
6.
7.
8.
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 view-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.
In the Name prefix field, type a new name prefix to be applied to all the copied items.
In the Name suffix field, type a new name suffix to be applied to all the copied items.
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.
If required, set revision copying options. For details, see Set Revisions for Target Plant
Hierarchy Item (on page 248).
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.
In the No. of chars. data field, type the number of characters in the name string to be
substituted.
In the Value field, type a new value that will substitute a part of the module item name
string.
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>.
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.
9. 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>.
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.
245
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.
10. In the left section, select other specific data, and repeat this procedure.
11. If needed, click Options to set naming options for wiring items in the target <unit>. For
details, see Set Wiring Naming Options for Target Plant Hierarchy Item (on page 247).
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.
12. Click OK to close the Copy Data from Source dialog box and monitor the progress of
copying the source data.
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.
When you define data copying settings for the Loop Drawings module, the Copy all
module data check box does not apply to CAD drawing blocks associated with
instrument tags or loops. CAD blocks is SmartPlant Instrumentation are defined per
<plant>. When copying Loop Drawings module data to another <plant>, if your source
instruments include instrument blocks assigned manually or loop blocks, these blocks
are not created in the target <plant>. On the other hand, instrument blocks associated
with tags via instrument type are created in the target <plant> regardless of whether this
check box is selected or cleared.
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.
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.
246
247
4.
5.
6.
7.
8.
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.
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.
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>.
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.
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.
Click OK to accept the settings, and return to the Copy Data from Source dialog box.
248
249
250
SECTION 9
251
Registering Tools
Before you can publish and retrieve information from any of the authoring tools, you must
register each plant in SmartPlant Instrumentation with a SmartPlant Foundation database. The
connection allows SmartPlant Instrumentation to use the SmartPlant integration commands. A
SmartPlant Instrumentation Domain Administrator typically performs the registration.
The software maps a plant and all its projects to a single SmartPlant Foundation URL, which
points to one, and only one, SmartPlant Foundation plant database and its projects. When you
use the Register command in any of the authoring tools, you are registering an authoring tool
plant with a SmartPlant Foundation URL and plant that you specify.
The Domain Administrator must register each plant in the authoring tool once; this action takes
place in the Administration module. After the plant is registered, you can publish and retrieve
documents.
Tool registration information is not upgraded in SmartPlant Foundation; therefore,
each tool must re-register with SmartPlant Foundation after upgrading SmartPlant Foundation.
Since it is not possible to re-register a SmartPlant Instrumentation plant using the interface
options, if you must re-register a SmartPlant Instrumentation plant, contact Intergraph Customer
Support.
252
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 (on page 256).
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.
On an Oracle platform, if using a single Oracle instance, the schema names, tablespace
names, and user names must be unique in each tool and in SmartPlant Foundation. For
example, if the schema name in SmartPlant foundation is Site 1, the SmartPlant
Instrumentation domain name cannot also be Site 1.
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.
253
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\.
If you are using SmartPlant Foundation versions 2007 or 2008, you must replace the
ContextMap.xml file in the <SmartPlant Instrumentation home folder>\XML\ folder
with the ContextMap.xml <SmartPlant Instrumentation home folder>\XML\Backup
folder. By using the ContextMap.xml in <SmartPlant Instrumentation home
folder>\XML\Backup folder, the software properly publishes documents.
9. Save the changes and then close the Domain Definition window.
10. On the Module Toolbar, click User
and define an IDEAL user. For details, see Define
an IDEAL User (on page 255).
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.
If your domain type is Owner operator, 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.
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 (on page 255).
16. Register each SmartPlant Instrumentation plant that you want to use in an integrated
environment. For details, see Register a Plant (on page 256).
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 case-sensitive). After that, you just need to register SmartPlant
Instrumentation, retrieve the plant hierarchy from SmartPlant Foundation, and correlate the
two plant hierarchies.
254
See Also
Set the Project Status for an Integrated Environment (on page 136)
When you first define an IDEAL user on a Windows 2003 server, the Operating System
automatically assigns the following policy for that user:
Deny local logon
Deny access to this computer from the network
6. You need to remove the IDEAL user from the above policy list, and then add the IDEAL
user to the following policy list:
Allow local logon
Allow access to this computer from the network
255
5.
6.
7.
8.
9.
10.
11.
12.
13.
14.
15.
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 (on page 256).
On the SmartPlant Foundation Login dialog box, type the appropriate user name and
password.
On the Retrieve dialog box, in the Document type list, select All.
Under Show, select All documents.
Under Documents to retrieve, select the PBS document for the desired plant.
Click OK to retrieve the document.
At the confirmation prompt, click Close.
On the Select Plant dialog box, click Cancel to close the dialog box.
Click SmartPlant > To Do List.
On the To Do List dialog box, select all the tasks that appear in the list.
Click Run to create the plant hierarchy in SmartPlant Instrumentation.
You cannot defer tasks or view To Do List task properties when retrieving a plant
hierarchy in the Administration module.
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.
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>.
5. For example:
http://<SPFServer>/SPFASP.
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.
6. Click Next.
256
See Also
Domain Administration Common Tasks (on page 119)
Merging Project and As-Built Data (on page 164)
Enable Item Registry (on page 87)
257
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 (on page 258).
See Also
Domain Administration Common Tasks (on page 119)
Register Items
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.
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.
See Also
Enable Item Registry (on page 87)
Clear Locking in All Sessions (on page 240)
258
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:
259
Segment
Property
InstrTagPrefix
MeasuredVariable+InstrFuncModifier
InstrTagSequenceNo
4
InstrTagSuffix
Segment 1 is populated with the InstrTagPrefix
Segment 2 is populated with the concatenation of MeasuredVariable and InstrFuncModifier
Segment 3 is populated with the InstrTagSequenceNo
Segment 4 is populated with the InstrTagSuffix
The segments are then trimmed and put together according to the naming convention to create
the tag number.
If the naming convention in other tools (for example, SmartPlant P&ID) does not include a
prefix, the first segment length needs to be set to 0.
Loop Retrieval
When you retrieve a loop, the software populates the loop name segments from the retrieved
instrument object properties according to the following mapping:
Segment
Property
LoopPrefix
LoopIdentifier
3
4
LoopSequenceNo
5
LoopSuff
Segment 1 is populated with the LoopPrefix
Segment 2 is populated with the LoopIdentifier
Segment 4 is populated with the LoopSequenceNo
Segment 5 is populated with the LoopSuff
Segment 3 is not populated and needs to be set to length 0
Instrument Publishing
When you publish an instrument, the software populates the published object properties by the
naming convention segments as follows:
260
Property
Segment
Comment
InstrTagPrefix
MeasuredVariable
InstrFuncModifier
Property
Segment
InstrTagSequenceNo
Comment
InstrTagSuffix
4
The object name is populated by the tag number with all spaces removed. If the length of prefix
is more than 0, the prefix will be part of the object name. Other applications that publish
instruments (for example, SmartPlant P&ID) need to be configured to publish the instrument
object name with the prefix.
The MeasuredVariable and InstrFuncModifier are both populated be the second segment. If the
first two characters of segment 2 are included in the TwoLetterMeasuredVariable list that was
defined in the SmartPlant Instrumentation mapping file, then the MeasuredVariable gets these
two letters; if not then the MeasuredVariable gets the first character of segment 2. In both cases,
the InstrFuncModifier gets the rest of the characters of segment 2. This allows correct
publishing of instruments such as PDT or DPT.
TwoLetterMeasuredVariable
DP
PD
FQ
FF
TD
WD
ZD
FO
Loop Publishing
When you publish a loop, the software populates the published object properties by the naming
convention segments as follows:
Property
Segment
LoopPrefix
LoopIdentifier
2+3
LoopSequenceNo
LoopSuff
5
The object name is populated by the loop name with all spaces removed. If the length of prefix
is more than 0, the prefix will be part of the object name. Other applications that publish loops
(for example, SmartPlant P&ID) need to be configured to publish the loop object name with the
prefix.
261
262
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.
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.
263
264
If needed, convert the domain type of an existing SmartPlant Instrumentation domain from
Engineering company (EPC) to Owner operator. For more information, see System
Administration > Domain Management > Create an Owner Operator Domain in the
SmartPlant Instrumentation Administration User's Guide.
In the Domain Definition window, under Domain type, select Owner operator and select
Exclusive claim mode. SmartPlant integration does not support having the same item
claimed for different projects.
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
> Owner Operator: 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 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.
265
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>
266
267
6. Click
to save the current domain data to the database.
If you select or cancel this option while SmartPlant Instrumentation is open, you must
then restart SmartPlant Instrumentation for the change to take effect.
268
SECTION 10
Resource File
Description
MenuLibrary80.dll
All user interface text strings for the Domain and Reference
Explorers and Preferences for the Enhanced Report Utility
SmartLoop8.drx
SymbolEditor8.drx
SmartPlantEN.dll
Dialog box labels and error messages for the Enhanced Report
Utility and Symbol Editor
ESLAboutEN.dll
SEAboutEN.dll
Translated text appears in the main SmartPlant Instrumentation interface, the Administration
module, and in the Import and Merger utilities. The text strings are stored in the
In_catalog.db file.
Text in the following software components is not translated:
Initialization and Update interfaces
Rule Manager
Internal Setup
SAP Interface
269
Fluke Wizard
External Editor
Process Data Editor
See Also
System Administration Common Tasks (on page 81)
271
The column headers that appear depend on the available languages, for example:
Custom Phrase, French Phrase, German Phrase, and so forth.
You can compare phrases more easily by moving two columns closer together. Drag a
column header and drop it in the desired location.
If you leave any fields blank for the target language, text from the Original Phrase
column (English) will appear in those fields in the interface after switching languages.
This is useful for terms that are the same in your language as in English; otherwise, you
should not leave fields blank in order to prevent the occurrence of phrases belonging to
more than one language appearing in the interface.
Make sure that you add the same prefixes, suffixes and punctuation marks that appear in
the corresponding original phrases of that interface language, for example: ~, &. For
details, see Prefixes and Suffixes in the Interface Text (on page 273).
4. Do one of the following:
Click Update to save the changes to the database. (If you want to save the changes to
an external language file and not to the database, do not click Update.)
Click Save File to save the translated interface text to an external language file with a
.psr extension.
5. Click Close to close the Edit Translation Text dialog box.
272
Prefix/Suffix
Function
Syntax
Example
&
&<interface text>
&Action
&&
&&
Operators &&
Functions
~n
<interface
text>~n<interface text>
~nContinue?
~r
Warning~n~r
~t
&Action~tCtrl+A
<interface
text>~t<interface text>
273
274
SECTION 11
A
Topics
Access Rights Window Toolbar .................................................... 275
Access Rights Window .................................................................. 276
Accounting Dialog Box ................................................................. 277
Active Database Connections Dialog Box .................................... 278
Activity Tracking Report Settings (Graph) Dialog Box ................ 278
Activity Tracking Report Settings (Grid) Dialog Box................... 279
Add Accounting Dialog Box ......................................................... 279
Add Client Dialog Box .................................................................. 280
Add Contractor Dialog Box ........................................................... 280
Add Database Views Dialog Box .................................................. 280
Add Datafiles (SQL Server) Dialog Box ....................................... 281
Add Datafiles (Oracle) Dialog Box ............................................... 281
Administration Window ................................................................ 282
Advanced Domain Preferences Dialog Box .................................. 282
Advanced Filter Definition (Cables) Dialog Box .......................... 283
Advanced Filter Definition (Loops) Dialog Box ........................... 284
Advanced Project Preferences Dialog Box.................................... 285
Area Properties Dialog Box ........................................................... 286
Assign Groups to Project Dialog Box ........................................... 287
Assign Users to Groups Dialog Box .............................................. 287
275
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 Owner operator.
276
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 (on page 195).
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.
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.
SmartPlant Instrumentation Administration User's Guide
277
Print
Prints the list of the connected users without opening a print preview.
278
279
280
Filegroup
This tab allows you to add new datafiles to a filegroup.
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.
281
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.
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.
282
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.
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.
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.
283
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 panels.
DCS panels Includes all the cables that are connected to DCS panels.
PLC panels Includes all the cables that are connected to PLC panels.
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.
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 .
284
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.
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.
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.
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.
285
286
287
B
Topics
Back Up Domain Dialog Box ........................................................ 288
Backup Repository Dialog Box ..................................................... 289
288
On completion of the backup process, the software records details of any 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.
Enables you to specify the target folders to which the software backs-up reports, and select the
documents you wish to include in the backup.
To open this dialog box, in the Back Up Domain dialog box, click Files.
289
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
Backing Up Files Containing Audit Trail Data (on page 37).
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.
C
Topics
Change Admin Schema Password Dialog Box ............................. 291
Change Domain Schema Password Dialog Box ............................ 291
Change Security Schema Password Dialog Box ........................... 291
Change Password Dialog Box ....................................................... 291
Clear Activity Tracking Data Dialog Box ..................................... 292
Clear Locking in Selected Sessions Dialog Box ........................... 292
Client Dialog Box .......................................................................... 293
Colors Dialog Box ......................................................................... 293
Comparison List Dialog Box ......................................................... 294
Comparison List Filter Dialog Box ............................................... 295
Comparison List Report Dialog Box ............................................. 296
Contractor Dialog Box................................................................... 296
Copy Data from Source Dialog Box .............................................. 297
Copy Access Rights Dialog Box ................................................... 301
Copy From Dialog Box ................................................................. 302
Copy from Project Dialog Box ...................................................... 302
Copy from Project Dialog Box ...................................................... 302
Copy Naming Conventions From Dialog Box .............................. 302
Copy Naming Conventions Dialog Box ........................................ 303
Copy to Projects Dialog Box ......................................................... 303
Custom Fields Dialog Box ............................................................ 303
Custom Tables Dialog Box............................................................ 305
290
291
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.
293
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 As-Built 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.
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.
294
295
Command Buttons
Apply Saves all the changes you have made.
296
Command Buttons
OK Copies the <unit> data to the target <unit>. 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.
Click this button only after you have finished making data selection. After you click
OK, canceling the copying process can corrupt the data in the target <unit> and render the
<unit> unusable.
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.
Wiring item naming settings are not retained when you reopen the Copy Data from
Source dialog box.
297
298
299
300
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.
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, 101F-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.
301
302
303
Data Window
Contains all custom fields available in the SmartPlant Instrumentation database.
Number Displays the custom field sequence numbers in the data window.
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 (on page 226).
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.
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.
304
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.
D
Topics
Database Upgrade Dialog Box ...................................................... 305
Data Files to Delete Manually Dialog Box.................................... 307
Delete Invalid Domain Dialog Box ............................................... 307
Delete Projects Dialog Box ........................................................... 307
Department Dialog Box ................................................................. 308
Domain Data and Indexes Dialog Box .......................................... 308
Dimensional Data Settings Dialog Box ......................................... 309
Domain Administration Window .................................................. 310
Domain Definition Window (Domain Administration)................. 310
Domain Definition Window Toolbar (Domain Administration) ... 314
Domain Definition Window (System Administration).................. 314
Domain Definition Window Toolbar (System Administration) .... 319
Domain Tablespace Definition Dialog Box .................................. 319
305
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.
306
307
Data Window
Displays all projects available in the current owner operator domain. If, in the owner operator
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.
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
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 Auto-extend feature automatically increases the size of this file if needed.
308
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 Auto-extend 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.
309
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 Owner operator.
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 type
Displays the domain type defined by the System Administrator for 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.
Owner operator 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 owner operator 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 As-Built. 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 AsBuilt. 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.
Domain usage Indicates the usage of an Owner operator domain, which can be one of
the following:
None This is the default value for a domain after an upgrade.
Host Indicates that the domain is defined as host.
Satellite Indicates that the domain is defined as a satellite under a particular host
domain.
Sub-contractor Indicates that the domain is defined as a sub-contractor under a
particular satellite domain.
Domain features
Activity tracking Indicates whether activity tracking options are enabled by the System
Administrator.
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).
311
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.
Obtain Revision from SmartPlant Foundation Indicates whether SmartPlant
Instrumentation uses SmartPlant Foundation to create a new revision for the publishable
documents or uses its own internal revision settings. When the check box is selected, on
publishing a report, the software first checks whether the report has a SmartPlant Foundation
revision and then assigns the appropriate revision scheme automatically. If a user added a
SmartPlant Instrumentation revision previously, but did not obtain a new revision from
SmartPlant Foundation, the software uses the SmartPlant Instrumentation Revision schema to
publish reports. In case of data changes in the report, SmartPlant Foundation automatically
upgrades the revision number when publishing the report. This option only applies to the
reports that SmartPlant Instrumentation can publish for The Engineering Framework. With the
check box selected, you can still use internal SmartPlant Instrumentation revision options, for
those items not registered to SmartPlant Foundation.
If the check box is cleared, SmartPlant Instrumentation users can add revisions to publishable
reports using only internal SmartPlant Instrumentation revision settings. SmartPlant Foundation
revision options become inaccessible. If a user obtained a revision from SmartPlant Foundation
previously, but did not make a new SmartPlant Instrumentation revision, the software ignores
the previous revision and does not allow publishing of the report until the user creates a revision
in SmartPlant Instrumentation.
312
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 Owner operator, 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.
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 needed.
313
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 type is Owner operator, 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.
Domain type
Select the domain type depending on the activities you want to perform in your engineering
plants.
We do not recommend working in an owner operator domain if it resides in a standalone database. It is known that when using the Sybase Adaptive Server Anywhere database
engine, certain options in an owner operator domain are liable to work incorrectly.
314
Domain features
Activity tracking Enables the use of activity tracking.
Audit trail options Enables the use of audit trail options.
Item registry Enables the Domain Administrator to use item registry options.
Cable type dependency Enables cable type dependency.
315
316
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.
Workflow
Instrumentation and process data Only applies where the selected domain type is
Engineering company. For the domain type Owner operator, 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.
317
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.
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.
318
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.
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.
After domain deletion in SQL Server, the devices are left in place connected to the
database, and can be used for a new domain.
319
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.
320
E
Topics
Export Macros Dialog Box ............................................................ 321
321
F
Topics
Field Personnel Profile Dialog Box ............................................... 322
Filegroup List Dialog Box ............................................................. 322
Filter Definition Dialog Box.......................................................... 322
Find Item Dialog Box .................................................................... 323
322
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.
323
G
Topics
Generate Access Rights Report Dialog Box .................................. 324
Global Access Rights Dialog Box ................................................. 325
Group Dialog Box ......................................................................... 326
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.
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.
324
Project
(only available when the domain type is Owner operator)
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 owner
operator 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.
325
326
I
Topics
Import Browser Views Dialog Box ............................................... 327
Import Spec Forms Dialog Box ..................................................... 328
Import DCS Hardware I/O Library Dialog Box ............................ 329
Import DDP Library Data Dialog Box .......................................... 329
Import Hook-Up Library Dialog Box ............................................ 329
Import Interface Language Dialog Box ......................................... 330
Import Macros Dialog Box ............................................................ 330
Import System Interfaces Dialog Box ........................................... 330
Initialize (Oracle) Dialog Box ....................................................... 331
Initialize (SQL Server) Dialog Box ............................................... 333
Initialize (Sybase Adaptive Server Anywhere) Dialog Box .......... 334
Items and Activities for Access Rights Dialog Box ...................... 336
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.
327
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
PSR folder path Allows you to specify the location of the PSR files in your domain. You
can type the file name and path or click Browse. You have to select the Spec_PSR folder
located in the path 'Program Files\SmartPlant\Instrumentation\'. Also, make sure that you
include a file name in the path that you set.
328
After importing the spec forms, you must rebuild the catalog tables. Switch to System
Administration and then click DBA > Rebuild catalog tables.
You can import only those spec forms for which you purchased an appropriate license.
In order to use these forms in SmartPlant Instrumentation, you must regenerate the
specifications that are based on these forms. You can do it for a single specification page or
for multiple ones in batch mode, For more information, see the SmartPlant Instrumentation
Help, Specifications > Specification Pages > Regenerate a Specification Page or Regenerate
Pages in Batch Mode.
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 Foxboro - I/A FBMs in the
Select panel library pane.
Miscellaneous Options
Select panel library Displays the Foxboro - I/A FBMs library after you connect to the
IN_CTLOG.DB file and allows you to select the library for import.
Import Imports the content of the Foxboro - I/A FBMs library to the database.
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.
SmartPlant Instrumentation Administration User's Guide
329
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.
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.
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
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 data.
Import Imports the selected link group from the source database file to your database. The
button becomes accessible after you click Connect.
331
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.
By default, the Domain schema password is not encrypted. When performing a database
connection, the software retrieves the logon name and password from the PROJECT table of
the Admin schema. If needed, the System Administrator can encrypt all the domain
passwords in the database, including passwords of new domains you initialize in the current
database.
View-Only Domain schema password Allows you to change the default logon password of
the View-Only Domain schema. The value that you type must be unique and typed as one word
with no spaces. You can use an underscore (_) to replace a space. The View-Only Domain
schema holds database views of all tables in a domain. This schema enables viewing data for
users of report generators, such as Microsoft Access and InfoMaker. The View-Only Domain
schema logon name is <Domain schema logon name>_VIEW. The logon name is set
permanently in the software. The default logon password is also <Domain schema logon
name>_VIEW. The maximum password length is fifteen characters (not case-sensitive).
In the database, the password is not encrypted. If you change the password, make sure
you make a record of the change so that you can use the password if you have to rebuild the
default views in the domain. You can change the password only once, when initializing a new
domain. The default password and the characters that you type when changing the password
appear masked.
Miscellaneous Options
Date Displays the date of the initialization process.
Start time Displays the start time of the initialization process.
End time Displays the end time of the initialization process.
Do not display error messages Allows you to run the initialization process without
displaying any error messages that can appear during the process. The software records errors
into the InitLog.txt file, located in the SmartPlant Instrumentation home folder. This file can
contain records from previous backup or initialization sessions.
Command Buttons
OK Opens 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.
332
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.
By default, the Domain schema password is not encrypted. When performing a database
connection, the software retrieves the logon name and password from the PROJECT table of the
Admin schema. If needed, the System Administrator can encrypt all the domain passwords in
the database, including passwords of new domains you initialize in the current database.
View-Only Domain schema password Allows you to change the default logon password of
the View-Only Domain schema. The value that you type must be unique and typed as one word
with no spaces. You can use an underscore (_) to replace a space. The View-Only Domain
schema holds database views of all tables in a domain. This schema enables viewing data for
users of report generators, such as Microsoft Access and InfoMaker. The View-Only Domain
schema logon name is <Domain schema logon name>_VIEW. The logon name is set
permanently in the software. The default logon password is also <Domain schema logon
name>_VIEW. The maximum password length is fifteen characters (not case-sensitive).
333
Miscellaneous Options
Date Displays the date of the initialization process.
Start time Displays the start time of the initialization process.
End time Displays the end time of the initialization process.
Do not display error messages Allows you to run the initialization process without
displaying any error messages that can appear during the process. The software records errors
into the InitLog.txt file, located in the SmartPlant Instrumentation home folder. This file can
contain records from previous backup or initialization sessions.
Command Buttons
OK Opens 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.
Source If you initialize a new domain from an existing source domain, click this button to
open a dialog box where you can connect to the source domain residing in Sybase Adaptive
Server Anywhere or in a SQL Server database.
334
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.
The Domain schema password is not encrypted and cannot be encrypted; after initializing a
domain, the Domain schema logon password becomes set permanently in the software.
When performing a database connection, the software retrieves the logon name and
password from the PROJECT table of the Admin schema.
View-Only Domain schema password Allows you to change the default logon password of
the View-Only Domain schema. The value that you type must be typed as one word with no
spaces. You can use an underscore (_) to replace a space. The View-Only Domain schema
holds database views of all tables in a domain. This schema enables viewing data for users of
report generators, such as Microsoft Access and InfoMaker. The View-Only Domain schema
logon name is <Domain schema logon name>_VIEW. The logon name is set permanently in the
software. The default logon password is also <Domain schema logon name>_VIEW. The
maximum password length is fifteen characters (not case-sensitive).
In the database, the password is not encrypted. If you change the password, make sure
you make a record of the change so that you can use the password if you have to rebuild the
default views in the domain. You can change the password only once, when initializing a new
domain. The default password and the characters that you type when changing the password
appear masked.
Miscellaneous Options
Date Displays the date of the initialization process.
SmartPlant Instrumentation Administration User's Guide
335
Command Buttons
OK Starts the initialization process.
Source If you initialize a new domain from an existing source domain, click this button to
open a dialog box where you can connect to the source domain residing in Sybase Adaptive
Server Anywhere, Oracle, or SQL Server.
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.
336
L
Topics
List of Duplicate Items Dialog Box ............................................... 337
Load Audit Trail Data Dialog Box ................................................ 337
Log File Dialog Box ...................................................................... 338
(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.
Period
From Allows you to type the initial date (month/day/year) of the audit trail data trimmed
from the audit trail repository in the source domain.
337
Miscellaneous Options
Load from file Allows you to type the user-defined file name segment as it appears in the
external file to which you have saved this data.
Load Loads the audit trail data to the audit trail repository in the current domain.
M
Topics
Microsoft SQL Server Connection Dialog Box............................. 338
338
N
Topics
Naming Conventions Dialog Box.................................................. 339
339
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.
Remove spaces in file names (only available when you select a document from the Convention
box) Allows you to remove spaces from the name of the document files. When saving a
document as a file, the software automatically applies the document item name to the file name.
For example, when you generate a loop drawing without opening the drawing, the software
saves the drawing file with the name of the source loop number. If the source loop number has
spaces, the software removes the spaces from the drawing file name.
Data Window
Segment Category Displays segment categories for which you can select specific segments
that comprise the naming convention string. The segment categories change according to the
item you select from the Convention list.
The Segment Category list of the always includes three default levels of the plant
hierarchy, even if you defined more than three levels in the Plant Hierarchy dialog box. The
default segment categories are Plant, Area, and Unit, where Plant stands for the highest
hierarchy level item of the parent hierarchy, Unit for the current <unit>, and Area for the
intermediate level item under which you created the <unit> in the Plant Hierarchy Explorer.
Seq. (Sequence) Displays the position of the segment in the naming convention string. You
cannot change this setting.
340
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 do want a separator to appear at the end of the item name, you must add another data
row and select Free Segment as both segment category and segment. Then, you define a
separator and also define the Free Segment length as 0.
Segment Allows you to select a segment for the corresponding segment category. The list of
segments change according to the category you selected from the Segment Category list. For
example, for the Unit category, you can select a Unit Number, Unit Name, or custom field
segment as the prefix segment of the naming convention string.
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.
Start Allows you to enter a number that determines the starting position of the corresponding
description setting to be used in the appropriate segment of the naming convention.
Length Allows you to enter the number of characters (starting from the determined position
in the Start field) to be taken from the description setting and used in the segment of the naming
convention.
Command Buttons
Apply Saves the naming conventions for the selected <unit>.
Copy From Allows you to select a source unit and copy its naming conventions to the
current <unit>. This button is only available when the current <unit> is empty.
Copy To Opens a dialog box where you can copy the current naming conventions to another
<unit>.
Add Adds an empty row at the bottom.
Insert Inserts an empty row above the cell that you click. If you do not click any cell, the
Insert button functions like the Add button: the software adds an empty row at the bottom.
Delete Deletes the row in which you clicked a cell.
Move Up Moves the row up.
Move Down Moves the row down.
341
O
Topics
Open Administration Module Dialog Box .................................... 342
Optimize Indexes (Oracle) Dialog Box ......................................... 342
Optimize Indexes (SQL Server) Dialog Box ................................. 342
Oracle Server Connection Dialog Box .......................................... 343
Owner Dialog Box ......................................................................... 344
342
343
Command Buttons
Edit Allows you to edit the current owner definition.
New Allows you to define a new owner for the current plant. Clicking this button makes all
the fields accessible for editing.
Delete Deletes the current owner definition.
P
Topics
Page Setup Dialog Box .................................................................. 344
Panel Location Levels Dialog Box ................................................ 345
Plant Hierarchy Dialog Box .......................................................... 346
Plant Hierarchy Explorer ............................................................... 347
Plant Properties Dialog Box .......................................................... 348
Preferences for Scoping and Merging Data Dialog Box ............... 350
Preferences Management Dialog Box ........................................... 354
Print Options .................................................................................. 358
Print Preview Dialog Box .............................................................. 358
Project Activities Dialog Box ........................................................ 359
344
345
If the current domain already has a plant other than the default plant, for example, a domain
based on the in_demo.db file, you can only change the names on the levels but not the
number of the levels.
If you define too long names of the plant hierarchy levels (up to 50 characters are allowed),
in report 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.
In the Plant Hierarchy Explorer, after creating a first <plant>, you cannot change the plant
hierarchy levels until you delete that plant. Therefore, it is recommended that you first
create your plant hierarchy levels using the options in this dialog box, and only then proceed
to creating specific plant hierarchy items using the Plant Hierarchy Explorer.
If you are planning to create more than three levels in your plant hierarchy, you cannot then
use the default plant even if the System Administrator has enabled the use of the default
plant. If more than three levels are defined, the software automatically clears the Default
plant use check box in the Domain Definition window.
Level Displays the level hierarchy number. Level 1 is the highest level. The hierarchical
manner of levels is displayed in the Plant Hierarchy Explorer.
Name Allows you to change the existing level name or enter a name for a new level. The
name must contain at least one character that is not space. The maximum name length is fifty
characters. The default level names that are supplied with SmartPlant Instrumentation are Plant,
Area, and Unit.
Add Appends a new level at the bottom of the list. This level becomes the lowest level of
the plant hierarchy. You can only use this option before creating the first plant in the Plant
Hierarchy Explorer.
346
You can change the names of the plant hierarchy items at any stage of your domain life
cycle.
You can only change the number of the plant hierarchy items before creating a naming
conventions for a SmartPlant Instrumentation item.
The names of plant hierarchy items must be unique within a particular node of the parent
level.
Explorer Icons
Indicates the plant hierarchy root. Below this level, you can create highest level items.
Indicates the highest level items in the plant hierarchy. The default highest level name is
Plant. On this level, you can edit properties or delete highest level items. Below this level, you
can create intermediate levels items.
Indicates intermediate levels items in the plant hierarchy. The default intermediate level
name is Area. You can have more than one intermediate level, depending on your level
definitions you made in the Plant Hierarchy dialog box. On this level, you can edit properties
or delete intermediate levels items. Below the lowest intermediate level, you can create lowest
levels items.
Indicates the lowest level items in the plant hierarchy. The default lowest level name is
Unit. On this level, you can edit properties or delete lowest level items.
347
Since deletion of a <unit> is irreversible, make a backup before you delete a <unit>.
You cannot delete the DEFAULT plant, area, and unit. The System Administrator,
however, when setting the domain features in the Domain Definition window, can enable or
disable the use of the default plant. If your plant hierarchy has more than three levels, the
software automatically disables the use of the default plant, and removes the plant
DEFAULT from the Plant Hierarchy Explorer.
348
349
350
Main Item
Loop
Main Item
Instrument
Basic engineering data, wiring items that have a signal propagated to the
instrument.
All wiring sub-items and control system tags that appear in the appropriate wiring
item folder in the Domain Explorer.
Terminal strip
Terminals
Cable
Wire
No sub-items Affects only items selected in an Explorer window for claiming, merging,
or copying to the appropriate buffer. The associated sub-items are claimed or copied to the
buffer as dummy items. When merging items, the software ignores dummy items. The
associated wiring sub-items that do not have a signal (for example, disconnected terminals
or spare wires) are not processed at all.
This setting also determines how the software remove a single item you select in the buffer.
If you select a single item for removal, the software cannot detect whether this item has subitems in the buffer or not. Therefore, on clicking Remove, the software prompts you to
convert the selected item to a dummy item in the buffer. The prompt message only appears
if the item that you select may have sub-items, for example, a panel, terminal strip, cable,
and so forth.
Documents associated with tags and loops are not considered items and, therefore, are
always claimed together with the tags and loops. These documents are process data,
calculation, calibration, dimensional data for piping, and specification sheets, and loop
drawings.
In the project, dummy items appear as view-only. In the Domain Explorer, the dummy
items are marked by a specific color and appear with the indicator.
Sub items Allows you to claim, merge, or move to buffer the associated sub-items.
After you select this option, you can select any combination of the check boxes if you want
the software to include wiring data when you perform a desired operation for claiming or
merging data.
For example, if you do not select any check box, and then, in the appropriate Explorer
window, select a loop or a tag, the software includes all the engineering data but does not
include any wiring items that have a signal propagated to the loop or tag. The engineering
data that the software includes consists of process data, calculation, calibration, dimensional
data for piping, and specification sheets, and hook-up associations. To include these wiring
items, you must select the Wiring data of tags and loops check box.
351
352
353
Merge by revision number Merges revisions with As-Built by using the revision
numbers defined in the current project. Existing revisions in As-Built are updated with
revision data merged from the project.
If you set the software to save revisions as files, the software does not delete the files in
the revision archive folder you specified for the project in the Report Management dialog box
(the software deletes the revision records from the project successfully). This, however, does
not affect report comparison procedures you can perform in As-Built after merging revisions.
Path for .psr files and log file Allows you to specify the path for a log file that contains
details of the merge process. In addition, the software uses this path to generate .psr files that
include a list of merged items. The software groups the items in .psr files according to item
types. You can enter the path of the target file, or click Browse to specify the path.
In the folder that you specify, in addition to the log file and individual .psr files, the
software also creates a .zip file that includes the log file and the .psr files. The software names
the .zip file as follows:
merge<project ID number>_<incrementing number>, for example, MERGE21215_12.
The incrementing number of the file name is incremented by one each time you merge items.
This way, you do not overwrite the previous .zip file. All the individual .psr files are
overwritten automatically after each merge session.
354
355
Command Buttons
Advanced Opens a dialog box where you can enable or disable preferences in the project
selected from the Project list, or in the current domain.
Import Imports the domain or project preferences from a .dmp file that contains previously
exported preferences. Before importing preferences, you can open the .dmp file and modify
preferences definitions in the file itself.
Export Allows you to save the domain or project preferences to an external .dmp file.
356
357
In the Specifications module, when you generate the Spec Forms report, the software
generates the report as the specprn.psr file and saves this file to the folder you specify in the
Temporary folder path box. If you leave this box blank, the software saves the specprn.psr
file to the SmartPlant Instrumentation home folder.
If your CAD application is MicroStation, make sure the path string does not exceed fifty
two characters. A longer path prevents MicroStation from generating or displaying
drawings or cells from SmartPlant Instrumentation.
If the System Administrator specified a global path in your domain, note that the global path
does not apply to the temporary folder path.
Output document folder Enables you to specify the path to the folder where the software
generates IDEAL report files. Click Browse to navigate to the path.
Print Options
This dialog box allows you to print out a report. The dialog box options are as follows:
Printer Allows you select a printer.
Copies Allows you to enter the number of copies you want to print.
Page range Determine whether the software prints the entire report or specific pages of the
report.
All Prints the entire document.
Current page Prints the currently displayed page.
Ranges Prints the pages you type in this box. For example, to print pages 2, 3, and 4,
type 2-4.
Print Select the portion of the report or document that you want to print.
Print to file Prints your report to a file instead of to a printer.
Collate copies Prints the copies of the document in proper binding order.
OK Prints the page range of the report.
Printer Allows you to define your default printer if needed.
Command Buttons
Print Opens a dialog box where you can send the report to a printer or a file.
Save As Saves the report in a format you specify.
Zoom Allows you to change the magnification of the report preview.
359
Active Enables publishing and retrieving of documents. You cannot delete projects with
Active status.
Completed Indicates that activities for the project have been successfully completed.
For projects with the Completed status, users can only publish engineering data. Users
cannot retrieve data that updates the To Do List for the project. To be able to delete the
project, you need to change its status to Merged.
Canceled Indicates that the project is no longer in use and that you can delete it if
needed. For projects with the Canceled status, users cannot publish or retrieve documents.
Merged Indicates that after completion of the project, the project engineering data has
been merged back to As-Built in SmartPlant Instrumentation. For projects with the Merged
status, users cannot publish or retrieve data. If needed, you can delete projects in the
Merged status.
Notes Allows you to enter notes or comments for the current project or As-Built.
Action Indicates the current action taking place when importing a project.
Command Buttons
Apply Saves the changes. If you click Apply to create a new project, the software prompts
you whether you want to copy SmartPlant Instrumentation user groups from As-Built. If you
choose not to copy the user groups, the software creates the project with only one user group
(that is, the group to which the current Project Administrator belongs).
The software also prompts you whether you want to create the Project schema. You need to
create the Project schema to make the project accessible for SmartPlant Instrumentation users.
If you do not create the Project schema at this stage, the software only saves the project name
and description.
If you do not create the Project schema at this stage, you can still proceed with claiming
items for the project. The software creates the project schema automatically when you claim an
item.
New Prompts to create a new project.
Edit Allows you to edit the definition of the current project.
Delete (not available for projects for which the SmartPlant status is Active or Completed)
Deletes the selected project, provided that is does not contain claimed items. You can only
delete an empty project after merging data. If your project no longer contains any data but you
previously deleted claimed items from the project, you must still perform a merge process to
delete these items from As-Built as well.
Reserve Opens a dialog box where you can reserve for the selected project or As-Built tag
numbers and loop numbers within specified ranges. After you reserve a range of numbers, 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 owner operator
domain cannot create tags and loops that belong to the specified range.
Scope Allows you to select a claim source for the current project and then proceed with
defining the scope of items for the project. The claim source can be either As-Built or any other
project that has data, provided that the System Administrator cleared the Exclusive claim mode
check box in the Domain Definition window. If this check box is selected, it is only possible to
define the scope of items for the current project using As-Built as a claim source.
Merge Allows you to select current project items for merging with As-Built.
360
361
362
363
Validations
Validate mandatory fields for data entry Select to generate warning messages where the
user does not enter data values in mandatory fields; clear to ignore any data that is missing in
those fields.
Reports
Display AF and AL graphs in the Instrument Calibration Result report to print all pages of
this report including the As Found and As Left graphs that appear on the second page of the
report. Clear the check box to print only the tabular data that appears on the first page of the
report.
364
Main Item
Loop
365
Main Item
Instrument
Basic engineering data, wiring items that have a signal propagated to the
instrument.
All wiring sub-items and control system tags that appear in the appropriate wiring
item folder in the Domain Explorer.
Terminal strip
Terminals
Cable
Wire
The Claim Buffer and Merge Buffer are only accessible from the Administration module.
For more information about the Claim Buffer, see the Administration module Help, Claim
Buffer (on page 454) in the Administration User's Guide. For more information about the
Merge Buffer, see the Administration module Help, Merge Buffer (on page 456) in the
Administration User's Guide.
Preferences that you set do not affect preferences the Project Administrator defines on the
Preferences for Scoping and Merging Data dialog box of the Administration module.
366
No sub-items Affects only items you selected in an Explorer window. The associated
sub-items are claimed, or copied to the buffer as dummy items. In the project, dummy items
appear as view-only and are marked by a specific color defined in the Administration
module. In the Domain Explorer, dummy items appear with the indicator . The
associated wiring sub-items that do not have a signal (for example, disconnected terminals
or spare wires) are not processed at all. When merging items, the software ignores dummy
items.
Sub items Allows you to claim, merge, or copy to the buffer the associated sub-items.
After you select this option, you can select any combination of the check boxes if you want
the software to include wiring data when you perform a desired claim or merge operation
using shortcut menu commands of an Explorer window.
For example, if you do not select any check box, and then, in the Domain Explorer, select a
loop or a tag, the software includes all the engineering data but does not include any wiring
items that have a signal propagated to the loop or tag. The engineering data that the
software includes consists of process data, calculation, calibration, dimensional data for
piping, and specification sheets, and hook-up associations. To include these wiring items,
you must select the Wiring data of tags and loops check box.
When you select a tag for claiming or merging, the basic engineering data is selected
automatically. You cannot claim or merge a specific instrument, process data sheet, and so
forth.
Wiring data of tags and loops Allows you to claim, merge, or copy to the buffer all the
wiring items that have a signal propagated to the tags and loops you select for claiming.
367
Display options
DCS / PLC attributes Select to display the attributes of DCS / PLC devices when placing
them on the drawing layer. The displayed attributes are: whether it is connected to a CS tag,
channels, number of slots and cabinet name.
Panel location Select to display the panel location in its unit, on the drawing layer (for
example Field, Control room, and so forth).
Terminal discontinuities Select to display a gapping symbol which indicates discontinuity
in a sequence of terminals. A gaping symbol appears between terminal symbols wherever there
is a gap in a terminal sequence.
Channel items Select to display channels with the channel names at the appropriate positions
on the strip.
Connector representation
Default layout Set the desired connector representation for the default layout. Select one of
the following:
Diagonal Represents connectors as straight diagonal lines between the short horizontal
lines that come from the terminals.
Orthogonal Represents connectors as lines consisting of horizontal and vertical sections.
For a visual comparison of these representations, see Connector Representation Examples
(Reference/Connector_Representation_Examples.htm).
Cross wiring Set the desired connector representation for cross- wiring connections. Select
one of the following:
Diagonal Represents connectors as straight diagonal lines between the short horizontal
lines that come from the terminals.
Orthogonal Represents connectors as lines consisting of horizontal and vertical sections.
368
369
Revision options
370
Display options
Use these options to display a tag list and an associated item list on your hook-ups drawing.
Tag list Select this check box to display the tag list on your hook-ups drawing. Clear the
check box not to show the tag list.
Associated item list Select this check box to display the associated item list on your hook-up
drawing. Clear the check box not to show the associated item list.
Format
Item Allows you to select the type of wiring item for which the formatting definitions apply,
for example, cable, cable set, wire, jumper.
Reset Resets the formatting definitions to their default values for the selected item.
Style Allows you to specify the line style for the connector representation. The box beside
this list indicates the visual appearance of the style that you select. You should not change the
default style used for jumpers; if you do so, the software will not display the jumpers.
Color Displays the current color that the software uses for the connector representation. To
change the connector color, click the ellipsis
to open the Color dialog box.
Units Select the units to specify for the connector width: inches, millimeters, or twips.
Width Specifies the connector width in the selected units.
If you are working with commas (,) instead of a period (.) as a decimal separator,
for example in a German environment, you must make sure that the Width of every item in the
Item list, of every category in the Enhanced Reports preferences, is set to 0.1 or lower. To do
this select the Item Type from the Item List and then change the width in the Width field. You
can also click Reset (not Reset All). to change the width to 0.005 for the selected Item. Failure
to reset the connector width causes the generated drawing to appear distorted and impossible to
read.
371
Generation method
Select the default generation method to use when you do not specify a generation method on the
Generate Loop Drawings dialog box for a particular loop.
By Loop Displays items such as strips that are common to a number of signals once only
on the drawing.
By Signal Displays each signal path separately on the drawing so that common items
such as strips appear repeatedly; once in each signal representation.
Custom by Loop Displays Enhanced SmartLoop or Fieldbus Loop reports using custom
symbols that you define for each item and allows you to specify the placement of the
symbols on the drawing sheet by displaying the Domain Explorer in the Enhanced Report
Utility and dragging items from it onto the drawing sheet.
Custom by Signal Displays Enhanced SmartLoop or Fieldbus Loop reports using
custom symbols and showing separate signal paths.
Display each signal on separate page (available for By Signal and Custom by Signal
options only)
Select to display each signal path on a separate drawing sheet.
Group by location (available for By Signal and Custom by Signal options only) Select to
organize panels or strips that belong to the same location in the same column of the drawing, if
possible.
Drawing area parameters When you select the Custom by Loop or Custom by Signal
generation method for a particular loop, the drawing area parameters allow you to specify the
optimum spacing between separate graphical elements on the drawing sheet. The optimum
spacing can vary according to the sizes of the symbols that you use.
Units Select the units to specify for the spacing values: inches, millimeters, or twips.
Row spacing Type a value to specify the spacing between rows on the drawing sheet.
Column spacing Type a value to specify the spacing between columns on the drawing sheet.
372
Template File
Description
A3tall.sma
A3 portrait
A3wide.sma
A3 landscape
A4tall.sma
A4 portrait
A4wide.sma
A4 landscape
Atall.sma
Awide.sma
Btall.sma
11 in x 17 in portrait
Bwide.sma
11 in x 17 in landscape
Title block for default layout Allows you to select the .sym file that you want to use as the
default title block in the template. Type the path and file name in the box or click Browse to
navigate to the file. For example:
C:\SmartPlant\Instrumentation\RAD\Templates\Types\Loop\ Loop_Wide.sym
Logo file Allows you to select the .sym file that you want to use as the logo in the default
title block. This logo does not appear on enhanced reports automatically. You need to perform a
procedure in the Enhanced Report Utility to save the logo as part of the default layout. Type the
path and file name in the box or click Browse to navigate to the file.
Automatic save options Save reports automatically Select to save the specified enhanced
reports automatically as files at the time of generation. If you clear the check box, the software
prints the reports at a printer when you generate them without a print preview.
Save without printing This option becomes available when you select Save reports
automatically. When you select this option, the software automatically saves reports that you
generate without a print preview but does not print them at your printer. If you clear the check
box, the software saves and prints the reports at a printer when you generate them without a
print preview.
373
General
Show generation status window Select to show the generation status window when
generating enhanced reports. Note that the items that appear in the window do not reflect the
actual items that in the reports after generation.
Display warning message when closing document Select to display a warning message in
the Enhanced Report Utility whenever you close a report. Clear this option if you do not want
to receive a warning message every time you close a report.
View
View-only mode Select to open the report in view-only mode. Clear to allow editing of the
report, redlining, saving, and so forth.
Display color property of cross wires Select to display labels indicating the colors of cross
wires where defined. Clear to hide the color labels.
Sort wires by wire sequence in set Select to sort wires according to the sequence number in
the cable set. Clear to sort wires according to the wire IDs. If you are not sure that the wire IDs
match the actual sequence of the wires, for example, if you imported cable data or added wires
manually, it is recommended that you select this option.
Split strip display between sheets Select to display strips in a split manner between two
sheets where those strips would otherwise appear on the margin of one of the drawing sheets.
Enlarge terminals with multiple connections Select to enlarge terminals with multiple
connections so that you can view all the multiple connections separately. When a terminal has
several connections, the software duplicates this terminal as many times as there are connections
and displays this terminal as one item that contains several terminals attached underneath each
other.
Replace missing symbols with default terminal symbol Select to replace all terminal
symbols that the software cannot find with the default terminal symbol term.sym. Clear this
check box to display the text Symbol is missing for all terminal symbols that the software
cannot find.
Drawing
Disable macro generation and annotation options Select to disable macro generation in
enhanced reports and also to disable macros, SmartText and redlining. Disabling these options
speeds up report generation.
This option does not disable the default macros, they still appear on the drawing even
with this option selected. Any macros other than the default macros are disabled and do not
appear on the drawing.
375
Layers
Shows a list of the enhanced report layers.
Name Describes the use of the layer [Connector, Macro, Redline, SmartText, Symbol,
Titleblock].
Value Type your own names for each layer as desired.
If you leave a field value empty, the layer will not be available for selection. Any
items that would be created on the unnamed layer are created on the default layer instead.
376
Pagination options
Start from page number Select the desired page number to appear on the first drawing
sheet.
Revision options
Revision macro order Select the relation between the order of revisions and the order of the
macros that you have set in the title block. The options are:
Ascending In ascending order, macro number 1 contains the first added revision, so that
the last added revision appears at the bottom of the list in the title block.
Descending In descending order, macro number 1 contains the last added revision, so
that the last added revision appears at the top of the list in the title block.
377
Display options
All jumpers Select to display all the jumpers between the entry and exit points of a signal on
a cabinet. Clear to display one line for all the midway jumpers.
When generating a loop in Custom Mode, with the terminal strip associated to a custom
symbol, all jumpers are displayed on the loop drawing irrespective of the All Jumpers
preference or layout properties settings.
Overall shield connected to another strip (without signal) Select to display the overall
shield (without signal) connected to another strip. If you clear the check box this strip is not
displayed, unless it has a signal in which case it is displayed whether the check box is selected
or cleared.
DCS / PLC attributes Select to display the attributes of DCS / PLC devices when placing
them on the drawing layer. The displayed attributes are: whether it is connected to a CS tag,
channels, number of slots and cabinet name.
Unconnected DCS / PLC terminals Select to display unconnected DCS / PLC terminals. If
you clear the check box, the software replaces the terminals with a break- in-sequence symbol.
Unconnected Apparatus terminals Select to display unconnected Apparatus terminals. If
you clear the check box, the software replaces the terminals with a break- in-sequence symbol.
378
Connector representation
Default layout Set the desired connector representation for the default layout. Select one of
the following:
Diagonal Represents connectors as straight diagonal lines between the short horizontal
lines that come from the terminals.
Orthogonal Represents connectors as lines consisting of horizontal and vertical sections.
For a visual comparison of these representations, see Connector Representation Examples
(Reference/Connector_Representation_Examples.htm).
Cross wiring Set the desired connector representation for cross- wiring connections. Select
one of the following:
Diagonal Represents connectors as straight diagonal lines between the short horizontal
lines that come from the terminals.
Orthogonal Represents connectors as lines consisting of horizontal and vertical sections.
When generating an enhanced report with many connectors, where the layout settings for
the connectors are set to diagonal, the connector names do not appear directly over their
respective connectors.
379
Display options
All jumpers Select to display all the jumpers between the entry and exit points of a signal on
a cabinet. Clear to display one line for all the midway jumpers.
When generating a loop in Custom Mode, with the terminal strip associated to a custom
symbol, all jumpers are displayed on the loop drawing irrespective of the All Jumpers
preference or layout properties settings.
Overall shield connected to another strip Select to display the overall shield connected to
another strip. If you clear the check box, this strip is not displayed.
DCS / PLC attributes Select to display the attributes of DCS / PLC devices when placing
them on the drawing layer. The displayed attributes are: whether it is connected to a CS tag,
channels, number of slots and cabinet name.
Unconnected DCS / PLC terminals Select to display unconnected DCS / PLC terminals. If
you clear the check box, the software replaces the terminals with a break- in-sequence symbol.
Unconnected Apparatus terminals Select to display unconnected Apparatus terminals. If
you clear the check box, the software replaces the terminals with a break- in-sequence symbol.
Panel location Select to display the panel location in its unit, on the drawing layer (for
example Field, Control room, and so forth).
Vertical orientation Select to display the drawing vertically.
Terminal discontinuities Select to display a gaping symbol which indicates discontinuity in
a sequence of terminals. A gapping symbol appears between terminal symbols wherever there is
a gap in a terminal sequence.
Loop drawing reference Select to display on the report a reference to an external drawing.
CS block when tag has no wiring Select to display Control System tags that are assigned to
the generated loop where those Control System tags do not have wiring connections.
Instrument list Select to display a list of instruments on the report that do not have wiring.
When displaying the list, the following options are available:
All instruments in loop Displays instruments that are included in the loop wiring as well
as non-wiring instruments.
Non-wiring instruments only Displays only those instruments that are not included in
the loop wiring.
Channel items Select to display channels with the channel names at the appropriate positions
on the strip.
380
Connector representation
Default layout Set the desired connector representation for the default layout. Select one of
the following:
Diagonal Represents connectors as straight diagonal lines between the short horizontal
lines that come from the terminals.
Orthogonal Represents connectors as lines consisting of horizontal and vertical sections.
For a visual comparison of these representations, see Connector Representation Examples
(Reference/Connector_Representation_Examples.htm).
Cross wiring Set the desired connector representation for cross - wiring connections. Select
one of the following:
Diagonal Represents connectors as straight diagonal lines between the short horizontal
lines that come from the terminals.
Orthogonal Represents connectors as lines consisting of horizontal and vertical sections.
When generating an enhanced report with many connectors, where the layout settings for
the connectors are set to diagonal, the connector names do not appear directly over their
respective connectors.
The options on the General page of the Preferences dialog box enable you to customize the
SmartPlant Instrumentation interface and set general application preferences. These settings do
not affect the preferences that were defined by other SmartPlant Instrumentation users in the
current domain or working in the current project, if the domain type is Owner operator.
When customizing the general preferences, you can:
Set the default locations of the main toolbar and the module toolbar.
Set the toolbar and icon display.
Automatically start SmartPlant Instrumentation with the unit and module you last worked in.
Set print preview options.
Overwrite the default logo.
Note that the Domain Administrator can restrict your ability to set various preferences.
Therefore, you can find that certain options are disabled. If you want to enable these options,
contact your Domain Administrator, who can manage preferences from the Administration
module.
Select toolbar Allows you to select the toolbar whose display options you want to define:
Main Toolbar or Module Toolbar.
Show toolbar Makes the currently selected toolbar visible in the application. Clear the
check box to hide the toolbar.
381
382
In the Specifications module, when you generate the Spec Forms report, the software
generates the report as the specprn.psr file and saves this file to the folder you specify in the
Temporary folder path box. If you leave this box blank, the software saves the
specprn.psr file to the SmartPlant Instrumentation home folder and not to the PSR working
folder path preference (on the Specifications > Export/Import page).
If your CAD application is MicroStation, make sure the path string does not exceed fifty
two characters. A longer path prevents MicroStation from generating or displaying drawings
or cells from SmartPlant Instrumentation.
If the System Administrator specified a global path in your domain, the global path does not
apply to the temporary folder path.
Output document folder Enables you to specify the path to the folder where the software
generates IDEAL report files. Click Browse to navigate to the path.
SmartPlant Instrumentation and the CAD drawing programs required to work with
SmartPlant Instrumentation, must be installed on the same machine.
MicroStation paths must not have spaces. Paths with spaces prevent MicroStation from
generating or displaying drawings or cells from SmartPlant Instrumentation. If you
installed MicroStation in the default Program Files folder, you must reinstall
MicroStation in a path that does not have spaces.
Global path Displays the global path set by the System Administrator.
CAD folder Click Browse to navigate to the folder containing the executable file of the
CAD application installed on your computer. For example:
C:\Program Files\SmartSketch\program
CAD configuration folder Click Browse to navigate to the folder containing the CAD
configuration file of the CAD application installed on your computer. For example:
383
CAD function folder Click Browse to navigate to the folder containing the CAD function
files. For example:
C:\Program Files\SmartPlant\Instrumentation\CAD\CADFunc
If your CAD application is SmartSketch, the CADFunc folder contains a shipped file
pid.igr. This is a template file on which all your SmartSketch drawings are based. The
default print sheet size is defined in the pid.igr file as A3 Wide. If you want to generate
drawings using a different print sheet size, you must open the pid.igr file in SmartSketch and
modify the sheet settings as you require. Changes that you make in the pid.igr file affect
both hook-up drawings and loop drawings you generate in SmartSketch. If you want the
print sheet size of hook-up drawings not to affect the print sheet size of loop drawings,
duplicate the CADFunc folder with all its content and define a different path setting
preference for loop drawings on the Loop Drawings > CAD File Locations page.
If your CAD application is MicroStation, make sure the path string does not
exceed fifty two characters. A longer path prevents MicroStation from generating or
displaying drawings or cells from SmartPlant Instrumentation. If your CAD function folder
path is longer than allowed, you need to copy the CADFunc folder and its content to another
location, for example, C:\CAD\CADFunc.
Open drawing files from Click Browse to navigate to the default folder from which saved
hook-up drawings are to be opened. For example:
C:\Program Files\SmartPlant\Instrumentation\CAD\DWG
Drawing block folder Click Browse to select the path to be used as the default for new
block files. For example:
C:\Program Files\SmartPlant\Instrumentation\CAD\Blocks
The file format of the saved files depends on the CAD application you have selected.
384
385
386
Bill of Material
Hide item number row when total quantity is zero Allows you not to include in BOM the
item number whose quantity is zero.
Enable the use of edit mode Allows you to select the Edit mode check box in a BOM print
preview.
Sort hook-up items in generated drawings Use these option buttons to determine how the
hook-up items are sorted in reports.
By item number Allows you to sort the hook-up items in order of the item numbers.
By item order Allows you to sort the hook-up items by their order of their assignment to
a hook-up.
387
Create new tags based on the properties of the typical tags defined for the selected typical
loop in the Typical Tag Number dialog box.
When duplicating a tag number, you can also include additional data associated with source tag
numbers. Select the appropriate check boxes below.
The following check boxes are not applicable when running batch loop creation.
CAD blocks Includes all the CAD blocks assigned manually to the source tag, page
numbering in the loop drawing where the blocks are located, and the X, Y, Z offset coordinates
of the block in the loop drawings. In the Loops folder of the Domain Explorer, manually
.
assigned blocks are shown under instruments as
The CAD blocks preference does not apply to blocks assigned to instruments using
the automatic block assignment method. In the Loops folder of the Domain Explorer,
these blocks are shown under instruments as . Such blocks are always duplicated under
the target instruments.
Specifications Includes the specifications associated with the source tag. You can include
the process data information in the source specification only if you select the Process Data
check box as well.
Instrument specifications are duplicated only if you select the Process data check box
too.
When duplicating an instrument tag associated with a composite spec, the software
never duplicates the composite spec, regardless of the preferences that you specify.
When duplicating a loop, the software always duplicates the loop composite spec.
Process data Includes the process data information of the source tag. This option is required
if you want include tag source instrument specifications as well.
Wiring Includes the entire wiring information of the source tag.
Include custom fields when copying (applicable for tag duplication and batch loop creation)
Duplicates the tag number with the custom fields of the source tag.
389
390
Same as the last created tag + 1 The data field in the New Tag Number dialog box
displays the last created tag plus 1 (one). You can accept the displayed number, modify it,
or type the number you need.
This option is available for numeric tag names only. If your tag names are not
numeric, the data field in the New Tag Number dialog box will display the last created tag.
Ignore loop creation when creating new virtual tag Allows you to create a virtual tag
without being prompted to create a loop associated with the new virtual tag.
Use loop suffix in instrument tag Allows you to include the loop suffix in the name of a
newly created instrument tag.
Tag number
Display old tag number automatically Enables automatic display of the old tag number in
the Old tag number field of the Tag Number Properties dialog box. Clear the check box to
leave the Old tag number field empty.
391
Loop number
Display old loop number automatically Enables automatic display of the old loop number
in the Old loop number field of the Loop Number Properties dialog box. Clear the check box
to leave the Old loop number field empty.
Apply loop number segment and suffix changes to tags Enables you to apply new loop
segments to tags associated with this loop. After you change loop segments in the Rename
Loop Number dialog box, you can view both the old and the new list of tag numbers for tags
associated with this loop. Then, you can select those tags whose segments will be changed
automatically according to the loop segments.
Rename drawing file name when renaming the loop Allows you to rename the associated
CAD drawing file names when renaming loop numbers. After you rename a loop number, the
software opens the Rename Loop Drawing File dialog box, where you can change the drawing
file names.
Propagate options
Propagate P&ID drawing when assigning tags to lines After selecting this option, on the
Tag Number Properties dialog box, the software automatically displays the P&ID drawing
reference that is associated with the line for the current tag number.
Propagate line pipe spec when assigning tags to lines After selecting this option, on the
Tag Number Properties dialog box, the software automatically displays the line pipe spec that
is associated with the line for the current tag number.
392
Connector representation
Default layout Set the desired connector representation for the default layout. Select one of
the following:
Diagonal Represents connectors as straight diagonal lines between the short horizontal
lines that come from the terminals.
Orthogonal Represents connectors as lines consisting of horizontal and vertical sections.
For a visual comparison of these representations, see Connector Representation Examples
(Reference/Connector_Representation_Examples.htm).
Cross wiring Set the desired connector representation for cross- wiring connections. Select
one of the following:
Diagonal Represents connectors as straight diagonal lines between the short horizontal
lines that come from the terminals.
Orthogonal Represents connectors as lines consisting of horizontal and vertical sections.
When generating an enhanced report with many connectors, where the layout settings for
the connectors are set to diagonal, the connector names do not appear directly over their
respective connectors.
SmartPlant Instrumentation and the CAD drawing programs required to work with
SmartPlant Instrumentation, must be installed on the same machine.
MicroStation paths must not have spaces. Paths with spaces prevent MicroStation from
generating or displaying drawings or cells from SmartPlant Instrumentation. If you
installed MicroStation in the default Program Files folder, you must reinstall
MicroStation in a path that does not have spaces.
Global path Displays the global path set by the System Administrator.
CAD folder Click Browse to navigate to the folder containing the executable file of the
CAD application installed on your computer. For example:
C:\Program Files\SmartSketch\program
393
The file format of the saved files depends on the CAD application you have selected.
394
This preference does not affect printing loop drawings generated using the Enhanced Report
Utility.
If you do not want to print CAD loop drawings but save them automatically at the time of
generation, clear this check box and then specify the output drawing folder path on the
Preferences > Loop Drawings > CAD File Locations page.
Regardless of this check box setting, when generating a batch of CAD loop drawings, the
software only opens the CAD drawing generated last in the batch. It is not possible to set
the software to open a print preview of every CAD loop drawing when generating multiple
loop drawings.
Generate null macro list Select this check box to generate a list of macros that are used in
the Macro report but which do not return a value when executed.
Generate undefined macro list Select this check box to generate a list of macros that are
used in the Macro report but are not found in the SmartPlant Instrumentation database.
Use macro functions Select this check box to enable the use of macro functions with macros
in CAD drawings. You define macro functions in the Loop Drawings module, in the UserDefined Macro Functions dialog box.
Display references to wiring reports automatically Select this check box to display
references to wiring reports generated in the title block of a specific CAD drawing. After
generating a report in the Wiring module, a reference to this report appears automatically in the
Document Reference dialog box, where you can add a reference description.
Explode block in AutoCAD Enables you to edit the loop drawing by separating the drawing
block into elements.
395
396
AutoCAD Generates loop drawings using AutoCAD as the CAD program. You must
specify the appropriate file locations on the Loop Drawings - CAD File Locations
preferences page. You can also specify application-specific options on this page.
MicroStation Generates loop drawings using MicroStation as the CAD program. You
must specify the MicroStation version on this page and the appropriate file locations on the
Loop Drawings - CAD File Locations preferences page. You can also specify other
application- specific options on this page.
Date format Type the date format for display in any loop drawing after generation. The
valid date formats are the same as the formats you use in Windows, for example, dd/mm/yy,
mm/dd/yyyy, and so forth). For details of supported date formats, see Set the Date Format in
CAD Loop Drawings (procedures/Set_the_Date_Format_in_CAD_Drawings.htm).
397
Display options
DCS / PLC attributes Select to display the attributes of DCS / PLC devices when placing
them on the drawing layer. The displayed attributes are: whether it is connected to a CS tag,
channels, number of slots and cabinet name.
Panel location Select to display the panel location in its unit, on the drawing layer (for
example Field, Control room, and so forth).
Terminal discontinuities Select to display a gaping symbol which indicates discontinuity in
a sequence of terminals. A gaping symbol appears between terminal symbols wherever there is
a gap in a terminal sequence.
Channel items Select to display channels with the channel names at the appropriate positions
on the strip.
Connector representation
Default layout Set the desired connector representation for the default layout. Select one of
the following:
Diagonal Represents connectors as straight diagonal lines between the short horizontal
lines that come from the terminals.
Orthogonal Represents connectors as lines consisting of horizontal and vertical sections.
For a visual comparison of these representations, see Connector Representation Examples
(Reference/Connector_Representation_Examples.htm).
Cross wiring Set the desired connector representation for cross - wiring connections. Select
one of the following:
Diagonal Represents connectors as straight diagonal lines between the short horizontal
lines that come from the terminals.
Orthogonal Represents connectors as lines consisting of horizontal and vertical sections.
When generating an enhanced report with many connectors, where the layout settings for
the connectors are set to diagonal, the connector names do not appear directly over their
respective connectors.
398
Display options
DCS / PLC attributes Select to display the attributes of DCS / PLC devices when placing
them on the drawing layer. The displayed attributes are: whether it is connected to a CS tag,
channels, number of slots and cabinet name.
Panel location Select to display the panel location in its unit, on the drawing layer (for
example Field, Control room, and so forth).
Terminal discontinuities Select to display a gaping symbol which indicates discontinuity in
a sequence of terminals. A gaping symbol appears between terminal symbols wherever there is
a gap in a terminal sequence.
Channel items Select to display channels with the channel names at the appropriate positions
on the strip.
Connector representation
Default layout Set the desired connector representation for the default layout. Select one of
the following:
Diagonal Represents connectors as straight diagonal lines between the short horizontal
lines that come from the terminals.
Orthogonal Represents connectors as lines consisting of horizontal and vertical sections.
For a visual comparison of these representations, see Connector Representation Examples
(Reference/Connector_Representation_Examples.htm).
Cross wiring Set the desired connector representation for cross- wiring connections. Select
one of the following:
Diagonal Represents connectors as straight diagonal lines between the short horizontal
lines that come from the terminals.
Orthogonal Represents connectors as lines consisting of horizontal and vertical sections.
When generating an enhanced report with many connectors, where the layout settings for
the connectors are set to diagonal, the connector names do not appear directly over their
respective connectors.
399
Display options
All jumpers Select to display all the jumpers between the entry and exit points of a signal on
a cabinet. Clear to display one line for all the midway jumpers.
When generating a loop in Custom Mode, with the terminal strip associated to a custom
symbol, all jumpers are displayed on the loop drawing irrespective of the All Jumpers
preference or layout properties settings.
Overall shield connected to another strip Select to display the overall shield connected to
another strip. If you clear the check box, this strip is not displayed.
DCS / PLC attributes Select to display the attributes of DCS / PLC devices when placing
them on the drawing layer. The displayed attributes are: whether it is connected to a CS tag,
channels, number of slots and cabinet name.
Unconnected DCS / PLC terminals Select to display unconnected DCS / PLC terminals. If
you clear the check box, the software replaces the terminals with a break- in-sequence symbol.
Unconnected Apparatus terminals Select to display unconnected Apparatus terminals. If
you clear the check box, the software replaces the terminals with a break- in-sequence symbol.
Panel location Select to display the panel location in its unit, on the drawing layer (for
example Field, Control room, and so forth).
Terminal discontinuities Select to display a gaping symbol which indicates discontinuity in
a sequence of terminals. A gaping symbol appears between terminal symbols wherever there is
a gap in a terminal sequence.
Leftmost strip descriptions on the left Select to place all the descriptions of the leftmost
strips to the left of the strips. Clear this check box to retain all the descriptions of the leftmost
strips above the strips.
All terminals on each strip Select to display all the terminals on all strips that appear in the
drawing. Clear this check box to display all the terminals on the main (selected) strip and only
wired terminals that carry signals on the other strips.
Signal path up to selected panel only Select to display the signal path from the field devices
up to the selected panel only. Clear this check box to display the entire signal path from the
field devices up to the control system.
Channel items Select to display channels with the channel names at the appropriate positions
on the strip.
Connector representation
Default layout Set the desired connector representation for the default layout. Select one of
the following:
400
Diagonal Represents connectors as straight diagonal lines between the short horizontal
lines that come from the terminals.
Orthogonal Represents connectors as lines consisting of horizontal and vertical sections.
For a visual comparison of these representations, see Connector Representation Examples
(Reference/Connector_Representation_Examples.htm).
Cross wiring Set the desired connector representation for cross-wiring connections. Select
one of the following:
Diagonal Represents connectors as straight diagonal lines between the short horizontal
lines that come from the terminals.
Orthogonal Represents connectors as lines consisting of horizontal and vertical sections.
When generating an enhanced report with many connectors, where the layout settings for
the connectors are set to diagonal, the connector names do not appear directly over their
respective connectors.
Display options
All jumpers Select to display all the jumpers between the entry and exit points of a signal on
a cabinet. Clear to display one line for all the midway jumpers.
When generating a loop in Custom Mode, with the terminal strip associated to a custom
symbol, all jumpers are displayed on the loop drawing irrespective of the All Jumpers
preference or layout properties settings.
Overall shield connected to another strip Select to display the overall shield connected to
another strip. If you clear the check box, this strip is not displayed.
DCS / PLC attributes Select to display the attributes of DCS / PLC devices when placing
them on the drawing layer. The displayed attributes are: whether it is connected to a CS tag,
channels, number of slots and cabinet name.
Unconnected DCS / PLC terminals Select to display unconnected DCS / PLC terminals. If
you clear the check box, the software replaces the terminals with a break- in-sequence symbol.
Unconnected Apparatus terminals Select to display unconnected Apparatus terminals. If
you clear the check box, the software replaces the terminals with a break- in-sequence symbol.
Panel location Select to display the panel location in its unit, on the drawing layer (for
example Field, Control room, and so forth).
Terminal discontinuities Select to display a gapping symbol which indicates discontinuity
in a sequence of terminals. A gaping symbol appears between terminal symbols wherever there
is a gap in a terminal sequence.
Leftmost strip descriptions on the left Select to place all the descriptions of the leftmost
strips to the left of the strips. Clear this check box to retain all the descriptions of the leftmost
strips above the strips.
SmartPlant Instrumentation Administration User's Guide
401
Connector representation
Default layout Set the desired connector representation for the default layout. Select one of
the following:
Diagonal Represents connectors as straight diagonal lines between the short horizontal
lines that come from the terminals.
Orthogonal Represents connectors as lines consisting of horizontal and vertical sections.
For a visual comparison of these representations, see Connector Representation Examples
(Reference/Connector_Representation_Examples.htm).
Cross wiring Set the desired connector representation for cross-wiring connections. Select
one of the following:
Diagonal Represents connectors as straight diagonal lines between the short horizontal
lines that come from the terminals.
Orthogonal Represents connectors as lines consisting of horizontal and vertical sections.
When generating an enhanced report with many connectors, where the layout settings for the
connectors are set to diagonal, the connector names do not appear directly over their
respective connectors.
A Panel-Strip report (with adjacent connections, no style), cannot be printed on a portrait
orientated A4 page.
402
General options
Convert units of measure automatically Select this check box to automatically convert
numerical data when changing the units of measure.
Enable velocity auto recalculation Select this check box to automatically recalculate the
velocity parameters for flow equipment.
Highlight required process data properties Select this check box to automatically highlight
the required fields in the Process Data window. Note that in the Calculation module, the
software also highlights the same fields in a calculation sheet.
403
Display options
All jumpers Select to display all the jumpers between the entry and exit points of a signal on
a cabinet. Clear to display one line for all the midway jumpers.
When generating a loop in Custom Mode, with the terminal strip associated to a custom
symbol, all jumpers are displayed on the loop drawing irrespective of the All Jumpers
preference or layout properties settings.
Overall shield connected to another strip Select to display the overall shield connected to
another strip. If you clear the check box, this strip is not displayed.
DCS / PLC attributes Select to display the attributes of DCS / PLC devices when placing
them on the drawing layer. The displayed attributes are: whether it is connected to a CS tag,
channels, number of slots and cabinet name.
Unconnected DCS / PLC terminals Select to display unconnected DCS / PLC terminals. If
you clear the check box, the software replaces the terminals with a break- in-sequence symbol.
Unconnected Apparatus terminals Select to display unconnected Apparatus terminals. If
you clear the check box, the software replaces the terminals with a break- in-sequence symbol.
Panel location Select to display the panel location in its unit, on the drawing layer (for
example Field, Control room, and so forth).
General signals assigned to segments Select to display general signals such as power
supplies or multiplexed wiring, that are assigned to wiring segments.
Terminal discontinuities Select to display a gapping symbol which indicates discontinuity
in a sequence of terminals. A gaping symbol appears between terminal symbols wherever there
is a gap in a terminal sequence.
Virtual tags Select to display the existing virtual tags in a generated segment wiring report.
404
Connector representation
Default layout Set the desired connector representation for the default layout. Select one of
the following:
Diagonal Represents connectors as straight diagonal lines between the short horizontal
lines that come from the terminals.
Orthogonal Represents connectors as lines consisting of horizontal and vertical sections.
For a visual comparison of these representations, see Connector Representation Examples
(Reference/Connector_Representation_Examples.htm).
Cross wiring Set the desired connector representation for cross-wiring connections. Select
one of the following:
Diagonal Represents connectors as straight diagonal lines between the short horizontal
lines that come from the terminals.
Orthogonal Represents connectors as lines consisting of horizontal and vertical sections.
When generating an enhanced report with many connectors, where the layout settings for
the connectors are set to diagonal, the connector names do not appear directly over their
respective connectors.
Display options
All jumpers Select to display all the jumpers between the entry and exit points of a signal on
a cabinet. Clear to display one line for all the midway jumpers.
When generating a loop in Custom Mode, with the terminal strip associated to a custom
symbol, all jumpers are displayed on the loop drawing irrespective of the All Jumpers
preference or layout properties settings.
DCS / PLC attributes Select to display the attributes of DCS / PLC devices when placing
them on the drawing layer. The displayed attributes are: whether it is connected to a CS tag,
channels, number of slots and cabinet name.
Panel location Select to display the panel location in its unit, on the drawing layer (for
example Field, Control room, and so forth).
Terminal discontinuities Select to display a gaping symbol which indicates discontinuity in
a sequence of terminals. A gaping symbol appears between terminal symbols wherever there is
a gap in a terminal sequence.
Report end point level Select to specify whether to report the end point level from
Amplifier or DCS.
405
Connector representation
Default layout Set the desired connector representation for the default layout. Select one of
the following:
Diagonal Represents connectors as straight diagonal lines between the short horizontal
lines that come from the terminals.
Orthogonal Represents connectors as lines consisting of horizontal and vertical sections.
For a visual comparison of these representations, see Connector Representation Examples
(Reference/Connector_Representation_Examples.htm).
Cross wiring Set the desired connector representation for cross- wiring connections. Select
one of the following:
Diagonal Represents connectors as straight diagonal lines between the short horizontal
lines that come from the terminals.
Orthogonal Represents connectors as lines consisting of horizontal and vertical sections.
When generating an enhanced report with many connectors, where the layout settings for
the connectors are set to diagonal, the connector names do not appear directly over their
respective connectors.
406
407
PSR options
PSR working folder Click Browse to select a working folder in which to keep specification
page files (in .psr format). For best performance, define a folder on your client computer. If
you do not define a PSR working folder, the software keeps the files in the temporary folder
path that you specify under the general preferences.
The .psr files that the software generates when opening a print preview do not get saved
in this folder but in the temporary folder. You specify the temporary folder path on the General
page of the Preferences dialog box.
Global path Displays the global path set by the System Administrator.
Overwrite PSR files For best performance, make sure that this check box is cleared. In
some network configurations, however, a .psr working file may not be properly updated from
the database. In such a case, select this check box to overwrite .psr files every time that you
save specifications. Note that when you select this check box, the performance of the software
can slow down.
ISF export/import
Default export/import folder Click Browse to select a folder that you want to set as your
default .isf file folder. The software will display this folder automatically in all dialog boxes
where you need to select a folder for importing data from .isf files, or for exporting data to .isf
files.
408
409
Ask user (default) This option prompts you to display the specification. If you accept,
the result depends on whether a specification already exists for that tag. If the selected
instrument tag is already associated with a specification, the specification is displayed. If
the selected instrument tag is not associated with a specification, the Select Specification
Page dialog box opens, from which you can select the page to be used to generate a new
specification.
Tag creation These options determine if the user can create new tags from the Specifications
module.
Not allowed (default) The user cannot create new tags from the Specifications module.
Allowed The user is able to create new tags in the Specifications module.
410
Selecting this check box affects the way SmartPlant Instrumentation displays tag records of
the same tag that is assigned to multiple process data cases. For example, in the Find Items
dialog box of the Specifications module, when a tag is assigned to multiple cases, the
software only displays the governing case.
If you clear the check box, when you create a multi-tag specification, you can add of the
cases in the Multi-Tag tab of the specification.
Customize the SEE LIST label Allows you to change the default label SEE LIST, which
appears in the main pages of a multi-tag specification. In a multi-tag specification, the SEE
LIST label appears in every field that the multi-tag list format contains. You can enter any
combination of alpha-numeric characters (up to 20 characters) or leave the box blank.
411
Display options
All jumpers Select to display all the jumpers between the entry and exit points of a signal on
a cabinet. Clear to display one line for all the midway jumpers.
When generating a loop in Custom Mode, with the terminal strip associated to a custom
symbol, all jumpers are displayed on the loop drawing irrespective of the All Jumpers
preference or layout properties settings.
Overall shield connected to another strip Select to display the overall shield connected to
another strip. If you clear the check box, this strip is not displayed.
DCS / PLC attributes Select to display the attributes of DCS / PLC devices when placing
them on the drawing layer. The displayed attributes are: whether it is connected to a CS tag,
channels, number of slots and cabinet name.
Unconnected DCS / PLC terminals Select to display unconnected DCS / PLC terminals. If
you clear the check box, the software replaces the terminals with a break- in-sequence symbol.
Unconnected Apparatus terminals Select to display unconnected Apparatus terminals. If
you clear the check box, the software replaces the terminals with a break- in-sequence symbol.
Panel location Select to display the panel location in its unit, on the drawing layer (for
example Field, Control room, and so forth).
412
Connector representation
Default layout Set the desired connector representation for the default layout. Select one of
the following:
Diagonal Represents connectors as straight diagonal lines between the short horizontal
lines that come from the terminals.
Orthogonal Represents connectors as lines consisting of horizontal and vertical sections.
For a visual comparison of these representations, see Connector Representation Examples
(Reference/Connector_Representation_Examples.htm).
Cross wiring Set the desired connector representation for cross- wiring connections. Select
one of the following:
Diagonal Represents connectors as straight diagonal lines between the short horizontal
lines that come from the terminals.
Orthogonal Represents connectors as lines consisting of horizontal and vertical sections.
When generating an enhanced report with many connectors, where the layout settings for
the connectors are set to diagonal, the connector names do not appear directly over their
respective connectors.
Display options
Origin point Select this check box to display the origin point of any symbol that you open in
the Symbol Editor. Clear the check box to hide the origin point.
413
414
DCS uniqueness
The following options allow you to set the required uniqueness level for a Distributed Control
System (DCS):
Plant Set uniqueness at the plant level.
Per panel Set uniqueness at the panel level.
Per terminal strip Set uniqueness at the terminal strip level.
Not unique Allow use of the same Control System tag name at any level.
PLC uniqueness
The following options allow you to set the required uniqueness level for a Programmable Logic
Controller (PLC):
Plant Set uniqueness at the plant level.
Per panel Set uniqueness at the panel level.
Per terminal strip Set uniqueness at the terminal strip level.
Not unique Allow use of the same Control System tag name at any level.
415
Unassigned CS tag
The following options allow you to set the required uniqueness level for Control System tag
names of tags that are not assigned to I/O cards:
Unique Allow the use of a CS tag name of an unassigned tag only once.
Not unique Allow the use of the same CS tag name for any tag that is not assigned to an
I/O card.
Display options
All jumpers Select to display all the jumpers between the entry and exit points of a signal on
a cabinet. Clear to display one line for all the midway jumpers.
When generating a loop in Custom Mode, with the terminal strip associated to a custom
symbol, all jumpers are displayed on the loop drawing irrespective of the All Jumpers
preference or layout properties settings.
Overall shield connected to another strip Select to display the overall shield connected to
another strip. If you clear the check box, this strip is not displayed.
DCS / PLC attributes Select to display the attributes of DCS / PLC devices when placing
them on the drawing layer. The displayed attributes are: whether it is connected to a CS tag,
channels, number of slots and cabinet name.
Unconnected Apparatus terminals Select to display unconnected Apparatus terminals. If
you clear the check box, the software replaces the terminals with a break- in-sequence symbol.
Panel location Select to display the panel location in its unit, on the drawing layer (for
example Field, Control room, and so forth).
General signals assigned to strips Select to display general signals such as power supplies
or multiplexed wiring, that are assigned to strips.
416
Connector representation
Default layout Set the desired connector representation for the default layout. Select one of
the following:
Diagonal Represents connectors as straight diagonal lines between the short horizontal
lines that come from the terminals.
Orthogonal Represents connectors as lines consisting of horizontal and vertical sections.
For a visual comparison of these representations, see Connector Representation Examples
(Reference/Connector_Representation_Examples.htm).
Cross wiring Set the desired connector representation for cross- wiring connections. Select
one of the following:
Diagonal Represents connectors as straight diagonal lines between the short horizontal
lines that come from the terminals.
Orthogonal Represents connectors as lines consisting of horizontal and vertical sections.
When generating an enhanced report with many connectors, where the layout settings for
the connectors are set to diagonal, the connector names do not appear directly over their
respective connectors.
Naming options
Enforce unique names for wiring items Select this check box to enforce the name
uniqueness for wiring items. For more information, see Name and Sequence Uniqueness of
Wiring Items.
Connection screen
Display terminal type name Check this option to display the terminal type name on the
Connection Screen.
417
Same I/O type for tag and I/O card Limits the I/O type of the instrument tag to be the
same as the I/O type of the I/O card selected in the I/O Assignment window. Note that the
software validates I/O type compatibility also upon connection.
All I/O types Allows the selection of all instrument tag I/O types in the I/O Assignment
window and upon connection.
All slots (vacant and occupied) Allows you to create multiple wiring equipment items
or double-width I/O cards under vacant slots.
Vacant slots only Allows you to create only one wiring equipment item per vacant slot.
The software will not allow you to add a double-width card or another wiring equipment
item under an occupied slot.
Automatic naming
Name jumpers automatically Allows you to select name jumpers automatically. Select this
check box in the following cases:
418
When making connections using connection types whose definitions contain jumpers. In
this case, the software automatically names the created jumpers using the following default
format: J<first terminal name>/<second terminal name>. For example, J1+/3sh. You
cannot modify the default format.
Clear this check box to name new jumpers by incrementing the jumper number, for example
J1/1, J1/2 and so forth.
When adding new jumpers to a terminal strip in the Connection window. In this case, the
software suggests a jumper name in the New Jumper Connection dialog box. The
suggested jumper name is based on the default format mentioned in the previous paragraph.
You can accept the suggested name or type another jumper name as needed.
Clear this check box to prevent the software from suggesting jumper names when making
new jumper connections on the New Jumper Connection dialog box.
Propagate tag signal through jumpers Allows you to instruct the software to propagate tag
signals through jumpers. If you do not select this preference, the software will not propagate tag
signals through jumpers.
beside
419
R
Topics
Rebuild Catalog Tables Dialog Box .............................................. 420
Rebuild Default Views in Domains Dialog Box ........................... 420
Rebuild Projects in Domain Dialog Box ....................................... 421
Rebuild Stored Procedures and Triggers Dialog Box .................... 421
Remove Deleted Windows Users Dialog Box............................... 422
Report Management Dialog Box ................................................... 422
Required Wiring Equipment Report Dialog Box .......................... 425
Reserve Item ID Ranges for Projects Dialog Box ......................... 426
Reserve Tags and Loops Dialog Box ............................................ 426
When running SmartPlant Instrumentation on Oracle, prior to using this dialog box, make
sure that in the Intools.ini file, in the [Database] section, you have the following parameter
setting:
DBParm=DisableBind=1,PBCatalogOwner='<Admin schema logon name>'
The default logon name of the Admin schema is IN_DBAMN. The System Administrator
has rights to customize the Admin schema logon name when initializing a domain.
When running SmartPlant Instrumentation on SQL Server, prior to using this dialog box,
make sure that in the Intools.ini file, in the [Database] section, you have the following
parameter setting:
DBParm=TBTextLimit='32000',PBCatalogOwner='<Admin schema logon name>'
The default logon name of the Admin schema is IN_DBAMN. The System Administrator
has rights to customize the Admin schema logon name when initializing a domain.
420
Data Window
Project Contains the list of projects in the active domain. Select projects that you want to
rebuild.
Project Administrator Displays the name of the Project Administrator. You assign Project
Administrators with projects in the Project Activities dialog box.
Plant Displays the highest plant hierarchy item assigned to the project. You assign <plants>
to projects in the Project Activities dialog box.
421
To enable users who have a full version of Sybase Adaptive Server Anywhere engine
(dbeng10.exe) to work in a domain backed up to Sybase Adaptive Server Anywhere
(INtools_Backup.db or its copy).
To open this dialog box, click DBA > Rebuild Stored Procedures and Triggers.
Admin schema Allows you to rebuild the Admin schema.
Domain schema Allows you to rebuild the schema of the domain you select from the list.
Domain Allows you to select the target domain if you choose to rebuild a Domain schema.
OK Opens a dialog box where you can accept or specify a log file path and start the process.
Make sure that all users have logged out of the database before rebuilding stored
procedures and triggers. When you start rebuilding stored procedures and triggers, no users
should attempt to log on to SmartPlant Instrumentation.
Data Window
Report Name Displays the full name of the report available in SmartPlant Instrumentation.
Module Name Displays the name of the module that includes the report.
Report Type Displays the report type. The report type determines whether the revision
management setting of a particular report is per document or per item. 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.
422
List
A report that displays a list of items. Examples of such reports are supporting-table reports and
browser views. If you created a report for a list of items using a browser view style, or item
search parameters, the software applies a unique document number and revision to this report
according to the specified browse view style or to the item search parameters.
For example, in the Wiring module, in the Cable Selection for Cable Schedule Report dialog
box, after creating a report for a list of cables filtered according to search parameters, the
software applies the unique document number and revision only when selecting the same search
parameters again.
Non-List
A report that is generated for a specific main item. Such a report displays the main item data
and associations. An example of a non-list-type report is a panel-strip report, which you can
generate for a specific strip. Such a report can display the main strip, two additional strips,
numerous cables, and wires.
In SmartPlant Instrumentation, you cannot apply global revisions to reports belonging to
the list report type because for a global revision, you can only use reports generated for a
specific item.
Revision Management Displays the revision management setting determined by the report
type. 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.
Per Item
The document number and revision are shared between documents created for a specific item
and between all reports generated for that item. This means that the document number and
revision numbers that you add to an item via the Revisions dialog box opened from the item
Properties dialog box are the same as in a print preview of any report generated for this item.
For example, after creating a revision for a specific strip from the 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
The document number and revision are unique to each specific document created or report
generated for a particular item. For example, if you create 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 are not shared. As a result, the document number and
revision added from the report print preview is different from the document number and revision
added via the Revisions dialog box opened from the item Properties dialog box.
Title Block Allows you to use a title block in the report. This can be a title block designed
by the user, or one of the defaults supplied with SmartPlant Instrumentation.
If you want to display the report without a title block, clear this check box. In this case,
the macros that appear in the title block appear at the top of the report. For those reports that
must contain a title block, the check box is selected by default, and you cannot clear it.
423
424
and enter
Filter by
These following options allow you to filter reports by a specific module.
Module Contains a list of SmartPlant Instrumentation modules that you can select for
filtering.
Apply Applies filtering.
Sort by
These following options determine the sorting order of the reports:
Report Lists all the reports in alphabetical order.
Module Lists the reports in alphabetical order per module.
Find
Report Allows you to find a specific report by entering a text string corresponding to the
name of the desired report.
Data Window
Parent <Item> Displays parent items of wiring equipment that you copied to the Claim or
Merge Buffer.
Selected Wiring Equipment Displays the wiring equipment you selected in the As-Built or
Project Explorer for copying to the buffer.
Required Wiring Equipment Displays the wiring equipment that you must select in the AsBuilt or Project Explorer and copy manually to the buffer.
Command Buttons
Print Prints the report using the current settings of your printer.
Save As Allows you to save the report in the format that you require.
425
426
Command Buttons
Apply Sets the reservations as defined.
Add Adds another data row for a new range definition.
Delete Deletes the current definition.
Command Buttons
Apply Sets the reservations as defined.
Add Adds another data row for a new range definition.
Delete Deletes the current definition.
427
S
Topics
Scope Definition Dialog Box ........................................................ 428
Search Dialog Box ......................................................................... 429
Security Options Dialog Box ......................................................... 430
Security Schema Password Encryption Dialog Box ...................... 430
Select Columns for Sorting Dialog Box ........................................ 431
Select Columns for Viewing Dialog Box ...................................... 431
Select Item Types for Comparison Dialog Box ............................. 431
Select Item Types for Reports Dialog Box .................................... 431
Select Logo Dialog Box ................................................................ 432
Select (Copy Unit Data) Dialog Box ............................................. 432
Select (Naming Conventions) Dialog Box .................................... 433
Select Plant (for Registering) Dialog Box ..................................... 433
Select Plant (for Retrieving Documents) Dialog Box ................... 433
Select Source Database Dialog Box .............................................. 433
Select Source for Claiming Dialog Box ........................................ 434
Set Color Dialog Box .................................................................... 435
Source Data Connection Dialog Box ............................................. 435
System Administration Window.................................................... 437
428
Command Buttons
Add Appends a new line in the Item properties data window.
Delete Deletes a selected line in the Item properties data window.
Verify Verifies the definition you made in the Item properties data window.
Results Lists the items that software found.
Select all Selects all the items listed in the Results data window.
Add to My List Adds the selected items to the My List pane in an window.
Go to Item In the tree view, selects the item you highlighted in the Results data window.
429
430
431
432
433
For more information about the Admin schema and other SmartPlant Instrumentation
database schemas, see SmartPlant Instrumentation Configuration and Maintenance Guide,
SmartPlant Instrumentation Database Technical Review > Logon Data and Database
Connection Security > SmartPlant Instrumentation Database Schemas.
When the source domain resides in a Sybase Adaptive Server Anywhere database, the
Admin schema logon name and Admin schema logon password boxes display IN_DBAMN
as view-only values. This is because in any Sybase Adaptive Server Anywhere database,
the Admin schema logon name and password are permanently set as IN_DBAMN.
Connect Connects to the source database.
Source project
Domain Allows you to select a source domain from the list.
Project Displays the name of the project from which you want to import data. After
selecting a domain, the software displays the source project automatically provided that the
database ID of the source and the target projects are identical.
Import only items marked as 'Merge Now' in the satellite For a project in an Owner
operator domain, imports from the selected project only those items that are marked as 'Merge
Now'.
Delete items from target if not found in source Select this option if you want to delete
items in the target database where they do not exist in the source. Clear this check box if you do
not want to delete the items from the target database.
Log File Opens a dialog box where you can define the log file name and path. Click this
button after connecting to the source database, and before importing data.
Report Opens a dialog box where you can view the list of items in the projects of the target
domain that will appear as duplicate in the target project after import. Click this button after
connecting to the source database, selecting the source domain, and before importing data.
Mapping This command opens the Map Plant Hierarchy Items dialog box, which allows
you to map <units> in the source plant hierarchy to one or more target <units>. This option only
applies where the source domain type is Engineering company.
Import Starts the import process.
435
When your source database is Sybase Adaptive Server Anywhere, the setting is view-only
because in any Sybase Adaptive Server Anywhere database, the Admin schema logon name
is permanently set as IN_DBAMN.
When your source database resides in Oracle, the default Admin schema logon name is
IN_DBAMN.
When your source 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.
Admin schema password Displays the default Admin schema logon password IN_DBAMN.
or type the required password name.
When your source database is Sybase Adaptive Server Anywhere, the setting is view-only
because in any Sybase Adaptive Server Anywhere database, the Admin schema logon
password is permanently set as IN_DBAMN.
When your source database is Oracle, the default Admin schema logon password is
IN_DBAMN.
When your source database is SQL Server, the default Admin schema logon password is
SPI_DBA. This setting must be different from the Admin schema logon name.
Connect Connects to the source database. After the connection is established, you can select
the source domain.
Domain After connecting to the source database, from the list, select the source domain.
Save last created ID for merging renamed items Allows you to 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 Merge
Options dialog box. If you clear this check box, the software makes a backup without saving
the last created item ID. In this case, the Merger Utility ignores any items that were renamed
since the backup, even if you select the Include renamed items option, and inserts them as new
records.
Copy users to target domain Allows you to copy the SmartPlant Instrumentation user
definitions from the source domain to the domain you are initializing. The software can only
copy those users who are assigned to groups.
436
Icon Description
Closes the System Administration window.
Opens the Domain Definition window, where you can create or modify domains.
Opens a dialog box where you can define or modify a user profile.
Opens a dialog box where you can define or modify a department profile.
T
Topics
Tablespace List Dialog Box .......................................................... 437
Target Database Parameters (Oracle) Dialog Box......................... 437
Target Database Parameters (SQL Server) Dialog Box ................ 439
Target Revisions Dialog Box ........................................................ 440
Telecom Device Panel Icons Dialog Box ...................................... 441
To Do List Dialog Box .................................................................. 441
Trim Audit Trail Data Dialog Box ................................................ 441
437
Admin schema
The options in this section are used to define the Admin schema name and password. For more
information about the Admin schema and other SmartPlant Instrumentation database schemas,
see SmartPlant Instrumentation Configuration and Maintenance Guide, SmartPlant
Instrumentation Database Technical Review > Logon Data and Database Connection Security
> SmartPlant Instrumentation Database Schemas.
Logon name Accept the default Admin schema logon name IN_DBAMN or enter another
name if you need. The logon name must be unique in the Oracle server. The logon name can
only start with a letter and contain no spaces. You can use an underscore ( _ ) to replace a space.
Logon password Accept the default Admin schema logon password IN_DBAMN or enter
another password if you need. The logon password can only start with a letter and contain no
spaces. You can use an underscore ( _ ) to replace a space.
Admin data
Tablespace name Accept the default Admin data tablespace name or enter another name if
you need.
Datafile name and path Accept the default path and name of the Admin datafile. You can
specify another path and name if you need. The default file extension is .dbf. You can change
the file extension as you require.
Tablespace size (MB) Accept the default Admin data tablespace size (25MB) if you want to
create four SmartPlant Instrumentation domains only. If you want to create more than four
domains, you need to specify a larger tablespace size.
438
Admin schema
The options in this section are used to define the Admin schema name and password. For more
information about the Admin schema and other SmartPlant Instrumentation database schemas,
see SmartPlant Instrumentation Configuration and Maintenance Guide, SmartPlant
Instrumentation Database Technical Review > Logon Data and Database Connection Security
> SmartPlant Instrumentation Database Schemas.
Logon name Displays the default Admin schema logon name SPI_DBAMN. You can type
a different name if needed. The logon name can only start with a letter and may not contain
spaces. You can use an underscore ( _ ) to indicate a space. The Admin schema logon name
must be different from the Admin schema logon password.
If this is the first database setup session for SmartPlant Instrumentation 2009 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.
Logon password Displays the default Admin schema logon password SPI_DBA. You can
type another password if needed, provided that it is different from the Admin schema logon
name. The logon password 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 2009 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.
439
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.
Admin data
Admin file name Accept the default value or type the required Admin file name.
Datafile name and path Accept the default settings or type the required Admin datafile
name and path. The default file extension is .mdf. You can change the file extension as you
require.
Initial size (MB) Accept the default value or type the required initial size value of the Admin
datafile.
Admin index
Index file name Accept the default value or type the required Admin index file name.
Datafile name and path Accept the default settings or type the required Admin index
datafile name and path. The default file extension is .mdf. You can change the file extension as
you require.
Initial size (MB) Accept the default value or type the required initial size value of the Admin
index datafile.
Filegroup Accept the default filegroup to which the Admin index datafile belongs, or type
the required filegroup name.
Command Buttons
OK Starts the database setup process.
Cancel Closes this dialog box and discards all the values you have entered.
440
Data Window
Define your revision settings to be used in SmartPlant Instrumentation documents you create in
the selected module. When in the left section of the Copy Data from Source dialog box you
select a different module, and access the Target Revisions dialog box again, the data window is
empty. Click a desired revision method option, and click New to add a row in the data window.
No (number) Displays the revision value, depending on the revision method option you use.
If your revision method is Other, type your revision value. If you did not select Other, every
time you click New, the software adds a new line with the next logical value and date. If
required, for methods P0, P1, P2..., 0, 1, 2..., and A, B, C..., you can change the default revision
number values as well.
By Type the name or initials of the person who created the revision (optional).
Date Type the date of creating a revision. The default is the current date. If required, type a
different date, using the format of the default date.
Description Type a revision description as required.
441
Period
Enables you to define the user operation period for which to trim the audit trail data. The time
of user operation appears in the audit trail repository. The audit trail repository contains time
data (year, month, day, hour, minutes, and seconds) about each user operation performed in a
particular domain.
From Allows you to type the initial date (month/day/year) of the audit trail data you want to
trim.
To Allows you to type the last date (month/day/year) of the audit trail data you want to trim.
Miscellaneous Options
Save to file Makes the File name box accessible for typing a file name segment for the target
file.
If you want to remove the audit trail data permanently from the current domain, clear this check
box.
File name Allows you to type a file name segment that will appear as part of a complete file
name in an external file where you save the audit trail data. This file will contain all the audit
trail data trimmed from the audit trail repository within the defined period.
Trim Removes the audit trail data contained in the audit trail repository within the defined
period.
442
U-V
Topics
Unit Properties Dialog Box ........................................................... 443
Update Statistics Dialog Box ......................................................... 445
User-Defined Database Views Dialog Box ................................... 445
User (Domain Administration) Dialog Box .................................. 445
User (System Administration) Dialog Box.................................... 446
443
444
445
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 Administrator or Domain Administrator.
If the System Administrator enables the use of Windows authentication logon method in a
specific domain, the software can create users automatically and assign them to the
appropriate user groups in that domain.
User Click New or Edit and type a unique user name (if you are creating a new user profile)
or select an existing user from the list (if you are editing an existing user profile). 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.
User initials Type the user initials, if required. These initials will be used to identify the user
when this user enters revisions. The user initials will appear in the By field of the Revisions
dialog box.
Password Type the user password (displayed masked). This is the default user password
given by the System Administrator and which can be later changed by the user. A password can
contain up to 15 characters (not case-sensitive). The software encrypts the password
automatically.
Verify new password Retype the password.
Note Type a short note if needed after clicking Edit or New. To insert a carriage return,
press Ctrl + Enter.
Department Select a department to which the user will be assigned.
System Administrator Select this check box to grant System Administrator rights to the
currently selected user.
IDEAL user Select this check box to define the currently selected user as an IDEAL user.
When generating reports using IDEAL, you must define an IDEAL user to enable the software
to make a connection between the SmartPlant Instrumentation Server and the SmartPlant
Instrumentation database. 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. Note that you can define one IDEAL user only per domain.
Command Buttons
Edit Allows you to edit the profile of the user you selected from the User list.
New Allows you to create a new user profile.
Delete Allows you to delete the user you selected from the User list.
If you enabled the use of Windows authentication logon method, it is possible to remove
all Windows users from SmartPlant Instrumentation if these users have been deleted from the
corresponding Windows groups.
446
SECTION
W
Topics
Wire End Naming Conventions Dialog Box ................................. 447
Wire End Naming Convention Properties Dialog Box.................. 447
Wiring Item Naming Options Dialog Box..................................... 449
Command Buttons
Properties Opens a dialog box where you can modify properties of a naming convention that
you selected in the data window.
New Opens a dialog box where you can define properties for a new naming convention.
Duplicate Opens a dialog box where you can duplicate a naming convention that you
selected in the data window.
Delete Deletes a naming convention that you select in the data window.
447
Segment definitions
Sample Shows a preview of the naming convention according to the definitions that you
have made in the data window.
Total length (not available when selecting any of the check boxes under the Trim Trailing
Spaces column) Represents the total value of characters in the naming convention segments,
including the separator characters. Any naming convention string can have a maximum length
of 50 characters.
Remove spaces from wire end names Removes spaces that appear in the naming
convention, regardless of whether any check boxes are selected in the Trim Trailing Spaces
column. Spaces can appear in the following cases:
You used a naming convention segment that includes spaces, for example, panel name FT
0001.
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.
For example, if you select this check box, the wire end name shown above becomes
FT0001TS1.
Data Window
Sequence Represents the position of the segment in the naming convention string. You can
change the sequence using the Up and Down buttons.
Separator Type or modify a separator between the segments in the naming convention
string. A separator can contain up to 30 characters of any kind.
Segment Select a segment from the list. A segment can be ether 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, users can type any string up to the length allocated for the free segment.
Start Type or modify a number to designate the starting character in the segment from which
the segment value appears in the naming convention. The default value is 1, which represents
the first character in the segment. If you select the Trim Trailing Spaces check box, the
software resets the value to 1 and makes it view-only.
448
Command Buttons
Add Adds a new row in the data window.
Delete Deletes a selected row in the data window.
Up and Down Change the order of the segments in the naming convention.
449
Naming Convention Copies the device cables with the naming convention of the target
<unit>.
Clear this check box if you want to copy all device cables without changing the source
names. The copied device cables are named according to the settings you make for copying
wiring items in the Copy Data from Source dialog box.
Signal name Copies signals using target tag names. If you clear this check box, the software
copies signals according to the settings you make for copying wiring items in the Copy Data
from Source dialog box.
Wire tag Copies wire tags using target tag names. If you clear this check box, the software
copies wire tags according to the settings you make for copying wiring items in the Copy Data
from Source dialog box.
OK Returns to the Copy Data from Source dialog box, where you can copy the <unit> data.
X-Y
Topics
Zoom.............................................................................................. 450
Zoom
Enables you to select the magnification level of the print preview of a generated report. You can
select a pre-set magnification level or enter the exact magnification level that you require. The
magnification level does not affect the report printout.
Magnification Allows you to use one of the following magnification levels:
200%
100%
65%
30%
Custom Allows you to enter a desired magnification level manually. The number must
be between 10 and 500.
OK Displays the report print preview with the magnification that you selected.
450
451
SECTION 12
As-Built Explorer
Displays all items available in As-Built. You use the As-Built Explorer to select items for
claiming for a project you selected in the Project Activities dialog box. You can either claim
specific items directly from the As-Built Explorer, or copy items to the Claim Buffer first, and
then, from the Claim Buffer, claim the copied items in batch mode. The As-Built Explorer
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.
Toolbar
Search
with.
Refresh
Filter
Opens the Search dialog box where you can look for items that you want to work
Updates the display of items.
Allows you to filter the display of items.
View
Toggles through each view of the items in the Items pane. You can click the
arrow and select the desired view.
Find
view.
Opens the Find Item dialog box where you can look for a specific item in the tree
453
Items Pane
The Items pane displays the individual items that comprise the hierarchy of the item or the
folder that you selected in the tree view. The name of the pane changes from Items to Projects,
for an item selected in the tree view, when you click Claimed For . The Projects pane lists
projects that already contain the item you selected.
The Items pane has the following display views:
List displays the individual items that comprise the hierarchy of the item or the folder that
you selected in the tree view. If needed, you can claim items or copy them to the Claim Buffer
directly from the List view.
My List allows you to create a special view of the Items pane where you can keep items that
belong to various folders in the tree view. The software retains all the items in the My List view
until you remove them from that list.
Claim Buffer
You use the Claim Buffer to claim items in batch mode. The Claim Buffer contains items that
you coped from the As-Built Explorer for the current project. Before copying items, the Claim
Buffer only contains empty item type folders. After you copy the items, it is possible to claim
all the items available in the Claim Buffer. Before claiming items, it is possible to generate a
report of the items available in the Claim Buffer.
When copying items to the Claim Buffer, the software applies preferences that you set in the
Preferences for Scoping and Merging Data dialog box. These preferences determine how the
software copies to the Claim Buffer sub-items and parent items that are associated with the
items you select in the As-Built Explorer.
The Claim Buffer displays items according to hierarchical structure, the way they appear in the
As-Built Explorer. You can arrange the hierarchical structure of the data according to item
types or according to the physical location of the items.
454
The Claim Buffer does not show engineering data associated with instrument tags.
The Claim Buffer opens and closes together with the As-Built Explorer, and the Claimed
Items window. When you close the Explorer windows, the software saves the display of
items in the Claim Buffer for the project you selected in the Project Activities dialog box.
Items that you claim are removed from the Claim Buffer automatically.
The main features of the Claim Buffer are as follows.
Toolbar
Search
with.
Opens the Search dialog box where you can look for items that you want to work
Updates the display of items.
Refresh
Filter
View
Toggles through each view of the items in the Items pane. You can click the
arrow and select the desired view.
Find
view.
Opens the Find Item dialog box where you can look for a specific item in the tree
Items Pane
The Items pane (list view) displays the individual items that comprise the hierarchy of the item
or the folder that you selected in the tree view. You cannot claim items from the list view.
The Items pane has the following display views:
List displays the individual items that comprise the hierarchy of the item or the folder that
you selected in the tree view.
My List allows you to create a special view of the Items pane where you can keep items that
belong to various folders in the tree view. The software retains all the items in the My List view
until you remove them from that list.
455
Claimed Items
Displays items that you have claimed from the current project. The displayed items are viewonly. When you close the Claimed Items window, the software saves the display of items
claimed during the current claim session. After you run another claim session for the same
project, the software adds the claimed items to the tree view.
In the Claimed Items window, the software marks items that you claimed with the indicator .
Merge Buffer
You use the Merge Buffer to merge items with As-Built in batch mode. You can merge items
belonging to different types, merge the associated sub-items, and the parent items, depending on
the preferences you set in the Preferences for Scoping and Merging Data dialog box. Before
copying items, the Merge Buffer only contains empty item type folders. Before merging data,
you can generate a report of items you copied to the Merge Buffer from the Project Explorer.
The Merge Buffer contains items that you coped whether directly from a project opened in
SmartPlant Instrumentation or from the project you selected on the Project Activities dialog
box. When copying items to the Merge Buffer, you specify a merge action for all or selected
items; 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. 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. After you copy the items, it is possible to merge all the items available in the Merge
Buffer.
The Merge Buffer displays items according to hierarchical structure, the way they appear in the
Project Explorer. You can arrange the hierarchical structure of the data according to item
types or according to the physical location of the items.
The Merge Buffer does not show engineering data associated with instrument tags.
The Merge Buffer opens and closes together with the Project Explorer. When you close
the Explorer windows, the software saves the display of items in the Merge Buffer for the
project you selected in the Project Activities dialog box.
Items that you merge are removed from the Merge Buffer automatically.
The main features of the Merge Buffer are as follows.
Toolbar
Search
with.
456
Opens the Search dialog box where you can look for items that you want to work
Toggles through each view of the items in the Items pane. You can click the
View
arrow and select the desired view.
Find
view.
Opens the Find Item dialog box where you can look for a specific item in the tree
Items Pane
The Items pane (list view) displays the individual items that comprise the hierarchy of the item
or the folder that you selected in the tree view. You cannot merge items from the list view.
The Items pane has the following display views:
List displays the individual items that comprise the hierarchy of the item or the folder that
you selected in the tree view.
My List allows you to create a special view of the Items pane where you can keep items that
belong to various folders in the tree view. The software retains all the items in the My List view
until you remove them from that list.
457
Project Explorer
Displays all items available in the project you selected in the Project Activities dialog box.
Also, the Project Explorer displays items that have been deleted from the current project but
appear in As-Built.
You use the Project Explorer to define items for merging with As-Built, and to assign merge
actions to these items. You can either merge specific items directly from the Project Explorer,
or copy items to the Merge Buffer first, and then, from the Merge Buffer, merge the copied
items in batch mode. The Project Explorer 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.
Toolbar
Search
with.
Refresh
Filter
Opens the Search dialog box where you can look for items that you want to work
Updates the display of items.
Allows you to filter the display of items.
View
Toggles through each view of the items in the Items pane. You can click the
arrow and select the desired view.
Find
view.
Opens the Find Item dialog box where you can look for a specific item in the tree
458
Items Pane
The Items pane displays the individual items that comprise the hierarchy of the item or the
folder that you selected in the tree view.
The Items pane has the following display views:
List displays the individual items that comprise the hierarchy of the item or the folder that
you selected in the tree view. If needed, you can merge items or copy them to the Merge Buffer
directly from the List view.
My List allows you to create a special view of the Items pane where you can keep items that
belong to various folders in the tree view. The software retains all the items in the My List view
until you remove them from that list.
The Source Project Explorer is not accessible when working in exclusive claim mode.
You cannot add, edit, or delete items in the Source Project Explorer.
The Source Project Explorer opens and closes together with the Target Project Buffer.
You can claim items directly from the Source Project Explorer only if the Target Project
Buffer is empty.
The main features of the Source Project Explorer are as follows.
Toolbar
Search
with.
Refresh
Filter
Opens the Search dialog box where you can look for items that you want to work
Updates the display of items.
Allows you to filter the display of items.
View
Toggles through each view of the items in the Items pane. You can click the
arrow and select the desired view.
Find
view.
Opens the Find Item dialog box where you can look for a specific item in the tree
459
Items Pane
The Items pane displays the individual items that comprise the hierarchy of the item or the
folder that you selected in the tree view. The name of the pane changes from Items to Projects
when you click Claimed For for an item selected in the tree view. The Projects pane lists
projects that already contain the item you selected.
The Items pane has the following display views:
List displays the individual items that comprise the hierarchy of the item or the folder that
you selected in the tree view. If needed, you can claim items or copy them to the Target
Project Buffer directly from the List view.
My List allows you to create a special view of the Items pane where you can keep items that
belong to various folders in the tree view. The software retains all the items in the My List view
until you remove them from that list.
460
The Target Project Buffer is not accessible when working in exclusive claim mode.
The Target Project Buffer does not show engineering data associated with instrument tags.
The Target Project Buffer opens and closes together with the Source Project Explorer.
When you close the Explorer windows, the software saves the display of items in the Target
Project Buffer for the project you selected on the Project Activities dialog box.
Items that you claim are removed from the Target Project Buffer automatically.
The main features of the Target Project Buffer are as follows.
Toolbar
Search
with.
Opens the Search dialog box where you can look for items that you want to work
Refresh
Filter
Toggles through each view of the items in the Items pane. You can click the
View
arrow and select the desired view.
Find
view.
Opens the Find Item dialog box where you can look for a specific item in the tree
Items Pane
The Items pane (list view) displays the individual items that comprise the hierarchy of the item
or the folder that you selected in the tree view. You cannot claim items from the list view.
The Items pane has the following display views:
461
Item Indicators
The software uses the following icons to indicate the status of various folders and items in your
project. The icons appear beside the folders and items in the tree view of an Explorer window.
Icon
Description
An item that belongs to the current project.
An item that belongs to As-Built.
A dummy item.
An item that does not belong to the current project or As-Built. Also, an item that
belongs to As-Built and all the projects, for a example, a hook-up type.
Access denied.
View only.
An As-Built item that has been claimed for a project.
462
Example 2:
Example 3:
Example 4:
Example 5:
463
464
SECTION 13
Glossary
Select the letter that the term starts with, then select the term.
ABCDEFGHIJKLMNOPQRSTUVWXYZ
A
Admin schema
Administrator (Domain)
Administrator (System)
area
As-Built
audit trail repository
automatic block assignment method
B
backup repository
C
cable block diagram
cable type dependency
case
claiming items
conventional tag numbers
custom fields
custom table
customized title block
D
default plant
document item
document number
document numbers (default)
domain
domain administration
Domain Administrator
Domain schema
dummy item
E
engineering company
electrical tag
exclusive claim mode
465
Glossary
F
fully-functional item
G
global path
global revision
I
item
item registry
L
link group
list-type report
M
manual block assignment method
N
non-exclusive claim mode
non-list-type report
O
owner operator
P
password
plant
PowerBuilder units
Project Administrator
R
report title block
revision (global)
revision management per document
revision management per item
S
specification title block
supporting table
system administration
System Administrator
T
title block
typical loop
typical tag
U
unit
V
View-Only Domain schema
virtual tag
466
Glossary
W
wildcard
Windows authentication logon method
wire end naming convention
workflow
467
Glossary
468
Index
A
A 275
access rights 74, 75, 76, 77, 126, 193, 194,
195, 204, 205, 206, 207, 231
all items 205
assigning users to groups 76
common tasks 74, 194
copying 207
creating a group 75
deleting groups 76
descriptions 195
editing a group 76
overview 193
project administrators 126
removing users from groups 77
report 207, 231
specific items 204
viewing items on levels 207
workflow 206
Access Rights 193
Access Rights Common Tasks 194
Access Rights Descriptions 195
Access Rights Window 276
Access Rights Window Toolbar 276
Accessing the Administration Module 67
accounting 115, 117
adding 115
associating with a domain 117
common tasks 115
deleting 115
editing 115
Accounting Dialog Box 277
Accounting, Contractors, and Clients
Common Tasks 115
Actions for Merging Items 178
Activate the Audit Trail Functionality 87
Active Database Connections Dialog Box
278
activity tracking 88, 89, 90, 91
clearing data 89
common tasks 88
graph-style activity report 91
grid-style activity report 90
setting 89
Activity Tracking Management Common
Tasks 88
Activity Tracking Report Settings (Graph)
Dialog Box 278
Activity Tracking Report Settings (Grid)
Dialog Box 279
Add a Datafile to the TEMPDB Database
107
Add a Filegroup 106
Add a Log File 106
Add Accounting Dialog Box 280
Add and Manage Accounting Information
115
Add and Manage Clients 117
Add and Manage Contractors 116
Add Client Dialog Box 280
Add Contractor Dialog Box 280
Add Database Views Dialog Box 281
Add Datafiles (Oracle) Dialog Box 282
Add Datafiles (SQL Server) Dialog Box
281
Add Datafiles to Oracle Tablespaces 108
Add Items to My List in the Items Pane 147
Add User-Defined Database Views 44
add-ins
exporting macros 220
importing browser views 219
importing DDP Library data for PDS 220
importing hook-up libraries 217
importing macros 221
importing system interfaces 218
overview 217
Add-Ins 217
Admin schema 97
logon password encryption 97
Administration module overview 13
Administration Window 282
Advanced Domain Preferences Dialog Box
282
Advanced Filter Definition (Cables) Dialog
Box 283
Advanced Filter Definition (Loops) Dialog
Box 284
469
Index
Advanced Project Preferences Dialog Box
285
apostrophe in custom fields 228
Area Properties Dialog Box 286
As-Built 125, 128, 132, 133, 137, 138, 139,
147, 149, 153, 155, 157, 159, 160, 161,
162, 163, 164, 166, 170, 174, 176, 177,
178, 179, 180, 181
actions for merging items 178
claiming common tasks 153
claiming documents 163
claiming from As-Built Explorer 161
claiming from buffer 160
claiming from command line 161
common tasks 128
comparing with project data 176
deleting project data 139
deleting projects 138
displaying items 155
displaying items for merging 166
item comparison options 177
items in Claim Buffer 159
making definitions 132
merging data common tasks 174
merging data overview 164
merging items from command line 181
merging items from Merge Buffer 180
merging items from Project Explorer 180
overview 125
preferences for claiming 157
preferences for merging 176
prerequisites for claiming documents 162
project deletion common tasks 138
rebuilding projects 137
reports of changed documents 170
reports of changed items 170
reserving tags and loops 133
scoping data overview 147
setting merge actions 179
settings and conditions for claiming 149
As-Built Explorer 453
Assign a Domain Administrator 73
Assign Groups to Project Dialog Box 287
Assign Icons to Telecom Device Types 225
Assign User Groups to a Project 131
Assign Users to Groups 76
Assign Users to Groups Dialog Box 287
470
B
B 288
Back Up a Domain 33
Back Up a Domain from the Command Line
34
Back Up a Domain in Thin Client Mode 35
Back Up Domain Dialog Box 288
Back Up Files Containing Audit Trail Data
on SQL Server 39
Back Up Files on Sybase Adaptive Server
Anywhere 40
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 a domain 31, 32, 33, 34, 35, 36,
37, 38, 39, 40
audit trail data 37
common tasks 32
domain backup procedure 33, 38, 40
from the command line 34
in Windows Vista 36
overview 31, 37, 39, 40
via Citrix 35
Backing Up Audit Trail Data on Oracle 37
Backing Up Audit Trail Data on SQL Server
39
Backing Up Audit Trail Data on Sybase
Adaptive Server Anywhere 40
Index
Backing Up Files Containing Audit Trail
Data 37
Backup Repository Dialog Box 289
Browser > Custom (Preferences) 361
Browser > Fonts (Preferences) 361
Browser > Reports (Preferences) 362
browsers 219, 228
defining custom fields 228
importing browser views 219
Browsers That Can Contain Custom Fields
228
C
C 290
Cable Block Diagram > View (Preferences)
362
cable block diagrams 163
Cable Hierarchy Example 462
cable type dependency 85
cables 85, 144, 163, 462
claiming cable block diagrams 163
enabling cable type dependency 85
filtering 144
hierarchy in explorer windows 462
Calculation > Custom (Preferences) 362
Calculation > General (Preferences) 363
Calibration and Maintenance > Custom
(Preferences) 363
Calibration and Maintenance > General
(Preferences) 363
catalog tables 105, 420
INtools.ini settings 420
rebuilding 105
Change a Domain Schema Password 96
Change Admin Schema Password Dialog
Box 291
Change Domain Schema Password Dialog
Box 291
Change Password Dialog Box 292
Change Security Schema Password Dialog
Box 291
Change the Security Schema Password 96
Change the System Administrator Password
96
character set for Oracle 42, 50
database character set 50
initialization prerequisites 42
national character set 50
Citrix 35
domain backup 35
Claim and Merge Options (Preferences)
365
Claim As-Built Items from the Command
Line 161
Claim Buffer 454
Claim Documents 163
Claim Items Directly from the As-Built
Explorer or Source Project Explorer 161
Claim Items from the Buffer 160
claim mode 83, 147, 149
defining 83
exclusive 147
non-exclusive 147
settings and conditions for claiming 149
Claim Tab (Preferences for Scoping and
Merging Data Dialog Box) 352
Claimed Items 456
claiming 83, 147, 153, 157, 158, 159, 160,
161, 162, 163, 164
claim modes 147
claiming common tasks 153
copying items to Claim Buffer 158
copying items to Target Project Buffer
158
documents 163
exclusing claim mode 83
fieldbus tags 147
from another project 161
from As-Built 161
from buffer 160
from command line 161
items claimed for multuple projects 164
items in buffer 159
preferences 157
prerequisites for claiming documents 162
showing projects with claimed items 164
Clean Up Item Registry 259
Clean Up the Oracle Database 21
Clean Up the SQL Server Database 28
Clear Activity Tracking Data 89
Clear Activity Tracking Data Dialog Box
292
Clear Blocked Sessions on Oracle 240
Clear Locking in All Sessions 240
Clear Locking in Selected Sessions Dialog
Box 292
471
Index
Clear Locking per User 240
Clear SmartPlant Instrumentation Session
Records 241
Clearing Locking 238
Clearing Locking Common Tasks 239
Client Dialog Box 293
clients 115, 117
adding 117
associating with a domain 117
common tasks 115
deleting 117
editing 117
Colors Dialog Box 293
colors of displayed items 133
command line 34, 57, 161, 181
claiming items for project 161
domain backup 34
domain initialization 57
merging items 181
Communication Line > View (Preferences)
368
Compare Project Data with As-Built Data
176
Comparison List Dialog Box 294
Comparison List Filter Dialog Box 295
Comparison List Report Dialog Box 296
comparison list report generation 169
Configure SmartPlant Instrumentation for
Integration 253
Configuring SmartPlant Instrumentation for
Integration 252
connection to database 118
list of connections 118
Contractor Dialog Box 296
contractors 115, 116, 117
adding 116
associating with a domain 117
deleting 116
editing 116
Copy Access Rights 207
Copy Access Rights Dialog Box 301
Copy All Items to the Merge Buffer as
Merge Now 172
Copy All Items to the Merge Buffer as
Release Claim 172
Copy All Module Data 246
Copy Custom Fields 228
Copy Data from Source Dialog Box 297
472
Index
custom fields 226, 227, 228
apostrophe in browsers 228
browsers 228
copying 228
defining 226
item types 228
length 226
plant hierarchy fields 226
process data sequence numbers 227
Custom Fields Dialog Box 303
Custom Fields Tab (Plant Hierarchy Item
Properties Dialog Box) 286, 349, 444
custom tables 230
defining 230
Custom Tables Dialog Box 305
custom title blocks 212, 213
associating with specs 212
database views 44
description 213
PowerBuilder units 213
D
D 305
data comparison 169, 176, 177
comparing project data with As-Built
176
comparison list reports for merging 169
item comparison options 177
data copying options 241, 243, 244, 246,
247, 248
all module data 246
CAD drawing blocks 246
common tasks 243
flow of activities 243
overview 241
restrictions 241
revisions 248
setting wiring naming options 247
source unit selection 244
specific data 244
Data Files to Delete Manually Dialog Box
307
database 50, 92, 99, 100, 101, 104, 105,
106, 107, 108, 109, 112, 118, 238, 239,
240, 241
Database Locking Mode (for Multi-User
Versions) 99
473
Index
supported character set 50
updating Oracle statistics 109
viewing Oracle tablespaces 108
datafiles 106, 107, 108
adding filegroups 106
adding log file for SQL Server 106
adding to tablespaces 108
adding to TEMPDB for SQL Server 107
dbeng10.exe 31
DBMS_PIPE 19
DBParm parameter 21
DCS hardware I/O data 219
Foxboro - I/A FBMs 219
DDP Library data for PDS 220
importing 220
default 104, 213
rebuilding default views 104
title block descriptions 213
Define a SmartPlant Instrumentation User
72
Define an IDEAL User 255
Define Custom Fields 226
Define Custom Tables 230
Define Databases for Logging On to
SmartPlant Instrumentation 101
Define Field Personnel Profiles 232
Define KKS Naming Convention Using
KKS Segments 113
Define Naming Conventions 184
Define Panel Location Levels 224
Define Paths When Using Oracle 237
Define Paths When Using SQL Server 237
Define Paths When Using Sybase Adaptive
Server Anywhere 238
Define Report Revision Management
Settings 215
Define Revision Source for an Integrated
Environment 267
Define Settings for an Integrated
Environment 257
Define Wire End Naming Conventions 191
Delete a Domain 60
Delete a Group 76
Delete a Plant Hierarchy Item 125
Delete a Single Project 138
Delete an Invalid Domain on Oracle 60
Delete an Invalid Domain on SQL Server
61
474
Index
Clear Locking in Selected Sessions 292
Client 293
Colors 293
Comparison List 294
Comparison List Filter 295
Comparison List Report 296
Connected Users 278
Contractor 296
Copy Access Rights 301
Copy Data from Source 297
Copy Data from Source (Left Section)
298
Copy Data from Source (Lower-Right
Section) 299
Copy Data from Source (Upper-Right
Section) 298
Copy From 302
Copy from Project 302
Copy Naming Conventions 303
Copy Naming Conventions From 302
Copy to Projects 303
Custom Fields 303
Custom Tables 305
Customize Toolbar 305
Data Files to Delete Manually 307
Database Upgrade 306
Delete Invalid Domain 307
Delete Projects 307
Department 308
Dimensional Data Settings 309
Domain Data and Indexes 308
Domain Tablespace Definition 320
Export Macros 321
Field Personnel Profile 322
Filegroup List 322
Filter Definition 322
Find Item 324
Generate Access Rights Report 324
Global Access Rights 325
Group 326
Import Browser Views 327
Import DCS Hardware I/O Library 329
Import DDP Library Data for PDS 329
Import Hook-Up Library 329
Import Interface Language 330
Import Macros 330
Import System Interfaces 330
Initialize (Oracle) 331
475
Index
Set Color 435
Source Data Connection 435
Tablespace List 437
Target Database Parameters (Oracle) 438
Target Database Parameters (SQL Server)
439
Target Unit Revisions 440
Telecom Device Panel Icons 441
To Do List 441
Trim Audit Trail Data 442
Unit Properties 443
Update Statistics 445
User (Domain Administration) 445
User (System Administration) 446
User-Definied Database Views 445
Wire End Naming Convention Properties
448
Wire End Naming Conventions 447
Wiring Item Naming Options 449
Zoom 450
Dimensional Data Settings Dialog Box 309
DisableBind 21
disconnecting users 240
Display Formats of Item Categories 132
Display Items in the As-Built Explorer 155
Display Items in the Source Project Explorer
156
Document Binder > Custom (Preferences)
369
Document Binder > General (Preferences)
369
Document Binder > General Document
Binder (Preferences) 369
Document Binder > Specification Binder
(Preferences) 370
Document Number Naming Convention
Examples 188
documents 162, 163, 170, 184, 188
claiming cable block diagrams 163
default document numbers 188
document number naming conventions
188
prerequisites for claiming 162
reports of changed documents 170
spaces in file names 184
Domain Administration
access rights 193
access rights common tasks 74, 194
476
Index
Domain Deletion Common Tasks 59
Domain Initialization 41
Domain Initialization Common Tasks 43
Domain Management Common Tasks 82
Domain Tablespace Definition Dialog Box
320
domains 31, 32, 33, 34, 35, 36, 37, 38, 39,
40, 41, 42, 43, 45, 47, 48, 50, 53, 55, 57,
58, 60, 63, 64, 73, 82, 84, 86, 88, 104,
105, 107, 209, 211
activity tracking common tasks 88
assigning a Domain Administrator 73
backup 38, 40
backup common tasks 32
backup from the command line 34
backup procedure 33
backup via Citrix 35
defining 84
defining domain common tasks 82
deleting 60
domain backup overview 31, 37, 39, 40
empty domain initialization in a .db file
45
empty domain initialization in Oracle 48
empty domain initialization in SQL Server
53
enabling workflow 86
exporting preferences 211
importing preferences 211
initialization common tasks 43
initialization from the command line 57
initialization in a .db file from a source
47
initialization in Oracle from a source 50
initialization in SQL Server from a source
55
initialization log files 58
initialization overview 41
initialization prerequisites 42
numeric character settings for Oracle 63
optimizing indexes on SQL Server 107
rebuilding catalog tables 105
rebuilding default views 104
rebuilding stored procedures and triggers
104
setting domain preferences 209
workaround for backing up in Vista 36
E
E 321
Enable Cable Type Dependency 85
Enable Item Registry 87
Enable the Use of Wire End Naming
Conventions 191
Enable Workflow 86
Encrypt All Domain Schema Passwords 97
Encrypt All User Passwords 98
Encrypt the Admin Schema Logon Password
97
Encrypt the Security Schema Password 98
encryption 97, 98
Admin schema logon password 97
all user passwords 98
Enhanced Reports > Connectors
(Preferences) 371
Enhanced Reports > Custom (Preferences)
372
Enhanced Reports > Drawing (Preferences)
372
Enhanced Reports > File Locations
(continued) (Preferences) 374
Enhanced Reports > File Locations
(Preferences) 373
Enhanced Reports > Fonts (Preferences)
374
Enhanced Reports > General (Preferences)
375
Enhanced Reports > Hook-Ups > View
(Preferences) 371
Enhanced Reports > Layers (Preferences)
376
Enhanced Reports > Pagination and
Revisions (Preferences) 377
Enhanced Reports > Title Block
(Preferences) 377
Enhanced SmartLoop > View (Preferences)
378
examples 113, 188, 462, 463, 464
cable hierarchy 462
477
Index
document number naming conventions
188
loop KKS naming convention 113
panels by category 463
panels by location 464
exclusive claim mode 83
disabling 83
enabling 83
explorer windows 140, 141, 142, 143, 147,
453, 454, 456, 458, 459, 460, 462
As-Built Explorer 453
Claim Buffer 454
Claimed Items 456
common tasks 141
descriptions 140
filtering items 143
finding a specific item 143
finding multiple items 142
item status indication icons 462
Merge Buffer 456
overview 140
Project Explorer 458
Source Project Explorer 459
Target Project Buffer 460
using in owner operator domain 140
using My List 147
Explorer Windows 140
Export Macros 220
Export Macros Dialog Box 321
Export Preferences 211
exporting 211
exporting project data
preferences 211
External Files with Trimmed Audit Trail
Data 236
F
F 322
field personnel 232
defining 232
Field Personnel Profile Dialog Box 322
Fieldbus Loop > View (Preferences) 380
fieldbus tags 147, 164
claiming 147
merging with As-Built 164
Filegroup List Dialog Box 322
filegroups 24, 106
adding 106
478
filegroup descriptions 24
printing filegroup information 106
files 184
removing spaces 184
Filter Cables 144
Filter Definition Dialog Box 322
Filter Loops According to Blocks 146
Filter the Display of Items in an Explorer
Window 143
filtering 144, 146
filtering items 143
cables 144
cross cables 144
loops according to blocks 146
Find a Specific Item in the Tree View 143
Find Item Dialog Box 324
Flow of Activities for Copying Data 243
Flow of Activities for Defining a Project
Administrator 126
Flow of Activities for Working in KKS
Mode 112
Foxboro - I/A FBMs 219
G
G 324
General (Preferences Management Dialog
Box) 356
General Database Maintenance Common
Tasks 100
General Tab (Area Properties Dialog Box)
286
General Tab (Plant Properties Dialog Box)
348
General Tab (Preferences for Scoping and
Merging Data Dialog Box) 350
General Tab (Unit Properties Dialog Box)
443
Generate a Graph-Style Activity Tracking
Report 91
Generate a Grid-Style Activity Tracking
Report 90
Generate Access Rights Report 207
Generate Access Rights Report Dialog Box
324
Generate Comparison List Reports 169
Generate Domain Administration Reports
231
Generate Naming Convention Reports 190
Index
Generate Reports of Changed Documents
170
Generate Reports of Changed Items 170
Generate Reports of Items Copied to the
Buffer 159
Generate Reports of Items Copied to the
Merge Buffer 171
Generate Reserved Items Report 134
Generating Reports for Merging Data
Common Tasks 168
Global Access Rights Dialog Box 325
global path 88
specifying 88
glossary 465
Administration module 465
Glossary 465
Grant Access Rights for Selected Items or
Activities 204
Grant the Same Access Rights for All Items
205
Grant to view Creation Error 64
Group Dialog Box 326
groups 74, 75, 76, 77, 78
assigning users 76
creating 75
deleting 76
editing 76
for Windows authentication 78
overview 74
removing deleted Windows users 78
removing users 77
SmartPlant Instrumentation groups 77
Windows global groups 77
H
Handle an Initialization Failure 62
hierarchy 121
hierarchy levels 122, 125
creating 122
deleting 122
deleting items 125
designing plant hierarchy 121
history 234
hook-up libraries 217
importing 217
Hook-Ups > CAD File Locations
(Preferences) 383
Hook-Ups > Custom (Preferences) 383
I
I 327
icons 225, 462
assigning to telecom device types 225
descriptions of item indicators 462
in explorer windows 462
IDEAL user 72
Import a New Interface Language 270
Import Browser Views 219
Import Browser Views Dialog Box 327
Import Data to a Project 134
Import DCS Hardware I/O Library Data
219
Import DCS Hardware I/O Library Dialog
Box 329
Import DDP Library Data 220
Import DDP Library Data Dialog Box 329
Import Hook-Up Libraries 217
Import Hook-Up Library Dialog Box 329
Import Interface Language Dialog Box 330
Import Macros 221
Import Macros Dialog Box 330
Import Preferences 211
Import Spec Forms 221
Import Spec Forms Dialog Box 328
Import System Interfaces 218
Import System Interfaces Dialog Box 330
importing 211, 217, 218, 219, 220, 221,
270
browser views 219
DCS hardware I/O library data 219
DDP Library data for PDS 220
Foxboro - I/A FBMs 219
hook-up libraries 217
interface language 270
macros 221
preferences 211
system interfaces 218
indicators of items 462
initialization 41, 43, 44, 45, 47, 48, 50, 53,
55, 57, 58, 62
Initialization Log Files 58
initialization prerequisites 42
for Oracle 42
for SQL Server 42
479
Index
for Sybase Adaptive Server Anywhere
42
for Windows Vista 42
language environments 42
NLS_NUMERIC_CHARACTERS 42
supported character set 42
initialization troubleshooting 61, 62, 63, 64
common tasks 43, 61
empty domain initialization in a .db file
45
empty domain initialization in Oracle 48
empty domain initialization in SQL Server
53
from the command line 57
Grant to view Creation Error 64
handling an initialization failure 62
in .db file from a source 47
in Oracle from a source 50
in SQL Server from a source 55
log files 58
ORA-01722 error 63
overview 41
restarting 62
restarting initialization 62
resuming 62
resuming initialization 62
user-defined database views 44
Windows Vista 63
Initialize (Oracle) Dialog Box 331
Initialize (SQL Server) Dialog Box 333
Initialize (Sybase Adaptive Server
Anywhere) Dialog Box 334
Initialize a Domain from the Command Line
57
Initialize a Domain in Oracle Using Another
Domain as a Source 50
Initialize a Domain in SQL Server Using
Another Domain as a Source 55
Initialize a Domain in Sybase Adaptive
Server Anywhere Using Another Domain
as a Source 47
Initialize an Empty Domain in Oracle 48
Initialize an Empty Domain in SQL Server
53
Initialize an Empty Domain in Sybase
Adaptive Server Anywhere 45
InitLog.txt 58
480
Index
Internal Cross Wiring > View (Preferences)
393
intools.ini file 101
[DATABASE] section 101
[PROFILES] section 101
DBMS parameter requirement 101
defining databases 101
INtools_Backup.db 31, 36, 37, 39, 40, 42
backing up a domain 31
connection problem in Windows Vista
36
prerequisites for working in backed up
domain 42
INTOOLS_ENGINEER role 15, 23, 41
database setup for Oracle 15
database setup for SQL Server 23
domain initialization 41
INtoolStorage 237, 238
Oracle 237
SQL Server 237
Sybase Adaptive Server Anywhere 238
Item and Sub-Item Selection Options for
Merging with As-Built 167
Item Comparison Options 177
item display colors 133
Item Indicators 462
item registry 87, 257, 258, 259
cleaning up 259
common tasks 258
enabling 87
overview 257
registration procedure 258
Item Registry Activities 257
Item Registry Activities Common Tasks
258
items 132, 133, 143, 155, 156, 157, 158,
159, 166, 167, 169, 171, 172, 173, 176,
177, 178, 179, 195, 207, 462
access rights descriptions 195
comparison list reports for merging 169
comparison options 177
copying all as Merge Now 172
copying all as Release Claim 172
copying as Merge Now 172
copying as Release Claim 173
copying display format 133
copying for merging common tasks 171
copying to Claim Buffer 158
K
KKS 112, 113
naming conventions 113
requirements 112
L
L 337
language 269, 270, 271, 272, 273
importing interface language 270
interface language common tasks 270
interface language overview 269
prefixes and suffixes 273
replacing from database 271
replacing from file 271
translating interface text phrases 272
Left Section (Copy Data from Source Dialog
Box) 298
length 92, 182, 190, 226
custom field characters 226
naming conventions 182
passwords 92
wire end naming convention 190
List of Duplicate Items Dialog Box 337
Load Audit Trail Data 235
Load Audit Trail Data Dialog Box 337
locations 224
location level separators 224
location levels for panels 224
locking 99, 100, 118, 238, 239, 240, 241
481
Index
clearing - common tasks 239
clearing - overview 238
clearing in all sessions 240
clearing on Oracle 240
clearing per user 240
clearing session records 241
database connections 118
database locking mode 99
setting database locking mode 100
Log File Dialog Box 338
log files 19, 58, 160, 180
domain backup 58
domain initialization 58
items claimed from buffer 160
merged items 180
orasetup.log 19
Log on as Domain Administrator 68
Log on as System Administrator 67
logging on 67, 68, 77, 78, 79, 101
as Domain Administrator 68
as System Administrator 67
defining databases 101
groups for Windows authentication 78
ODBC profile for SQL Server 101
switching to dirrerent logon method 79
Windows authentication 77
logos 131, 232
selecting for a domain 232
selecting for projects 131
Loop Drawings > CAD File Locations
(Preferences) 393
Loop Drawings > Custom (Preferences)
395
Loop Drawings > General (Preferences)
395
loop numbers 133, 134, 146
filtering according to blocks 146
reserved loops report 134
reserving for As-Built 133
reserving for projects 133
Loop Numbers Tab (Reserve Tags and
Loops Dialog Box) 426
Lower-Right Section (Copy Data from
Source Dialog Box) 299
M
M 338
macros 220, 221
482
exporting 220
importing 221
Maintaining the SmartPlant Instrumentation
Database 100
maintenance 99, 100, 105, 106, 107, 108,
109
catalog tables 105
database locking mode 99
database maintenance on Oracle 107
database maintenance on SQL Server
105
database maintenance overview 100
general database maintenance 100
optimizing indexes on Oracle 109
optimizing indexes on SQL Server 107
printing filegroup information 106
updating Oracle statistics 109
viewing Oracle tablespaces 108
Make As-Built Definitions 132
Make Domain Definitions 84
Managing Audit Trail Data 234
Managing Audit Trail Data Common Tasks
234
Managing Database Security 92
Managing Preferences Common Tasks 208
merge actions 178
Merge Later 178
merge mode for Merge Now 178
Merge Now 178
Release Claim 178
Merge Buffer 456
Merge Items Directly from the Project
Explorer 180
Merge Items from the Command Line 181
Merge Items from the Merge Buffer 180
merge modes 164
Merge Tab (Preferences for Scoping and
Merging Data Dialog Box) 353
merging 167
Merging Project and As-Built Data 164
Merging Project and As-Built Data Common
Tasks 174
merging with As-Built 83, 164, 168, 169,
170, 171, 174, 176, 178, 179, 180, 181
comparing project data with As-Built
176
comparison list report generation 169
data copying common tasks 171
Index
fieldbus tags 164
from command line 181
from Merge Buffer 180
from Project Explorer 180
item and sub-item selection 167
items in Merge Buffer 171
merge action descriptions 178
merge modes 164
merging data common tasks 174
overview 164
preferences 176
reports common tasks 168
reports of changed documents 170
reports of changed items 170
setting merge actions 179
without deleting from project 83
Microsoft SQL Server Connection Dialog
Box 338
Miscellaneous Domain Administration Tasks
223
Modify Domain Notes 233
Modify Printer Settings 233
Modify the Display Format for an Item
Category 133
Modify the Profile of a Group 76
Modify Wire End Naming Conventions
192
Module Icons (Preferences) 397
My List 147
N
N 339
Naming Convention Mapping 266
naming conventions 113, 133, 182, 183,
184, 187, 188, 190, 191, 192, 193
common tasks 183
copying from another unit 187
copying to existing units 187
copying to new units 187
defining 113, 184
defining wire end naming conventions
191
deleting wire end naming conventions
193
document numbers 188
duplicating wire end naming conventions
192
enabling wire end conventions 191
examples 113
generating reports 190
maximum length 182
modifying wire end naming conventions
192
overview 182
separators 113
spaces in file names 184
tag and loop reservation 133
trailing spaces 184
wire end common tasks 190
wire end naming conventions overview
190
wiring items 184
Naming Conventions 182
Naming Conventions Common Tasks 183
Naming Conventions Dialog Box 339
Network Class > View (Preferences) 398
notes 233
modifying 233
Notes for Creating Naming Conventions for
Wiring Items 184
Numeric Character Settings for Oracle 63
O
O 342
Open Administration Module Dialog Box
342
Open the Project Explorer and Merge Buffer
166
Optimize Indexes 107, 109
Optimize Indexes (Oracle) Dialog Box 342
Optimize Indexes (SQL Server) Dialog Box
342
ORA-01722 error 63
Oracle 48, 50, 60, 107, 108, 109, 118, 240
Oracle Database Server Tablespaces for
SmartPlant Instrumentation 16
Oracle Instance Configuration File 237
clearing blocked sessions 240
database character set 50
database connections 118
database maintenance 107
datafiles 108
deleting an invalid domain 60
domain initialization from a source 50
empty domain initialization 48
modifying on Oracle 9.2 237
483
Index
national character set 50
optimizing indexes 109
paths for trimming audit trail data 237
tablespaces 108
updating Oracle statistics 109
viewing tablespaces 108
Oracle Server Connection Dialog Box 343
Owner 122
Owner Dialog Box 344
owner operator domain 83, 125, 128, 130,
131, 132, 137, 138, 139, 153, 155, 166,
174, 178
actions for merging items 178
As-Built 125
claiming common tasks 153
common tasks 128
creating 83
creating a project 130
deleting project data 139
deleting projects 138
displaying As-Built items 155
displaying project items 166
making As-Built definitions 132
merging data common tasks 174
overview 125
project deletion common tasks 138
projects 125
rebuilding projects 137
selecting a project logo 131
Owner Operator Domain (As-Built and
Projects) 125
Owner Operator Domain (As-Built and
Projects) Common Tasks 128
Owner Operator Domain Explorer Windows
453
owners 122
defining a plant owner 122
deleting 122
editing 122
P
P 344
PA Amplifier > View (Preferences) 399
Page Setup Dialog Box 345
Panel by Category Hierarchy Example 463
Panel by Location Hierarchy Example 464
Panel Location Levels Dialog Box 345
panel locations 184, 224
484
Index
for merging items with As-Built 176
for project scope 157
importing preferences 211
overview 207
setting domain preferences 209
setting project preferences 209
Preferences Management 207
Preferences Management Dialog Box 354
Prefixes and Suffixes in the Interface Text
273
Prerequisites for Claiming Documents 162
Prerequisites for Domain Initialization 42
Print Database Connection Information 118
Print Filegroup Information 106
Print Options 358
Print Preview Dialog Box 358
printer settings 233
Process Data > Custom (Preferences) 402
Process Data > General (Preferences) 403
Project Activities Dialog Box 359
project administrator 126
access rights 126
assigning to project 126
defining 126
project deletion 138, 139
common tasks 138
deleting empty project 138
deleting project data 139
deleting project data and schema 139
prerequisites 138
Project Deletion Common Tasks 138
Project Explorer 458
project statuses 138, 359
for project deletion 138
status descriptions 359
projects 83, 128, 130, 131, 132, 133, 134,
137, 139, 147, 149, 155, 156, 157, 160,
161, 162, 163, 164, 166, 170, 171, 176,
177, 178, 179, 180, 181, 209, 210
actions for merging items 178
assigning user groups 131
claim modes 147
claiming documents 163
claiming from buffer 160
claiming from command line 161
claiming items from another project 161
claiming items from As-Built 161
comparing data for merging 176
R
R 420
Rebuild a Project 137
Rebuild Catalog Tables 105
Rebuild Catalog Tables Dialog Box 420
Rebuild Default Views in Domains 104
Rebuild Default Views in Domains Dialog
Box 420
Rebuild Projects in Domain Dialog Box
421
Rebuild Stored Procedures and Triggers
104
Rebuild Stored Procedures and Triggers
Dialog Box 421
485
Index
Register a Plant 256
Register Items 258
registering 256
plant 256
Remove Deleted Windows Users Dialog Box
422
Remove Deleted Windows Users from
SmartPlant Instrumentation User Groups
78
Remove Items from the Buffer 159
Remove Items from the Merge Buffer 173
Remove Users from Groups 77
Replace the Interface Language with a
Language from an External File 271
Replace the Interface Language with a
Language from the Database 271
Report Generation (System Administration)
118
Report Generator (Preferences) 404
Report Management 211
Report Management Common Tasks 212
Report Management Dialog Box 422
reports 90, 91, 118, 134, 159, 168, 169,
170, 171, 190, 207, 211, 212, 214, 215,
231
access rights 207, 231
archiving options 214
associating a new title block 212
changed documents 170
changed items 170
common tasks 212
comparison list for merging 169
domain statistics 231
generating system admin reports 118
graph-style activity report 91
grid-style activity report 90
items copied to Claim Buffer 159
items copied to Merge Buffer 171
items copied to Target Project Buffer
159
list-type reports 215
naming conventions 190
non-list-type reports 215
report management overview 211
reports for merging data common tasks
168
reserved items 134
revision management overview 211
486
S
S 428
Schema Component 253
schema mapping 266
naming conventions 266
Scope Definition Dialog Box 428
scope of a project 83, 147, 153, 157, 158,
159
claim modes 147
copying items to Claim Buffer 158
copying items to Target Project Buffer
158
Index
exclusive claim mode 83
preferences for claiming 157
removing items from buffer 159
scoping data common tasks 153
scoping data overview 147
Scoping Data for Projects 147
Scoping Data for Projects Common Tasks
153
Search Dialog Box 429
Search for Items 142
searching for items 142, 143
multiple items for claiming 142
multiple items for merging 142
specific item for claiming 143
specific item for merging 143
security 92, 96, 98, 99, 100, 183, 190
changing System Administrator password
96
database locking mode 99
database security 92
encrypting all user passwords 98
setting database locking mode 100
setting security options 99
Security Options Dialog Box 430
Security Schema Password Encryption
Dialog Box 430
Segment Wiring > View (Preferences) 404
Select (Copy Unit Data) Dialog Box 432
Select (Naming Conventions) Dialog Box
433
Select a Logo 232
Select a Project Logo When the Domain
Type is Owner Operator 131
Select Columns for Sorting Dialog Box 431
Select Columns for Viewing Dialog Box
431
Select Item Types for Comparison Dialog
Box 431
Select Item Types for Reports Dialog Box
431
Select Logo Dialog Box 432
Select Plant (for Registering) Dialog Box
433
Select Plant (for Retrieving Documents)
Dialog Box 433
Select Source Database Dialog Box 433
Select Source for Claiming Dialog Box 434
487
Index
Single Speaker > View (Preferences) 405
SmartPlant Foundation 255
SmartPlant Foundation Web Client 256
retrieving plant hierarchy 255
SmartPlant Instrumentation Database Setup
for Oracle 15
SmartPlant Instrumentation Database Setup
for SQL Server 23
SmartPlant Instrumentation Encryption
Mechanism 92
SmartPlant Instrumentation Interface
Languages 269
SmartPlant Instrumentation Server 255
define IDEAL user 255
SmartPlant Instrumentation Server
(Preferences) 407
SmartPlant integration 137, 252
configuring for 252
setting project status 137
SmartPlant Integration > General
(Preferences) 406
SmartPlant Integration > To Do List
(Preferences) 407
Source Data Connection Dialog Box 435
Source Project Explorer 459
special characters in custom fields 228
specification title blocks 84
Specifications > Custom (Preferences) 408
Specifications > Export/Import (Preferences)
408
Specifications > General (Preferences) 409
Specifications > Multi-Tag Specifications
(Preferences) 411
Specifications > Save as Excel (Preferences)
412
Specify a Global Path 88
Specify an Action for Merging a Group of
Items 179
SQL script file for database setup 21
SQL Server 39, 53, 55, 61, 64, 101, 105,
106, 107, 118
adding datafiles to filegroups 106
adding datafiles to TEMPDB 107
audit trail data backup 39
database connections 118
database maintenance 105
deleting an invalid domain 61
domain initialization from a source 55
488
Index
System Administration Common Tasks 81
System Administration Window 437
system interfaces 218
importing 218
T
T 437
Tablespace List Dialog Box 437
tablespaces 16, 108
adding datafiles 108
tablespace descriptions 16
viewing 108
tag numbers 133, 134
reserved tags report 134
reserving for As-Built 133
reserving for projects 133
Tag Numbers Tab (Reserve Tags and Loops
Dialog Box) 427
Target Database Parameters (Oracle) Dialog
Box 438
Target Database Parameters (SQL Server)
Dialog Box 439
Target Project Buffer 460
Target Revisions Dialog Box 440
Telecom Device Panel Icons Dialog Box
441
telecom device types 225
assigning icons 225
TEMPDB 107
thin client 35
domain backup 35
Title Block Descriptions 213
title blocks 84, 212, 213
associating a new title block 212
default 213
defining for specs 84
descriptions 213
plant hierarchy name truncation 213
suitable for specs 213
To Do List Dialog Box 441
Tool Requirements for Integrating
SmartPlant Instrumentation 259
toolbars 276, 314, 319
Access Rights 276
Domain Definition (System
Administration) 319
Domain Definition Window (Domain
Administration) 314
U
U - V 443
Unit Properties Dialog Box 443
Update Statistics 109
Update Statistics Dialog Box 445
Upper-Right Section (Copy Data from
Source Dialog Box) 298
User (Domain Administration) Dialog Box
445
User (System Administration) Dialog Box
446
user groups 74, 126, 130, 131, 207
access rights report 207
assigning to project 131
copying from As-Built 130
overview 74
project administrators 126
User Groups 74
user-defined database views 44
adding for initialization 44
User-Defined Database Views Dialog Box
445
users 71, 72, 75, 76, 77, 78, 79, 118
assigning to departments 72
assigning to groups 76
creating 72
creating a group 75
database connections 118
489
Index
deleting 72
editing 72
IDEAL user 72
logon options 77
removing deleted Windows users 78
removing from groups 77
switching to dirrerent logon method 79
users and departments common tasks 71
Windows authentication 77
Windows groups 78
Users and Groups Common Tasks 74
Users, Departments, and Groups 71
V
View Tablespace Data 108
View the Items in the Current Domain 207
views 44, 104
adding for initialization 44
rebuilding default views 104
W
W 447
windows 276, 282, 310, 314, 347, 437
Windows and Dialog Boxes 275
Windows authentication logon method 77,
78
Access Rights 276
Administration 282
creating groups 78
Domain Administration 310
Domain Definition (Domain
Administration) 310
Domain Definition (System
Administration) 314
overview 77
Plant Hierarchy Explorer 347
removing deleted Windows users 78
System Administration 437
Windows Authentication Logon Method 77
Wire End Naming Convention Properties
Dialog Box 448
wire end naming conventions 190, 191,
192, 193
common tasks 190
defining 191
deleting 193
duplicating 192
enabling 191
490
modifying 192
overview 190
trailing spaces 191
Wire End Naming Conventions 190
Wire End Naming Conventions Common
Tasks 190
Wire End Naming Conventions Dialog Box
447
Wiring > Copy Items (Preferences) 413
Wiring > Cross Wiring (Preferences) 414
Wiring > CS Tags (Preferences) 415
Wiring > Custom (Preferences) 416
Wiring > General (Preferences) 417
Wiring > I/O Assignment (Preferences) 418
Wiring > I/O Cards (Preferences) 418
Wiring > Jumpers (Preferences) 418
Wiring > Reports (Preferences) 419
Wiring Equipment Connections > View
(Preferences) 416
Wiring Item Naming Options Dialog Box
449
wiring items 184, 224
naming convention examples 184
panel location levels 224
Workaround for an Initialization Problem in
Windows Vista 63
Workaround for the Grant to View Creation
Error 64
Workaround for the INtools_Backup.db
Connection Problem in Windows Vista
36
workflow 86, 206
access rights 206
Workflow Access Rights 206
Working in KKS Mode in SmartPlant
Instrumentation 110
Working with Explorer Windows Common
Tasks 141
Working with SmartPlant Integration 251
Working with the Administration Module
13
X
X-Y 450
Z
Zoom 450
Index
491