Install Oracle Database 12.1.0 or 19.3.0

To install Oracle Database 12.1.0 or 19.3.0, follow instructions in the Oracle Database Installation Guide, making selections appropriate for Oracle Clinical as noted in the following sections.

You can configure database(s) as part of the database software installation or after, using the Database Configuration Assistant (DBCA).

Oracle Clinical supports installation on either a Container Database (CDB) containing a Pluggable Database (PDB) or a non-CDB database.

For an explanation of which options require an additional license, see the Database Licensing Information User Manual at:

Install and Configure Oracle Database

Oracle recommends that you set up a new database instance so that neither Oracle Clinical nor its installation process interferes with other applications. However, you can install Oracle Clinical on an existing Oracle database.

When you configure the database, select the following options for Oracle Clinical:

Doc bug 28917364: Update the following list.

  • Custom Database template (recommended)
  • Oracle JVM (required)
  • Oracle Text (required for TMS only)
  • Accept connections as a service instead of a SID. Service name requirements for Oracle Clinical include:
    • The service name must be less than 15 characters long.
    • It must not include the domain.
    • It must be all lowercase.

      Note:

      If you are installing the Oracle Clinical database on a pluggable Oracle 12.1.0.2 database (PDB), see My Oracle Support article ID 1910177.1, How To Configure TNS / SQLNET using the local_listener parameter for Pluggable Database In Oracle 12c, Allowing a SQLNET Connection to the PDB.
  • Check that required tablespaces exist, and have Autoextend on:

    • SYSTEM
    • TEMP
    • UNDOTBS1
    • USERS
    • SYSAUX
  • Initialization Parameters. The Required and Recommended Initialization Values in the init.ora File table below shows the required or recommended values for Oracle Clinical. For parameters that accept a value within a range, the minimum values are given.

    Tip:

    Parameters are listed in alphabetical order. In the Database Configuration Assistant, you can click the Parameter column to display the parameters in the same order. You may need to select Advanced Parameters to see all of them.

    Note:

    For an existing database, if you make any changes to the initialization parameters, restart the database for the new settings to take effect.

    • Automatic Memory Management (recommended)
    • Sizing: From the Block Size drop-down, select 16384 Bytes.
    • Character Set: See Choose a Character Set.

The following get installed by default in Oracle Database 12.1.0.2 with the Custom Database template selected:

  • Distributed Database Option and Advanced Replication Option (only if you are using Oracle Clinical Distributed Study Conduct (Replication))
  • Oracle Partitioning
  • Oracle XML DB
  • Oracle Text, Java Virtual Machine (JVM), and Oracle XML DB are configured automatically if you select the Custom Database template.

Table 2-3 Required and Recommended Initialization Values in the init.ora File

Parameter Value Comments

OPTIMIZER_ADAPTIVE_STATISTICS (for Database 19c only)

FALSE

Controls adaptive statistics. Some query shapes are too complex to rely on base table statistics alone, so the optimizer augments these statistics with adaptive statistics.

OPTIMIZER_ADAPTIVE_PLANS (for Database 19c only)

FALSE

Controls adaptive plans. Adaptive plans are execution plans built with alternative choices that are decided at run time based on statistics collected as the query executes.

COMPATIBLE

For 12c: 12.1.0.2

For 19c: 19.3.0.0

Specifies the release with which the Oracle server must maintain compatibility.

DB_BLOCK_SIZE

16384 bytes

You cannot change this value after you create the database.

DB_CACHE_SIZE

150 MB

Recommended value for 50 to 60 concurrent users. Adjust this value according to your organization's needs.

DB_DOMAIN

null

DO NOT set this value. From Release 5.1 onward, setting this value causes problems with the Patient Data Report generation.

DB_FILES

200

Oracle adds needed space to the control files up to the number specified in the DB_FILES parameter.

EVENT

31151 trace name context forever, level 0x100

Required for HTML generation.

NOTE: Do not include the EVENT parameter when you create the database. Once the database is created, you can add the EVENT parameter to the init.ora file.

JAVA_POOL_SIZE

50 MB

Recommended value for 50 to 60 concurrent users. You can change the value of this parameter after installation. Set this parameter to a value as per the number of concurrent users accessing the system.

JOB_QUEUE_PROCESSES

10

Developer-specific parameter. You can change the value of this parameter after installation.

LARGE_POOL_SIZE

50 MB

Recommended value for 50 to 60 concurrent users.

MEMORY_MAX_TARGET

1000 MB (minimum)

Adjust this value according to your organization's needs.

MEMORY_TARGET

1000 MB (minimum)

Adjust this value according to your organization's needs.

NLS_DATE_FORMAT

DD-MON-RRRR (default value)

Determines the format in which client applications running on the Windows server transfer date information to and from the database. The format must specify the year as RRRR.

NLS_LENGTH_SEMANTICS

BYTE

The CHAR value for this parameter is not supported.

OPEN_CURSORS

800 or greater

You can change the value of this parameter after installation.

OPTIMIZER_DYNAMIC_SAMPLING

2 or greater

The default setting is 2. Oracle recommends using dynamic sampling for Batch Data Load temporary tables; see the Oracle Clinical Administrator's Guide.

OPTIMIZER_FEATURES_ENABLE

For 12c: 12.1.0.2

For 19c: 19.1.0

Acts as an umbrella for enabling a series of optimizer features based on an Oracle release number.

NOTE: Oracle Clinical 5.2.2 is certified on the Oracle Database 12c (12.1.0.2) optimizer features.

PGA_AGGREGATE_TARGET

200 MB

Recommended value for 50 to 60 concurrent users. You can change the value of this parameter after installation.

REMOTE_LOGIN_PASSWORDFILE

EXCLUSIVE

The database must be set up to use password file authentication.

SEC_CASE_SENSITIVE_LOGON

FALSE

Lets you enter passwords without case sensitivity.

SESSIONS

500 or greater

You can change the value of this parameter after installation.

SGA_MAX_SIZE

600 MB (minimum)

Recommended value for 50 to 60 concurrent users. Adjust this value according to your organization's needs.

SGA_TARGET

600 MB (minimum)

Recommended value for 50 to 60 concurrent users. Adjust this value according to your organization's needs.

SHARED_POOL_SIZE

150 MB (minimum)

Recommended value for 50 to 60 concurrent users. You can change the value of this parameter after installation.

UNDO_MANAGEMENT

AUTO

Specifies which undo space management mode the system uses. When set to AUTO, the instance starts in Automatic Undo Management (AUM) mode.

UTL_FILE_DIR

opa_home\xmltemp

Specifies each directory you access.

Required to support Oracle Clinical PDF layout generation.

For Windows environments, samples of the valid syntax are as follows:

UTL_FILE_DIR=c:\e2b\import

UTL_FILE_DIR=c:\opapps\xmltemp

In a UNIX environment, UTL_FILE_DIR requires an entry with two specified paths: one with and one without a trailing slash. Add these lines before any other UTL_FILE_DIR entries:

UTL_FILE_DIR=/usr/opapps/oc/xmltemp/

UTL_FILE_DIR=/usr/opapps/oc/xmltemp

Modify the tnsnames.ora File on the Database Server

There is a tnsnames.ora file in at least two locations in the installation. Oracle recommends maintaining a master file and copying it to each location whenever you add a database. See Modify the tnsnames.ora File on the Application Server for the application server locations.

  1. Navigate to the tnsnames.ora file in the following directory on the database server:
    Oracle_Home/network/admin
  2. Enter a connect string for each database that matches the database’s service name.
  3. If there are multiple Oracle homes, maintain tns entries for all databases in a central location; for example: /etc/tnsnames.ora.
  4. If you are using disconnected replication, you must make additional edits to tnsnames.ora. See Create a Wallet Credential for the RXC_DISC_REP Database User (UNIX) or Create a Wallet Credential for the RXC_DISC_REP Database User (Windows).

Create the oinstall User Group

Use instructions in the Oracle Database 12.1.0.2 Installation Guide chapter "Configuring Users, Groups and Environments for Oracle Database."

  1. Check if the oinstall user group exists.
  2. If it does not exist, create it.

Check Required Tablespaces

The table below lists the tablespaces, along with their minimum size, required for Oracle Clinical. Make sure the database contains these tablespaces. The best practice is to create them with the Autoextend On option, to avoid running out of space.

In addition, you may need to increase the minimum sizes for your installation.

Table 2-4 Required Tablespaces and Sizes

Tablespace Minimum Size

SYSTEM

900 MB

TEMP

100 MB

UNDOTBS1

700 MB

USERS

500 MB

SYSAUX

600 MB

Performance Tuning Step for Pluggable Databases

To prevent performance issues, specifically with accessing dba_synonyms view, take these steps. See My Oracle Support doc ID 2033658.1 for more information.

  1. Run the following statement:
    alter system set "_common_data_view_enabled" = false scope=both;
    
  2. Restart the database.

Modify the tnsnames.ora File on the Database Server

The tnsnames.ora file must have a connect string entry for each database that matches the database’s service name. There is a tnsnames.ora file in at least two locations in the installation. Oracle recommends maintaining a master file and copying it to each location whenever you add a database. See Modify the tnsnames.ora File on the Application Server for the application server locations.

The tnsnames.ora file is on each database server at: oracle_home/network/admin.

If the database server has multiple Oracle Homes, the tns entries for all databases should be maintained in a central location; for example: /etc/tnsnames.ora.

For the requirements for disconnected replication, see Section 5.4.3.2, "Create a Wallet Credential for the RXC_DISC_REP Database User".