Contribute in GitHub:

Voice agent tester environment variables

The following tables list all the Docker environment variables that can be used to configure the Voice Agent Tester microservice.

Environment variables for configuration

The following table describes the environment variables that can be used in configuration.

Table 1. General Deployment Configuration
Environment variable name	Default value	Description
TESTER_WEBHOOK_URI	None	(Optional) Specifies the URI of the microservice where all the endpoints are found. If not defined, the default assumes that the microservice is being run from a docker container and that the Voice Gateway that starts the outbound calls is in the same container network. Inside the application, the URI is built with an http protocol that reflects these assumptions.
CLOUDANT_URL	None	Specifies the URL endpoint of the database where all the associated test data is found. Takes precedence over `CLOUDANT_ACCOUNT`. This variable applies to both Cloudant and CouchDB.
CLOUDANT_USERNAME	None	Specifies the user name for authenticating to the database where the resources are stored. Along with `CLOUDANT_PASSWORD`, this variable takes precedence over `CLOUDANT_APIKEY`. This variable applies to both Cloudant and CouchDB.
CLOUDANT_PASSWORD	None	Specifies the password for authenticating to the database where the resources are stored. Along with `CLOUDANT_USERNAME`, this variable takes precedence over `CLOUDANT_APIKEY`. This variable applies to both Cloudant and CouchDB.
CLOUDANT_ACCOUNT	None	Specifies a string that defines your IBM Cloudant account name, if the user name and account name are different. This variable applies to Cloudant only.
CLOUDANT_APIKEY	None	Specifies the API key for authenticating to the database where the resources are stored. This variable applies to Cloudant only.
CLOUDANT_DATABASE_NAME	None	Specifies the name of the database where you want your data stored. If no database exists, one is created. This variable applies to both Cloudant and CouchDB.
CACHE_TIME_TO_LIVE	10	(Optional) Specifies the number of minutes that the resources inside the cache are valid.
CALLER_VOICE_GATEWAY_URI	None	Specifies the URI of the Voice Gateway's REST application that contains the endpoints for outbound calling
CALLER_VOICE_GATEWAY_USERNAME	None	(Optional) Specifies the user name for authenticating to the outbound calling REST API inside the `CALLER_VOICE_GATEWAY_URI` URI .
CALLER_VOICE_GATEWAY_PASSWORD	None	(Optional) Specifies the password for authenticating to the outbound calling REST API inside the `CALLER_VOICE_GATEWAY_URI` URI.
REST_ADMIN_USERNAME	defaultAdmin	Specifies the admin user name for quick starting the service. This user name must be different than `TESTER_WEBHOOK_USERNAME`.
REST_ADMIN_PASSWORD	defaultPassword	Specifies the admin password for quick starting the service
TESTER_WEBHOOK_USERNAME	defaultUser	Specifies the user name for securing the tester webhook endpoints. This user name must be different then `REST_ADMIN_USERNAME`. If you define a custom registry, you must add this user name as a user in the registry See samples for more details.
TESTER_WEBHOOK_PASSWORD	defaultPass	Specifies the password for securing the tester webhook endpoints. If you define a custom registry, you must add this password as a user in the registry. See samples for more details

Outbound Call defaults

For best results when starting outbound calls, add a default of 15 seconds for POST_RESPONSE_TIMEOUT and 1.6 seconds to the WATSON_STT_FIRMUP_SILENCE_TIME. These are the default settings when starting each outbound call.

Environment variables for logging and tracing

The following table describes the environment variables that can be used for logging and tracing.

Table 2. Environment variables for logging and tracing
Environment variable name	Default value	Description
LOG_LEVEL	info	Specifies the log level for the microservice. Valid values, from least information to most information are, `off`, `fatal`, `severe`, `warning`, `audit`, `fine`, `finest`, and `all`. Note that when the logs are set to `fine`, `finest`, or `all`, they might contain sensitive data.
LOG_MAX_FILES	5	Specifies the maximum number of log files, trace files, and exception summary log files. When this limit is reached, the oldest file is deleted and a new file is created. For example, when this variable is set to 5, the microservice can generate up to 5 message logs, 5 trace logs, and 5 exception summaries.
LOG_MAX_FILE_SIZE	100	Specifies the maximum size in megabytes (MB) that a log file can reach before a new file is created.

Environment variables for Security configuration

SSL

The following table describes the environment variables that can be used for SSL configuration.

Table 3. Environment variables for SSL configuration
Environment variable name	Default value	Description
SSL_TRUST_STORE_FILE	Provided by the container Java™ SDK	Specifies the file that contains the trusted keys for the outbound SSL connections, including connections to the Watson Assistant service, a service orchestration engine, the SMS provider, or the XSLD caching server.
SSL_TRUST_PASSPHRASE	None	Specifies the passphrase that was used to secure the `SSL_TRUST_STORE_FILE` truststore file.
SSL_TRUST_FILE_TYPE	JKS	Specifies the format of the `SSL_TRUST_STORE_FILE` file.
SSL_KEY_STORE_FILE	None	Specifies the keystore file that contains the trusted keys for inbound SSL connections.
SSL_KEY_PASSPHRASE	None	Specifies the passphrase that was used to secure the `SSL_KEY_STORE_FILE` keystore file.
SSL_KEY_FILE_TYPE	JKS	Specifies the format of the `SSL_KEY_STORE_FILE` keystore file.

Authentication

The following table describes the environment variables that can be used for authentication.

Table 4. Environment variables for authentication
Environment variable name	Default value	Description
SERVER_REGISTRY_INCLUDE_PATH	The default Registry for quick starting the service. This registry uses `REST_ADMIN_USERNAME` and `REST_ADMIN_PASSWORD` for authentication	(Optional) Specifies the path to the custom registry that is used for authenticating to the REST API. See samples for more details.
ROLE_NAME_ADMINISTRATOR	Administrator	Specifies the name of the security group that has Administrator access to the service. This group has access to all the REST calls.
ROLE_NAME_EDITOR	Editor	Specifies the name of the security group that has Editor access to the service. This group has access to all the REST calls.
ROLE_NAME_OPERATOR	Operator	Specifies the name of the security group that has Operator access to the service. This group only has access to all the REST calls that involve viewing resources (GETs) and managing jobs.
ROLE_NAME_VIEWER	Viewer	Specifies the name of the security group that has Viewer access to the service. This group only has access to all the REST calls that involve viewing resources (GETs).