You are on page 1of 12

SECTION 17

Upgrading SmartPlant Instrumentation


This part of the guide describes the procedure for upgrading the SmartPlant Instrumentation
database to Version 2013. The purpose of the upgrade procedure is to adapt the data model
of the existing database to the requirements of Version 2013. SmartPlant Instrumentation
database upgrade is performed in two stages. First, you need to upgrade the Admin schema,
and then open the Administration module and upgrade individually each domain that exists in
the database. If you have a database of an earlier version than the version of the current
installation, you are prompted to upgrade your current database when you start the
Administration module or SmartPlant Instrumentation.

In this guide, whenever a string appears in brackets, type the desired value substituting the
entire string, including the brackets. For example: instead of <Oracle home folder>, type
c:\orawin.
If you encounter problems during the upgrade process, contact your local SmartPlant
Instrumentation provider or Intergraph Support. To locate your Intergraph Support
service provider, use a World Wide Web browser to connect to
http://support.intergraph.com (http://support.intergraph.com/).

See Also
Prerequisites for Upgrading to Version 20 (see "Prerequisites for Upgrading to Version 2013" on
Database Upgrade (on page 136)
Post-Upgrade Tasks (on page 140)

Prerequisites for Upgrading to Version 2013


There are various prerequisites you must complete before upgrading SmartPlant
Instrumentation to Version 2013. Some prerequisites are general tasks you must perform
regardless of the data your database contains or features of SmartPlant Instrumentation that
your user's work with. For example, you must perform a thorough database check before
upgrading. Other tasks are related to specific options of the software.

General Prerequisites
General prerequisites deal with freeing disk space and performing a database check. Also, you
need to make sure that your source version of SmartPlant Instrumentation and the database

SmartPlant Instrumentation Installation and Upgrade Guide 131


Upgrading SmartPlant Instrumentation

platform where SmartPlant Instrumentation resides allow you to complete the upgrade
procedure for Version 2013.

Perform a Database Check and Make Domain Backups


1. For each domain in the database you want to upgrade, run the DBChecker Utility by clicking
the checkdb.exe file, located in the SmartPlant Instrumentation home folder. For details, see
the DBChecker Utility User's Guide.
2. If the DBChecker Utility finds problems, contact Intergraph Support personnel, who can help
you fix the problems.
3. After fixing all the problems, make domain backups. For details, see the appropriate topics in
the Administration User's Guide, Domain Initialization, Backup, and Deletion.

Free Disk Space on Oracle


Upgrading to Version 2013 requires significant working space in the Oracle tablespaces.
Therefore, check whether all the datafiles in the Oracle tablespaces are set as
autoextended. Make sure that you have enough free space on the disk where the datafiles
are located. Also, make sure that the maximum size for each datafile in the tablespaces is
large enough or set as unlimited.
Consider the following scenarios:
If the datafiles in a tablespace are not autoextended, and the total datafile free space is less
than half the total datafile used space, you must either resize the tablespace using your
Oracle tools or add more datafiles for the tablespace using the Administration module
option Add Datafiles on the DBA menu of the System Administration window.
If the datafiles in a tablespace are autoextended but the total free space on the disk where
the tablespace is located is less than half the total datafile used space, you must create
additional datafiles for this tablespace on another disk.

Free Disk Space on SQL Server


Upgrading to Version 2013 requires significant working space in the SQL Server
filegroups. Therefore, check whether all the datafiles in the SQL Server filegroups are set to
automatically grow files. Make sure that you have enough free space on the disk where the
datafiles are located. Also, make sure that the maximum size for each datafile in the
filegroups is large enough or set as unrestricted.
Consider the following scenarios:

132 SmartPlant Instrumentation Installation and Upgrade Guide


Upgrading SmartPlant Instrumentation

If the datafiles in a filegroup are not set to automatically grow files, and the total datafile
free space is less than half the total datafile used space, you must either resize the
filegroup using your SQL Server tools or add more datafiles for the filegroup using the
Administration module option Add Datafiles on the DBA menu of the System
Administration window.
If the datafiles in a filegroup are set to automatically grow files but the total free space on
the disk where the filegroup is located is less than half the total datafile used space, you
must create additional datafiles for this filegroup on another disk.

Free Disk Space on Sybase Adaptive Server Anywhere


Upgrading to Version 2013 requires significant working space in the Sybase Adaptive Server
Anywhere database file. Therefore, check whether you have enough free disk space to
upgrade the database. The DBspace of Sybase Adaptive Server Anywhere database has a
datafile that is permanently set as autoincremented.

Specific Prerequisites
Specific prerequisites deal with various features and functionalities of SmartPlant
Instrumentation that are used according to specific engineering needs.

Back Up Symbols Used in Enhanced Reports


If you use the Enhanced Report Utility to generate loop drawings and various wiring reports,
we recommend that you back up your customized symbols before installing the latest version
of the Enhanced Report Utility.

Update Customized Symbols

Upgrade a Domain with an Offsite Project


An offsite project is a project that is not part of the database containing the owner operator
domain (As-Built and other projects). If you intend to upgrade an owner operator domain that
has an offsite project, you first need to import this project data back to the owner operator
domain that you want to upgrade. To do so, log on to the Administration module as Project
Administrator, and then, on the Project Activities dialog box, click Import.
Importing an offsite project into an upgraded Owner operator domain is likely to
damage your database.

SmartPlant Instrumentation Installation and Upgrade Guide 133


Upgrading SmartPlant Instrumentation

Upgrading on Oracle
SmartPlant Instrumentation 2013supports Oracle 11g; therefore if you have an earlier version
of Oracle, you must upgrade that version to Oracle 11g.

As a prerequisite for upgrading to Oracle 11g, you must already have an installation of
Oracle 10g.
Every sub-contractor must use SmartPlant Instrumentation in the national environment of
your Oracle client to ensure that units of measure are displayed correctly in the upgraded
version of SmartPlant Instrumentation. For more information, contact Intergraph
Customer Support.

See Also
Database Upgrade (on page 136)

Workflow for Upgrade of SmartPlant Instrumentation on an Oracle


Platform
1. If you are working with Oracle10g upgrade the Oracle database server to Version 11g using
Oracle tools.
After reinstalling Oracle client, make sure that the Oracle client has a correct alias
for establishing a connection between the SmartPlant Instrumentation client application
and the SmartPlant Instrumentation database.

2. On the client machine where SmartPlant Instrumentation is installed, uninstall the existing
version and then install Version 2013.
3. After installing Oracle Client 11g and SmartPlant 2013, use the Smart Upgrade (Admin) to
update your database to Oracle 011g.
4. Create a new instance in Oracle Server 11g. For more information, see Create a New Oracle
Instance (on page 39).
5. Run DBSetup.
6. Initialize a new domain using the upgraded database as your source
7. If you upgraded from a non-Unicode database, create a new Oracle Unicode instance and
initialize domains from the upgraded database to this new instance.
I Some scenarios require that you initialize new domains using the upgraded domains as
a source. You need to familiarize yourself with the domain initialization prerequisites and
procedures pertinent to your database platform. For details, see the Administration User's
Guide, Domain Initialization, Backup and Deletion, Domain Initialization.

134 SmartPlant Instrumentation Installation and Upgrade Guide


Upgrading SmartPlant Instrumentation

In scenarios that involve domain initialization using another domain as a source, you
lose the source audit trail data. Therefore, before implementing such a scenario, we
recommend that you back up the existing audit trail data. For details, see the Administration
User's Guide, Domain Initialization, Backup and Deletion, Backing up Files Containing Audit Trail
Data.

Upgrading on SQL Server


SmartPlant Instrumentation Version 2013 supports SQL Server 2008 and SQL Server 2012,
therefore if you have an earlier version of SQL Server, you must upgrade that version to SQL
Server 2008 or SQL Server 2012. The following workflow can be used as a guide to do this.
In order to upgrade to SQL Server 2008, you must already have installed SQL
Server 2005. In order to upgrade to SQL Server 2012, you must have SQL Server 2008 installed
on your server.
If you have already upgraded to SQL Server 2008 or SQL Server 2012, all you need to do
is install SmartPlant Instrumentation 2013 and run the upgrade on SmartPlant
Instrumentation.

Workflow for Upgrade of SmartPlant Instrumentation on a SQL


Server Platform
1. Install SQL Server 2008 or SQL Server 2012, and during the installation, at the prompt to
upgrade the instance from 2005 to 2008 or 2012, click Yes.
2. Install SmartPlant Instrumentation 2013 and run the upgrade.

Upgrading on Sybase Adaptive Server Anywhere


You need to run an upgrade procedure when upgrading from SmartPlant Instrumentation to
Version 2013. Performing the following workflow will upgrade both the data model and the
Admin schema of SmartPlant Instrumentation.

SmartPlant Instrumentation Installation and Upgrade Guide 135


Upgrading SmartPlant Instrumentation

Workflow for Upgrade of SmartPlant Instrumentation on Sybase


Adaptive Server Anywhere
1. Do the following if you use SmartPlant Instrumentation shipped databases (for example,
IN_DEMO.DB) as your production databases:
a. Make a backup of your databases.
b. Run the ODBC wizard (available on the Windows Control Panel) and rename the profiles of
your databases.
On a 64 bit machine the ODBC wizard is not available from the Windows Control
Panel. To create or update ODBC profiles from the Start menu enter the command:
%systemdrive%\Windows\SysWoW64\odbcad32.exe.
c. Rename the database files.
2. Install SmartPlant Instrumentation 2013 in the same folder as your current installation of
SmartPlant Instrumentation.
When prompted, choose to keep your old database.

3. Copy the INTERMEDIATE.DB file to another location.


You need to have an original copy of INTERMEDIATE.DB so that you can run more
upgrades.

4. After installing Version 2013, make sure that the INTOOLS.INI file still points to the original
database.
If you have any custom views in your database, you must remove them by
running the following SQL on the source database:

"Truncate table external_view_list"

You will need to re-create the custom views again after the upgrade is complete.

5. Start the Administration module and enter as the System Administrator.


6. Run the upgrade procedure when prompted. This will upgrade and initialize the Admin
schema.
7. In the Administration module, open the Domain Definition window and run the domain
upgrade procedure.

Database Upgrade
The software automatically prompts you to upgrade your database when you try to log on to
SmartPlant Instrumentation after installing a new version, allowing you to select which domain
schemas you wish to upgrade.

136 SmartPlant Instrumentation Installation and Upgrade Guide


Upgrading SmartPlant Instrumentation

If you do not upgrade all domains at this stage, you can later manually upgrade
individual domains one by one. For additional information see Upgrade Domain Schemas.
An upgrade to Version 2013 must be followed by:
1. Rebuilding stored procedures and triggers for all domains.
2. Rebuilding projects in As-Built domains.
You must upgrade all the domains in which you want to work in this SmartPlant
Instrumentation version. The time needed for upgrade depends on the database size. For a
large database, the upgrade process can take several hours.
Alternatively, you can upgrade several or all of your schemas (including admin schema) using
batch upgrade (See Batch Upgrade (on page 139)).
.

Upgrade the Database


1. Start the Administration module.
2. In the Logon Information dialog box, enter your System Administrator name and password
and click OK.
3. In the SmartPlant Instrumentation Upgrade window which opens, you can click the Select
log directory icon to specify the folder in which to save log files.

The log file contains the upgrade process information of your current or previous
upgrade session per domain.
The default log file directory is your user's Temp folder. To locate this folder, click the
Windows Start > Run > %temp%.

The SmartPlant Instrumentation Upgrade window displays English as its default


language if there is no support for a specific language.

SmartPlant Instrumentation Installation and Upgrade Guide 137


Upgrading SmartPlant Instrumentation

1. Select the desired schemas to upgrade by selecting the check box next to each, or select the
Select all check box if you want to upgrade all the schemas.

2. Click the Upgrade icon at the bottom to start upgrading all selected domains.
Once the upgrade process begins, each schema's status will update, according to the following:
Requires upgrade schema not selected for upgrade.
Pending schema selected for upgrade.
In progress the schema currently being upgraded.
Progress indicators below the schema grid show the current state and phase of each schema's
upgrade and the overall progress of the upgrade process.
Once upgrade is complete, each upgraded schema may have one of the following statuses:
Upgraded schema successfully upgraded.
Upgraded with errors schema upgraded, with errors
Upgrade failed schema not upgraded.
On completion of the domain upgrade process, the software records the upgrade
session information in a domain-specific log file, in the specified log file location.

Upgrade Domain Schemas


1. After the upgrade process is completed successfully, log on to the Administration module as
System Administrator and on the toolbar, click .
2. In the Domain Definition window, from the domain list, select a domain and then, on the
toolbar, click .

138 SmartPlant Instrumentation Installation and Upgrade Guide


Upgrading SmartPlant Instrumentation

3. In the SmartPlant Instrumentation Schema Upgrade window which opens, you can click
the Select log directory icon to specify the directory to which to save log files.
The default log file directory is your user's Temp folder. To locate this folder, click the
Windows Start > Run > %temp%\SpiUpgradeLog.

4. Select the desired schemas to upgrade by selecting the check box beside each schema, or
select the Select all check box.
Domain schemas which do not require upgrading are grayed-out and cannot be
selected.

5. Click the Upgrade icon at the bottom to start upgrading all selected domains.
6. Once the upgrade process begins, each schema's status will update (for additional
information, see Upgrade the Database).
On completion of the domain upgrade process, the software records the upgrade
session information in a domain-specific log file, in the defined log file location.

7. After upgrading, open SmartPlant Instrumentation and implement the Post-Upgrade Tasks
(on page 140) listed in the current guide.
8. Familiarize yourself with special instructions listed in Schem SPI Special Instructions.pdf
file, which resides in the SmartPlant Instrumentation home folder, and implement the
instructions for the features you consider relevant.
Upgrade of an owner operator domain can take significant time (several hours). You
must allow the software complete the upgrade process once started.

Batch Upgrade
In batch upgrade you can create a .bat file that updates all the desired domains, using the
Administration module mechanism.
To create a batch upgrade file:
1. In Notepad, create a batch file (e.g., BatchUpgrade.bat).
2. Enter a line for each domain you wish to upgrade (starting with a line for the admin schema),
as shown in the example below:
Upgrade 9999 //upgrade admin schema

Upgrade <proj_id> //upgrade specific domain

-silent //optional flag: run in background

For a complete list of domain project IDs, run the following SQL Query: SELECT *
FROM Project.

SmartPlant Instrumentation Installation and Upgrade Guide 139


Upgrading SmartPlant Instrumentation

3. Double-click the batch file to run it and upgrade the defined domains.

If you added the -silent flag to the file, no dialog boxes or messages are shown.
You can schedule the batch file to run at a convenient time using Windows scheduler
(for example, during the night or over the weekend).

Post-Upgrade Tasks
There are various post-upgrade tasks you need to complete to be able to work with SmartPlant
Instrumentation. Some tasks are general tasks you must perform regardless of the data your
database contains or features of SmartPlant Instrumentation that you used before the
upgrade. For example, you must perform a thorough database check after upgrading. Other
tasks are related to specific options of the software. You do not have to complete a task if it
deals with features you never used before upgrading.
See Also
Upgrading SmartPlant Instrumentation (on page 131)

Update Link Definitions for Importing Data into the PANEL Table
If you use the Import Utility to import data to SmartPlant Instrumentation, you must update
the link definitions you use to import data into the PANEL table. When importing data into the
PANEL table, you must make link definitions for both the panel_category_id and
panel_sub_category fields. If you make a link definition for either one of these fields only, the
import does not work correctly.

Perform a Database Check


For each domain in the upgraded database, run the DBChecker Utility and, if problems are
found, contact Intergraph Customer Support. For details, see the DBChecker Utility User's
Guide.

See Also
Perform a Database Check and Make Domain Backups (on page 132)

140 SmartPlant Instrumentation Installation and Upgrade Guide


Upgrading SmartPlant Instrumentation

Rebuild Default Views


After you complete the upgrade, certain default views, which are supplied with SmartPlant
Instrumentation, might become invalid. This is because during the upgrade, the software
makes changes to tables with which the default views are associated. Therefore, we
recommend that after completing the upgrade, the System Administrator rebuild the default
views for all the domains as follows.

You can only rebuild the default views supplied with the SmartPlant Instrumentation
database. You cannot rebuild any user-defined views.
Make sure that all users have logged out of the database before starting this procedure.
1. With the System Administration window open, click DBA > Rebuild Default Views in
Domains.
2. From the Domain list, select the domain whose database views you want to rebuild.
3. In the View-Only Domain schema password box, enter the logon password of the
View-Only Domain schema. The password characters appear masked.
You can change the password only once, when initializing a new domain. If you did
not change the password when initializing the selected domain, enter the default logon
password, which is <Domain schema logon name>_VIEW.

4. If working on SQL Server, type the SQL Server System Administrators password.
5. Click OK to start rebuilding the views of the selected domain.

Rebuild Projects in a Domain on Sybase Adaptive Server Anywhere


This procedure applies to owner operator domains when you are running the software on a
Sybase Adaptive Server Anywhere platform. After completing the database upgrade, the
Domain Administrator must rebuild the projects for each owner operator domain as follows:
1. As Domain Administrator, enter the owner operator domain.
2. Click DBA > Rebuild Projects in Domain.
3. In the data window, select As-Built and those projects for which you want to rebuild the
schemas.
Selecting As-Built is required after initializing an owner operator domain in Sybase
Adaptive Server Anywhere (full engine version).

4. Click OK to rebuild the selected projects.

SmartPlant Instrumentation Installation and Upgrade Guide 141


Upgrading SmartPlant Instrumentation

Optimize Indexes
If you upgraded an Oracle or Microsoft SQL database, you must optimize your indexes before
continuing.
1. Log on to the SmartPlant Instrumentation Administration application as a System
Administrator.

2. Click DBA > Tuning > Optimize Indexes.


For details on using this functionality, see the appropriate topic in the SmartPlant
Instrumentation Administration documentation.

Update Process Data


If your database includes process data, after installing SmartPlant Instrumentation 2013, but
before upgrading the database, you must perform this procedure to be able to edit and save
process data successfully.
1. In the SmartPlant Instrumentation home folder, click SynchronizePD.exe.
2. On the Synchronize Process Data dialog box, select a domain from the list and click Run.

142 SmartPlant Instrumentation Installation and Upgrade Guide