verbose
Section: db-direct-connection
Default Value: 0
Valid Values: 0 - 4
Changes Take Effect: After restart
This option controls the SQL statement and message sending debug information.
identity-in-login-table
Section: statserver
Default Value: off
Valid Values: on, off
Changes Take Effect: After restart
Turning this option on enables Stat Server to operate with an Oracle Real Application Clusters (RAC). This option requires a database access point connection to an Oracle RAC database. The user must also initialize their LOGIN table with the oracle/login_oracle.sql script that comes with the Stat Server installation.
enable
Section: db-direct-connection
Default Value: off
Valid Values: on, off
Changes Take Effect: After restart
This option enables direct database connection to the DBMS.
debug
Section: db-direct-connection
Default Value: 0
Valid Values: 0 - 5
Changes Take Effect: After restart
This option controls advanced debugging information such as function calls.
reconnect-timeout
Section: statserver
Default Value: 10
Valid Values: Positive integers less than or equal to 2147483; Stat Server sets any negative or 0 values that you might configure to 10.
Changes Take Effect: After restart
Modified: 8.5.104
Indicates the time interval, in seconds, between Stat Server attempts to reconnect to a T-Server or the database (DB Server if [db-direct-connection]/enable is set to no) if either is disconnected or not running.
This option was previously named reconnect_timeout (spelled with an underscore).
db-txn-max-retries
Section: statserver
Default Value: 3
Valid Values: Integers greater or equal to 1 and less than or equal to 10 retries
Changes Take Effect: After restart
This option controls how many times Stat Server re-sends a transaction to the database connection after a timeout has occurred, before it disconnects and reconnects to the database.
db-timeout
Section: statserver
Default Value: 30
Valid Values: Integers greater or equal to 10 and less than or equal to 3600 seconds
Changes Take Effect: After restart
This option controls how long Stat Server waits for a response from the database connection, before re-sending the current transaction.
accept-clients-in-backup-mode
Section: statserver
Default Value: yes
Valid Values: yes, no
Changes Take Effect: After restart
Modified: 8.5.1. New default value is yes
Specifies whether Stat Server accepts client connections when operating in backup mode.
With this option set to yes, Stat Server notifies the clients about its redundancy mode after a client's registration and after a change in mode. Moreover, when its redundancy mode is changed to backup, Stat Server does not close the communication port and accepts clients' connections and requests.
media-type
Section: statserver
Default Value: No default value
Valid Values: Any value, preconfigured within Configuration Server—in the Business Attributes/MediaType folder in Genesys Administrator
Changes Take Effect: Immediately upon notification
Modified: 8.5.102
Determine the media type of interactions that the virtual queue has been configured to handle. This option is set only for a Virtual Queue object. Only one media type should be configured for any given virtual queue. Starting with Stat Server release 8.5.102, voice is a valid value.
disconnect-from-lca-on-history-log-expired
Section: statserver
Default Value: false
Valid Values: true, false
Changes Take Effect: After restart
Introduced: 8.5.102
Controls whether Stat Server disconnects from LCA upon receiving the HistoryLogExpired event.
backup-file-aggregates-store
Section: statserver
Default Value: true
Valid Values: true, false
Changes Take Effect: Immediately upon notification
Dependencies: auto-backup-interval != 0
Introduced: 8.5.102
Controls whether the statistical aggregates are read from/written into the backup file.
interaction-wait-on-sa-media-list
Section: statserver
Default Value: "chat"
Valid Values: “Media 1, Media 2, …, Media N” or “All”
Changes Take Effect: After restart
Introduced: 8.5.103
Specifies the list of media type name(s) for which the InteractionWait (StagingAreas) action is generated.
interaction-wait-on-sa-max-number
Section: statserver
Default Value: 2147483647
Valid Values: Integers 0 through 2147483647
Changes Take Effect: After restart
Introduced: 8.5.103
Specifies the maximum allowed number of InteractionWait (StagingAreas) actions. When the threshold is reached, Stat Server does not create any more instances of the InteractionWait (StagingAreas) action, until the number of such actions falls back below the threshold.
If the debug-level option is set to Server, the following message is printed in the Stat Server log every minute while the threshold is reached:
"ATTN: InteractionWait actions threshold of (Max Number) reached”
suppress-user-data
Section: statserver
Default Value: undefined
Valid Values: yes or no when the option is defined
Changes Take Effect: Upon DN re-registration
Introduced: 8.5.104
If this option is not defined, there is no change to the existing Stat Server behavior. If the option is defined, its value overrides the value of the suppress-user-data option of Switch and/or DN objects. If the option is defined but the value is missing or wrong, then it is considered as defined no value.
reg-dns-chunk-delay
Section: statserver
Default Value: 10
Valid Values: Positive integers less than or equal to 2147483
Changes Take Effect: After restart
Modified: 8.5.104
Related Options: reg-dns-chunk-volume
Specifies the interval, in seconds, between two subsequent registration requests. Stat Server waits for the specified interval before sending a request to T-Server to register a subsequent set of DNs, thus allowing T-Server to process the previous request.
In a large configuration environment, use this option in conjunction with reg-dns-chunk-volume to optimize DN registration at Stat Server startup.
reg-delay
Section: statserver
Default Value: 0
Valid Values: 0 (zero) or positive integer less than or equal to 2147483
Changes Take Effect: After restart
Modified: 8.5.104
Causes Stat Server to wait the specified number of seconds before registering DNs that have been added to Configuration Server.
This option was previously named reg_delay (spelled with an underscore).
reconnect-timeout
Section: statserver
Default Value: 10
Valid Values: Positive integers less than or equal to 2147483; Stat Server sets any negative or 0 values that you might configure to 10.
Changes Take Effect: After restart
Modified: 8.5.104
Indicates the time interval, in seconds, between Stat Server attempts to reconnect to a T-Server or the database (DB Server if [db-direct-connection]/enable is set to no) if either is disconnected or not running.
This option was previously named reconnect_timeout (spelled with an underscore).
consult-acw-mode
Section: statserver
Default Value: always
Valid Values: always, last
Changes Take Effect: After restart
Introduced: 8.5.104
When a consult call is released on a regular DN and the after-call-work (ACW) is pending, Stat Server generates the AfterCallWork action only in the following cases:
- consult-acw-mode=always
- consult-acw-mode=last and there are no more calls on a DN
auto-backup-interval
Section: statserver
Default Value: 15
Valid Values: Integers 0 through 35791
Changes Take Effect: After restart
Modified: 8.5.104
Related Options: backup-file-name
Sets the time, in minutes, for checking persistent statistics and storing them in the file specified by the backup-file-name option. A value of 0 disables automated backups.
This option was previously named AutoBackupInterval.
reg-error-max-count
Section: statserver
Default Value: 0
Valid Values: 0 (zero) or positive integer less than or equal to 2147483647
Changes Take Effect: After restart
Introduced: 8.5.105
Specifies the number of additional DN registration attempts if the initial registration request fails. The time between attempts is specified by the value of the reg-error-delay and reg-dns-chunk-delay options.
reg-error-delay
Section: statserver
Default Value: 0
Valid Values: 0 (zero) or positive integer less than or equal to 2147483
Changes Take Effect: After restart
Introduced: 8.5.105
Specifies the minimal/least interval, in seconds, between the failed DN registration attempt and the next registration attempt. Since Stat Server registers DNs in chunks, the actual interval between registration attempts also depends on the value of the reg-dns-chunk-delay option.
throttle-threshold
Section: log
Default Value: 5000
Valid Values: 0-10000
Changes Take Effect: Immediately
Dependencies: enable-thread = true
Introduced: 8.5.106
Related Links: log throttling
Specifies the size of the internal log queue at which the verbose level is to be reduced so as to lessen the load generated by logging. If this option is set to 0 (zero), throttling does not occur. For more information about log throttling, refer to the Framework Management Layer User’s Guide.
throttle-period
Section: log
Default Value: 30
Valid Values: 0-3600
Changes Take Effect: Immediately
Dependencies: enable-thread = true
Introduced: 8.5.106
Specifies, in seconds, how long to keep the throttled verbose level. When this period of time has expired, the original log verbose level will be restored when the log queue size has decreased to less than 50% of the threshold.
enable-thread
Section: log
Default Value: false
Valid Values: true, false
Changes Take Effect: Immediately
Introduced: 8.5.106
Related Options: throttle-period, throttle-threshold
Related Links: log throttling
Specifies whether to enable or disable the logging thread. If set to true (the logging thread is enabled), the logs are stored in an internal queue to be written to the specified output by a dedicated logging thread. This setting also enables the log throttling feature, which allows the verbose level to be dynamically reduced when a logging performance issue is detected. Refer to the Framework Management Layer User’s Guide for more information about the log throttling feature.
If this option is set to false (the logging thread is disabled), each log is written directly to the outputs by the thread that initiated the log request. This setting also disables the log throttling feature.
stat-file-timeout
Section: statserver
Default Value: 10
Valid Values: Positive integers less than 65536
Changes Take Effect: Immediately
Introduced: 8.5.107
Specifies the amount of time, in seconds, that Stat Server must wait after adding a record to the StatFile log file, before it can write another record. Set this option to a large value if you need to minimize the amount of hard drive space that is consumed by the StatFile log file.
stat-file-show-options
Section: statserver
Default Value: false
Valid Values: true, false
Changes Take Effect: Immediately
Introduced: 8.5.107
Controls whether Stat Server configuration options are shown in the StatFile log file.
stat-file-show-clients-list
Section: statserver
Default Value: false
Valid Values: true, false
Changes Take Effect: Immediately
Introduced: 8.5.107
Specifies whether Stat Server writes client connection details in the StatFile log file.
interaction-wait-on-tenant-media-list
Section: statserver
Default Value: "chat"
Valid Values: "Media 1, Media 2, …, Media N" or "All"
Changes Take Effect: After restart
Introduced: 8.5.107
Specifies the list of media type name(s) for which the InteractionWait (Tenants) action is generated. All other media types will be ignored.
interaction-wait-on-tenant-max-number
Section: statserver
Default Value: 2147483647
Valid Values: Integers 1 through 2147483647
Changes Take Effect: After restart
Introduced: 8.5.107
Specifies the maximum allowed number of InteractionWait (Tenants) actions. When the threshold is reached, Stat Server does not create any more instances of the InteractionWait (Tenants) action, until the number of such actions falls back below the threshold.
When the debug-level option is set to Server, and the number of InteractionWait (Tenants) actions meets or exceeds the configured threshold value, the following message is printed in the Stat Server log once every minute until the number of InteractionWait (Tenants) actions is less than the maximum allowed:
"ATTN: Tenant(s) InteractionWait actions threshold of <max number> reached”
qos-recovery-enable-lms-messages
Section: overload
Default Value: false
Valid Values: true, false
Changes Take Effect: After restart
Introduced: 8.5.108
Enables Standard recovery related log messages, which are introduced for debugging purpose:
10072 “GCTI_SS_OVERLOAD_RECOVERY_STARTED - Overload recovery started on %s (%d current CPU usage)”
10073 “GCTI_SS_OVERLOAD_RECOVERY_FAILED - Overload recovery failed on %s (%d current CPU usage)”.
qos-default-overload-policy
Section: overload
Default Value: 0
Valid Values: 0, 1, 2
Changes Take Effect: After restart
Introduced: 8.5.108
Defines the global overload policy.
If this option is set to:
- 0 (zero) - sends and updates for requested statistics can be cut
- 1 - only sends of statistics to Stat Server clients can be cut
- 2 - nothing can be cut. Stat Server updates and sends all requested statistics.
protection
Section: overload
Default Value: false
Valid Values: true, false
Changes Take Effect: Immediately
Introduced: 8.5.108
Controls whether the overload protection is applied during the Stat Server overload.
cut-debug-log
Section: overload
Default Value: true
Valid Values: true, false
Changes Take Effect: Immediately
Introduced: 8.5.108
Controls debug logging in the overload. If set to true, the debug log is cut during the Stat Server overload.
cpu-threshold-low
Section: overload
Default Value: 60
Valid Values: 0-100
Changes Take Effect: After restart
Introduced: 8.5.108
Defines the lower level of the main thread CPU utilization threshold, which signifies the start of the Stat Server recovery.
cpu-threshold-high
Section: overload
Default Value: 80
Valid Values: 0-100
Changes Take Effect: After restart
Introduced: 8.5.108
Defines the higher level of the main thread CPU utilization threshold, which signifies the start of the Stat Server overload.
cpu-poll-timeout
Section: overload
Default Value: 10
Valid Values: 1-60
Changes Take Effect: After restart
Introduced: 8.5.108
Defines, in seconds, how often the main thread CPU is polled.
cpu-cooldown-cycles
Section: overload
Default Value: 30
Valid Values: 1-100
Changes Take Effect: After restart
Introduced: 8.5.108
Defines the number of cpu-poll-timeout cycles in a cooldown period.
For example, if the cpu-poll-timeout = 10sec and cpu-cooldown-cycles = 30, then the cooldown period is 10x30 =300sec. It means that the main thread CPU should be below the value of the cpu-threshold-low option for 300sec, after this period overload recovery is considered to be over.
allow-new-requests-during-overload
Section: overload
Default Value: true
Valid Values: true, false
Changes Take Effect: Immediately
Introduced: 8.5.108
Controls whether new requests can be made during the Stat Server overload.
allow-new-connections-during-overload
Section: overload
Default Value: true
Valid Values: true, false
Changes Take Effect: Immediately
Introduced: 8.5.108
Controls whether new clients can connect during the Stat Server overload.
debug-level
Section: statserver
Default Value: Init
Valid Values: all, Action, Client, Init, HA, Java, Mngmnt, Reset, Server, SPT, SQL, Status
Changes Take Effect: Immediately upon notification
A comma-separated list of debug categories that are visible in the Stat Server log:
- all Synonymous with Init,Server,Client,Status,Action,SQL,Mngmnt,Java,Reset. The debug level that you designate for this category supersedes any debug level that you designate for other categories.
- Action Logs changes to the internal Stat Server object model and provides a significant source of troubleshooting data, which includes entries following every TEvent.
- Client Logs all Stat Server communication with its clients, such as the opening of statistics and all statistical values sent to the client. This value generates a large amount of data, and should be sparingly used for troubleshooting reproducible problems with statistics.
- Init Used for capturing data related to Configuration Server that affects Stat Server, including dynamic Configuration Server changes made as Stat Server starts--such as the addition, deletion, and/or change of objects or their properties having an affect on Stat Server. This value is useful for tracking initial configuration and dynamic changes and is much more compact than the information provided in the Configuration Server log. Genesys recommends that you always include this value in this option.
- HA Logs messages related to HA functionality.
- Java Displays information related to Java extension functionality. Use this value only for statistics in the Outbound Contact 7.2.0+ or MCR 7.0.1+ (MCR has been renamed to eServices in release 8.0).
- Mngmnt Displays profiling information, including the number of currently connected clients, statistics being computed at the moment, and statistics to be reported to clients.
- Reset Enables the log messages Stat Server sends to clients while sending statistics requested with a reset-based notification mode.
- Server Logs T-Server events pertaining to Stat Server. Genesys recommends that you not include this value if you maintain logs for the related T-Server(s).
- SPT Logs events related to Stat Server startup. This value is provided to maintain backward compatibility and may be eliminated in future releases.
- SQL Displays the SQL statements issued if you have configured a database for Stat Server.
- Status Logs events related to the current state of objects and is useful for troubleshooting Stat Server-Router problems.
This option is enabled only if you have set the verbose common log option to all.
In graphical environments, log output often takes more than half of a server's execution time. To maintain performance, use only the debug levels that you need and run Stat Server in the background. Also, minimize the Stat Server window or redirect log output to a different device, such as a file. Be very careful, however, when directing log output to a file and consider the available free disk space, directory and file permissions, and possible conflicts with different software trying to use the log file at the same time.
For each debug category, you can also set the level of debug logging by specifying a numerical value from [0–9] (with 9 being the most verbose) and appending the number to each category.
For example: Init, Status:6
Debug level 0 is synonymous to no logging at all for the specified debug category.
Debug levels 1–4 provide less logging information than was provided in prior releases but more than debug level 0.
Debug level 5 provides exactly the same logging information that was provided in prior releases. This level is the default level if none is otherwise specified.
Debug levels 6–7 provide more detailed output than level 5.
Debug levels 8–9 provide the most extensive log output requiring further internal processing which, in turn, further degrades Stat Server performance.
The SIP Server 8.1.1 product provides a troubleshooting tool that parses the log output of several Genesys servers including Stat Server. Refer to the SipSpan2 User's Guide, available on the SIP Server CD, for information on how to use this tool.
This option was previously named DebugLevel.
session-expiration-timeout
Section: ha
Default Value: 120
Valid Values: 1 - 3600
Changes Take Effect: Immediately
Introduced: 8.5.109
Specifies, in seconds, how often the session expiration is checked during the time configured in the session-expiration-period option.
session-expiration-period
Section: ha
Default Value: 1800
Valid Values: 0 - 86400
Changes Take Effect: Immediately
Introduced: 8.5.109
Sets the session expiration period, in seconds. When the primary and backup Stat Servers, operating in high availability (HA) mode, cannot reconnect in time specified by the value of this option, the new session with the full statistics replication is initialized. When this option is set to 0 (zero), the lost session expires immediately.
connect-timeout
Section: ha
Default Value: 2
Valid Values: 1 - 3600
Changes Take Effect: Immediately
Introduced: 8.5.109
Timeout, in seconds, when the reconnect attempt between Stat Servers, operating in high availability (HA) mode, is made.
chunk-timeout
Section: ha
Default Value: 1
Valid Values: 1 - 3600
Changes Take Effect: Immediately
Introduced: 8.5.109
Duration, in seconds, between adjacent chunks during replication of statistics between primary and backup Stat Server instances. Term "chunk" means the number of statistics, processed simultaneously.
chunk-size
Section: ha
Default Value: 5000
Valid Values: 1 - 100000
Changes Take Effect: Immediately
Introduced: 8.5.109
Sets the number of statistics, processed simultaneously during replication of statistics between primary and backup Stat Server instances.
addp-trace
Section: ha
Default Value: both
Valid Values: local, remote, both, off
Changes Take Effect: Immediately
Introduced: 8.5.109
If addp is specified for the HA connection, the addp-trace option determines whether ADDP messages are written to the primary and backup Stat Server logs:
- local ADDP trace occurs on the side of the Stat Server in backup mode.
- remote ADDP trace occurs on the side of the Stat Server in primary mode.
- both ADDP trace occurs at both the primary and backup Stat Servers.
- off Turns ADDP off.
addp-timeout
Section: ha
Default Value: 10
Valid Values: 1 - 3600
Changes Take Effect: Immediately
Introduced: 8.5.109
If addp is specified for the HA connection, the addp-timeout option specifies the time interval, in seconds, that Stat Server in backup mode waits before polling the other Stat Server in the redundant pair.
addp-remote-timeout
Section: ha
Default Value: 10
Valid Values: 1 - 3600
Changes Take Effect: Immediately
Introduced: 8.5.109
If addp is specified for the HA connection, the addp-remote-timeout option specifies the time interval, in seconds, that Stat Server in backup mode instructs the other Stat Server in the redundant pair to use when polling to check the connection between the two servers.
java-extension-loading-timeout
Section: java-config
Default Value: 60
Valid Values: Any positive integer less than 2147483648 (231)
Changes Take Effect: Immediately
Modified: 8.5.109. Previously, the default value was 20.
Specifies the length of time, in seconds, that Stat Server allocates for loading Java Extensions. If an Extension does not load within this timeout, Stat Server sends a message to its log indicating this. Stat Server makes no further attempts to load the Extension during runtime.
interaction-cost-key
Section: budget
Default Value: InteractionCost
Valid Values: <key name>
Changes Take Effect: Immediately
Introduced: 8.5.110
Specifies the key in UserData, where the interaction cost is specified. If changed, all future interactions are affected. This option is recognized by URS.
enabled
Section: budget
Default Value: false
Valid Values: true, false
Changes Take Effect: Immediately
Introduced: 8.5.110
Enables the budget model. If set to false, Stat Server does not provide the budget information in the CurrentTargetState statistic on agents. This option is recognized by URS.
default-cost-unknown
Section: budget
Default Value: the value of the default-cost option
Valid Values: 0 - 2147483647
Changes Take Effect: Immediately
Introduced: 8.5.110
If defined, overrides the default-cost option for any media type for the particular Tenant.
default-cost-outbound
Section: budget
Default Value: the value of the default-cost option
Valid Values: 0 - 2147483647
Changes Take Effect: Immediately
Introduced: 8.5.110
If defined, overrides the default-cost option for any media type for the particular Tenant.
default-cost-internal
Section: budget
Default Value: the value of the default-cost option
Valid Values: 0 - 2147483647
Changes Take Effect: Immediately
Introduced: 8.5.110
If defined, overrides the default-cost option for any media type for the particular Tenant.
default-cost-inbound
Section: budget
Default Value: the value of the default-cost option
Valid Values: 0 - 2147483647
Changes Take Effect: Immediately
Introduced: 8.5.110
If defined, overrides the default-cost option for any media type for the particular Tenant.
default-cost-consult
Section: budget
Default Value: the value of the default-cost option
Valid Values: 0 - 2147483647
Changes Take Effect: Immediately
Introduced: 8.5.110
If defined, overrides the default-cost option for any media type for the particular Tenant.
default-cost
Section: budget
Default Value: 0
Valid Values: 0 - 2147483647
Changes Take Effect: Immediately
Introduced: 8.5.110
Default interaction cost for any media type.
default-agent-budget
Section: budget
Default Value: 0
Valid Values: 0 - 2147483647
Changes Take Effect: Immediately
Introduced: 8.5.110
Default agent budget for any media type.
default-cost-unknown
Section: budget
Default Value: No default value
Valid Values: 0 - 2147483647
Changes Take Effect: Immediately
Introduced: 8.5.110
If defined, overrides the settings of the default-cost-unknown and default-cost options on the Tenant level for a given MediaType.
default-cost-outbound
Section: budget
Default Value: No default value
Valid Values: 0 - 2147483647
Changes Take Effect: Immediately
Introduced: 8.5.110
If defined, overrides the settings of the default-cost-outbound and default-cost options on the Tenant level for a given MediaType.
default-cost-internal
Section: budget
Default Value: No default value
Valid Values: 0 - 2147483647
Changes Take Effect: Immediately
Introduced: 8.5.110
If defined, overrides the settings of the default-cost-internal and default-cost options on the Tenant level for a given MediaType.
default-cost-inbound
Section: budget
Default Value: No default value
Valid Values: 0 - 2147483647
Changes Take Effect: Immediately
Introduced: 8.5.110
If defined, overrides the settings of the default-cost-inbound and default-cost options on the Tenant level for a given MediaType.
default-cost-consult
Section: budget
Default Value: No default value
Valid Values: 0 - 2147483647
Changes Take Effect: Immediately
Introduced: 8.5.110
If defined, overrides the settings of the default-cost-consult and default-cost options on the Tenant level for a given MediaType.
default-cost
Section: budget
Default Value: No default value
Valid Values: 0 - 2147483647
Changes Take Effect: Immediately
Introduced: 8.5.110
If defined, overrides the settings of the default-cost option on the Tenant level for a given MediaType.
default-agent-budget
Section: budget
Default Value: No default value
Valid Values: 0 - 2147483647
Changes Take Effect: Immediately
Introduced: 8.5.110
If defined, overrides the settings of the default-agent-budget on the Tenant level for a given MediaType.
<media type name>
Section: budget
Default Value: No default value
Valid Values: 0 - 2147483647
Changes Take Effect: Immediately
Introduced: 8.5.110
If defined, overrides the settings of the default-agent-budget option on MediaType and Tenant levels for a giving MediaType.
old-stats-remove
Section: statserver
Default Value: yes
Valid Values: yes, no
Changes Take Effect: Immediately
Introduced: 8.5.110.18
If set to no, statistics that have not had connected clients for longer than the time set as the value of the old-stats-remove-interval option are not to be cleaned. If set to yes (the backward-compatibility mode), the statistical garbage-collection is performed.
interaction-agent-party-in-progress-on-tenant-media-list
Section: statserver
Default Value: chat
Valid Values: All, Media 1, Media 2, …, Media N
Changes Take Effect: After restart
Introduced: 8.5.110.18
A comma-separated list of media type names for which the InteractionAgentPartyInProgress (Tenants) action is generated. All other media types are ignored.
interaction-agent-party-in-progress-on-tenant-max-number
Section: statserver
Default Value: 2147483647
Valid Values: Integers 1 through 2147483647
Changes Take Effect: After restart
Introduced: 8.5.110.18
Specifies the maximum allowed number of InteractionAgentPartyInProgress (Tenants) actions. When the threshold is reached, Stat Server does not create any more instances of the InteractionAgentPartyInProgress (Tenants) action, until the number of such actions is below the threshold.
When the debug-level option is set to Server, and the number of InteractionAgentPartyInProgress (Tenants) actions meets or exceeds the configured threshold value, the following message is printed in the Stat Server log once every minute until the number of InteractionAgentPartyInProgress (Tenants) actions is less than the maximum allowed:
"ATTN: Tenant(s) InteractionAgentPartyInProgress actions threshold of <max number> reached”
config-reload-delay-if-primary
Section: statserver
Default Value: false
Valid Values: true, false
Changes Take Effect: Immediately
Introduced: 8.5.112.07
This option controls whether Stat Server, in primary mode, delays configuration reloads. If this option is set to true, the primary Stat Server in the redundant pair delays the reload of the configuration when it cannot restore a session with Configuration Server. The option must be configured in both Stat Server applications of the primary-backup pair.
mm-skip-reason-changed-events
Section: statserver
Default Value: no (for backward compatibility)
Valid Values: yes, no
Changes Take Effect: After restart
Introduced: 8.5.112.16
Prevents incorrect reason filter evaluation and the TotalContinuousNumber statistic calculation in certain scenarios by ignoring any reason change events.
If this option is set to yes, the multimedia reason changed events are ignored for proper calculation of statistics with the applied reason filter.
mm-agent-logout-optimization
Section: statserver
Default Value: false
Valid Values: true, false
Changes Take Effect: After restart
Introduced: 8.5.112.17
Controls Stat Server behavior for multimedia agents logout. The default value false provides backward compatibility. The true value optimizes multimedia agents logout.
Stat Server Migration Guide
New in Release 8.5.x
Stat Server 8.5.1 General Changes
- Stat Server supports the following new Agent Workbin actions:
- InteractionAbandonedDuringOffering
- InteractionAccepted
- InteractionAnswered
- InteractionCleared
- InteractionDistributed
- InteractionEntered
- InteractionReleased
- InteractionWait
- Stat Server supports protected mode in addition to normal mode during configuration reloads.
- Stat Server supports Kernel Virtual Machine (KVM) on Windows and Linux.
- Stat Server supports Microsoft SQL Server 2017.
- Stat Server supports changes of the interaction cost for budget-based routing.
- Stat Server supports the SinceLogin time profile for blended agents.
- Stat Server supports the durable InteractionAgentPartyInProgress action for Tenants.
- Stat Server supports the new DoNotDisturb action on a media channel.
- Enhanced tracking of a multimedia interaction associated with the virtual queue (VQ).
- Default DN capacity for voice calls on a Multimedia DN has been changed to 1 (instead of 255).
- Stat Server supports budget-based routing. Stat Server release 8.5.110 and URS release 8.1.400.50 or higher is required.
- In addition to Warm Standby, Stat Server supports the Hot Standby redundancy mode for Stat Server high availability (HA) pairs on Windows and Linux platforms.
- Stat Server maps the content of the attribute_reason_desc from Interaction Server events to the value of the ReasonValue key in a UserData key-value list on Action for the CurrentState or in a Reasons key-value list for the CurrentStateReasons.
- Stat Server supports the overload protection method of reducing CPU consumption.
- Stat Server supports the retrospective InteractionAbandoned action for Tenants.
- Stat Server supports Windows Server 2016 and Windows Server 2016 Hyper-V.
- Stat Server supports Sliding, Selection, and SinceLogin aggregation intervals in the statistical category Formula.
- Stat Server logs operational statistics and current execution context into a special StatFile log file to help with diagnostics and troubleshooting.
- Stat Server supports the durable InteractionWait action for Tenants. The action is intended to track an interaction until it is actually handled by an agent.
- Stat Server supports the durable DND action on RegDN.
- Stat Server supports Red Hat Enterprise Linux 7.
- Stat Server supports the statistical category Formula for the Growing time profile.
- Stat Server supports the Ever Growing time profile for a limited set of the float-valued categories. See the documentation for more details.
- Stat Server supports the new DialRemoteRelease action on Campaign/CallingList statistical objects.
- Stat Server can be configured to undertake multiple attempts to register a DN.
- Stat Server supports multiple business attribute values in stat types.
- Stat Server supports the InteractionResponded action.
- Stat Server supports Routable and NotRoutable actions on an agent or place.
- Stat Server supports GroupBy and DistinquishBy features.
- Stat Server supports ApplyFilterAtActionEndOnly stat type option.
- Stat Server natively supports the Tenant statistical object.
- Stat Server supports ActorType, AgentID, and RequestEnvelope System attributes.
- Stat Server supports the GlobalUserData key-value list in filters and formulas.
- Stat Server serializes statistical aggregates to/from the backup file.
- Stat Server connects to Configuration Server in an asynchronous mode.
- Stat Server rereads the whole configuration upon receiving the event HistoryLogExpired from Configuration Server.
- Stat Server natively supports the StagingArea statistical object.
- Stat Server supports new observer-related and outbound-call related actions for a regular DN.
- Stat Server supports JDK 1.8.
- Stat Server includes functionality for the prevention of database update losses due to commit failures or loss of database server connection.
- Stat Server now only loads JVM, if it is defined in the configuration with absolute path.
Stat Server 8.5.0 General Changes
- Stat Server supports multiple Interaction Servers that handle the same Tenant.
- Stat Server supports the EventHint panic signal from Interaction Server. Refer to the eServices Reference Manual for more information about this feature.
- Stat Server supports Interaction Server Proxy.
- Stat Server supports direct connection to the database.
- Stat Server features a more robust DND model implementation for voice.
- Stat Server processes network messages (client and server) in a separate thread.
- Stat Server supports a higher number of concurrent client connections (on most platforms).
- Stat Server no longer supports Genesys suite-wide deployment wizards. All deployment wizards migrate to Genesys Administrator Extension (GAX):
- Resource Capacity Editor of GAX covers all the functionality that was covered by the Recourse Capacity Wizard.
Compatibility with Framework Components
Stat Server 8.5 interoperates successfully with the following Framework components:
- Configuration Server, releases 6.5 through 8.5
- Local Control Agent, releases 6.5 through 8.5
- Message Server, releases 6.5 through 8.5
- DB Server, releases 6.5 through 8.1
- T-Server, release 6.5 through 8.5
- Solution Control Server, release 6.5 through 8.5
However, to access all of the features that are available in a particular release, Genesys recommends that you operate Stat Server within the same family of Framework components in which it was released, or the latest available component release. Otherwise, some documented features may not be available to you.
Configuration Option Changes
| Current Option Name |
Section | Type of Change |
Release # in Which Change Occurred |
Details |
|---|---|---|---|---|
| mm-agent-logout-optimization | [statserver] | Added | 8.5.112.17 | Controls Stat Server behavior for multimedia agents logout. |
| mm-skip-reason-changed-events | [statserver] | Added | 8.5.112.16 | Prevents incorrect reason filter evaluation and the TotalContinuousNumber statistic calculation in certain scenarios by ignoring any reason change events. |
| config-reload-delay-if-primary | [statserver] | Added | 8.5.112.07 | Controls the delay of configuration reloads by the primary Stat Server in a redundant (primary-backup) pair in case of inability to restore a session with Configuration Server. |
| interaction-agent-party-in-progress-on-tenant-max-number | [statserver] | Added | 8.5.110.18 | Specifies the maximum allowed number of InteractionAgentPartyInProgress (Tenants) actions. |
| interaction-agent-party-in-progress-on-tenant-media-list | [statserver] | Added | 8.5.110.18 | A comma-separated list of media type names for which the InteractionAgentPartyInProgress (Tenants) action is generated. |
| old-stats-remove | [statserver] | Added | 8.5.110.18 | Controls when the statistical garbage-collection is performed |
| <media type name> | [budget] | Added | 8.5.110.03 | This option is configured on the Agent or Place object. |
| default-agent-budget | [budget] | Added | 8.5.110.03 | This option is configured on the MediaType object. |
| default-cost | [budget] | Added | 8.5.110.03 | This option is configured on the MediaType object. |
| default-cost-consult | [budget] | Added | 8.5.110.03 | This option is configured on the MediaType object. |
| default-cost-inbound | [budget] | Added | 8.5.110.03 | This option is configured on the MediaType object. |
| default-cost-internal | [budget] | Added | 8.5.110.03 | This option is configured on the MediaType object. |
| default-cost-outbound | [budget] | Added | 8.5.110.03 | This option is configured on the MediaType object. |
| default-cost-unknown | [budget] | Added | 8.5.110.03 | This option is configured on the MediaType object. |
| default-agent-budget | [budget] | Added | 8.5.110.03 | This option is configured on the Tenant object. |
| default-cost | [budget] | Added | 8.5.110.03 | This option is configured on the Tenant object. |
| default-cost-consult | [budget] | Added | 8.5.110.03 | This option is configured on the Tenant object. |
| default-cost-inbound | [budget] | Added | 8.5.110.03 | This option is configured on the Tenant object. |
| default-cost-internal | [budget] | Added | 8.5.110.03 | This option is configured on the Tenant object. |
| default-cost-outbound | [budget] | Added | 8.5.110.03 | This option is configured on the Tenant object. |
| default-cost-unknown | [budget] | Added | 8.5.110.03 | This option is configured on the Tenant object. |
| enabled | [budget] | Added | 8.5.110.03 | This option is configured on the Tenant object. |
| interaction-cost-key | [budget] | Added | 8.5.110.03 | This option is configured on the Tenant object. |
| java-extension-loading-timeout | [java-config] | Modified | 8.5.109 | The default value is changed from 20 to 60 seconds. |
| addp-remote-timeout | [ha] | Added | 8.5.109 | Specifies the time interval, in seconds, that Stat Server in backup mode instructs the other Stat Server in the redundant pair to use when polling to check the connection between the two servers. |
| addp-timeout | [ha] | Added | 8.5.109 | Specifies the time interval, in seconds, that Stat Server in backup mode waits before polling the other Stat Server in the redundant pair. |
| addp-trace | [ha] | Added | 8.5.109 | Determines whether ADDP messages are written to the primary and backup Stat Server logs. |
| chunk-size | [ha] | Added | 8.5.109 | Sets the number of statistics, processed simultaneously during replication of statistics between primary and backup Stat Server instances. |
| chunk-timeout | [ha] | Added | 8.5.109 | Duration, in seconds, between adjacent chunks during replication of statistics between primary and backup Stat Server instances. Term "chunk" means the number of statistics, processed simultaneously. |
| connect-timeout | [ha] | Added | 8.5.109 | Timeout, in seconds, when the reconnect attempt between Stat Servers, operating in high availability (HA) mode, is made. |
| session-expiration-period | [ha] | Added | 8.5.109 | Session expiration period (in seconds). |
| session-expiration-timeout | [ha] | Added | 8.5.109 | Specifies, in seconds, how often the session expiration is checked during the time configured in the session-expiration-period option. |
| debug-level | [statserver] | Modified | 8.5.109 | New HA value is added. |
| allow-new-connections-during-overload | [overload] | Added | 8.5.108 | Controls whether new clients can connect during the Stat Server overload. |
| allow-new-requests-during-overload | [overload] | Added | 8.5.108 | Controls whether new requests can be made during the Stat Server overload. |
| cpu-cooldown-cycles | [overload] | Added | 8.5.108 | Defines the number of cpu-poll-timeout cycles in a cooldown period. |
| cpu-poll-timeout | [overload] | Added | 8.5.108 | Defines, in seconds, how often the main thread CPU is polled. |
| cpu-threshold-high | [overload] | Added | 8.5.108 | Defines the higher level of the main thread CPU utilization threshold, which signifies the start of the Stat Server overload. |
| cpu-threshold-low | [overload] | Added | 8.5.108 | Defines the lower level of the main thread CPU utilization threshold, which signifies the start of the Stat Server recovery. |
| cut-debug-log | [overload] | Added | 8.5.108 | Controls debug logging in the overload. If set to true, the debug log is cut during the Stat Server overload. |
| protection | [overload] | Added | 8.5.108 | Controls whether the overload protection is applied during the Stat Server overload. |
| qos-default-overload-policy | [overload] | Added | 8.5.108 | Defines the global overload policy. |
| qos-recovery-enable-lms-messages | [overload] | Added | 8.5.108 | Enables Standard recovery related log messages. |
| DynamicOverloadPolicy | [<stat-type>] | Added | 8.5.108 | Defines actions that Stat Server may apply to a given statistic to reduce the overload. |
| interaction-wait-on-tenant-max-number | [statserver] | Added | 8.5.107 | Specifies the maximum allowed number of InteractionWait (Tenants) actions. |
| interaction-wait-on-tenant-media-list | [statserver] | Added | 8.5.107 | Specifies the list of media type name(s) for which the InteractionWait (Tenants) action is generated. |
| stat-file-show-clients-list | [statserver] | Added | 8.5.107 | Specifies whether Stat Server writes client connection details in the StatFile log file. |
| stat-file-show-options | [statserver] | Added | 8.5.107 | Controls whether Stat Server configuration options are shown in the StatFile log file. |
| stat-file-timeout | [statserver] | Added | 8.5.107 | Specifies the amount of time, in seconds, that Stat Server must wait after adding a record to the StatFile log file, before it can write another record. |
| enable-thread | [log] | Added | 8.5.106 | Specifies whether to enable or disable the logging thread. Refer to the Framework Management Layer User’s Guide for more information about the log throttling. |
| throttle-period | [log] | Added | 8.5.106 | Specifies, in seconds, how long to keep the throttled verbose level. |
| throttle-threshold | [log] | Added | 8.5.106 | Specifies the size of the internal log queue at which the verbose level is to be reduced so as to lessen the load generated by logging. |
| reg-error-delay | [statserver] | Added | 8.5.105 | Specifies the minimal/least interval, in seconds, between the failed DN registration attempt and the next registration attempt. |
| reg-error-max-count | [statserver] | Added | 8.5.105 | Specifies the number of additional DN registration attempts if the initial registration request fails. |
| auto-backup-interval | [statserver] | Modified | 8.5.104 | New max value is 35791. |
| consult-acw-mode | [statserver] | Added | 8.5.104 | Controls when Stat Server generates the AfterCallWork action. |
| reconnect-timeout | [statserver] | Modified | 8.5.104 | New max value is 2147483. |
| reg-delay | [statserver] | Modified | 8.5.104 | New max value is 2147483. |
| reg-dns-chunk-delay | [statserver] | Modified | 8.5.104 | New max value is 2147483. |
| suppress-user-data | [statserver] | Added | 8.5.104 | Determines whether Stat Server should transmit call-extracted attached data. |
| interaction-wait-on-sa-max-number | [statserver] | Added | 8.5.103 | Specifies the maximum allowed number of InteractionWait (StagingAreas) actions. |
| interaction-wait-on-sa-media-list | [statserver] | Added | 8.5.103 | Specifies the list of media type name(s) for which the InteractionWait (StagingAreas) action is generated. |
| backup-file-aggregates-store | [statserver] | Added | 8.5.102 | Controls whether the statistical aggregates are read from/written into the backup file. |
| disconnect-from-lca-on-history-log-expired | [statserver] | Added | 8.5.102 | Controls whether Stat Server disconnects from LCA upon receiving the HistoryLogExpired event. |
| media-type | [statserver] | Meaning extended | 8.5.102 | Now voice is a valid value. |
| accept-clients-in-backup-mode | [statserver] | Modified | 8.5.1 | New default value is yes. |
| db-timeout | [statserver] | Added | 8.5.1 | Controls the timeout, during which Stat Server waits for response from DB Server. |
| db-txn-max-retries | [statserver] | Added | 8.5.1 | Controls the number of transaction retries with DB Server. |
| reconnect-timeout | [statserver] | Meaning extended | 8.5.1 | The option is now also applicable to the Configuration Server connection. |
| debug | [db-direct-connection] | Added | 8.5.0 | Controls advanced debugging information on interactions with a database in the direct connection mode. |
| enable | [db-direct-connection] | Added | 8.5.0 | Enables direct database connection. |
| identity-in-login-table | [statserver] | Added | 8.5.0 | Applicable only for Oracle. Enables Stat Server to fill the APP_DBID field in LOGIN table. This option is required for Stat Server to operate with an Oracle Real Application Clusters (RAC). |
| verbose | [db-direct-connection] | Added | 8.5.0 | Controls the verbosity level of Stat Server log messages about SQL statement and other database-related activities. |
Log Events Changes
| Message ID |
Level | Text | Type of Change |
Release # |
|---|---|---|---|---|
| 10087 | STANDARD | Protected configuration monitoring mode stopped (duration=%d sec) | Added | 8.5.112.07 |
| 10086 | STANDARD | Protected configuration monitoring mode started | Added | 8.5.112.07 |
| 10085 | STANDARD | Normal configuration monitoring mode stopped (duration=%d sec) | Added | 8.5.112.07 |
| 10084 | STANDARD | Normal configuration monitoring mode started | Added | 8.5.112.07 |
| 10082 | TRACE | Large kv-list ([number] bytes) in CurrentState value | Added | 8.5.110.12 |
| 10078 | STANDARD | Budget model is disabled on tenant '%s' | Added | 8.5.110.03 |
| 10077 | STANDARD | Budget model is enabled on tenant '%s' | Added | 8.5.110.03 |
| 10081 | STANDARD | Invalid time-range: '%s' = '%s' | Added | 8.5.109 |
| 10080 | STANDARD | Invalid filter: '%s' = '%s' | Added | 8.5.109 |
| 10075 | STANDARD | Overload protection on %s deactivated | Added | 8.5.108 |
| 10074 | STANDARD | Overload protection on %s activated | Added | 8.5.108 |
| 10073 | STANDARD | Overload recovery failed on %s (%d current CPU usage) | Added | 8.5.108 |
| 10072 | STANDARD | Overload recovery started on %s (%d current CPU usage) | Added | 8.5.108 |
| 10071 | STANDARD | Overload ended on %s (%d current CPU usage) | Added | 8.5.108 |
| 10070 | STANDARD | Overload detected on %s (%d current CPU usage) | Added | 8.5.108 |
| 10069 | STANDARD | Building virtual agent groups on tenant '%s', %d percent complete | Added | 8.5.105 |
| 10068 | STANDARD | Name uniqueness violation for %s '%s' (tenant '%s') (old dbid=%d, new dbid=%d) | Added | 8.5.104 |
| 10067 | STANDARD | Application failed to restore session with Config Server | Added | 8.5.100 |
Diagnostics changes
- Stat Server ignores identically named places and indicates that with the following Standard type LMS message: 10068 Name uniqueness violation for %s '%s' (tenant '%s') (old dbid=%d, new dbid=%d).
- Stat type definitions are now printed at startup if the Init:6 value is specified for the [statserver]\debug-level configuration option.
- Statistical requests to open statistics (OpenStat, GetStat) and associated responses (EventStatOpened, EventError) are printed at Init:4 (previously, at Init:5).
- Stat Server recognizes the [log]\time-format configuration option when printing timestamps in the log.
- If session with Configuration Server cannot be restored, new Standard type LMS message 10067 Application failed to restore session with Config Server is printed in the standard log.
- If Init:7 is specified in [statserver]\debug-level, then additional diagnostics is printed on Init log level.
Migrating from Stat Server 8.1.2 with Connection to DB Server, to Stat Server 8.5.0 with Direct Database Connection
Prerequisites:
- A Database Access Point (DAP) properly configured for connection to the database with initialized Stat Server tables.
- Installed and properly configured related DBMS client software.
Migration steps:
- Install Stat Server 8.5.0.
- In the Stat Server application object, under Options / Application Options (GAX), in the [db-direct-connection] section set the enable option to on. Default value for the enable option is off.
- Optional. Set the verbose option in the db-direct-connection section to a value from 1 to 4 to produce more verbose log output on Stat Server database-related activities.
For DB2, you can install the IBM Data Server Runtime Client.
For SQL Server, you can install Microsoft Data Access Components (which includes ODBC), but this should not be necessary as Windows ships with ODBC.Migrating LOGIN table from 8.1.2 to 8.5.0 for Oracle
In general, Stat Server tables upgrade is not required, because Stat Server 8.5 works properly with tables from previous releases. If you use Oracle RAC environment, you must upgrade the LOGIN table using the upgrade script, which adds extra fields.
Using the Oracle sqlplus client, run the script sql_scripts/oracle/upgrade_850_login_oracle.sql, which will upgrade the table for use with Stat Server 8.5.0, and migrates existing data. This script creates two additional fields, ID and APP_DBID. Note that for existing data, the APP_DBID field will simply be set to 0.
- Running the script login_oracle.sql creates the table, and deletes previously existing data from it.
- Before you begin, back up your original LOGIN table, because running this script will reinitialize it, removing any old data from this table.
In the Stat Server application object, under Options / Application Options (GAX), in the [statserver] section set the identity-in-login-table option to on. This setting is not on by default.