SmartPlant Instrumentation

Administration
User's Guide

Version 2013
March 2013
DSPI2-PE-200002B

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

U.S. Government Restricted Rights Legend

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

Terms of Use
Use of this software product is subject to the End User License Agreement ("EULA") delivered with this software product unless
the licensee has a valid signed license for this software product with Intergraph Corporation. If the licensee has a valid signed
license for this software product with Intergraph Corporation, the valid signed license shall take precedence and govern the use
of this software product. Subject to the terms contained within the applicable license agreement, Intergraph Corporation gives
licensee permission to print a reasonable number of copies of the documentation as defined in the applicable license agreement
and delivered with the software product for licensee's internal, non-commercial use. The documentation may not be printed for
resale or redistribution.

Warranties and Liabilities

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

Trademarks
Intergraph, the Intergraph logo, PDS, SmartPlant, SmartMarine, FrameWorks, I-Convert, I-Export, I-Sketch, IntelliShip, INtools,
ISOGEN, MARIAN, SmartSketch, SPOOLGEN, SupportManager, and SupportModeler are trademarks or registered trademarks
of Intergraph Corporation or its subsidiaries in the United States and other countries. Microsoft and Windows are registered
trademarks of Microsoft Corporation. MicroStation is a registered trademark of Bentley Systems, Inc. Other brands and product
names are trademarks of their respective owners.

Contents
Working with the Administration Module ................................................................................................. 9
SmartPlant Instrumentation Database Setup for Oracle ....................................................................... 11
Oracle Database Server Tablespaces for SmartPlant Instrumentation ................................................ 11
Setting Up a Database for Oracle Common Tasks............................................................................... 13
Set Up a SmartPlant Instrumentation Database for Oracle .................................................................. 14
Create a Database by Running the DB Setup SQL Script File ............................................................. 19
Clean Up the Oracle Database ............................................................................................................. 19
SmartPlant Instrumentation Database Setup for SQL Server ............................................................... 21
SQL Server Database Server Filegroups for SmartPlant Instrumentation ........................................... 21
Setting Up a Database for SQL Server Common Tasks ...................................................................... 23
Set Up a SmartPlant Instrumentation Database for SQL Server .......................................................... 24
Clean Up the SQL Server Database ..................................................................................................... 26
Domain Backup, Initialization, and Deletion ........................................................................................... 27
Domain Backup Common Tasks .......................................................................................................... 28
Back Up a Domain.......................................................................................................................... 28
Back Up a Domain from the Command Line .................................................................................. 29
Back Up a Domain in Thin Client Mode ......................................................................................... 30
Workaround for a Backup Problem in Windows Vista and Windows 7 .......................................... 32
Backing Up Files Containing Audit Trail Data ....................................................................................... 32
Backing Up Audit Trail Data on Oracle ........................................................................................... 33
Backing Up Audit Trail Data on SQL Server .................................................................................. 34
Backing Up Audit Trail Data on Sybase Adaptive Server Anywhere ............................................. 36
Domain Initialization .............................................................................................................................. 37
Prerequisites for Domain Initialization ............................................................................................ 37
Domain Initialization Common Tasks ............................................................................................. 39
Domain Deletion Common Tasks ......................................................................................................... 56
Delete a Domain ............................................................................................................................. 57
Delete an Invalid Domain on Oracle ............................................................................................... 57
Delete an Invalid Domain on SQL Server ...................................................................................... 58
Troubleshooting Domain Initialization Common Tasks......................................................................... 58
Handle an Initialization Failure ....................................................................................................... 59
Workaround for an Initialization Problem in Windows Vista and Windows 7 ................................. 60
Workaround for a Backup Problem in Windows Vista and Windows 7 .......................................... 60
Numeric Character Settings for Oracle .......................................................................................... 61
Workaround for the Grant to View Creation Error .......................................................................... 62
Accessing the Administration Module .................................................................................................... 63
Log on as System Administrator ........................................................................................................... 63
Log on as Domain Administrator........................................................................................................... 64
Switch from System Administration to Domain Administration ............................................................. 64
Switch from Domain Administration to System Administration ............................................................. 64

SmartPlant Instrumentation Administration User's Guide

Contents
Users, Departments, and Groups ............................................................................................................ 65
Create and Manage Departments......................................................................................................... 65
Define a SmartPlant Instrumentation User ........................................................................................... 66
Assign a Domain Administrator ............................................................................................................. 67
User Groups .......................................................................................................................................... 68
Users and Groups Common Tasks....................................................................................................... 68
Create a New Group ....................................................................................................................... 69
Modify the Profile of a Group .......................................................................................................... 69
Delete a Group ............................................................................................................................... 70
Assign Users to Groups.................................................................................................................. 70
Remove Users from Groups ........................................................................................................... 71
Windows Authentication Logon Method ......................................................................................... 71
Create a Group for Windows Authentication Logon Method .......................................................... 72
Remove Deleted Windows Users from SmartPlant Instrumentation User Groups ........................ 72
Switching to a Different Logon Method .......................................................................................... 73
System Administration ............................................................................................................................. 75
System Administration Common Tasks ................................................................................................ 75
Domain Management Common Tasks ................................................................................................. 76
Create an Owner Operator Domain ............................................................................................... 78
Make Domain Definitions................................................................................................................ 79
Enable Cable Type Dependency .................................................................................................... 80
Enable Workflow............................................................................................................................. 81
Activate the Audit Trail Functionality .............................................................................................. 81
Enable Item Registry ...................................................................................................................... 82
Specify a Global Path ..................................................................................................................... 82
Activity Tracking Management Common Tasks ................................................................................... 83
Set the Activity Tracking Mode ....................................................................................................... 83
Clear Activity Tracking Data ........................................................................................................... 84
Generate a Grid-Style Activity Tracking Report ............................................................................. 85
Generate a Graph-Style Activity Tracking Report .......................................................................... 85
Managing Database Security ................................................................................................................ 86
SmartPlant Instrumentation Encryption Mechanism ...................................................................... 86
Set Security Options ....................................................................................................................... 91
Database Locking Mode (for Multi-User Versions) ........................................................................ 91
Set Database Locking Mode .......................................................................................................... 92
Maintaining the SmartPlant Instrumentation Database ........................................................................ 92
General Database Maintenance Common Tasks .......................................................................... 92
Database Maintenance on SQL Server Common Tasks ............................................................... 98
Database Maintenance on Oracle Common Tasks ..................................................................... 101
Using KKS Naming Conventions in SmartPlant Instrumentation ....................................................... 105
Working in KKS Mode in SmartPlant Instrumentation ........................................................................ 107
Flow of Activities for Working in KKS Mode ................................................................................. 109
System Administrator Activities .................................................................................................... 109
Domain Administrator Activities .................................................................................................... 110
Import Utility Activities .................................................................................................................. 110
Define KKS Naming Convention Using KKS Segments .............................................................. 110
Example of a KKS Naming Convention for Loops ....................................................................... 111
Loop Number Representation in the Domain Explorer of SmartPlant
Instrumentation ............................................................................................................................. 112
Accounting, Contractors, and Clients Common Tasks ....................................................................... 112
Add and Manage Accounting Information .................................................................................... 113

SmartPlant Instrumentation Administration User's Guide

Contents
Add and Manage Contractors ...................................................................................................... 114
Add and Manage Clients .............................................................................................................. 115
Associate Accounting, Client, and Contractor Information with a Domain ................................... 115
Print Database Connection Information .............................................................................................. 116
Report Generation (System Administration) ....................................................................................... 116
Domain and Project Administration ...................................................................................................... 117
Domain Administration Common Tasks ............................................................................................. 117
Plant Design and Structure ................................................................................................................. 119
Create a Plant Hierarchy .............................................................................................................. 120
Owner ........................................................................................................................................... 120
Create a Plant Hierarchy Item on the Highest Level .................................................................... 121
Create a Plant Hierarchy Item on an Intermediate Level ............................................................. 121
Create a Plant Hierarchy Item on the Lowest Level ..................................................................... 123
Delete a Plant Hierarchy Item ...................................................................................................... 124
Owner Operator Domain (As-Built and Projects) ................................................................................ 124
Flow of Activities for Defining a Project Administrator .................................................................. 125
Owner Operator Domain (As-Built and Projects) Common Tasks ............................................... 126
Project Deletion Common Tasks .................................................................................................. 136
Explorer Windows ............................................................................................................................... 138
Working with Explorer Windows Common Tasks ........................................................................ 139
Search for Items ........................................................................................................................... 140
Find a Specific Item in the Tree View ........................................................................................... 141
Filter the Display of Items in an Explorer Window ........................................................................ 141
Filter Cables ................................................................................................................................. 142
Filter Loops According to Blocks .................................................................................................. 143
Add Items to My List in the Items Pane ........................................................................................ 145
Scoping Data for Projects ................................................................................................................... 145
Settings and Conditions for Claiming Items ................................................................................. 146
Scoping Data for Projects Common Tasks .................................................................................. 150
Merging Project and As-Built Data ...................................................................................................... 160
Open the Project Explorer and Merge Buffer ............................................................................... 161
Item and Sub-Item Selection Options for Merging with As-Built .................................................. 162
Generating Reports for Merging Data Common Tasks ................................................................ 163
Copy Items to the Merge Buffer Common Tasks ......................................................................... 165
Merging Project and As-Built Data Common Tasks ..................................................................... 168
Naming Conventions ........................................................................................................................... 176
Compatibility with Instrumentation Standards .............................................................................. 177
Naming Conventions Common Tasks .......................................................................................... 177
Notes for Creating Naming Conventions for Wiring Items ........................................................... 178
Define Naming Conventions ......................................................................................................... 179
Copy Naming Conventions to Other <Units> ............................................................................... 181
Copy Naming Conventions from Another <Unit> ......................................................................... 181
Document Number Naming Convention Examples ...................................................................... 182
Generate Naming Convention Reports ........................................................................................ 184
Wire End Naming Conventions .................................................................................................... 184
Access Rights ..................................................................................................................................... 187
Access Rights Common Tasks .................................................................................................... 187
Access Rights Descriptions .......................................................................................................... 189
Grant Access Rights for Selected Items or Activities ................................................................... 199
Grant the Same Access Rights for All Items ................................................................................ 200
Workflow Access Rights ............................................................................................................... 201
Copy Access Rights ..................................................................................................................... 202

SmartPlant Instrumentation Administration User's Guide

Contents
View the Items in the Current Domain .......................................................................................... 202
Generate Access Rights Report ................................................................................................... 202
Preferences Management ................................................................................................................... 203
Managing Preferences Common Tasks ....................................................................................... 203
Set Domain Preferences .............................................................................................................. 204
Set Project Preferences................................................................................................................ 204
Copy Project Preferences ............................................................................................................ 205
Export Preferences ....................................................................................................................... 205
Import Preferences ....................................................................................................................... 206
Report Management ........................................................................................................................... 206
Report Management Common Tasks .......................................................................................... 206
Associate a New Title Block with a Report ................................................................................... 207
Title Block Descriptions ................................................................................................................ 207
Set Archiving Options for Report Comparison ............................................................................. 209
Define Report Revision Management Settings ............................................................................ 210
Add-Ins ................................................................................................................................................ 210
Import Hook-Up Libraries ............................................................................................................. 211
Import System Interfaces.............................................................................................................. 211
Import Browser Views................................................................................................................... 212
Import DCS Hardware I/O Library Data ........................................................................................ 213
Import DDP Library Data .............................................................................................................. 213
Export Macros .............................................................................................................................. 214
Import Macros ............................................................................................................................... 214
Import Spec Forms ....................................................................................................................... 215
Miscellaneous Domain Administration Tasks ..................................................................................... 216
Define Panel Location Levels ....................................................................................................... 217
Assign Icons to Telecom Device Types ....................................................................................... 218
Define Custom Fields ................................................................................................................... 218
Sequence Numbers and Process Data Custom Fields ................................................................ 219
Copy Custom Fields ..................................................................................................................... 220
Browsers That Can Contain Custom Fields ................................................................................. 220
Define Custom Tables .................................................................................................................. 222
Generate Domain Administration Reports.................................................................................... 223
Select a Logo ................................................................................................................................ 224
Define Field Personnel Profiles .................................................................................................... 224
Modify Domain Notes ................................................................................................................... 225
Modify Printer Settings ................................................................................................................. 225
Managing Audit Trail Data .................................................................................................................. 226
Managing Audit Trail Data Common Tasks ................................................................................. 226
Load Audit Trail Data .................................................................................................................... 227
Trim Audit Trail Data..................................................................................................................... 228
External Files with Trimmed Audit Trail Data ............................................................................... 228
Define Paths When Using Oracle ................................................................................................. 229
Define Paths When Using SQL Server ........................................................................................ 229
Define Paths When Using Sybase Adaptive Server Anywhere ................................................... 230
Clearing Locking ................................................................................................................................. 230
Clearing Locking Common Tasks ................................................................................................ 231
Clear Locking per User ................................................................................................................. 232
Clear Blocked Sessions on Oracle ............................................................................................... 232
Clear Locking in All Sessions ....................................................................................................... 232
Clear SmartPlant Instrumentation Session Records .................................................................... 232
Copying Data ...................................................................................................................................... 233
Flow of Activities for Copying Data ............................................................................................... 234

SmartPlant Instrumentation Administration User's Guide

Contents
Copying Data Common Tasks ..................................................................................................... 235
Select the Source Plant Hierarchy Item for Copying Data ........................................................... 236
Copy Specific Data ....................................................................................................................... 236
Copy All Module Data ................................................................................................................... 238
Set Wiring Naming Options for Target Plant Hierarchy Item ........................................................ 239
Set Revisions for Target Plant Hierarchy Item ............................................................................. 240
Working with SmartPlant Integration .................................................................................................... 241
Configuring SmartPlant Instrumentation for Integration...................................................................... 242
Integration Common Tasks ................................................................................................................. 242
SmartPlant Instrumentation Configuration Checklist for Integration ............................................ 242
Configure SmartPlant Instrumentation for Integration .................................................................. 243
Item Registry Activities ........................................................................................................................ 245
Register Items .............................................................................................................................. 246
Clean Up Item Registry ................................................................................................................ 246
Define an IDEAL User ......................................................................................................................... 246
Registering Plants ............................................................................................................................... 247
Register a Plant ............................................................................................................................ 247
Retrieve a Plant Hierarchy .................................................................................................................. 248
Define Preferences Settings for an Integrated Environment .............................................................. 249
Tool Requirements for Integrating SmartPlant Instrumentation ......................................................... 249
General Integration Requirements ............................................................................................... 249
Naming Convention Requirements for Integration ....................................................................... 250
Working with SmartPlant P&ID ..................................................................................................... 253
Working with SmartPlant Electrical .............................................................................................. 254
Using Projects in an Integrated Environment ............................................................................... 255
Naming Convention Mapping ....................................................................................................... 256
Configure SmartPlant Instrumentation to Use Minor Revisions ......................................................... 257
SmartPlant Instrumentation Interface Languages ............................................................................... 259
Interface Languages Common Tasks ................................................................................................. 260
Import a New Interface Language....................................................................................................... 260
Replace the Interface Language with a Language from the Database .............................................. 261
Replace the Interface Language with a Language from an External File ........................................... 261
Translate Interface Text Phrases ........................................................................................................ 262
Complementary Resource Files ................................................................................................... 263
Prefixes and Suffixes in the Interface Text ......................................................................................... 263
Schema Grid ................................................................................................................................. 393
Owner Operator Domain Explorer Windows ........................................................................................ 405
As-Built Explorer ................................................................................................................................. 405
Claim Buffer ........................................................................................................................................ 406
Claimed Items ..................................................................................................................................... 408
Merge Buffer ....................................................................................................................................... 408
Project Explorer................................................................................................................................... 410
Source Project Explorer ...................................................................................................................... 411
Target Project Buffer ........................................................................................................................... 412
Item Indicators..................................................................................................................................... 414
Cable Hierarchy Example ................................................................................................................... 414
Panel by Category Hierarchy Example ............................................................................................... 415
Panel by Location Hierarchy Example ................................................................................................ 416

SmartPlant Instrumentation Administration User's Guide

Contents
Glossary ................................................................................................................................................... 417
Index ......................................................................................................................................................... 419

SmartPlant Instrumentation Administration User's Guide

SECTION 1

Working with the Administration Module

The Administration module provides you with administrative tools for keeping track of your
resources and maintaining user access security.
There are two mutually exclusive levels of administration System Administration and Domain
Administration that provide you with a greater degree of control over security and resource
management.
The system must first be set up at the System Administration level before resources can be
allocated at the Domain Administration level.
In 32 and 64bit environments with UAC on, to perform administrative tasks in
SmartPlant Instrumentation, the Windows user must be allocated Read/Write permissions in the
installation folder (by default %systemdrive%\Program Files\SmartPlant - for 32-bit machines
and %systemdrive%\Program Files (x86)\SmartPlant - for 64-bit machines).

SmartPlant Instrumentation Administration User's Guide

Working with the Administration Module

10

SmartPlant Instrumentation Administration User's Guide

SECTION 2

SmartPlant Instrumentation Database

Setup for Oracle
The database setup stage involves configuring SmartPlant Instrumentation database for your
Oracle database server by adding the database schemas, INTOOLS_ENGINEER role, logon
information, and associated database objects into the Oracle database.
You can also configure the database using an SQL script file which contains the appropriate
database statements. The DB Setup Utility creates the SQL script file at the end of the
configuration process. After the SQL script file is created, you can run that script file
automatically by letting the DB Setup Utility run the file at the end of the database setup. You
can also run that script file manually in the Server Manager dialog box.
You perform the database setup procedure after you finish installing the Oracle database server,
Oracle client, and SmartPlant Instrumentation for Oracle.
The DB Setup Utility performs the following operations (in the indicated order):
1. Creates Oracle database server tablespaces.
2. Creates the INTOOLS_ENGINEER role and SmartPlant Instrumentation database schemas
containing logon information required for connection to the Oracle database server.
3. Creates database objects in the Admin schema of SmartPlant Instrumentation and fills these
objects with data that appears in the IN_TEMPL template database, supplied with
SmartPlant Instrumentation.
During the database setup, the INTOOLS_ENGINEER role receives system privileges
and privileges for database objects included in the Admin schema. These objects are shared for
all domains you initialize. When initializing a new domain, other database schemas of
SmartPlant Instrumentation receive the INTOOLS_ENGINEER role.
If 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.

Oracle Database Server Tablespaces for SmartPlant

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

SmartPlant Instrumentation Administration User's Guide

11

SmartPlant Instrumentation Database Setup for Oracle

Temporary tablespace used for internal Oracle operations (for example, sorting). For the
temporary operation of Oracle in each domain, one tablespace is created automatically for
all domains during the database setup.
Each tablespace can contain one or more datafiles. SmartPlant Instrumentation database
keeps your data in the following schemas:
Admin schema contains the administration data and indexes.
Domain schema (a separate schema for each domain) contains the domain and index
data of a SmartPlant Instrumentation domain.
View-Only Domain schema (an individual schema for each domain)
The DB Setup Utility creates tablespaces for the Admin schema using the following tablespace
default values:

Parameter

Admin Data Tablespace

Index Data Tablespace

Tablespace name

main_ts

index_main_ts

Database filename:

in_main.db

ix_main.db

Tablespace size

10 MB

ix_main.db

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

Quantity (Average)

Instruments

45058

Loops

16616

CAD drawing blocks

1381

Device panels

11384

Junction boxes

504

Marshaling racks

45

Cabinets

36

DCSs and PLCs

108

Channels

16880

Specifications

111

P&ID drawings

855

Lines

3132

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

12

Admin Data
Tablespace

Admin Index
Tablespace

Domain Data
Tablespace

Domain Index
Domain Temporary
Data Tablespace Data Tablespace

30 MB

10 MB

350 MB

180 MB

100 MB
(auto-extended)

SmartPlant Instrumentation Administration User's Guide

SmartPlant Instrumentation Database Setup for Oracle

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

For better performance, it is highly recommended that you locate the data tablespaces and
index tablespaces on different physical disks. You can also locate the system file, database
tables and the index data on different physical drives to speed up your work in the Oracle
Database. See your Oracle User Guide for more information.
Each of the file names must be a legal name. Each tablespace name must be unique within
your database.

See Also
SmartPlant Instrumentation Database Setup for Oracle (on page 11)

Setting Up a Database for Oracle Common Tasks

The following tasks allow the System Administrator to create and configure a SmartPlant
Instrumentation database for Oracle by running the DB Setup Utility, supplied with SmartPlant
Instrumentation. You can create one SmartPlant Instrumentation database per database setup
session. After a successful database setup session, you can log on to the Administration
module of SmartPlant Instrumentation as System Administrator and initialize SmartPlant
Instrumentation domains in your database. For a complete list of tasks, click the appropriate
topic on the Contents tab and then click the procedure that you want.

Set Up a SmartPlant Instrumentation Database for Oracle

Use this procedure to run SmartPlant Instrumentation database setup in your Oracle database
server. You define tablespaces and other parameters required for the SmartPlant
Instrumentation database. The setup provides default parameters and values that you can
accept or modify. The default tablespace sizes are recommended as initial values. When
connecting to the Oracle database, you provide a logon name and a logon password. This
logon information is different from the logon information required to log on to SmartPlant
Instrumentation. You define the Oracle database server logon information during this
procedure. For more information, see Set Up a SmartPlant Instrumentation Database for
Oracle.

Create a Database by Running the DB Setup SQL Script File

Use this procedure to set up the SmartPlant Instrumentation database for Oracle manually, by
running an SQL file which the DB Setup Utility generates. This way you can review or modify
the SmartPlant Instrumentation database setup parameters, and also perform a step-by-step
process of the SmartPlant Instrumentation database setup. The execution of the SQL file
automatically creates the appropriate tablespaces, the Admin schema, the Administration tables,
indexes and the Administration primary key. For more information, see Create a Database by
Running the DB Setup SQL Script File (on page 19).

Clean Up the Oracle Database

Use this procedure to clean up the Oracle database by deleting SmartPlant Instrumentation
database objects created during a specific database setup session. You must perform this
procedure if a database setup did not complete successfully and you want to run the same

SmartPlant Instrumentation Administration User's Guide

13

SmartPlant Instrumentation Database Setup for Oracle

setup again. You clean up the database using Oracle tools. For more information, see Clean
Up the Oracle Database (on page 19).

Set Up a SmartPlant Instrumentation Database for

Oracle

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.
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 [Link] file, accept or change the displayed compatible
DBMS parameter for the Oracle server version that you selected from the Oracle version
list.
If you want to change the DBMS parameter, make sure it is compatible with SmartPlant
Instrumentation. For more details about all compatible combinations of Oracle and
SmartPlant Instrumentation versions, see SmartPlant Configuration and Maintenance
Guide, Compatibility of Oracle and SmartPlant Instrumentation Versions.
4. In the Oracle database name box, do one of the following:
Accept displayed database name.
Change the displayed value if it does not match the value you defined for the DB_NAME
parameter in the Oracle Instance Configuration file.
5. In the Server name box, accept or modify the displayed Oracle server connection string.
6. In the System Administrator logon password box, accept the given default value
manager (the password is masked), or type the appropriate password.
If you cannot connect to the Oracle database server using the default password,
contact your Oracle Database Administrator, who has rights to create a new SmartPlant
Instrumentation System Administrator logon password for connection to the Oracle
database server.

Database Creation - Tablespaces Creation Modes

The user now creates the database and tablespaces for the Admin and the Domain or Domains.
The user may use existing tablespaces or create new ones. To create tablespaces the user has
the following modes:
Automatic The tablespaces for the administration and domain or domains are created
automatically. The user then has to define the tablespaces for the Domain or Domains.
Customized The user is able to configure the tablespace name, data file name and path, and
the tablespace size of the Admin schema data, Admin schema indexes, and Temporary
[Link] user then has to define the tablespaces for the Domain or Domains.

14

SmartPlant Instrumentation Administration User's Guide

SmartPlant Instrumentation Database Setup for Oracle

Predefined The user predefines a list of tablespaces as desired. The user, then selects the
desired Admin schema data from the prdefined list. The Temporary tablespaces names, data file
name and path, and the tablespace size are created automatically. The user then has to define
the tablespaces for the Domain or Domains.
1. In dbsetup click Connect to connect to your Oracle database server.

2.

Accept the default Administration schema login name and Administration schema login
password values in_dbamn.

If you want to modify the login name or password, verify that the login name is unique
in the Oracle database server. The login name and password can only start with a letter and
contain no spaces. You can use an underscore instead of a space. If you wish to encrypt the
password, see Encrypt the Admin Schema Logon Password.
3. Continue to either the Automatic, or Customized, options as described in the Automatic
mode of tablespaces creation and Customized mode of tablespaces creation. Else, if
the Predefined mode is required, continue to Predefined mode of tablespaces creation.

Automatic mode of tablespaces creation

1. On the New Database Definitions dialog box, from the Tablespaces options, select
Automatic, and click Create.
2. Continue to section Defining Domain Tablespaces in Oracle (on page 54).

SmartPlant Instrumentation Administration User's Guide

15

SmartPlant Instrumentation Database Setup for Oracle

Customized mode of Tablespaces creation
1. On the New Database Definitions dialog box, from the Tablespaces options, select
Customize, and click Create.

2. Under Administration schema data, do the following:

a. From the Tablespace name list, select the desired tablespace name.
b. In the Data file name and path field, insert the desired path details.
c. In the Tablespace size field, insert the desired tablespace size.
3. Under Administration schema indexes, do the following:
a. Accept the Tablespace name or type in a desired tablespace name.
b. In the Data file name and path field, insert the desired path details.
c. In the Tablespace size field, insert the desired tablspace size.
4. Under Temporary Tablespaces, do the following:
a. Accept the Tablespace name or type in a desired tablespace name.
b. In the Data file name and path field, insert the desired path details.
c. In the Tablespace size field, insert the desired tablespace size.
5. Click Create.
6. Continue to section Defining Domain Tablespaces in Oracle (on page 54).

16

If you want to create more than four SmartPlant Instrumentation domains, for the Admin
data tablespace, specify a size larger than 25 MB, and for the Admin index tablespace,
specify a size larger than 10 MB.
If you change the default tablespace definitions when, for better performance, it is highly
recommended that you locate the data tablespaces and index tablespaces on different
physical disks. You can also locate the system file, database tables and the index data

SmartPlant Instrumentation Administration User's Guide

SmartPlant Instrumentation Database Setup for Oracle

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.
If you want to create more than four SmartPlant Instrumentation domains, for the Admin
index tablespace, you need to specify a size larger than 10 MB.

Predefined mode of tablespaces creation

Create the following:
For the Administration Schema - Admin data, Admin indexes and Temporary tablespaces.
a. Administration data tablespace:
i. Create tablespace ZED007 datafile '[Link]' size 15M autoextend on next 10M
maxsize 3000M;
ii. Create tablespace ZED007i datafile '[Link]' size 15M autoextend on next
10M maxsize 3000M;
b. Temporary tablespace:
Create Temporary tablespace ZED007temp tempfile '[Link]' size 2M
autoextend on next 2M maxsize 3000M;
For each Domain - Two tablespaces for the domain data and domain indexes.
a. Create tablespace ZED007demo datafile '[Link]' size 20M autoextend on
next 10M maxsize 3000M;
b. Create tablespace ZED007demoi datafile '[Link]' size 20M autoextend on
next 10M maxsize 3000M;
Create the above tablespaces for each domain schema as necessary.
Use the following procedure to create each of the tablespaces listed above.
1. On the New Database Definitions dialog box, from the Tablespaces options, select
Predefined, and click Create.

SmartPlant Instrumentation Administration User's Guide

17

SmartPlant Instrumentation Database Setup for Oracle

2. Under Administration schema data, from the Tablespace name list, select the desired
tablespace name.
3. Under Administration schema indexes, from the Tablespace name drop-down list, select
the desired tablespace name.
4. Under Temporary Tablespaces, from the Tablespace name drop-down list, select the
desired tablespace name.
5. Click Create.
6. The user may, if desired, continue to section Defining Domain Tablespaces in Oracle (on
page 54).

1. Each domain requires two tablespaces.

2. Once predefined tablespaces is selected in [Link], Init will work with predefined
tablespaces by default. This is controlled through the predefinedtablespaces flag in the
License table.

See Also
Setting Up a Database for Oracle Common Tasks (on page 13)
SmartPlant Instrumentation Database Setup for Oracle (on page 11)
Oracle Database Server Tablespaces for SmartPlant Instrumentation (on page 11)

18

SmartPlant Instrumentation Administration User's Guide

SmartPlant Instrumentation Database Setup for Oracle

Create a Database by Running the DB Setup SQL

Script File
1. Run the DB Setup Utility and on the Oracle Server Connection dialog box, connect to the
new Oracle instance.
2. Ensure that the configuration settings file [Link] in the SmartPlant Instrumentation home
folder contains the following value of the DBParm parameter in the [Database] section:
'DBparm=DisableBind=1'

3.
4.
5.
6.
7.

If 'DisableBind=1' is not the only value of the DBParm parameter, make sure that it is
not enclosed by single quotes and is separated from other values by a comma. For
example, DBParm=DisableBind=1,PBDBMS=1
On the Target Database Parameters dialog box, enter the required values and click Create
File.
After the script file is created, make sure that the [Link] file is located in the
SmartPlant Instrumentation home folder.
Run the SQL*Plus utility.
Connect as the System Manager.
In the SQL*Plus utility, run the following set of commands:
SET ECHO OFF
SET SCAN OFF
SPOOL C:\TEMP\[Link]
@<SmartPlant Instrumentation home folder>[Link]
COMMIT;
SPOOL OFF

See Also
Setting Up a Database for Oracle Common Tasks (on page 13)
SmartPlant Instrumentation Database Setup for Oracle (on page 11)
Oracle Database Server Tablespaces for SmartPlant Instrumentation (on page 11)

Clean Up the Oracle Database

1. In SQL Plus, use your Oracle System account logon information and provide the Host
String value to connect to the target Oracle database.
The Host String value is the Oracle server name defined in the [DATABASE] section
of the [Link] file, as the Server parameter value.
2. Do the following to display SmartPlant Instrumentation schema tablespace names, which
you have to remember and delete after deleting the schemas themselves.
a. To display the Admin data and Temporary tablespace names, run the command
SELECT DEFAULT_TABLESPACE,TEMPORARY_TABLESPACE FROM DBA_USERS WHERE
USERNAME ='IN_DBAMN';
Remember the DEFAULT_TABLESPACE name (MAIN_TS by default) and
TEMPORARY_TABLESPACE name (TEMP1_TS by default).
b. To display the Admin index tablespace name, run the command
SELECT DISTINCT TABLESPACE_NAME FROM DBA_INDEXES WHERE
OWNER='IN_DBAMN';

SmartPlant Instrumentation Administration User's Guide

19

SmartPlant Instrumentation Database Setup for Oracle

This command returns both the Admin data and Admin index tablespace
names. Remember the Admin index tablespace name (INDEX_MAIN_TS by default).
In these commands, IN_DBAMN is the default Admin schema logon name. If you
changed the default name during the database setup, you can retrieve it from the
[Database] section of the [Link] file, where the Admin schema logon name appears as
the LogId parameter value.
3. Delete the INTOOLS_ENGINEER role using the command
DROP ROLE INTOOLS_ENGINEER CASCADE;
4. Delete the SmartPlant Instrumentation schemas (database users) one by one using the
commands
DROP USER INTOOLS_LOGIN CASCADE;
DROP USER IN_DBAMN CASCADE;
Substitute the default Admin schema logon name IN_DBAMN with your value.
5. Delete the SmartPlant Instrumentation tablespaces one by one using the commands
DROP TABLESPACE MAIN_TS INCLUDING CONTENTS AND DATAFILES;
DROP TABLESPACE INDEX_MAIN_TS INCLUDING CONTENTS AND DATAFILES;
DROP TABLESPACE TEMP1_TS INCLUDING CONTENTS AND DATAFILES;
Use your tablespace names in place of the default names displayed in the SQL
commands.

See Also
Setting Up a Database for Oracle Common Tasks (on page 13)
SmartPlant Instrumentation Database Setup for Oracle (on page 11)
Oracle Database Server Tablespaces for SmartPlant Instrumentation (on page 11)

20

SmartPlant Instrumentation Administration User's Guide

SECTION 3

SmartPlant Instrumentation Database

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

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

SQL Server Database Server Filegroups for

SmartPlant Instrumentation
An SQL Server filegroup is a logical category that connects a database with operating system
data files. The DB Setup Utility for SQL Server creates the following filegroup types:
Admin data used for the Administration schema logon settings (see the following
paragraph). The database contains the Admin schema logon data.
Index data used for the Administration schema logon settings. The database contains the
SmartPlant Instrumentation domain index of a single domain.

SmartPlant Instrumentation Administration User's Guide

21

SmartPlant Instrumentation Database Setup for SQL Server

Domain used for the Domain schema logon information. The database contains domain
data of a single domain (there is a different schema logon setting for each domain).
Index used for the Domain schema logon information.
Log file used internally by SQL Server to resume any previous sessions that were
stopped.
View-Only Domain schema (an individual schema for each domain)
The DB Setup Utility creates SmartPlant Instrumentation domain files using the following default
file values:

Parameter

Admin Datafile

Index Datafile

Log Datafile

Filegroup name

primary

intools_dba_index

log

Data file name

intools_pr.db

intools_ix.db

intools_l.db

File size

15 MB

5 MB

50 MB

Administration data (admin data files and index data files), SmartPlant Instrumentation database
log file and history data are based on four filegroups: two SmartPlant Instrumentation default
filegroups and two SQL Server filegroups. The SQL Server filegroups cannot be edited. The
default total file size in these filegroups is 70 MB. Each filegroup is based on an auto-extended
data file. Such a file automatically extends to the limits of your disk.
The following table lists important statistical data that you can use as a guide when selecting the
domain file sizes (the disc space required for such a domain is 650 MB):
Item Types

Quantity (Average)

Instrument tags

45058

Loops

16616

CAD loop drawing blocks

1381

Device panels

11384

Junction boxes

504

Marshaling racks

45 (208366 total number of terminals)

Cabinets

36

DCSs and PLCs

108

Channels

16880

Specifications

111

P&ID drawings

855

Lines

3132

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

22

Admin Datafile Admin Index

Datafile

Domain Datafile Domain Index

Datafile

Log Datafile

15 MB

350 MB

50 MB

5 MB

180 MB

SmartPlant Instrumentation Administration User's Guide

SmartPlant Instrumentation Database Setup for SQL Server

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

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.

Setting Up a Database for SQL Server Common Tasks

The following tasks allow the System Administrator to create and configure a SmartPlant
Instrumentation database for SQL Server running the DB Setup Utility, supplied with SmartPlant
Instrumentation. You can create one SmartPlant Instrumentation database per database setup
session. After a successful database setup session, you can log on to the Administration
module of SmartPlant Instrumentation as System Administrator and initialize SmartPlant
Instrumentation domains in your database. For a complete list of tasks, click the appropriate
topic on the Contents tab and then click the procedure that you want.

Set Up a SmartPlant Instrumentation Database for SQL Server

Use this procedure to run SmartPlant Instrumentation database setup in your SQL Server
instance. You define filegroups and other parameters required for the SmartPlant
Instrumentation database. The setup provides default parameters and values that you can
accept or modify. The default file sizes are recommended as initial values. When connecting
to the SQL Server database, you provide a logon name and a logon password. This logon
information is different from the logon information required to log on to SmartPlant
Instrumentation. You define the SQL Server database server logon information during this
procedure. For more information, see Set Up a SmartPlant Instrumentation Database for SQL
Server (on page 24).

Clean Up the SQL Server Database

Use this procedure to clean up the SQL Server database by deleting SmartPlant Instrumentation
database objects created during a specific database setup session. You must perform this
procedure if a database setup did not complete successfully and you want to run the same
setup again. You clean up the database using SQL Server tools. For more information, see
Clean Up the SQL Server Database (on page 26).

See Also
SmartPlant Instrumentation Database Setup for Oracle (on page 11)
SmartPlant Instrumentation Database Setup for SQL Server (on page 21)

SmartPlant Instrumentation Administration User's Guide

23

SmartPlant Instrumentation Database Setup for SQL Server

Set Up a SmartPlant Instrumentation Database for

SQL Server
The paths you specify in this procedure refer to the database server local
folders (non-network folders). Do not use network drives or network server names in the
paths.
1. On your Windows Start menu, navigate to the Intergraph SmartPlant Instrumentation
program icons and click DB Setup Utility.
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 [Link] file, created during SmartPlant
Instrumentation installation.
Type the required name of the target database server machine or another named
instance to which you want to connect for the SmartPlant Instrumentation database
setup.
3. Under System Administrator logon password, type the appropriate password if required
or leave this field empty if the password is not required.
4. Click Connect to connect to the SQL Server database on your server machine and open the
Target Database Parameters dialog box, where you can set parameters for the target
SmartPlant Instrumentation database and start the database setup process.
If you changed the Server name setting, when you click Connect, in the [Database]
section of the [Link] 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.
The SmartPlant Instrumentation database name must be unique within your SQL
Server that you specified on the Microsoft SQL Server Connection dialog box.
6. Under Admin schema, accept the default Admin schema logon name SPI_DBAMN or
modify the name as you require, provided that you type a setting that is different from the
Admin schema logon password.

24

The logon name can only start with a letter and may not contain spaces. You can use
an underscore (_) to indicate a space.
If this is the first database setup session for SmartPlant Instrumentation 2009 in the
current SQL Server database, the logon name must be unique in the SQL Server
database server.
If this is not the first database setup session, you can use an existing Admin schema
logon name but in this case, you must also use the existing Admin schema logon
password. You can only use an existing Admin schema logon name if the password in
that Admin schema is different. For example, if in another SmartPlant Instrumentation
database, the Admin schema logon name is IN_DBAMN, and the password is also
IN_DBAMN, you cannot use IN_DBAMN for the Admin schema in the new SmartPlant
Instrumentation database.

SmartPlant Instrumentation Administration User's Guide

SmartPlant Instrumentation Database Setup for SQL Server

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

The logon password can only start with a letter and may not contain spaces. You can
use an underscore ( _ ) to indicate a space. If you want to encrypt the password, see
Encrypt the Admin Schema Logon Password (on page 90).
If this is the first database setup session for SmartPlant Instrumentation 2009 in the
current SQL Server database, the logon password must be unique in the SQL Server
database server.
If this is not the first database setup session, you can either use the existing Admin
schema logon password or type a new password. If you want to use the existing
password, you must also use the existing logon name. If you want to define a new
password, you must also define a new logon name.
The software automatically converts all the password characters to upper case. This
means that after completing the database setup, if you need to connect to the
SmartPlant Instrumentation database externally, you must enter the Admin schema
logon password using upper-case characters.
8. In the subsequent boxes, accept the default parameters or modify them as needed.

If you change the default file size definitions, make sure the total file size that you
specify does not exceed the available empty space on your selected disks. The default
is 70 MB, which includes the size of the file for the recommended initial size of the
Admin data and indexes, and SmartPlant Instrumentation database log file.
Each of the file names must be a legal name.
Each file name must be unique within your database. Special characters are not
supported.
9. Click OK and make sure the database setup process is completed successfully.

If the database setup process is not successful, you cannot use the SmartPlant
Instrumentation database and must manually clean up the SQL Server database before
running the DB Setup Utility again. For details, see Clean Up the SQL Server Database (on
page 26).
On SQL Server 2005, the DB Setup Utility automatically clears the Enforce password
policy check box for each SmartPlant Instrumentation schema login created in the
instance. If your company policy requires that this check box is selected, after completing
the database setup, select the Enforce password policy check box for each of the
SmartPlant Instrumentation logins, that is: SPIsuper and SPI_login, which are created
automatically and shared for all SmartPlant Instrumentation databases, and Admin schema
login, whose name you defined during the current database setup. You will have to select
the Enforce password policy check box every time you create other logins for SmartPlant
Instrumentation schemas. The Domain schema and View-Only Domain schema logins are
created when initializing a domain; the As-Built schema login when creating an owner
operator domain; the Project and Combined Project schema logins when creating a
project. For details about database schemas, in the SmartPlant Instrumentation
Configuration and Maintenance Guide, see SmartPlant Instrumentation Database Technical

SmartPlant Instrumentation Administration User's Guide

25

SmartPlant Instrumentation Database Setup for SQL Server

Review > Logon Data and Database Connection Security > SmartPlant Instrumentation
Database Schemas.

Clean Up the SQL Server Database

The following procedure allows you to clean up the SQL Server 2005 database by using
Microsoft SQL Server Management Studio options.
1. In Microsoft SQL Server Management Studio, on the Connect to Server dialog box, do the
following:
a. From the Server type box, select Database Engine.
b. Connect as SA to open the Object Explorer.
2. In the <server name> > Databases folder, do the following:
a. Expand the Security > Users hierarchy of the target SmartPlant Instrumentation
database to display the database user login names.
b. Remember the Admin schema login name (you will need to delete the Admin schema
login).
c. In the Databases folder, right-click the target SmartPlant Instrumentation database and
click Delete.
When deleting the database, the software also deletes the appropriate filegroups, the
INTOOLS_ENGINEER role, and the SmartPlant Instrumentation database schemas
(database users).
3. In the <server name> > Security folder, expand the Logins folder of the target SmartPlant
Instrumentation database and do one of the following:
If your SmartPlant Instrumentation database is the only database in the current
instance, right-click and delete the following logins: SPI_login, SPIsuper, and the
Admin schema login.
If you have other SmartPlant Instrumentation databases in the current instance,
right-click and delete only the Admin schema login.
The SPI_login and SPIsuper logins are shared for all SmartPlant Instrumentation
databases created in the current SQL Server instance.

26

SmartPlant Instrumentation Administration User's Guide

SECTION 4

Domain Backup, Initialization, and

Deletion
It is possible to back up an entire SmartPlant Instrumentation domain to the backup repository in
Sybase Adaptive Server Anywhere. You must use the INtools_Backup.db database as the
backup repository. INtools_Backup.db is a Sybase Adaptive Server Anywhere database
supplied with SmartPlant Instrumentation. You can use INtools_Backup.db for backing up a
domain even if you do not have a full version of Sybase Adaptive Server Anywhere database
engine. INtools_Backup.db enables you to back up a domain and then use it as a source for
initializing another domain in Oracle or SQL Server. This way, you can restore the backed up
data in another domain in your database platform.
If you intend to work in the backed up domain in Sybase Adaptive Server Anywhere, the
following conditions must be met:
You must have a full version of Sybase Adaptive Server Anywhere database engine
([Link]).
You must rebuild stored procedures and triggers in the backed up domain.
If your domain type is Owner operator, and you want to create an off-site project, you must
back up the entire owner operator domain.

You can only back up data to the backup repository once from a single domain or
project. Therefore, to be able to make several backups, you need to have several copies of
the original Intools_backup.db database. If you have already used Intools_backup.db for a
backup and did not make a clean copy of Intools_backup.db, you can obtain another
Intools_backup.db by installing on another machine and then using it as a source for making
copies. The name of the clean copy must always be Intools_backup.db.
The backup repository and its copies are only compatible with the current version of
SmartPlant Instrumentation. After you install a new service pack for the current version, you
can only use the backup repository that is supplied with the service pack.
When backing up a domain, the software does not back up the audit trail data from the
CHANGES_LOG table.. Therefore, before performing the domain backup, you must make
sure that you trimmed all the audit trail data. Then, you can back up the trimmed audit trail
data manually. For details, see Backing up Files Containing Audit Trail Data. (see "Backing
Up Files Containing Audit Trail Data" on page 32)
When you back up a domain, the software records the backup session information in the
[Link] file. The software creates this file in the SmartPlant Instrumentation home folder
when you initialize your first domain, and then, uses this file for recording information during any
subsequent initialization or backup session. Information in this file includes information about
errors that can occur when backing up data into the Domain schema of the INtools_Backup.db
database.
The backup procedure involves the following sequence of operations:
1. Connecting to the target Sybase Adaptive Server Anywhere database
2. Connecting to the database containing a domain you want to back up
3. Selecting a domain for backup
4. Backing up the domain to the backup repository

SmartPlant Instrumentation Administration User's Guide

27

Domain Backup, Initialization, and Deletion

Domain Backup Common Tasks

As System Administrator, you are responsible for backing up a domain to the backup
repository. It is only possible to back up one domain at a time.

Back Up a Domain
This procedure enables the System Administrator to select an existing domain on the server
database on SQL Server or Oracle and then back up this domain to the backup repository. The
backup repository is the INtools_Backup.db database, which is a Sybase Adaptive Server
Anywhere database, created automatically during SmartPlant Instrumentation setup. For more
information, see Back Up a Domain (on page 28).

Back Up a Domain from the Command Line

This topic explains how to back up a domain to INtools_Backup.db database without using the
Administration module options of SmartPlant Instrumentation. For more information, see Back
Up a Domain from the Command Line (on page 29).

Back Up a Domain in Thin Client Mode

This topic explains domain backup parameters that you need to include in a batch file for
backing up a domain when working with SmartPlant Instrumentation in thin client mode (via
Citrix). After defining the appropriate parameters, you run the batch file on the Citrix server to
back up the target domain. You do not have to use the Administration module options of
SmartPlant Instrumentation when backing up a domain in thin client mode. For more
information, see Back Up a Domain in Thin Client Mode (on page 30).

Workaround for the INtools_Backup.db Connection Problem in Windows Vista and

Windows 7
This workaround enables you to resolve the problem of connecting to the INtools_Backup.db
database in Windows Vista and Windows 7. This problem occurs if the User Account Control in
Windows Vista and Windows 7 is set to On. To resolve this problem, you need to temporarily
set the User Account Control in Windows Vista and in Windows 7 to Off. For more information,
see Workaround for an Initialization Problem in Windows Vista and Windows 7 (on page 60).

Back Up a Domain

If you work in thin client environment, for example, Citrix, you must copy the [Link] file to
the SmartPlant Instrumentation home folder on the server machine to be able to perform a
backup procedure. On backup completion, remove the [Link] file from the server
machine.
If you want to back up a domain in Windows Vista or in Windows 7, you might need to
temporarily turn off the User Account Control in Windows Vista. For details, see
Workaround for an Initialization Problem in Windows Vista and Windows 7 (on page 60).
1. With the System Administration window open, click File > Backup.
2. On the Backup Repository dialog box, click Browse to select the Intools_backup.db
database file, and display it in the Target database name and path box.
3. Click Connect to connect to the backup repository and to the current database.

28

SmartPlant Instrumentation Administration User's Guide

Domain Backup, Initialization, and Deletion

4. On the Back Up Domain dialog box, from the Domain list, select the domain which you
want to back up.
5. Select Save last created ID for merging renamed items to save the ID of the last item that
was created in the domain. You can select this option if you later intend to merge items in
the Merger Utility. For details, the check box description in the Help topic for the Back Up
Domain dialog box.
6. If required, select Copy users to target domain to copy the user definitions from the
source domain to the target Sybase Adaptive Server Anywhere database file.
The software can only copy those users who are assigned to groups.
7. If required, select Copy departments to target domain to copy the department definitions
from the source domain to the target Sybase Adaptive Server Anywhere database file.
8. Click OK to start the backup process and monitor the progress on the Backup Information
dialog box.

The name of the backed up domain is Intools_backup. The Domain schema name and
passwor