A.1 Additional Configuration

You can customize port number for the services and other additional configuration if required.

Customizable Parameters

Users can customize the parameters based on their preferences using additional_config.sh file.

After updating the additional_config.sh file, you must stop, trigger a reinstall, and then start Compliance Studio.

Note:

The custom ports for the Batch Service and Meta Service are not replaced in the appropriate files, so the following changes must be made manually.

To update the custom port for Batch Service, follow these steps:

  1. Navigate to the <COMPLIANCE_STUDIO_INSTALLATION_PATH>/deployed/batchservice/ conf directory.
  2. Open the server-config.properties file.
  3. Based on your preferences, update the custom port for the following parameters:
    • server.http.port:<Custom port for batch service to start>
    • server.shutdownPort:<Custom port for batch service to stop>

      For example,

      server.http.port:16043

      server.shutdownPort:16044

  4. Navigate to <COMPLIANCE_STUDIO_INSTALLATION_PATH>/batchservice/confdirectory (outside the deployed location) and repeat step 3.

To update the custom port for Meta Service, follow these steps:

  1. Navigate to the <COMPLIANCE_STUDIO_INSTALLATION_PATH>/deployed/metaservice/ conf directory.
  2. Open the server-config.properties file.
  3. Based on your preferences, update the custom port for the following parameters:
    • server.http.port:<Custom port for meta service to start>
    • server.shutdownPort:<Custom port for meta service to stop>

      For example,

      server.http.port:16043

      server.shutdownPort:16044

  4. Navigate to <COMPLIANCE_STUDIO_INSTALLATION_PATH>/metaservice/conf directory (outside the deployed location) and repeat step 3.

To customize the parameters, follow these steps:

  1. Navigate to <COMPLIANCE_STUDIO_INSTALLATION_PATH>/bin directory.
  2. Open the additional_config.sh file and update the parameters as mentioned in the following table. The port number/value is provided for reference only; you need to configure it based on your preferences.

Table A-1 Additional Configuration File

Service / Parameter Significance Port Number/ Value
AUTH_SERVICE_PORT Indicates the port number for authorization service. 7041
BATCH_SERVICE_PORT Indicates the port number for batch service. 7043
BE_PORT Indicates the port number for authorization service. 7002
DATAPIPELINE_GATEWAY_SERVICE_PORT Indicates the port number for datapipeline gateway service. 7063
DATASTUDIO_SPARK_INTERPRETER_PORT Indicates the port number for Datstudio’s spark interpreter. 7014
DATASTUDIO_SERVER_PORT Indicates the port number for Datstudio server. 7008
DATASTUDIO_MARKDOWN_INTERPRETER_PORT Indicates the port number for Datstudio’s markdown interpreter. 7009
DATASTUDIO_PYTHON_INTERPRETER_PORT Indicates the port number for Datstudio’s python interpreter. 7012
DATASTUDIO_JDBC_INTERPRE TER_PORT Indicates the port number for Datstudio’s jdbc interpreter. 7011
DATASTUDIO_PYTHON_INTERPRETER_REST_SERVER_PORT Indicates the port number for Datstudio’s python interpreter of the server. 6012
DATASTUDIO_PGX_PYTHON_INTERPRETER_REST_SERVER_PORT Indicates the port number for Datstudio’s pgx-python interpreter of the server. 6022
DATASTUDIO_THRIFT_EVENT_ HANDLER_PORT Indicates the port number for Datstudio’s thrift event handler. 8432
DATASTUDIO_PGX_INTERPRET ER_PORT Indicates the port number for Datstudio’s pgx interpreter. 7022
DATAPIPELINE_HAZELCAST_PORT Indicates the port number for datapipline hazelcast. 5701
DATA_PIPELINE_UI_SERVICE_PORT Indicates the port number for datapipline UI service. 7067
ER_SERVICE_PORT Indicates the port number for Entity Resolution service. 7051
GRAPH_SERVICE_PORT Indicates the port number for Graph service. 7059
GRAPH_SERVICE_CACHE_SERV ER_PORT Indicates the port number for cache server of the Graph service. 7060
JDBC_EVENT_PORT Indicates the port number for jdbc event. 7031
JDBC_PORT Indicates the port number for jdbc. 7011
LOAD_TO_OS_SERVICE_PORT Indicates the port number for load to OpenSearch service. 7053
MATCHING_SERVICE_PORT Indicates the port number for matching service. 7049
META_SERVICE_PORT Indicates the port number for meta service. 7045
MMG_COHERENCE_CLUSTER_PORT Indicates the port number for MMG coherence cluster. 7574
PIPELINE_UI_SERVICE_PORT Indicates the port number for pipeline UI service. 7065
PYTHON_DEFAULT_EVENT_PORT Indicates the port number for python default event. 7030
PYTHON_DEFAULT_PORT Indicates the port number for default python. 7010
PYTHON_DEFAULT_REST_PORT Indicates the port number for default python rest. 7077
PYTHON_ML4AML_EVENT_PORT Indicates the port number for python ML4AML event. 7036
PYTHON_ML4AML_PORT Indicates the port number for python ML4AML. 7016
PYTHON_ML4AML_REST_PORT Indicates the port number for python ML4AML rest. 7097
PYTHON_SANE_EVENT_PORT Indicates the port number for python sane event. 7037
PYTHON_SANE_PORT Indicates the port number for python sane. 7017
PYTHON_SANE_REST_PORT Indicates the port number for python sane rest. 7087
SCHEMA_PORT Indicates the port number for schema. 7003
SESSION_SERVICE_PORT Indicates the port number for session service. 7047
STUDIO_SERVICE_PORT Indicates the port number for studio service. 7008
UI_PORT Indicates the port number for UI. 7001
CONNECTION_TIME_OUT Indicates the connection time out. 50000
DS_API_VERSION Indicates the API version for Data Studio. 20230913
HOSTNAME Indicates the hostname of the application. `hostname -f`
MD_VERSION Indicates the version of the application. 21.4.9
READ_TIME_OUT Indicates the read time out. 50000
LOG_LEVEL Indicates the log level. INFO
STUDIO_LOG_LEVEL Indicates the log level of the Studio. INFO
DATAPIPELINE_SERVICE_PORT1 Indicates the port number for datepipeline. 18005
DATAPIPELINE_SERVICE_PORT2 Indicates the port number for datepipeline. 18006
DATAPIPELINE_METADATA_IMPORT_SERVICE_PORT Indicates the port number for importing metadata in the datapipeline 18007
DATASTUDIO_SERVER_TOMCAT_THREADS_MAX Maximum amount of worker threads. 200
DATASTUDIO_HIKARI_MAX_LIFE_TIME Maximum lifetime for a connection in the pool. 28800000
DATASTUDIO_HIKARI_MINIMUM_IDLE Minimum number of idle connections that the pool should try to maintain. 10
DATASTUDIO_HIKARI_CONN_TIMEOUT_MS Maximum time application is willing to wait for a connection from the pool. 30000
DATASTUDIO_HIKARI_MAXPOO LSIZE Maximum number of connections that can be held in the connection pool. 350
DATASTUDIO_SERVER_ASYNC_ THREADPOOL_SIZE Number of threads in the thread pool used for asynchronous request. 128
DATASTUDIO_SERVER_SCHED_ THREADPOOL_SIZE Number of threads in the thread pool used for scheduled execution. 128
DATASTUDIO_INTERPRETER_CLEANUP_CRON Expression defines the schedule for the idle session cleanup. "'*/5 * * * * *'"
DATASTUDIO_INTERPRETER_CLEANUP_ENABLED It is used to enable or disable the idle session cleanup. TRUE
DATASTUDIO_INTERPRETER_IDLE_SESSION_TIMEOUT Timeout duration for idle session. Longer sessions idle will be terminated. PT1H
DATASTUDIO_ENABLE_INTERPRETER_RESTART It is used to enable or disable the interpreter restart. TRUE
DATASTUDIO_STARTUP_THRESHOLD_MS

The maximum time allowed for the interpreter to start in milliseconds. If the interpreter fails to start within this time, it is considered as unhealthy and restart is required.

Note:

This parameter is applicable only when this parameter (DATASTUDIO_ENABLE_INTERPRETER_RESTART) is enabled.

 60000
DATASTUDIO_CHECK_ALIVE_INTERVAL Indicates the time interval between health checks for the interpreter in milliseconds. 60000
DATASTUDIO_ZPLN_SCHED_THREADPOOL_SIZE Number of threads in the thread pool used by Zeppelin's scheduler. 10000

Non-customizable Parameters

Note:

Do not modify the parameters within the Non-customizable parameters section.