1 Data Model Installation

This chapter describes how to install the OHF Data Model. There are two ways to install the Data Model, depending on how you create the user schemas. The installer can create the user schemas during the installation or you can create them manually, prior to the installation:

1.1 Install the Data Model without Pre-created User Schemas

This section describes how to install the Data Model by using the installer to create fresh user schemas.

  1. Check Prerequisites

  2. Prepare the Installer

  3. Run the Installer

  4. Check the Installation

1.1.1 Check Prerequisites

Install Oracle Database 12.2.0.1 Enterprise Edition.
Make sure that the database compatible parameter is set to 12.2.0.1.0 by connecting to the DBA user and running the query below:
select * from v$parameter where name = 'compatible';

If the parameter is not set to 12.2.0.1.0, ask your database administrator to set it.

If you are installing OHF on an Exadata environment, apply the Oracle database patch 19562381 (Doc ID >19562381.8).
Create a container database with a single pluggable database instance with the help of a Database Administrator.
Make sure the database initialization parameter MAX_STRING_SIZE is set to STANDARD (default value).
Install Java Virtual Machine on the database server.
Set the NLS_LENGTH_SEMANTICS parameter to either CHAR or BYTE, based on your requirements.

For Oracle Healthcare Foundation Globalization Support information, see Oracle Database Globalization Support Guide and set your database character set accordingly.

Enable database connection through SERVICE_NAME. Make sure that you are connecting to the pluggable database instance.

Verify the database connectivity using the following command:

SQL>connect <username>@<hostname>:<port number>/<service name>

or

sqlplus <username>@'(DESCRIPTION=(ADDRESS=(PROTOCOL=TCP)(HOST=<dbhost>)(PORT=<dbport>))(CONNECT_DATA=(SERVICE_NAME=<dbservicename>)))'
Make sure that the Sqlplus utility is available in the installation server.
Make sure that the password expiry notification message does not display for the Sys and system schemas.
To create an encrypted tablespace during the installation, set up your environment for tablespace encryption. For more information, see Oracle Database Advanced Security Guide 12.2. The installer only creates the tablespace and does not handle prerequisites like setting up the keystore, opening it, etc. The installer only checks whether the keystore is open if the sys and system passwords are provided during the installation.
Set the GLOBAL_NAMES database initialization parameter to false.
For remote installations, make sure the following are available on the client machine:
  • Oracle Linux 6.7 (64-bit) OS or above

  • Oracle Database 12.2.0.1.0 client

If you are installing OHF on an Exadata database machine, see the Exadata Machine and Exadata Implementation sections in the Oracle Healthcare Foundation Programmer's Guide.
Table compression strategy is decided based on the number of updates in tables. If the number of updates is high, select the Advanced compression option instead of HCC (QUERY HIGH).
If you are installing OHF on an Exadata environment, selecting the compression type as HCC (QUERY HIGH) will slow down the first few incremental loads.
Make sure that you have an appropriate database license for the compression methods you choose.
The installer does not validate the tablespace data files location. If the database server is on the remote server, make sure the location physically exists or the installer will fail.

1.1.2 Prepare the Installer

Extract the contents of the OHF media pack to your system.
Open the <media_pack_location>/ folder.
Unzip the OHF_721_Linux-x64.zip file where you want to launch the installer using the following command:

unzip -a OHF_721_Linux-x64.zip

Open the Disk1/install folder.
Change the protection on files as follows:

chmod 755 *


1.1.3 Run the Installer

Start the Oracle Universal Installer (OUI) using the following command:

  • If the database server (Exadata or non-Exadata) is on the machine where the installer is running, execute:

    sh runInstaller.sh -local

  • If the database server is on a different machine, execute:

    sh runInstaller.sh -local remote_installation=true

where, the -local option is to install on the local node irrespective of the cluster nodes specified on the installer machine.


Screen Action
Welcome Click Next.
Select a Product to Install Select the Oracle Healthcare Foundation Data Model 7.2.1.0.0 option.
Specify Home Details Enter the installation home name and location.
Verify Installation Prerequisites Verify if all the prerequisites are met before proceeding.
Oracle Client Home Configuration Specify the Oracle (version 12.2.0.1.0) client home path.
Database Configuration Enter values for the following fields:
  • Hostname - By default, the system host name appears. For remote installations, set this value to the host name of the remote machine.

  • Port - By default, the port number is 1521. You can edit this field if required.

  • Service name

  • System user password

  • Sys user password

Table Compression On an Exadata setup, use the following compression options:

Interface Tables schema

  • Hybrid columnar compression (default)

  • No Compression

Data Warehouse schema

  • No Compression (default)

  • Advanced Compression: Preferred if updates are high. If you don't have a license for Advanced Compression, select Hybrid Columnar Compression.

  • Hybrid Columnar Compression

Common Data Mart schema

  • No Compression (default)

  • Advanced Compression

Cohort Data Mart schema

  • No Compression (default)

  • Advanced Compression

Omics Data Bank schema

  • Hybrid columnar compression (default)

On a non-Exadata setup, for each of the above schemas, choose either No Compression (default) or Advanced Compression.

Data Model Configuration Enter values for the following fields:
  • Interface Tables schema name

  • Interface Tables schema password

  • Data Warehouse schema name

  • Data Warehouse schema password

  • Common Data Mart schema name

  • Common Data Mart schema password

  • Omics Data Bank schema name

  • Omics Data Bank schema password

Data Model Configuration Enter values for the following fields:
  • Cohort Data Mart schema name

  • Cohort Data Mart password

  • Enterprise schema name

  • Enterprise schema password

  • Job Engine schema name

  • Job Engine schema password

  • Services schema name

  • Services schema password

Data Model Configuration Enter values for the following fields:
  • Clinical Genomics (cga) schema name

  • Clinical Genomics (cga) schema password

Data Model Configuration Verification Click Next.
Tablespace Data File Location Specify the location of the Tablespace data files. This is the directory on the database server where the data files are created during the installation.

For example,

Unix: /u01/oradata/dbname

ASM: +DATA_EX02/hashas01/datafile

Note:

  • The ASM location must always start with +.

  • The path should not end with /.

Tablespace Details The installer creates the following tablespaces. Make sure that these tablespaces do not exist in the database.
  • hdi_ts - Default tablespace used for Interface tables (hdi) schema

  • hdm_ts - Default tablespace used for Data Warehouse (hdm) schema

  • hcd_ts - Default tablespace used for Common Data Mart (hcd) schema

  • odb_data_ts - Default tablespace used for Omics Data Bank (odb) schema

  • odb_index_ts - Tablespace used for indexes of the Omics Data Bank (odb) schema

  • odb_lob_ts - Tablespace used for LOB columns in the Omics Data Bank (odb) schema

  • cdm_data_ts - Default tablespace used for Cohort Data Mart (cdm) schema

  • cdm_index_ts - Tablespace used for indexes of the Cohort Data Mart (cdm) schema

  • ent_ts - Default tablespace used for Enterprise (ent) schema

  • job_data_ts - Default tablespace for Job Engine (job) schema

  • job_index_ts - Tablespace used for indexes of the Job Engine (job) schema

  • job_store_ts - Database File System (DBFS) store is created as part of the Job Engine installation

  • job_lob_ts - Tablespace used to store LOB data in the DBFS store created for the JOB ENGINE schema user

  • job_tbs_ts - Tablespace used for the DBFS store created for the JOB_ENGINE schema

  • svc_ts - Default tablespace used for services schema (svc)

  • api_ts - Default tablespace used for Clinical Genomics schema (cga)

For each schema, you can edit the default tablespace name, initial size, max size, and tablespace encryption.

Temporary Tablespace Details The installer creates the following temporary tablespaces. Make sure that these tablespaces do not exist in the database.
  • hdi_temp - Temporary tablespace for the Interface tables schema (hdi)

  • hdm_temp - Temporary tablespace for the Data warehouse schema (hdm)

  • hcd_temp - Temporary tablespace for the Common data mart schema (hcd)

  • odb_temp - Temporary tablespace for the Omics Data bank schema (odb)

  • cdm_temp - Temporary tablespace for the Cohort data mart schema (cdm)

  • ent_temp - Temporary tablespace for the Enterprise schema (ent)

  • job_temp - Temporary tablespace for the Job Engine schema (job)

  • svc_temp - Temporary tablespace for the Services schema (svc)

  • api_ts - Temporary tablespace used for Clinical Genomics schema (cga)

For each schema, you can edit the temporary tablespace name, initial size and max size.

Omics Data Bank and Cohort Data Mart Parameters Enter values for the following fields:
  • Result Partition - Used to partition result tables in the ODB schema. The available options are:

    • GENE (Default)

    • STUDY (Deprecated. Use GENE instead)

  • Promoter Offset - Numerical value to specify a portion of the gene used as a promoter in the ODB schema. The default value is 200.

  • Flanking Offset - Numerical value to specify the region before and after a gene to link results to a gene in the ODB schema. The default value is 200.

  • Max Parallel Degree - An option to specify the maximum degree of parallelism to be set on tables or used in the SQL statements for the CDM or ODB schema. It is dependent on the machine configuration of the database server. The default value is 2.

  • Job Store Name - Use the job schema name.

If you are using the same database instance for multiple environments, enter a unique job store name for each job schema.

Summary Click Install.
End of Installation Click Exit after reviewing the installation information. At the confirmation prompt, click Yes to exit the installer.

1.1.4 Check the Installation

Review the generated installation log files for errors. For details, see Installation Log Files.
Contact Oracle support, if necessary, to resolve any errors.

1.2 Install the Data Model with Pre-created User Schemas

This section describes how to install the Data Model by creating OHF user schemas and tablespaces outside the installer, then using the installer to create database objects in the respective user schemas.

  1. Check Prerequisites

  2. Create Default Tablespaces

  3. Create Temporary Tablespaces

  4. Prepare the Installation Files

  5. Create Database Roles

  6. Create User Schemas

  7. Run the Installation Scripts

  8. Start the Installer

  9. Run the Installer

  10. Check the Installation

  11. Revoke Privileges

1.2.1 Check Prerequisites

Install Oracle Database 12.2.0.1 Enterprise Edition.
Make sure that the database compatible parameter is set to 12.2.0.1.0 by connecting to the DBA user and running the query below:
select * from v$parameter where name = 'compatible';

If the parameter is not set to 12.2.0.1.0, ask your database administrator to set it.

If you are installing OHF on an Exadata environment, apply the Oracle database patch 19562381 (Doc ID >19562381.8).
Create a container database with a single pluggable database instance with the help of a Database Administrator.
Make sure the database initialization parameter MAX_STRING_SIZE is set to STANDARD (default value).
Install Java Virtual Machine on the database server.
Set the NLS_LENGTH_SEMANTICS parameter to either CHAR or BYTE, based on your requirements.

For Oracle Healthcare Foundation Globalization Support information, see Oracle Database Globalization Support Guide and set your database character set accordingly.

Enable database connection through SERVICE_NAME. Make sure that you are connecting to the pluggable database instance.

Verify the database connectivity using the following command:

SQL>connect <username>@<hostname>:<port number>/<service name>

or

sqlplus <username>@'(DESCRIPTION=(ADDRESS=(PROTOCOL=TCP)(HOST=<dbhost>)(PORT=<dbport>))(CONNECT_DATA=(SERVICE_NAME=<dbservicename>)))'
Make sure that the Sqlplus utility is available in the installation server.
Make sure that the password expiry notification message does not display for the Sys and system schemas.
To create an encrypted tablespace during the installation, set up your environment for tablespace encryption. For more information, see Oracle Database Advanced Security Guide 12.2. The installer only creates the tablespace and does not handle prerequisites like setting up the keystore, opening it, etc. The installer only checks whether the keystore is open if the sys and system passwords are provided during the installation.
Set the GLOBAL_NAMES database initialization parameter to false.
For remote installations, make sure the following are available on the client machine:
  • Oracle Linux 6.7 (64-bit) OS or above

  • Oracle Database 12.2.0.1.0 client

If you are installing OHF on an Exadata database machine, see the Exadata Machine and Exadata Implementation sections in the Oracle Healthcare Foundation Programmer's Guide.
Table compression strategy is decided based on the number of updates in tables. If the number of updates is high, select the Advanced compression option instead of HCC (QUERY HIGH).
If you are installing OHF on an Exadata environment, selecting the compression type as HCC (QUERY HIGH) will slow down the first few incremental loads.
Make sure that you have an appropriate database license for the compression methods you choose.

1.2.2 Create Default Tablespaces

Create the following default tablespaces. You can use different tablespace names than the ones listed below.


Tablespace Name Big File Tablespace Description
hdi_ts Yes Default tablespace for the Interface Tables (hdi) schema
hdm_ts Yes Default tablespace for the Data Warehouse (hdm) schema
hcd_ts Yes Default tablespace for the Common Data Mart (hcd) schema
odb_data_ts Yes Default tablespace for the Omics Data Bank (odb) schema
odb_index_ts Yes Used for indexes of the Omics Data Bank (odb) schema
odb_lob_ts Yes Used for LOB columns in the Omics Data Bank (odb) schema
cdm_data_ts Yes Default tablespace for the Cohort Data Mart (cdm) schema
cdm_index_ts Yes Used for indexes of the Cohort Data Mart (cdm) schema
ent_ts No Default tablespace for the Enterprise (ent) schema
job_data_ts No Default tablespace for the Job Engine (job) schema
job_index_ts No Used for indexes of the Job Engine (job) schema
job_store_ts No Database File System (DBFS) store created as part of the Job Engine installation
job_lob_ts No Name of the tablespace to store LOB data in the DBFS store created for the JOB ENGINE schema user
job_tbs_ts No Name of the tablespace to be used for the DBFS store created for the JOB_ENGINE schema
svc_ts No Default tablespace used for the Services (svc) schema
api_ts No Default tablespace for the Clinical Genomics (cga) API schema.

1.2.3 Create Temporary Tablespaces

Create the following temporary tablespaces. You can use different tablespace names than the ones listed below.


Tablespace Name Big File Tablespace Description
hdi_temp Yes Temporary tablespace for the Interface Tables (hdi) schema
hdm_temp Yes Temporary tablespace for the Data Warehouse (hdm) schema
hcd_temp Yes Temporary tablespace for the Common Data Mart (hcd) schema
odb_temp Yes Temporary tablespace for the Omics Data Bank (odb) schema
cdm_temp Yes Temporary tablespace for the Cohort Data Mart (cdm) schema
ent_temp No Temporary tablespace for the Enterprise (ent) schema
job_temp No Temporary tablespace for the Job Engine (job) schema
svc_temp No Temporary tablespace for the Services (svc) schema
api_temp Yes Temporary tablespace for the Clinical Genomics (cga) API schema

1.2.4 Prepare the Installation Files

Extract the contents of the OHF media pack to your system.
Open the <media_pack_location>/ folder.
Unzip the OHF_721_Linux-x64.zip file where you want to launch the installer using the following command:

unzip -a OHF_721_Linux-x64.zip


1.2.5 Create Database Roles

Navigate to the directory <media_pack_location>/Disk1/stage/Components/oracle.hsgbu.hc.datamodel/7.2.1.0.0/1/DataFiles/Expanded/filegroup1.
Unzip the master_install.zip file.
Connect to Oracle SYS from the extracted content and create database roles by executing the roles.sql script.

1.2.6 Create User Schemas

Create the following user schemas and assign the appropriate default and temporary tablespaces. Refer to Create Default Tablespaces and Create Temporary Tablespaces for details. If you created tablespaces with different names, use those names instead.


Schema Default Tablespace Temporary Tablespace
Interface Tables (hdi) hdi_ts hdi_temp
Data Warehouse (hdm) hdm_ts hdm_temp
Common Data Mart (hcd) hcd_ts hcd_temp
Omics Data Bank (odb) odb_data_ts odb_temp
Cohort Data Mart (cdm) cdm_data_ts cdm_temp
Enterprise (ent) ent_ts ent_temp
Job Engine (job) job_data_ts job_temp
Services (svc) svc_ts svc_temp
Clinical Genomics (cga) api_ts api_temp

1.2.7 Run the Installation Scripts

Execute the following scripts/commands as a DBA user. When prompted, enter the respective schema names.

When prompted for the application role, enter OHF_APPLICATION_ROLE.

@hdi_install/grant_schema_priv.sql
@hdm_install/grant_schema_priv.sql
@hcd_install/grant_schema_priv.sql
@odb_install/grant_schema_priv.sql

Execute the following commands:

> ALTER USER <odb> QUOTA UNLIMITED on <odb_index_ts>

> ALTER USER <odb> QUOTA UNLIMITED on <odb_lob_ts>

@cdm_install/grant_schema_priv.sql

Execute the following command:

> ALTER USER <cdm> QUOTA UNLIMITED on <cdm_index_ts>

@enterprise_install/grant_schema_priv.sql
@job_install/grant_schema_priv.sql

Execute the following commands:

> ALTER USER <job> QUOTA UNLIMITED on <job_index_ts>

> ALTER USER <job> QUOTA UNLIMITED on <job_store_ts>

> ALTER USER <job> QUOTA UNLIMITED on <job_lob_ts>

> ALTER USER <job> QUOTA UNLIMITED on <job_tbs_ts>

@svc_install/grant_schema_priv.sql

1.2.8 Start the Installer

Make sure that all the OHF schemas are disconnected from the database by querying gv_$session from the sys user:
select * from sys.gv_$session where status <> 'KILLED' and username in ('<OHF Schemas>');
Navigate to the <media_pack_location>/Disk1/install folder.
Change the protection on files as follows:

chmod 755 *

Start the Oracle Universal Installer (OUI) using the following command:
  • If the database server is on the machine where the installer is running and is an Exadata instance:

    sh runInstaller.sh -local dba_tasks=false db_platform=exadata

  • If the database server is on the machine where the installer is running and is a non-Exadata instance:

    sh runInstaller.sh -local dba_tasks=false db_platform=default

  • If the database server is on a different machine and is an Exadata instance:

    sh runInstaller.sh -local remote_installation=true dba_tasks=false db_platform=exadata

  • If the database server is on a different machine and is a non-Exadata instance:

    sh runInstaller.sh -local dba_tasks=false db_platform=default remote_installation=true

The -local option tells the installer to install on the local node, irrespective of the cluster nodes specified on the installer machine.

The dba_tasks=false option tells the installer not to create user schemas and tablespaces.


1.2.9 Run the Installer


Screen Action
Welcome Click Next.
Select a Product to Install Select the Oracle Healthcare Foundation Data Model 7.2.1.0.0 option.
Specify Home Details Enter the installation home name and location.
Verify Installation Prerequisites Verify if all the prerequisites are met before proceeding.
Oracle Client Home Configuration Specify the Oracle (version 12.2.0.1.0) client home path. The installer validates this path.
Database Configuration Enter values for the following fields:
  • Hostname - By default, the system host name appears. For remote installations, set this value to the host name of the remote machine.

  • Port - By default, the port number is 1521. You can edit this field if required.

  • Service name

The installer will not validate the database connectivity. Make sure that you are able to connect to the database from SQLPlus.

Table Compression On an Exadata setup, use the following compression options:

Interface Tables schema

  • Hybrid columnar compression (default)

  • No Compression

Data Warehouse schema

  • No Compression (default)

  • Advanced Compression: Preferred if updates are high. If you don't have a license for Advanced Compression, select Hybrid Columnar Compression.

  • Hybrid Columnar Compression

Common Data Mart schema

  • No Compression (default)

  • Advanced Compression

Cohort Data Mart schema

  • No Compression (default)

  • Advanced Compression

Omics Data Bank schema

  • Hybrid columnar compression (default)

On a non-Exadata setup, for each of the above schemas, choose either No Compression (default) or Advanced Compression.

Data Model Configuration Enter values for the pre-created schemas:
  • Interface Tables schema name

  • Interface Tables schema password

  • Data Warehouse schema name

  • Data Warehouse schema password

  • Common Data Mart schema name

  • Common Data Mart schema password

  • Omics Data Bank schema name

  • Omics Data Bank schema password

Data Model Configuration Enter values for the pre-created schemas:
  • Cohort Data Mart schema name

  • Cohort Data Mart password

  • Enterprise schema name

  • Enterprise schema password

  • Job Engine schema name

  • Job Engine schema password

  • Services schema name

  • Services schema password

Data Model Configuration Enter values for the following fields:
  • Clinical Genomics (cga) schema name

  • Clinical Genomics (cga) schema password

Data Model Configuration Verification Click Next.
Tablespace Details Click Next.
Temporary Tablespace Details Click Next.
Omics Data Bank and Cohort Data Mart Parameters Enter values for the following fields:
  • Result Partition - Used to partition result tables in the ODB schema. The available options are:

    • GENE (Default)

    • STUDY (Deprecated. Use GENE instead)

  • Promoter Offset - Numerical value to specify a portion of the gene used as a promoter in the ODB schema. The default value is 200.

  • Flanking Offset - Numerical value to specify the region before and after a gene to link results to a gene in the ODB schema. The default value is 200.

  • Max Parallel Degree - An option to specify the maximum degree of parallelism to be set on tables or used in the SQL statements for the CDM or ODB schema. It is dependent on the machine configuration of the database server. The default value is 2.

  • Job Store Name - Use the job schema name.

Execute the following query to find all store names in the database (created by all previous installations) by connecting to the SYS user:

SELECT DISTINCT owner,object_type,object_name,created FROM all_objects WHERE object_name LIKE '%JOB_STORE%';

Note: If you have store names in the database that do not match the %JOB_STORE% pattern, run the following query to find the correct names:

SELECT DISTINCT owner,object_type,object_name,created FROM all_objects WHERE owner =<Job Username/schemaname> AND object_type IN ('TABLE','VIEW');

Tablespace Parameters Enter values for the fields below from the existing or pre-created CDM, ODB, and Job engine schemas. Make sure that these tablespaces exist or were created before the installation. Refer to Create Default Tablespaces for the tablespace names to be used.
  • cdm_index_ts_name

  • odb_index_ts_name

  • odb_lob_ts_name

  • job_index_ts_name

  • job_lob_ts_name

  • job_tbs_ts_name

Summary Click Install.
End of Installation Click Exit after reviewing the installation information. At the confirmation prompt, click Yes to exit the installer.

1.2.10 Check the Installation

Review the generated installation log files for errors. For details, see Installation Log Files.
Contact Oracle support, if necessary, to resolve any errors.

1.2.11 Revoke Privileges

After the Cohort Data Mart (CDM) and Omics Data Bank (ODB) data model installation, connect to the database user with DBA privilege, and execute the following scripts to revoke privileges:

REVOKE CREATE ANY DIRECTORY FROM <odb user>

REVOKE CREATE ANY CONTEXT FROM <cdm user>

where,

<odb_user> is the ODB schema name.

<cdm_user> is the CDM schema name.