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.

Tip

Click this link to read more general information about Java-based .properties files.

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).	GMT
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	Specifices 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.	Valid FQDN or IP
host	Specifies the primary Configuration Server Host, written as a Fully Qualified Domain Name (FQDN) or IP.	Valid FQDN or IP
http_port	Defines the HTTP port.	integer	8080
https_port	Defines the HTTPS port.	integer	8443
keystore_path	Specifies the keystore path.	Valid path
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
saml	Enables Single Sign On.	true, false	false
saml_entityid	Unique SAML Entity ID for IdP.	String
saml_idp_metadata	Specifies location of IdP metadata, as an HTTP URL or file location.	String
saml_landingpage	Specifies the Single Sign On landing page.	String URL
saml_slo	Enables Single Log Out (SLO).	true, false	false
saml_sp_slo_registration_endpoint	For SLO, specifies the registration URL exposed by Activity Monitor	String URL
saml_sp_slo_unregistration_endpoint	For SLO, specifies the unregistration URL exposed by Activity Monitor	String URL
saml_sp_heartbeat_handler_endpoint	Specifies the Genesys service provider heartbeat reporting endpoint.	String URL
saml_sp_activity_reporting_mode	If server-based, the service provider reports user activity to Activity Monitor.	String URL	server_based
saml_application_name	Specifies the name of the GAX Application object. This value must be unique in the environment.	String
saml_sp_slo_endpoint	For SLO, specifies the logout URL exposed by Activity Monitor	String URL
saml_service_provider_id	Specifies the service provider entity name of the current application. This value must be the same as in the corresponding SP metadata's entity ID.	String
saml_sp_return_url	Specifies the return URL after Single Log Out is completed. In most cases, this value is set to the GAX home page (hosturl/gax).	String URL
supported_protocol	Specifies the protocol to use when communicating with the server.	http, https, both	http

Important

Options related to Single Sign On (SSO) and Single Log Out (SLO) might not be available to all customers.

category:Genesys Administrator Extension category:Genesys Administrator Extension Deployment Guide