Revision as of 14:59, June 8, 2018 by Pmcknigh (talk | contribs) (→‎Configuration Server)
Jump to: navigation, search

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.

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:

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.

[+] Show table

DB Server

The following table lists all configuration option changes in DB Server from release 7.6 through 8.1, with the most recent changes listed first.

Important
DB Server is not a part of Management Framework 8.5.

[+] Show table

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.

[+] Show table

Configuration Server

The following table documents all configuration option changes in Configuration Server from release 7.6 through 8.5, 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).

Important
In the following table, the Configuration Server section is referred to as confserv for changes in earlier releases.

[+] Show table

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.

[+] Show table

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.

Important
Configuration Manager was not updated in release 8.5.

[+] Show table

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.

[+] Show table

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).

Important
In release 8.5.1, Genesys Deployment Agent is not installed with Local Control Agent by default.

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.

[+] Show table

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.

[+] Show table

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.

[+] Show table

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.

Important
Solution Control Interface was not updated after release 8.0.

[+] Show table

SNMP Master Agent

The following table lists configuration option changes in Genesys SNMP Master Agent from release 7.6 through 8.1, 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.

[+] Show table

Tenant

The following table lists Tenant- and User-level configuration option changes from release 7.6 through 8.5, with the most recent changes listed first.

[+] Show table

Host

The following table lists Host-level configuration option changes from release 7.6 through 8.5, with the most recent changes listed first.

[+] Show table

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.

Comments or questions about this documentation? Contact us for support!