Configure the configForEST.sh file

5.5 Configure the configForEST.sh file

To configure the configForEST.sh file:

Log in to the server as a Non-root user.
Navigate to the following path: /installation directory/OFS_STSA/bin/ directory .
For example, /scratch/ofsaaweb/EST_HOME/OFS_STSA/bin

Edit the applicable configForEST.sh attributes as shown here.

Sample configForEST.sh file

#!/bin/sh

## Common properties
export EST_WALLET_LOCATION=<WALLET_LOCATION_PATH>
export EST_TNS_ADMIN_PATH=<TNS_ADMIN_PATH>
export EST_CONF_WALLET_ALIAS=<CONFIG_WALLET_ALIAS>
export EST_META_WALLET_ALIAS=<ATOMIC_WALLET_ALIAS>
export LOG_HOME=<LOG_DIRECTORY_PATH>
export FTPSHARE_PATH=<FTPSHARE_DIRECTORY_PATH>
## with no '/' at end and no http:// or https://
export HOST_NAME=<HOST_NAME_OR_IP>

## Path up to 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:@<CONFIG_WALLET_ALIAS>
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=<TENANT_ID>
export ofs_service_id=<SERVICE_ID>
export ofs_app_id=est
export ofs_cor_id=<CORRELATION_ID>

export FEIGN_CLIENT_CONFIG_DEFAULT_CONNECTTIMEOUT=160000000
export FEIGN_CLIENT_CONFIG_DEFAULT_READTIMEOUT=160000000

## MMG Keys location
export EST_MMG_KEYS_LOC=<MMG_KEYS_PATH>

# PMF Keys
export spring_main_allow_circular_references=true

# Open Metadata Keys start
export OPENMETADATA_URL=http://<OPENMETADATA_HOST>:<PORT>
export OPENMETADATA_VERSION=v1
export OPENMETADATA_TOKEN=<TOKEN>
export OPENMETADATA_ADMINUSERNAME=<OM_ADMIN_USERNAME>
export OPENMETADATA_ADMINPASSWORD=<OM_ADMIN_PASSWORD>
export OPENMETADATA_SHOULDUSETOKEN=true
export OPENMETADATA_TOKENGENERATIONTIME=36000
export OPENMETADATA_IDCS_URL=
export OPENMETADATA_IDCS_APPLICATION_CLIENT_ID=<IDCS_CLIENT_ID>
export OPENMETADATA_IDCS_APPLICATION_CLIENT_SECRET=<IDCS_CLIENT_SECRET>
# Open Metadata Keys end

# SSL Configurations
export SERVER_SSL_KEY_STORE_TYPE=PKCS12
export SERVER_SSL_KEY_STORE=<KEYSTORE_PATH>
export SERVER_SSL_KEY_STORE_PASSWORD=<KEYSTORE_PASSWORD>
export SERVER_SSL_KEY_ALIAS=<KEY_ALIAS>
export SERVER_SSL_ENABLED=false

# est-ui
export AAI_COOKIE_DOMAIN=<COOKIE_DOMAIN>
export LOGGING_LEVEL_ROOT=DEBUG
export SPRING_MVC_VIEW_PREFIX=/
export SPRING_MVC_VIEW_SUFFFIX=.html
export SERVER_MAX_HTTP_HEADER_SIZE=32KB

# Remove this line if deprecated:
# export DATAPIPELINE_URL_FOR_UI=<URL>  # (Remove if no longer used)

export DATACATALOG_BASE_URL=http://<DATACATALOG_HOST>:<PORT>/<CONTEXT_PATH>/

export TOKEN_CLIENT_ID=<CLIENT_ID>
export TOKEN_SECRET=<CLIENT_SECRET>

export AAI_CONFIG_WALLET_ALIAS=<CONFIG_WALLET_ALIAS>

## BI REPORT
export BI_REPORT_URL=http://<BI_REPORT_HOST>:<PORT>/dv

## Log level for DI
export EST_DI_LOG_LEVEL=DEBUG
export EST_DI_DATEFORMAT=MM/dd/YYYY
#Path to pub and priv keys
export SSH_KEYS_PATH=##SFTP_SSH_KEYS_PATH##

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

Parameter	Description	Is Mandatory	Comments
##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_PATH#	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:
#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
##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
##SSH_KEYS_PATH##	Specify the path to the public and private SSH keys used for connecting to remote machines. If the keys do not exist, generate them using the following command: `ssh-keygen -t rsa -b 4096 -f ~/.ssh/id_rsa` Copy the generated key pair to a different folder and provide the path to that folder.	Yes	<STSA Installation Path>/SSH_KEYS This property can be `<STSA Installation Path>/OFS_STSA/MMG/OFS_MMG/conf` .