2.7.7 Configure config.sh File

This section describes how to configure the config.sh file.

To configure the config.sh file for installing Compliance Studio:
  1. Login to the server as a non-root user.
  2. Navigate to the <COMPLIANCE_STUDIO_INSTALLATION_PATH>/bin directory.
  3. Configure the applicable config.sh attributes are shown in the following table.
    A sample config.sh file is shown below for reference.

    Figure 2-5 Snapshot of config.sh file

    Description of Figure 2-5 follows
    Description of "Figure 2-5 Snapshot of config.sh file"

    Note:

    • You must manually set the parameter value in the config.sh file. If a value is not applicable, enter NA and ensure that the value is not entered as NULL.
    • If the parameter STUDIO_DB_SERVICE_NAME has been filled, the parameter STUDIO_DB_SID should be left blank, and vice versa.
    • If the parameter ATOMIC_DB_SERVICE_NAME has been filled, the parameter ATOMIC_DB_SID should be left blank, and vice versa.

    Table 2-12 config.sh file

    Parameter Significance Value
    COMPLIANCE_STUDIO_INSTALL ATION_PATH Indicates the path where the Compliance Studio installer file is extracted.

    Provide the path where the new installer is extracted.

    For example: /scratch/testuser/OFS_COMPLIANCE_STUDIO.

    MINICONDA_INSTALLATION_HOME

    Indicates configured path for miniconda installation.

    By default, the value is set to $HOME, which refers to the user's home directory.

    By default, the value is $HOME.
    NON_OFSAA

    To install Compliance Studio with OFSAA, enter "false".

    To install Compliance Studio without OFSAA, enter "true".

    Enter the value as false.

    For example: NON_OFSAA=false

    GRAPH_SOURCE Indicates the source database for Compliance Studio.

    Enter the value as BD.

    Note: This is a legacy ETL parameter, and the value should always be BD. This will not impact the Graph pipeline functionality with ECM.

    ECM_SCHEMA_NAME Indicates the name of the ECM Atomic Schema.

    The value should be name of the ECM Atomic Schema.

    For example: ATOM8125

    Note: If Legacy Graph (ETL connector job using Hadoop) is not required, then set the value as NA.

    FCDM_SCHEMA This indicates the datasource for the Production workspace. The available options are ECM and BD.

    The value of this parameter should be provided either BD or ECM.

    For example: ECM.

    STUDIO_SERVER_SSL_SECRET Indicates the password for Studio Server P12 that is required for HTTPS configuration.

    Enter the password created for the studio_server.p12 file.

    For example: password.

    STUDIO_SERVER_SSL_ALIAS Indicates the alias name for P12 for the Studio Server.

    Enter alias name of the P12 file for the studio server.

    For example: studio_server.

    AUTH_REALM

    Realm indicates the functional grouping of database schemas and roles that must be secured for an application. Realms protect data from access through system privileges; realms do not give its owner or participant’s additional privileges.

    Compliance Studio uses realm- based authorization and authentication for its users.

    The Compliance Studio application can be accessed using the following realms:

    FCCMRealm Value=AAI FCCSamlRealm Value=SAML

    Enter AUTH_REALM value as SAML or AAI.

    For example: SAML.

    COOKIE_DOMAIN The domain of the server where Compliance Studio is installed.

    Enter the domain of the server where Compliance Studio is installed.

    For example: in.oracle.com.

    AAI_URL

    The Application URL of ECM/BD application.

    URL: http://<Server Hostname>:<Applic ation URLPORT>/ <Context Path>

    Enter Application URL of ECM/ BD.

    For example: http://testserver.in.oracle.com:4000/ BDTEST

    Note: This parameter is applicable only if AUTH_REALM is AAI.

    SAML_DESTINATION Indicates the SAML IDP URL that the Identity Provider provides after creating the SAML Application.

    Enter the SAML Identity Provider URL.

    For example: http://<IDCS_APP_SSO_URL>

    Note: This parameter is applicable only if AUTH_REALM is SAML.

    SAML_ROLE_ATTRIBUTE Indicates the SAML client identifier provided by the SAML Administrator for the Role and Attributes information while creating the SAML application for Compliance Studio.

    Enter the SAML client identifier.

    For example: group.

    Note: This parameter is applicable only if AUTH_REALM is SAML.

    MMG_SPARK_ENABLED It is used to enable or disable the spark interpreter. The value is either true or false.
    HADOOP_HOME Indicates the directory path where Hadoop is installed. Retain the placeholder as it is.

    For example, ##HADOOP_HOME##

    SPARK_MASTER Indicates master URL for the cluster or environment in which the spark job will run. Retain the placeholder as it is.

    For example, ##SPARK_MASTER##

    SPARK_DEPLOY_MODE Indicates the mode how the spark application will be deployed. Retain the placeholder as it is.

    For example, ##SPARK_DEPLOY_MODE##

    CS_SAML_SIGN_AUTHN_REQ It is used to enable authentication through SAML signed request.

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

    Set the value as true or false. By default, the value is false.
    SAML_PRIVATE_KEY_PATH Indicates the file path where the private key for signing SAML assertions or request is stored.

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

    For generating .pem file, see the Generating Files for SAML Signed Request section.

    Enter the file path where private key is stored.

    For example, <COMPLIANCE_STUDIO_INSTA LLATION_PATH>/spprivatekey. pem

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

    SAML_SP_X509_CERT_PATH Indicates the file path where the service provider’s X509 certificate is stored. It is used by the service provider to validate the authenticity of the SAML assertions or to encrypt/decrypt information exchanged with the Identity Provider.

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

    For generating .cer file, see the Generating Files for SAML Signed Request section.

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

    For example, <COMPLIANCE_STUDIO_INSTA LLATION_PATH>/spcertificate. cer

    SAML_SIGN_ALGORITHM Indicates algorithm for signing SAML assertions, request or responses.

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

    Set this field as blank
    SAML_LOGOUT_URL Indicates the SAML client identifier provided by the SAML Administrator for the Logout URL information while creating the SAML application for Compliance Studio.

    Enter the Logout URL for SAML application.

    For example: http://<IDCS_APP_SLO_URL>

    Note: This parameter is applicable only if AUTH_REALM is SAML.

    API_USERS Retain the default value

    Retain the default value. In case of ECM-IH integration, add one more value to the parameter. i.e., ECM_API_USER.

    The values should be comma separated.

    For example: CS_API_USER, ECM_API_USER.

    VALID_ROLES Retain the default value

    Retain the default value.

    For example: DSADMIN and DSUSER.

    BATCH_ROLE Retain the default value

    Retain the default value.

    For example: DSBATCH

    SESSION_TOKEN_CREDENTIALS Retain the default value Retain the default value
    FCC_API_USER Retain the default value

    Retain the default value.

    For example: CS_API_USER

    SSO_TOKEN This is the API token for FCC_API_USER.

    Enter the API token for FCC_API_USER. For token value, see Generate API Token for CS API User.

    MMG_DATASOURCE_MAX_POOL_SIZE Maximum connection pool size allowed for Config Data Source.

    Enter the maximum connection pool size for Config Data Source.

    For example: 50.

    MMG_DATASOURCE_IDLE_TIMEOUT Idle timeout for Config Data Source in a millisecond.

    Enter Idle timeout for Config Data Source in a millisecond.

    For example: 30000.

    MMG_DATASOURCE_CONN_TIMEOUT Connection timeout for Config Data Source in milliseconds.

    Enter connection timeout for Config Data Source in milliseconds.

    For example: 30000.

    EXT_DATASOURCE_MAX_POOL_SIZE Maximum connection pool size allowed for Meta/Data Schemas.

    Enter maximum connection pool size allowed for Meta/Data Schemas.

    For example: 50.

    EXT_DATASOURCE_IDLE_TIMEOUT Idle timeout for Meta/Data Schemas in milliseconds.

    Enter Idle timeout for Meta/Data Schemas in milliseconds.

    For example: 30000.

    EXT_DATASOURCE_CONN_TIMEOUT Connection timeout for Meta/Data Schemas in milliseconds.

    Enter Connection timeout for Meta/Data Schemas in milliseconds.

    For example: 30000.

    SERVER_COOKIE_TIMEOUT Connection timeout for server cookie in milliseconds.

    Enter connection timeout for server cookie in milliseconds.

    For example: 86400.

    DATASTUDIO_CSP_FRAME_ANCESTORS This parameter allows Datastudio UI to be embedded as iFrame in any external application and this controls the allowed origins where datastudio UI can be embedded.

    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:7 071,http://testECMserver:8019

    STUDIO_DB_HOSTNAME Indicates the hostname of the database where the Compliance Studio schema is created.

    Note: You must be logged in as SYSDBA to perform the Studio Schema configurations.

    Enter hostname of the database where the Compliance Studio schema is created.

    For example: <testserver>.oraclevcn.com

    STUDIO_DB_PORT Indicates the port number where the Compliance Studio schema is created.

    Enter port number where the Compliance Studio schema is created.

    For example: 1521.

    STUDIO_DB_SERVICE _NAME Indicates the service name of the database where the Studio schema is created.

    Enter service name of the database where the Studio schema is created.

    For example: fccmdb.

    STUDIO_DB_SID Indicates the SID of the database where the Studio schema is created.

    SID of the database where the Studio schema is created.

    For example: fccmdb.

    Note: Set this field as blank if there is no SID for Database.

    STUDIO_DB_USERNAME Indicates the username of the Compliance Studio Schema

    Enter username of the Compliance Studio Schema (newly created Oracle Schema).

    For example: CS8127_XXX_XX.

    ATOMIC_DB_HOSTNAME The hostname of the database where Atomic schema is present

    Enter hostname of the database where Atomic schema is present (BD/ECM config).

    For example: <testserver>.oraclevcn.com

    ATOMIC_DB_PORT Port number of database where Atomic schema is present

    Enter Port number of database where Atomic schema is present.

    For example: 1521.

    ATOMIC_DB_SERVICE_NAME The service name of the database where Atomic schema is present

    Enter service name of the database where Atomic schema is present.

    For example: fccmdb.

    ATOMIC_DB_SID

    Service ID of database where Atomic schema is present.

    Note: Set this field as blank if there is no SID for Database.

    Enter Service ID of database where Atomic schema is present.

    For example: fccmdb.

    Note: Set this field as blank if there is no SID for Database.

    ATOMIC_DB_USERNAME Username of the Atomic schema.

    Enter Username of the Atomic schema.

    For example: XXX_ATOM8125.

    WALLET_LOCATION Indicates the Compliance Studio’s wallet location.

    Note: For information on creating a wallet, Setup Password Stores with Oracle Wallet.

    Enter wallet location of the Compliance Studio.

    For example: <COMPLIANCE_STUDIO_INSTALLATION_PATH>/wallet

    TNS_ADMIN_PATH Indicates the path of the tnsnames.ora file where an entry for the STUDIO_ALIAS_NAME is present.

    Enter the path of the tnsnames.ora file where an entry for the STUDIO_ALIAS_NAME is present.

    For example: <COMPLIANCE_STUDIO_INSTALLATION_PATH>/wallet

    STUDIO_ALIAS_NAME Indicates the Studio alias name.

    Enter Studio alias name.

    For example: CS8127_XXX_XX_alias

    Note: Enter the alias name that was created during wallet creation.

    ATOMIC_ALIAS_NAME Indicates alias name of FCDM source atomic schema given in wallet.

    Enter alias name of FCDM source atomic schema given in wallet.

    For example: XXX_ATOM8125_alias

    Note: If Legacy Graph (ETL connector job using Hadoop) is not required, then set the value as NA.

    LOGSTASH_HOME Indicates the Logstash home.

    Note: Logstash is a supporting software for data ingestion to the OpenSearch.

    Enter the path where Logstash is configured.

    For example: <COMPLIANCE_STUDIO_INS TALLATION_PATH>/Logstash/logstash-7.16.3"

    Note: If Graph Pipeline and Entity Resolution functionalities are not required, then set the value as NA.

    GRAPH_DB_SERVER_NAME Indicates the Graph Database server name.

    Note: The following parameters for graph service are mandatory for successful Compliance Studio installation, and the parameters cannot be set as blank or NA. If you do not want to use graph pipeline functionality, studio schema details should be provided for these parameters.

    Enter the server name where the Graph Database is installed.

    For example: <testserver>.com

    GRAPH_DB_PORT Indicates the Graph Database server port

    Enter the Graph Database server port.

    For example: 1521.

    GRAPH_DB_SERVICE_NAME Indicates the Graph Database service name

    Enter the Graph Database service name.

    For example: fccmdb.

    GRAPH_KEYSTORE_PASSWORD Indicates the password of the keystore file, which stores the password of the graph schema.

    Enter the password of the keystore file, which stores the password of the graph schema. For example: passwordXXX

    Note: If Graph Pipeline functionality is not required, then set the value as NA.

    GRAPH_SCHEMA_DB_SCHEMA_NAME Indicates the Database schema name of the graph schema.

    Enter the Database schema name of the graph schema.

    For example: GSCS8127_XXX_XX.

    GRAPH_SCHEMA_WALLET_ALIAS Indicates the wallet alias of the graph schema.

    Enter the wallet alias of the graph schema.

    For example: GSCS8127_XXX_XX_alias.

    GRAPH_SCHEMA_WALLET_LOCATION Indicates the wallet location of the graph schema.

    Enter the wallet location of the graph schema.

    For example: <COMPLIANCE_STUDIO_INSTALLATION_PATH>/wallet

    GRAPH_SCHEMA_TNS_ADMIN_PATH Indicates the TNS admin path of the graph schema.

    Enter the TNS admin path of the graph schema.

    For example:<COMPLIANCE_STUDIO_INSTALLATION_PATH>/wallet

    PGX_ENABLE_CP It is used to enable or disable connection pooling for sub graph loading.

    Set it to true for enabling the connection pooling for sub graph loading. The value for 'PGX_ENABLE_CP' is "true" or "false".

    For example: PGX_ENABLE_CP=true.

    PGX_CP_INITIAL_SIZE Indicates the initial number of connections that are created when the pool is started.

    Enter the initial number of connections that are created when the pool is started.

    For example: 5.

    PGX_CP_MAX_TOTAL Indicates the maximum number of active connections that can be allocated from this pool at the same time or negative for no limit.

    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: 25.

    PGX_CP_MAX_IDLE Indicates the maximum number of connections that can remain idle in the pool, without extra ones being released or negative for no limit.

    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: 10.

    PGX_CP_MIN_IDLE Indicates the minimum number of connections that can remain idle in the pool, without extra ones being created, or zero to create none.

    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: 5.

    PGX_CP_MAX_WAIT_MILLIS Indicates 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.

    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.

    PGX_CP_MIN_EVICTABLE_IDLE_TIME Indicates 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 PGX_CP_MIN_IDLE. 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 PGX_CP_MIN_IDLE.
    PGX_CP_SOFT_MIN_EVICTABLE__IDLE_TIME Indicates the minimum amount of time a connection may sit idle in the pool before it is closed and a new connection is created.

    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: PT8H.

    Note: The values lesser than PGX_CP_MIN_EVICTABLE_IDLE_ TIME will close all the idle connection and create connection to match PGX_CP_MIN_IDLE.

    EXT_SCHEMA_ENABLE_CP It is used to enable or disable connection pooling from any external schema.

    The parameters (Default Connection Pooling Configuration for External Schema) are applicable for enabling connection pool in graph service for any external schema.

    Note: The External Schema parameters are required for generating PDF in Investigation Hub notebooks.

    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 Indicates the maximum number of connections that can remain idle in the pool, without extra ones being released or negative for no limit.

    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 Indicates the minimum number of connections that can remain idle in the pool, without extra ones being created, or zero to create none.

    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 Indicates the initial number of connections that are created when the pool is started.

    Enter the initial number of connections that are created when the pool is started.

    For example: 1.

    EXT_SCHEMA_CP_MAX_TOTAL Indicates the maximum number of active connections that can be allocated from this pool at the same time or negative for no limit.

    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 Indicates 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.

    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_EVICTAB LE_IDLE_TIME Indicates 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.

    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_EV ICTABLE_IDLE_TIME Indicates the minimum amount of time a connection may sit idle in the pool before it is closed and a new connection is created.

    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_TH READPOOL_SIZE Indicates the threadpool size of the PGX interpreter.

    Enter the threadpool size of the PGX interpreter.

    For example: 200.

    ENABLE_MATCHING_FOR_GRAPH It is used to enable or disable matching for the graph.

    The value is either true or false.

    For example: ENABLE_MATCHING_FOR_GRAPH=true

    ENABLE_QUANTIFIND It is used to enable or disable the quantifind integration

    The parameters (Quantifind Details) are related to Quantifind Integration with Investigation Hub and these are optional.

    Note: The parameters related to Quantifind are applicable only when you are using Investigation Hub notebooks (v8.1.2.6.1).

    Enable to integrate with quantifind. The value is “true” or “false”.

    For example: Y.

    QUANTIFIND_URL Indicates the quantifind API 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.

    QUANTIFIND_TOKEN Indicates the quantifind API 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.

    QUANTIFIND_APPNAME Indicates the quantifind App Name

    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.

    HTTPS_PROXY_HOST Indicates the proxy host that is used

    Enter the proxy host that is used.

    For example: testproxyserver.com

    HTTPS_PROXY_PORT Indicates the proxy port that is used.

    Enter the proxy port that is used.

    For example: 80.

    HTTP_PROXY_USERNAME Indicates the proxy username used, if there is any.

    Enter the proxy username used, if there is any.

    For example: NA.

    HTTP_PROXY_PASSWORD Indicates the proxy password used if there is any.

    Enter the proxy password used if there is any.

    For example: NA.

    NO_PROXY

    Indicates URLs with these domains and IP will be accessed without PROXY.

    Note: Configure this parameter when Quantifind is enabled.

    The default value is "\"*.$(hostname - d)|localhost|$(hostname - i)|127.0.0.1|0.0.0.0\""
    NUM_CACHED_RESULTSET Indicates the cached result set.

    PGX (Parallel Graph AnalytiX) is a graph toolkit from Oracle that provides graph analysis on large scale graphs, to extract insights hidden in the connections across datasets between entities.

    Using built-in and custom graph algorithms, graph-pattern matching queries, and other enhanced graph analytics features, PGX helps investigators in conducting meaningful investigations and making actionable recommendations.

    Note: The parameter related to PGX server is applicable only for Graph use case.

    Enter the cached result set.

    For example: 0.

    RESULTSET_EXPIRATION_TIME_ SECS Indicates the Result set expiration time.

    Enter the Result set expiration time.

    For example: 3600.

    MAX_TOTAL_SHARED_DATA_MEMORY_SIZE The absolute memory limit of shared data (includes published graphs and pinned non-referenced graphs).

    Enter the absolute memory limit of shared data (includes published graphs and pinned non-referenced graphs).

    For example: 20G.

    MAX_TOTAL_PRIVATE_DATA_M EMORY_SI ZE The memory limit of private data (includes non-published graphs and PGQL results) relative to the total PGX engine memory limit.

    Enter the memory limit of private data (includes non-published graphs and PGQL results) relative to the total PGX engine memory limit.

    For example: 8G.

    MAX_PER_SESSION_DATA_MEMORY_SIZE Absolute memory limit for any one session of the PGX engine.

    Enter the Absolute memory limit for any one session of the PGX engine.

    For example: 700M.

    MAX_DATA_MEMORY_SIZE_DSUSRGRP Absolute memory limit for any user of the PGX engine whose role is DSUSRGRP.

    Enter the Absolute memory limit for any user of the PGX engine whose role is DSUSRGRP.

    For example: 2G.

    MAX_DATA_MEMORY_SIZE_DSBATCH Absolute memory limit for any user of the PGX engine whose role is DSBATCH.

    Enter the Absolute memory limit for any user of the PGX engine whose role is DSBATCH.

    For example: 10G.

    MAX_DATA_MEMORY_SIZE_DSINTER Absolute memory limit for any user of the PGX engine whose role is DSINTER.

    Enter the Absolute memory limit for any user of the PGX engine whose role is DSINTER.

    For example: 5G.

    MAX_DATA_MEMORY_SIZE_DSA PPROVER Absolute memory limit for any user of the PGX engine whose role is DSAPPROVER.

    Enter the Absolute memory limit for any user of the PGX engine whose role is DSAPPROVER.

    For example: 5G.

    MAX_DATA_MEMORY_SIZE_DSUSER Absolute memory limit for any user of the PGX engine whose role is DSUSER.

    Enter the Absolute memory limit for any user of the PGX engine whose role is DSUSER.

    For example: 5G.

    MAX_DATA_MEMORY_SIZE_IHU SRGRP Absolute memory limit for any user of the PGX engine whose role is IHUSRGRP.

    Enter the Absolute memory limit for any user of the PGX engine whose role is IHUSRGRP.

    For example: 10G.

    PGX_SERVER_URL Indicates the URL of the PGX server.

    Enter URL of the PGX server.

    Note: If SSL is enabled, the URL should be provided with https.

    If SSL is disabled, the URL should be provided with http.

    Ensure to provide the correct hostname for the URL of the PGX service.

    If Legacy Graph (ETL connector job using Hadoop) and Graph Pipeline functionalities are not required, then set the value as NA.

    RS_CONF_PATH

    Absolute path to Rserve.conf file for running Rserve.

    For example: /scratch/users/mmg-studio/conf/Rserve.conf

    Retain the default value.
    RS_KEYSTORE

    Absolute path for the Keystore file made for Rserve.conf.

    For example: / scratch/ users/mmg-studio/ conf/ rinterpreterkeystore

    Retain the default value.
    RS_KS_SECRET

    Keypass for rinterpreterkeystore

    For example: Change it. If the target AAI is https, then the certificate of the target machine needs to be imported to the DS Java keystore.

    Retain the default value.
    LD_LIBRARY_PATH Indicates the Oracle Instant client path.

    Enter the Oracle Instant client path.

    For example: /opt/oracle/instantclient_19_8/:$LD_LIBRARY_PATH

    MATCHING_MECHANISM Indicates the matching mechanism for Entity Resolution and Graph.

    Enter the value that will be used for matching mechanism for Entity Resolution and Graph.

    The options are OS, ES, and OT. Where OS refers to OpenSearch, ES refers to Elastic Search, and OT refers to Candidate Selection with Oracle Text matching.

    By default, the value of the parameter is OT.

    Note: For MATCHING_MECHANISM = OT, no additional installation/configuration is required as it is part of the Oracle Database.

    OPEN_SEARCH_HOSTNAME Indicates the hostname of the server where the OpenSearch service is installed.

    OpenSearch is a distributed search and analytics engine. Compliance Studio leverages the search feature offered by OpenSearch.

    Note: The parameter related to OpenSearch is applicable for Entity Resolution and Graph use cases when MATCHING_MECHANISM is set to OS.

    Enter the hostname of the server where the OpenSearch service is installed.

    For example: <testserver>.com.

    Note: If Graph Pipeline and Entity Resolution functionalities are not required, then set the value as NA.

    OPEN_SEARCH_PORT Indicates the port number where the OpenSearch service is installed.

    Enter the port number where the OpenSearch service is installed.

    For example: 9202.

    Note: If Graph Pipeline and Entity Resolution functionalities are not required, then set the value as NA.

    OPEN_SEARCH_HADOOP_CREDENTIAL_PATH Indicates the open search hadoop credential path. Enter the value as NA.
    OPEN_SEARCH_USERNAME Indicates the OpenSearch Username.

    Enter the OpenSearch Username. (It is Not Applicable when https enabled is false and authentication is not supported).

    For example: admin.

    Note: If Graph Pipeline and Entity Resolution functionalities are not required, then set the value as NA.

    OPEN_SEARCH_ENCRYPTED_PASSWORD Indicates the Encrypted password of the OpenSearch

    Enter the Encrypted password. (It is Not Applicable when https enabled is false and authentication is not supported).

    Note: To generate an encrypted password, see Generate an Encrypted Password for OpenSearch.

    If Graph Pipeline and Entity Resolution functionalities are not required, then set the value as NA.

    OPEN_SEARCH_HADOOP_PASSWORD_ALIAS Indicates the password alias for OpenSearch Enter the value as NA.
    OPEN_SEARCH_HTTPS_ENABLED True (If OS is https enabled, else false)

    Set it to True when Open Search is https enabled.

    Note: If Graph Pipeline and Entity Resolution functionalities are not required, then set the value as false.

    OPEN_SEARCH_TRUSTSTORE_FILE_NAME The filename of the OpenSearch keystore that contains the certificates of OS host to trust. (Not Applicable, if https enabled is false).

    Enter the filename of the OpenSearch keystore that contains the certificates of OS host to trust. (Not Applicable, if https enabled is false).

    For example: admin.p12.

    Note: If Graph Pipeline and Entity Resolution functionalities are not required, then set the value as NA.

    OPEN_SEARCH_TRUSTSTORE_SECRET The password of the OpenSearch keystore file. (Not Applicable, if https enabled is false).

    Enter the password of the OpenSearch keystore file. (Not Applicable, if https enabled is false).

    Note: If Graph Pipeline and Entity Resolution functionalities are not required, then set the value as NA.

    OPEN_SEARCH_KEYSTORE_HADOOP_CREDENTIAL_ALIAS Indicates the password alias for OpenSearch. (Not applicable if OS OPEN_SEARCH_HT TPS_ENABLED is false). 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_SERVICE, as true for starting all services and false for starting the 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 Indicates the service to be started.

    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 This service has to be enabled for all use cases. Set the value as true.
    BATCHSERVICE_ENABLED This service has to be enabled for all use cases. Set the value as true.
    GRAPH_SERVICE_ENABLED This service has to be enabled for Graph use case. Set the value as true.
    FCC_UI_ENABLED This service has to be enabled for Entity Resolution and Graph use cases. Set the value as true.
    CANDIDATE_SELECTION_ENABLED This service has to be enabled for Entity Resolution and Graph use cases when MATCHING_MECHANISM is set to OT. Set the value as true.
    FCC_PYTHON_ENABLED This service has to be enabled for all use cases. Set the value as true.
    JDBC_ENABLED This service has to be enabled for all use cases. Set the value as true.
    PGX_ENABLED This service has to be enabled for Graph use case. Set the value as true.
    ENTITY_RESOLUTION_ENABLED This service has to be enabled for Entity Resolution use case. Set the value as true.
    MATCHING_SERVICE _ENABLED This service has to be enabled for Entity Resolution and Graph use cases. Set the value as true.
    LOAD_TO_OPEN_SEARCH_ENABLED This service has to be enabled for Entity Resolution and Graph use cases when MATCHING_MECHANISM is set to OS. Set the value as true.
    MMG_SERVICE_ENABLED This service has to be enabled for all use cases. Set the value as true.