5.5 Configure the configForEST.sh file

To configure the configForEST.sh file:
  1. Log in to the server as a Non-root user.
  2. Navigate to the following path: /installation directory/OFS_STSA/bin/ directory .
    For example, /scratch/ofsaaweb/EST_HOME/OFS_STSA/bin
  3. Edit the applicable configForEST.sh attributes as shown here.
    Sample configForEST.sh file
    #!/bin/sh ## Common properties export EST_WALLET_LOCATION=/scratch/ofsest/STSA_8123/OFS_STSA/wallet export EST_TNS_ADMIN_PATH=/scratch/ofsest/STSA_8123/OFS_STSA/wallet export EST_CONF_WALLET_ALIAS=STSDV8123CONF export EST_META_WALLET_ALIAS=STSDV8123CONF export LOG_HOME=/scratch/ofsest/STSA_8123/OFS_STSA/logs export FTPSHARE_PATH=/scratch/ofsest/STSA_8123/OFS_STSA/ftpshare ## with no '/' at end and no http:// or https:// export HOST_NAME=ofss-mum-2788.snbomprshared1.gbucdsint02bom.oraclevcn.com ## Path Upto Directory where all bin,conf,lib,mmg-ui folders are present export MMG_INSTALLATION_PATH=##MMG_INSTALLATION_PATH## ##application properties export EST_SERVICE_SERVER_PORT=31101 export EST_UI_SERVICE_SERVER_PORT=31102 export EST_UI_SERVER_PORT=31103 export EST_SCHEMA_CREATOR_PORT=31104 export AAI_CONNECTION_ISMULTITENANT=true export AAI_CONNECTION_MAXPOOLSIZE_OVERRIDE=4 export SPRING_MASTERDATASOURCE_WALLETENABLED=true export SPRING_MASTERDATASOURCE_WALLETURL=jdbc:oracle:thin:@STSDV8123CONF export SPRING_MASTERDATASOURCE_DRIVER_CLASS_NAME=oracle.jdbc.OracleDriver export SPRING_MVC_PATHMATCH_MATCHING_STRATEGY=ant-path-matcher export EST_SERVER_SERVLET_CONTEXT_PATH=estservice export LOCALE=en-us export ofs_tenant_id=MMG1 export ofs_service_id=OFSAA export ofs_app_id=est export ofs_cor_id=#TXN_523# #export spring.datasource.hikari.minimum-idle= 1 #export spring.datasource.hikari.maximum-pool-size= 2 export FEIGN_CLIENT_CONFIG_DEFAULT_CONNECTTIMEOUT=160000000 export FEIGN_CLIENT_CONFIG_DEFAULT_READTIMEOUT=160000000 ## MMG Keys location with '/' at end export EST_MMG_KEYS_LOC=/scratch/ofsest/STSA_8123/OFS_STSA/MMG/OFS_MMG/conf/ #PMF Keys export spring_main_allow_circular_references=true #Open Metadata Keys start ## Only Base URL of OM [sslType://hostname:port] export OPENMETADATA_URL=http://100.76.123.142:8585 export OPENMETADATA_VERSION=v1 export OPENMETADATA_TOKEN=XXXXYYZZZ export OPENMETADATA_ADMINUSERNAME=admin export OPENMETADATA_ADMINPASSWORD=admin export OPENMETADATA_SHOULDUSETOKEN=true export OPENMETADATA_TOKENGENERATIONTIME=36000 #Provide full token URL (Suffix may differ on provider) eg: https://host/oauth2/v1 export OPENMETADATA_IDCS_URL= export OPENMETADATA_IDCS_APPLICATION_CLIENT_ID=#OPENMETADATA_IDCS_APPLICATION_CLIENT_ID# export OPENMETADATA_IDCS_APPLICATION_CLIENT_SECRET=#OPENMETADATA_IDCS_APPLICATION_CLIENT_SECRET# #Open Metadata Keys end #Auth-validation Keys # export AUTH_REQUIRED=false # est_function_codes=EST_SCENARIO_VIEW,EST_SCENARIO_SUMM,EST_SCENARIO_MOD,EST_SCENARIO_DEL,EST_SCENARIO_COPY,EST_SCENARIO_ADD,EST_PROCESS_VIEW,EST_PROCESS_SUMM,EST_PROCESS_MOD,EST_PROCESS_DEL,EST_PROCESS_COPY,EST_PROCESS_ADD,EST_PORTFOLIO_VIEW,EST_PORTFOLIO_SUMM,EST_PORTFOLIO_MOD,EST_PORTFOLIO_DEL,EST_PORTFOLIO_COPY,EST_PORTFOLIO_ADD,EST_METRICS_VIEW,EST_METRICS_SUMM,EST_METRICS_MOD,EST_METRICS_DEL,EST_METRICS_COPY,EST_METRICS_ADD,EST_AY_CFG_VIEW,EST_AY_CFG_SUMM,EST_AY_CFG_MOD,EST_AY_CFG_DEL,EST_AY_CFG_COPY,EST_AY_CFG_ADD,EST_PROJECT_VIEW,EST_PROJECT_SUMM,EST_PROJECT_MOD,EST_PROJECT_DEL,EST_PROJECT_COPY,EST_PROJECT_ADD,EST_VARIABLE_VIEW,EST_VARIABLE_SUMM,EST_VARIABLE_MOD,EST_VARIABLE_DEL,EST_VARIABLE_COPY,EST_VARIABLE_ADD,CPCRUDSUMM,CPCRUDEDIT,CPCRUDREM,WFCRUDAPP,RPCRUDAPP,CPCRUDAPP,WRCCRUDAPP,ADD_WF,EDIT_WF,DEL_WF,VIEW_WF,SUM_WF,LINK_WF,VIEW_WF_M,MAN_WF_M,INBOXLINK,WFCRUDSUMM,WFCRUDEDIT,WFCRUDREM,RPCRUDSUMM,RPCRUDEDIT,RPCRUDREM,MDLADD,MDLVIEW,MDLEDIT,MDLCOPY,MDLDEL # est_dev=true #SSL Configurations export SERVER_SSL_KEY_STORE_TYPE=PKCS12 export SERVER_SSL_KEY_STORE=/scratch/ofsest/STSA_8123/OFS_STSA/SSLKeys/server.keystore export SERVER_SSL_KEY_STORE_PASSWORD=secret export SERVER_SSL_KEY_ALIAS=estalias export SERVER_SSL_ENABLED=false #est-ui export AAI_COOKIE_DOMAIN=.snbomprshared1.gbucdsint02bom.oraclevcn.com export LOGGING_LEVEL_ROOT=DEBUG export SPRING_MVC_VIEW_PREFIX=/ export SPRING_MVC_VIEW_SUFFFIX=.html export SERVER_MAX_HTTP_HEADER_SIZE=32KB export DATAPIPELINE_URL_FOR_UI=http://ofss-mum-2757.snbomprshared1.gbucdsint02bom.oraclevcn.com:11107/pipelineserviceui/pmf/dp/index.jsp export DATACATALOG_BASE_URL=http://ofss-mum-2757.snbomprshared1.gbucdsint02bom.oraclevcn.com:31101/estservice/ export TOKEN_CLIENT_ID=ofsauser export TOKEN_SECRET=secret export AAI_CONFIG_WALLET_ALIAS=llfp812jpconf ## Above Property is for OFSAA Config Alias ##BI REPORT # No '/' at end export BI_REPORT_URL=http://ofss-mum-2757.snbomprshared1.gbucdsint02bom.oraclevcn.com:9502/dv ##Log level for DI- DEBUG or INFO export EST_DI_LOG_LEVEL=DEBUG export EST_DI_DATEFORMAT=MM/dd/YYYY

    Table 5-2 Details of attributes in the configforEST.sh file

    Parameter Description Is Mandatory Comments
    ##OPENMETADATA_URL## The URL to openmetadata application's API endpoint.    
    ##EST_WALLET_LOCATION## The location where the oracle wallet is created. For more information, see the Configuring Password Store with Oracle Wallet. YES /scratch/users/wallet
    ##EST_TNS_ADMIN_PATH## The folder that contains the tnsnames.ora file. YES /scratch/users/tns
    ##EST_CONF_WALLET_ALIAS## The wallet alias name configured for the STSA application configuration schema. YES STSA_CONFIG

    Note: Ensure that this and alias name mentioned in config.sh file are the same.

    ##EST_META_WALLET_ALIAS## The wallet alias name configured for the STSA application META schema.

    Note: The value is same as ##EST_CONF_WALLE T_ALIAS##.

    		YES STSA_CONFIG
    ##LOG_HOME## A writable folder designated for storing application and liquibase logs YES scratch/users/logs
    #FTPSHARE# This can be any writable folder accessible to the process owner. Grant 0775 permission YES

    /scratch/users/ftpshare

    Ensure that an ftpshare folder is created before installation.
    ##HOST_NAME## Hostname on which the all services run. Use the same hostname wherever applicable.

    Note: Do not add any protocol to host IP or Fully Qualified Domain Name (FQDN).

    		YES HostIP or FQDN

    Example: <hostname>.xyz.com
    ##MMG_INSTALLATION_PATH## Path where MMG is installed that contains (bin, mmg-ui, mmg-service and so on) folders. Required only when existing MMG is used and is already installed in the same environment. NO Example: <MMG_INSTALLATION_DIRECTORY>/OFS_MMG
    ##EST_SERVICE_SERVER_PORT## Port number where the backend service (estservice) is running. YES 3101
    ##EST_UI_SERVICE_SERVER_PORT## Port number where the UI service (estui service) is running. YES 3102
    ##EST_UI_SERVER_PORT## Port number where the UI ojet service (estui) is running. YES 3103
    ##EST_SCHEMA_CREATOR_PORT## Port number where the schema creator for STSA is running. YES 3104
    ##AAI_CONNECTION_ISMULTITENANT## This is the connection library to enable multi tenant connection. The default value is set to true.

    Note: Retain the value as is given in the configuration file.

    		YES NA
    ##AAI_CONNECTION_MAXPOOLSIZE_OVERRIDE## This is a connection pool size across the services. The default value is set to 4.

    Note: Retain the value as is given in the configuration file.

    		YES NA
    ##SPRING_MASTERDATASOURCE_WALLETENABLED## Boolean property indicating if you have to use the wallet for the masterdatasource connection. The default value is set to true.

    Note: Retain the value as is given in the configuration file.

    		YES NA
    ##SPRING_MASTERDATASOURCE_WALLETURL## This is the jdbc url to connect to the wallet alias. Replace the placeholder with wallet alias name of configuration schema. YES jdbc:oracle:thin:@STSA_CONFIG
    ##SPRING_MASTERDATASOURCE_DRIVER_CLASS_NAME## This is the class name of the JDBC driver that you use to communicate with the database. The default value is set as oracle.jdbc.OracleDriver. The value is same as ##EST_CONF_WALLE T_ALIAS## attribute.

    Note: Retain the value as is given in the configuration file.

    		YES NA
    ##SPRING_MVC_PATHMATCH_MATCHING_STRATEGY## Choice of strategy for matching request paths against registered mappings. The default value is ant-path-matcher .

    Note: Retain the value as is given in the configuration file.

    		YES NA
    ##EST_SERVER_SERVLET_CONTEXT_PATH## Context path of the application. The default value is estservice. YES NA
    ##LOCALE## This is the property that defines the users language. The default value is en-us.

    Note: Retain the value as is given in the configuration file.

    		YES NA
    ##ofs_tenant_id## This is the default tenant id value. The default value is MMG1.

    Note: Retain the value as is given in the configuration file.

    		YES NA
    ##ofs_service_id## This is a default service id value. The default value is OFSAA.

    Note: Retain the value as is given in the configuration file.

    		YES NA
    ##ofs_app_id## This is a default application id. The default value is est.

    Note: Retain the value as is given in the configuration file.

    		YES NA
    ##ofs_cor_id## This is a default corelation id value. The default value is TXN_523.

    Note: Retain the value as is given in the configuration file.

    		YES NA
    FEIGN_CLIENT_CONFIG_DEFAULT_CONNECTTIMEOUT The connection timeout prevents blocking the caller due to the long server processing time. The default value is 160000000 MilliSeconds (ms).

    Note: Retain the value as is given in the configuration file.

    		YES < STSA Installation Path> / OFS_STSA/conf
    FEIGN_CLIENT_CONFIG_DEFAULT_READTIMEOUT The read timeout is applied from the time of connection establishment and is triggered when returning the response time takes too long. The default value is 1600000000 ms.

    Note: Retain the value as is given in the configuration file.

    		YES NA
    ##EST_MMG_KEYS_LOC## Provide the absolute path of the MMG public and private keys. MMG keys are generated in the MMG setup steps. See the mmg keys location in the <mmg configuration file> (MMG_KEYS_LOC property ). YES < MMG Installation Path> / OFS_MMG/conf
    spring_main_allow_circular_references This parameter checks whether to allow circular references between beans and automatically tries to resolve them. The default value is set to true.

    Note: Retain the value as is given in the configuration file.

    		YES NA
    ##OPENMETADATA_VERSION## Version of the Openmetadata application. Ensure that this value is v1. YES Example: v1
    ##OPENMETADATA_TOKEN## Token for validating api calls made to openmetadata application. YES NA
    ##OPENMETADATA_ADMINUSERNAME## Administrator username for OM Application.

    If the OPENMETADATA_SHOULDUSETOKEN attribute is set to true, then this parameter is mandatory.

    		YES admin
    ##OPENMETADATA_ADMINPASSWORD## Administrator password for OM Application.

    If the OPENMETADATA_SHOULDUSETOKEN attribute is set to true, then this parameter is mandatory.

    		YES admin
    ##OPENMETADATA_SHOULDUSETOKEN## Set this value to true if you are using token based authentication.

    Set this value to false if you are using SSO based authentication.

    		YES Example: true
    ##OPENMETADATA_TOKENGENERATIONTIME## Token regeneration time for authentication.

    If the OPENMETADATA_SHOULDUSETOKEN attribute is set to false, then this parameter is mandatory.

    Note: If you do not set any value, the default value is taken from OM.

    		YES Example: 360000 ms
    #OPENMETADATA_IDCS_URL# The IDCS URL for OpenMetadata if authentication is configured through SSO.

    If the OPENMETADATA_SHOULDUSETOKEN attribute is set to false, then this parameter is mandatory.

    		NO Example:
    sample idcs url
    #OPENMETADATA_IDCS_APPLICATION_CLIENT_ID# The IDCS client ID from IDCS configuration for Openmetadata if authentication is configured through SSO.

    If the OPENMETADATA_SHOULDUSETOKEN attribute is set to false, then this parameter is mandatory.

    		YES  
    #OPENMETADATA_IDCS_APPLICATION_CLIENT_SECRET# The IDCS SECRET(TOKEN) from IDCS configuration for OpenMetadata if authentication is configured through SSO.

    If the OPENMETADATA_SHOULDUSETOKEN attribute is set to false, then this parameter is mandatory.

    		YES  
    ##SERVER_SSL_KEY_STORE_TYPE## The value passed in the command for keystore creation for -storetype. The values can be either JKS or PKCS12. YES Example: PKCS12
    ##SERVER_SSL_KEY_STORE## Absolute path for the keystore file. Ensure to enter the same path as MMG SSL_KEYSTORE attribute value. YES Include the file name in the path. ../conf/server.keystore
    ##SERVER_SSL_KEY_STORE_PASSWORD## The password for the keystore file is same as SSL_KS_SECRET. YES  
    ##SERVER_SSL_KEY_ALIAS## The value for the alias is same as SSL_KS_ALIAS. YES Example: demoalias
    ##SERVER_SSL_ENABLED## Enables or disables the SSL protocol for the application. YES Example: true
    ##AAI_COOKIE_DOMAIN## The domain of the server. YES Example: in.xyz.com
    ##LOGGING_LEVEL_ROOT## Base level set for type of logs that are available in log file. The value options are: info, debug, and warn. YES Example: DEBUG
    ##SPRING_MVC_VIEW_PREFIX## It applies a prefix to the view name and then looks for a physical resource with that path in the servlet context. The default value is \.

    Note: Retain the value as is given in the configuration file.

    		YES \
    ##SPRING_MVC_VIEW_SUFFFIX## It applies a suffix to the view name and then looks for a physical resource with that path in the servlet context. The default value is .html.

    Note: Retain the value as is given in the configuration file.

    		YES .html
    ##SERVER_MAX_HTTP_HEADER_SIZE## Property to modify the max HTTP response header size in KB. Retain the value provided in configuration file. YES Example: 32KB
    ##DATAPIPELINE_URL_FOR_UI## Provide the datapipeline gateway UI URL set in MMG. YES Format: http(s)://<BE_HOSTNAME>:<DATAPIPELINE_GATEWAY_SERVICE_PORT>/pipelineserviceui/pmf/dp/index.jsp where

    BE_HOSTNAME and DATAPIPELINE_GATEWAY_SERVICE_PORT is from mmg installation steps.

    ##DATACATALOG_BASE_URL## This is the base URL to datacatalog application for UI. YES Format: http(s)://<HOST_NAME>:<EST_SERVICE_SERVER_PORT>/<EST_SERVER_SERVLET_CONTEXT_PATH>
    ##TOKEN_CLIENT_ID## Client ID used for token generation for authentication. The value is ofsauser. YES Example: ofsauser
    ##TOKEN_SECRET## Secret (Pass) used for token generation for authentication. Ensure that this value is secret. YES Example: secret
    ##AAI_CONFIG_WALLET_ALIAS## Provide the wallet alias for configuration schema of production OFSAA application. YES OFSAACNF
    ##BI_REPORT_URL## The URL to view BI reports after running the project. YES http(s)://BI_HOST_NAME:BI_PORT/dv
    ##EST_DI_LOG_LEVEL## The Log level to specify what level of Direct Ingestion logs are to be produced. NO. If no level specified default logs will be of INFO level.
    ##EST_DI_DATEFORMAT## The date format that will be used by Direct Ingestion utility to fetch records from external datasource NO If no format specified then default will be MM/dd/YYYY