3.2.1 Upgrade Steps

This section describes upgrade steps when you upgrade from CS 8.1.2.7.0 to CS 8.1.2.8.0.

Extract the Installer Kit

To extract the downloaded .zip files:
  1. Extract the OFS_COMPLIANCE_STUDIO-8.1.2.8.0-1of2.zip file from the installer in the download directory using the command: unzip -a OFS_COMPLIANCE_STUDIO-8.1.2.8.0-1of2.zip

    Note:

    You should not extract CS 81280 installer in the same directory where previous version of Compliance Studio is installed.
  2. The OFS_COMPLIANCE_STUDIO-8.1.2.8.0-2of2.zip file should be placed in the same directory where OFS_COMPLIANCE_STUDIO-8.1.2.8.0-1of2.zip file is extracted.

    Note:

    You do not need to unzip the OFS_COMPLIANCE_STUDIO-8.1.2.8.0- 2of2.zip file.
  3. Navigate to the download directory where the installer archive is extracted, and assign execute permission to the installer directory using the following command:

    chmod –R 0755 OFS_COMPLIANCE_STUDIO

    After extracting .zip files, the folder structure should be as follows:

    OFS_COMPLIANCE_STUDIO

    OFS_COMPLIANCE_STUDIO-<version>-1of2.zip

    OFS_COMPLIANCE_STUDIO-<version>-2of2.zip

    The Compliance Studio installer file is extracted, and this OFS_COMPLIANCE_STUDIO directory is obtained and is referred to as <COMPLIANCE_STUDIO_INSTALLATION_PATH>.

    Note:

    Do not rename the application installer directory name after extraction from the archive.

Public and Private Keys

The private.key and public.key files can be reused from the previous version of Compliance Studio instance.

Copy private.key and public.key files from previous version of the Compliance Studio instance and paste in the same path where current version is installed.

File Path: 

<COMPLIANCE_STUDIO_INSTALLATION_PATH>/mmg-home/mmg-studio/conf
<COMPLIANCE_STUDIO_INSTALLATION_PATH>/batchservice/conf
<COMPLIANCE_STUDIO_INSTALLATION_PATH>/mmg-home/mmg-load-to-graph/graphservice/conf
<COMPLIANCE_STUDIO_INSTALLATION_PATH>/mmg-home/mmg-ui/conf

API Token for CS API User

The SSO_TOKEN value can be reused from the previous version of Compliance Studio instance.

To copy the SSO_TOKEN value:

  1. Navigate to the <COMPLIANCE_STUDIO_INSTALLATION_PATH>/mmg-home/bin directory.

    Note:

    This path refers to the previous version of Compliance Studio.
  2. Open the token.out file and copy the SSO_TOKEN value.
  3. Navigate to the <COMPLIANCE_STUDIO_INSTALLATION_PATH>/bin directory.

    Note:

    This path refers to the previous version of Compliance Studio.
  4. Open the config.sh file and update the copied value in the SSO_TOKEN parameter.

SSL Configuration

The .p12 and studio_server.p12 files can be reused from the previous version of Compliance Studio instance.

Copy .p12 and studio_server.p12 files from previous version of the Compliance Studio instance and paste in the same path where current version is installed.

File Path for .p12 and studio_server.p12: <COMPLIANCE_STUDIO_INSTALLATION_PATH>/mmg-home/mmg-studio/conf

Import SSL Certificate to JDK Security

Note:

This section is applicable only when you are upgrading java during the upgrade activity.

For upgrade, see the Import the Certificate to JDK Security section.

Place Key Store File for Secure Batch Service

The studio_server.p12 file can be reused from the previous version of Compliance Studio instance.

Copy the studio_server.p12 file from previous version of the Compliance Studio instance and paste in the same path where current version is installed.

File Path: <COMPLIANCE_STUDIO_INSTALLATION_PATH>/batchservice/conf

Grants for Studio Schema

During the upgrade activity, make sure that the following grants are assigned to the studio schema.

GRANT CREATE SESSION TO <STUDIO SCHEMA USER>;
GRANT CREATE TABLE TO <STUDIO SCHEMA USER>;
GRANT CREATE VIEW TO <STUDIO SCHEMA USER>;
GRANT CREATE TRIGGER TO <STUDIO SCHEMA USER>;
GRANT CREATE PROCEDURE TO <STUDIO SCHEMA USER>;
GRANT CREATE SEQUENCE TO <STUDIO SCHEMA USER>;
GRANT EXECUTE ON DBMS_RLS TO <STUDIO SCHEMA USER>;
GRANT EXECUTE ON SYS.DBMS_SESSION TO <STUDIO SCHEMA USER>;
GRANT CREATE SYNONYM TO <STUDIO SCHEMA USER>;
GRANT EXECUTE ON DBMS_REDEFINITION TO <STUDIO SCHEMA USER>;
GRANT REDEFINE TABLE TO <STUDIO SCHEMA USER>;
GRANT CREATE MATERIALIZED VIEW TO <STUDIO SCHEMA USER>;
GRANT SELECT ON SYS.V_$PARAMETER TO <STUDIO SCHEMA USER>;
GRANT SELECT ON SYS.DBA_FREE_SPACE TO <STUDIO SCHEMA USER>;
GRANT SELECT ON SYS.DBA_TABLES TO <STUDIO SCHEMA USER>;
GRANT SELECT ON SYS.DBA_TAB_COLUMNS TO <STUDIO SCHEMA USER>;
GRANT CREATE RULE TO <STUDIO SCHEMA USER>;
GRANT DROP TRIGGER TO <STUDIO SCHEMA USER>;
GRANT SELECT ON SYS.DBA_RECYCLEBIN TO <STUDIO SCHEMA USER>;
GRANT CREATE JOB TO <STUDIO SCHEMA USER>;
GRANT EXECUTE ON DBMS_LOCK TO <STUDIO SCHEMA USER>;
GRANT EXECUTE ON DBMS_STATS TO <STUDIO SCHEMA USER>;
GRANT ANALYZE TO <STUDIO SCHEMA USER>;
GRANT CREATE TYPE TO <STUDIO SCHEMA USER>;
GRANT EXECUTE ON CTXSYS.CTX_DDL TO <STUDIO SCHEMA USER>;

Note:

The following grants should be revoked after the successful installation of Compliance Studio. 
REVOKE SELECT ON SYS.DBA_RECYCLEBIN FROM <STUDIO SCHEMA USER>;
REVOKE SELECT ON SYS.DBA_FREE_SPACE FROM <STUDIO SCHEMA USER>;
REVOKE SELECT ON SYS.DBA_TABLES FROM <STUDIO SCHEMA USER>;
REVOKE SELECT ON SYS.DBA_TAB_COLUMNS FROM <STUDIO SCHEMA USER>;

Entity Resolution Use Case

Grants for ER Schema

During the upgrade activity, make sure that the following grants are assigned to the Entity Resolution schema.

GRANT CREATE SESSION TO <ER SCHEMA USER>;
GRANT CREATE TABLE TO <ER SCHEMA USER>;
GRANT CREATE VIEW TO <ER SCHEMA USER>;
GRANT CREATE TRIGGER TO <ER SCHEMA USER>;
GRANT CREATE PROCEDURE TO <ER SCHEMA USER>;
GRANT CREATE SEQUENCE TO <ER SCHEMA USER>;
GRANT EXECUTE ON DBMS_RLS TO <ER SCHEMA USER>;
GRANT EXECUTE ON SYS.DBMS_SESSION TO <ER SCHEMA USER>;
GRANT CREATE SYNONYM TO <ER SCHEMA USER>;
GRANT EXECUTE ON DBMS_REDEFINITION TO <ER SCHEMA USER>;
GRANT REDEFINE TABLE TO <ER SCHEMA USER>;
GRANT CREATE MATERIALIZED VIEW TO <ER SCHEMA USER>;
GRANT SELECT ON SYS.V_$PARAMETER TO <ER SCHEMA USER>;
GRANT SELECT ON SYS.DBA_FREE_SPACE TO <ER SCHEMA USER>;
GRANT SELECT ON SYS.DBA_TABLES TO <ER SCHEMA USER>;
GRANT SELECT ON SYS.DBA_TAB_COLUMNS TO <ER SCHEMA USER>;
GRANT CREATE RULE TO <ER SCHEMA USER>;
GRANT DROP TRIGGER TO <ER SCHEMA USER>;
GRANT SELECT ON SYS.DBA_RECYCLEBIN TO <ER SCHEMA USER>;
GRANT CREATE JOB TO <ER SCHEMA USER>;
GRANT EXECUTE ON DBMS_LOCK TO <ER SCHEMA USER>;
GRANT EXECUTE ON DBMS_STATS TO <ER SCHEMA USER>;
GRANT ANALYZE TO <ER SCHEMA USER>;
GRANT CREATE TYPE TO <ER SCHEMA USER>;
GRANT EXECUTE ON CTXSYS.CTX_DDL TO <ER SCHEMA USER>;

Note:

The following grants are applicable when MATCHING_MECHANISM is set to OT in the config.sh file. 
GRANT EXECUTE ON CTXSYS.CTX_THES TO <ER SCHEMA USER>;
GRANT MANAGE SCHEDULER TO <ER SCHEMA USER>;
GRANT EXECUTE ON DBMS_MVIEW TO <ER SCHEMA USER>;

Note:

The following grants should be revoked after the successful installation of Compliance Studio. 
REVOKE SELECT ON SYS.DBA_RECYCLEBIN FROM <ER SCHEMA USER>;
REVOKE SELECT ON SYS.DBA_FREE_SPACE FROM <ER SCHEMA USER>;
REVOKE SELECT ON SYS.DBA_TAB_COLUMNS FROM <ER SCHEMA USER>;
REVOKE SELECT ON SYS.DBA_TABLES FROM <ER SCHEMA USER>;

Graph Use Case

Prerequisites

  1. Create filestore directories in the database server. To create filestore directories, see the Create Filestore Directories in the Database Server for Graph section.
  2. Assign grants to Studio Schema to access the file store directories. To assign grants, see the Assign Grants to Studio Schema to Access the Filestore Directories section.

Pre-installation Grants for Graph Schema

During the upgrade activity, make sure that the following grants are assigned to the graph schema.

  • Pre-installation Grants for both BD and ECM Graphs
    GRANT ANALYZE TO <GRAPH_SCHEMA>;
GRANT CREATE SESSION TO <GRAPH_SCHEMA>;
GRANT CREATE TABLE TO <GRAPH_SCHEMA>;
GRANT CREATE VIEW TO <GRAPH_SCHEMA>;
GRANT CREATE PROCEDURE TO <GRAPH_SCHEMA>;
GRANT CREATE SEQUENCE TO <GRAPH_SCHEMA>;
GRANT CREATE JOB TO <GRAPH_SCHEMA>;
GRANT CREATE MATERIALIZED VIEW TO <GRAPH_SCHEMA>;
GRANT EXECUTE ON DBMS_SCHEDULER TO <GRAPH_SCHEMA>;
GRANT EXECUTE ON DBMS_COMPARISON TO <GRAPH_SCHEMA>;
GRANT EXECUTE ON DBMS_RLS TO <GRAPH_SCHEMA>;
GRANT EXECUTE ON SYS.DBMS_SESSION TO <GRAPH_SCHEMA>;
GRANT EXECUTE ON DBMS_REDEFINITION TO <GRAPH_SCHEMA>;
GRANT REDEFINE TABLE TO <GRAPH_SCHEMA>;
GRANT SELECT ON SYS.V_$PARAMETER TO <GRAPH_SCHEMA>;
GRANT EXECUTE ON DBMS_ISCHED TO <GRAPH_SCHEMA>;
GRANT EXECUTE ON DBMS_PARALLEL_EXECUTE TO <GRAPH_SCHEMA>;
GRANT EXECUTE ON DBMS_STATS TO <GRAPH_SCHEMA>;

    Note:

    The following grant is applicable only when MATCHING_MECHANISM is set to OT in the config.sh file. 
    GRANT EXECUTE ON CTXSYS.CTX_THES TO <GRAPH_SCHEMA>;
  • Pre-installation Grants for BD Graph

    Change the <BD_ATOMIC_SCHEMA> to the underlying schema of the data source of the BD graph pipeline.

    Note:

    The following grants are applicable for the Out-of-the-box graph pipeline only. If the user has to execute the custom graph, the same permissions have to be provided for the input tables referred in Custom Graph Pipeline. 
    GRANT SELECT ON <BD_ATOMIC_SCHEMA>.ACCT TO <GRAPH_SCHEMA>;
GRANT SELECT ON <BD_ATOMIC_SCHEMA>.CUST_ACCT TO <GRAPH_SCHEMA>;
GRANT SELECT ON <BD_ATOMIC_SCHEMA>.ACCT_BAL_POSN_SMRY TO <GRAPH_SCHEMA>;
GRANT SELECT ON <BD_ATOMIC_SCHEMA>.CUST TO <GRAPH_SCHEMA>;
GRANT SELECT ON <BD_ATOMIC_SCHEMA>.BACK_OFFICE_TRXN TO <GRAPH_SCHEMA>;
GRANT SELECT ON <BD_ATOMIC_SCHEMA>.EMP TO <GRAPH_SCHEMA>;
GRANT SELECT ON <BD_ATOMIC_SCHEMA>.CUST_CUST TO <GRAPH_SCHEMA>;
GRANT SELECT ON <BD_ATOMIC_SCHEMA>.KDD_CAL TO <GRAPH_SCHEMA>;
GRANT SELECT ON <BD_ATOMIC_SCHEMA>.KDD_REVIEW TO <GRAPH_SCHEMA>;
GRANT SELECT ON <BD_ATOMIC_SCHEMA>.EMP_ACCT TO <GRAPH_SCHEMA>;
GRANT SELECT ON <BD_ATOMIC_SCHEMA>.ACCT_SMRY_MNTH TO <GRAPH_SCHEMA>;
GRANT SELECT ON <BD_ATOMIC_SCHEMA>.ACCT_ADDR TO <GRAPH_SCHEMA>;
GRANT SELECT ON <BD_ATOMIC_SCHEMA>.EXTERNAL_ENTITY TO <GRAPH_SCHEMA>;
GRANT SELECT ON <BD_ATOMIC_SCHEMA>.CUST_EMAIL_ADDR TO <GRAPH_SCHEMA>;
GRANT SELECT ON <BD_ATOMIC_SCHEMA>.CUST_PHON TO <GRAPH_SCHEMA>;
GRANT SELECT ON <BD_ATOMIC_SCHEMA>.CUST_ADDR TO <GRAPH_SCHEMA>;
GRANT SELECT ON <BD_ATOMIC_SCHEMA>.CASH_TRXN TO <GRAPH_SCHEMA>;
GRANT SELECT ON <BD_ATOMIC_SCHEMA>.LINK_STAGE TO <GRAPH_SCHEMA>;
GRANT SELECT ON <BD_ATOMIC_SCHEMA>.WIRE_TRXN TO <GRAPH_SCHEMA>;
GRANT SELECT ON <BD_ATOMIC_SCHEMA>.MI_TRXN TO <GRAPH_SCHEMA>;
GRANT SELECT ON <BD_ATOMIC_SCHEMA>.INSTN_MASTER TO <GRAPH_SCHEMA>;
GRANT SELECT ON <BD_ATOMIC_SCHEMA>.EXTERNAL_ENTITY_ADDR TO <GRAPH_SCHEMA>;
GRANT SELECT ON <BD_ATOMIC_SCHEMA>.DERIVED_ADDRESS TO <GRAPH_SCHEMA>;
GRANT SELECT ON <BD_ATOMIC_SCHEMA>.CLIENT_BANK TO <GRAPH_SCHEMA>;
GRANT SELECT ON <BD_ATOMIC_SCHEMA>.EXTERNAL_ENTITY_LINK TO <GRAPH_SCHEMA>;
GRANT ANALYZE TO <GRAPH_SCHEMA>;
  • Pre-installation Grants for ECM Graph

    Change the <ECM_ATOMIC_SCHEMA> to the underlying schema of the data source of the ECM graph pipeline. 

    GRANT SELECT ON <ECM_ATOMIC_SCHEMA>.FCC_ACCT TO <GRAPH_SCHEMA>;
GRANT SELECT ON <ECM_ATOMIC_SCHEMA>.FCC_CUST_ACCT TO <GRAPH_SCHEMA>;
GRANT SELECT ON <ECM_ATOMIC_SCHEMA>.FCC_ACCT_BAL_POSN_SMRY TO <GRAPH_SCHEMA>;
GRANT SELECT ON <ECM_ATOMIC_SCHEMA>.FCC_CUST TO <GRAPH_SCHEMA>;
GRANT SELECT ON <ECM_ATOMIC_SCHEMA>.FCC_BACK_OFFICE_TRXN TO <GRAPH_SCHEMA>;
GRANT SELECT ON <ECM_ATOMIC_SCHEMA>.FCC_EMP TO <GRAPH_SCHEMA>;
GRANT SELECT ON <ECM_ATOMIC_SCHEMA>.FCC_CUST_CUST TO <GRAPH_SCHEMA>;
GRANT SELECT ON <ECM_ATOMIC_SCHEMA>.FCC_EMP_ACCT TO <GRAPH_SCHEMA>;
GRANT SELECT ON <ECM_ATOMIC_SCHEMA>.FCC_ACCT_SMRY_MNTH TO <GRAPH_SCHEMA>;
GRANT SELECT ON <ECM_ATOMIC_SCHEMA>.FCC_ACCT_ADDR TO <GRAPH_SCHEMA>;
GRANT SELECT ON <ECM_ATOMIC_SCHEMA>.FCC_EXTERNAL_ENTITY TO <GRAPH_SCHEMA>;
GRANT SELECT ON <ECM_ATOMIC_SCHEMA>.FCC_CUST_EMAIL_ADDR TO <GRAPH_SCHEMA>;
GRANT SELECT ON <ECM_ATOMIC_SCHEMA>.FCC_CUST_PHON TO <GRAPH_SCHEMA>;
GRANT SELECT ON <ECM_ATOMIC_SCHEMA>.FCC_CUST_ADDR TO <GRAPH_SCHEMA>;
GRANT SELECT ON <ECM_ATOMIC_SCHEMA>.FCC_CASH_TRXN TO <GRAPH_SCHEMA>;
GRANT SELECT ON <ECM_ATOMIC_SCHEMA>.FCC_WIRE_TRXN TO <GRAPH_SCHEMA>;
GRANT SELECT ON <ECM_ATOMIC_SCHEMA>.FCC_MI_TRXN TO <GRAPH_SCHEMA>;
GRANT SELECT ON <ECM_ATOMIC_SCHEMA>.FCC_INSTN_MASTER TO <GRAPH_SCHEMA>;
GRANT SELECT ON <ECM_ATOMIC_SCHEMA>.FCC_EXTERNAL_ENTITY_ADDR TO <GRAPH_SCHEMA>;
GRANT SELECT ON <ECM_ATOMIC_SCHEMA>.FCC_DERIVED_ADDRESS TO <GRAPH_SCHEMA>;
GRANT SELECT ON <ECM_ATOMIC_SCHEMA>.FCC_CLIENT_BANK TO <GRAPH_SCHEMA>;
GRANT SELECT ON <ECM_ATOMIC_SCHEMA>.FCC_EXTERNAL_ENTITY_LINK TO <GRAPH_SCHEMA>;
GRANT SELECT ON <ECM_ATOMIC_SCHEMA>.KDD_CASES TO <GRAPH_SCHEMA>;
GRANT SELECT ON <ECM_ATOMIC_SCHEMA>.KDD_CASE_ACCOUNTS TO <GRAPH_SCHEMA>;
GRANT SELECT ON <ECM_ATOMIC_SCHEMA>.FCC_SCENARIO_MASTER TO <GRAPH_SCHEMA>;
GRANT SELECT ON <ECM_ATOMIC_SCHEMA>.FCC_EVENTS TO <GRAPH_SCHEMA>;
GRANT SELECT ON <ECM_ATOMIC_SCHEMA>.FCC_EVENT_DETAILS TO <GRAPH_SCHEMA>;
GRANT SELECT ON <ECM_ATOMIC_SCHEMA>.FCC_EVENT_ENTITY_MAP TO <GRAPH_SCHEMA>;
GRANT SELECT ON <ECM_ATOMIC_SCHEMA>.FCC_PRECASE_CASE_MAP TO <GRAPH_SCHEMA>;
GRANT SELECT ON <ECM_ATOMIC_SCHEMA>.KDD_CASE_CUSTOMERS TO <GRAPH_SCHEMA>;
GRANT SELECT ON <ECM_ATOMIC_SCHEMA>.KDD_CASE_EXTERNAL_ENTITY TO <GRAPH_SCHEMA>;
GRANT SELECT ON <ECM_ATOMIC_SCHEMA>.KDD_CASE_INSTN_MASTER TO <GRAPH_SCHEMA>;
GRANT SELECT ON <ECM_ATOMIC_SCHEMA>.FCC_CORRELATION_EVENT_MAP TO <GRAPH_SCHEMA>;
GRANT EXECUTE ON DBMS_SCHEDULER TO <ECM_ATOMIC_SCHEMA>;
GRANT EXECUTE ON DBMS_ISCHED TO <ECM_ATOMIC_SCHEMA>;
GRANT EXECUTE ON DBMS_PARALLEL_EXECUTE TO <ECM_ATOMIC_SCHEMA>;
GRANT CREATE JOB TO <ECM_ATOMIC_SCHEMA>;

Graph-keystore.p12 File

The graph-keystore.p12 file can be reused from the previous version of Compliance Studio instance.

Copy the graph-keystore.p12 file from previous version of the Compliance Studio instance and paste in the same path where current version is installed.

File Path:

<COMPLIANCE_STUDIO_INSTALLATION_PATH>/deployed/mmg-home/mmg-load-to-graph/ graph-service/conf

<PGX_HOME>/pgx/pgx-server/conf.

Note:

  • If you do not have any graph schema then create an empty file with a name “graph-keystore.p12” and place it in the <PGX_HOME>/ pgx/pgx-server/deployed/conf directory.
  • The path where the pgx-server-<version>.zip file is unzipped is referred as <PGX_HOME>.
  • If you are updating credentials then copy the updated graph-keystore. p12 file and place in the <PGX_HOME>/pgx/pgxserver/conf directory.

PGX Service

Upgrade for PGX service is same process as fresh configuration. To configure, see the Configure the PGX Service section.

Stop PGX Service

To stop the PGX service:
  1. Navigate to the path where the PGX service is installed.
  2. Navigate to the <PGX_Installation_Path>/pgx/pgx-server/bin directory where the start service for PGX is located.
  3. Run ./pgx-server.sh --stop.

Config.sh File

The parameters in config.sh file can be reused from the previous version of Compliance Studio instance.

Navigate to the <COMPLIANCE_STUDIO_INSTALLATION_PATH>/bin directory and update parameter as mentioned in the following table.

Table 3-2 Parameter in config.sh file for Upgrade

Parameter Value for Upgrade from CS 8.1.2.7.0 to CS 8.1.2.8.0
COMPLIANCE_STUDIO_INSTALLATION_PATH Provide the path where the new installer is extracted.

For example: /scratch/testuser/OFS_COMPLIANCE_STUDIO.

MINICONDA_INSTALLATION_HOME By default, the value is $HOME.
NON_OFSAA Enter the value as false.
GRAPH_SOURCE Enter the value as BD.
ECM_SCHEMA_NAME Reuse value from previous version of the Compliance Studio.
FCDM_SCHEMA Reuse value from previous version of the Compliance Studio.
STUDIO_SERVER_SSL_SECRET Reuse value from previous version of the Compliance Studio.
STUDIO_SERVER_SSL_ALIAS Reuse value from previous version of the Compliance Studio.
AUTH_REALM Reuse value from previous version of the Compliance Studio.
COOKIE_DOMAIN Reuse value from previous version of the Compliance Studio.
AAI_URL Reuse value from previous version of the Compliance Studio.
SAML_DESTINATION Reuse value from previous version of the Compliance Studio.
SAML_ROLE_ATTRIBUTE Reuse value from previous version of the Compliance Studio.
MMG_SPARK_ENABLED The value is either true or false.
HADOOP_HOME Retain the placeholder as it is.

For example, ##HADOOP_HOME##
SPARK_MASTER Retain the placeholder as it is.

For example, ##SPARK_MASTER##
SPARK_DEPLOY_MODE Retain the placeholder as it is.

For example, ##SPARK_DEPLOY_MODE##
CS_SAML_SIGN_AUTHN_REQ Set the value as true or false. By default, the value is false.

Note: This parameter can be configured after applying this patch 37052417 (v8.1.2.8.1) only.

SAML_PRIVATE_KEY_PATH Enter the file path where private key is stored. For example, <COMPLIANCE_STUDIO_INSTALLATION_PATH>/spprivatekey. pem

This parameter is applicable only when SAML_SIGN_AUTHN_REQ is set to true.

Note: This parameter can be configured after applying this patch 37052417 (v8.1.2.8.1) only.

SAML_SP_X509_CERT_PATH Enter the file path where service provider’s X509 certificate is stored.

For example, <COMPLIANCE_STUDIO_INSTALLATION_PATH>/spcertificate.cer

Note: This parameter can be configured after applying this patch 37052417 (v8.1.2.8.1) only.

SAML_SIGN_ALGORITHM Set this field as blank

Note: This parameter can be configured after applying this patch 37052417 (v8.1.2.8.1) only.

SAML_LOGOUT_URL Reuse value from previous version of the Compliance Studio.
API_USERS Reuse value from previous version of the Compliance Studio.
VALID_ROLES Reuse value from previous version of the Compliance Studio
BATCH_ROLE Reuse value from previous version of the Compliance Studio.
SESSION_TOKEN_CREDENTIALS Reuse value from previous version of the Compliance Studio.
FCC_API_USER Reuse value from previous version of the Compliance Studio.
SSO_TOKEN Reuse value from previous version of the Compliance Studio
MMG_DATASOURCE_MAX_POOL_SIZE Reuse value from previous version of the Compliance Studio.
MMG_DATASOURCE_IDLE_TIMEOUT Reuse value from previous version of the Compliance Studio.
MMG_DATASOURCE_CONN_TIMEOUT Reuse value from previous version of the Compliance Studio.
EXT_DATASOURCE_MAX_POOL_SIZE Reuse value from previous version of the Compliance Studio.
EXT_DATASOURCE_IDLE_TIMEOUT Reuse value from previous version of the Compliance Studio.
EXT_DATASOURCE_CONN_TIMEOUT Reuse value from previous version of the Compliance Studio.
SERVER_COOKIE_TIMEOUT Reuse value from previous version of the Compliance Studio.
DATASTUDIO_CSP_FRAME_ANCESTORS

In case of ECM-IH integration use case, update the DATASTUDIO_CSP_FRAME_ANCESTORS parameter as follows:

https://<Hostname>:<Compliance_Studio_Gateway_Port>,http://<ecm_webserver_hostname>:<ecm_ui_port>

For example: DATASTUDIO_CSP_FRAME_ANCESTORS=https://testCSserver.oraclevcn.com:7071,http://testECMserver:8019.

Note: This parameter is available only after applying the patch 36804835 (v8.1.2.6.13).

STUDIO_DB_HOSTNAME Reuse value from previous version of the Compliance Studio.
STUDIO_DB_PORT Reuse value from previous version of the Compliance Studio.
STUDIO_DB_SERVICE _NAME Reuse value from previous version of the Compliance Studio.
STUDIO_DB_SID Reuse value from previous version of the Compliance Studio.
STUDIO_DB_USERNAME Reuse value from previous version of the Compliance Studio.
ATOMIC_DB_HOSTNAME Reuse value from previous version of the Compliance Studio.
ATOMIC_DB_PORT Reuse value from previous version of the Compliance Studio.
ATOMIC_DB_SERVICE _NAME Reuse value from previous version of the Compliance Studio.
ATOMIC_DB_SID Reuse value from previous version of the Compliance Studio.
ATOMIC_DB_USERNAME Reuse value from previous version of the Compliance Studio.
WALLET_LOCATION Reuse value from previous version of the Compliance Studio.
TNS_ADMIN_PATH Reuse value from previous version of the Compliance Studio.
STUDIO_ALIAS_NAME Reuse value from previous version of the Compliance Studio.
ATOMIC_ALIAS_NAME Reuse value from previous version of the Compliance Studio.
LOGSTASH_HOME Reuse value from previous version of the Compliance Studio.
GRAPH_DB_SERVER_ NAME Reuse value from previous version of the Compliance Studio.
GRAPH_DB_PORT Reuse value from previous version of the Compliance Studio.
GRAPH_DB_SERVICE _NAME Reuse value from previous version of the Compliance Studio.
GRAPH_KEYSTORE_PASSWORD Reuse value from previous version of the Compliance Studio.
GRAPH_SCHEMA_DB_SCHEMA_NAME Reuse value from previous version of the Compliance Studio.
GRAPH_SCHEMA_WALLET_ALIAS Reuse value from previous version of the Compliance Studio.
GRAPH_SCHEMA_WALLET_LOCATION Reuse value from previous version of the Compliance Studio.
GRAPH_SCHEMA_TNS_ADMIN_PATH Reuse value from previous version of the Compliance Studio.
PGX_ENABLE_CP Reuse value from previous version of the Compliance Studio.
PGX_CP_INITIAL_SIZE Reuse value from previous version of the Compliance Studio.
PGX_CP_MAX_TOTAL Reuse value from previous version of the Compliance Studio.
PGX_CP_MAX_IDLE Reuse value from previous version of the Compliance Studio.
PGX_CP_MIN_IDLE Reuse value from previous version of the Compliance Studio.
PGX_CP_MAX_WAIT_MILLIS Reuse value from previous version of the Compliance Studio.
PGX_CP_MIN_EVICTABLE_IDLE_TIME Reuse value from previous version of the Compliance Studio.
PGX_CP_SOFT_MIN_EVICTABLEIDLE_TIME Reuse value from previous version of the Compliance Studio.
EXT_SCHEMA_ENABLE_CP

The value is either true or false.

If it is set to true, then configure the following parameters related to External Schema.

If it is set to false, then configure the following parameters related to External Schema as NA.
EXT_SCHEMA_CP_MAX_IDLE Enter the maximum number of connections that can remain idle in the pool, without extra ones being released or negative for no limit.

For example: 5.
EXT_SCHEMA_CP_MIN_IDLE Enter the minimum number of connections that can remain idle in the pool, without extra ones being created, or zero to create none.

For example: 2.
EXT_SCHEMA_CP_INITIAL_SIZE Enter the initial number of connections that are created when the pool is started.

For example: 1.
EXT_SCHEMA_CP_MAX_TOTAL Enter the maximum number of active connections that can be allocated from this pool at the same time or negative for no limit.

For example: 10.
EXT_SCHEMA_CP_MAX_WAIT_MILLIS Enter the maximum number of milliseconds that the pool will wait (when there are no available connections) for a connection to be returned before throwing an exception or -1 to wait indefinitely.

For example: 3000.
EXT_SCHEMA_CP_MIN_EVICTABLE_IDLE_TIME Enter the minimum amount of time a connection may sit idle in the pool before it is closed and a new connection is created if count of connections is less than EXT_SCHEMA_CP_MIN_IDLE.

For example: PT30M.
EXT_SCHEMA_CP_SOFT_MIN_EVICTABLE_IDLE_TIME Enter the minimum amount of time a connection may sit idle in the pool before it is closed and a new connection is created.

For example: PT6H.

Note: The values lesser than EXT_SCHEMA_CP_MIN_EVICTABLE_IDLE_TIME will close all the idle connection and create connection to match EXT_SCHEMA_CP_MIN_IDLE.

PGX_ZEPPELIN_SCHEDULER_THREADPOOL_ SIZE Enter the threadpool size of the PGX interpreter.

For example: 200.
ENABLE_MATCHING_FOR_GRAPH Reuse value from previous version of the Compliance Studio.
ENABLE_QUANTIFIND Enable to integrate with quantifind. The value is “true” or “false”.

For example: Y.

Note: This parameter can be configured after applying this patch 36752689 (v8.1.2.7.2) only.

QUANTIFIND_URL Enter the quantifind API URL.

For example: https://testserver.quantifind.com.

Note: In Studio Schema, update Quantifind URL in V_URL column of the CS_IH_EXT_SRVC_APP_DETAILS table.

Note: This parameter can be configured after applying this patch 36752689 (v8.1.2.7.2) only.

QUANTIFIND_TOKEN Enter the quantifind API token.

Note: In Studio Schema, update Quantifind API token in V_REQ_HDR_VALUE column of the CS_IH_EXT_SRVC_REQ_HEADERS table where V_REQ_HDR_KEY is X-QF-App-Token.

Note: This parameter can be configured after applying this patch 36752689 (v8.1.2.7.2) only.

QUANTIFIND_APPNAME Enter the quantifind App Name.

For example: OracleIntegrationTest

Note: In Studio Schema, update Quantifind App name in V_REQ_HDR_VALUE column of the CS_IH_EXT_SRVC_REQ_HEADERS table where V_REQ_HDR_KEY is X-QF-App-Name.

Note: This parameter can be configured after applying this patch 36752689 (v8.1.2.7.2) only.

HTTPS_PROXY_HOST Reuse value from previous version of the Compliance Studio.
HTTPS_PROXY_PORT Reuse value from previous version of the Compliance Studio.
HTTP_PROXY_USERNAME Reuse value from previous version of the Compliance Studio.
HTTP_PROXY_PASSWORD Reuse value from previous version of the Compliance Studio.
NO_PROXY The default value is "\"*.$(hostname -d)|localhost|$(hostname - i)|127.0.0.1|0.0.0.0\"".
NUM_CACHED_RESULTSET Reuse value from previous version of the Compliance Studio.
RESULTSET_EXPIRATION_TIME_SECS Reuse value from previous version of the Compliance Studio.
MAX_TOTAL_SHARED_DATA_MEMORY_SIZE Reuse value from previous version of the Compliance Studio.
MAX_TOTAL_PRIVATE_DATA_MEMORY_SIZE Reuse value from previous version of the Compliance Studio.
MAX_PER_SESSION_DATA_MEMORY_SIZE Reuse value from previous version of the Compliance Studio.
MAX_DATA_MEMORY_SIZE_DSUSRGRP Reuse value from previous version of the Compliance Studio.
MAX_DATA_MEMORY_SIZE_DSBATCH Reuse value from previous version of the Compliance Studio.
MAX_DATA_MEMORY_SIZE_DSINTER Reuse value from previous version of the Compliance Studio.
MAX_DATA_MEMORY_SIZE_DSAPPROVER Reuse value from previous version of the Compliance Studio.
MAX_DATA_MEMORY_SIZE_DSUSER Reuse value from previous version of the Compliance Studio.
MAX_DATA_MEMORY_SIZE_IHUSRGRP Enter the Absolute memory limit for any user of the PGX engine whose role is IHUSRGRP.

For example: 10G.
PGX_SERVER_URL Reuse value from previous version of the Compliance Studio.
RS_CONF_PATH Retain the default value.
RS_KEYSTORE Retain the default value.
RS_KS_SECRET Retain the default value.
LD_LIBRARY_PATH Reuse value from previous version of the Compliance Studio.
MATCHING_MECHANISM From CS 8.1.2.7.0 (OpenSearch) to CS 8.1.2.8.0 (OpenSearch) the value should be OS.
OPEN_SEARCH_HOSTNAME Reuse value from previous version of the Compliance Studio.
OPEN_SEARCH_PORT Reuse value from previous version of the Compliance Studio.
OPEN_SEARCH_HADOOP_CREDENTIAL_PATH Enter the value as NA.
OPEN_SEARCH_USERNAME Reuse value from previous version of the Compliance Studio.
OPEN_SEARCH_ENCRYPTED_PASSWORD Reuse value from previous version of the Compliance Studio.
OPEN_SEARCH_HADOOP_PASSWORD_ALIAS Enter the value as NA.
OPEN_SEARCH_HTTPS_ENABLED Reuse value from previous version of the Compliance Studio.
OPEN_SEARCH_TRUSTSTORE_FILE_NAME Reuse value from previous version of the Compliance Studio.
OPEN_SEARCH_TRUSTSTORE_SECRET Reuse value from previous version of the Compliance Studio.
OPEN_SEARCH_KEYSTORE_HADOOP_CREDE NTIAL_ALIAS Enter the value as NA.
ES Cluster Details

Configuration is not required for the parameters related to Elastic Search as it is deprecated.

 -
Additional MMG Configuration

Configuration is not required for these DATACATALOG_SERVICE_URL, SPARK_HOME, EST_ENABLED, and EST_UI_URL parameters.

 -
All Services

Set the value of the parameter, DEPLOY_ALL_SERVIC E, as true for starting all services and false for starting selected services.

For example: Compliance Studio independent of OFSAA: set "false" for service(s): entity resolution, matching service, and load-to-open Compliance Studio lite: set "false" for service(s): fcc-pgql, fcc-pgx-algorithm, fcc- pgx-java and pgx-server.

 -
DEPLOY_ALL_SERVICE Set the value as true or false.

Set it to true for starting all services. If it is false, then enable the following services based on the use case.
METASERVICE_ENABLED Set the value as true and it has to be enabled for all use cases.
BATCHSERVICE_ENABLED Set the value as true and it has to be enabled for all use cases.
GRAPH_SERVICE_ENABLED Set the value as true and it has to be enabled for Graph use case.
FCC_UI_ENABLED Set the value as true and it has to be enabled for Entity Resolution and Graph use cases.
CANDIDATE_SELECTION_ENABLED Set the value as true and it has to be enabled for Entity Resolution and Graph use cases when MATCHING_MECHANISM is set to OT.
FCC_PYTHON_ENABLED Set the value as true and it has to be enabled for all use cases.
JDBC_ENABLED Set the value as true and it has to be enabled for all use cases.
PGX_ENABLED Set the value as true and it has to be enabled for Graph use case.
ENTITY_RESOLUTION_ENABLED Set the value as true and it has to be enabled for Entity Resolution use case.
MATCHING_SERVICE _ENABLED Set the value as true and it has to be enabled for Entity Resolution and Graph use cases.
LOAD_TO_OPEN_SEARCH_ENABLED Set the value as true and it has to be enabled for Entity Resolution and Graph use cases when MATCHING_MECHANISM is set to OS.
MMG_SERVICE_ENA BLED Set the value as true and it has to be enabled for all use cases.

Run Compliance Studio Installer

Note:

Before proceeding with this section, you should stop previous instance of the Compliance Studio.

To run, see the Run the Compliance Studio Installer section.

Verify the Installation

To verify the Compliance Studio installation with OFSAA, check the log files in the <COMPLIANCE_STUDIO_INSTALLATION_PATH>/deployed/logs directory.

If all the servers are up and running, it indicates that the installation is complete.

Note:

If you notice any errors in the log files, do not proceed further. Contact My Oracle Support (MOS) and provide the applicable error code and log files.

Access Compliance Studio

To access the Compliance Studio, see the Access Compliance Studio Application section.