2.2 How to Apply This Maintenance Level Release in the Compliance Studio?

This section describes how to apply this ML release in the Compliance Studio.

To install this ML release in the Compliance Studio:
  1. Download and copy 37649413_GENERIC.zip on to your server (in Binary mode) where Compliance Studio is installed.
  2. Extract the contents of patch archive file using the following command.
    unzip -a <Name of the file to be unzipped>
    For example, unzip -a 37649413_GENERIC.zip
  3. Provide 0755 permission to all files inside 37649413_GENERIC folder. To provide permission, execute the following.
    chmod -R 0755 37649413_GENERIC

    Note:

    The "-a" option is mandatory to unzip the patch. In case you notice an error message "unzip: not found [No such file or directory]" when the package is not installed, contact your UNIX administrator to resolve this issue.
  4. Navigate to the <PATCH_HOME>/bin directory.

    Note:

    <PATCH_HOME> indicates the path where patch contents are extracted.
  5. Open the config.sh file and configure the following parameters.

    Note:

    The COMPLIANCE_STUDIO_INSTALLATION_PATH parameter is mandatory, and all other parameters are optional.

    Table 2-1 Parameters of config.sh file

    Parameter Significance Value
    COMPLIANCE_STUDIO_INSTALLATION_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
    PGX_INSTALLATION_HOME Indicates the path where the pgx-server-<version>.zip file is extracted. Provide the path where the PGX server is extracted.
    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##
    FTPSHARE This can be any writable folder accessible to the process owner.

    By default the value is $COMPLIANCE_STUDIO_INSTALLATION_PATH/deployed/workspace.

    For example, /scratch/users/ftpshare

    Note: Ensure that ftpshare folder is created before installation

    CS_SAML_SIGN_AUTHN_REQ It is used to enable authentication through SAML signed request. Set the value as true or false.

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

    For generating .pem file, see the Generating Files for SAML Signed Request section in the OFS Compliance Studio Installation Guide, 8.1.2.8.0.

    Enter the file path where private key is stored.

    For example, <COMPLIANCE_STUDIO_INSTA LLATION_PATH>/sp-privatekey.pem

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

    For generating .cer file, see the Generating Files for SAML Signed Request section in the OFS Compliance Studio Installation Guide, 8.1.2.8.0.

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

    For example, <COMPLIANCE_STUDIO_INSTA LLATION_PATH>/sp-certificate.cer
    SAML_SIGN_ALGORITHM Indicates algorithm for signing SAML assertions, request or responses Set this field as blank
    SAML_IDP_URL Indicates the endpoint on the IDP side where SAML requests are posted. The Service Provider (SP) needs to obtain this information from the Identity Provider (IDP). For example, http(s)://idcsxxxx.com/fed/v1/idp/sso.

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

    R_ENABLED To enable the R-interpreter By default the value is set to true.

    Note: For configuration, see the R Interpreter section in the OFS Compliance Studio Administration and Configuration Guide, 8.1.2.9.0.

  6. Set the value for SPARK_HOME parameter in the <COMPLIANCE_STUDIO_INSTALLATION_PATH/bin/config.sh> file before proceeding with the next step, only when MMG_SPARK_ENABLED parameter is set to true.

    For more information, see the Spark Interpreter section in the OFS Compliance Studio Administration and Configuration Guide, 8.1.2.9.0.

  7. Navigate to the <PATCH_HOME>/bin directory.

    Note:

    <PATCH_HOME> indicates the path where patch contents are extracted.
  8. To apply the patch, execute the following.
    ./applyPatch.sh -cs
    Follow the console logs for execution details. In case of any errors, contact My Oracle Support.

    Note:

    1. This patch will stop Compliance Studio. It will back up the affected jars, files, or directories and subsequently update the corresponding items.
    2. After the replacement, it will reinstall the Compliance Studio to update the configuration.
    3. After reinstall, the patch will start the Compliance Studio.
    4. Any manual configurations to the files which are available in the Files Packaged in This Patch section has to be reconfigured after applying the patch.
    5. When you reapply the patch, comment out the copy commands in update_ml4aml.sh file until where it has been executed since the last patch application.
  9. Restart Compliance Studio.
  10. On top of CS 8.1.2.9.0, apply the patches listed in the following table in sequential order.

    Table 2-2 Patch Details

    Patch Version Patch Number
    CS 8.1.2.9.1 37865671
    CS 8.1.2.9.2 38066664
    CS 8.1.2.9.3 37947168