Users Guide
September 2007
DINS-08.00.0001D
Copyright
Copyright 1995-2007 Intergraph Corporation. All Rights Reserved.
Including software, file formats, and audiovisual displays; may be used pursuant to applicable software license
agreement; contains confidential and proprietary information of Intergraph and/or third parties which is protected by
copyright law, trade secret law, and international treaty, and may not be provided or otherwise made available
without proper authorization.
Trademarks
Intergraph, the Intergraph logo, PDS, SmartPlant, SmartSketch, FrameWorks, INtools, MARIAN, and IntelliShip
are registered trademarks and SupportModeler and SupportManager are trademarks of Intergraph Corporation.
Microsoft and Windows are registered trademarks of Microsoft Corporation. MicroStation is a registered trademark
of Bentley Systems, Inc. ISOGEN and SPOOLGEN are registered trademarks of Alias Limited. Other brands and
product names are trademarks of their respective owners.
Table of Contents
Table of Contents
Preface...............................................................................................................................14
Working with Administration Module: An Overview .................................................15
SmartPlant Instrumentation Database Setup for Oracle: An Overview....................16
SmartPlant Instrumentation Database Setup for SQL Server: An Overview...........17
Setting Up a SmartPlant Instrumentation Database Common Tasks ........................18
SQL Server Database Server Filegroups for SmartPlant Instrumentation........................ 19
Set Up a SmartPlant Instrumentation Database for SQL Server....................................... 21
Oracle Database Server Tablespaces for SmartPlant Instrumentation.............................. 23
Set Up a SmartPlant Instrumentation Database for Oracle............................................... 26
Create a SmartPlant Instrumentation Database by Running the DB Setup SQL
Script File.......................................................................................................................... 29
Table of Contents
Initialize a Domain from the Command Line ................................................................... 66
Initialization Log Files...................................................................................................... 68
Table of Contents
Activity Tracking Management Common Tasks......................................................115
Set the Activity Tracking Mode...................................................................................... 116
Clear Activity Tracking Data.......................................................................................... 116
Generate a Grid-Style Activity Tracking Report ............................................................ 117
Generate a Graph-Style Activity Tracking Report ......................................................... 118
Table of Contents
Operating Owner Domain (As-Built and Projects): An Overview ...........................158
Flow of Activities for Defining a Project Administrator..........................................159
Operating Owner Domain (As-Built and Projects) Common Tasks ........................160
Create a Project ............................................................................................................... 162
Assign User Groups to a Project ..................................................................................... 164
Select a Project Logo When the Domain Type is Operating Owner .............................. 165
Make As-Built Definitions.............................................................................................. 166
Display Formats of Item Categories ............................................................................... 166
Modify the Display Format for an Item Category .......................................................... 167
Copy the Display Format from Another Project............................................................. 168
Reserve Tags and Loops for a Project or As-Built ......................................................... 168
Generate Reserved Items Report .................................................................................... 170
Set the Project Status for an Integrated Environment ..................................................... 170
Rebuild a Project............................................................................................................. 171
Table of Contents
Prerequisites for Claiming Documents ........................................................................... 215
Claim Documents ........................................................................................................... 216
Show Projects Containing Claimed Items ...................................................................... 217
Table of Contents
Table of Contents
Managing Audit Trail Data: An Overview..................................................................314
Managing Audit Trail Data Common Tasks ............................................................315
Load Audit Trail Data..................................................................................................... 316
Trim Audit Trail Data ..................................................................................................... 317
External Files with Trimmed Audit Trail Data ............................................................... 318
Define Paths When Using Oracle ................................................................................... 318
Define Paths When Using SQL Server ........................................................................... 319
Define Paths When Using Sybase Adaptive Server Anywhere ...................................... 320
Table of Contents
General Integration Requirements .................................................................................. 354
Naming Convention Integration Requirements .............................................................. 355
Working with SmartPlant P&ID ..................................................................................... 359
Working with SmartPlant Electrical ............................................................................... 361
Using Projects in an Integrated Environment ................................................................. 363
Naming Convention Mapping......................................................................................... 364
Table of Contents
Copy From Dialog Box................................................................................................... 409
Copy from Project Dialog Box ....................................................................................... 409
Copy from Project Dialog Box ....................................................................................... 409
Copy Naming Conventions From Dialog Box................................................................ 409
Copy Naming Conventions Dialog Box ......................................................................... 410
Copy to Projects Dialog Box .......................................................................................... 410
Custom Fields Dialog Box.............................................................................................. 411
Custom Tables Dialog Box............................................................................................. 413
Database Upgrade Dialog Box........................................................................................ 413
Data Files to Delete Manually Dialog Box..................................................................... 414
Delete Invalid Domain Dialog Box ................................................................................ 415
Delete Projects Dialog Box............................................................................................. 416
Department Dialog Box .................................................................................................. 417
Domain Data and Indexes Dialog Box ........................................................................... 417
Dimensional Data Settings Dialog Box .......................................................................... 419
Domain Administration Window.................................................................................... 420
Domain Definition Window (Domain Administration).................................................. 420
Domain Definition Window Toolbar (Domain Administration) .................................... 424
Domain Definition Window (System Administration) ................................................... 425
Domain Definition Window Toolbar (System Administration) ..................................... 430
Domain Tablespace Definition Dialog Box.................................................................... 431
List of Duplicate Items Dialog Box ................................................................................ 432
Edit Translation Text Dialog Box................................................................................... 433
Items and Activities for Access Rights Dialog Box ....................................................... 434
Export Macros Dialog Box ............................................................................................. 434
Field Personnel Profile Dialog Box ................................................................................ 435
Filegroup List Dialog Box .............................................................................................. 435
Filter Definition Dialog Box........................................................................................... 436
Find Item Dialog Box ..................................................................................................... 438
Generate Access Rights Report Dialog Box ................................................................... 438
Global Access Rights Dialog Box .................................................................................. 440
Group Dialog Box........................................................................................................... 441
Import Browser Views Dialog Box ................................................................................ 443
Import DCS Hardware I/O Library Dialog Box ............................................................. 444
Import DDP Library Data for PDS Dialog Box.............................................................. 444
Import Hook-Up Library Dialog Box ............................................................................. 445
Import Interface Language Dialog Box .......................................................................... 445
Import Macros Dialog Box ............................................................................................. 446
Import System Interfaces Dialog Box............................................................................. 446
Initialize (Oracle) Dialog Box ........................................................................................ 447
Initialize (SQL Server) Dialog Box ................................................................................ 449
Load Audit Trail Data Dialog Box ................................................................................. 451
Log File Dialog Box ....................................................................................................... 452
Naming Conventions Dialog Box................................................................................... 453
Microsoft SQL Server Connection Dialog Box.............................................................. 456
Open Administration Module Dialog Box...................................................................... 457
Optimize Indexes (Oracle) Dialog Box .......................................................................... 457
Optimize Indexes (SQL Server) Dialog Box .................................................................. 458
Oracle Server Connection Dialog Box............................................................................ 459
Owner Dialog Box .......................................................................................................... 460
Page Setup Dialog Box ................................................................................................... 460
Table of Contents
Panel Location Levels Dialog Box ................................................................................. 461
Plant Hierarchy Dialog Box............................................................................................ 462
Plant Hierarchy Explorer ................................................................................................ 464
<Plant> Properties Dialog Box ....................................................................................... 466
Preferences for Scoping and Merging Data Dialog Box................................................. 468
Preferences Management Dialog Box............................................................................. 475
Preferences Management (General) Dialog Box ............................................................ 477
Print Options ................................................................................................................... 480
Print Preview Dialog Box ............................................................................................... 481
Project Activities Dialog Box ......................................................................................... 482
Rebuild Catalog Tables Dialog Box ............................................................................... 486
Rebuild Default Views in Domains Dialog Box............................................................. 487
Rebuild Projects in Domain Dialog Box......................................................................... 488
Rebuild Stored Procedures and Triggers Dialog Box ..................................................... 489
Remove Deleted Windows Users Dialog Box................................................................ 489
Report Management Dialog Box .................................................................................... 490
Required Wiring Equipment Report Dialog Box............................................................ 494
Reserve Tags and Loops Dialog Box.............................................................................. 494
Scope Definition Dialog Box.......................................................................................... 496
Search Dialog Box .......................................................................................................... 497
Security Options Dialog Box .......................................................................................... 498
Select Columns for Sorting Dialog Box ......................................................................... 499
Select Columns for Viewing Dialog Box ....................................................................... 499
Select Item Types for Comparison Dialog Box .............................................................. 500
Select Item Types for Reports Dialog Box ..................................................................... 500
Select Language Dialog Box .......................................................................................... 501
Select Logo Dialog Box.................................................................................................. 501
Select Dialog Box ........................................................................................................... 502
Select Dialog Box ........................................................................................................... 503
Select Plant ..................................................................................................................... 503
Select Plant ..................................................................................................................... 503
Select Source Database Dialog Box ............................................................................... 504
Select Source for Claiming Dialog Box.......................................................................... 505
Select Target Database Dialog Box ................................................................................ 506
Set Color Dialog Box...................................................................................................... 507
Source Data Connection Dialog Box .............................................................................. 507
System Administration Window..................................................................................... 510
Tablespace List Dialog Box............................................................................................ 510
Target Database Parameters (Oracle) Dialog Box .......................................................... 511
Target Database Parameters (SQL Server) Dialog Box.................................................. 512
Target Revisions Dialog Box.......................................................................................... 515
Telecom Device Panel Icons Dialog Box ....................................................................... 516
To Do List Dialog Box ................................................................................................... 516
Trim Audit Trail Data Dialog Box.................................................................................. 517
<Unit> Properties Dialog Box ........................................................................................ 518
Update Statistics Dialog Box .......................................................................................... 521
User-Defined Database Views Dialog Box .................................................................... 521
User (Domain Administration) Dialog Box.................................................................... 522
User (System Administration) Dialog Box..................................................................... 523
Initialize (Sybase Adaptive Server Anywhere) Dialog Box ........................................... 524
Wire End Naming Conventions Dialog Box................................................................... 526
Table of Contents
Wire End Naming Convention Properties Dialog Box ................................................... 527
Wiring Item Naming Options Dialog Box...................................................................... 529
Zoom............................................................................................................................... 530
As-Built Explorer............................................................................................................ 531
Claim Buffer ................................................................................................................... 533
Claimed Items ................................................................................................................. 535
Merge Buffer................................................................................................................... 535
Project Explorer .............................................................................................................. 538
Source Project Explorer .................................................................................................. 540
Target Project Buffer ...................................................................................................... 542
Item Indicators ................................................................................................................ 544
Cable Hierarchy Example ............................................................................................... 544
Panel by Category Hierarchy Example........................................................................... 545
Panel by Location Hierarchy Example ........................................................................... 546
Index................................................................................................................................547
Preface
Preface
This user's guide describes concepts, procedures, and interface features of the
SmartPlant Instrumentation Administration module.
Send documentation comments or suggestions to PPMdoc@intergraph.com.
4
If you use an existing Oracle server (where you intend to keep your
database) which was not installed according to the instructions in the
SmartPlant Instrumentation Installation and Upgrade Guide, make sure
the Oracle database parameters comply with the parameters required to
use SmartPlant Instrumentation. See Oracle Database Server Installation
in the SmartPlant Instrumentation Installation and Upgrade Guide for
additional information about the required Oracle server parameters.
Related Topics
Admin data used for the Administration schema logon settings (see
the following paragraph). The database contains the Admin schema logon
data.
Index data used for the Administration schema logon settings. The
database contains the SmartPlant Instrumentation domain index of a single
domain.
The DB Setup Utility creates SmartPlant Instrumentation domain files using the
following default file values:
Parameter
Admin Datafile
Index Datafile
Log Datafile
Filegroup name:
primary
intools_dba_index
log
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.
Quantity (Average)
Instrument tags
45058
Loops
16616
1381
Device panels
11384
Junction boxes
504
Marshaling racks
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, page 133.
Notes
Make sure the total file size that you specify does not exceed the available
empty space on your selected disks. The default is 70 MB, which includes
the size of the file for the recommended initial size of the Admin data and
indexes, and SmartPlant Instrumentation database Log file
Each of the file names must be a legal name. Each file name must be
unique within your database. Special characters are not supported.
Related Topics
Caution
When starting the DB Setup Utility, the Sybase Adaptive Server
Anywhere database engine starts as well (in minimized mode). Do not
close the database engine, as this causes the database setup process to
stop.
2. On the Microsoft SQL Server Connection dialog box, under Server name, do
one of the following:
Accept the server name (or the instance name if the instance is not the
default instance) that the software retrieves from the Intools.ini file,
created during SmartPlant Instrumentation installation.
4. Click Connect to connect to the SQL Server database on your server machine and
open the Target Database Parameters dialog box, where you can set parameters
for the target SmartPlant Instrumentation database and start the database setup
process.
Note
If you changed the Server name setting, when you click Connect, in
the [DATABASE] section of the Intools.ini file, the software changes
the ServerName parameter, and also updates the Server parameter in
the current SQL Server ODBC profile.
5. Under Target database name, type the name of the SmartPlant Instrumentation
database for which you want to run the setup process.
Tip
The 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 not the first database setup session, you can use an existing
Admin schema logon name but in this case, you must also use the
existing Admin schema logon password. You can only use an existing
Admin schema logon name if the password in that Admin schema is
different. For example, if in another SmartPlant Instrumentation
database, the Admin schema logon name is IN_DBAMN, and the
password is also IN_DBAMN, you cannot use IN_DBAMN for the
Admin schema in the new SmartPlant Instrumentation database.
If you want to define a new logon name, you must also define a new
logon password, different from the logon name.
7. Accept the default Admin schema logon password SPI_DBA or modify the
password as you require, provided that you type a setting that is different from the
Admin schema logon name.
Tips
The logon password can only start with a letter and may not contain
spaces. You can use an underscore ( _ ) to indicate a space. If you
want to encrypt the password, See Encrypt the Admin Schema Logon
Password, page 121.
If this is 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.
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.
Related Topics
The DB Setup Utility creates tablespaces for the Admin schema using the following
tablespace default values:
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:
Item Types
Quantity (Average)
Instruments
45058
Loops
16616
1381
Device panels
11384
Junction boxes
504
Marshaling racks
45
Cabinets
36
108
Channels
16880
Specifications
111
P&ID drawings
855
Lines
3132
Domain Data
Tablespace
Domain Index
Data
Tablespace
Domain
Temporary Data
Tablespace
30 MB
350 MB
180 MB
100 MB
(autoextended)
10 MB
Later on, you may receive an indication that the available free space in the tablespace
is low, or you may encounter a message that there is insufficient space while working
in SmartPlant Instrumentation. If this happens, SmartPlant Instrumentation System
Administrator can increase the size of the tablespace for the specific domain. For
details, see Add Datafiles to Oracle Tablespaces, page 137.
Notes
For better performance, it is highly recommended that you locate the data
tablespaces and index tablespaces on different physical disks. You can
also locate the system file, database tables and the index data on different
physical drives to speed up your work in the Oracle Database. See your
Oracle User Guide for more information.
Each of the file names must be a legal name. Each tablespace name must
be unique within your database.
Related Topics
Paths you specify in this procedure refer to the database server local
folders (non-network folders). Do not use network drives or network
server names in the paths.
Make sure you have an available Oracle instance. It is not possible to set
up more than one SmartPlant Instrumentation database in a given Oracle
instance.
1. On your Windows Start menu, navigate to the Intergraph SmartPlant
Instrumentation program icons and click DB Setup Utility.
Caution
When starting the DB Setup Utility, the Sybase Adaptive Server
Anywhere database engine starts as well (in minimized mode). Do not
close the database engine, as this causes the database setup process to
stop.
2. On the Oracle Server Connection dialog box, from the Oracle version list,
select the version of your Oracle server.
3. Under DBMS identifier in the INtools.ini file, accept or change the displayed
compatible DBMS parameter for the Oracle server version that you selected from
the Oracle version list.
Tip
If you want to change the DBMS parameter, make sure it is
compatible with SmartPlant Instrumentation. For more details about
all compatible combinations of Oracle and SmartPlant Instrumentation
versions, see SmartPlant Configuration and Maintenance Guide,
Compatibility of Oracle and SmartPlant Instrumentation Versions.
4. In the Oracle database name box, do one of the following:
Change the displayed value if it does not match the value you defined
for the DB_NAME parameter in the Oracle Instance Configuration
file.
5. In the Server name box, accept or modify the displayed Oracle server connection
string.
6. In the System Administrator logon password box, accept the given default
value manager (the password is masked), or type the appropriate password.
8. Under Admin schema, accept the default Admin schema logon name and
password IN_DBAMN or modify the name or password as needed.
Tip
The logon name must be unique in the Oracle database server. The
logon name and password can only start with a letter and contain no
spaces. You can use an underscore to replace a space. If you want to
encrypt the password, See Encrypt the Admin Schema Logon
Password, page 121.
9. In the Admin data and Admin index sections, accept the default settings or
modify them as needed.
Tips
Tip
Important
After completing the database setup, contact your Oracle Database Administrator,
who must specify the super user logon password. To specify this password, from
the SQL Plus utility, in the Oracle server database, connect to the sys super user
as sysdba and then run the following command:
grant execute on DBMS_PIPE to public;
We recommend that you specify the super user logon password before initializing
a SmartPlant Instrumentation domain. If you initialize a domain in Oracle 9i
without specifying the super user logon password, the SmartPlant Instrumentation
System Administrator must rebuild stored procedures and triggers before using
the domain. For details, see Rebuild Stored Procedures and Triggers, page 130.
Related Topics
Oracle Database Server Tablespaces for SmartPlant Instrumentation,
page 23
4. After the script file is created, make sure that the orasetup.sql file is located in the
SmartPlant Instrumentation home folder.
5. Run the SQL*Plus utility.
6. Connect as the System Manager.
7. In the SQL*Plus utility, run the following set of commands:
SET ECHO OFF
SET SCAN OFF
SPOOL C:\TEMP\ORASETUP.TXT
@<SmartPlant Instrumentation home folder>ORASETUP.SQL
COMMIT;
SPOOL OFF
Related Topics
When backing up a domain, the software does not back up the audit trail
data. Therefore, before performing the domain backup, you must make
sure that you trimmed all the audit trail data. Then, you can back up the
trimmed audit trail data manually. For details, see SmartPlant
Instrumentation Installation and Upgrade Guide, Backup and Restore,
Backing up Files Containing Audit Trail Data.
Related Topics
Back Up a Domain
Important
If you work in thin client environment, for example, Citrix, you must copy
the INtools.ini file to the SmartPlant Instrumentation home folder on the
server machine to be able to perform a backup procedure. On backup
completion, remove the INtools.ini file from the server machine.
1. With the System Administration window open, click File > Backup.
In the target database, the domain type is the same as in the source
database.
9. Click Close after the backup is completed.
Note
Related Topics
Description
Possible Settings
Init.exe
INIT.EXE
BKC
BKC
<Copy
users flag>
Y or N
<Copy
The Yes/No parameter for
departments copying the department
definitions from the source
flag>
domain to the target Sybase
Adaptive Server Anywhere
database file.
Y or N
<Save last
created ID
flag>
<Source
Domain
schema
name>
d:\Program Files\SmartPlant\
Instrumentation\INtools_Backup.db
After completing the backup process, you can check the InitLog.txt file for
errors that might have occurred during the domain backup. The
InitLog.txt file appears in the SmartPlant Instrumentation home folder. In
this log file, the software automatically records errors that do not cause the
backup process to fail.
Related Topics
When using Oracle, these files appear as .sql files on your Windows
server.
When using SQL Server, these files appear as .txt files on your Windows
server.
When using Sybase Adaptive Server Anywhere, these files appear as .txt
files on a client machine where you have installed SmartPlant
Instrumentation.
You need to back up these files to enable loading of the trimmed audit trail data to the
CHANGES_LOG table of a particular domain. The software records the audit trail
data in the CHANGES_LOG table that exists in each domain. To learn more about
trimming and loading audit trail data, see For more information, see Audit Trail: An
Overview in the Administration User's Guide, under Domain Administration.
The external file containing audit trail data has a filename made up of the date range
within which the data was trimmed, the domain schema name, the CHANGES_LOG
table name, and the filename which the System Administrator has defined in the
Administration module before trimming. The following is an example of an external
file with audit trail data:
20010614_20011015_<domain schema>#CHANGES_LOG#<user-defined
filename>.
The audit trail period segment displays the date range in the following order: year,
month, and day.
Related Topics
Backing up Audit Trail Data on Oracle: An Overview, page 37
To enable loading of the audit trail data saved to the SQL files in the
<drive>:\INTOOLSTORAGE\ORC1 folder, you must create a backup of these files
on your Windows server in the following cases:
Related Topics
3. In the Oracle Instance Configuration file, add the following parameter line:
utl_file_dir=<drive>:\INtoolStorage\orc2
4. Copy the content of the folder orc1 in the path <drive>:\INtoolStorage\ to the
folder orc2.
5. Restart your computer.
5. In the Oracle Instance Configuration file, add the following parameter line:
utl_file_dir=<drive>:\INtoolStorage \orc2.
6. Copy the content of the folder orc1 in the source path <drive>:\INtoolStorage to
the folder orc2 in the target path <drive>:\INtoolStorage.
7. Restart your computer.
To enable loading of the audit trail data after moving a SmartPlant Instrumentation
database from one SQL Server server database to another, you must make a backup
of the .txt files with the trimmed audit trail data on your Windows server.
Related Topics
Related Topics
Copy the content of the default folder in the source client machine, for
example, c:\Program Files\SmartPlant\Instrumentation\INtoolStorage
to the default folder in the new client machine. For example: Program
Files\SmartPlant\Instrumentation\INtoolStorage
If you do not have enough disk space for copying audit trail data to the
target drive where you have installed SmartPlant Instrumentation, do
the following:
3. In the required drive on the target client machine, create a folder INtoolStorage.
4. Open the Intools.ini file, and then, in the [database] section, set the file path value
of the parameter WatINstorageDir so that it matches the path you have created.
For example: WatINstorageDir="d:\SmartPlant\Instrumentation\
INtoolStorage"
5. Copy the content of the default folder in the source client machine. For example:
c:\Program Files\SmartPlant\Instrumentation\ INtoolStorage to the
default folder in the new client machine, for example,
d:\SmartPlant\Instrumentation\INtoolStorage.
Related Topics
Make sure the database version of the source domain is the same as the
database version where you want to initialize a new domain, that is
Version 2007. If not, you must upgrade the source domain to Version
2007, or the target Admin schema to Version 2007.
If the source domain resides in Oracle 8i, and the target database platform
is Oracle 9i or 10g, initialize the domain in Sybase Adaptive Server
Anywhere first, then, upgrade the domain to Version 2007 before
initializing this domain in Oracle 9i or 10g.
If the source domain resides in SQL Server 2000, upgrade the SmartPlant
Instrumentation database to Version 2007, and then, use this domain as a
source for initializing a new domain in SQL Server 2000 or 2005.
If the source domain resides in SQL Server 2000 and the target database is
in SQL Server 2005, the current client machine mast have two SQL Server
client installations: SQL Server 2000 client and SQL Server 2005 client.
If the source domain resides in SQL Server 2005 and the target database is
in SQL Server 2000, the current client machine mast have two SQL Server
client installations: SQL Server 2000 client and SQL Server 2005 client.
Related Topics
Note
After you click Apply in the Add Database Views dialog box, the
software allocates the database views that you selected to the data window
of the User-Defined Database Views. These database views become
available in a target domain after initializing that domain using the current
domain as a source.
2. In the Password box, type DBA, which is the default password you use to log on
to the Admin schema.
3. Click OK to open the System Administration window.
4. Click File > Initialize.
5. On the Initialize dialog box, in the Domain box, type the domain name, which
must be unique in the current database, start with a letter, and contain only
alphanumeric characters without spaces. You can use an underscore ( _ ) to
indicate a space.
Tips
You can modify the domain name after completing the initialization.
For details, see Make Domain Definitions, page 109.
6. In the Domain schema name box, type the logon name of the Domain schema,
which must be unique in the current database, start with a letter, and contain only
alphanumeric characters without spaces. You can use an underscore ( _ ) to
indicate a space. The software needs to use this name internally to connect to this
domain.
7. In the Domain schema password box, type the logon password of the Domain
schema, which must be unique in the current database, start with a letter, and
contain only alphanumeric characters without spaces. You can use an underscore
( _ ) to indicate a space.
Tip
Related Topics
2. In the Password box, type DBA, which is the default password you use to log on
to the Admin schema.
3. Click OK to open the System Administration window.
4. Click File > Initialize.
5. On the Initialize dialog box, in the Domain box, type the domain name, which
must be unique in the current database, start with a letter, and contain only
alphanumeric characters without spaces. You can use an underscore ( _ ) to
indicate a space.
Tips
You can modify the domain name after completing the initialization.
For details, see Make Domain Definitions, page 109.
6. In the Domain schema name box, type the logon name of the Domain schema,
which must be unique in the current database, start with a letter, and contain only
alphanumeric characters without spaces. You can use an underscore ( _ ) to
indicate a space. The software needs to use this name internally to connect to this
domain.
7. In the Domain schema password box, type the logon password of the Domain
schema, which must be unique in the current database, start with a letter, and
contain only alphanumeric characters without spaces. You can use an underscore
( _ ) to indicate a space.
Tip
10. On the Source Data Connection dialog box, from the Database type list, select
one of the following options:
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.
Related Topics
2. In the Password box, type DBA, which is the default password you use to log on
to the Admin schema.
3. Click OK to open the System Administration window.
4. Click File > Initialize.
You can modify the domain name after completing the initialization.
For details, see Make Domain Definitions, page 109.
6. In the Domain schema name box, type the logon name of the Domain schema,
which must be unique in the current database, start with a letter, and contain only
alphanumeric characters without spaces. You can use an underscore ( _ ) to
indicate a space. The software needs to use this name internally to connect to this
domain.
7. In the Domain schema password box, type the logon password of the Domain
schema, which must be unique in the current database, start with a letter, and
contain only alphanumeric characters without spaces. You can use an underscore
( _ ) to indicate a space.
Tip
The schema password must be different from the domain name. We
recommend that you write down the schema password and keep it in a
safe place. When initializing a domain, the software changes all the
password characters to upper case. This means that if the Domain
schema name is MY_DOMAIN, you cannot use my_domain as the
password string.
8. In the View-Only Domain schema password box, accept the default password of
the View-Only Domain schema or change it as appropriate, provided that the
setting is unique in the current database, starts with a letter, and contains only
alphanumeric characters without spaces. You can use an underscore (_) to
indicate a space.
Tip
The default password and the characters that you type when changing
the password appear masked.
11. To define the domain tablespace data, under Domain data, accept all the given
default values or modify them as follows:
a. In the Tablespace name box, type the appropriate domain tablespace name.
b. In the Datafile name and path box, type the full path and filename of the
tablespace database file.
c. In the Tablespace size (MB) box, type the appropriate domain tablespace
size.
Important
Related Topics
2. In the Password box, type DBA, which is the default password you use to log on
to the Admin schema.
3. Click OK to open the System Administration window.
4. Click File > Initialize.
5. On the Initialize dialog box, in the Domain box, type the domain name, which
must be unique in the current database, start with a letter, and contain only
alphanumeric characters without spaces. You can use an underscore ( _ ) to
indicate a space.
Tips
You can modify the domain name after completing the initialization.
For details, see Make Domain Definitions, page 109.
6. In the Domain schema name box, type the logon name of the Domain schema,
which must be unique in the current database, start with a letter, and contain only
alphanumeric characters without spaces. You can use an underscore ( _ ) to
indicate a space. The software needs to use this name internally to connect to this
domain.
Tip
The default password and the characters that you type when changing
the password appear masked.
9. Click Source.
10. On the Source Data Connection dialog box, from the Database type list, select
one of the following options:
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.
18. To define the domain tablespace data, under Domain data, accept all the given
default values or modify them as follows:
a. In the Tablespace name box, type the appropriate domain tablespace name.
b. In the Datafile name and path box, type the full path and filename of the
tablespace database file.
c. In the Tablespace size (MB) box, type the appropriate domain tablespace
size.
Important
Related Topics
2. In the Password box, type DBA, which is the default password you use to log on
to the Admin schema.
3. Click OK to open the System Administration window.
4. Click File > Initialize.
You can modify the domain name after completing the initialization.
For details, see Make Domain Definitions, page 109.
6. In the Domain schema name box, type the logon name of the Domain schema,
which must be unique in the current database, start with a letter, and contain only
alphanumeric characters without spaces. You can use an underscore ( _ ) to
indicate a space. The software needs to use this name internally to connect to this
domain.
7. In the Domain schema password box, type the logon password of the Domain
schema, which must be unique in the current database, start with a letter, and
contain only alphanumeric characters without spaces. You can use an underscore
( _ ) to indicate a space.
Tip
The schema password must be different from the domain name. We
recommend that you write down the schema password and keep it in a
safe place. When initializing a domain, the software changes all the
password characters to upper case. This means that if the Domain
schema name is MY_DOMAIN, you cannot use my_domain as the
password string.
8. In the View-Only Domain schema password box, accept the default password of
the View-Only Domain schema or change it as appropriate, provided that the
setting is unique in the current database, starts with a letter, and contains only
alphanumeric characters without spaces. You can use an underscore (_) to
indicate a space.
Tip
The default password and the characters that you type when changing
the password appear masked.
11. On the Domain Data and Indexes dialog box, in the Datafile folder path box,
type the folder path or accept the displayed default.
Tip
If you change the folder path in this box, the software automatically
updates the datafile name and path settings specified for the domain
and index data.
12. Under Domain data, accept or type the required values.
Tip
The values in the Domain file name and Filegroup boxes must be
must be unique in the database.
Tip
If, during the process, you receive a Grant to view Creation Error
message, see Workaround for the Grant to View Creation Error, page
76.
Important
Related Topics
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.
You can modify the domain name after completing the initialization.
For details, see Make Domain Definitions, page 109.
7. In the Domain schema name box, type the logon name of the Domain schema,
which must be unique in the current database, start with a letter, and contain only
alphanumeric characters without spaces. You can use an underscore ( _ ) to
indicate a space. The software needs to use this name internally to connect to this
domain.
8. In the Domain schema password box, type the logon password of the Domain
schema, which must be unique in the current database, start with a letter, and
contain only alphanumeric characters without spaces. You can use an underscore
( _ ) to indicate a space.
Tip
The schema password must be different from the domain name. We
recommend that you write down the schema password and keep it in a
safe place. When initializing a domain, the software changes all the
password characters to upper case. This means that if the Domain
schema name is MY_DOMAIN, you cannot use my_domain as the
password string.
9. In the View-Only Domain schema password box, accept the default password of
the View-Only Domain schema or change it as appropriate, provided that the
setting is unique in the current database, starts with a letter, and contains only
alphanumeric characters without spaces. You can use an underscore (_) to
indicate a space.
Tip
The default password and the characters that you type when changing
the password appear masked.
10. Click Source.
13. In the Admin schema logon name and Admin schema logon password boxes, if
your source domain resides in a different database, type the Admin schema name
and password of the source database to which you want to connect.
14. Click Connect to connect to the selected source database.
15. From the Domain list, select a domain to be used as a source.
16. Select the Copy users to target domain if you want to copy all the existing
SmartPlant Instrumentation user definitions to the new domain.
17. Select the Copy departments to target domain if you want to copy all the
existing SmartPlant Instrumentation department definitions to the new domain.
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.
20. On the Domain Data and Indexes dialog box, in the Datafile folder path box,
type the folder path or accept the displayed default.
Tip
If you change the folder path in this box, the software automatically
updates the datafile name and path settings specified for the domain
and index data.
21. Under Domain data, accept or type the required values.
Tip
The values in the Domain file name and Filegroup boxes must be
must be unique in the database.
22. Under Index data, accept or type the required values.
Tip
The values in the Index file name and Filegroup boxes must be
unique in the database. For example, if you have six domains in one
database, you must have six different index file names.
If, during the process, you receive a Grant to view Creation Error
message, see Workaround for the Grant to View Creation Error,
page 76.
Important
Related Topics
Description
Possible
Settings
Init.exe
INIT.EXE
INT
INT
DEMO
DEMO
DEMO
Example
INIT.EXE INT,DEMO,DEMO,DEMO
Note
After completing the initialization process, you can check the InitLog.txt
file for errors that might have occurred during the domain initialization.
The InitLog.txt file appears in the SmartPlant Instrumentation home
folder. In this log file, the software automatically records errors that do
not cause the initialization process to fail.
Related Topics
The software also uses the InitLog.txt file when you back up a domain to
the INtools_Backup.db database, and adds information about errors that
can occur when backing up data into the Domain schema of the
INtools_Backup.db database.
Delete a Domain
Caution
Deletion is an operation you should consider very carefully before
attempting to perform it. If you delete a domain, the software deletes the
Domain schema with all the database objects associated with it. Since this
operation is irreversible, you should consider backing up your domain first
(or even the entire database, if required). See Installation Guide, Backup
and Restore to learn more about database backup procedures.
1. Do one of the following to open the Domain Definition window:
Click .
2. Do one of the following
Click
Notes
Related Topics
2. In the Delete Invalid Domain dialog box, from the Domain Name list, select the
invalid domain.
Tip
If the list is empty, there are no corrupted domains in the current
database.
3. Click OK.
Notes
After you click OK, you cannot stop the deletion process.
The duration of the deletion process depends on the stage at which the
domain initialization failed: the later the stage, the longer the deletion
process.
Related Topics
2. In the Delete Invalid Domain dialog box, from the Domain Name list, select the
invalid domain.
Tip
If the list is empty, there are no corrupted domains in the current
database.
3. Click OK.
Notes
After you click OK, you are prompted to verify your selection to make
sure you have selected a schema of an invalid domain and not a schema
that is not part of SmartPlant Instrumentation.
The duration of the deletion process depends on the stage at which the
domain initialization failed: the later the stage, the longer the deletion
process.
Related Topics
If you want to resume the initialization process from the same place
where the process was interrupted, click Yes and keep running the
process until it is completed successfully.
When restarting the initialization process, you cannot define the same
domain name because it is in use in the domain that became invalid
when the previous initialization session was interrupted. If you want
to use the same domain name, you must first delete the invalid domain.
For details, see Domain Deletion Common Tasks, page 69.
3. If, during the initialization process, you receive the same error that caused the
process to stop previously, press the Print Screen key. You must make a screen
capture of both the Initialize dialog box, and the error message.
4. Send the screen capture and the InitLog.txt file, located in the SmartPlant
Instrumentation home folder, to Intergraph Support.
Related Topics
French
Portuguese
Italian
If you ignore ORA-01722 error messages and complete the domain initialization, the
domain does not initialize correctly. To prevent the problem from occurring or to
resolve the problem if it has already occurred, do the following:
1. In the Registry Editor, under My Computer, expand the
KEY_LOCAL_MACHINE folder hierarchy.
2. Expand the SOFTWARE folder hierarchy.
3. Expand the ORACLE folder hierarchy.
4. Depending on your oracle client version, do one of the following:
Related Topics
Note
After you resolve the problem and run the interrupted initialization process
again, the software might prompt you to resume or restart the process. For
details about resuming or restarting the process, see Handle an
Initialization Failure, page 74.
Related Topics
If you need to create an off-site project, do not use the project Export
option of the Project Activities dialog box. This option is not intended
for off-site engineering but only for backing up a specific project. For
details about off-site projects, see Off-Site Project Creation and
Implementation: An Overview, page 172.
Related Topics
Back Up a Project
Important
SmartPlant Instrumentation is shipped with the INtoolsAB.db database,
which already contains an Operating owner domain. It is not possible to
use any other database for backing up project data. You cannot export
data from more than one project to the INtoolsAB.db database. Therefore,
before performing this procedure, we recommend that you rename
INtoolsAB.db to <Master>.db, and then, for each export process, make a
copy of the <Master>.db database with the name INtoolsAB.db. After
exporting project data, you should rename INtoolsAB.db. For example, if
your source project name is Project1, you can rename INtoolsAB.db to
Project1.db.
1. Start the Administration module and log on as Domain Administrator.
Click .
3. In the Project Activities dialog box, from the Project list, select a project you
want to use as a source for data export.
Related Topics
Click .
3. On the Project Activities dialog box, from the Project list, select a project whose
data you want to export to another database.
4. Click Export.
5. On the Select Target Database dialog box, click Log File.
6. On the Log File dialog box, do one of the following:
Accept the default path and name of the log file <SmartPlant
Instrumentation home folder>\Exportlog.txt. At this stage, the log file
is not created yet. If you do not want a log file to be created, clear the
Log file name and path box.
Click Browse to select the desired log file. The log file must be a .txt
file.
7. Click OK to save the changes and return to the Select Target Database dialog
box, where you can export the current project data to another database.
Related Topics
Backing Up and Restoring Projects Common Tasks, page 79
Restore a Project
Important
You can perform the following procedure successfully only if the source
and the target projects have the same database ID.
1. Start the Administration module and log on as Domain Administrator.
Click .
3. In the Project Activities dialog box, from the Project list, select a target project
to which you want to import data.
9. Click Report to open the List of Duplicate Items dialog box where you can view
the list of items in the projects of the target domain that appear as duplicate in the
target project after import.
10. Click OK when done.
11. Click Import to restore the project by overwriting the data in the target project.
12. On the Project Activities dialog box, click Close.
Related Topics
Backing Up and Restoring Projects Common Tasks, page 79
Click .
3. On the Project Activities dialog box, from the Project list, select a target project
which you want to restore by importing data from a backed up project.
Accept the default path and name of the log file <SmartPlant
Instrumentation home folder>\importlog.txt. At this stage, the log file
is not created yet. If you do not want a log file to be created, clear the
field.
Click Browse to navigate to the required log file. The log file must be
a .txt file.
9. Click OK to save the changes and return to the Select Source Database dialog
box, where you can restore the backed up project in your Operating owner
domain.
Related Topics
Backing Up and Restoring Projects Common Tasks, page 79
The System Administrator user name and password are defined per
installation. DBA is the default user name and password that you use
to log on to SmartPlant Instrumentation for the first time. The
password is entered in upper case characters, regardless of the
keyboard setting. After you log on for the first time, you should
change your password.
4. In the Open Administration Module dialog box, click System Administrator.
Note
Related Topics
Related Topics
2. Click
2. Click
Click .
3. Click New.
Note that the software creates a default department with each new domain.
If required, you can assign all your users to this department.
Related Topics
Create and Manage User Profiles and Departments Common Tasks, page
88
Click .
3. In the User dialog box, click New.
6. From the Department list, select a department to which you want to assign the
user.
7. Under Password, type a unique login password for the user.
Tip
A password can contain up to 15 characters (not case-sensitive). The
password that you type appears masked.
8. Under Verify new password, retype the password you just entered.
9. Select the System Administrator check box if you want to grant System
Administrator rights to the new user.
Tip
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.
Related Topics
Create and Manage User Profiles and Departments Common Tasks, page
88
5. From the Administrator list, select a user you want to set as Domain
Administrator for the current domain.
Tip
The Domain Administrator name password remain the same that you
have set in the User dialog box when you created that user's profile.
6. Repeat steps 2 through 4 to assign additional Domain Administrators if needed.
Related Topics
Click No to create a new group in which all members have full access
rights to all SmartPlant Instrumentation features.
Click Yes select a source group for copying access rights to the group
that you are creating.
Related Topics
When modifying the profile of a group, the group access rights remain
unchanged.
Related Topics
Delete a Group
Important
You can only delete a group that has no users.
1. Start the Administration module and log on as Domain Administrator.
5. Drag the selected user from the User list pane to the Group users pane.
6. Repeat steps 3 through 5 in this procedure for each user you want to assign to a
group.
7. Click Apply to save the selections.
8. Click Close to close the dialog box.
Note
If a user does not see the plant hierarchy after starting SmartPlant
Instrumentation, this means that this particular user is not assigned to any
group in the domain.
Related Topics
Users who are not assigned to any group have no access rights in the
domain.
1. Start the Administration module and log on as Domain Administrator.
Users who do not belong to any Windows user group or who are not
defined in any SmartPlant Instrumentation group cannot access the
domain.
Click No to create a new group in which all members have full access
rights to all SmartPlant Instrumentation features.
Click Yes select a source group for copying access rights to the group
that you are creating.
Note
Related Topics
Select Remove for those users you want to remove from SmartPlant
Instrumentation.
Select Remove all if you want to remove all the users displayed on the
dialog box.
Tip
The dialog box only displays those users who have been deleted from
their Windows groups.
4. Click OK.
Related Topics
Click .
3. From the Domain list, select a domain.
4. Click
Tip
The domain schema name and domain schema password values are set
only once, when you initialize the domain; therefore, you cannot edit
these values.
Important
The options under Operating owner become permanently fixed in the
current domain after creating the first project.
7. Do one of the following:
If you selected both the Excusive claim mode and Merge without
deleting from project check boxes, after a Project Administrator
merges project items with As-Built, it is still possible to claim these
item for a another project even though there are copies of these items
remaining in the project from which the items were merged with AsBuilt.
9. Set or update the remaining domain definitions as you require. For a detailed
description of domain features, see the Help topic Domain Definition Window.
Related Topics
Click
3. Click
.
to associate the domain in the database.
Tip
The domain schema name and domain schema password values are set
only once, when you initialize the domain; therefore, you cannot edit
these values.
6. From the Standard list, select a naming convention standard.
Tip
You can select a naming convention standard in the Standard box
only if you have not yet created the first instrument tag. For further
information about naming convention standards, see Define Naming
Conventions, page 245.
7. Do one of the following to specify the domain type:
9. Under Workflow, select a desired option. For more information, see Enable
Workflow, page 112.
Tip
Workflow options are available only when the domain type is defined
as Engineering company. For an Operating owner domain, the
workflow is defined at the level of the projects in the domain.
12. Under Global path, click Browse to navigate to a folder which you want to set as
a global path folder. For more information, see Specify a Global Path, page 114.
13. On the window toolbar, click
Related Topics
2. With the System Administration window open, do one of the following to open
the Domain Definition window:
Click .
3. From the Domain list, select a domain.
Click .
5. Under Domain features, select the Cable type dependency check box.
6. Click
Related Topics
Enable Workflow
Important
Your Domain Administrator needs to define access rights at the level of
individual instrument tags in order to implement workflow (for details, see
Workflow Access Rights, page 272).
1. Start the Administration module and log on as System Administrator.
2. With the System Administration window open, do one of the following to open
the Domain Definition window:
Click .
3. From the Domain list, select a domain.
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.
6. Click
Related Topics
Click .
3. From the Domain list, select a domain.
4. Click
Related Topics
2. With the System Administration window open, do one of the following to open
the Domain Definition window:
Click .
3. From the Domain list, select a domain.
Click .
5. Under Domain features, select the Item registry check box.
6. Click
Related Topics
2. With the System Administration window open, do one of the following to open
the Domain Definition window:
Click .
3. From the Domain list, select a domain.
Click .
5. In the Global path group box, click Browse to navigate to the folder which you
want to set as a global path.
Tips
Select Allow to overwrite the global path if you want to allow users
to set user-defined paths in addition to the specified global path.
When this check box is selected, users are not restricted to setting new
paths in SmartPlant Instrumentation only within the global path folder.
6. Click
Related Topics
Click .
2. From the Domain list, select the required domain.
Click .
4. Under Domain features, select or clear the Activity Tracking check box.
5. Click
Related Topics
Related Topics
Note
If Domain and User are selected as the main and secondary categories,
the hours shown in the third column are divided per module. In all other
cases, only the total number of hours is shown.
Related Topics
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.
Related Topics
Related Topics
After you select to encrypt the Admin schema logon password the values
of the LogId and LogPassword are automatically cleared from the
[Database] section of intools.ini file on the System Administrator's
workstation. On all other workstations, the System Administrator has to
delete the values of these parameters, including the equal sign (=).
For example, where the parameters are displayed as shown:
LogId=IN_DBAMN
LogPassword=IN_DBAMN
You should delete the string =IN_DBAMN in each of the lines.
Related Topics
Related Topics
Related Topics
Related Topics
Click .
3. In the Domain Definition window, from the Domain list, select the domain
whose locking mode you want to change.
4. Click
5. Under Domain features, select Single mode to enable locking of items and to
switch to multi-user mode.
6. Click
Related Topics
Related Topics
[Database1]
DBMS=O90
LogId=IN_DBAMN
LogPassword=IN_DBAMN
ServerName=Oracle
Database=ORC1
UserId=
DatabasePassword=
TableDir=0
StayConnected=1
AutoCommit=0
DBParm='DisableBind=1'
Prompt=110
Commit=100
[Database1]
DBMS=MSS
LogId=SPI_DBAMN
LogPassword=SPI_DBA
ServerName=
Database=
UserId=
DatabasePassword=
TableDir=0
StayConnected=1
AutoCommit=0
DBParm="ConnectString=
'DSN=MSS2005;UID=SPI_DBAMN;
PWD=SPI_DBA',DisableBind=1"
DSN=MSS2005
Prompt=110
Commit=100
[Database1]
DBMS=ODBC
LogId=IN_DBAMN
LogPassword=IN_DBAMN
ServerName=
Database=
UserId=
DatabasePassword=
TableDir=0
StayConnected=1
AutoCommit=0
DBParm=
ConnectString='DSN=IN_DEMO;
UID=IN_DBAMN;PWD=IN_DBAMN'
Prompt=110
Commit=100
Tips
When the database type is SQL Server, the DisableBind=1 is not the
only value of the DbParm parameter. Make sure that it is not
enclosed by single quotes and is separated from other values by a
comma, as shown in the example in the table.
4. Test the software by opening Logon Information dialog box and checking the
Database list values.
Tip
The databases that appear in the Logon Information dialog box are
specific to the platform to which you have connected; databases
belonging to other platforms do not appear.
Note
When the user, on the Logon Information dialog box, selects a database
and click OK, the software populates the [Database] section of the
Intools.ini file with information you specified in the Intools.ini file for the
selected database.
You can only rebuild the default views supplied with the SmartPlant
Instrumentation database. You cannot rebuild any user-defined views.
Make sure that all users have logged out of the database before starting
this procedure.
1. With the System Administration window open, click DBA > Rebuild Default
Views in Domains.
2. From the Domain list, select the domain whose database views you want to
rebuild.
3. In the View-Only Domain schema password box, enter the logon password of
the View-Only Domain schema. The password characters appear masked.
Tip
You can change the password only once, when initializing a new
domain. If you did not change the password when initializing the
selected domain, enter the default logon password, which is <Domain
schema logon name>_VIEW.
4. If working on SQL Server, type the SQL Server System Administrator's
password.
Make sure that all users have logged out of the SmartPlant Instrumentation
database before starting this procedure. When you start rebuilding stored
procedures and triggers, no users should attempt to log on to SmartPlant
Instrumentation.
1. With the System Administration window open, click DBA > Rebuild
Procedures and Triggers.
Click Domain schema and then, under Domain, select a domain for
which you can rebuild stored procedures and triggers.
3. Click OK.
Tips
At this point you can select the default LOG.TXT file. This file will
contain the update process information of your current update session
and any errors that may have occurred. The log file is incremented if
you use the same log file name.
If the upgrade stops for any reason (for example, insufficient memory),
you can restart the process and the upgrade will continue from where it
stopped. If you get an error that cannot be corrected, contact Customer
Support with the error description. It is recommended that you have
your log file available when calling Customer Support.
4. In the Database Upgrade dialog box, click OK to start updating the stored
procedures and triggers of the selected schema. At the end of the upgrade process,
an appropriate message is displayed and the LOGERROR.TXT and the
LOG.TXT files are generated.
Note
Add a Filegroup
1. With the System Administration window open, click DBA > Add Datafiles.
2. Click the Filegroup tab.
3. In the System Admin. Password field, type the password to log on as the
Database System Administrator (this field is empty by default).
4. In the New file information section, type the datafile name, the datafile location,
and the initial size (in MB).
5. Click Add to add the filegroup.
Related Topics
Optimize Indexes
Important
Before starting the optimization process, make sure that no other user is
using the currently selected domain. If you attempt to optimize the
indexes of a domain which is currently being used by another user, the
software displays a message warning you that the domain is currently in
use.
1. With the System Administration window open, click DBA > Optimize Indexes.
Click All tables to optimize the indexes of all the existing tables in the
defined domain.
Note
Related Topics
With the System Administration window open, click DBA > Tablespaces
List to display the data for all filegroups that have free space for storing
data.
Note
To learn about Oracle tablespaces, user logins, and how they are used in
SmartPlant Instrumentation, see Installation Guide, Installing SmartPlant
Instrumentation on Oracle > Running Oracle Database Setup > Oracle
Database Server Tablespaces.
Related Topics
2. From the Tablespace list, select the tablespace you want to resize.
3. In the Datafile name box, type the full path and name of a new additional datafile
(.DB file format) that you want to attach to the currently selected tablespace.
Tip
Ensure that you select a datafile which is not currently in use.
4. In the Datafile size box, type the size of the additional datafile.
5. Click OK.
Note
Related Topics
Optimize Indexes
Important
Before starting the optimization process, make sure that no other user is
using the currently selected domain. If you attempt to optimize the
indexes of a domain which is currently being used by another user, the
software displays a message warning you that the domain is currently in
use.
1. With the System Administration window open, click DBA > Tuning >
Optimize Indexes.
2. From the Domain list, select the domain in which you want to optimize indexes.
Tips
Click All tables to optimize the indexes for all the tables in the
selected domain.
Click Selected tables to display in the data window all the tables in
the current domain and optimize the indexes for the required tables.
4. Click OK to start the optimization process.
Note
Related Topics
Update Statistics
With the System Administration window open, click DBA > Tuning >
Update Statistics.
Notes
Related Topics
Click .
3. From the Domain list, select the required domain.
Related Topics
Click .
3. From the Domain list, select the required domain.
Click .
3. From the Domain list, select the required domain.
To edit the properties of existing client, select the required client from the
Client list and click Edit.
To delete existing client from the system, select the required client from
the Client list and click Delete.
Related Topics
Click .
3. From the Domain list, select the required domain.
4. Click Options > Add Accounting (or Add Contractor or Add Client).
5. In the General list pane, select an item and drag it to the Domain pane.
6. Click Apply.
Notes
Related Topics
French
German
In the File name and path box, type the path and filename of the
language database file (the default file is IN_CTLOG.DB).
Important
If you get a message stating that the connection has failed, make sure
you typed in the correct path and filename of the database file (see step
2 of this procedure).
4. In the Language section, do one of the following:
Clear this check box if you want to add new terms and phrases to the
previously imported language without overwriting any existing terms
or phrases.
6. Click Import to add the selected language to the database.
Related Topics
Description
Domain Information
Domain List
Note
Related Topics
Once the System Administrator has set up the working environment, the Domain
Administrator is responsible for performing the activities.
The Domain Administrator is responsible for defining plant hierarchy levels and then
setting up and organizing the plant hierarchy level items. For example, on the Plant
level, it is possible to create several items such as Plant1, Plant2, Plant3, and so forth.
When you enter a domain for the first time, and open the Plant Hierarchy Explorer,
the software only displays the plant DEFAULT, provided that the System
Administrator has enabled the use of the default plant. The System Administrator has
rights to switch the default plant on or off until you create a plant hierarchy with more
than three levels.
You must be granted full access rights for the ENGINEERING PROJECT
DEFINITION activity in order to be able to perform engineering
activities. To learn how to grant access rights, see Grant Access Rights for
Selected Items or Activities, page 270.
Related Topics
Click Add to add the lowest level in the plant hierarchy (the default
lowest level is Level 3).
Select a level, and then click Insert to add a new level above the
selected level.
Select a level, and then click Delete to delete the level that you do not
require.
Under Name, change or enter a new name for the level. The name that
you enter appears as the name of the appropriate folder in the Plant
Hierarchy Explorer.
You can delete any levels as long as three levels remain in the dialog
box after deletion. Three levels in the minimum number of plant
hierarchy levels.
You can add or insert levels only before creating the first plant in the
Plant Hierarchy Explorer.
You can change the level names at any stage of your domain life cycle.
Related Topics
Click .
3. Click New.
4. In the boxes, for the new owner profile, enter data as required.
5. Click Apply to save the new owner profile in SmartPlant Instrumentation.
Notes
To edit the profile of an existing owner, from the Owner list, select an
owner and click Edit.
To delete an owner, from the Owner list, select an owner and click
Delete.
Related Topics
To delete an item, right-click the item itself, and then, on the shortcut
menu, click Delete. To delete an item that has child items, you must
first delete the child items.
5. In General tab of the Plant Properties dialog box, in the <Plant> box, type the
new <plant> name.
Tip
The name must contain at least one character that is not space. The
maximum name length is fifty characters.
6. From the Owner list, select the appropriate owner for the new <plant>.
3. In the Plant Hierarchy Explorer, right-click any level under which the software
displays the icon
.
4. Click New.
Tips
The highest plant hierarchy level items are indicated by the icon
To delete an item, right-click the item itself, and then, on the shortcut
menu, click Delete. To delete an item that has child items, you must
first delete the child items.
5. From the Plant list, select a plant.
6. Click New.
7. In the <Area> data field, type a new <area> name.
Tips
The intermediate level item name must be unique within the current
node of the parent level.
The name must contain at least one character that is not space. The
maximum name length is fifty characters.
8. In the boxes, enter data as required.
9. If needed, click the Custom Fields tab to define custom field values to be
associated with the current intermediate level item.
Related Topics
3. In the Plant Hierarchy Explorer, expand the plant hierarchy until you display
the lowest level icon
.
4. Right-click the intermediate level above the icon
Tips
To delete an item, right-click the item itself, and then, on the shortcut
menu, click Delete. To delete an item that has child items, you must
first delete the child items.
Caution
Make sure you select the appropriate plant hierarchy node before you
click New. After creating a <unit>, you cannot move it to another
plant hierarchy node.
5. On the shortcut menu, click New.
6. In the General tab of the <Unit> Properties dialog box, in the Name box, type a
unit name which is unique within the current node of the parent level.
Tip
The name must contain at least one character that is not space. The
maximum name length is fifty characters.
The value you type in the Number data field is generally used in the
prefix part of the tag number naming conventions. For further
information, see Define Naming Conventions, page 245. You do not
have to define the unit number if you plant to define naming
conventions without using the <unit> number segment. However, you
must define the <unit> number if you want to copy data from another
<unit> even if in the source <unit>, naming conventions do not
include the <unit> number segment.
If you change the unit number of a unit which already has naming
conventions with the unit number segment, the new naming
convention applies to existing items as well as for new items.
In the Custom Fields tab, you can define custom field values to be
associated with the current <unit>.
8. Do one of the following:
Related Topics
Copy Naming Conventions to Other <Units>, page 248
You can only delete a plant hierarchy item that does not have child
items.
Related Topics
Related Topics
Create a Project
Important
You may also want to define a <plant> before creating a project. For
details, see Create a Plant Hierarchy Item on the Highest Level, page 154.
1. Start the Administration module and log on as Domain Administrator.
Click .
3. In the Project Activities dialog box, click New.
Select the Do not propagate wire tag names check box if you want to
suppress the tag number name propagation along the signal path
this way you will be able to customize wire tag names along the
propagated signal path.
Clear the Do not propagate wire tag names check box to propagate
wire tag names this way, all the wires along the propagated signal
path will be named according to the tag number from which the signal
originates.
9. If needed, select a logo for the current project.
Click Yes to copy all the As-Built user groups to the current project.
Click No to create the project with only one user group (that is, the
group to which the current Project Administrator belongs).
12. click Yes if you want to proceed immediately.
13. When prompted to create the project schema, click Yes if you want to proceed
immediately.
Tip
Creation of the project schema can take a considerable time, therefore,
if you do not need to implement your project right away, click No
when prompted. You can then create the project schema when you
claim items for the project.
14. Click Close
Related Topics
To remove a group from the selected project, drag this group from the
Project groups pane to the Group list pane.
Tip
After you click OK, users of a group with full access rights for project
activities become available on the Project Activities dialog box, in the
Project Administrator list. You can select a specific user and assign
this user to the project as Project Administrator.
Related Topics
From the Project list, select a project for which you want to assign a
logo and click Edit.
Tip
The first time you open the Browse Logo Files dialog box the Logo
Preview data window displays a message notifying you that no logo is
currently assigned to the selected project.
3. Click Browse to open the Select Logo File dialog box.
Tip
You can select only the .bmp file format. You can create a .bmp file
using a graphic editing application such as Windows Paintbrush.
Since most reports are printed out in black-and-white, we recommend
that you select Bitmap files in black-and-white to save system
resources.
4. Navigate to the required .bmp file which you want to assign as the project logo
and click OK.
5. On the Browse Logo Files dialog box, click Assign to assign the selected bitmap
to the current project and save the new project logo to the database.
Related Topics
Click .
3. On the Project Activities dialog box, select As-Built.
4. Click Edit.
5. From the Project Administrator list, select a Project Administrator.
Tip
The Plant box displays All Plants. This option is view-only because
As-Built is always associated with all the plants that exist in the
current domain.
6. If needed, select a workflow option for As-Built.
Claimed items In As-Built, items that have been claimed for projects.
This category is only available when you select As-Built from the Project
list of the Project Activities dialog box.
Project items In the project that you selected, indicates project items
when SmartPlant Instrumentation users open the current project with AsBuilt items displayed.
To modify the display format of an item category, see Modify the Display Format for
an Item Category, page 167
To copy the display format of an item category from another project, see Copy the
Display Format from Another Project, page 168
Related Topics
Select As-Built to indicate in As-Built those items that you claim for
projects.
Select a project in which you want to set the display format for dummy
items. Also, for users working in the current project with As-Built
items displayed, you can set the display format for As-Built items and
project items.
2. Click Edit.
3. In the Colors dialog box, for a desired item category, click Change in the
Display Format column.
4. Move the sliders for the red, green, and blue components to obtain the required
color.
5. If required, click Bold or Italic (or both) to format the text.
Click .
2. On the Project Activities dialog box, do one of the following:
From the Project list, select As-Built if you want to reserve tags and
loops for As-Built.
From the Project list, select an existing project or enter a name for a
new project if you want to reserve tags and loops for a project.
3. Click Reserve.
If you clicked the Tag Numbers tab, under Instrument Type, select
the instrument type of the tag numbers for which you want to define
the reservation.
7. Under From Number, type the first number for the range.
Tips
When defining a range of loop numbers, the number of digits that you
type must be smaller or the same as the number defined on the
Naming Conventions dialog box for the Loop Number segment in
the Loop Number segment category.
When defining a range of tag numbers, the number of digits that you
type must be smaller or the same as the number defined on the
Naming Conventions dialog box for the Loop Identifier segment in
the Tag Number segment category.
8. Under To Number, type the last number for the range. The number of digits that
you type must be smaller or the same as the number defined on the Naming
Conventions dialog box, for the Loop Number segment.
Tips
When defining a range of loop numbers, the number of digits that you
type must be smaller or the same as the number defined on the
Naming Conventions dialog box for the Loop Number segment.
When defining a range of tag numbers, the number of digits that you
type must be smaller or the same as the number defined on the
Naming Conventions dialog box for the Loop Identifier segment.
9. Click Apply.
Tip
Click Add to add a new row and define another range of numbers.
Related Topics
Click Tag Numbers to generate a report that displays all the reserved
tag numbers in the current domain.
Click Loop Numbers to generate a report that displays all the reserved
tag numbers in the current domain.
Related Topics
Click .
3. On the Project Activities dialog box, select the project for which you want to set
the status.
4. From the SmartPlant project status list, select one of the following statuses:
Notes
The Active status is the default status assigned automatically to every new
project that you create.
Rebuild a Project
1. As Domain Administrator, enter the Operating owner domain.
2. Click DBA > Rebuild Projects in Domain.
3. In the data window, select As-Built and those projects for which you want to
rebuild the schemas.
Tip
Selecting As-Built is required after initializing an Operating owner
domain in Sybase Adaptive Server Anywhere (full engine version).
4. Click OK to rebuild the selected projects.
Note
Without rebuilding the As-Built and project schemas, you cannot use an
Operating owner domain initialized in Sybase Adaptive Server Anywhere
(full engine version) because during the domain initialization, only the
Domain schema is created.
Related Topics
We do not recommend that you use the project Export option of the
Project Activities dialog box to export partial master domain information.
This option is not intended for off-site engineering but only for backing up
a specific project within the master domain. The use of the Export option
for engineering changes may result in severe data integrity violations in
the master database. For details about backing up and restoring projects,
see Backing Up and Restoring Projects: An Overview, page 78.
Related Topics
Caution
At this stage, in the master domain, it is strongly recommended that no
changes whatsoever be done to the project until the off-site project
changes are imported. Failure to prevent changes may result in the
database corruption or synchronization problems. Therefore, to
prevent accidental changes to the project data in the master domain,
the Domain Administrator can set all access rights of the project user
groups as Access-Denied or View-Only.
2. Send the database with the backed up domain to the appropriate contractor.
3. In the contractor's database, initialize a new off-site domain that has both As-Built
and project data using the Ntools_Backup.db as a source.
4. Define or modify the project data as you require.
5. Back up the entire domain with the off-site project to the contractor's empty copy
of the INtools_Backup.db database or create the database dump if the database
type is Oracle or SQL Server.
6. Connect to the database containing the off-site project and import the off-site
project to the Operating owner domain in the master database. For details, see
Import an Off-Site Project, page 177
7. In the Operating owner domain in the master database, merge the project data
with As-Built.
Related Topics
Define all plant hierarchy items that will be involved in the off-site
project.
Create projects and claim As-Built items that you need for the projects.
If you want to enable the use of revisions in the off-site project, save the
revisions to the database. If the project you want to use as a source for
creating an off-site project already has documents and revisions saved as
files, change the revision storage method to Database using the Manage
Spec Revisions dialog box of the Specifications module.
Related Topics
Restrictions
Important Notes
Plant
hierarchy
Adding or
modifying is not
allowed.
Naming
conventions
Defining or
modifying is not
allowed
Supporting
tables
Changing
supporting table
values that exist in
the master domain
is not allowed.
Spec forms
and pages
Changing spec
forms or pages that
are present in the
master database is
not allowed.
Restrictions
Important Notes
Deleting
items
No restrictions
Changing
items
properties
No restrictions
Merging
items
Not allowed
Related Topics
Click .
3. On the Project Activities dialog box, from the Project list, select a target project
to which you want to import data.
When using Oracle or SQL Server, type your database server name.
Tip
When using Sybase Adaptive Server Anywhere, the Admin schema
login boxes are view-only.
8. In the Admin schema logon password box, accept or type the required password.
9. Click Connect.
10. From the Domain list, select a source domain.
Tip
After selecting the source domain, the software detects the source
project with the same database ID as in the target project, and
automatically displays the source project in the Project box.
Click .
3. On the Project Activities dialog box, from the Project list, select a target project
to which you want to import data.
When using Oracle or SQL Server, type your database server name.
Tip
When using Sybase Adaptive Server Anywhere, the Admin schema
logon boxes are view-only.
8. In the Admin schema logon password box, accept or type the required password.
9. Click Connect.
Accept the default path and name of the log file <SmartPlant
Instrumentation home folder>\importlog.txt. At this stage, the log file
is not created yet. If you do not want a log file to be created, clear the
field.
Click Browse to navigate to the required log file. The log file must be
a .txt file.
12. Click OK to save the changes and return to the Select Source Database dialog
box, where you can import the data from the off-site project to the current project.
Related Topics
Import an Off-Site Project, page 177
2. On the Project Activities dialog box, under Project, select an empty project you
want to delete.
Tip
In an integrated environment, you can only delete an empty project
whose is set as Cancelled or Completed. To set the project status,
before deleting the project on the Project Activities dialog box, under
SmartPlant project status, select Cancelled or Completed.
3. Click Delete.
Note
You can perform the following procedure if you have Domain
Administrator rights in the current domain and the Project Administrator
cannot perform this operation due to a technical problem.
1. On the Domain Administration window menu bar, click DBA > Delete
Projects.
2. On the Delete Projects dialog box, select the Delete project schema check box.
3. Under Project List, select the project that you want to delete.
4. Click OK.
Related Topics
2. On the Delete Projects dialog box, clear the Delete project schema check box.
3. Under Project List, select the project for which you want to delete project data.
4. Click OK.
Related Topics
Operating Owner Domain (As-Built and Projects) Common Tasks, page
160
Select the Delete project schema check box to delete project data
together with the project schema.
Clear the Delete project schema check box if you only want to delete
the engineering data and be able to use the same projects for creating
new data.
3. Under Project List, select the projects you want to delete.
4. Click OK.
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.
Related Topics
2. Select an item type. Note that the Item type list is a required field and without
selecting an item type, the software cannot proceed with the search.
3. Under Item name, type a name of an item that you want to find.
Tip
You can use wildcard characters (* or %) to find items whose names
contain part of the text that you type. If you do not know the item
name, leave the asterisk * in the this field.
4. Under Search in, select a plant hierarchy level on which the software searches for
items:
7. In the Results data window, select the items that you want to work with and click
Add to My List.
Notes
After the software finds the items that you were looking for and lists them
in the Results data window, you can search for more items without losing
your current results. Select another item type and click Search Now. The
software adds the newly found items to the previously found results.
To start a new search and clear the Search results data window.
Related Topics
2. On the Find Item dialog box, select Match case if you want the software to find
items whose names match the capitalization of the item name you entered.
3. Select Find whole name only if you want the software to search for occurrences
that are whole names and not part of a larger item name.
Select As typed and then under Item type a name. The software looks
for the item as you type. You can set the search delay to determine
how long the software will wait after the last time you press a key on
your keyboard.
5. Click Close.
Related Topics
Tip
Note that the value that you enter in this box overrides all other filter
criteria in this dialog box.
3. Type a filter name.
4. Select an item type appropriate for the folder that you selected. You must select
an item type to be able to perform the filter operation.
5. Do one of the following:
Select Selected node definition to filter the child items that belong to
a folder or the items at any hierarchy level that you selected in the
Explorer tree view.
Select Global definition to define a filter for the entire tree view of
the active Explorer. The software applies this definition to the item
type you selected. If you defined a filter definition for a specific
folder, the filter for the folder override the settings for the global filter
definition.
Value select or type a required value for the item you selected
under Property. The available values depend on the specific property
that you select.
Logic You use this option when you specify more than one filter
condition. The option allows you to select the required logical
operator (And or Or) to determine how the next filter expression will
relate to the current expression. When you have a mixture of logical
operators for several conditions, the software performs the expressions
on the conditions in order, for example:
(A and B) or C
(A or B) and C
7. Click Verify to check the validity of the current filtering condition.
8. Click OK.
Note
Clicking Advanced allows you to define a special filter for the Cables,
Cross Cables, and Loops folders. For details, see Filter Cables, page 189
and Filter Loops According to Blocks, page 192.
Related Topics
Filter Cables
1. In an Explorer window, select the Cables or the Cross Cables folder and do one
of the following:
Tip
The value that you enter in this box overrides all other filter criteria in
this dialog box.
3. Type a filter name.
Select Selected node definition to filter the child items that belong to
a folder or the items at any hierarchy level that you selected in the
Explorer tree view.
Select Global definition to define a filter for the entire tree view of
the active Explorer. The software applies this definition to the item
type you selected. If you defined a filter definition for a specific
folder, the filter for the folder overrides the settings for the global filter
definition.
Value select or type a required value for the item you selected
under Property. The available values depend on the specific property
that you select.
Logic You use this option when you specify more than one filter
condition. The option allows you to select the required logical
operator (And or Or) to determine how the next filter expression will
relate to the current expression. When you have a mixture of logical
operators for several conditions, the software performs the expressions
on the conditions in order, for example:
(A and B) or C
(A or B) and C
6. Click Verify to check the validity of the current filtering condition.
Clear the Look for connections check box if you do not want to
include any of the connection criteria in the filter condition. Selecting
this option disables the check boxes in this group box and in the
Connected to group box.
Select the Look for connections check box to include and select
connection criteria in the filter condition.
9. To select a connection criterion, in the Connection group box, click the
following:
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.
Device panels - Includes all the cables that are connected to device
panel.
DCS panels Includes all the cables that are connected to DCS
panel.
PLC panels Includes all the cables that are connected to DCS
panel.
11. In the Cable associations group box, select an appropriate Foundation Fieldbus
or Profibus segment if you want to include cables that are associated with a
specific Fieldbus segment.
12. Select the Display telecom cables only if you want to filter the Cables folder so
that it displays telecom cables only.
13. Click OK in the Advanced Filter Definition dialog box.
14. Click OK in the Filter Definition dialog box.
Related Topics
Tip
The value that you enter in this box overrides all other filter criteria in
this dialog box.
3. Type a filter name.
Select Selected node definition to filter the child items that belong to
a folder or the items at any hierarchy level that you selected in the
Explorer tree view.
Select Global definition to define a filter for the entire tree view of
the active Explorer. The software applies this definition to the item
type you selected. If you defined a filter definition for a specific
folder, the filter for the folder overrides the settings for the global filter
definition.
5. In the Filter definition group box, define the criteria that you use to filter the
items displayed:
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
Under Blocks associated with tags, select one or more blocks that are
associated with loop tags. After you select these blocks, in the current
explorer window, the software only displays loops whose blocks are
assigned to tags using the block-tag assignment method.
In the tree view, right-click an item and then on the shortcut menu,
click Add to My List.
In the Items pane, click My List and then drag an item from the tree
view to My List.
Notes
To remove an item from My List, right-click the item, and then, click
Remove from My List.
To clear the My List view of all the items, right-click an item and then
click Remove All from My List.
Related Topics
If you want to claim fieldbus tags, you only need to claim the associated
fieldbus segments with their sub-items and the fieldbus tags are claimed
automatically. It is not possible to claim fieldbus tags manually, although
they are displayed in the As-Built Explorer or Source Project Explorer
under loops and fieldbus segments.
Related Topics
Claim As-Built Items from the Command Line, page 214
Reclaim
Items
Check
Box
Possible
Action
Condition
Result
Selected
N/A
Claim a
strip for
Project1.
Selected
N/A
Claim a
strip for
Project2.
Reclaim
Items
Check
Box
Possible
Action
Condition
Result
Selected
N/A
Claim a
strip for
Project1.
Selected
N/A
Claim a
strip for
Project1.
There is no change in
Project1. This action is
not allowed because only
one project can contain a
fully-functional strip when
working in exclusive claim
mode.
Selected
Selected
Reclaim a
strip for
Project1.
Selected
Selected
Reclaim a
strip for
Project1.
Reclaim
Items
Check
Box
Possible
Action
Condition
Result
Cleared
N/A
Claim a
strip for
Project1.
Cleared
N/A
Claim a
strip for
Project2.
Cleared
N/A
Claim a
strip for
Project1.
Cleared
N/A
Claim a
strip for
Project1.
There is no change in
Project1. This action is
not allowed because only
one project can contain
fully-functional strip and
panel when working in
exclusive claim mode.
Cleared
Selected
Reclaim a
strip for
Project1.
Reclaim
Items
Check
Box
Possible
Action
Condition
Result
N/A
Selected
Reclaim a
strip for
Project1.
There is no change in
Project1. This action is
not allowed because
reclaiming a dummy item
converts it to a fullyfunctional item. You
cannot have the same
fully-functional strip in
more than one project
when working in exclusive
claim mode.
Important
When you claim instruments directly from the Instruments folder of the
As-Built Explorer or Source Project Explorer, the source loop is always
claimed as a dummy item. In this case, the Claim parent items as dummy
preference does not apply..
Reclaim
Items
Check
Box
Possible
Action
Condition
Result
Selected
N/A
Claim a
strip for
Project1.
Reclaim
Items
Check
Box
Possible
Action
Condition
Result
Selected
N/A
Claim a
strip for
Project2.
Selected
N/A
Claim a
strip for
Project1.
Selected
Selected
Reclaim a
strip for
Project1.
Cleared
N/A
Claim a
strip for
Project1.
Reclaim
Items
Check
Box
Possible
Action
Condition
Result
Cleared
N/A
Claim a
strip for
Project1.
Cleared
N/A
Claim a
strip for
Project2.
Cleared
Selected
Reclaim a
strip for
Project1.
Important
When you claim instruments directly from the Instruments folder of the
As-Built Explorer or Source Project Explorer, the source loop is always
claimed as a dummy item. In this case, the Claim parent items as dummy
preference does not apply..
Related Topics
Click .
3. In the Project Activities dialog box, select a project for which you want to claim
data from As-Built.
4. Click Scope.
5. On the Select Source for Claiming dialog box, under Claim source, select AsBuilt.
6. Click OK.
Select Include to make items from selected units available for use in
the project.
Select Select all to make items from all the units available for use in
the project (or clear this check box to clear the selection for all the
items).
8. Click Continue.
9. In the As-Built Explorer, expand the hierarchy to display the item type folders.
Related Topics
Click .
3. On the Project Activities dialog box, select a project for which you want to claim
data from another project.
4. Click Scope.
5. On the Select Source for Claiming dialog box, under Claim source, select the
source project.
Tips
The source and target projects must be carried out in the same <plant>.
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).
The source and target projects must be carried out in the same <plant>.
4. On the Scope Definition dialog box, do one of the following:
Select Include to make items from selected units available for use in
the project.
Select Select all to make items from all the units available for use in
the project (or clear this check box to clear the selection for all the
items).
5. Click Continue.
For details on preferences options, see Help topics for the Preferences for
Scoping and Merging Data dialog box.
The software saves the preferences that you define for the entire Operating
owner domain, so that the same preferences apply in all the projects and
As-Built. These preferences do not affect user preferences defined in the
Preferences Management dialog box.
Preferences you define on the General tab also apply to merging data
options.
Related Topics
Preferences for Scoping and Merging Data Dialog Box, page 468
In the tree view pane, right-click a specific item, and then, on the
shortcut menu, click Copy to Claim Buffer.
In the Items pane, select and right-click one or more items, and then,
on the shortcut menu, click Copy to Claim Buffer.
From the tree view or Items pane, drag the items to the Claim Buffer.
Tips
When you select the items for defining the scope of a project, in
addition to the main items you select, the software can select the
associated sub-items automatically, or you have the option to include
the sub-items manually with the main item by setting preferences on
the General tab of the Preferences for Scoping and Merging Data
dialog box.
The Claim Buffer does not show engineering data associated with the
instrument tags that you copied.
You cannot select basic engineering data manually or set the software
to claim instruments without including the associated basic
engineering data.
Related Topics
In the tree view pane, right-click a specific item, and then, on the
shortcut menu, click Copy to Target Project Buffer.
In the Items pane, select and right-click one or more items, and then,
on the shortcut menu, click Copy to Target Project Buffer.
From the tree view or Items pane, drag the items to the Copy to
Target Project Buffer.
Tips
When you select the items for defining the scope of a project, in
addition to the main items you select, the software can select the
associated sub-items automatically, or you have the option to include
the sub-items manually with the main item by setting preferences on
the General tab of the Preferences for Scoping and Merging Data
dialog box.
The Target Project Buffer does not show engineering data associated
with the instrument tags that you copied.
You cannot select basic engineering data manually or set the software
to claim instruments without including the associated basic
engineering data.
Related Topics
3. In the Select Item Types for Reports dialog box, use the check boxes to select
item types for which you want to generate reports.
4. Click OK to display the report print preview for the first item type you selected.
5. In the print preview, under Reports, click arrow keys to display reports for other
item types you selected.
Tips
The software generates an individual reports for each item type that you
selected. For example, if you selected Line, Loop, and Tag, the software
first displays a report of lines that appear in the buffer. After you close
this report, the software displays a report of loops that appear in the buffer,
and so forth.
Related Topics
To remove all items that appear in the buffer, in the tree view pane,
right-click the highest hierarchy node, and then, on the shortcut menu,
click Remove All.
To remove one specific item, in the tree view pane, select and rightclick an item, and then, on the shortcut menu, click Remove.
To remove one or more items, in the Items pane, select and right-click
one or more items, and then, on the shortcut menu, click Remove.
Note
Related Topics
Tips
The buffer only contains items that you copied from the claim source.
A log file and .psr files that include a list of claimed items appear in
the path that you specified when setting the preferences for claiming
items.
If you claimed a loop or instrument together with the wiring items, the
software only claims those wiring items that have a signal propagated
to the loop or instrument. If you placed a device panel inside a cabinet
or junction box, when claiming the loop, this device panel is not
claimed together with the cabinet or junction box because this device
panel does not have a signal propagated to the loop. You must select
and claim such a device panel manually.
Related Topics
Claiming items from the As-Built Explorer is only possible if the Claim
Buffer has no items.
Claiming items from the Source Project Explorer is only possible if the
Target Project Buffer has no items.
1. Depending on a claim source, do one of the following:
If you claimed a loop or instrument together with the wiring items, the
software only claims those wiring items that have a signal propagated
to the loop or instrument. If you placed a device panel inside a cabinet
or junction box, when claiming the loop, this device panel is not
claimed together with the cabinet or junction box because this device
panel does not have a signal propagated to the loop. You must select
and claim such a device panel manually.
Related Topics
You can only claim items from the command line after copying the items
from the As-Built Explorer to the Claim Buffer. For details, see Copy
Items to the Claim Buffer.
After copying the items, you must close the Administration module prior
to claming the items from the command line.
It is not possible to claim items from the command line using another
project as a claim source.
Important
Use a space character between the Main and <user name> parameters.
For other parameters, you must only use commas as parameter separators.
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
<Operating owner
domain name>
SPI1
<target project
name>
The name of the project for which you want to claim As-Built
items from the Claim Buffer.
Project1
<claim flag>
Example
Main User1,User1,SPI1,Project1,C
Related Topics
Claim Documents
Important
Prior to claiming documents we recommend that you read the
Prerequisites for Claiming Documents, page 215 topic.
1. Depending on a claim source, do one of the following:
You can copy documents to the buffer first, and then, claim all the
documents together with all other items that you copied to the buffer.
When claiming a cable block diagram, you must also claim panels the
cable block diagram references. These panels must be claimed as
fully-functional items.
Related Topics
After clicking Claimed For, the software changes the lower pane name
from Items to Projects.
The Projects pane can display several projects containing the same item
only if the System Administrator cleared the check box Exclusive claim
mode in the Domain Definition window when creating an Operating
owner domain. If the Exclusive claim mode is selected, it is not possible
to claim the same item for more than one project.
If the Projects pane is empty, this means that the selected item has not
been claimed for any project.
The Projects pane does not display items that you claimed for a project
and then deleted from that project.
Related Topics
When merging project data with As-Built, you can ignore dummy items.
After merging all items that have a parent dummy item, the software
removes the dummy item from the project automatically.
If you want to merge fieldbus tags, you only need to merge the associated
fieldbus segments with their sub-items and the fieldbus tags are merged
automatically. It is not possible to merge fieldbus tags manually, although
they are displayed in the Project Explorer under loops and fieldbus
segments.
Related Topics
Actions for Merging Items, page 235
Item and Sub-Item Selection Options for Merging with As-Built, page 220
Click .
3. In the Project Activities dialog box, select a project whose data you want to
merge with which As-Built.
4. Click Merge.
Related Topics
Loop
Tag
Terminal Strip
Terminals
Cable
Wire
Note
You cannot select basic engineering data manually or set the software to
merge tags without including the associated basic engineering data.
Related Topics
Related Topics
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.
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.
Related Topics
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.
Item and Sub-Item Selection Options for Merging with As-Built, page 220
When copying the items, the software also changes the merge action to
Merge Now for those items that already appear in the Merge Buffer.
Related Topics
Item and Sub-Item Selection Options for Merging with As-Built, page 220
In the tree view pane, right-click a specific item, and then, on the
shortcut menu, click Copy to Buffer as Merge Now.
In the Items pane, select and right-click select one or more items, and
then, on the shortcut menu, click Copy to Buffer as Merge Now.
From the tree view or Items pane, drag the items to the Merge Buffer.
Tip
If the items that you select already appear in the Merge Buffer, when
copying the items, the software also changes the merge action to
Merge Now for those items.
Related Topics
Item and Sub-Item Selection Options for Merging with As-Built, page 220
When copying the items, the software also changes the merge action to
Release Claim for those items that already appear in the Merge Buffer.
Related Topics
Item and Sub-Item Selection Options for Merging with As-Built, page 220
In the tree view pane, right-click a specific item, and then, on the
shortcut menu, click Copy to Buffer as Release Claim.
In the Items pane, select and right-click select one or more items, and
then, on the shortcut menu, click Copy to Buffer as Release Claim.
Tips
If the items that you select already appear in the Merge Buffer, when
copying the items, the software also changes the merge action to
Release Claim.
Do not drag the items to the Merge Buffer. This is because the
software automatically applies the Merge Now action to the items that
you drag.
Related Topics
Item and Sub-Item Selection Options for Merging with As-Built, page 220
To remove all items that appear in the Merge Buffer, in the tree view
pane, right-click the highest hierarchy node (the Merge Buffer node),
and then, on the shortcut menu, click Remove All.
To remove one specific item, in the tree view pane, select and rightclick an item, and then, on the shortcut menu, click Remove.
To remove one or more items, in the Items pane, select and right-click
one or more items, and then, on the shortcut menu, click Remove.
Note
Related Topics
For details on specific preferences options, see Help topics for the
Preferences for Scoping and Merging Data dialog box.
The software saves the preferences that you define for the entire Operating
owner domain, so that the same preferences apply in all the projects and
As-Built. These preferences do not affect user preferences defined in the
Preferences Management dialog box.
Preferences you define on the General tab also apply to defining a scope
of items for projects.
Related Topics
Item and Sub-Item Selection Options for Merging with As-Built, page 220
Preferences for Scoping and Merging Data Dialog Box, page 468
Tip
From Column list to Columns to view, drag columns in the order you
want them to appear in the Comparison List for the current item type.
To remove a column, drag it from Columns to view to Column list.
6. If required, click Sort, and in a dialog box that opens, select the sort order of the
database fields.
Tip
In the Comparison List, the software sorts the fields in ascending
priority, according to the fields that you drag from Column list to
Sorted Columns.
7. In the Comparison List, view the change for each of the selected items. The
Mode column can display the following change indicators:
D Indicates an item claimed for the project and then deleted from
the project.
Related Topics
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
Channel
None
Terminal
1 Side, 2 Side
Cable
1 Side
Cable set
1 Side
Wire
1 Side
None
Related Topics
Items that SmartPlant Instrumentation users created in the project are also
inserted in As-Built. If an item that exists in the project was deleted in AsBuilt, that item is reinserted in As-Built.
Items that SmartPlant Instrumentation users deleted in the project are also
deleted in As-Built.
Items that SmartPlant Instrumentation users updated in the project are also
updated in As-Built. Also, if you made any changes to As-Built data after
claiming the item for the project, the software overwrites the As-Built data
with the project data on merging.
Release claim Disregards changes and leaves the data in As-Built as it was
before claiming it for the project. When using the Release Claim action, the
following rules apply to project data:
The Release Claim action does not apply to new items that you create in
the project.
The Release Claim action does not apply to new sub-items you associated
with a claimed item.
If a claimed item does not have new sub-items you created in the project,
the software removes the claimed item from the project even if you
changed its name and description in the project.
If a claimed item has new sub-items you created in the project, the
software always leaves this claimed item as a dummy item in the project.
If a claimed item has both claimed sub-items and new sub-items you
created in the project, the software only removes the claimed sub-items
from the project. The parent item appears in the project as a dummy item.
You can merge items using one of the two modes set by System
Administrator for the current domain: with deletion from the project or
without deletion from the project. Depending on the merge mode, on
merging data, the software either deletes the merged items from the
project or leaves view-only copies of the merged items in the project. You
cannot delete these copies or update their properties. It is possible,
however, to claim these items for another project even if you are working
in exclusive claim mode. Existence of view-only copies does not prevent
you from deleting the project.
Related Topics
6. Select one or more of the types of changes for applying the action, for example,
Inserted, Deleted, and Not changed.
Tips
After you click OK, the software applies the merge action and affects
the display of items that already appear in the Merge Buffer.
If you change the action from Merge Later to Merge Now, the
software does not merge the item but only copies it and the associated
sub-items to the Merge Buffer.
Related Topics
The Merge Buffer does not contain any items assigned to the Merge Later
action.
During the process of merging data, the software merges all the items
assigned to the Merge Now action in the Merge Buffer, and also release
claim for those items that are assigned to the Release Claim action. For
details on merge action descriptions and examples, see Actions for
Merging Items.
On completing merging the items, the software clears the Merge Buffer.
However, if you copied items to My List, you need to remove the items
manually.
A log file and .psr files that include a list of merged items appear in the
path that you specified when setting the preferences for merging items.
Related Topics
2. In the tree view pane, click an item type folder to display the items in the Items
pane.
3. In the Items pane, select and right-click one or more items, and then do one of the
following:
On the shortcut menu, click Merge to apply the Merge Now action to
all the items that you selected.
On the shortcut menu, click Release Claim to apply the Release Claim
action to all the items that you selected.
Tip
When clicking Merge or Release Claim, the software applies the merge
action all the items that you selected, regardless of the merge action that
was previously assigned to the items. If you want to preserve the merge
action of the selected items, we recommend that you first copy the items to
the Merge Buffer as Merge Now or Release Claim, and then, in the
Merge Buffer, use the Merge All option.
Related Topics
You can only merge items from the command line after copying the items
from the Project Explorer to the Merge Buffer. For details, see Copy
Items to the Merge Buffer Common Tasks.
After copying the items, you must close the Administration module prior
to merging the items from the command line.
Important
Use a space character between the Main and <user name> parameters.
For other parameters, you must only use commas as parameter separators.
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
<Operating owner
domain name>
SPI1
<target project
name>
The name of the project from which you want to merge items
with As-Built.
Project1
<merge flag>
Example
Main User1,User1,SPI1,Project1,M
Related Topics
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.
You can use some parts of the Flexible standard with the Power Station
Designation System (KKS) standard.
Related Topics
Notes for Creating Naming Conventions for Wiring Items, page 244
Click .
3. Beside Parent hierarchy, click Browse to specify a <unit> for which you want
to define naming conventions.
Tip
Naming conventions are always defined per <unit>.
4. From the Convention list, select the item for which you want to define a naming
convention.
Tips
6. From the Segment Category list, select a segment category in each of the data
rows.
7. From the Segment list, select a segment for each category.
8. In the Separator box, type a character to separate the current segment from the
next.
Tips
By default, the software assigns the C- prefix to all the device cable
names. However, when you select device cable from the Convention
list, the Separator data field is empty. If you define new naming
conventions for the device cable but do not type any separator in the
Tag Number row, cable names appear without the C- prefix. You
need to type C in the Separator field of the Tag Number row to make
the C- prefix available again.
If a separator is the last character in the control system tag name, the
software retains the separator when applying the control system tag
naming convention.
If you want a separator to appear at the end of the item name, add
another data row and select Free Segment as both segment category
and segment, define a separator, and then, define the Free Segment
length as 0.
9. In the Start data field, type the starting position of the current segment, that is, the
leftmost character of the description which appears in the segment descriptor.
10. In the Length data field, type the total number of characters (from the starting
character) which appears in the segment descriptor.
Tips
The software does not remove spaces that are part of separators or
appear at the beginning or in the middle of a segment.
Select Remove spaces in file names to removes spaces from the name
of the document files.
Clear Remove spaces in file names to save documents with the name
of the source document item.
Tip
A document file has spaces if the source document item has spaces.
For example, when you generate a loop drawing without opening the
drawing, the software automatically saves the drawing file with the
name of the source loop number. If the source loop number has spaces
and you selected this check box, the software removes the spaces from
the drawing file name when saving the drawing as a file.
13. If you are prompted to change the naming convention (if a naming convention
already exists for the unit), do one of the following in the displayed message:
Click .
3. Beside Parent hierarchy, click Browse to specify a source <unit>.
Tips
You can select Copy all conventions from the current <unit> to
copy all the naming conventions that exist in the current <unit> to
every new <unit> that you create using the Plant Hierarchy
Explorer. This option does not apply to units that already exist in
your domain.
4. Click Copy To.
5. In the Copy Naming Conventions dialog box, select a check box beside the
target <units> to which you want to copy the naming conventions of the source
<unit>.
6. Click Copy and then Close.
7. In the Naming Conventions dialog box, click Apply and then Close.
Related Topics
Click .
3. Beside Parent hierarchy, click Browse to specify a target <unit>.
Edit properties of an existing loop or tag, and then, on the Tag Number
Properties dialog box, select the Update document numbers check box.
Notes
If you do not define a naming convention for process data sheet document
numbers, the software creates the default document number
<tag number>-PD.
For other documents, the software only create document numbers when
naming conventions exist.
If needed, when editing properties of a tag or loop number, you can update
the document number for the associated documents. In this case, the
software assigns document numbers according to the document number
naming conventions.
SmartPlant Instrumentation Administration Users Guide 251
With the Domain Administration window open, click Report > Naming
Convention.
Related Topics
With the Wire End Naming Conventions dialog box open, select Enable
using wire end naming conventions.
Related Topics
Wire End Naming Conventions Common Tasks, page 254
7. To define the start position and length of segments, under Start accept or modify
the value that designates the starting character in the segment from which the
segment appears in the naming convention.
8. Under Length, accept or modify the default number of characters allocated for
the selected segment string in the naming convention (starting from the position
defined in the Start box).
Tip
When you select a segment, the software automatically displays the
maximum length that can be used for the segment. If the total length
exceeds the maximum permitted value of 50 characters, the software
automatically truncates the number of characters in the segment to
maintain the permitted total length or displays a message if the total
length of the segment has already reached the maximum value.
9. If you need to define a separator between the segments in the naming convention
string, in the Separator column, type separator characters (up to 30 characters of
any kind).
10. Repeat steps 4 through 9 for each segment that you want to define.
Tips
Related Topics
You can modify any existing segment definitions as you need. These
settings only apply to the target naming convention.
Related Topics
You can delete only those conventions that are not in use in SmartPlant
Instrumentation.
Related Topics
Full users in the corresponding group can add, delete, and update the
data of the selected item type.
Modify users in the corresponding group can only add or update the
data of the selected item type (deletion is prohibited).
View Only users in the corresponding group can only view the data of
the selected item type without being able to modify it.
Access Denied users in the corresponding group cannot access the data
of the selected item type.
Note
If you assign a user to more than one group, you can specify whether to
grant maximum or minimum access rights for that user over all the groups,
by respectively selecting or clearing Grant maximum access rights.
Related Topics
Description
Level
Access Rights
Management
Domain
Add-Ins
Domain
Administration
Reports
Domain
Assign Groups
to Projects
Parent
Description
Level
Assign Users to
Groups
Domain
Auto Cross
Wiring
Plant
Auto Wiring
Plant
Binder Package
Deletion
Plant
Browser Buffer
Use
Unit
Browser
Manager
Plant
Browser
Manager Filter
Plant
Browser
Manager Sort
Plant
Browser
Manager Style
Plant
Browser
Manager Style
Headers
Plant
Browser
Module Access
Domain
Browser User
Name, Change
Date
Unit
Parent
Wiring Module
Access
Description
Level
Cable Routing
and Drums
Plant
Cable Routing
Options
Command
Plant
Calculation
Activities
Unit
Calculation
Module Access
Unit
Calibration
History Editing
Unit
Calib. Options
& Maint.
Events
Unit
Calib. Options
& Maint.
Events
Calib. Options
& Maint.
Events
Unit
Parent
Calculation
Module Access
Description
Level
Parent
Calibration
Result Modif.
Unit
Calib. Options
& Maint.
Events
Domain
Clear Locking
Domain
Connection
Type
Construction
Module Access
Unit
Construction
Revision Cables
Plant
Construction
Module Access
Construction
Revision Instr.
Plant
Construction
Module Access
Construction
Revision Panels
Plant
Construction
Module Access
Construction
Revision Wires
Plant
Construction
Module Access
Construction
Supporting
Tables
Domain Construction
Module Access
Control System
Tag Operations
Plant
Custom Field
Definition
Domain
Wiring Module
Access
Description
Level
Parent
DDP Module
Supporting
Tables
Plant
Dimensional
Data Module
Access
Define User
Groups
Domain
DeltaV Data
Domain
Dimensional
Data Module
Access
Unit
Document
Binder Module
Access
Plant
Domain Cable
Management
Plant
Domain
Definition
Notes
Domain
Domain Panel
Management
Plant
Drawing Block
Management
Enhanced
Report Chg.
(Layout)
Enhanced
Report Chg.
(Report)
Equipment
Supporting
Table
Plant
Field Personnel
Domain
Wiring Module
Access
Wiring Module
Access
Description
Level
Parent
Form Data
Template
Domain
Global
Revision
Management
Unit
Hook-Up
Definition
Plant
Hook-Ups
Module Access
Hook-Up Item
Management
Plant
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
Instrument
Index Module
Access
Unit
Instrumentation
Workflow Flag
Unit
Intrinsic Safety
Definition
Plant
Wiring Module
Access
Description
Level
Line Definition
Plant
Logo
Definition
Domain
Loop - External
Macro Source
Unit
Loop Drawings
Module Access
Loop
Definition
Unit
Instrument
Index Module
Access
Loop Drawings
Module Access
Unit
Macro
Definitions
Maintenance
Module Access
Unit
Maintenance
Supporting
Tables
Plant
Management of
Local
Revisions
Naming
Convention
Definition
Domain
P&ID
Supporting
Table
Plant
Plant Hierarchy
Management
Domain
Parent
Maintenance
Module Access
Description
Level
Parent
Plant Owner
Definition
Domain
Prevent. Maint.
- Supervisor
Unit
Maintenance
Module Access
Prevent. Maint.
- Technician
Maintenance
Module Access
Process Data
Change in
Specs
Unit
Process Data
Definition
Unit
Process Data
Module Access
Unit
Process Data
Supporting
Tables
Process Data
Workflow Flag
Unit
Project
Definition
Domain
Publish
Plant
Reference
Cable
Management
Domain
Process Data
Module Access
Description
Level
Reference
Panel
Management
Domain
SmartPlant
Registration
Domain
Repair Supervisor
Unit
Retrieve
Plant
Repair Technician
Revision
Deletion
Unit
SAP Interface
Access
Domain
Segment-Wide
Parameters
Unit
Fieldbus
Segments
Plant
SP Electrical
Interface
Unit
Specification
Definition
Unit
Specification
Form Access
Domain
Specifications
Module Access
Unit
Tag Category
Definition
Parent
Maintenance
Module Access
Maintenance
Module Access
Wiring Module
Access
Specifications
Module Access
Description
Level
Parent
Tag Definition
Unit
Instrument
Index Module
Access
Telecom Panel
Management
Plant
Telecom
Supporting
Tables
Plant
To Do List
Unit of
Measure
Definition
Domain
Update
Statistics
(Oracle)
Domain
Wire Group
Wiring Module
Access
Wiring
Connections
Wiring Module
Access
Wiring Module
Access
Wiring
Supporting
Tables
Plant
Description
Level
Parent
Unit
Maintenance
Module Access
Maintenance
Module Access
Related Topics
Click .
2. In the Domain Definition window, do one of the following:
Click .
3. In the Access Rights dialog box, in the Group list pane, select the desired user
group for which you want to define access rights.
View Only
Access Denied
8. Repeat steps 5 through 7 to grant access rights to the same group for another item
or activity. Repeat steps 3 through 7 grant access rights to another group for the
required item or activity.
Note
Related Topics
Click .
2. Do one of the following:
Click .
3. In the Global Access Rights dialog box, in the Access mode list, select the access
mode that you require.
4. From the Group name list, select a user group to which you want to apply the
access rights.
Tip
To apply the access rights to all the groups, select All.
5. To choose the level at which the software grants access rights, select the
appropriate Enable item selection check boxes.
Tips
At the Domain level, you can grant the selected access rights for all the
items at the domain level for the current domain.
At the <Plant> level, you can grant the selected access rights for all
the items at the <plant> level for a selected <plant>, or for all <plants>
in the domain.
At the <Unit> level, you can grant the selected access rights for all
the items at the <unit> level for a selected <unit>, or for all <units> in
the domain.
Tip
To apply the access rights to all the items at a particular level, from the
Item or activity list, select All.
8. Click Apply.
9. Repeat steps 3 through 7 for each item or activity whose access rights you want to
define.
10. Close the Global Access Rights dialog box and then, in the Access Rights
window, click .
Note
You can also modify any selections you make in the Access Rights
window.
Related Topics
2. Define two engineering groups, one for instrumentation, and one for process data
with their users.
3. With the System Administration window open, do one of the following to open
the Domain Definition window:
Click
4. Click
.
to open the Access Rights window.
Click
Related Topics
When the domain type is Operating owner, select source and target
projects. To copy access rights within one project, from the Source
project and Target project lists, select the same project.
Select a check box to specify the level at which you want to copy
access rights.
Related Topics
Related Topics
To generate a report on a specific level, click any tab other that All
Levels.
3. Under Group Name, select user groups that you want to include in the Access
Rights report.
Related Topics
5. On the Advanced Domain Preferences dialog box, for the preferences that you
modified and want to set as default, clear the Enabled check box.
Tips
Clearing the Enabled check box for a particular option prevents new
and existing users from modifying this preference in SmartPlant
Instrumentation.
Selecting Enable all allows you to make all the domain preferences
available for customization in SmartPlant Instrumentation.
Caution
Related Topics
Tip
To learn more about SmartPlant Instrumentation module preferences,
click Help in the in the Preferences Management dialog box on the
appropriate tabs.
5. Click Advanced.
6. On the Advanced Project Preferences dialog box, for the preferences that you
modified and want to set as default, clear the Enabled check box.
Tips
Selecting Enable all allows you to make all the project preferences
available for customization in SmartPlant Instrumentation.
7. Click OK to save the settings and close the Advanced Project Preferences
dialog box.
Related Topics
Select the Enable all check box to make all the preference options
available for customization in the current project.
6. Do one of the following:
8. Click OK to save the settings and close the Advanced Project Preferences
dialog box.
Related Topics
Export Preferences
1. Start the Administration module and log on as Domain Administrator.
2. With the Domain Administration window open, click Activities > Preferences
Management.
3. If the domain type is Operating owner, form the Project list, select a source
project.
4. Click Export.
5. On the dialog box that opens, enter the name of the target .dmp file, and then,
click Save to export the current preferences to the .dmp file.
Tips
In the created .dmp file, you can modify preferences as you require,
and then, import them to a domain or project residing in another
database.
Related Topics
Import Preferences
1. Start the Administration module and log on as Domain Administrator.
2. With the Domain Administration window open, click Activities > Preferences
Management.
3. If the domain type is Operating owner, form the Project list, select a target
project.
4. Click Import.
5. On the dialog box that opens, select the .dmp file that contains previously
exported preferences, and then, click Open.
6. On the Preferences Management dialog box, click OK to save the settings.
Related Topics
4. From the Title Block Customization list, select a title block for each relevant
report. For details on the available title blocks, see Title Block Descriptions.
Tips
Related Topics
If in the Plant Hierarchy dialog box, you define too long names of the
plant hierarchy levels (up to 50 characters are allowed), in the default title
blocks, truncation may occur in the fields that display the names of the
plant hierarchy levels and the specific level items. If you must use long
name strings, to prevent truncation, we recommend that users create
custom title blocks and provide enough room in the PLANT_NAME,
AREA_NAME, and UNIT_NAME fields.
Related Topics
Do not save (not available for the Document Binder module reports)
Sets the software not to keep a revision archive. After saving the report
revision, SmartPlant Instrumentation users cannot see the information
contained in that report at the time of revision, and the report comparison
is not available.
2. With the Domain Administration window open, click Activities > Report
Management.
3. In the Report Management dialog box, under Sort by, select one of the
following options to sort the reports in the Report Name column:
Report sort the reports in the data window by the report names.
Tip
To use the Save as File, or Compress as Zip file options, you need to
set an archive path (see step 7 below). If you have selected Save to
database, or Do not save, skip step 6 in this procedure.
7. To define the default archive path for all the report revisions to be saved as files
or compressed as .zip files, click
next to the Path field in the Default archive
path group box, and enter the required path.
Tip
Related Topics
Description
Example
Per Item
Per
Document
Notes
Related Topics
For more information, see Import DCS Hardware I/O Library Data, page 296.
Import DDP Library Data for PDS
This option enables you import process connection data for the Dimensional Data for
Piping (DDP) module. For more information, see Import DDP Library Data for
PDS, page 297.
Export Macros
This option enables you to export macros from a current SmartPlant Instrumentation
database or domain to a text file. Then, from another database or domain, you import
data contained in this file. Note that you can also include all the existing typical tags
in the target text file. For more information, see Export Macros, page 298.
Import Macros
This option enables you to import macros into SmartPlant Instrumentation from a
predefined intermediate text file that already contains macros exported from another
database or domain to the current database or domain. When importing macros, this
text file serves as the source file. Note that you can also import all the typical tags
that have been included in the text file. For more information, see Import Macros,
page 299.
Related Topics
In the File name and path box, type the path and filename of the
required database file (the default file is IN_CTLOG.DB).
Important
If you get a message stating that the connection has failed, make sure
you typed in the correct path and filename of the database file (see step
3 of this procedure).
5. Do one of the following:
Type the drawing path for the items in the imported library (the default
location is <SmartPlant Instrumentation home folder>HOOK-UP).
This is useful if you don't want to type the path every you retrieve a
drawing from this library.
Leave the data field empty. This way you will have to type the path
when retrieving each drawing. For this option, you will still be able to
assign a path to the drawings in the Hook-Ups module in batch mode.
7. In the Plant Name data window, select the name of the plant in which the
appended hook-up items will be used.
8. Click Import to append the selected hook-up item library to the database.
Note
The software does not allow you to import a hook-up item library which
already exists in the database. If you attempt to import such a hook-up
item library, the software displays an appropriate message.
Related Topics
PDS/SmartPlant P&ID
FirstVue
Performance Spec #1
Masoneilan Spec #1
In the File name and path box, type the path and filename of the
database file IN_CTLOG.DB.
Important
If you get a message stating that the connection has failed, make sure
you typed in the correct path and filename of the database file (see step
3 of this procedure).
5. Under the Select link group section, select one or more of the link groups to
import.
6. Locate the source path of all the links in the imported group in one of the
following ways:
In the Source file path data field, type the source path.
You can import only those link groups for which you purchased an
appropriate license.
Related Topics
In the File name and path box, type the path and filename of the
required database file (the default file is IN_CTLOG.DB).
Important
If you get a message stating that the connection has failed, make sure
you typed in the correct path and filename of the database file (see step
3 of this procedure).
5. From the Target plant list, select the plant to which you want to add the imported
views.
6. Under the Select Views section, select views that you want to import.
7. Click Import to append the selected views to the database.
Note
You can import only those views for which you purchased an appropriate
license.
Related Topics
In the File name and path box, type the path and filename of the
required database file (the default file is IN_CTLOG.DB).
Important
If you get a message stating that the connection has failed, make sure
you typed in the correct path and filename of the database file (see step
3 of this procedure).
4. Under Select panel library, highlight the required library to be imported.
The software does not allow you to import the same connection data more
than once. If you attempt such an import, the software displays an
appropriate message stating that the data import has failed because at least
some of the connection data already exists.
Related Topics
In the box, type the path and filename of the required database file (the
default file is IN_CTLOG.DB).
Important
If you get a message stating that the connection has failed, make sure
you typed in the correct path and filename of the database file (see step
3 of this procedure).
5. Click Import to import the process connection data to your database.
Note
The software does not allow you to import the same DDP Library data
more than once. If you attempt such an import, the software displays an
appropriate message stating that the data import has failed because at least
some of the data already exists.
Related Topics
Export Macros
Important
Exporting macros requires the existence of an sppid_macro component
table in the source database or domain, Domain Administrator access
rights, and a database target .txt file.
1. Start the Administration module and log on as Domain Administrator.
7. Click OK in the notification box that appears if macros have been exported
successfully.
8. Click Close in the Export Macros dialog box.
Related Topics
Import Macros
Important
Importing macros requires the existence of an sppid_macro component
table in the target database or domain, Domain Administrator access
rights, and a predefined source .txt file.
1. Start the Administration module and log on as Domain Administrator.
Select the Include typical tags check box to import all typical tags to
the current database or domain from the source .txt file, if required.
Before selecting Include typical tags, ensure that the source .txt file
contains the required typical tags; otherwise, the macro import process
will fail.
6. Click OK in the Import Macros dialog box.
7. Click OK in the notification box that appears if macros have been imported
successfully.
8. Click Close in the Import Macros dialog box.
Related Topics
Access Rights: An Overview, page 258
The level separators and user-defined level names appear in the Panel
Properties dialog box of the Wiring module.
For a panel location name, you can use any number of alphanumeric or
special characters. The name can include spaces.
4. Click Add and then enter another location level name and a separator.
For example, create the level Room and enter an ampersand separator ( & ).
Important
The location level names must be unique.
5. Do one of the following:
Select the row with the Room level and click Insert to add another
row above the Room level.
Tips
You can insert or delete levels only before users create panel locations
on the level that you select.
At any stage of your domain life cycle, you can click Add to define a
new lowest level in your panel location hierarchy.
If you defined three levels, for example, Building as the highest level,
with separator \, Floor as the second level, with separator , and
Room as the lowest level (Level 3), with separator &, in the Wiring
module, in the Panel Properties dialog box, the location string
appears as follows:
<user-defined location name on the Building level>\<user-defined
location name on the Floor level> <user-defined location name on
the Room level>&.
The level names that you define only appear in the Domain Explorer,
and do not affect specific location names that users define. Therefore,
you can change the level names any time you require.
Related Topics
Miscellaneous Domain Administration Tasks, page 300
You can only select icon files with the extension .ico.
Related Topics
Click .
3. From the <Plant> list, select a <plant> in which you want to make custom field
definitions.
4. From the Item type list, select a target item or data type.
Tips
If you intend to use custom fields in browser views, note that custom
field definitions appear as column headers. For details about the use
of special characters in browser view column headers and for a list of
browsers which can contain custom fields that you define per item or
data type, see Browsers That Can Contain Custom Fields.
You can select a plant hierarchy level name as an item and modify the
default custom field definitions for each of the twenty custom fields.
A custom field definition is a label that appears in the Custom Fields
tab of the Plant Hierarchy Item Properties dialog box. The default
label is Custom field<number incremented from 1 to 20>. For
example, if your highest plant hierarchy level is Plant, for Row
Number 1, enter text My Custom Fields for PlantA. In the Custom
Fields tab of the <Plant> Properties dialog box, for the first custom
field, the software displays My Custom Fields for PlantA instead of
the default definition Custom field 1.
5. In the data window, under Definitions, type or edit custom field labels.
Tips
For each field, the Length field displays the maximum number of
characters that users can specify in the field in SmartPlant
Instrumentation. If needed, you can type a smaller value, and thus,
decrease the maximum allowed number of characters.
If from the Item type list, you selected Process Data, you can disable
the use of certain custom fields by clearing check box in the Visible
column.
6. Click Apply.
Related Topics
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
Click .
2. From the <Plant> list, select a target <plant>.
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
Browser
Calibration Setting
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
Browser
Line
Line Browser
Line Component Browser
Line PD Data Browser
Loop
Block Browser
Enhanced SmartLoop Browser
Loop Browser
Loop Drawing Browser
Panel
Process Data
Revision
Revision Browser
Strip
Terminal
Wire
Wire Browser
Wire Schedule Instal. Index
Wire Schedule Instal. Index Changes
Related Topics
Do not use the single quote (`) character in custom table names
because doing so causes the label to be displayed incorrectly in the
Tag Number Properties dialog box.
5. Click Apply and, if needed, repeat the procedure for another plant.
Related Topics
Description
User List
A list of SmartPlant Instrumentation users for the domains for which you
have access rights (those which have been assigned to you as Domain
Administrator). When you select this option, the list is printed in
ascending alphanumeric sequence.
User List SmartPlant Instrumentation users of the domains for which you have
per Group access rights, listed according to the groups to which they belong.
Description
Domain
Statistics
Access
Rights
Related Topics
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 .
3. Do one of the following:
Click .
4. Click Browse to open the Select Logo File dialog box.
Tip
You can only select the BMP (Bitmap) file format. You can create a
Bitmap file using a graphic editing application such as Windows
Paintbrush. Since most reports are printed out in black-and-white, it is
recommended that you select Bitmap files in black-and-white to save
system resources.
5. Navigate to the required BMP file to which you want to assign as the domain logo
and click OK.
6. In the Browse Logo Files dialog box, click Assign to assign the selected bitmap
to the current domain.
7. Click
8. Click
Related Topics
Click .
3. Do one of the following:
Click .
4. In the Notes field, edit the text as required.
5. Click
6. Click
Related Topics
LEFTMARGIN
RIGHTMARGIN
TOPMARGIN
WIDTH
HEIGHT
ORIENTATION
HRES
VRES
All your page settings apply to all reports and documents that you print
and they are true on all the hierarchy levels (domain, plant, area, and unit).
All your page settings apply to your local machine only and do not affect
other users of SmartPlant Instrumentation.
If you want to change the page setup for the current print session only, do
not click Default, just make your changes and click OK.
Some reports have their orientation hard-coded, therefore only the hardcoded settings apply.
Related Topics
2. With the Domain Administration window open, click DBA > Data
Maintenance > Load Audit Trail.
3. In the From box, type the initial date of the period (month, day, and year).
4. In the To box, type the last date of the period (month, day, and year).
5. In the Load from file box, type the file name segment as it appears in the external
file containing the audit trail data.
Tips
You can type all of the required variables using information contained
in the complete name of the file. The following is an example of a
complete file name: 20010501_20010503_<DOMAIN
NAME>#CHANGES_LOG#<FILE NAME SEGMENT>.TXT (or .sql
on Oracle).
Note that in the complete file name, the audit trail period is displayed
in the following order: year, month, and day.
6. Click Load.
Tip
After loading the audit trail data, the external file remains on your
server. If needed, you can load the same data onto another domain, or
delete the external file manually.
7. Click Close.
Related Topics
2. With the Domain Administration window open, click DBA > Data
Maintenance > Trim Audit Trail Data.
3. If your domain type is Operating owner, from the Project list, a project in which
you want to trim audit trail data, or select As-Built.
4. To define the period of the audit trail data that you want to remove from the audit
trail repository in the current domain, in the From box, type the initial date of the
period (month, day, and year).
5. In the To box, type the last date of the period (month, day, and year).
6. To trim the audit trail data contained within the defined period and save it to an
external file, select Save to file.
7. In the File name box, type a file name segment that will become part of the name
of the external file to which you are saving the defined audit trail data.
8. Click Trim to save the audit trail data to the defined file and remove this data
from audit trail repository in the selected domain.
Tip
The external file name contains information about the initial date of
the defined period (year, month, and day), the last date (year, month,
and day), the domain name, and the file name segment you have typed
in the File name box.
9. To trim the audit trail data without saving it to an external file, clear the Save to
file check box.
10. Click Trim to permanently remove the audit trail data from the audit trail
repository in the current domain.
Related Topics
Define Paths When Using Sybase Adaptive Server Anywhere, page 320
Related Topics
Activate the Audit Trail Functionality, page 113
In the path value, the folder name Orc1 corresponds to a possible instance
name. INtoolStorage is a user-defined name. For convenience, we
recommend that you always use this name in the file path.
On Oracle 9.2, the software might append numbers to the name of the
Oracle Instance Configuration File init.ora. For example, the file name
might be as follows:
init.ora.2242004153249
Prior to trimming audit trail data, you need to delete the numbers together
with the dot that are appended to the init.ora file. Then, you must restart
the Oracle instance manually, that is, not from the Oracle interface but
using appropriate SQL commands.
Related Topics
Related Topics
2. With the Domain Administration window open, click DBA > Locking > Clear
Locking in Selected Sessions.
3. In the Clear Locking in Selected Sessions dialog box, from the User list, select
the user whose SmartPlant Instrumentation sessions you want to stop in the
database.
Tips
View the current database name in the Database field.
4. Click OK.
Related Topics
2. With the Domain Administration window open, click DBA > Locking > End
Blocked Sessions.
Related Topics
Clearing Locking Common Tasks, page 322
2. With the Domain Administration window open, click DBA > Locking > End
Blocking Sessions.
Related Topics
2. With the Domain Administration window open, click DBA > Locking > Clear
Locking in All Sessions.
Note
Related Topics
2. With the Domain Administration window open, click DBA > Data
Maintenance > Clear Session Records.
Module Data
Instrument Index
Tag number
Loop
P&ID drawing
Line
Equipment
Document association
Calculation
Process data
Calculation
Specifications
All module data (you can only copy the specification data
in its entirety.)
Wiring
Wiring items
Connection data (excluding cross wiring)
Loop Drawings
All module data (you can only copy the loop drawing data
in its entirety.)
Hook-Ups
All module data (you can only copy the hook-up data in
its entirety.)
Related Topics
In the <unit> that you selected, you must define the <unit> number
even if in the source <unit>, the naming conventions do not include
the <unit> number segment.
2. Click Copy From.
3. In the dialog box that opens, select a source <unit>, and then, click OK to open
the Copy Data from Source dialog box.
Tips
When the domain type is Operating owner, select the required project
from the Source project list, and then select the <unit> whose data
you want to copy.
The Copy Data from Source dialog box can display previously used
settings that you used the last time when you were copying data. You
can use the same settings, discard some of them, or discard them all.
Click Clear All to discard all the displayed settings.
4. In the left section of the Copy Data from Source dialog box, do one of the
following:
To copy specific data, expand the module hierarchy, and select the
required module data to access the fields in the lower-right section.
For details, see Set Options for Copying Specific Data, page 328.
5. Repeat step 4 in this procedure for each source <unit> module or module data.
6. Click Options to set naming options for wiring items in the target <unit>.
Caution
Make sure that you define the settings described in this procedure for
all the required modules and module items before clicking OK. After
you click OK, canceling the copying process can corrupt the data in
the target <unit> and render the <unit> unusable.
7. Click OK to close the Copy Data from Source dialog box and monitor the
progress of the copying process.
The lower-right section of the Copy Data from Source dialog box
displays only the options that are required for copying data, depending
on the specific module data you select in the left section. The options
that are irrelevant to the selected module are read-only.
Make sure that you do not select the Copy all module data check
box. If you do, click Clear All. Clicking this button discards all the
settings you have made and you have to start again.
3. In the Name prefix field, type a new name prefix to be applied to all the copied
items.
4. In the Name suffix field, type a new name suffix to be applied to all the copied
items.
Tip
Specifying a prefix, a suffix, or both is required when copying module
data within the same <plant>. This way you avoid creating duplicate
module item names.
5. If required, set revision copying options.
6. To avoid having duplicate module item names, in the Char. location data field,
type the number of characters from the start of the name string where you want
the substitution to start from.
7. In the No. of chars. data field, type the number of characters in the name string to
be substituted.
8. In the Value field, type a new value that will substitute a part of the module item
name string.
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.
Tips
This option is available when copying loop or tag number data from a
<unit> within the same <plant>. For tag number items, the option is
accessible only if the ISA or Loop standard naming convention for the
suffix segment description of tags is COMPONENT SUFFIX.
For loop items, the option is accessible only if the ISA or Loop
standard naming convention for the suffix segment description of
loops is LOOP SUFFIX.
If, in your source <unit>, there are loop names or tag numbers that
differ only in their suffix segments, these loop names and tag numbers
become identical in the target <unit>. The new suffix value in the
target <unit> overwrites all the suffix values of the source <unit>. For
example, if in the Suffix field, you type 5, loop names 101-F-100\1,
101-F-100\2, 101-F-100\3 in the source <unit> become 101-F-100\5 in
the target <unit>. This option is not applicable if you use Flexible
naming conventions in the source <unit>. For Flexible naming
conventions, you can define your target loop and tag number suffixes
in the Name suffix field.
11. In the left section, select other specific data, and repeat steps 2 through 10.
Related Topics
4. In the Name suffix field, type a new name suffix to be applied to all the copied
items of the selected module.
Tip
Specifying a prefix, a suffix, or both is required when copying the
<unit> module data within the same <plant>. This way you avoid
creating duplicate module item names.
5. To avoid having duplicate module item names, in the Char. location data field,
type the number of characters from the start of the name string where you want
the substitution to start from.
6. In the No. of chars. data field, type the number of characters in the name string to
be substituted.
7. In the Value field, type a new value that will substitute a part of the module item
name string.
8. If required, set revision copying options.
9. Do one of the following to define the level on which you want to copy the Wiring
module data:
Click Lowest when copying the source and the target <units>
belonging to the same <plant>.
Caution
Make sure to set the copying options for all the required modules and
module items before clicking OK. After you click OK, canceling the
copying process can corrupt the data in the target <unit> and render the
<unit> unusable.
Related Topics
Select Control system tag to name new control system tags according
to target tag names.
Clear Control system tag to name new controls system tags according
to source tag names.
3. Do one of the following to set naming options for device panels:
Select Device panel, and from the Like list, and then select Default to
copy the device cables with the default names (identical with tag
number names) or Naming Convention to copy the device panels with
the naming convention of the target <unit>.
Clear Device panel to copy all device panels without changing the
source names, according to the settings you make for copying wiring
items in the Copy Data from Source dialog box.
4. Clear the Device cable check box to set the naming convention options for device
cables and to copy all device cables without changing the source names,
according to the settings you make for copying wiring items in the Copy Data
from Source dialog box.
Default to copy the device cables with the default names, for
example,
C-<TAG NUMBER>.
Clear Signal name to copy signals according to the settings you make
for copying wiring items in the Copy Data from Source dialog box.
7. Do one of the following to set naming options for wire tags:
Select Wire tag to copy wire tags using target tag names.
Clear Wire tag to copy wire tags according to the settings you make
for copying wiring items in the Copy Data from Source dialog box.
8. Click OK to accept the settings, and return to the Copy Data from Source dialog
box.
Related Topics
Copy all revisions from the source <unit> to the new <unit>.
Create new revisions for the new <unit>. This option allows you to start a
new set of revisions for the copied <unit> data.
Forgo creating any revisions for the target <unit>. This option resembles
the creation of new revisions. You can assign revisions to the documents
in the new <unit>.
1. Start copying the <unit> data and select specific module data from the source
<unit>. For details, see Copy Data from Another Lowest Plant Hierarchy Item.
2. In the left section of the Copy Data from Source dialog box, do one of the
following:
Expand Process Data & Calculation and select specific data (Process
Data or Calculation).
Click All existing to copy all revisions from the selected module data
to the new module data.
5. To set new revisions, click Set new.
Related Topics
Loops
Lines
Process equipment
For each of these item types, the following KKS segment properties are available:
KKS Level
Name
Property
Description
Total Plant
Total Plant
System Code
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
Equipment
Unit Code
Equipment Unit
Classification
Equipment
Unit
Numbering
Equipment
Optional character
Unit Additional (alphabetic).
Code
Property
Description
Component
Code
Component Classification
Component
Numbering
Numbering
Element (for
cables only)
Application Area
Cable Number
(digits 2 and 3)
Two-digit number.
Cable Suffix
Total Plant
This property is a single character (numeric or alphabetic).
System Code
System Code Prefix (optional) Single digit.
System Classification Three-character alphabetic key, selected from a standard
list, that represents the type of system in use the plant.
System Numbering Two-digit number with leading zeros.
Equipment Unit Code
Equipment Unit Classification Two-character alphabetic key, selected from a
standard list, that represents the type of equipment within the system used for
measuring or monitoring the system, or the type of measurement circuit (level, flow,
and so forth).
Equipment Unit Numbering Three-digit number with leading zeros.
Equipment Unit Additional Code Optional character (alphabetic).
Component Code
Component Classification Two-character alphabetic key, selected from a
standard list, that represents the type of component.
Component Numbering Two-digit number with leading zeros.
Value
Total Plant
System Classification
BBA
System Numbering
01
(Not used)
(Not used)
Description
MV distribution board
Value Description
Total Plant
System Classification
PAE
System Numbering
01
Equipment Unit
Classification
CF
001
Component Classification
-B
Component Numbering
01
Transducer
Note
When creating a new instrument, the associated loop inherits the relevant
segments of the instrument names and vice versa. Also, KKS naming is
propagated to cables when you connect them to panels that already have
KKS naming. Cables inherit the KKS naming of the panel whose system
code is first in alphabetic order.
Not all items use all the described segments. For example, DCS and PLC
panels do not use equipment unit code and component code segments.
Marshaling racks, junction boxes, process equipment, and lines do not use
component code segments.
Related Topics
3. In the Domain Definition window, under Domain features, select KKS mode.
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.
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.
Related Topics
Selecting this option does not register the items, but only makes the
item registry commands available on the DBA menu for the Domain
Administrator, who performs all the item registry activities. Note that
the System Administrator has rights to switch the item registry on or
off at any stage of the plant life-cycle. If the System Administrator
switches off the item registry after the items are registered, and then
switches it on again, you must re-register the items. This is required
so that the software can update the references to the items in the item
registry table. When updating the table, the software registers all the
changes that were made to the items in SmartPlant Instrumentation,
including the period when the item registry options were switched off.
Tip
To be able to define an IDEAL user, you must first define a
department.
11. Click File > Close.
Related Topics
When you first define an IDEAL user on a Windows 2003 server, the
Operating System automatically assigns the following policy for that user:
You need to remove the IDEAL user from the above policy list, and then add the
IDEAL user to the following policy list:
Select Create new plant to create an entirely new plant hierarchy with
the same names as the source plant hierarchy items.
Select Correlate plant to create under the selected plant new plant
hierarchy items with the same names as the source plant hierarchy
items.
Tip
If you choose the option Create new plant, you must register the
newly-created plant before you can use it for integration. For details,
see Register a Plant, page 349.
5. On the SmartPlant Foundation Login dialog box, type the appropriate user
name and password.
6. On the Retrieve dialog box, in the Document type list, select All.
7. Under Show, select All documents.
8. Under Documents to retrieve, select the PBS document for the desired plant.
9. Click OK to retrieve the document.
10. At the confirmation prompt, click Close.
11. On the Select Plant dialog box, click Cancel to close the dialog box.
Register a Plant
1. Log on as Domain Administrator and select the desired domain, configured for an
integrated environment.
2. Click SmartPlant > Register.
Important
You cannot unregister a plant after it is registered.
3. On the Select Plant dialog box, select the plant that you want to register.
For example:
http://<SPFServer>/SPFASP.
Tips
You can click the Browse button to search for the node name.
However, you must append the virtual directory to that node name by
typing it in the SmartPlant Foundation URL box.
6. On the SmartPlant Foundation Plant page, select from the Plant name list the
SmartPlant Foundation plant with which you want to register your SmartPlant
Instrumentation plant.
The System Administrator has rights to switch the item registry on or off at
any stage of the plant life-cycle.
Related Topics
Register Items
Important
Prior to registering items, make sure that no users are connected to the
SmartPlant Instrumentation database. It is recommended that you clear all
SmartPlant Instrumentation sessions before performing item registration.
1. Start the Administration module and log on as Domain Administrator.
2. With the Domain Administration window open, click DBA > Data
Maintenance > Register Items.
Note
The System Administrator has rights to switch the item registry on or off
as required at any stage of the plant life-cycle. If the System
Administrator switched the item registry off after you registered the items,
and then switched it on again, you must re-register the items. This is
required so that the software can update the references to the items in the
item registry table. When updating the table, the software registers all the
changes that were made to the items in SmartPlant Instrumentation,
including the period when the item registry options were switched off.
Assign the access rights for Publish and Retrieve (under each registered
plant) to Full (Add / Delete / Update).
Property
InstrTagPrefix
MeasuredVariable+InstrFuncModifier
InstrTagSequenceNo
InstrTagSuffix
Property
LoopPrefix
LoopIdentifier
3
4
LoopSequenceNo
LoopSuff
Segment
Comment
InstrTagPrefix
MeasuredVariable
InstrFuncModifier
InstrTagSequenceNo
InstrTagSuffix
The object name is populated by the tag number with all spaces removed. If the
length of prefix is more than 0, the prefix will be part of the object name. Other
applications that publish instruments (for example, SmartPlant P&ID) need to be
configured to publish the instrument object name with the prefix.
The MeasuredVariable and InstrFuncModifier are both populated be the second
segment. If the first two characters of segment 2 are included in the
TwoLetterMeasuredVariable list that was defined in the SmartPlant Instrumentation
mapping file, then the MeasuredVariable gets these two letters; if not then the
MeasuredVariable gets the first character of segment 2. In both cases, the
Segment
LoopPrefix
LoopIdentifier
2+3
LoopSequenceNo
LoopSuff
The object name is populated by the loop name with all spaces removed. If the length
of prefix is more than 0, the prefix will be part of the object name. Other applications
that publish loops (for example, SmartPlant P&ID) need to be configured to publish
the loop object name with the prefix.
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 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.
In SmartPlant Electrical, you defined a registered report for both the I/O
lists and for Instruments requiring power supply.
SmartPlant Instrumentation Administration Users Guide 361
Rated Voltage
Number of Phases
Operating Mode
Process Function
Frequency
Starting Current
Assign the access right for Project Definition (under Domain Level) to
Full (Add / Delete / Update).
Create one or more projects. For more information, see Domain and
Project Administration > Operating Owner: General Activities > Create a
Project in the SmartPlant Instrumentation Administration User's Guide.
Scope and claim items from As-Built for a project. For more information,
see Scoping Data for Projects: An Overview in the SmartPlant
Instrumentation Administration Guide.
Set the necessary status for the project. For more information, see Set the
Project Status for an Integrated Environment in the SmartPlant
Instrumentation Administration Guide.
Notes
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>
English (default)
French
German
Custom
After the appropriate interface language is added, you can do the following:
Related Topics
The System Administrator must first add the required language to the
database. You can purchase a language that you require as a separate addin.
If you edit the phrases of an interface language that you have previously
imported, you will not be able to revert to the imported interface language.
When editing, make sure that you fill all the fields in the appropriate
column. If you have a field blank, the phrase from the previous interface
language remains after you switch the currently displayed language to the
language that you are editing now. This can result in your interface text
containing phrases or terms in more than one language.
1. Start SmartPlant Instrumentation or the Administration module.
Click Open to navigate to the language file that contains the interface
text.
Tips
You can modify the column sequence, for example, you can compare
phrases more easily by moving two columns closer together. Drag a
column header and drop it in the desired location. Then, click Update
to save the changes to the database. If you want to save the changes to
an external language file and not to the database, do not click Update.
To view the changes, replace the active language with the language
that you have edited. For details, see Replace the Interface Language
with a Language from the Database, page 368.
5. Click Save File to save the edited interface text to a language file (a file with a
.psr extension).
6. Type the path and filename of the language file or navigate to an existing
language file.
7. Click OK in the displayed message and restart SmartPlant Instrumentation or the
Administration module for the changes to take effect.
8. Click OK to save the changes and return to the Edit Translation Text dialog
box.
9. Click Close.
From the Language data window, select the language with which you
want to replace the current interface language.
Clear the Optimize Speed check box to retrieve the interface text from
the database. This frees the memory resources but decreases the
performance.
5. Click OK to close the dialog box and change the interface language.
Related Topics
In the data field, type the path and filename of the appropriate
language file.
Related Topics
The System Administrator must first add the required language to the
database.
The interface text changes take effect only after exiting and re-entering the
application.
1. Start SmartPlant Instrumentation or the Administration module.
Click Open to navigate to the language file that contains the interface
text.
Tips
In the Custom Phrase column, each phrase that you type replaces the
corresponding phrase in the interface text. If you leave a field blank,
the corresponding field in the interface text remains unchanged. Make
sure that you add the same prefixes, suffixes and punctuation marks
that appear in the corresponding original phrases of that interface
language (for example, ~, &). For details, see Prefixes and Suffixes in
the Interface Text, page 370.
7. Type the path and filename of the language file or navigate to an existing
language file.
8. Click OK in the displayed message and restart SmartPlant Instrumentation or the
Administration module for the changes to take effect.
9. Click OK to save the changes and return to the Edit Translation Text dialog
box.
10. Click Close.
Related Topics
Function
Syntax
&
&&
&&
~n
interface
~nContinue?
text]~n[interface
text]
~r
interface
text]~r[interface
text]
Warning~n~r
~t
interface
text]~t[interface
text]
&Action~tCtrl+A
Example
Operators &&
Functions
Description
Saves the access rights definitions in the current domain.
Opens a pop-up window that displays all the available items and the level on
which they are defined.
Opens a dialog box where you can select a user group and grant access rights
globally.
Opens a dialog box where you can copy access rights from plants to plants,
from units to units, or from projects to projects if the domain type is Operating
owner.
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.
Ignore Allows you to display only the current domains in the report.
OK Opens the Print Preview window from which you can view and print out
the report.
Ignore Allows you to display only the current domains in the report.
OK Opens the Print Preview window from which you can view and print out
the report.
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.
The current tablespace datafile path appears by default. Make sure that
you select a datafile which is not currently in use.
Datafile size Allows you to enter the size of the additional datafile.
Admin schema logon name Displays the Admin schema logon name.
Admin schema logon password Allows you to type a new password for the
Admin schema.
Administration Window
Enables you to end the Administration module session or to re-enter the module
either as System Administrator or Domain Administrator. Clicking the toolbar icon
re-opens the Open Administration Module dialog box.
When you clear the Enabled check box for an property in a particular
domain, the user is unable to change the value of that item. If you enable
the same item in another domain and the user logs onto that domain, the
user sees the value that was set in the domain where the property was
disabled, and not the value from the current domain.
We recommend that you do not disable the temporary folder path option.
This is because in the temporary folder, the software creates temporary
files during various activities that users perform in SmartPlant
Instrumentation, for example, when creating specifications, generating
CAD drawings, hook-up drawings, reports, and so forth. If you prevent
users from specifying individual temporary folder paths, the temporary
folder path becomes shared among several users. This can cause problems
with data display when users perform the same activity at the same time,
for example, when creating two specifications at the same time.
Enable all Makes all the preference options available for customization in the
current domain.
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..
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.
Junction boxes Includes all the cables that are connected to junction
boxes.
Device panels Includes all the cables that are connected to device
panel.
DCS panels Includes all the cables that are connected to DCS panel.
PLC panels Includes all the cables that are connected to DCS panel.
Cable associations
Allows you to filter the cables according to their associations.
Fieldbus segment Allows you to filter for cables associated with a specific
Foundation Fieldbus or Profibus segment.
Display telecom cables only Allows you to filter for cables connected to
telecom items.
Related Topics
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.
When you clear the Enabled check box for an property in a particular
project, the user is unable to change the value of that item. If you enable
the same item in another project and the user opens that project, the user
sees the value that was set in the project where the property was disabled,
and not the value from the current project.
Important
We recommend that you do not disable the temporary folder path option.
This is because in the temporary folder, the software creates temporary
files during various activities that users perform in SmartPlant
Instrumentation, for example, when creating specifications, generating
CAD drawings, hook-up drawings, reports, and so forth. If you prevent
users from specifying individual temporary folder paths, the temporary
folder path becomes shared among several users. This can cause problems
with data display when users perform the same activity at the same time,
for example, when creating two specifications at the same time.
Enable all Makes all the preference options available for customization in the
current project.
Copy To Opens the Copy to Projects dialog box, where you can copy the
current project preference settings to other projects in the Operating owner domain.
Copy From Opens the Copy from Projects dialog box, where you can overwrite
the current project preference settings with other project preferences.
Custom Fields Tab (Plant Hierarchy Item Properties Dialog Box), page
390
In CAD drawings
Parent hierarchy (not available for the highest plant hierarchy item) Displays
the plant hierarchy string to which the current item belongs.
The software copies the custom fields (values and definitions) when
copying <unit> data.
Related Topics
When the domain type is Operating owner, the Project Administrator can
define user groups in As-Built and then, when creating a project using the
Project Activities dialog box, copy all the user groups from As-Built
automatically.
To access this dialog box, on the Activities menu, click Assign Users to Groups.
User list Contains all the users created by the System Administrator. To assign a
user to the group displayed in the Group box, select a user name and drag it to the
Group users pane.
Note
You can assign the same user to more than one group.
When backing up a domain, the software does not back up the audit trail
data. Therefore, before performing the domain backup, you must make
sure that you trimmed all the audit trail data. Then, you can back up the
trimmed audit trail data manually. For details, see SmartPlant
Instrumentation Installation and Upgrade Guide, Backup and Restore,
Backing up Files Containing Audit Trail Data.
Database type Displays the source database type: SQL Server or a specific
Oracle version.
Server When using SQL Server, displays the name of the server machine where
the source data is located. When using Oracle, displays your Oracle instance alias.
Database name (only available when the source database type is SQL Server)
Displays your SQL Server database name located on the server machine that contains
the source data.
Administrator schema name Displays the Admin schema logon name of the
SmartPlant Instrumentation database.
Administrator schema password Displays the Admin schema logon password.
Domain Allows you to select a domain for a backup.
Save last created ID for merging renamed items Save the ID of the last created
item in the domain. The software allocates a unique sequential ID to each item that
you create. On merging data at a later stage, if the ID of an item is less than or equal
to the ID of the last created item, this indicates that the item was created in the
database prior to making the backup. Consequently, the Merger Utility is able to
identify the item by its ID, and can update renamed items if required, by selecting the
Include renamed items check box in the Merger dialog box.
If you clear this check box, the Merger Utility ignores any items that were renamed
since the backup, even if you select the Include renamed items check box, and
inserts the items as new records.
In the target database, the domain type is the same as in the source
database.
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.
Import Utility
Merger Utility
The user's sessions in other applications are not affected. After disconnecting a user,
the records of the user's SmartPlant Instrumentation sessions remain in the
CURRENT_INFO table of your server database. If needed, you can manually clear
the session records. For more information, see Clear SmartPlant Instrumentation
Session Records.
Claimed items In As-Built, items that have been claimed for projects.
This category is only available when you select As-Built from the Project
list of the Project Activities dialog box.
Project items In the project that you selected, indicates project items
when SmartPlant Instrumentation users open the current project with AsBuilt items displayed.
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.
If you change a merge action from Merge Now or Release Claim to Merge
Later, the software automatically removes this item from the Merge
Buffer.
If you change the action from Merge Later to Merge Now, the software
does not merge the item but only copies it and the associated sub-items to
the Merge Buffer.
For mode Allows you to select modes where the specified action is to be
applied. The modes refer to the changes made in the current project. The following
modes are available:
Inserted Indicates that a new record was inserted in the current project
which does not exist in As-Built. Deleting an existing record from AsBuilt is also equivalent to this.
Deleted Indicates that an existing record was deleted from the current
project. Inserting a new record from As-Built is also equivalent to this.
Not changed Indicates that the record in the current project is identical
to the record in As-Built.
Data Window The data window columns show various data values for the item,
where changes are indicated by a light blue background.
Lower-Right Section (Copy Data from Source Dialog Box), page 405
Upper-Right Section (Copy Data from Source Dialog Box), page 404
Name prefix Allows you to enter a new name prefix to be applied to all the
copied items of the selected module. When copying data from a <unit> within the
same plant, you have to make sure that you do not have duplicate names for the
module items that you are going to copy. Therefore, you have to modify the module
item names. You can do this by adding either a prefix or a suffix to the item name.
Name suffix Allows you to enter a new name suffix to be applied to all the
copied items of the selected module. When copying data from a <unit> within the
same <plant>, you have to make sure that you do not have duplicate names for the
module items that you are going to copy. Therefore, you have to modify the module
item names. You can do this by adding either a prefix or a suffix to the item name.
Substituting name values To avoid having duplicate module item names, you
can modify their names by changing a part of the name. You can do this by
substituting a part of the name string with the value that you type in the following
fields:
No. of chars. Allows you to enter the number of characters in the name
string to be substituted.
Value Allows you to enter the new value that will substitute the old
one in the name string.
Set new Allows you to click Copy Revisions and open a dialog box
where you can set new revisions for the target <unit>.
All existing Allows you to copy all the revisions that exist in the
selected module.
Copy on plant hierarchy level (for the Wiring module only) Determine the level
on which you want to copy the wiring data. You must select the highest level when
copying data from <units> belonging to different <plants>. This is required because
most wiring data is defined either per <area> or per <plant>. When copying data
from <units> belonging to the same <plant>, you can select the highest or the lowest
(recommended) level of your plant hierarchy. However, if you select the lowest
level, you need to modify the name strings to avoid duplicate names in the Wiring
module. The following options are available:
Lowest Allows you to copy data from <units> belonging to the same
<plant>.
Related Topics
Left Section (Copy Data from Source Dialog Box), page 403
Lower-Right Section (Copy Data from Source Dialog Box), page 405
Make sure that the Copy all module data check box is not selected. This
way you copy only the selected data and not the entire module data. You
can select specific items in the Instrument Index and Wiring modules.
Also, you can use this option to copy only the Process Data module or
only the Calculation module data by expanding Process Data &
Calculation in the left section and selecting a module.
Name prefix Allows you to enter a new name prefix to be applied to all the
copied items. When copying data from a <unit> within the same <plant>, you have
to make sure that you do not have duplicate names for the module items that you are
going to copy. Therefore, you need to modify the item names. You can do this by
adding either a prefix or a suffix to the item name.
Name suffix Allows you to enter a new name prefix to be applied to all the
copied items. When copying data from a <unit> within the same <plant>, you have
to make sure that you do not have duplicate names for the module items that you are
going to copy. Therefore, you have to modify the item names. You can do this by
adding either a prefix or a suffix to the item name.
Substituting name values To avoid having duplicate item names, you can
modify their names by changing a part of the name. You can do this by substituting a
part of the name string with the value that you type in the following boxes:
No. of chars. Allows you to enter the number of characters in the name
string to be substituted.
Value Allows you to enter the new value that will substitute the old
one in the name string.
Revision Copying Options (for process data and calculation data only)
Determine how the software copies revision data. The following options are
available:
Set new Allows you to click Copy Revisions and open a dialog box
where you can set new revisions for the target <unit>.
All existing Allows you to copy all the revisions that exist in the
Process Data or Calculation modules.
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.
Suffix (for loop and tag number data only) Allows you to enter a loop or tag
number suffix to be used in the target <unit>. Use this option when copying loop or
tag number data from a <unit> within the same <plant>. This way you define a
distinctive loop or tag number suffix to be used in the target <unit>.
Notes
For tag number items, the option is accessible only if the ISA or Loop
standard naming convention for the suffix segment description of tags is
COMPONENT SUFFIX. For loop items, the option is accessible only if
the ISA or Loop standard naming convention for the suffix segment
description of loops is LOOP SUFFIX.
If in your source unit there are loop names or tag numbers which are
different only in the suffix segment, these loop names and tag numbers
become identical in the target <unit>, for the new suffix value in the target
unit overwrites all the suffix values of the source <unit>.
For example, if in the Suffix box, you type 5, loop names 101-F-100\1,
101-F-100\2, 101-F-100\3 in the source <unit> become 101-F-100\5 in
the target <unit>.
Related Topics
Left Section (Copy Data from Source Dialog Box), page 403
Upper-Right Section (Copy Data from Source Dialog Box), page 404
<Plant> Contains highest plant hierarchy level items in which you can make
custom field definitions. The label <Plant> changes dynamically according to your
highest plant hierarchy level definition.
Item type Contains item types and data types which you can select for defining
custom fields. When you define custom fields per item/data type, these fields become
available for selection in certain browsers. For a list of these browsers, see Browsers
That Can Contain Custom Fields.
You can select a plant hierarchy level name as an item and modify the default custom
field definitions for each of the twenty custom fields. A custom field definition is a
label that appears in the Custom Fields Tab (Plant Hierarchy Item Properties Dialog
Box). The default label is Custom field<number incremented from 1 to 20>.
The Item type list contains all the names of the plant hierarchy levels you created in
the Plant Hierarchy dialog box. The default hierarchy is Plant, Area, and Unit.
Items on each plant hierarchy level can contain up to twenty custom field values.
However, when modifying a custom field definition, the software applies the changes
at the hierarchy level to which the item belongs. For example, you can select Plant
and for Row Number 1, enter text My Custom Fields for PlantA. In the Custom
Fields tab of the <Plant> Properties dialog box, for the first custom field, the
software displays My Custom Fields for PlantA instead of the default definition
Custom field 1.
For process data custom fields, the values in the Number column do not
correspond to the custom fields sequentially. For details, see Sequence
Numbers and Process Data Custom Fields.
Visible (only available when you select Process Data from the Item type list)
Enables or disables custom fields used in process data sections.
Section Name (only available when you select Process Data from the Item type list)
Displays the default custom field definition in process data sections.
Definition Allows you to type a definition to be used as a new default definition
in SmartPlant Instrumentation.
Notes
When defining a browser view style, users can modify the definitions that
you make.
In 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.
At the first stage, from the Logon Information dialog box, you click OK
to enter the Administration module as System Administrator, where the
software prompts you to upgrade the Admin schema and then opens the
Database Upgrade dialog box.
To access this dialog box, with the System Administration window open, on the
DBA menu, click Delete Invalid Domain.
Domain Contains a list of corrupted domains and allows you to select a domain
for deleting.
OK If the database platform is Oracle, the software begins the deletion process.
If the database platform is SQL Server, the software prompts you to check your
selection first.
Note
Instrument type change Allow you to set the default action for dimensional data
when a tag number's instrument type has been changed (in cases where dimensional
data exists for the instrument type). The following options are available:
Delete dimensional data Allows you to ensure redefinition of the dimensional
data associated with the tag number after its instrument type has been changed.
Mark data as suspected Keeps the dimensional data and marks it as suspected.
Description
Closes the Domain Administration window.
Opens the Domain Definition window, where you can grant access rights,
select the domain logo, and so forth.
Opens the Project Activities dialog box. This icon is only available where the
domain type is Operating owner.
Opens a dialog box where you can define ownership of plants.
Opens a dialog box where you can define naming conventions for various
items.
Opens a window where you can define plant hierarchy items for each
hierarchy level available in the current domain.
Opens the Custom Fields dialog box, where you define custom fields for an
Instrument Index Standard Browser view.
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.
KKS mode Indicates whether KKS naming conventions are enabled by the
System Administrator.
Rule Manager Indicates whether the use of Rule Manager is enabled by the
System Administrator.
Description
Saves the changes made to the logo or notes.
Opens the Select Logo dialog box to select a different logo for the current
domain. When the domain is Operating owner, this icon is not available. A
Project Administrator needs to open the Project Activities dialog box, and
click the Logo button to define a project logo.
Makes the Notes box accessible for editing.
Opens the Access Rights window to grant or modify user access rights.
If you want only one user at a time to work with the same item, you must
clear this check box. This way, when a user starts working with a specific
item, the software locks the item for other users.
Default plant use Allows you to enable or disable the use of the default plant in
the current domain. If you clear this check box, the plant DEFAULT and all its
hierarchy levels do not appear in the Plant Hierarchy Explorer. You can switch the
use of the default plant on or off when making or modifying domain definitions.
Important
KKS mode Activates propagation of KKS names when KKS naming conventions
are used in the project.
Rule Manager Allows consistency and GUI rules created by Rule Manager to be
used in the project. For more information, see SmartPlant Instrument Rule Manager:
An Overview in the SmartPlant Instrumentation User's Guide, under Using Rule
Manager, SmartPlant Instrument Rule Manager: An Overview.
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.
Description
Saves the definitions of the selected domain.
Upgrades your database after installing a new version of SmartPlant
Instrumentation. This icon is available only if the version of the domain you
selected from the Domain list is different from the Administration version.
Makes the options in this window accessible for editing.
Deletes the current domain and all the database tables associated with the
domain. This operation is irreversible, therefore it is recommended that you
back up a domain before deletion. For more information, see Back up a
Domain.
After domain deletion in Oracle, a message appears with the list of physical
tablespace datafiles that need to be deleted physically from the disk. If a
rollback segment problem occurs, the software displays an appropriate error
message. In this case, you need to restart the deletion process. For more
information, see Delete a Domain.
After domain deletion in SQL Server, the devices are left in place connected to
the database, and can be used for a new domain.
Domain Displays the name that you specified in the Initialize dialog box.
Domain data
Tablespace name Accept the displayed value or type an appropriate domain
tablespace name.
Datafile name and path Accept the displayed value or type the full path and
name of the domain tablespace database file. The default file extension is .dbf. You
can change the file extension as you require.
Tablespace size (MB) Accept the displayed value or type the required domain
tablespace size.
Index data
Tablespace name Accept the displayed value or type an appropriate index
tablespace name.
Datafile name and path Accept the displayed value or type the full path and
name of the index tablespace database file. The default file extension is .dbf. You
can change the file extension as you require.
Tablespace size (MB) Accept the displayed value or type the required index
tablespace size.
OK
Starts the initialization process.
Make sure that you do not leave any blank fields, as the previous existing
interface language will remain in those fields after switching to the
language you are currently editing. By not leaving blank fields, you
prevent the occurrence of phrases belonging to more than one language
appearing in the interface.
Find phrase Allows you to type a text string that you want to find in the data
window. Press the ENTER key to execute the search.
Command Buttons
Retrieve Retrieves the interface text from the database. This button becomes
disabled after the interface text is retrieved.
Open Allows you to navigate to the language file from which the interface text
will be automatically retrieved. This button becomes disabled after the interface text
appears in the dialog box.
Update Saves the changes to the database. To view the changes, switch to the
appropriate language using the Select Language dialog box.
Save File Saves the data in an external language file.
In a project, access rights granted on the domain level do not apply. If you
want to grant access rights to a group assigned to a project, you must also
assign this group to As-Built.
Project Allows you to select a the project for which you can edit access rights.
Select all Allows you to select all the items and activities available in the data
window. This way, you set the software to display all the available items and
activities in the Access Rights window.
Data Window
Display Sets the software to display of a particular item in the Access Rights
window.
Item name Displays an inventory list of the items that exist within a particular
project. You can click the header to display the items in alphabetical order.
Item level Displays the level of a particular item: the whole project, or just to a
specific unit or plant. You can click the header to display the items by level.
Selected node definition Filters the child items that belong to a folder
or the items at any hierarchy level that you selected in the Explorer tree
view.
Global definition Allows you to define a filter for the entire tree view
of the active Explorer. The software applies this definition to the item
type you selected. Note that if you defined a filter definition for a specific
folder, the filter for the folder override the settings for the global filter
definition.
Property Allows you to select a property to use for filtering the items.
Value Allows you to select or type a required value for the item you
selected under Property. The available values depend on the specific
property that you select.
Logic You use this option when you specify more than one filter
condition. The option allows you to select the required logical operator
(And or Or) to determine how the next filter expression will relate to the
current expression. When you have a mixture of logical operators for
several conditions, the software performs the expressions on the
conditions in order, for example:
(A and B) or C
(A or B) and C
Note
Command Buttons
Add Adds a new line for specifying a filtering condition.
Delete Deletes the selected filtering condition.
Verify Verifies the correctness of the entire filtering expression.
Reset Removes all filtering conditions so that you can re-enter a new filter
definition.
Advanced Allows you to define a special filter for cables or loops.
Related Topics
Full (Add / Delete / Update) Allows group users to add, delete, and
modify data for the selected item.
Modify (Add / Update) Allows group users to add and modify data for
the selected item and group. Deletion is prohibited..
View Only Allows group users to view data for the selected item, but
cannot edit it in any way.
Access Denied Indicates that group users has no access to the selected
item. You apply this mode at the domain level to deny access to an entire
module, feature, or activity.
Group name Allows you to select a target user group for applying the access
mode you have set in the Access mode list. Also, you can select All to apply the
access mode to all the users in the current domain.
Domain level access rights
Enable item selection Allows you to apply the access mode to a specific item or
to all items belonging to the domain level.
Item Allows you to select a domain level item for which you want to grant global
access rights, according to the specified access mode. Also, you can select All to
grant access rights for all the items belonging to the domain level.
This option only takes effect after the System Administrator enables the
use of Windows authentication logon method.
You can import only those predefined browser views that have been
purchased for an additional fee.
Source database
File name and path Allows you to specify the source database file. You can
type the file name and path or click Browse. The default file is IN_CTLOG.DB.
Connect Connects to the source database file.
Miscellaneous Options
Target plant Allows you to select the plant to which you want to add the
imported predefined browser views.
View Displays all available predefined browser views after you click Connect.
Select a view and click Import.
Import Imports the selected predefined browser views from the source database
file to your database. This button becomes accessible only after you click Connect.
These libraries are add-ins that are supplied for an additional fee.
Source database
File name and path Allows you to specify the source database file. You can
type the file name and path or click Browse. The default file is IN_CTLOG.DB.
Connect Connects to the IN_CTLOG.DB file and displays the available panel
library in the Select panel library data window.
Miscellaneous Options
Select panel library Displays the available panel libraries after you connect to
the IN_CTLOG.DB file. Select the panel library that you want to add to your
database.
Import Imports the selected panel library to the database.
If the selected .txt file does not contain typical tags, do not select the
Include typical tags check box.
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).
Note
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).
Note
If you do not want a log file to be created, clear the Log file name and
path box.
Sample Shows a preview of the naming convention that you have just defined.
Each group of characters depicts a different part of the name. The separators appear
as selected.
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.
Note
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.
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.
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.
Add Adds an empty row at the bottom.
Before starting the optimization process, make sure that the currently
selected domain is not used by another user. If you attempt to optimize
the indexes in a domain currently used by another user, an appropriate
message is displayed.
To access this dialog box, with the System Administration window open, on the
DBA menu, point to Tuning and click Optimize Indexes.
Domain Name Allows you to select the domain in which you want to optimize
indexes.
All tables Sets the software to optimize the indexes of all tables displayed in the
data window.
Selected tables Sets the software to optimize the indexes of the tables that you
select in the data window.
Data Window Contains the table and index names. The Fragmentation column
displays the number of Extents of each index. Select the tables whose indexes you
want to optimize.
Note
Before starting the optimization process, make sure that the currently
selected domain is not being used by another user. If you attempt to
optimize the indexes in a domain which is in use, an appropriate message
is displayed.
To access this dialog box, with the System Administration window open, on the
DBA menu, click Optimize Indexes.
Domain Allows you to select the domain that contains the tables whose indexes
require optimization.
Objects Allows you to define the tables to be included into the optimization
process. The following options are available:
All tables Optimizes the indexes of all the existing tables in the defined
domain.
Index source Allows you to define the index source on which you want to base
the optimization. The following options are available:
Table Name After you click Selected tables, displays the table names in the
defined domain and allows you to select the tables you want to include in the
optimization process.
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.
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 that 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.
Insert Inserts a new level above the level that you select. You can only use this
option before creating the first plant in the Plant Hierarchy Explorer.
Delete Deletes a level that you select. You can only use this option before
creating the first plant in the Plant Hierarchy Explorer. You can delete any level,
as long as the minimum of three levels remains in the dialog box.
After creating a first <plant>, you cannot change the plant hierarchy levels
that you defined in the Plant Hierarchy dialog box. Therefore, it is
recommended that prior to defining plant hierarchy items in the Plant
Hierarchy Explorer, you create all the plant hierarchy levels that you
require. If you need to change the plant hierarchy levels after defining
<plants>, you must first delete all the <plants>. To delete a <plant>, you
need to open the <Unit> dialog box, where you can delete units. The
software deletes a plant when you delete the plant's last <unit>.
Notes
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.
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.
After creating a first <plant>, you cannot change the plant hierarchy levels
that you defined in the Plant Hierarchy dialog box. Therefore, it is
recommended that prior to defining plant hierarchy items in the Plant
Hierarchy Explorer, you create all the plant hierarchy levels that you
require. If you need to change the plant hierarchy levels after defining
<plants>, you must first delete all the <plants>.
If you use three plant hierarchy levels (that is, the default number of levels), you can
also use the DEFAULT plant options, provided that the System Administrator has
enabled the use of the default plant. The DEFAULT plant has the following
hierarchy levels: Plant, Area, and Unit.
<Plant> Allows you to enter or modify the name of the highest level item in the
current plant hierarchy node. The name must be unique within the current domain.
The name must contain at least one character that is not space. The maximum name
length is fifty characters.
Address 1 / Address 2 / City / State / Zip code / Country Allow you to enter
the <plant> address details.
Site name Allows you to enter the name of the site where the <plant> is located.
Owner Allows you to select the <plant> owner from the list. You define this list
in the Owner dialog box.
ANSI / ASME
ANSI / DIN
Other
These values affect the values that the software assigns to certain properties on the
Line Properties dialog box in SmartPlant Instrumentation.
Do not propagate wire tag names Allows the software to suppress the tag
number naming propagation along the signal path this way SmartPlant
Instrumentation users can customize wire tag names along the propagated signal path.
If you clear this check box, the software propagates wire tag names this way, all
the wires along the propagated signal path are named according to the tag number
from which the signal originates.
Note Allows you to enter a short note. To insert a carriage return, press Ctrl +
Enter.
Related Topics
Custom Fields Tab (Plant Hierarchy Item Properties Dialog Box), page
390
In CAD drawings
The software copies the custom fields (values and definitions) when
copying <unit> data.
Related Topics
The following table shows the related data or items that the software can claim,
merge, or include in the buffer for claiming or merging items when you select a main
item belonging to a specific item type.
Main Item
Loop
Instrument
Wiring item
(panel, rack,
wiring
equipment, and
so forth
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
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.
Sub items Allows you to claim, merge, or move to buffer the associated subitems. 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.
Note
When you select a tag for claiming or merging, the basic engineering data
is selected automatically. You cannot claim or merge a specific
instrument, process data sheet, and so forth. Engineering data is only
displayed within the SmartPlant Instrumentation environment.
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 in
the As-Built or Project Explorer.
Tags and loops with lowest level sub-items only Only available after you select
Wiring data of tags and loops. Allows you to claim, merge, or copy to the buffer
only the terminals and wires that have a signal propagated to the tags and loops you
select for claiming or merging. The intermediate sub-items are processed as dummy.
Wiring equipment sub-items Only available after you select Wiring data of
tags and loops. Allows you to claim, merge, or copy to the buffer all the wiring
items that are associated with wiring equipment. For example, if you claim a tag
associated with an apparatus, the software also claims all of the sub-items associated
with the apparatus.
If you selected a loop or tag, and also selected the Wiring data of tags
and loops check box, the Wires connected to terminals check box does
not apply to the wiring items associated with the loop or tag. In this case,
the software always claims, merges, or copies to the buffer all the wires
that have signal propagated to the tag.
Related Topics
Preferences for Scoping and Merging Data Dialog Box, page 468
These options only apply to revisions for documents that the software
claims automatically, together with the associated items that you select.
These documents are process data, calculation, calibration, and
dimensional data sheets, specifications, and loop drawings. These options
do not apply to documents that you can select in the As-Built Explorer or
Source Project Explorer.
Copy revision data Includes revision data of the documents associated with
items that you claim.
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:
claim<project ID number>_<incrementing number>, for example,
CLAIM21215_12.
The incrementing number of the file name is incremented by one each
time you claim items. This way, you do not overwrite the previous .zip
file. All the individual .psr files are overwritten automatically after each
claim session.
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, this preference does not apply.
Related Topics
Preferences for Scoping and Merging Data Dialog Box, page 468
Merge option for revisions Allows you to select a desired option to specify how
to process revisions when merging data. This list contains the following options:
Ignore Does not merge revisions associated with the items. If you
select this option, you cannot generate Changed Documents reports (report
generation is available from the Project Explorer).
Copy Deletes revisions that exist in As-Built and then copies revisions
from the current project. This option does not allow you to generate
Changed Documents reports.
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.
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.
Preferences for Scoping and Merging Data Dialog Box, page 468
If you do not use the advanced options but only modify the preferences
settings on the Preferences dialog box page, apart from you, none of
new or existing users receive the modified settings when they log on to
SmartPlant Instrumentation.
If the domain type is Operating owner, you set the domain preferences in the
following two stages:
1. Before you create projects, on the Preferences dialog box, under Project, you
select DEFAULT PREFERENCES, and then, define default preferences on the
various pages of the dialog box.
2. Then, you click Advanced and clear the check boxes for the preferences that you
defined. The software automatically copies the default preferences to any new
project that you create. These preferences become the preferences of new and
existing users in the project they log onto.
Managing preferences involves the following operations:
To open the dialog box, start the Administration module and enter as Domain
Administrator, and then on the Activities menu, click Preferences Management.
Project When the domain type is Operating owner, allows you to select As-Built
or an existing project from the list. If you do not have any projects yet, you can select
DEFAULT PREFERENCES, and then, define default preferences first. After that,
you click Advanced and clear check boxes for those preferences that you defined.
When you create projects, they receive automatically the default preferences that you
defined.
Domain (available only when your domain does not support the As-Built
functionality) Displays the current domain name in this read-only box.
Tree view Contains the SmartPlant Instrumentation module names and the
options associated with the modules. Click beside a desired module to expand the
hierarchy, and then click an option to open a specific page where you can set the
default preferences for each module in your domain.
Pages The options on the pages allow you to modify preferences for the current
domain or project, but individual users who work in this domain or project will be
able to view and overwrite these preferences with their own settings within the
SmartPlant Instrumentation environment. To prevent individual users from changing
the default preferences that the Domain Administrator has set for each SmartPlant
Instrumentation module in the domain or project, click the Advanced button, and
then clear the Enabled check box for the appropriate preferences options.
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.
Related Topics
Set the default locations of the main toolbar and the module toolbar.
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. To
hide the toolbar, clear the check box.
Show toolbar text Displays text with the icons in the currently selected toolbar.
To hide the text, clear the check box.
Top Places the selected toolbar along the top of the screen right under
the menu bar.
Bottom Places the selected toolbar along the bottom of the screen.
Right Places the selected toolbar along the right edge of the screen.
Left Places the selected toolbar along the left edge of the screen.
Ask user (default) Sets the software to prompt you to open a report
print preview before printing.
Mark changes only Sets the software to mark the changes in the print
preview of a new report, if the currently previewed report is different from
the archived report.
Mark changes and generate changes report Sets the software to both
generate a changes report after comparing a new report with an archived
report and mark the changes in the print preview of the new report.
Temporary folder path Enables you to specify the path to the SmartPlant
Instrumentation temporary folder where the temporary logo and custom files are
stored. Click Browse to navigate to the path.
For example:
C:\Program Files\SmartPlant\Instrumentation\Temp
In the temporary folder, the software creates temporary files during various activities
that you perform in SmartPlant Instrumentation, for example, when you generate
specifications, reports, CAD loop or hook-up drawings, and so forth.
Notes
In the Specifications module, when you generate the Spec Forms report,
the software generates the report as the specprn.psr file and saves this file
to the folder you specify in the Temporary folder path box. If you leave
this box blank, the software saves the specprn.psr file to the SmartPlant
Instrumentation home folder.
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.
PDF generator Enables you to select the .pdf file generator that you installed for
generating IDEAL reports. Available options are: Acrobat Distiller and Generic
PostScript Printer. Selecting a .pdf generator also allows SmartPlant
Instrumentation users to save specification sheets and specification binder packages
as .pdf files.
Output document folder Enables you to specify the path to the folder where the
software generates IDEAL report files. Click Browse to navigate to the path.
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.
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.
When defining a project scope, this dialog box displays the items you can
claim from the Claim Buffer.
When merging project data with As-Built, this dialog box shows the items
you can merge from the Merge Buffer. Also, you can open this dialog
box to generate reports available on the Reports menu of the Project
Explorer.
Pages Allows to navigate back and forward through a multi-page report using the
arrow buttons.
Show items (only available when claiming items for a project) Determines
whether you can display claimed items or items copied to the Claim Buffer.
Claimed Displays only items that were claimed for the project.
Not claimed Displays only items that appear in the Claim Buffer, but
have not yet been claimed for the project.
Reports If you selected more than one item type, allows you to navigate back
and forward between each item type report using the arrows.
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.
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.
Do not propagate wire tag names Suppresses the tag number name propagation
along the signal path. This way, users can customize wire tag names along the
propagated signal path.
Note
If you clear this check box, the software can propagate wire tag names.
This means that all the wires along the propagated signal path will be
named according to the tag number from which the signal originates.
Notes Allows you to enter notes or comments for the current project or As-Built.
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.
You can use this option either to restore project data backed up to the
INtoolsAB.db database, or import an off-site project from a source
domain. For details about backing up and restoring projects, see Backing
Up and Restoring Projects: An Overview, page 78. For details about offsite projects, see Off-Site Project Creation and Implementation: An
Overview, page 172.
Export Opens a dialog box where you can connect to the INtoolsAB.db
database, and back up the current project data to the Operating owner domain
supplied with the INtoolsAB.db database.
Caution
We do not recommend that you use the project Export option to create an
off-site project. This option is not intended for off-site engineering but
only for backing up a specific project in an Operating owner domain. The
use of the Export option for engineering changes may result in severe data
integrity violations in the master database. If you want to work with
project data, you need to back up the entire domain, using the System
Administration window option File > Backup.
Make sure that all SmartPlant Instrumentation users have logged out of the
database before you start rebuilding the default views.
Note
Domain Allows you to select the domain in which you want to rebuild the
default views.
View-Only Domain schema password Allows you to enter the logon password
of the View-Only Domain schema. You must specify the password you set for the
View-Only Domain schema when initializing the current domain. If you did not
change the password when initializing the current domain, enter the default logon
password, which is <Domain schema logon name>_VIEW.
Note
Make sure that all users have logged out of the database before starting
this procedure. When you start rebuilding stored procedures and triggers,
no users should attempt to log on to SmartPlant Instrumentation.
Important
This procedure should only be carried out when you are specifically
instructed to do so by Intergraph Support.
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.
Title Block Location Displays the location of the title block in the report.
If, in the Report Name column, you selected Specification but the list of
options in the Title Block Customization column is disabled, this means
that the System Administrator, in the Domain Definitions window,
selected the block assignment method Special (used in the Specifications
module only). In this case, SmartPlant Instrumentation users can associate
individual title blocks with specifications using the options available in the
Specifications module itself.
Save Document Data Allows you to save all revision data for all reports of the
specified type when using the Changed Documents feature (accessed from the Tools
menu in SmartPlant Instrumentation. If you clear the check box, the software
performance is improved when creating revisions. Clearing this check box does not
affect the report comparison functionality (which is controlled by the Archiving
Option settings).
Archiving Option Allows you to assign an archiving option to a particular
report, needed if you want to enable report comparison. The following options are
available:
Do not save (not available for the Document Binder module reports)
Sets the software not to keep a revision archive. After saving the report
revision, SmartPlant Instrumentation users cannot see the information
contained in that report at the time of revision, and the report comparison
is not available. This is the default selection.
Archive Path Allows you to define a different path for a specific report to be
saved as a file, or compressed as a .zip file. You can use this option in addition to
defining the default archiving path.
When selecting the archiving options Save as File, or Compress as Zip file, click
and enter a path.
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.
Default archive path
Path Allows you to enter the default archive path for all the report revisions to be
saved as files, or compressed as .zip files. Using this option enables you to specify a
path for your report revisions only once, provided that you do not specify a path for
that report in the Archive Path column of the data window.
Browse Allows you to navigate to a path that you want to set as the default
archive path.
To open this dialog box, on the Project Activities dialog box, select a project or
define a new project name, and then click Reserve.
Tag Numbers Tab (Reserve Tags and Loops Dialog Box), page 495
Loop Numbers Tab (Reserve Tags and Loops Dialog Box), page 495
You can only select <units> that do not contain claimed items. For the
units that already contain claimed items, you cannot clear the Include
check box.
Continue Depending on the claim source, opens one of the following set of
windows:
If the claim source is a project, opens the Source Project Explorer and
Target Project Buffer. You can either copy items to the Target Project
Buffer or claim items from the Source Project Explorer or Target
Project Buffer.
Current highest plant hierarchy level The <plant> that you selected
in the Project Activities dialog box.
Current lowest plant hierarchy level The <units> that belong to the
<plant> that you selected.
Item properties Allows you to specify item properties so that the software looks
for items with the specified properties only.
Property Allows you to select an existing property from the list. For
example, to search for loop numbers assigned to a specific loop drawing
generation method, select the Generation method property.
If you clear this check box, each user must provide a personal SmartPlant
Instrumentation user name and password when logging on to SmartPlant
Instrumentation.
Select Plant
Allows you to select a plant for registering with SmartPlant Foundation.
Plant - Lists the available plants for selecting.
Select Plant
Allows you to select a plant for retrieving documents. The software uses the
information in these documents to build a new plant hierarchy in SmartPlant
Instrumentation that matches the source plant structure.
Plant - Lists the available plants for selecting.
Create new plant - Instructs the software to generate tasks for creating a completely
new target plant hierarchy.
Correlate plant - Instructs the software to generate tasks for creating a target plant
hierarchy under an existing plant.
For more information about the Admin schema and other SmartPlant
Instrumentation database schemas, see Installation Guide, SmartPlant
Instrumentation Database Technical Review > Logon Data and Database
Connection Security.
When the claim source is a project, the source and target projects must be
carried out in the same <plant>.
OK Opens the Scope Definition dialog box, where you select the <unit> in the
target project <plant> before proceeding to defining a scope of items for the project.
You can only export data from a single project to the INtoolsAB.db
database. Therefore, before exporting data, we recommend that you
rename INtoolsAB.db to <Master>.db, and then, for each export process,
make a copy of the <Master>.db database with the name INtoolsAB.db.
After exporting project data, you should rename INtoolsAB.db. For
example, if your source project name is Project1, you can rename
INtoolsAB.db to Project1.db.
To access this dialog box, in the Project Activities dialog box, select a project and
click Export.
Target database name and path Allows you specify a target database. Click
Browse to select the database.
Connect Connects to the target database.
Domain Allows you to select the Operating owner for project creation.
Log File Opens a dialog box where you can define the log file name and path.
Click this button after connecting to the target database, and before exporting data.
Export Starts the project data export process.
SQL Server 2000 You can select it as a source if the target database is
in Sybase Adaptive Server Anywhere, or SQL Server 2000. If the target
database is in SQL Server 2005, you can select SQL Server 2000 only if
the current machine has two SQL Server client installations: SQL Server
2000 client and SQL Server 2005 client.
SQL Server 2005 You can select it as a source if the target database is
in Sybase Adaptive Server Anywhere, or SQL Server 2005. If the target
database is in SQL Server 2000, you can select SQL Server 2005 only if
the current machine has two SQL Server client installations: SQL Server
2000 client and SQL Server 2005 client.
You can only select the same platform as the target database where you
are creating the new domain, or alternatively, you can initialize the
domain using a Sybase Adaptive Server Anywhere database file as a
source. If you want to perform a cross-platform initialization, you must
first initialize a domain from either Oracle or SQL Server in an
intermediate database file in Sybase Adaptive Server Anywhere, and then
use this .db file as a source for initializing a new domain in the target
database platform.
Database file name and path (only available when the source database type is
Sybase Adaptive Server Anywhere) Allows you to click Browse and specify the
.db file to be used a source for initializing a domain in Oracle, SQL Server, or Sybase
Adaptive Server Anywhere.
Server (only available when the source database type is Oracle) Allows you to
type your Oracle instance alias.
ODBC profile (DSN) (only available when the source database type is SQL Server)
Allows you 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.
Admin schema name Displays the SmartPlant Instrumentation database schema.
When your source database is Oracle or SQL Server, you can type the appropriate
Admin schema name of the source SmartPlant Instrumentation database. you can
type the appropriate Admin schema name of the source SmartPlant Instrumentation
database. Sybase Adaptive Server Anywhere, this box displays the default setting
IN_DBAMN. Accept the displayed default Admin schema logon name IN_DBAMN
or type the required logon name.
Notes
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.
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.
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.
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.
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.
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.
for
A new icon can only appear after a SmartPlant Instrumentation user creates a telecom
tag belonging to the device type to which you have assigned the icon.
Telecom Device Type Displays all the telecom device types defined in the
current domain. Users can manage telecom device types in the Instrument Index
module.
Description Displays the telecom device type description.
Icon File Name and Path Displays the icon assigned to the telecom device type.
You can click Browse to assign the appropriate icon. If you do not assign any icon,
the software uses the default icon.
Note
You can only select icon files with the extension .ico.
If you change the number of an existing <Unit>, and then, click OK, the
software displays a prompt message in which you can click Yes to update
all existing tag and loop numbers or click No do cancel the change to the
<Unit> number. If you click Yes, you are then prompted to update control
system tag numbers. If your instruments and loop naming conventions in
the current <Unit> include the <Unit> number segment, the software
updates this number automatically. When you open the current <Unit> in
SmartPlant Instrumentation, you can see that all the existing tag and loop
numbers have been updated accordingly. The document numbers
associated with instruments or loops are not updated.
Note Allows you to enter a short note for the current lowest plant hierarchy level
item.
Copy From Opens a dialog box where you select a source lowest plant hierarchy
level item for copying data to the current item.
Related Topics
Custom Fields Tab (Plant Hierarchy Item Properties Dialog Box), page
390
In CAD drawings
Parent hierarchy (not available for the highest plant hierarchy item) Displays
the plant hierarchy string to which the current item belongs.
<Current plant hierarchy item> Displays the plant hierarchy item for which
you opened the Properties dialog box.
Custom fields from 1 to 15 Allow you to enter up to fifty characters in each box.
You can edit the definitions above the boxes using the options in the Custom Fields
dialog box. The default definitions are Custom field 1, Custom field 2, and so
forth.
Custom fields from 16 to 20 Allow you to enter up to one hundred characters in
each box. You can edit the definitions above the boxes using the options in the
Custom Fields dialog box. The default definitions are Custom field 16, Custom
field 17, and so forth.
Note
The software copies the custom fields (values and definitions) when
copying <unit> data.
Related Topics
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.
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).
Note
Enable or disable the use of wire end naming conventions in the Wiring
module
To open the dialog box, with the Domain Administration window open, on the
Activities menu, click Wire End Naming Conventions.
Data Window Displays all wire end naming conventions defined by the Domain
Administrator. Select a naming convention that you want to edit, duplicate, or delete.
Enable using wire end naming conventions Enables users to assign wire end
naming conventions to wires or group of wires in a particular cable.
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.
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
FT 0001TS 1.
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.
Default Copies the device cables with the default names (identical with
tag number names).
Clear this check box if you want to copy all device panels without
changing the source names. In this case, the copied device panels are
named according to the settings you make for copying wiring items in the
Copy Data from Source dialog box.
Device cable Allows you to set new names for the target device cables by
selecting an option from the Like list.
Like Allows you to select one of the following options for copying device cable
names:
Default Copies the device cables with the default names, for example,
C-<TAG NUMBER>.
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.
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%
OK Displays the report print preview with the magnification that you selected.
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.
Notes
The As-Built Explorer opens and closes together with the Claim Buffer,
and the Claimed Items window.
You can claim items directly from the As-Built Explorer only if the
Claim Buffer is empty.
Views
Toggles through each view of the items in the Items pane. You can
click the arrow and select the desired view.
Opens the Find Item dialog box where you can look for a specific item
Find
in the tree view.
Expand a folder to display the items. If you cannot expand a folder, that
folder is empty.
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.
Notes
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.
Views
Toggles through each view of the items in the Items pane. You can
click the arrow and select the desired view.
Find
Opens the Find Item dialog box where you can look for a specific item
in the tree view.
Expand a folder to display the items. If you cannot expand a folder, that
folder is empty.
To perform an action, right-click the highest hierarchy node (the Claim Buffer node),
and then click a command.
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.
Claimed Items
Displays items that you have claimed from the current project. The displayed items
are view-only. 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 . For a full list of available item indicators, see Item Indicators, page 544.
Notes
The software only displays those items that you have claimed for the
current project.
The Claimed Items window opens and closes together with the As-Built
Explorer, and the Claim Buffer.
Related Topics
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 wither 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. For details, see Actions for Merging Items, page
235. You can either change a merge action for a specific item or for all items and
sub-items in batch mode, regardless of the item type. After you copy the items, it is
possible to merge all the items available in the Merge Buffer.
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.
Toggles through each view of the items in the Items pane. You can
Views
click the arrow and select the desired view.
Find
Opens the Find Item dialog box where you can look for a specific item
in the tree view.
Tree View Pane
The tree view pane shows instrumentation items organized by folders. SmartPlant
Instrumentation defines standard folders in the database. You cannot move or delete
these folders, nor can you add new folders. Each folder contains a particular item
type, and the options available on the menus depend on the currently selected item
type.
Expand or collapse the hierarchy by clicking the + and - icons respectively or by
double-clicking a folder.
After you double-click the top level of your plant hierarchy, the tree view shows the
folders and the next level of the plant hierarchy. You can navigate to the items that
you need by doing one of the following:
Expand a folder to display the items. If you cannot expand a folder, that
folder is empty.
To perform an action, right-click the highest hierarchy node (the Merge Buffer node),
and then click a command.
Item status indicators As in the Project Explorer, the software uses various
icons beside items to indicate the status of items, for example a dummy item is
marked with the indicator . For a full list of available item indicators, see Item
Indicators, page 544.
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.
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.
Notes
The Project Explorer opens and closes together with the Merge Buffer.
You can merge items directly from the Project Explorer only if the
Merge Buffer is empty.
Views
Toggles through each view of the items in the Items pane. You can
click the arrow and select the desired view.
Find
Opens the Find Item dialog box where you can look for a specific item
in the tree view.
Expand a folder to display the items. If you cannot expand a folder, that
folder is empty.
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.
Views
Toggles through each view of the items in the Items pane. You can
click the arrow and select the desired view.
Opens the Find Item dialog box where you can look for a specific item
Find
in the tree view.
Expand a folder to display the items. If you cannot expand a folder, that
folder is empty.
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.
Expand a folder to display the items. If you cannot expand a folder, that
folder is empty.
To perform an action, right-click the highest hierarchy node (the Claim Buffer node),
and then click a command.
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.
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.
Example 2:
Example 3:
Example 4:
Index
Index
access rights
all items, 271
assigning users to groups, 97
common tasks, 94, 259
copying, 274
creating a group, 95
deleting groups, 96
descriptions, 260
editing a group, 96
overview, 258
project administrators, 159
removing users from groups, 98
report, 275, 309
specific items, 270
viewing items on levels, 274
workflow, 272
accounting
adding, 140
associating with a domain, 143
common tasks, 140
deleting, 140
editing, 140
activity tracking
clearing data, 116
common tasks, 115
graph-style activity report, 118
grid-style activity report, 117
setting, 116
add-ins
common tasks, 291
exporting macros, 298
importing browser views, 295
importing DDP Library data for PDS, 297
importing hook-up libraries, 293
importing macros, 299
importing system interfaces, 294
overview, 290
Admin schema
logon password encryption, 121
Administration module overview, 15
apostrophe in custom fields, 306
As-Built
actions for merging items, 235
claiming common tasks, 203
claiming documents, 216
claiming from As-Built Explorer, 213
claiming from buffer, 212
claiming from command line, 214
common tasks, 160
comparing with project data, 232
deleting project data, 182
Index
cables
enabling cable type dependency, 111
filtering, 189
hierarchy in explorer windows, 544
catalog tables
INtools.ini settings, 486
rebuilding, 131
character set for Oracle
database character set, 56
initialization prerequisites, 44
national character set, 56
checklist
installation, 343
claim mode
defining, 107
exclusive, 195
non-exclusive, 195
settings and conditions for claiming, 197
claiming
claim modes, 195
claiming common tasks, 203
copying items to Claim Buffer, 208
copying items to Target Project Buffer, 209
documents, 216
exclusing claim mode, 107
fieldbus tags, 195
from another project, 213
from As-Built, 213
from buffer, 212
from command line, 214
items claimed for multuple projects, 217
items in buffer, 210
preferences, 207
prerequisites for claiming documents, 215
showing projects with claimed items, 217
clients
adding, 142
associating with a domain, 143
common tasks, 140
deleting, 142
editing, 142
colors of displayed items, 167
command line
claiming items for project, 214
domain backup, 33
domain initialization, 66
merging items, 240
comparison list report generation, 223
connection to database
list of connections, 145
contractors, 140
adding, 141
associating with a domain, 143
deleting, 141
editing, 141
conventions
KKS, 334
copying items
selection for merging, 220
copying items for merging
copying all as Merge Now, 227
copying all as Release Claim, 228
copying as Merge Now, 227
copying as Release Claim, 228
custom
database views, 47
custom fields
apostrophe in browsers, 306
browsers, 306
copying, 306
defining, 304
item types, 306
length, 304
plant hierarchy fields, 304
process data sequence numbers, 305
custom tables
defining, 309
custom title blocks
associating with specs, 284
description, 285
PowerBuilder units, 285
data comparison
comparing project data with As-Built, 232
comparison list reports for merging, 223
item comparison options, 234
data copying options
all module data, 330
common tasks, 326
from another plant hierarchy item, 327
overview, 325
revisions, 332
setting wiring naming options, 331
specific module data, 328
database, 338
clearing blocking sessions on SQL Server, 324
clearing locking common tasks, 322
clearing locking in all sessions, 324
clearing locking on Oracle, 323
clearing locking overview, 321
clearing locking per user, 323
clearing session records, 324
defining for logging on, 127
general maintenance, 126
list of database connections, 145
locking mode, 123
maintenance on Oracle, 136
maintenance on SQL Server, 132
maintenance overview, 125
optimizing indexes on Oracle, 138
optimizing indexes on SQL Server, 135
printing filegroup information, 134
rebuilding catalog tables, 131
Index
rebuilding stored procedures and triggers, 130
security, 120
setting locking mode, 124
supported character set, 56
updating Oracle statistics, 139
viewing Oracle tablespaces, 137
database setup
common tasks, 18
for Oracle, 16
for SQL Server, 17
manual setup for Oracle, 29
Oracle orasetup.log file, 26
Oracle orasetup.sql file file, 26
Oracle tablespaces, 23
running for Oracle, 26
running for SQL server, 21
SQL Server filegroups, 19
database views
adding for initialization, 47
rebuilding, 129
datafiles
adding filegroups, 133
adding log file for SQL Server, 134
adding to tablespaces, 137
adding to TEMPDB for SQL Server, 133
DBMS_PIPE, 26
DBParm parameter, 29
DCS hardware I/O data
Honeywell, 296
Yokogawa CENTUM CS 1000, 296
Yokogawa CENTUM CS 3000, 296
DDP Library data for PDS
importing, 297
default
rebuilding default views, 129
title block descriptions, 285
departments
assigning users, 90
creating, 89
deleting, 89
departments and users common tasks, 88
editing, 89
dialog boxes
Accounting, 375
Activity Tracking Report Settings (Graph), 376
Activity Tracking Report Settings (Grid), 378
Add Accounting, 379
Add Client, 379
Add Contractor, 380
Add Database Views, 380
Add Datafiles (Oracle), 382
Add Datafiles (SQL Server), 380
Admin Schema Password Encryption, 383
Advanced Domain Preferences, 384
Advanced Filter Definition (Cables), 385
Advanced Filter Definition (Loops), 386
Index
Initialize (Sybase Adaptive Server Anywhere), 524
Items and Activities for Access Rights, 434
List of Duplicate Items, 432
Load Audit Trail Data, 451
Log File, 452
Microsoft SQL Server Connection, 456
Naming Conventions, 453
Open Administration Module, 457
Optimize Indexes (Oracle), 457
Optimize Indexes (SQL Server), 458
Oracle Server Connection, 459
Owner, 460
Page Setup, 460
Panel Location Levels, 461
Plant Hierarchy, 462
Plant Properties, 466
Preferences for Scoping and Merging Data, 468
Preferences Management, 475
Preferences Management (General), 477
Print Options, 480
Print Preview, 481
Project Activities, 482
Rebuild Catalog Tables, 486
Rebuild Default Views in Domains, 487
Rebuild Projects in Domain, 488
Rebuild Stored Procedures and Triggers, 489
Remove Deleted Windows Users, 489
Report Management, 490
Required Wiring Equipment Report, 494
Reserve Project Loop Numbers, 495
Reserve Project Tag Numbers, 495
Reserve Tags and Loops for As-Built, 494
Reserve Tags and Loops for Project, 494
Scope Definition, 496
Search, 497
Security Options, 498
Select, 502, 503
Select Columns for Sorting, 499
Select Columns for Viewing, 499
Select Item Types for Comparison, 500
Select Item Types for Reports, 500
Select Language, 501
Select Logo, 501
Select Source Database, 504
Select Source for Claiming, 505
Select Target Database, 506
Set Color, 507
Source Data Connection, 507
Tablespace List, 510
Target Database Parameters (Oracle), 511
Target Database Parameters (SQL Server), 512
Target Unit Revisions, 515
Telecom Device Panel Icons, 516
To Do List, 516
Trim Audit Trail Data, 517
Unit Properties, 518
Index
backup common tasks, 32
backup from the command line, 33
defining, 109
defining domain common tasks, 106
deleting, 70
domain backup overview, 30, 37, 39, 41
empty domain initialization in a .db file, 48
empty domain initialization in Oracle, 52
empty domain initialization in SQL Server, 59
enabling workflow, 112
exporting preferences, 281
importing preferences, 281
initialization common tasks, 46
initialization from the command line, 66
initialization in a .db file from a source, 50
initialization in Oracle from a source, 56
initialization in SQL Server from a source, 62
initialization log files, 68
initialization overview, 43
initialization prerequisites, 44
optimizing indexes on SQL Server, 135
rebuilding catalog tables, 131
rebuilding default views, 129
rebuilding stored procedures and triggers, 130
setting domain preferences, 278
workaround for Grant to view Creation Error, 76
workaround for ORA-01722 error, 75
encryption
Admin schema logon password, 121
all user passwords, 122
examples
cable hierarchy, 544
document number naming conventions, 249
loop KKS naming convention, 340
panels by category, 545
panels by location, 546
exclusive claim mode
disabling, 107
enabling, 107
explorer windows
As-Built Explorer, 531
Claim Buffer, 533
Claimed Items, 535
common tasks, 184
descriptions, 183
filtering items, 187
finding a specific item, 186
finding multiple items, 185
item status indication icons, 544
Merge Buffer, 535
overview, 183
Project Explorer, 538
Source Project Explorer, 540
Target Project Buffer, 542
using in Operating owner domain, 183
using My List, 194
exporting
preferences, 281
exporting project data, 80
field personnel
defining, 312
fieldbus tags
claiming, 195
merging with As-Built, 218
filegroups
adding, 133
filegroup descriptions, 19
printing filegroup information, 134
files
removing spaces, 245
filtering
cables, 189
cross cables, 189
loops according to blocks, 192
filtering items, 187
global path
specifying, 114
Grant to view Creation Error, 76
groups
assigning users, 97
creating, 95
deleting, 96
editing, 96
for Windows authentication, 100
overview, 93
removing deleted Windows users, 101
removing users, 98
SmartPlant Instrumentation groups, 99
Windows global groups, 99
hierarchy
designing plant hierarchy, 149
hierarchy levels
creating, 152
deleting, 152
deleting items, 157
history, 314
Honeywell, 296
hook-up libraries
importing, 293
icons
assigning to telecom device types, 303
descriptions of item indicators, 544
in explorer windows, 544
IDEAL user, 90
importing
browser views, 295
DCS hardware I/O library data, 296
DDP Library data for PDS, 297
hook-up libraries, 293
interface language, 143
macros, 299
preferences, 281
Index
system interfaces, 294
indicators of items, 544
initialization
common tasks, 46
empty domain initialization in a .db file, 48
empty domain initialization in Oracle, 52
empty domain initialization in SQL Server, 59
from the command line, 66
handling an initialization failure, 74
in .db file from a source, 50
in Oracle from a source, 56
in SQL Server from a source, 62
log files, 68
Operating owner domain, 171
overview, 43
restarting, 74
resuming, 74
user-defined database views, 47
initialization prerequisites
for Oracle, 44
for SQL Server, 44
for Sybase Adaptive Server Anywhere, 44
language environments, 44
NLS_NUMERIC_CHARACTERS, 44
supported character set, 44
initialization troubleshooting
common tasks, 73
Grant to view Creation Error, 76
ORA-01722 error, 75
restarting initialization, 74
resuming initialization, 74
InitLog.txt, 68
installation
checklist, 343
integration
common tasks, 344
configuring, 344
define IDEAL user, 347
deleting projects, 181
forbidden actions for projects, 218
item registry overview, 351
project deletion common tasks, 180
registering plants, 349
requirements, 354
setting project status, 170
settings definitions, 350
interface language
common tasks, 366
customizing new phrases, 369
editing interface text, 367
importing, 143
overview, 365
prefixes and suffixes, 370
intools.ini file
[PROFILES] section, 127
defining databases, 127
Index
with a language from a file, 368
with a language from the database, 368
length
custom field characters, 304
naming conventions, 241
passwords, 120
wire end naming convention, 253
locations
location level separators, 302
location levels for panels, 302
locking
clearing - common tasks, 322
clearing - overview, 321
clearing in all sessions, 324
clearing on Oracle, 323
clearing on SQL Server, 324
clearing per user, 323
clearing session records, 324
database connections, 145
database locking mode, 123
setting database locking mode, 124
log files
domain backup, 68
domain initialization, 68
items claimed from buffer, 212
merged items, 238
off-site project import, 178
orasetup.log, 26
project backup log file path, 81
restoring projects, 82
logging on
as Domain Administrator, 86
as System Administrator, 85
defining databases, 127
groups for Windows authentication, 100
ODBC profile for SQL Server, 127
switching to dirrerent logon method, 102
Windows authentication, 99
logos
selecting for a domain, 311
selecting for projects, 165
loop numbers
filtering according to blocks, 192
reserved loops report, 170
reserving for As-Built, 168
reserving for projects, 168
macros
exporting, 298
importing, 299
maintenance
catalog tables, 131
database locking mode, 123
database maintenance on Oracle, 136
database maintenance on SQL Server, 132
database maintenance overview, 125
general database maintenance, 126
Index
wiring items, 244
notes
modifying, 312
off-site projects
creation prerequisites, 174
implementation workflow, 173
import log file, 178
importing, 177
overview, 172
restrictions, 175
Operating owner domain
actions for merging items, 235
As-Built, 158
claiming common tasks, 203
common tasks, 160
creating, 107
creating a project, 162
deleting project data, 182
deleting projects, 181
displaying As-Built items, 205
displaying project items, 220
making As-Built definitions, 166
merging data common tasks, 230
off-site projects, 172
overview, 158
project deletion common tasks, 180
projects, 158
rebuilding projects, 171
selecting a project logo, 165
ORA-01722 error, 75
Oracle
clearing blocked sessions, 323
database character set, 56
database connections, 145
database maintenance, 136
datafiles, 137
deleting an invalid domain, 71
domain initialization from a source, 56
empty domain initialization, 52
national character set, 56
optimizing indexes, 138
tablespaces, 137
updating Oracle statistics, 139
viewing tablespaces, 137
Oracle Instance Configuration File
modifying on Oracle 9.2, 318
paths for trimming audit trail data, 318
owners
defining a plant owner, 153
deleting, 153
editing, 153
panel locations
defining levels, 302
naming conventions, 244
separators, 302
passwords
Index
backing up and restoring common tasks, 79
backup, 80
claim modes, 195
claiming documents, 216
claiming from buffer, 212
claiming from command line, 214
claiming items from another project, 213
claiming items from As-Built, 213
comparing data for merging, 232
copying project preferences, 280
creating, 162
deleting project data, 182
displaying As-Built items, 205
displaying items for merging, 220
displaying source project items, 206
exporting data for backup, 80
importing an off-site project, 177
item comparison options, 234
items claimed for multuple projects, 217
items in Merge Buffer, 225
making As-Built definitions, 166
merging data overview, 218
merging items from command line, 240
merging items from Merge Buffer, 238
merging items from Project Explorer, 239
off-site project creation, 172
off-site project implementation workflow, 173
off-site project prerequisites, 174
off-site project restrictions, 175
Operating owner domain, 107
Operating owner domain common tasks, 160
preferences for claiming, 207
preferences for merging, 232
prerequisites for claiming documents, 215
Project schema creation, 162
rebuilding, 171
reports of changed documents, 225
reports of changed items, 224
reserving tags and loops, 168
restoring, 81
scoping data overview, 195
selecting a logo, 165
setting merge actions, 236
setting project preferences, 279
setting status for integration, 170
settings and conditions for claiming, 197
showing claimed items, 217
registering
plant, 349
reports
access rights, 275, 309
archiving options, 287
associating a new title block, 284
changed documents, 225
changed items, 224
common tasks, 283
Index
multiple items for merging, 185
specific item for claiming, 186
specific item for merging, 186
security
changing System Administrator password, 121
database locking mode, 123
database security, 120
encrypting all user passwords, 122
setting database locking mode, 124
setting security options, 122
separators, 340
control system tag names, 245
device cable names, 245
in panel location levels, 302
plant hierarchy, 109
wire end naming conventions, 254
sessions
clearing in all sessions, 324
clearing locking common tasks, 322
clearing locking overview, 321
clearing on Oracle, 323
clearing on SQL Server, 324
clearing per user, 323
clearing records, 324
database connections, 145
SmartPlant Foundation
retrieving plant hierarchy, 348
SmartPlant Foundation Web Client, 349
SmartPlant Instrumentation Server
define IDEAL user, 347
SmartPlant integration
setting project status, 170
special characters in custom fields, 306
specification title blocks, 109
SQL script file for database setup, 29
SQL Server
adding datafiles to filegroups, 133
adding datafiles to TEMPDB, 133
audit trail data backup, 40
clearing blocking sessions, 324
database connections, 145
database maintenance, 132
deleting an invalid domain, 72
domain initialization from a source, 62
empty domain initialization, 59
Grant to view Creation Error, 76
ODBC profiles, 127
printing filegroup information, 134
stored procedures
rebuilding, 130
sub-items for claiming
copying to Claim Buffer, 208
copying to Target Project Buffer, 209
removing from buffer, 211
removing from Merge Buffer, 229
sub-items for merging
Index
Grant to view Creation Error, 76
ORA-01722 error, 75
restarting initialization, 74
resuming initialization, 74
user groups
access rights report, 275
assigning to project, 164
copying from As-Built, 162
overview, 93
project administrators, 159
user-defined database views
adding for initialization, 47
users
assigning to departments, 90
assigning to groups, 97
creating, 90
creating a group, 95
database connections, 145
deleting, 90
editing, 90
IDEAL user, 90
logon options, 99
removing deleted Windows users, 101
removing from groups, 98
switching to dirrerent logon method, 102
users and departments common tasks, 88
Windows authentication, 99
Windows groups, 100
views
adding for initialization, 47