Revision as of 05:48, January 17, 2020 by Lpotturi (talk | contribs)
Jump to: navigation, search

Configuration Server Section

This section contains the configuration options of Configuration Server. The name of the section depends on the name of the Configuration Server Application object. On the first Configuration Server (named confserv), this section is named confserv. On other Configuration Servers being installed, this section has the same name as the Configuration Server object.

allow-empty-password

Default Value: true
Valid Values: true, false
Changes Take Effect: Immediately

Specifies whether Configuration Server allows an empty (blank) password in a client connection request. If the option is set to false and the password in a request is not specified, Configuration Server rejects the request and generates a corresponding error message.

Important
The Tenant option password-min-length overrides the value of allow-empty-password for all users in the Tenant in which the latter option is configured.
Genesys strongly recommends that you use password-min-length instead of allow-empty-password. The latter has been provided only for purposes of backward compatibility.

Refer to the User Passwords section of the Genesys Security Deployment Guide for more information about this option and how to use it.

allow-external-empty-password

Default Value: true
Valid Values: true, false
Changes Take Effect: Immediately

This option is used only if external authentication is being used.

Specifies whether Configuration Server allows an empty (blank) password in a client connection request when these requests are authenticated externally. When set to true (default), Configuration Server will permit an unspecified password in an externally authenticated request.

Important
There might be instances where an LDAP server, instead of rejecting a blank password, might (depending on the LDAP Server configuration) interpret this to mean that it should make an unauthenticated connection, giving the false impression that authentication has succeeded. To allow empty passwords in Configuration Server and still avoid this, set the allow-external-empty-password option to false so that configuration will enforce at least one character in a password sent to an external system.

If the option is set to false and the password in a request is not specified, Configuration Server rejects the request and generates a corresponding error message, regardless of the value of the two other options.

Refer to the User Passwords section of the Genesys Security Deployment Guide for more information about this option and how to use it.

allow-mixed-encoding

Default Value: false
Valid Values: true, false
Changes Take Effect: After restart

Specifies if Configuration Server checks if the encoding of user interface client applications at client registration matches the current encoding of Configuration Server. If set to false (the default), only those interface clients with the same encoding mode can connect to Configuration Server. If set to true, Configuration Server will not check, and the interface client can connect to Configuration Server regardless of its encoding mode.

Important
Be very careful if you are setting this option to true. If a client sends any string data that is encoded differently than the encoding used by Configuration Server, the behavior of Configuration Server will be undefined.

cfglib-connect-tmout

Default Value: 20 Valid Values: Any integer from 0 to 65536 seconds
Changes Take Effect: After restart

Sets a timeout (in seconds) for this instance of Configuration Server to expect a TCP success or failure response from the remote Configuration Server to which it is connecting. If the connection has not been made when the timeout expires, all pending connection requests are cancelled.

When set to 0 (zero), this timeout is disabled.

The value of this parameter overrides that of the -cfglib-connect-tmout command-line parameter.

client-connect-timeout

Default Value: 40
Valid Values: Any positive integer from 1 to 65536
Changes Take Effect: After restart

Specifies the client connection timeout. The client should be authenticated before this timeout expires.

client-response-timeout

Default Value: 600 Valid Values: Positive integer up to 86400 (24 hours)
Changes Take Effect: Immediately

Limits the time, in seconds, during which Configuration Server retains prepared unsent data in its memory. If this timeout expires and the data is still unsent, Configuration Server disconnects the client and discards all the data related to it.

dbthread

Default Value: true
Valid Values: true, false

true Uses internal database thread. This is the preferred method.
false Uses separate DB Server, as in releases prior to 8.5.

Changes Take Effect: After restart

Specifies how Configuration Server accesses the Configuration Database.

If set to true, Configuration Server attempts to launch a database client process locally using the options specified in the Configuration Database section, but not the host and port options. This is the preferred method of accessing a database.

If set to false, Configuration Server attempts to use a remote DB Server, as specified in the Configuration Database section, including the host and port options. This was the only way to access a database in releases prior to 8.5. Genesys recommends that you use this method only with older Genesys applications.

decryption-key

Default Value: No default value
Valid Values: Valid path to decryption file
Changes Take Effect: After restart

Specifies the path to an external .pem file containing the RSA key used for decrypting the password to the Configuration Database. The presence of this option, plus encryption set to true, indicates that the password was encoded using an asymmetric algorithm, with an encryption key from an external file.

Configuration Server creates or updates the value of this option if the -keys parameter is specified in the command-line at startup.

Important
  • This option is set automatically by Configuration Server. Do not change the value of this option manually, except in the following circumstance.
  • If you want to switch back to using an unencrypted Configuration password, set the value of this option to empty (no value) and set the encryption option to false, then manually enter the unencrypted password into the Configuration Server configuration file. Note: You must have Write access to the Configuration Server configuration file to do this.
  • If you then want to revert back to using symmetric encryption, set the value of this option to empty (no value), and restart Configuration Server from the command line using the -p <name of Configuration Database section> <password> parameter.

delay-reload-backup

Default Value: 0
Valid Values: 0 or any positive integer
Changes Take Effect: For the next reconnect to the master

Specifies the reload delay period (in seconds) for the backup Configuration Server Proxies or the master Configuration Server running in the backup mode. 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 “proxy-load-max” option to further delay data reloading process for the proxies.

disable-vag-calculation

Default Value: false
Valid Values: true, false
Changes Take Effect: After restart

Specifies whether Configuration Server calculates Virtual Agent Groups for existing and newly-created objects for the application in which it is configured.

To manage the calculation of Virtual Agent Groups by primary and backup Configuration Servers before and after switchovers, add this option to both the primary and backup Configuration Servers, in the sections with the same name as the corresponding Application objects. If this option is set to true, Configuration Server does not calculate Virtual Agent Groups for existing and newly-created objects.

Important
You must set this option to the same value for both the primary and backup Configuration Servers. Then stop and restart both Configuration Servers. You must do this each time you change this option to retain the contents of the Virtual Agent Group.

enable-pre-812-security

Default Value: false
Valid Values: false, true
Changes Take Effect: Immediately

If set to true, this option restores pre-8.1.2 security behavior as follows:

  • Enables a user, who does not have Change permission on a folder, to move objects from that folder to another location.
  • Enables a user, who does not have Change Permissions permission on an object, to change the object’s permissions implicitly by moving the object with inherited permissions between folders with different permission.

If set to false (the default), both actions are disabled.

Important
To take effect, this option must be set to true in both the confserv section of the primary master Configuration Server, and in the corresponding main section of the backup master Configuration Server.
Warning
Use this option only in exceptional cases, and only as a temporary measure.

encoding

Default Value: UTF-8
Valid Values: UTF-8, UTF-16, ASCII, ISO-8859-1, ISO-8859-2, ISO-8859-3, ISO-8859-4, ISO-8859-5, ISO-8859-6, ISO-8859-7, ISO-8859-8, ISO-8859-9, ebcdic-cp-us, ibm1140, gb2312, Big5, koi8-r, Shift_JIS, euc-kr
Changes Take Effect: After restart

Sets the UCS (Universal Character Set) transformation format (such as UTF-8, UTF-16, Shift_JIS, and so on) that Configuration Server uses when exporting configuration data into an XML (Extensible Markup Language) file. The Configuration Import Wizard (CIW) must initiate the export operation. If the operating system settings do not support the specified value, Configuration Server uses the default value.

Specify the UTF-8 encoding format unless you are using wide-character codesets (such as Chinese, Japanese, Korean).

Important
In single-language format on UNIX platforms, the value of this option must match the value defined by the LANG environment variable (or derived from the values of the LC_ALL and LC_CTYPE environment variables as specified in the vendor documentation). On the Solaris platform, you might be required to set the environment variable GCTI_TRANSLOCALCP to the value that represents the current local system encoding name (returned by the iconv -l command). You must set this Genesys-specific variable only if, in your environment, the value returned by the command does not match the codepage name specified in system locale settings (LANG, LC_ALL, or LC_CTYPE) on Solaris.

encryption

Default Value: false
Valid Values: true, false
Changes Take Effect: After restart

When set to true, the values of the password options in all Configuration Database sections are interpreted as being encrypted. Configuration Server decrypts the value when reading its configuration file at startup, accesses the Configuration Database using the decrypted value, and prints an encrypted string of characters as the password value into the log.

This option is set to true automatically by Configuration Server when the -p parameter is specified in the startup command line.

Important
  • This option is set automatically by Configuration Server. Do not change the value of this option manually, except in the following circumstance.
  • If you want to switch back to using an unencrypted Configuration password, set the value of this option to false and set the decryption-key option to empty (no value), then manually enter the unencrypted password into the Configuration Server configuration file. Note: You must have Write access to the Configuration Server configuration file to do this.

fix_cs_version_7x

Default Value: true
Valid Values: true, false
Changes Take Effect: After restart

Use this option when using a master Configuration Server running release 8.0.3 (or later) with a Configuration Server Proxy running release 8.1.1 (or earlier). Setting this option to true enables the master Configuration Server to treat Configuration Server Proxy as running an equivalent schema. This prevents Configuration Server Proxy from using an incorrect schema and reading configuration data incorrectly.

Important
If you are trying to run a Configuration Server Proxy release 8.1.1 (or earlier) with a Master Configuration Server 8.x, make sure that this option is set to true before setting up the connection between the two servers. Otherwise, the configuration schema of Configuration Server Proxy will be incorrect, and you will have to reinstall Configuration Server Proxy. However, note that Genesys strongly recommends that Configuration Server and Configuration Server proxy be running the same version of software. The only exception is during migration, in which case the servers can run different version but only until migration is complete.
Comments or questions about this documentation? Contact us for support!