force_host_network
Section: agentx
Default Value: 0
Valid Values: 1, 0
Changes Take Effect: After restart
When set to 1, specifies that Solution Control Server connects to the Genesys SNMP Master Agent through a host network that is configured in the host section.
When set to 0 (the default), the connection is established through the local host.
haflip-detect-timeout
Section: log
Default Value: 10
Valid Values: 1–2147483647
Changes Take Effect: Immediately
Specifies the time interval, in seconds, for which Solution Control Server detects the flipping of the monitoring applications from Primary to Backup to Primary or vice versa, and prints the following standard log messages depending on the state of the applications or SCS:
- 10327—Indicates that the operation mode (primary or backup) of the application has changed frequently.
- 10328—Indicates that the application is in a stable state.
- 10329—Indicates that "split brain" condition may have occurred for SCS.
- 10330—Indicates that SCS has recovered from the split brain state
delay-reload-backup
Section: csproxy
Default Value: 0
Valid Values: 0 or any positive integer
Changes Take Effect: For the next reconnect to the master
Related Options: delay-reload, proxy-load-max
Specifies the time interval, in seconds, that the backup Configuration Server Proxies or the backup master server must wait to reload data from the master Configuration Server after the initial connection failed. You can specify a higher delay period for the backup Configuration Server proxies to ease the load on the master Configuration Server after network outages when multiple clients need to reload data at the same time.
The configured reload delay period applies to the master Configuration Server when it needs to reload data while running in the backup mode or after being switched to backup mode upon a switchover.
This option does not delay initial data load after Configuration Server restart and it does not delay the attempt to restore the previous session to the master Configuration Server. This option takes effect only if an attempt to restore the previous session with the master Configuration Server fails.
Tip: Specify different delay reload settings for different proxies to establish the order in which proxies initiate reload. You can use this option in conjunction with the [system].proxy-load-max option to further delay data reloading process for the proxies.
delay-reload
Section: csproxy
Default Value: 0
Valid Values: 0 or any positive integer
Changes Take Effect: For the next reconnect to the master
Related Options: delay-reload-backup, proxy-load-max
Specifies the time interval, in seconds, that Configuration Server Proxy waits to reload data from the master Configuration Server after the initial connection failed. When multiple proxies are connected to the master Configuration Server, this feature enables you to prioritize proxy reloads and decrease the time each proxy remains out of service while reloading the data.
This option does not delay initial data load after Configuration Server restart and it does not delay the attempt to restore the previous session to the master Configuration Server. This option takes effect only if an attempt to restore the previous session with the master Configuration Server fails.
Tip: Specify short but different delay reload settings for different proxies to establish the order in which proxies initiate reload. You can use this option in conjunction with the [system].proxy-load-max option to further delay data reloading process for the proxies.
throttle-updates-interval
Section: system
Default Value: 0 (zero)
Valid Values: 0, 1–2147483647
Changes Take Effect: Immediately
Dependencies: serialize-write-transactions=true
Introduced: 8.5.101.20
Related Options: serialize-write-transactions deferred-requests-expiration
Enables transaction throttling and specifies, in milliseconds, the time interval used to throttle data update (transactional) requests. If a data update request is received before this time interval expires, the request is deferred until the interval expires. Any non-transactional requests received from the same client are also deferred and processed in FIFO (first-in, first-out) order after the deferred request is processed. A value of 0 (zero) disables this option.
Notes: When configuring this option, keep in mind that if actual load consistently exceeds the rate specified by this option for a significant time, deferred unprocessed requests will accumulate in the input queue and will be eventually cancelled as defined by the value of the deferred-requests-expiration option. To avoid this happening, consider adjusting the throttle-updates-interval option accordingly, to account for the expected actual load.
skip-annex-validation
Section: system
Default Value: 0 (zero)
Valid Values: 0 (zero), 1, 16
Changes Take Effect: Immediately
Introduced: 8.5.101.21
Specifies if Configuration Server validates the Annex of an object, checking for an empty or duplicate object section. By default, Configuration Server performs a full validation and rejects modifications that can potentially affect data integrity or cannot be displayed properly by Genesys Administrator.
Valid values are:
0 (zero, the default)—Full validation is performed, and changes are rejected if an empty section and/or a duplicate section are found.
1—Partial validation is performed, and changes are rejected if a duplicate section is found.
16—Disables validation completely.
Warning: Set this option to 16 only when requested by Customer Care.
serialize-write-transactions
Section: system
Default Value: false
Valid Values: true, false
Changes Take Effect: Immediately
Introduced: 8.5.101.20
Related Options: deferred-requests-expiration, proxy-load-max, proxy-load-timeout, throttle-updates-interval
Enables (true) or disables (false, default) the following functionality:
- Transaction serialization
- Transactions deferral at proxy/backup startup/data (re)load
- Limiting of the number of proxies concurrently loading/reloading data (requires additional option proxy-load-max)
- Throttling of data updates (requires an additional option throttle-updates-interval)
Transaction serialization is the mode of Configuration Server operation that prevents data change transactions from overlapping and potentially causing a loss of data integrity. It involves the deferral of data change requests so that each request can be processed completely, without impacting or being impacted by other requests.
Transaction serialization mode also defers processing of data change requests for the time when Configuration Server Proxies or backup instance of master Configuration Server are in progress of loading/reloading data from the master primary Configuration Server. At that time, Configuration Server Proxies cannot always correctly process notifications on the data change. These notifications cannot always be correctly applied to partially loaded and not yet fully reconciled dataset. They could be missed or incorrectly applied, resulting in outdated or corrupt data in the proxy's memory. Deferring data changes for the time of data reload prevents this from happening.
Note: This option must be enabled in order for the options proxy-load-max and throttle-updates-interval to take effect.
For a detailed description of this functionality, refer to "Transaction Serialization" section in Framework Deployment Guide.
proxy-load-timeout
Section: system
Default Value: 600
Valid Values: 0, 1–2147483647
Changes Take Effect: Immediately
Dependencies: serialize-write-transactions=true
Introduced: 8.5.101.20
Related Options: serialize-write-transactions proxy-load-max
For transaction serialization mode (see serialize-write-transactions option), specifies the time limit during which transactional requests are deferred to avoid interference with a data load by a single Configuration Server Proxy. If set to 0 (zero), there is no limit.
If a proxy server fails to complete its data load within the specified time interval since it was authorized, it is allowed to continue loading. However, transaction deferral mode is exited and deferred transactions are processed. If the proxy-load-max option is specified, expiration of this interval allows the next proxy server waiting in the queue to start loading its data.
Note: Ensure that this interval is sufficient for the proxies to complete data load, based on the size of the database and the bandwidth of the communication channel between the master Configuration Server and Configuration Server Proxies. Premature termination of the transaction deferral mode allows data change transactions to be processed while the proxy is still loading data. This can cause data inconsistencies in the proxy's data once it completes loading.
proxy-load-max
Section: system
Default Value: 0 (zero)
Valid Values: 0, 1–2147483647
Changes Take Effect: Immediately
Dependencies: serialize-write-transactions=true
Introduced: 8.5.101.20
Related Options: serialize-write-transactions proxy-load-timeout
Enables limiting the number of proxy servers concurrently loading and reloading data and specifies the maximum number of Configuration Server Proxies allowed to (re)load data in parallel. A value of 0 (zero, the default) indicates there is no limit on the number of Configuration Server Proxies. If more than the specified number of proxy servers attempt to reload their data concurrently, only requests from the maximum number of servers are processed; requests from the rest of the servers are deferred until other servers have finished loading their data. This enables the excess Configuration Server Proxies (those with deferred requests) to continue serving their clients with unchanged (original) data and to prevent too many proxy servers from simultaneously disabling their services to reload data and overloading master Configuration Server.
deferred-requests-expiration
Section: system
Default Value: 3600
Valid Values: 0, 1–2147483647
Changes Take Effect: Immediately
Dependencies: serialize-write-transactions=true
Introduced: 8.5.101.20
Related Options: serialize-write-transactions
For transaction serialization mode (see serialize-write-transactions option), enables expiration of regular clients' deferred requests and specifies the time interval (in seconds) for which deferred requests are kept for further processing. A value of 0 means that that request never expires. If a deferred request cannot be processed within this time interval, processing of the request is cancelled and an error response is sent to the client.
This value does not apply to the requests from Configuration Server proxies deferred upon data reload and internally generated requests.
Note: Genesys recommends that you not change the default value unless instructed to do so by your Genesys representative.
enable-upn
Section: authentication
Default Value: 0
Valid Values: 0 to 2
Changes Take Effect: After next login
Specifies whether Configuration Server allows externally authenticated users to be configured and authenticated using Windows-compatible User Principal Name (UPN) format of usernames.
Valid values are:
- 0 (zero, the default value)—Kerberos authentication for UPN usernames is not enabled. Users authenticated through Kerberos should not have the "@domain" suffix in their usernames on Configuration Server.
- 1—UPN-style usernames and plain usernames are allowed for the same user to log in. When Configuration Server login contains UPN credentials, the first user object with UPN is searched for. If the user object is not found, the domain name in the UPN credentials is removed and another search attempt is made. The user is authenticated successfully if either format of username is configured. You must configure this value when you migrate from using the plain username to UPN-style usernames across users authenticated through Kerberos.
- 2—UPN-style login is used strictly. When Configuration Server login contains UPN credentials, the user with UPN is searched for and if the user is not found, an error is returned.
Refer to the "Kerberos External Authentication" chapter of the Framework External Authentication Reference Manual for more information.
audit-max-records
Section: history-log
Default Value: 50000
Valid Values: Any positive integer
Changes Take Effect: Immediately
Specifies the maximum number of records that can be stored in the database. When the maximum number of records is reached, Master Configuration Server will delete the older records while adding new records. Genesys recommends not to set the value above 100000 for performance reasons. Configuration Server cleans up the history records based on this option every 30 minutes.
audit-expiration
Section: history-log
Default Value: 365
Valid Values: Any positive integer
Changes Take Effect: Immediately
Specifies the number of days of records to retain in the database. For example, if the value is set to 30, the records of the last 30 days will be kept in the database and older records will be deleted. The maximum value for this option is 365. Configuration Server cleans up the history records based on this option every 30 minutes.
Note: The value of this option must always be greater than expiration.
primary-master-response-timeout
Section: confserv
Default Value: 600
Valid Values: Any positive integer
Changes Take Effect: Immediately
Specifies the time interval, in seconds, the backup Configuration Server and Configuration Server Proxy waits for a response from the primary master Configuration Server while loading data from it. If this timeout expires, connection to the primary master Configuration Server is closed and then reconnection and data loading processes are reattempted from scratch.
For master Configuration Server, set this option in the main section of Configuration Server primary and backup to enable this functionality during startup. For the proxies, this option must be specified in the command line.
Note: The time measured to determine the timeout condition includes the time needed to completely receive a response for each request. Some responses may contain a significant portion of the entire configuration database. Setting this option too small for large databases can cause false timeouts and results in consistent failure to load data.
x-stat-print-interval
Section: log
Default Value: 0
Valid Values: 0 or any positive integer
Changes Take Effect: For the next scheduled printout
Specifies the interval (in seconds) between each logging printout of the statistics.
When the statistics printout interval is set, all statistics log entries are written in a separate log file with the suffix _stat in the file name and this file is placed in the same directory as the regular log file. The default value 0 (zero) means that the feature is disabled.
Note: The statistics log file is created and updated only if the following two conditions are met:
- The verbose option is set to debug or all.
- File logging is configured for the regular logs.
delay-reload-backup
Section: csproxy
Default Value: 0
Valid Values: 0 or any positive integer
Changes Take Effect: For the next reconnect to the master
Related Options: delay-reload, proxy-load-max
Specifies the time interval, in seconds, that the backup Configuration Server Proxies or the backup master server must wait to reload data from the master Configuration Server after the initial connection failed. You can specify a higher delay period for the backup Configuration Server proxies to ease the load on the master Configuration Server after network outages when multiple clients need to reload data at the same time.
The configured reload delay period applies to the master Configuration Server when it needs to reload data while running in the backup mode or after being switched to backup mode upon a switchover.
This option does not delay initial data load after Configuration Server restart and it does not delay the attempt to restore the previous session to the master Configuration Server. This option takes effect only if an attempt to restore the previous session with the master Configuration Server fails.
Tip: Specify different delay reload settings for different proxies to establish the order in which proxies initiate reload. You can use this option in conjunction with the [system].proxy-load-max option to further delay data reloading process for the proxies.
delay-reload
Section: csproxy
Default Value: 0
Valid Values: 0 or any positive integer
Changes Take Effect: For the next reconnect to the master
Related Options: delay-reload-backup, proxy-load-max
Specifies the time interval, in seconds, that Configuration Server Proxy waits to reload data from the master Configuration Server after the initial connection failed. When multiple proxies are connected to the master Configuration Server, this feature enables you to prioritize proxy reloads and decrease the time each proxy remains out of service while reloading the data.
This option does not delay initial data load after Configuration Server restart and it does not delay the attempt to restore the previous session to the master Configuration Server. This option takes effect only if an attempt to restore the previous session with the master Configuration Server fails.
Tip: Specify short but different delay reload settings for different proxies to establish the order in which proxies initiate reload. You can use this option in conjunction with the [system].proxy-load-max option to further delay data reloading process for the proxies.
consistent-port-selection
Section: system
Default Value: false
Valid Values: true, false
Changes Take Effect: At the next reconnect. For master Configuration Server, this option must be configured from the configuration files and it must be restarted for the changes to take effect. For proxies, this option can be configured at runtime and it must be specified in the application configuration objects.
When set to true, this option implements the following behavior in selecting ports for connections of Configuration Server Proxies to the master Configuration Server, including the connections of backup instances of both master and proxy to their primary peers:
- When a Configuration Server Proxy loses connection to the primary master Configuration Server, to reconnect to the primary backup instance, the proxy will consistently use the port with the same port ID that was used for its initial connection to the primary (specified in the command line). If the port with the same ID is not configured, the default port will be used. If a port with the ID default is not configured, any available port will be used.
- The backup instances of Configuration Servers, both master and proxy, will consistently use the ports marked as HA Sync to connect to their primary peers. If HA Sync port is not available, the default port will be used. If a port with the ID default is not configured, any available port will be used.
This option applies to the configurations where Configuration Server instances have multiple listening ports. If set to false (the default), this feature is disabled.
ldap-negative-cache-time
Section: authentication
Default Value: 0
Valid Values: 0 to 65536
Changes Take Effect: Immediately
Specifies the time interval, in seconds, during which Configuration Server caches the username and password after unsuccessful authentication of a user. When a user enters incorrect login credentials multiple times, Configuration Server caches only the last invalid password entered for the LDAP user account.
The cache is reset after the time specified by this option elapses. Also, the cache is reset when the Person object is changed or when any option is changed in the authentication or gauth_ldap section of the Configuration Server object.
When set to 0 (the default), this feature is disabled.
ldap-cache-time
Section: authentication
Default Value: 0
Valid Values: 0 to 65536
Changes Take Effect: Immediately
Specifies the time interval, in seconds, during which Configuration Server caches the LDAP username and password after successful authentication of a user.
The cache is reset after the time specified by this option elapses. Also, the cache is reset when the Person object is changed or when any option is changed in the authentication or gauth_ldap section of the Configuration Server object.
When set to 0 (the default), this feature is disabled.
x-stat-print-segment
Section: log
Default Value: 100 MB
Valid Values:
- false—No segmentation is allowed.
- <number> KB or <number>—Sets the maximum segment size, in kilobytes. The minimum segment size is 100 KB.
- <number>—MB Sets the maximum segment size, in megabytes.
- <number> hr—Sets the number of hours for the segment to stay open. The minimum number is 1 hour.
Changes Take Effect: Immediately
Specifies whether there is a segmentation limit for the statistics log file. If there is, sets the mode of measurement, along with the maximum size. If the current statistics log segment exceeds the size set by this option, the file is closed and a new one is created. This option is ignored if log output is not configured to be sent to a statistics log file.
force_host
Section: dbserver
Default Value: 0
Valid Values: 1, 0, false, true, on, off, yes, no, y, n
Changes Take Effect: After restart
When set to 1, specifies that DB Server connects to the dbclient through a host network that is configured in the host option in the [dbserver] section.
When set to 0 (the default), the connection is established through the local host.
Enabling New Functionality
As a rule, newer versions of Framework components by default behave in the same way and rely on the same configuration as prior versions they are replacing. This allows you to use components as drop-in replacements and continue using the software in the same way that you are used to. In some cases, when you want to activate a particular new feature or behavior, you must add or change configuration options after you have installed a new release. A list of changes in configuration options is provided in New and Changed Configuration Options by Release.
Some versions may introduce changes that require you to take action before you can launch the new component after upgrading it in the existing environment. A list of mandatory configuration changes that has to be made when upgrading certain components is provided in Mandatory Changes in Configuration of Framework Components.
New and Changed Configuration Options by Release
The tables in this section document all configuration option changes in specific Framework server components from release 7.6 through 8.5, with the most recent changes listed first. The changes are listed by component.
Configuration option reference material is currently transitioning to the Genesys Documentation wiki. The tables on this page might contain option names with links to the new wiki format. For all other Framework options, refer to the Framework Configuration Options Reference Manual for detailed descriptions, with the following exceptions:
- Configuration options for the Configuration Conversion Wizard are described in detail in CCW Configuration Options.
- Configuration options related to external authentication are described in detail in the Framework External Authentication Reference Manual.
General Configuration Option Changes
The following table lists all changes in common configuration options (that is, those that are supported by all Genesys server applications), from release 7.6 through 8.5, with the most recent changes listed first.
All Genesys server applications support the unified set of log options (called common log options) in addition to application-specific log options. The common log options are configured for each application in the following sections: log, log-extended, log-filter, and log-filter-data.
All Genesys Server applications also support a set of common options for operations that are not related to logs.
| Option | Configuration Section | Type of Change | Changed in Release | Additional Information |
|---|---|---|---|---|
| compatible-output-priority | log | Removed | 8.5 | |
| enable-thread | log | New | 8.5 | |
| expire | log | Modified | 8.5 | |
| message-format | log | Renamed | 8.5 | Formerly named message_format |
| no-memory-mapping | log | New | 8.5 | |
| segment | log | Modified | 8.5 | |
| snapshot | log | New | 8.5 | |
| throttle-period | log | New | 8.5 | |
| throttle-threshold | log | New | 8.5 | |
| hide-tlib-sensitive-data | log-filter | New | 8.5 | |
| sec-protocol | security | New | 8.5 | |
| tls-mutual | security | New | 8.5 | |
| autostart | sml | New | 8.5 | |
| n/a | dbserver | Removed | 8.5 | Section removed |
| dml_retry | dbserver | Moved | 8.5 | Moved to Configuration Server |
| sec-protocol | Transport Parameters | New | 8.5 | |
| enable-async-dns | common | Modified | 8.1 | |
| cipher-list | security | New | 8.1 | |
| tls-crl | security | New | 8.1 | |
| tls-target-name-check | security | New | 8.1 | |
| n/a | security-authentication-rules | New | 8.1 | New section |
| account-override-lockout | security-authentication-rules | New | 8.1 | |
| last-expired-at | security-authentication-rules | New | 8.1 | Read-only |
| last-locked-at | security-authentication-rules | New | 8.1 | Read-only |
| no-change-password-at-first-login | security-authentication-rules | New | 8.1 | |
| override-account-expiration | security-authentication-rules | New | 8.1 | |
| heartbeat-period | sml | Modified | 8.1 | |
| default-filter-type | log-filter | Modified | 8.1 | |
| filtering | log-filter | New | 8.1 | |
| <key-name> | log-filter-data | Modified | 8.1 | |
| dml-retry | dbserver | New | 8.1 | |
| enable-ipv6 | common | New | 8.1 | |
| cipher-list | Transport Parameters | New | 8.1 | |
| ip-version | Transport Parameters | New | 8.1 | |
| expire | log | Modified | 8.0 | |
| default-filter-type | log-filter | Modified | 8.0 | |
| <key-name> | log-filter-data | Modified | 8.0 | |
| n/a | security | New | 8.0 | New section |
| disable-rbac | security | New | 8.0 | |
| heartbeat-period | sml | New | 8.0 | |
| heartbeat-period-threadclass-<n> | sml | New | 8.0 | |
| hangup-restart | sml | New | 8.0 | |
| suspending-wait-timeout | sml | New | 8.0 | |
| alarm | log | Moved | 7.6 | Moved from Solution Control Server. |
| x-conn-debug-open | log | New | 7.6 | Use only when requested by Genesys Customer Care. |
| x-conn-debug-select | log | New | 7.6 | |
| x-conn-debug-timers | log | New | 7.6 | |
| x-conn-debug-write | log | New | 7.6 | |
| x-conn-debug-security | log | New | 7.6 | |
| x-conn-debug-api | log | New | 7.6 | |
| x-conn-debug-dns | log | New | 7.6 | |
| x-conn-debug-all | log | New | 7.6 | |
| n/a | common | New | 7.6 | New section |
| rebind-delay | common | New | 7.6 | Use only when requested by Genesys Customer Care. |
| enable-async-dns | common | New | 7.6 | Use only when requested by Genesys Customer Care.
Use only with T-Servers. |
| n/a | extended-log | New | 7.6 | New section |
| level-reassign-<eventID> | extended-log | New | 7.6 | |
| level-reassign-disable | extended-log | New | 7.6 | |
| address | Transport Parameters | New | 7.6 | |
| backup-port | Transport Parameters | New | 7.6 | |
| port | Transport Parameters | New | 7.6 |
DB Server
The following table lists all configuration option changes in DB Server from release 7.6 through 9.0, with the most recent changes listed first.
| Option | Configuration Section | Type of Change | Changed in Release | Additional Information |
|---|---|---|---|---|
| force_host | dbserver | New | 8.5.100.02 | |
| db-request-timeout | dbserver | New | 8.0 | |
| dbprocess_name | dbserver | Modified | 8.0 | |
| db2_name | dbserver | Modified | 8.0 | |
| informix_name | dbserver | Modified | 8.0 | |
| msql_name | dbserver | Modified | 8.0 | |
| oracle_name | dbserver | Modified | 8.0 | |
| postgre_name | dbserver | New | 8.0 | |
| sybase_name | dbserver | Modified | 8.0 |
Database Access Point
The following table lists all configuration option changes in Database Access Point from release 7.6 through 8.5, with the most recent changes listed first.
| Option | Configuration Section | Type of Change | Changed in Release | Additional Information |
|---|---|---|---|---|
| mssql-multisubnet | default | New | 8.5.1 | Set in Annex; for Log Database only |
| utf8-ucs2 | dbclient | New | 8.1 | |
| db-request-timeout | dbserver | New | 8.0 |
Configuration Server
The following table documents all configuration option changes in Configuration Server from release 7.6 through 9.0, with the most recent changes listed first. These options apply to Configuration Server operating in Master mode. Refer to Configuration Server Proxy for configuration option changes in Configuration Server 8.5 running in Proxy mode (also referred to as Configuration Server Proxy).
| Option | Configuration Section | Type of Change | Changed in Release | Additional Information |
|---|---|---|---|---|
| override-shortcut-add-restriction | security-authentication-rules | New | 8.5.101.50 | |
| shortcut-add-restriction-count | security-authentication-rules | New | 8.5.101.50 | |
| override-shortcut-remove-restriction | security-authentication-rules | New | 8.5.101.42 | |
| shortcut-remove-restriction-count | security-authentication-rules | New | 8.5.101.42 | |
| x-stat-print-segment | log | New | 8.5.101.42 | |
| ldap-cache-time | authentication | New | 8.5.101.41 | |
| ldap-negative-cache-time | authentication | New | 8.5.101.41 | |
| consistent-port-selection | Configuration Server | New | 8.5.101.38 | |
| delay-reload | Configuration Server | New | 8.5.101.38 | |
| delay-reload-backup | Configuration Server | New | 8.5.101.38 | |
| x-stat-print-interval | Configuration Server | New | 8.5.101.38 | |
| backupmode-restart | Configuration Server | New | 8.5.101.33 | |
| primary-master-response-timeout | Configuration Server | New | 8.5.101.28 | |
| audit-expiration | history-log | New | 8.5.101.24 | |
| audit-max-records | history-log | New | 8.5.101.24 | |
| enable-upn | authentication | New | 8.5.101.24 | |
| mssql-multisubnet | <Configuration Database section> | New | 8.5.101.22 | |
| deferred-requests-expiration | system | New | 8.5 | |
| proxy-load-max | system | New | 8.5 | |
| proxy-load-timeout | system | New | 8.5 | |
| serialize-write-transactions | system | New | 8.5 | |
| skip-annex-validation | system | New | 8.5 | |
| throttle-updates-interval | system | New | 8.5 | |
| cfglib-connect-tmout | Configuration Server | New | 8.5 | Replaces cfglib-conn-async-tmout |
| token-tolerance | system | New | 8.5 | |
| token-ttl | system | New | 8.5 | |
| dbserv-conn-async-tmout | Configuration Server | New | 8.5 | |
| langid | Configuration Database | Modified | 8.5 | Added language codes |
| enforce-internal-auth | authentication | New | 8.5 | |
| allow-empty-password | Configuration Server | Modified | 8.5 | Corrected when Changes Take Effect |
| allow-external-empty-password | Configuration Server | Modified | 8.5 | Corrected when Changes Take Effect |
| cfglib-conn-async-tmout | Configuration Server | New/Removed | 8.5 | Replaced by cfglib-connnect-tmout |
| client-connect-timeout | Configuration Server | New | 8.5 | |
| client-response-timeout | Configuration Server | Modified | 8.5 | |
| dbthread | Configuration Server | New | 8.5 | |
| decryption-key | Configuration Server | New | 8.5 | |
| encryption | Configuration Server | Modified | 8.5 | |
| force-offline | Configuration Server | New | 8.5 | |
| force-connect-reload | Configuration Server | Moved | 8.5 | Moved to system section |
| langid | Configuration Server | New | 8.5 | |
| license | Configuration Server | Removed | 8.5 | |
| max-client-output-queue-size | Configuration Server | New | 8.5 | |
| max-output-queue-size | Configuration Server | New | 8.5 | |
| packet-size | Configuration Server | New | 8.5 | |
| primary-startup-tmout | Configuration Server | New | 8.5 | |
| upgrade-mode | Configuration Server | New | 8.5 | |
| addp | Configuration Database | Removed | 8.5 | |
| addp-timeout | Configuration Database | Removed | 8.5 | |
| addp-trace | Configuration Database | Removed | 8.5 | |
| dbengine | Configuration Database | Modified | 8.5 | |
| dbname | Configuration Database | Added new Valid Value | 8.5 | |
| dbserver | Configuration Database | Added new Valid Value | 8.5 | |
| dml-retry | Configuration Database | Moved | 8.5 | Moved from Common Configuration Options |
| history-log-guid | Configuration Database | Removed | 8.5 | |
| history-log-version | Configuration Database | Removed | 8.5 | |
| host | Configuration Database | Removed | 8.5 | Used only if dbthread=false and with DB Server 8.1; refer to Framework 8.1 documentation. |
| port | Configuration Database | Removed | 8.5 | |
| reconnect-timeout | Configuration Database | Removed | 8.5 | |
| server | Configuration Database | Removed | 8.5 | |
| ignore-case-username | gauth-kerberos | New | 8.5 | |
| n/a | hca | Removed | 8.5 | Section removed |
| schema | hca | Removed | 8.5 | |
| x-dblib-debug | log | New | 8.5 | Use only when requested by Genesys Customer Care. |
| x-dblib-sql | log | New | 8.5 | |
| objbrief-api-permission-check | security | New | 8.5 | |
| n/a | soap | Removed | 8.5 | Section removed |
| client-lifespan | soap | Removed | 8.5 | |
| debug | soap | Removed | 8.5 | |
| port | soap | Removed | 8.5 | Used only if dbthread=false and with DB Server 8.1; refer to Framework 8.1 documentation. |
| n/a | system | New | 8.5 | New section |
| force-connect-reload | system | Moved | 8.5 | Moved from Configuration Server section. |
| postgre-standard-conforming-strings | system | Removed | 8.5 | |
| prevent-mediatype-attr-removal | system | New | 8.5 | |
| token-authentication-mode | system | New | 8.5 | |
| token-preambula | system | New | 8.5 | |
| token-uuid | system | New | 8.5 | |
| skip-environment-enum-transfer | system | New | 8.5 | |
| write-former-value | history-log | New | 8.5 | |
| user | Application Parameters | New | 8.5 | |
| reconnect-timeout | Configuration Database | Modified | 8.1 | |
| allow-mixed-encoding | confserv | New | 8.1 | |
| enable-pre-812-security | confserv | New | 8.1 | |
| force-md5 | confserv | New | 8.1 | |
| multi-languages | confserv | New | 8.1 | |
| password-change | confserv | New | 8.1 | |
| packet-size | confserv | New | 8.1 | |
| peer-switchover-tmout | confserv | New | 8.1 | |
| chase-referrals | gauth_ldap[_n] | New | 8.1 | |
| objbrief-api-permission-check | security | New | 8.1 | Added to version 8.1.300.27 |
| port | soap | Modified | 8.1 | |
| all | history-log-section | Modified | 8.0 | Does not apply to master Configuration Server.
Not documented in previous versions of this document. |
| failsafe-store-processing | history-log-section | Modified | 8.0 | |
| protocol | confserv/<application> | New | 8.0 | |
| addp-timeout | confserv/<application> | New | 8.0 | Same name as existing options, but placed in different configuration section. |
| addp-remote-timeout | confserv/<application> | New | 8.0 | |
| addp-trace | confserv/<application> | New | 8.0 | |
| fix_cs_version_7x | confserv | New | 8.0 | |
| allow-external-empty-password | confserv | New | 8.0 | |
| last-login | confserv | New | 8.0 | |
| last-login-synchronize | confserv | New | 8.0 | |
| objects-cache | confserv | New | 8.0 | |
| disable-vag-calculation | <application> | New | 7.6 | |
| all | history-log | Modified | 7.6 | |
| history-log-file-name c | confserv | Obsolete | 7.6 | Replaced by options in history-log section. |
| history-log-expiration | confserv | Obsolete | 7.6 | |
| history-log-client-expiration | confserv | Obsolete | 7.6 | |
| history-log-max-records | confserv | Obsolete | 7.6 | |
| history-log-active | confserv | Obsolete | 7.6 | |
| no-default-access | security | New | 7.6 | |
| all | history-log | New | 7.6 | |
| expiration | history-log | New | 7.6 | |
| client-expiration | history-log | New | 7.6 | |
| max-records | history-log | New | 7.6 | |
| active | history-log | New | 7.6 | |
| failsafe-store-processing | history-log | New | 7.6 | |
| backlog | Application Parameter | New | 7.6 | Use only when requested by Genesys Customer Care. |
Configuration Server Proxy
The following table documents all configuration option changes in Configuration Server running in Proxy mode (also referred to as Configuration Server Proxy) mode from release 7.6 through 8.5, with the most recent changes listed first.
| Option | Configuration Section | Type of Change | Changed in Release | Additional Information |
|---|---|---|---|---|
| -cs-persistent-failover-tmout | csproxy | New | 9.0 | |
| -proxy-persistent-mode | csproxy | New | 9.0 | |
| db-persistent-failover-tmout | Configuration Database | New | 9.0 | |
| force-vag-calculation | csproxy | New | 9.0 | |
| delay-reload | csproxy | New | 9.0 | |
| delay-reload-backup | csproxy | New | 9.0 | |
| cfglib-connect-tmout | csproxy | New | 8.5 | |
| token-tolerance | system | New | 8.5 | New section |
| token-ttl | system | New | 8.5 | New section |
| enforce-internal-auth | authentication | New | 8.5 | |
| allow-empty-password | csproxy | New | 8.5 | |
| allow-external-empty-password | csproxy | New | 8.5 | |
| management-port | csproxy | New | 8.5 | |
| proxy-cluster-name | csproxy | New | 8.5 | |
| client-response-timeout | csproxy | Modified | 8.5 | |
| max-client-output-queue-size | csproxy | New | 8.5 | |
| max-output-queue-size | csproxy | New | 8.5 | |
| packet-size | csproxy | New | 8.5 | |
| proxy-cluster-name | csproxy | New | 8.5 | |
| ignore-case-username | gauth-kerberos | New | 8.5 | |
| active | history-log | Removed | 8.5 | |
| all | history-log | Removed | 8.5 | |
| expiration | history-log | Removed | 8.5 | |
| failsafe-store-processing | history-log | Removed | 8.5 | |
| max-records | history-log | Removed | 8.5 | |
| n/a | soap | Removed | 8.5 | Section removed |
| client-lifespan | soap | Removed | 8.5 | |
| debug | soap | Removed | 8.5 | |
| max-records | soap | Removed | 8.5 | |
| user | Application Parameters | New | 8.5 | |
| n/a | authentication | New | 8.1 | New section |
| library | authentication | New | 8.1 | |
| enforce-external-auth | authentication | New | 8.1 | |
| allow-mixed-encoding | csproxy | New | 8.1 | |
| client-response-timeout | csproxy | New | 8.1 | |
| packet-size | csproxy | New | 8.1 | |
| n/a | gauth_ldap | New | 8.1 | New section |
| ldap_url | gauth_ldap | New | 8.1 | |
| verbose | gauth_ldap | New | 8.1 | |
| retry_attempts | gauth_ldap | New | 8.1 | |
| retry_interval | gauth_ldap | New | 8.1 | |
| proxy-writable | csproxy | Modified | 8.0 | |
| last-login | csproxy | New | 8.0 | |
| last-login-synchronize | csproxy | New | 8.0 | |
| objects-cache | csproxy | New | 8.0 | |
| proxy-writable | csproxy | New | 7.6 | |
| expiration | history-log | Modified | 7.6 | |
| client-expiration | history-log | Modified | 7.6 | |
| max-records | history-log | Modified | 7.6 | |
| failsafe-store-processing | history-log | New | 7.6 | |
| all | history-log | Modified | 7.6 | |
| backlog | Application Parameter | New | 7.6 | Use only when requested by Genesys Customer Care. |
Steps to roll out the solution based on proxy-side VAG processing
- Proxies, which you plan to use for VAG calculation should be upgraded to the version that supports the feature. Upgrade of the master Configuration Server and other proxies is not mandatory.
- Set [cs_main_section]\disable-vag-calculation=true for both primary and backup instances of the master Configuration Server in their .conf/.cfg files. Set [csproxy]\force-vag-calculation=true for both primary and backup instances of the proxies, you plan to use as VAG-processing, in their Application configuration objects. No changes in the configuration of the regular proxies are needed.
- Perform the restart of both instances of the master Configuration Server. Switchover is not enough: both primary and backup should be stopped concurrently first, then started again. Restart of the proxies is not required. Proxies, configured with force-vag-calculation=true, once reconnected to restated master with disable-vag-calculation=true, will automatically enable VAG calculation on their side. The remaining proxies after reconnect and data reload will see the content of VAGs as empty.
- Reconfigure the clients you planned to use with VAG-processing proxies, so they connect to these proxies. Then restart them to connect to these proxies. Whether hard restart of the client HA pairs is needed depends on specific client. However, hard restart is always the safe choice.
- To double-check the configuration, connect GA or CM to both master and VAG-processing prox(ies) to verify that VAGs on the master have no members, while VAGs on the VAG-processing prox(ies) have their member lists calculated as expected according to the VAG scripts.
Configuration Manager
The following table documents all configuration option changes in Configuration Manager from release 7.6 through 8.1, with the most recent changes listed first.
This table does not include configuration options for Genesys Administrator, which might have been set in the Configuration Manager Application object with which Genesys Administrator is bound, or associated, during its deployment.
| Option | Configuration Section | Type of Change | Changed in Release | Additional Information |
|---|---|---|---|---|
| inactivity-timeout | security | New | 7.6 |
Local Control Agent
Local Control Agents supports common log options which allows you to precisely configure log output for LCA. Because you do not configure an Application object for LCA, if you need to change the default log option settings, modify the configuration file called lca.cfg and specify new values for appropriate options. The file must be located in the same directory as the Local Control Agent executable file.
The following table documents all other configuration option changes in Local Control Agent from release 7.6 through 8.5, with the most recent changes listed first. For more information about the LCA configuration file and for related instructions, see the Framework Deployment Guide.
| Option | Configuration Section | Type of Change | Changed in Release | Additional Information |
|---|---|---|---|---|
| wmiquery-timeout | general | New | 8.5 | |
| lookup_clienthost | general | New | 8.1 | |
| upgrade | security | Correction | 8.1 | Originally documented as Host option |
Genesys Deployment Agent
Starting in release 8.0, the Genesys Deployment Agent is deployed with LCA. The Genesys Deployment Agent is used by of Genesys Administrator Extension to deploy Genesys Applications and Solutions on a Host. To enable this functionality, you must identify what port on the Host that the Genesys Deployment Agent will use to communicate with Genesys Administrator Extension. You provide this information in the Host’s Annex, in the new section rdm, specifying the port number with the configuration option port.
Genesys Deployment Agent supports common log options which allows you to precisely configure log output for Genesys Deployment Agent. Because you do not configure an Application object for Genesys Deployment Agent, if you need to change the default log option settings, create a configuration file called gda.cfg (or rename and modify the gda.cfg.sample file that is located in the installation folder) and specify new values for appropriate options. The file must be located in the same directory as the Genesys Deployment Agent executable file (gda.exe).
The following table lists all other configuration option changes in Genesys Deployment Agent from release 8.0 through 8.5, with the most recent changes listed first. For more information about the Genesys Deployment Agent, refer to the Framework Deployment Guide.
| Option | Configuration Section | Type of Change | Changed in Release | Additional Information |
|---|---|---|---|---|
| n/a | security | New | 8.1 | New section |
| transport | security | New | 8.1 | |
| n/a | web | New | 8.0 | New section |
| rootdir | web | New | 8.0 |
Message Server
The following table lists configuration option changes in Message Server from release 7.6 through 8.5, with the most recent changes listed first.
| Option | Configuration Section | Type of Change | Changed in Release | Additional Information |
|---|---|---|---|---|
| dbthread | messages | New | 8.5 | |
| x-dblib-debug | log | New | 8.5 | |
| signature | MessageServer | New | 8.0 | |
| request-queue-size | messages | Removed | 8.0 |
Solution Control Server
The following table lists configuration option changes in Solution Control Server from release 7.6 through 8.5, with the most recent changes listed first.
| Option | Configuration Section | Type of Change | Changed in Release | Additional Information |
|---|---|---|---|---|
| haflip-detect-timeout | log | New | 8.5.100.31 | |
| cfglib-connect-tmout | general | New | 8.5 | |
| default-audit-username | general | New | 8.5 | |
| disable-switchover | general | New | 8.5 | |
| distributed_sync_timeout | general | New | 8.5 | |
| hostinfo-load-timeout | general | New | 8.5 | |
| max_switchover_time | general | Removed | 8.5 | |
| ha_service_unavail_primary | general | New | 8.1 | |
| lookup_clienthost | general | New | 8.1 | |
| max-req-per-loop | general | New | 8.1 | |
| alarms-port | Transport Parameter | New | 8.1 | |
| backup-alarms-port | Transport Parameter | New | 8.1 | |
| alarm | log | Moved | 7.6 | Moved to common configuration options. |
Solution Control Interface
The following table lists configuration option changes in Solution Control Interface from release 7.6 through 8.0, with the most recent changes listed first.
| Option | Configuration Section | Type of Change | Changed in Release | Additional Information |
|---|---|---|---|---|
| n/a | host-status-display | New | 8.0 | New section |
| critical-color | host-status-display | New | 8.0 | |
| major-color | host-status-display | New | 8.0 | |
| other-color | host-status-display | New | 8.0 | |
| inactivity-timeout | security | New | 7.6 |
SNMP Master Agent
The following table lists configuration option changes in Genesys SNMP Master Agent from release 7.6 through 9.0, and in SNMP Master Agent in 8.5, with the most recent changes listed first.
Note: Starting in release 8.5, you can use a 3rd-party Net-SNMP Master Agent instead of Genesys SNMP Master Agent, re-using the same configuration object. Refer to the Framework Deployment Guide for more information about Net-SNMP and Genesys SNMP Master Agent. See the instructions in Migrating to Net-SNMP to convert a Genesys SNMP Master Agent Application object to use with Net-SNMP.
| Option | Configuration Section | Type of Change | Changed in Release | Additional Information |
|---|---|---|---|---|
| force_host_network | agentx | New | 9.0 | |
| netsnmp-enable | snmp | New | 8.5 | |
| n/a | snmp-v3-auth | New | 8.1 | New section |
| password | snmp-v3-auth | New | 8.1 | |
| n/a | snmp-v3-priv | New | 8.1 | New section |
| password | snmp-v3-priv | New | 8.1 | |
| v3priv_protocol | snmp | Modified | 8.0 |
Tenant
The following table lists Tenant- and User-level configuration option changes from release 7.6 through 9.0, with the most recent changes listed first.
| Option | Configuration Section | Type of Change | Changed in Release | Additional Information |
|---|---|---|---|---|
| object-deletion-rate | security-authentication-rules | New | 9.0 | |
| object-deletion-rate-interval | security-authentication-rules | New | 9.0 | |
| override-object-deletion-rate | security-authentication-rules | New | 9.0 | |
| shortcut-remove-restriction-count | security-authentication-rules | New | 9.0 | |
| override-shortcut-remove-restriction | security-authentication-rules | New | 9.0 | |
| account-lockout-mode | security-authentication-rules | New | 9.0 | |
| password-no-repeats | security-authentication-rules | Modified | 9.0 | Changed the maximum supported value to 30. |
| account-override-lockout | security-authentication-rules | Modified | 8.5 | User-level option
Corrected description of when set to false |
| force-password-reset | security-authentication-rules | New | 8.1 | |
| max-account-sessions | security-authentication-rules | New | 8.1 | |
| password-expiration | security-authentication-rules | New | 8.1 | |
| password-expiration-notify | security-authentication-rules | New | 8.1 | |
| password-no-repeats | security-authentication-rules | New | 8.1 | |
| password-req-punctuation | security-authentication-rules | New | 8.1 | |
| tenant-override-section | security-authentication-rules | New | 8.1 | |
| password-req-number | security-authentication-rules | New | 8.0 | Not documented in previous releases of this document. |
| password-req-mixed-case | security-authentication-rules | New | 8.0 | |
| password-req-alpha | security-authentication-rules | New | 8.0 | |
| account-lockout-threshold | security-authentication-rules | New | 8.0 | |
| account-lockout-duration | security-authentication-rules | New | 8.0 | |
| account-lockout-attempts-period | security-authentication-rules | New | 8.0 | |
| password-min-length | security-authentication-rules | New | 8.0 |
Host
The following table lists Host-level configuration option changes from release 7.6 through 8.5, with the most recent changes listed first.
| Option | Configuration Section | Type of Change | Changed in Release | Additional Information |
|---|---|---|---|---|
| addp-trace | addp | New | 8.5 | Not documented in previous releases of this document. |
| sec-protocol | security | New | 8.5 | |
| n/a | ntp-service-control | New | 8.1 | New section |
| signature | ntp-service-control | New | 8.1 | |
| cipher-list | security | New | 8.1 | |
| lca-upgrade | security | New | 8.1 | |
| n/a | transport | New | 8.1 | New section |
| ip-version | transport | New | 8.1 | |
| n/a | rdm | New | 8.0 | New section |
| port | rdm | New | 8.0 | Not documented in previous releases of this document. |
| n/a | security | New | 8.0 | New section |
| gda-tls | security | New | 8.0 | Not documented in previous releases of this document. |
| n/a | addp | New | 7.6 | New section |
| addp-remote-timeout | addp | New | 7.6 | Not documented in previous releases of this document. |
| addp-timeout | addp | New | 7.6 |
Mandatory Changes in Configuration of Framework Components
When upgrading Configuration Server to release 8.5, you must modify the existing configuration file to include the [<name of conf server app>]dbthread=false option to continue using your existing DB Server. Alternatively, consider installing and configuring DBMS client software on the same host where the Configuration Server instance resides (to make it available to Configuration Server) and set connection parameters in the configuration file to access the DBMS from that host (see the Framework Deployment Guide for details). In this case, you no longer need a separate DB Server for Configuration Server to access the database.
When updating the Configuration Database schema version to 8.5, and newer, in an environment where Configuration Server 8.5 is already being used (against a database schema of a prior version), you have to specify the [<name of config server app>]langid option. Set this option to 1033 when upgrading an English environment. See Localized Environments for details on how to set the option for other languages.
When upgrading Configuration Server from release 8.0 or older in environment where Configuration Server Proxies are being deployed, make sure you set the force-md5 option to true on the master Configuration Server until you have completed upgrading all Configuration Server Proxies in your environment to the latest version.
Mandatory Changes in Secure Protocol Configuration
When you upgrade your Genesys applications that are configured to communicate securely using Genesys Security Pack on UNIX (or Linux), versions 8.5.1 or later, or you upgrade your Windows operating system to the latest version or Service pack, make sure you are using certificates that are signed using SHA1 or higher across all server applications with which new or updated components have to communicate. If you have previously generated MD5 signed certificates using tools provided with Genesys Security Pack, re-issue them as soon as possible using Security Pack 8.5.1 or later. MD5 certificates are no longer accepted by the latest secure protocol implemenations.