02 - SP Instrumentation On Oracle PDF
02 - SP Instrumentation On Oracle PDF
Oracle
Table of Contents
Overview .........................................................................................................................................3
Overview
SmartPlant Instrumentation is designed to use data stored in databases to construct and
maintain your engineering data and domains. Before installing the multi-user SmartPlant
Instrumentation version for Oracle, you need to perform some preliminary procedures such
as installing the Oracle database server, Oracle client, and configuring SmartPlant
Instrumentation for connection to the database server. To install Oracle, you must have
some knowledge of the database installation procedures and basic conventions and features
of your environment (Windows or Unix).
When working in Oracle, you maintain database - user relations by exchanging data with the
database. To do this, Oracle maintains a multi-interface system which provides the required
connection along the data transfer path.
The systems described in the above figure can be physically located on the same computer
or on different computers which are connected on a local network.
The entire installation process contains the following major steps:
1. Installing the Oracle database server. You perform this step only if you have not already
installed the Oracle database server on your system.
2. Installing the Oracle client and verifying the connection to the Oracle database server
You perform this step only if you have not already installed the appropriate Oracle client
on your system.
4. Connecting to the Oracle database and set up the SmartPlant Instrumentation database
for Oracle (by running the DB Setup Utility).
The final stage is to initialize a new domain in Oracle and set the initial parameters of the
domain. This way you prepare the database for creating the domain plant hierarchy and
defining engineering data.
Caution
Note
• In this document, whenever <value> appears in brackets, type the required value
substituting the word 'value' without adding the brackets. For example: instead of
<Oracle home folder> type C:\ORAWIN.
Installing SmartPlant Instrumentation on Oracle 5
System Requirements
This section describes the hardware and software requirements you must meet to be able to
install Oracle and SmartPlant Instrumentation, and also, to enable SmartPlant
Instrumentation to connect and maintain a database on the Oracle database server.
Note
• If you use Unix, make sure you have a compatible Unix machine with at least 700
MB free disk space.
Note
• The Import and Merger utilities require a minimum of 128 MB of hard disk space.
Note
• We recommend that the Oracle client version be the same as the Oracle server
version.
Installing SmartPlant Instrumentation on Oracle 8
8i O84 8i 5.2-7.0
O84 9i 5.3-7.0
9i O84 8i 5.3-7.0
O84 9i 5.3-7.0
O90 9i 6.0-7.0
Note
• For Version 5.3 or 5.4, you can run database setup for Oracle 9i only using
special instructions provided by Intergraph Support.
Installing SmartPlant Instrumentation on Oracle 9
8i
9i
10g
Caution
• To minimize disc space and physical memory required for the Oracle server
database, we recommend that you do not perform a typical installation but
always select a custom installation type when installing Oracle.
Installing SmartPlant Instrumentation on Oracle 10
4. On the Available Products page, select Oracle8i Enterprise Edition 8.1.7 and click
Next.
5. On the Installation Types page, click Custom and then click Next.
6. On the Available Product Components page select the components that you need and
then, click Next.
7. On the Component Locations page, specified a desired location and then click Next.
9. On the Create Database page, click Yes and then click Next.
b) In the SID field, enter the default instance name INTOOLS. It is recommended that
you use the same database and instance name.
c) Click Next.
12. After the software completes the installation and opens the Net8 Configuration Assistant,
on the Welcome page of the Net8 Configuration Assistant, select Perform typical
installation and then click Next to create a listener.
Note
• After creating a listener, the software opens the Configuration Tools page,
where you can review the database creation progress, and also opens the
Oracle Database Configuration Assistant, where you configure the Oracle
server database for SmartPlant Instrumentation. If the listener is not created
automatically, see page 12.
Installing SmartPlant Instrumentation on Oracle 11
13. In the Oracle Database Configuration Assistant, under Select the primary type of
application…, click Multipurpose, and then click Next.
14. On the Enter the approximate number of users… page, in the Concurrently
connected users box, accept or change the value as you need, and then click Next.
15. Under Select the mode…, click Dedicated Server Mode, and then click Next.
16. On the Select the options you want to configure for use in your database page, click
Next.
17. Under Review the following database parameters…, from the Compatible Parameter
list, select 8.1.0 do the following:
18. Click Change Character Set and in a dialog box that opens, do the following:
a) From the Character Set list, select a desired character set.
b) From the National Character Set list, select UTF8 — this value enables you to
initialize a SmartPlant Instrumentation domain from the current Oracle 8i database to
another Oracle 9i database.
c) Click OK.
Caution
20. On the page that has tabs, make changes as you require, and then click Next.
21. On the Review the following redo log file parameter information… page, click Next.
22. On the Review the following logging parameter information… page, click Next.
23. On the Review the following SGA parameter information… page, do the following:
a) In the Shared Pool Size (Bytes) box, change the value to 10000000 (10 million
bytes).
Installing SmartPlant Instrumentation on Oracle 12
b) In the Block Size (Bytes) box, make sure that the value is at least 8192 or change
the value to 16384 or 32768, if you intend to use multiple specifications in the
SmartPlant Instrumentation database.
Cautions
• For the DB_BLOCK_SIZE parameter, the use of a value smaller than 8192 can
cause certain SmartPlant Instrumentation features to stop functioning.
24. Proceed with running the Oracle Database Configuration Assistant till you click Finish.
3. On the Listener Configuration, Listener page, select Add and click Next.
1. Run the AUTORUN.EXE file and on the Oracle9i Server – Autorun page, click
Install/Deinstall Products to launch the Oracle Universal Installer 2.2.
3. On the File Locations page, set the file locations as you require and then click Next.
4. On the Available Products page, click Oracle9i Database 9.2.0.1.0, and then click
Next.
5. On the Installation Types page, click Enterprise Edition (2.86GB), and then click Next.
6. On the Database Configuration page, click Customized, and then click Next.
7. On the Oracle Services for Microsoft Transaction Server page, click Next.
9. After the software completes the installation and opens the Oracle Net Configuration
Assistant, on the Welcome page of the Oracle Net Configuration Assistant, select
Perform typical installation and then click Next to create a listener.
Note
• After creating a listener, the software opens the Configuration Tools page,
where you can review the database creation progress, and also opens the
Database Configuration Assistant, where you need to configure the Oracle
server database for SmartPlant Instrumentation.
10. In the Database Configuration Assistant, on the Welcome page, click Next.
11. On the Step 1 of 8: Operations page, click Create a database, and then click Next.
12. On the Step 2 of 8: Database Templates page, make sure that the New Database
option is selected, and then click Next.
b) In the SID field, enter the default instance name INTOOLS. It is recommended that
you use the same database and instance name.
c) Click Next.
b) Click Standard database features and then, in a dialog box that opens, clear all the
check boxes.
c) Click Next.
15. On the Step 5 of 8: Database Connection Options page, click Dedicated Server
Mode, and then click Next.
b) On the DB Sizing tab, accept the default value 8 or change the value to 16 or 32 if
you intend to use multiple specifications in the SmartPlant Instrumentation database.
c) On the Character Set tab, click Choose from the list of character sets, and then
select a desired character set.
d) From the National Character Set list, select UTF8 — this value enables you to
initialize a SmartPlant Instrumentation domain from the source Oracle 8i database to
the current Oracle 9i database.
Caution
19. On the Step 8 of 8: Creation Options page, select Create Database, and then click
Finish.
20. Complete the Oracle database creation as described in your Oracle Installation Guide.
3. Modifying the LISTENER.ORA file which Oracle will run when carrying out the instance
creation process.
• DB_BLOCK_BUFFERS
• LOG_BUFFER
• SORT_AREA_SIZE
Note
Caution
• For the DB_BLOCK_SIZE parameter, make sure that the value is at least 8192.
When using values smaller than these, some SmartPlant Instrumentation
features cannot function. In your SmartPlant Instrumentation database has
multiple specifications, we recommend that you use the values 16384 or 32768.
Installing SmartPlant Instrumentation on Oracle 17
• Use the following formula to calculate MB RAM for each Oracle 8i, 9i or 10g instance:
MB RAM=(SHARED_POOL_SIZE + (DB_BLOCK_SIZE * DB_BLOCK_BUFFERS) +
LOG_BUFFER + SORT_AREA_SIZE + JAVA_POOL_SIZE +
LARGE_POOL_SIZE)/1024/1024
Caution
• If you use more than one Oracle 8i, 9i or 10g instance, make sure that the
total MB RAM of all instances does not exceed the MB RAM of your server.
5. In the Concurrently connected users field, accept or change the value as required, and
click Next.
7. Clear the check boxes for options that you will not use in your database, and click Next.
8. Do the following:
a) In the Global Database Name field, enter your Oracle 8.1.7 database name.
Note
• It is recommended that you use the same name for database and instance.
Make sure that the database and instance name is different from the existing
database and default instance name.
9. Click Change Character Set and in a dialog box that opens, do the following:
a) From the Character Set list, select a desired character set.
b) From the National Character Set list, select UTF8 — this value enables you to
initialize a SmartPlant Instrumentation domain from the current Oracle 8i database to
another Oracle 9i database.
c) Click OK.
Caution
11. Enter the password for the INTERNAL privileged account. For example, manager.
Confirm the password, and click Next.
12. Accept the minimum configuration of control files for SmartPlant Instrumentation, and
click Next.
13. Proceed with running the Oracle Database Configuration Assistant till you click Finish.
Note
• You need to carry out the following steps to enable trimming audit trail data
of a domain for a selected period. The audit trail records are contained in the
CHANGES_LOG table which exists in each SmartPlant Instrumentation domain
or project if the domain type is Operating owner. You can save the trimmed
audit trail data to an external SQL file, and load it to the CHANGES_LOG table of
a particular domain.
15. Select a disk drive with 300 MB free disk space for the storage of about 1 million records.
Tip
• The name of the new Oracle database appears as the value of the DB_NAME
parameter in the Oracle Instance Configuration file. For example, ORC1.
Installing SmartPlant Instrumentation on Oracle 19
18. Open the Oracle Instance Configuration file INIT.ORA, and do the following:
a) Add parameter line UTL_FILE_DIR=<DRIVE>:\INTOOLSTORAGE\ORC1
3. Repeat steps 10 through 21 of the procedure described in the section Installing Oracle
Database Server 9.2.0 on Windows 2000 on page 13.
Caution
• Make sure that all the passwords, user names, folders, and files of the new
instance are different from those of the existing instance.
2. Checking and modifying the Oracle client character set. You must verify that the
character set parameter value of the NLS_LANG parameter is the same on client and
server. You can find this parameter in the Windows Registry Editor, in the
HKEY_LOCAL_MACHINE\SOFTWARE\ORACLE folder. For details, see page 23.
3. Configuring additional parameters for national language support. For details, see 25.
After the Oracle client installation process is complete, you proceed by installing SmartPlant
Instrumentation. See Running the SmartPlant Instrumentation Installation Setup For Oracle
on page 28 to learn how to install SmartPlant Instrumentation on Oracle. Before you start the
installation process, make sure that the machine (file server or local station) has access to a
CD-ROM drive. If your machine does not have access to a CD-ROM drive, you need to copy
all the installation files from the installation CD to your local hard disk.
Caution
• If you are using Oracle on Unix, make sure that you use UNIX conventions
when entering file location data (using regular slash (‘/’) instead of backslash (‘\’)
and omitting the drive letter).
Caution
• The Oracle client version must be compatible with your Oracle server version.
See SmartPlant Instrumentation Versions Compatibility with Oracle Versions on
page 6 for details.
Installing SmartPlant Instrumentation on Oracle 21
2. Click Next till you open the Available Products page, where you select Oracle Client
8.1.7.
3. Click Next.
4. On the Installation Type page, select Application User (160MB), and click Next.
5. Click Install.
6. When the installation is complete, close the Oracle Universal Installer and restart your
computer.
8. In the Net8 Assistant tree-view, expand the Local folder hierarchy and highlight Service
Naming.
10. On the Welcome page of the Net Service Name Wizard enter a name of the alias. For
example, INtools.
12. On the Protocol page, accept the TCP/IP (Internet Protocol) selection, then click Next.
13. On the Protocol Settings page, in the Host Name field, enter the name of the server
where you have created a new instance for the SmartPlant Instrumentation database.
16. Proceed with the creation of the Oracle client till you click Finish.
Note
• When using Oracle 8i, the NLS_LANG parameter value can be N/A. Therefore, you
might need to specify the appropriate character set manually after completing the
Oracle client installation. For details, see Checking and Modifying Oracle Client
Character Set on page 23.
Installing SmartPlant Instrumentation on Oracle 22
Caution
• The Oracle client version must be compatible with your Oracle server version.
See SmartPlant Instrumentation Versions Compatibility with Oracle Versions on
page 6 for details.
1. Run the AUTORUN.EXE file and on the Oracle9i Server – Autorun page, click
Install/Deinstall Products to launch the Oracle Universal Installer 2.2.
3. On the File Locations page, set the file locations as you require and then click Next.
4. On the Available Products page, click Oracle9i Client 9.2.0.1.0, and then click Next.
5. On the Installation Types page, click Runtime (193MB), and then click Next.
7. After the software completes the installation and opens the Oracle Net Configuration
Assistant, on the Welcome page of the Oracle Net Configuration Assistant, click No, I
will create net service names myself, and then click Next.
8. On the Database Version page, click Oracle8i or later database or service, and then
click Next.
9. On the Service Name page, type the name of the SmartPlant Instrumentation database
created on the Oracle database server machine, and then click Next.
10. On the Select Protocols page, select the Internet protocol TCP, and then click Next.
c) Click Next.
Installing SmartPlant Instrumentation on Oracle 23
12. On the Text page, click Yes, perform a test, and then click Next.
14. On the Net Service Name page, type an alias to establish a connection between the
SmartPlant Instrumentation client application and the SmartPlant Instrumentation
database.
Tip
• The alias name can contain any alphanumeric characters without spaces.
After installing the Oracle client, the alias value appears in the INTOOLS.INI file
as a value of the ServerName parameter in the [Database] section.
15. Complete the Oracle client installation creation as described in your Oracle Installation
Guide.
Note
• When using Oracle 9i, the NLS_LANG parameter value can be N/A. Therefore, you
might need to specify the appropriate character set manually after completing the
Oracle client installation. See the following section for details.
Caution
• The NLS_LANG parameter value must be the same on both the client machine
used for the domain backup and the client machine used for initializing a new
domain. These values must correspond to the database character set in the
source and target Oracle databases.
Installing SmartPlant Instrumentation on Oracle 24
5. Highlight the NLS_LANG parameter in the right hand-side data window and make sure that
the character set in the NLS_LANG parameter value <language_territory>.<database
character set> is the same as the character set on your Oracle server.
1. With the Registry Editor of the Oracle Client machine open, right-click the NLS_LANG
parameter.
3. In the Edit String dialog box, in the Value data field, type the required character set.
You must specify the appropriate national language parameter values prior to performing the
SmartPlant Instrumentation database setup for Oracle.
Prior to performing the configuration procedure, make sure that SmartPlant Instrumentation
supports your language. In the Language Groups section, find your language from the
groups of languages supported by SmartPlant Instrumentation.
Caution
• If your database character set is other than English, Far Eastern, Middle Eastern,
or Spanish (Latin American), you need to configure the
NLS_NUMERIC_CHARACTERS parameter in the client registry prior to initializing a
domain in Oracle.
Language Groups
SmartPlant Instrumentation supports the following national language groups:
• English
• French
• Slav — Russian, Polish, and so forth.
• Western European and Scandinavian — German, Dutch, Norwegian, and so forth.
• Spanish — Spanish of Spain
• Spanish — Latin American
• Portuguese
• Italian
• Baltic — Latvian, Lithuanian, and so forth.
• Far Eastern — Japanese, Korean, and so forth.
• Middle Eastern — Arabic and Hebrew.
Installing SmartPlant Instrumentation on Oracle 26
For character sets of certain language groups, special configuration procedures apply. For
details, see the table below.
Note
Note
• You do not need to perform the following procedure if the NLS_LANG parameter in
the Registry Editor contains values for either the English language, or any of Far
Eastern, Middle Eastern, or Spanish (Latin American) languages.
8. In the Edit String dialog box, under Value data, enter the following values: ., (dot and
comma)
9. Click OK.
Installing SmartPlant Instrumentation on Oracle 28
Caution
• If you add any components to an existing installation, make sure that the version
of the components you install is the same as the version of the existing
installation.
If you upgrade your current version, it is recommended that you backup your current
database before you start the actual installation process. You can do it by performing the
backup procedure. See Installation Guide, Backup and Restore to learn how to perform
backup. If you have database System Administrator access rights, you can also back up your
database by selecting to save a copy of your existing database during the setup procedure.
When you install SmartPlant Instrumentation you need to determine the appropriate access
rights for each user, (regular users, Domain Administrators and System Administrator). See
User’s Guide, Administration Module > Domain Administration > Access Rights to learn more
about access rights in SmartPlant Instrumentation. Therefore, when working in multi-stations
environment, it is recommended to predetermine the network status of each computer:
SmartPlant Instrumentation station — this computer is used only for engineering purposes
(for running SmartPlant Instrumentation modules). On this computer, you do not install the
Admin applications. It is also recommended that you do not install the Import Utility and the
Merger Utility on this computer.
Admin station — this computer which contains the IN_TEMPL.DB database file and is used
for the System and Domain Administrator. On this computer, you install the Admin
applications. On this computer, you can also install the Import Utility and the Merger Utility.
This division is important because maintaining data in the long-term involves continuous
database maintenance and usage monitoring.
Installing SmartPlant Instrumentation on Oracle 29
You install SmartPlant Instrumentation either on the computer where you installed the
database server (file server) or on the local station. Here are some of the environment
characteristics that you should consider when selecting where to install SmartPlant
Instrumentation:
Free disk space — the computer where you install SmartPlant Instrumentation should have
free disk space sufficient for the installation (335 MB for a full installation). See System
Requirements for Oracle on page 5 for additional information.
Network performance — most Oracle databases operate on local networks. Therefore, the
local network data transfer rate significantly influences the overall performance of Oracle and
SmartPlant Instrumentation. Therefore, if the local network under-performs, install
SmartPlant Instrumentation on the local station, to work faster with SmartPlant
Instrumentation features.
SmartPlant Instrumentation components upgrade - you should consider the amount of
work involved in upgrading/re-installing all the copies of SmartPlant Instrumentation on the
local network, in case you install SmartPlant Instrumentation on the stations.
Before you start the installation process, make sure that your computer (file server or local
station) has access to a CD-ROM drive. If your machine does not have access to a CD-ROM
drive, you need to copy all the installation files from the installation CD to your local hard disk.
Note
• If you are upgrading from an existing installation, make sure that all components
of the software are inactive before starting the Setup process.
• If you are using Oracle on Unix, make sure that you use UNIX conventions
when entering file location data (using regular slash (‘/’) instead of backslash (‘\’)
and omitting the drive letter).
Installing SmartPlant Instrumentation on Oracle 30
1. Insert the CD into your CD-ROM drive. The SmartPlant Instrumentation CD Browser
automatically launches if AutoPlay is enabled on your system.
Note
3. On the Welcome page of the Installation for SmartPlant Instrumentation wizard, click
Next.
4. On the License Agreement page, click Display to read the software license agreement
.pdf file, and then click Yes.
Note
6. On the Customer Information page, enter your registration information and click Next.
• Click (Network) to install a client application after you have performed a full
or custom installation of SmartPlant Instrumentation on your application server
machine. See page 36 for details.
Note
10. On the Destination Folder page, specify the SmartPlant Instrumentation folder location.
Note
• If on the Setup Type page, you have selected to perform a customized setup
process, select components on the Select Components page, and click
Next when done. See Installation Guide, SmartPlant Instrumentation Setup
Maintenance and Database Selection > Installing SmartPlant Instrumentation
Components to learn what components are required to work with SmartPlant
Instrumentation.
12. On the Oracle Version page, select your Oracle server version and click Next. For
details about how to install an Oracle server, see Installing Oracle Server on page 9.
15. On the Select Program Folder page, select the program folder where you want Setup to
install the program icons.
Installing SmartPlant Instrumentation on Oracle 32
Caution
• On the Start Copying Files page, after you click Next, Setup immediately
starts copying all the components you selected to the SmartPlant
Instrumentation home folder. To undo this operation you will have to
uninstall SmartPlant Instrumentation. Therefore, if you need to make any
modification to the current Setup selections, click Back before you start
copying the files.
17. On the Start Copying Files page, view the settings of the current Setup session, and
then click Next to start copying the files to your hard disk.
18. On the Setup Status page, view the progress of the file transfer. When the file transfer
is complete, on the Important Notes page, read the text carefully as it contains important
information for the current version.
19. When the file transfer is complete, on the Important Notes page, read the text carefully
as it contains important information for the current version. Click Next when done.
20. In the Readme message box, click Yes if you want to view the Readme file.
Note
21. On the Setup Complete page, click the required option and then click Finish.
You have successfully installed SmartPlant Instrumentation on your computer. See page 37
for a description of the program icons that Setup has installed on your local station. See
SmartPlant Instrumentation Database Setup for Oracle on page 38 to learn how to create a
SmartPlant Instrumentation database on Oracle.
Installing SmartPlant Instrumentation on Oracle 33
Caution
2. When Setup detects an existing installation, in the Choose the Destination Folder
message box, click Yes to install SmartPlant Instrumentation to the existing folder.
Tip
• In the Choose the Destination Folder message box, you can click No to
install SmartPlant Instrumentation to a different folder. In this case, you run
Setup as for a new installation of SmartPlant Instrumentation.
Caution
• If you click No, you lose all the previous preferences and configuration
settings.
Installing SmartPlant Instrumentation on Oracle 34
5. On the Database Installation Options page, do one of the following to determine what
to do with your existing databases, such as in_demo.db (demonstration), intools.db
(empty), and intoolsef.db (with TEF demonstration data):
• Click Keep old databases to keep the old databases so that you can use them after
the installation.
• Click Back up old and install new databases if you are upgrading your software
version. Setup renames the existing INTOOLS.DB to INTOOLS(1).BK, IN_DEMO.DB to
IN_DEMO(1).BK, and INTOOLSEF.DB to INTOOLSEF(1).BK, where (1) is the running
number for the old database.
• Click Overwrite old databases to replace the existing databases.
Caution
• If you overwrite your databases, you lose any user-defined data that you
have in these files.
7. On the Styles.pbd File Installation Options page, do one of the following to determine
what to do with your existing STYLES.PBD file.
• Click Keep the old Styles.pbd to keep the old STYLES.PBD file and use it after the
installation.
• Click Back up old and install new Styles.pbd if you are upgrading your software
version. Setup renames the existing STYLES.PBD file to STYLESOLD(1).PBD, where (1)
is the running number of the old STYLES.PBD file.
• Click Overwrite the old Styles.pbd to overwrite the existing STYLES.PBD file with a
new file.
Note
• The STYLES.PBD file holds user-defined view style settings for the Browse window of
the Instrument Index module.
9. On the Oracle Version page, select your Oracle server version and click Next. For
details about how to install an Oracle server, see Installing Oracle Server on page 9.
12. On the Select Program Folder page, select the program folder where you want Setup to
install the program icons.
Caution
• On the Start Copying Files page, after you click Next, Setup immediately
starts copying all the components you selected to the SmartPlant
Instrumentation home folder. To undo this operation you will have to
uninstall SmartPlant Instrumentation. Therefore, if you need to make any
modification to the current Setup selections, click Back before you start
copying the files.
14. On the Start Copying Files page, view the settings of the current Setup session, and
click Next to start copying the files to your hard disk.
15. On the Setup Status page, view the progress of the file transfer.
16. When the file transfer is complete, on the Important Notes page, read the text carefully
as it contains important information for the current version. Click Next when done.
17. In the Readme message box, click Yes if you want to view the Readme file.
Note
18. On the Setup Complete page, click the required option and then click Finish.
This completes the installation of SmartPlant Instrumentation over a previous Installation.
Installing SmartPlant Instrumentation on Oracle 36
Caution
Caution
• Make sure that the location you select is mapped (that is, it has been
assigned a drive letter) and it is accessible for READ and WRITE operations.
Installing SmartPlant Instrumentation on Oracle 37
3. On the Destination Folder page, select the SmartPlant Instrumentation home folder on
the application server machine and click Next.
Note
Caution
• If you use an existing Oracle server (where you intend to keep your database)
which was not installed according to the instructions in this Installation Guide,
make sure the Oracle database parameters comply with the parameters required
to use SmartPlant Instrumentation. See Oracle Database Server Installation on
page 9 for additional information about the required Oracle server parameters.
You perform the database setup procedure after you finish installing the Oracle database
server, Oracle client, and SmartPlant Instrumentation for Oracle. See Oracle Database
Server Installation on page 9, Oracle Client Installation on page 20 to learn more about the
required software installation.
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.
• Domain view (a different schema for each domain) — provides view access rights to
users. This way these users can only view the data from an external Report viewer
without modifying the database. See Creating a New Domain in Oracle on page 47 to
learn more about this option.
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:
Loops 16616
Marshaling racks 45
Cabinets 36
Channels 16880
Installing SmartPlant Instrumentation on Oracle 40
Specifications 111
Lines 3132
The above entity quantities populate a domain whose tablespace and index sizes are as
follows:
Administration Domain
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, increase the size of the tablespace for the specific domain.
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. In some operating systems, special characters are
not supported.
• You must have Supervisor’s access rights on your local network to perform this
procedure.
• If you are using Oracle on Unix, make sure that you use UNIX conventions when
entering file location data (using regular slash (‘/’) instead of backslash (‘\’) and
omitting the drive letter).
Make sure you have sufficient database resources to run the SmartPlant Instrumentation
database setup. The following data is sufficient for 1000 tags in SmartPlant Instrumentation:
• You should have enough System tablespace:
• The DML Locks (Data Manipulation Language) should be sufficiently high (at least 100).
• You can open more tablespaces (at least 8).
See your Oracle User Guide for further information on these points.
Installing SmartPlant Instrumentation on Oracle 41
Caution
• 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.
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 will terminate the Oracle database setup process.
2. In 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.
Caution
• 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 page
8.
5. In the Server name field, accept or modify the displayed Oracle server connection string.
6. In the System Administrator login password field, accept the given default value
manager (the password is masked), or type the appropriate password.
Note
• If you cannot connect to the Oracle database server using the default
password, contact your Oracle Database Administrator, who has rights to
create a new SmartPlant Instrumentation System Administrator logon
password for connection to the Oracle database server.
7. Click Connect to connect to your Oracle database server and open the Target Database
Parameters dialog box, where you can set parameters for the target SmartPlant
Instrumentation database and start the database setup session.
8. Under Estimated number of domains, type the number of domains you want to create
in the target SmartPlant Instrumentation database.
Caution
• 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 User’s Guide, Administration Module > System Administration
> Database Security > Encrypt the Admin Schema Logon Password for
details.
Note
• Creates tablespaces
• Creates Administration user schema
• Creates Administration tables
• Creates Administration indexes
• Creates Administration primary key
1. Run the DB Setup Utility and in the Oracle Server Connection dialog box, connect to
the new Oracle instance.
Caution
• If ’DISABLEBIND=1’ is not the only value of the Dbparm parameter, make sure
that it is not enclosed by single quotes and is separated from other values by
a comma. For example, DBparm=DISABLEBIND=1,PBDBMS=1
3. In the Target Database Parameters dialog box, enter the required values and click
Create File.
4. After the script file is created, make sure that the ORASETUP.SQL file is located in the
SmartPlant Instrumentation home folder.
• When using Oracle 9i, in SQL Plus or SQL Worksheet type and then 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
Notes
• Oracle 9i does not support Server Manager but only SQL Plus and SQL
Worksheet. However, when using SQL Plus or SQL Worksheet, the script
@< SmartPlant Instrumentation home folder>ORASETUP.SQL does not
complete all the commands required for an initial SmartPlant Instrumentation
database creation on Oracle 9i. Therefore, you must complete an initial
SmartPlant Instrumentation database creation manually. See Step 8 on the
next page. Although you can also other versions of Oracle also support SQL
Plus, we recommend that you use utilities described in Step 5 in the current
procedure.
• Step 8 on the next page refers to SQL Plus only, but also applies to SQL
Worksheet if you are using Oracle 9i.
8. If you run SQL Plus, perform the following steps to complete the creation of the initial
SmartPlant Instrumentation database: clean up the ORASETUP.TXT file manually:
a) In the ORASETUP.TXT file, ignore the error ORA-03217 and find the error ORA-00921.
The error means that the PROJECT table was not created. Return to the
ORASETUP.SQL file and find the following command:
b) Select and copy all the command rows to the Clopboard. In SQL Plus, connect to the
Admin schema, paste the command rows and run the CREATE command to build
the PROJECT table manually.
c) Return to the ORASETUP.TXT file, find the error ORA-00942 and then, copy to SQL
Plus and run the following command:
d) Return to the ORASETUP.TXT file, and look for rows that start with the following string:
SP2-0042...
e) If you found the rows, reopen the ORASETUP.SQL file and find rows that belong to
the following INSERT command:
f) Copy all the INSERT command rows into SQL Plus and run the command.
g) In the ORASETUP.TXT file, find other occurrences of the error ORA-00942, copy the
related commands to SQL Plus and run them.
9. Open the ORASETUP.TXT file again and check for errors. If you find any errors, contact
Intergraph Support.
Installing SmartPlant Instrumentation on Oracle 47
Cautions
• If your database character set is other than English, Far Eastern, Middle Eastern,
or Spanish (Latin American), you need to configure the
NLS_NUMERIC_CHARACTERS parameter in the client registry prior to initializing a
domain in Oracle.
• If you are using Oracle on Unix, make sure that you use UNIX conventions when
entering file location data (using regular slash (‘/’) instead of backslash (‘\’) and
omitting the drive letter).
You can initialize a domain from another source domain only if you have already
established a connection with the source database (Sybase Adaptive Server Anywhere
or Oracle). You do this by using the following values of the DBMS parameter in the
[DATABASE] section of the INTOOLS .INI file:
o ODBC — use when the source domain is in Sybase Adaptive Server Anywhere
o O84 or O90 — use when the source domain is on Oracle
• Creating a new domain from another domain is recommended in the following cases:
o When you move a domain from one database to another.
o When the new domain serves as a backup of the source domain.
o When you want to use the source domain as a standard domain for new domains.
o When you want to create a demo domain using the IN_DEMO domain.
o When you want to work on a domain that you receive from a sub-contractor or an
engineering firm.
Cautions
• The source domain must be of the same database version as the database
version of the new domain which you initialize.
• The database character set and the national character set in the source Oracle
database must correspond to the database character set and the national
character set in the target Oracle database.
• The NLS_LANG parameter value must be the same on both the client machine
used for the domain backup and the client machine used for initializing a new
domain. These values must correspond to the database character set in the
source and target Oracle databases.
Note
• When initializing a domain from a source domain, we recommend that you run
the DB Checker utility for the source domain before starting the initialization
process.
Installing SmartPlant Instrumentation on Oracle 49
If you omit the line, the default OFF will be assumed. You should expect a 4.5 MB file to be
created as a log file. The file name comprises the number of the domain and the .log
extension. The number of the domain reflects the order of domain initialization in your
database. For example, if you initialize your first domain, the software creates the log file
with name 1.LOG. In the event of any problem occurring during the creation of the domain,
you must provide this file with your request for assistance.
During the initialization process the system creates a View-Only Domain schema for each
domain with the name and password of <DOMAIN NAME>_VIEW (where _VIEW is constant). The
View-Only Domain schema is intended for users who need to view the data from an external
report viewer but are not allowed to modify the data. See Installation Guide, Appendix C >
SmartPlant Instrumentation Database Technical Review > Logon Data and Database
Connection Security for further information about using SmartPlant Instrumentation database
schemas.
1. Run the SQLPlus utility and delete the contents of the table where the process stopped.
Type and then run the following:
DELETE FROM <table name>;
COMMIT;
2. In the [DATABASE] section of the INTOOLS.INI file, insert the following line:
INIT_TABLE_CONT=<the table name where the process stopped>.
3. Rerun the domain initialization process.
Note
• If the initialization of the domain fails after the phase of inserting data into
tables, you need to delete this domain and start a new initialization session.
See Deleting an Invalid Domain on page 57 for details.
Caution
• 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.
Installing SmartPlant Instrumentation on Oracle 50
1. Start the Administration module to open the Logon Information dialog box with DBA set
as the default user name.
2. To log in as the System Administrator, in the User name and in the Password data
fields, enter your system administrator’s username and password (the default value is
DBA for both fields).
3. With the System Administration window open, on the File menu, click Initialize.
4. In the Initialize dialog box, in the Domain field, type the required domain name. The
domain name must be unique and contain only alphanumeric characters without spaces.
You can use an underscore ( _ ) to replace a space. You can also use a name of
previously deleted domain.
Caution
• The name of a domain, schema, and password can only start with a letter. If
your password, schema, or domain name starts with a numeral or any
character that is not a letter, the initialization process will fail and SmartPlant
Instrumentation will stop responding.
Note
• You can change the domain name at a later stage in the Administration
module. See User’s Guide, Administration Module > System Administration
> Creating and Managing Domains > Make Domain Definitions to learn how
to modify the SmartPlant Instrumentation domain name.
5. In the Domain schema name box, type the logon name of the Domain schema.
SmartPlant Instrumentation needs to use this name internally to connect to this domain.
The Domain schema name must be unique and typed as one word with no spaces.
You can use an underscore ( _ ) to replace a space.
Installing SmartPlant Instrumentation on Oracle 51
6. In the Domain schema password box, type the logon password of the Domain schema.
The software needs to use this name internally to connect to this domain. See
SmartPlant Instrumentation Database Setup for Oracle on page 38 to learn more about
the database schema logon information in SmartPlant Instrumentation. The Domain
schema password must be unique and typed as one word with no spaces. You can use
any alphanumeric symbol and the underscore ( _ ).
Tip
• You can enter a schema password other than the domain name to enhance
database access security. This way, external users can only view the
database. See the explanation on page 49 for further information about
viewing the database. We recommend that you write down the schema
password and keep it in a safe place.
7. In the View-Only Domain schema password box, accept the default password of the
View-Only Domain schema or change it as appropriate. The default logon password is
<domain name>_VIEW, where the <domain name> segment corresponds to the Domain
schema logon name in the database. The default password and the characters that you
type when changing the password appear masked. The value that you type must be
unique and typed in as one word with no spaces. You can use an underscore (_) to
replace a space.
Tip
8. Do one of the following to determine the type of the domain that you want to initialize:
• Click Operating owner to initialize the domain as a domain with AsBuilt functionality.
The database is partitioned into several schemas: a single schema for AsBuilt and
separate schemas for projects.
• Click Engineering company to initialize the domain as a domain contracted to
design and build plants based on process information. A domain of the Engineering
company type usually involves one set of data which may be revised extensively
during the life cycle of the plant. In this case, the data for each project is maintained
within a single database schema. Once a plant is operational, the domain type can
be changed to Operating owner if required, and the owner can perform the necessary
maintenance and modernization.
Tip
• If you want to run the initialization process without displaying any error
messages during the process, select the Do not display error messages
check box.
Installing SmartPlant Instrumentation on Oracle 52
9. Click OK to open the Domain Tablespace Definition dialog box, where you can define
the tablespace data of the domain for initialization.
Caution
• When working in the Unix environment, you must specify a full path. If you
do not specify a full path, Novell places the tablespace database file in the
Oracle home folder. The paths that you specify in this dialog box refer to the
local folders (non-network folders) of the computer where Oracle is installed.
Do not use network drives or network server names in the paths.
10. 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 field, type the appropriate domain tablespace name.
b) In the Datafile name and path field, type the full path and filename of the tablespace
database file.
c) In the Tablespace size (MB) field, type the appropriate domain tablespace size.
11. To define the domain index tablespace data, under Index data, accept the given default
values or modify them as follows:
a) In the Tablespace name field, type the appropriate domain tablespace name.
b) In the Datafile name and path field, type the full path and filename of the tablespace
database file.
c) In the Tablespace size (MB) field, type the appropriate domain index tablespace
size. The recommended size is 50% of the domain tablespace size.
Note
• For the temporary operation of Oracle in each domain, you can use one
tablespace for all domains, one for each domain, or a combination of
tablespaces. The SmartPlant Instrumentation installation procedure lets you
define a separate temporary tablespace for each domain. Otherwise, you
can use the same temporary tablespace for all domains. The size of the
tablespace should be increased accordingly. Contact Intergraph Support to
receive the appropriate SQL file.
12. To create a separate temporary tablespace for this domain, select the Use domain
temporary tablespace check box to make three additional fields available for editing.
Installing SmartPlant Instrumentation on Oracle 53
13. To define the domain temporary tablespace data, accept the given default values or
modify them as needed. You can use any alphanumeric values without spaces between
them. The temporary tablespace size is recommended to be 50% of the index
tablespace size.
Note
• It is recommended that the domain datafile and the domain index datafile are
stored on separate physical disks.
Caution
Note
Note
1. Open the Initialize dialog box and make the target domain definitions. (You need to
repeat steps 1 through 9 of the procedure described on page 51.)
2. In the Initialize dialog box, click Source to create a new domain using data from an
existing database.
3. In the Source Data Connection dialog box, from the Database type list, select one of
the following:
• Sybase Adaptive Server Anywhere — select if you have a domain created or backed
up in Sybase Adaptive Server Anywhere and then, beside the Database file name
and path field, click Browse to navigate to the source .db file.
• Oracle — select the required Oracle version to initialize the new domain from another
domain that exists in your Oracle database.
Caution
4. Change the Admin schema name and password if needed or accept the displayed
defaults. For more information about SmartPlant Instrumentation schemas, see
Appendix C, SmartPlant Instrumentation Database Technical Review, Logon Data and
Database Connection Security in this Installation Guide.
6. From the Domain list, select a domain to be used as a source for the initialization.
7. Select the Copy users to target domain if you want to copy all the existing SmartPlant
Instrumentation user definitions to the new domain.
8. Select the Copy departments to target domain if you want to copy all the existing
SmartPlant Instrumentation department definitions to the new domain
10. In the Initialize dialog box, click OK to start the initialization procedure.
Note
Caution
You have successfully initialized your domains. See the following procedure to learn how to
continue the domain creation procedure by associating a new domain with SmartPlant
Instrumentation.
Associating a Domain
Domain association is the second stage of the domain creation procedure. The SmartPlant
Instrumentation System Administrator can associate a domain with SmartPlant
Instrumentation after the domain initialization is complete.
Caution
• Before you can associate a new domain, you must initialize it as described on
page 47. A domain that has been initialized from a source database does not
require association.
To associate a domain
• Click .
2. In the Domain Definition dialog box, from the Domain list, select the domain you want
to associate with SmartPlant Instrumentation.
5. From the Standard list, select the appropriate naming convention standard.
Caution
• You cannot change the naming convention standard after you assign the
naming conventions to the first unit. See User’s Guide, Administration
Module > Domain Administration > Naming Conventions to learn more about
the standards supported in SmartPlant Instrumentation.
7. Set the domain features as you require. For details, see User’s Guide, Administration
Module > System Administration > Creating and Managing Domains.
9. Click to save the new domain settings to the SmartPlant Instrumentation database.
The Domain section of the window becomes unavailable.
10. Click to modify the domain data after you have saved it to the SmartPlant
Instrumentation database. The Domain section of the window becomes available.
Note
• If the version of the domain schema you selected in step 2 is different from
the Admin schema version, you need to upgrade your domain schema by
clicking and performing the update procedure. See Installation Guide,
Upgrading SmartPlant Instrumentation to learn more about the upgrade
procedure.
11. Click to close the Domain Definition dialog box and return to the System
Administration window.
Installing SmartPlant Instrumentation on Oracle 57
2. On the System Administration menu bar, on the DBA menu, click Delete Invalid
Domain.
3. In the Delete Invalid Domain dialog box, from the Domain list, select the corrupted
domain that you want to delete. This list does not contain any items if there are no
corrupted domains in the database.
Caution
• Once you click Start, the deletion process begins and you will not be able to
stop it. The duration of the deletion process depends on the stage where the
domain initialization process failed: the later the stage at which the domain
initialization process failed, the longer it will take to delete that domain.
6. Click Close to close the above dialog box and the Delete Corrupted Domain dialog box.
A message is displayed notifying you that the deletion process is completed successfully.