Setting Up Database Environment Variables

Status

 

If you are...

This task is...

Installing a new iProcess Engine Version 11.8.0

Required

Upgrading from an iProcess Engine Version 11.0 or later

Required

Database

Oracle, DB2

Description

The iProcess Engine uses the following environment variables for communication with the database:

For Oracle

ORACLE_HOME—the directory that contains the appropriate Oracle Server or Client software. See Oracle Database for more information.
ORACLE_SID—the Oracle System Identifier, or SID, which is the name of the Oracle Server instance.

Note 

If you intend to use TNS to connect to a remote Oracle instance (see TNS Connection Requirements for Oracle) the ORACLE_SID environment variable is not used, but is set to a dummy value.

For DB2

DB2PATH—the directory where the DB2 software is installed.
DB2INSTANCE—the name of the DB2 instance that will hold the iProcess Engine database. (If you want to use a new instance for the iProcess Engine database you should create the instance now.)
DB2CONNECT_IN_APP_PROCESS—this DB2 system environment variable must be either set to Yes, or not set (the default setting). If this variable is set to No the iProcess Engine will fail to start.

Node-Cluster

These environment variables must be set up on the master server and on each slave server.

For Oracle

If you are using the Oracle database and installing iProcess Engine on a slave server in an existing node cluster, you need to add TWO_TASK—the Oracle default connect identifier, which defines the default Oracle database to connect to. This is set to the appropriate Oracle Service Name (that is, the entry in the $ORACLE_HOME/network/admin/tnsnames.ora file for the Oracle instance that holds the iProcess Engine tables).

Procedure

Follow the different procedures based on your database type.

For Oracle

Set these environment variables in the shell of the user who is going to run the installer (either root or the iProcess Engine background user).

For DB2

1. Set DB2PATH and DB2INSTANCE in the shell of the user who is going to run the installer (either root or the iProcess Engine background user).
2. Make sure that DB2CONNECT_IN_APP_PROCESS is either set to Yes, or is not set (the default setting). Use the DB2 db2set command to check and, if necessary, reset the value of this variable.

Example

For Oracle

export ORACLE_HOME=/opt/oracle/product/10.2.0.5
export ORACLE_SID=sw10202

For DB2

export DB2PATH=/opt/IBM/db2/V8.2 
export DB2INSTANCE=db2inst1

See Also

See your operating system documentation for more information about how to set environment variables.