Jump to: navigation, search

Configuring GAX Properties

After GAX starts for the first time, it generates the following files and folders in the installation directory:

  • conf/gax.properties
  • webapp
  • logs
  • jsp

You can configure GAX by editing the gax.properties file. The options specified in the gax.properties file are used by GAX before it connects to Configuration Server. To set additional configuration options, see Configuration Options.

Read more general information about Java-based .properties files here.

The following options can be configured:

Option Description Possible Values Default Value
accesslog_enabled Enables HTTP access logging true, false true
accesslog_filename File name for the HTTP access log Valid filename ./logs/http-yyyy_mm_dd.log
accesslog_timezone Time zone for the HTTP access log Any valid timezone code (see Time Zones for a list).
Note: It is recommended to specify the time zone value in canonical format instead of three-letter time zone IDs. For example, Australia/Sydney, Asia/Kolkata, America/Los_Angeles, and so on.
accesslog_append After GAX is restarted, specifies whether to append to existing HTTP access log true, false true
accesslog_extended Specifies whether to include extended information in the HTTP access log true, false false
accesslog_cookies Specifies whether to include cookies in the HTTP access log true, false false
accesslog_retaindays Specifies number of days to retain the HTTP access log integer 90
app Specifies the GAX Application object Existing Application object name
backup_port Specifies the backup Configuration Server Port integer
backup_host Specifies the backup Configuration Server Host, written as a Fully Qualified Domain Name (FQDN) or IP address Valid FQDN or IP address
Enables real-time notification if the configuration object currently being modified has been updated by another user while the current user was modifying it; that is, since the object's properties window was opened. See Coordinating Simultaneous Changes to Data.
Note: This feature is currently supported only in the Configuration Manager view.
true, false false
host Specifies the primary Configuration Server Host, written as a Fully Qualified Domain Name (FQDN) or IP address Valid FQDN or IP address
http_port Defines the HTTP port integer 8080
https_port Defines the HTTPS port integer 8443
keystore_path Specifies the keystore path. Valid path, for example: C:\\OpenSSL-Win32\\bin
keystore_password Specifies the keystore password Note: The password is encrypted and must not be modified directly. Instead, refer to Step 4 of Setting up HTTPS for use with Genesys Administrator Extension.
max_cfg_connection Specifies the maximum number of connections to allow from GAX to Configuration Server. To allow unlimited connections, set the value to -1. -1 or any positive integer 200
max_idle_time Specifies the maximum idle time, in milliseconds, before automatic logout integer 1000*60*60
port Specifies the primary Configuration Server Port integer
root_url Specifies the root URL (host:port/rootURL) /gax
supported_protocol Defines the protocol to use when communicating with the server http/https/both http
saml_external_userid Defines the protocol to correlate to the External User ID in Genesys Person object. GAX must extract DSID from SAML assertion and query the user by using the external ID, then use the username to enable the user to log in. Valid SAML attribute (DSID) value
saml_jksfilelocation Specifies the location or path of custom JKS Keystore. Valid path
saml_jkspassword Defines the custom JKS Keystore’s password. Any value (password entered during key store generation)
saml_signingkeyname Defines the signing key name (alias provided during custom key store generation) Any value (alias name given during key store generation)
saml_signingkeypassword Defines the signing key password Any value (key password entered during key store generation)


Comment on this article:

blog comments powered by Disqus
This page was last modified on December 12, 2018, at 22:17.