Jump to: navigation, search

Configuration Options Reference

Modified in 8.5.107, 8.5.108, 8.5.109, 8.5.110, 8.5.111

This page provides descriptions and explanations of Genesys Mobile Services-specific options.

Important
Starting in 8.5.108, new options have been added to the Genesys Mobile Services Options Reference. This content is under development and might not be comprehensive or completely up to date.

Overview

By default, the Options tab for your Genesys Mobile Services Application object contains several sections with configuration values.

  • Log — Standard log file options for this Application object. For more information about these options, refer to your Genesys Framework documentation.
  • gms — Configuration settings used across different services.
  • ors — Configuration settings for the Orchestration Server.
  • push — Configuration settings for the Notification sub-service.
  • resources — Configuration details for handling of resource groups.
  • server — This section describes configuration options specific to each Genesys Mobile Services Application instance.
  • service.servicename — Every service you want to provide using this instance of Genesys Mobile Services can have a custom entry created using this format. The default installation provides two examples:
    • service.request-interaction
    • service.query
  • port_restrictions — Configuration settings for port restrictions.
  • log filters — Configuration settings for log filters hiding data.
  • reporting — Setting for URS statistics reporting.
  • stat.statname — You can ask Genesys Mobile Services to open one or more Stat Server statistics on startup. This section describes the formatting.
  • chat — Additional chat settings.
  • callback — Additional callback settings.

[business-attributes] Section

map-names

Section: business-attributes
Default Value: false
Valid Values: String
Changes Take Effect: Immediately


Set to true to return the Names of Business Attribute Values instead of DB IDs in the responses for GET operations; false (default) to return the DB IDs of Business Attribute Values in the responses for GET operations.

resourcename.fieldname

Section: business-attributes
Default Value:
Valid Values:
Changes Take Effect: Immediately


Associates a Business Attribute key with the name of the Business Attribute configured in the proper tenant.

  • Possible resource name values are:
    • Service
    • State
    • Task
  • Possible field name values to map are:
    • type (for service type)
    • disposition
    • application_type
    • resource_type
    • media_type
  • Such as, for instance: Service.service_type, Task.disposition, State.media_type.
Important
  • If there is no configuration for a given field, Context Services automatically allows any valid integer value for this field. In this case, your application is responsible for the value's validity.
  • A Business Attribute can be mapped to several resource fields. For instance, the Service.media_type and Task.media_type string can both point to the "MediaType" Business Attributes.

[callback] Section

_enable_in_queue_checking

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


Added in: 8.5.109.05
If true, prevents the callback creation if the same customer number has already two callbacks in the queue; if false, does not check whether the customer is already in queue when creating the callback. This option applies to both immediate and scheduled callbacks.

_enable_throttle_header_parameters

Section: callback
Default Value: true
Valid Values: true, false
Changes Take Effect: Immediately
Introduced: 8.5.111.04

If true, applies the throttling to the header parameters that are configured in the _throttle_request_parameters option. You can configure two types of parameters in the _throttle_request_parameters option:

  • Callback request body's parameters
  • Callback request header's parameters. If the same parameter name exists in both header and body with different values, and if this option is true, the system applies the throttling to the header value and ignores the body value.

For example, let's consider _throttle_request_parameters=_customer_number, user_id, where user_id is a parameter passed in the Callback request header and where _customer_number is passed in the request as a body parameter. If _enable_throttle_header_parameters=true, by default, the system will allow a maximum of 6 immediate callback requests issued from the same user_id per day (24 hours). If set to false, there is no restriction for the callback requests issued from the same user_id.

_throttle_callbacks_per_service_1

Section: callback
Default Value: 500
Valid Values: Any positive integer
Changes Take Effect: Immediately
Introduced: 8.5.109.05

Specifies the maximum number of callbacks per service for the duration set in _throttle_ttl_1. A second limitation can be introduced with the options _throttle_callbacks_per_service_2 and throttle_ttl_2. Genesys recommends using these options to prevent a high rate of callback requests in a given period of time. For instance, to set a limit of 500 callbacks in 5 minutes, but not more than 1000 callbacks in 1 hour, use the following configuration:

_throttle_callbacks_per_service_1=500
_throttle_ttl_1=300
_throttle_callbacks_per_service_2=1000
_throttle_ttl_2=3600

_throttle_customer_number_limit

Section: callback
Default Value: 6
Valid Values: Any positive integer
Changes Take Effect: Immediately
Introduced: 8.5.109.05
Discontinued: 8.5.110.07

Specifies the maximum number of immediate callback requests that a given customer number can request per day. You can set the list of parameters to apply this throttling in the option _throttle_request_parameters.

Starting in 8.5.110.07, this option is discontinued. Use option _throttle_request_parameters_limit instead.

_throttle_callbacks_per_service_2

Section: callback
Default Value: 1000
Valid Values: Any positive integer
Changes Take Effect: Immediately
Introduced: 8.5.109.05

Specifies the maximum number of callbacks per service for the duration set in _throttle_ttl_2. A second limitation can be introduced with the options _throttle_callbacks_per_service_1 and _throttle_ttl_1. Genesys recommends using these options to prevent high rates of callback requests in a given period of time. For instance, to set a limit of 500 callbacks in 5 minutes, but not more than 1000 callbacks in 1 hour, use the following configuration:

_throttle_callbacks_per_service_1=500
_throttle_ttl_1=300
_throttle_callbacks_per_service_2=1000
_throttle_ttl_2=3600

_throttle_request_parameters

Section: callback
Default Value: _customer_number
Valid Values: String
Changes Take Effect: Immediately


Added in: 8.5.109.05
Specifies a comma-separated list of request parameters to which the _throttle_customer_number_limit option applies. For example, _throttle_request_parameters=_customer_number, _target

_throttle_ttl_1

Section: callback
Default Value: 300
Valid Values: Any positive integer
Changes Take Effect: Immediately


Added in: 8.5.109.05
Specifies the duration in seconds used for the callbacks limit set in _throttle_callbacks_per_service_1. A second limitation can be introduced with the options _throttle_callbacks_per_service_2 and _throttle_ttl_2. Genesys recommends using these options to prevent high rates of callback requests in a given period of time. For instance, to set a limit of 500 callbacks in 5 minutes, but not more than 1000 callbacks in 1 hour, use the following configuration:

_throttle_callbacks_per_service_1=500
_throttle_ttl_1=300
_throttle_callbacks_per_service_2=1000
_throttle_ttl_2=3600

_throttle_ttl_2

Section: callback
Default Value: 3600
Valid Values: Any positive integer
Changes Take Effect: Immediately


Added in: 8.5.109.05
Specifies the duration in seconds used for the callbacks limit set in _throttle_callbacks_per_service_2. A second limitation can be introduced with the options _throttle_callbacks_per_service_1 and _throttle_ttl_1. Genesys recommends using these options to prevent high rates of callback requests in a given period of time. For instance, to set a limit of 500 callbacks in 5 minutes, but not more than 1000 callbacks in 1 hour, use the following configuration:

_throttle_callbacks_per_service_1=500
_throttle_ttl_1=300
_throttle_callbacks_per_service_2=1000
_throttle_ttl_2=3600

callback_column_alias

Section: callback
Default Value: No default value
Valid Values: JSON-formatted string
Changes Take Effect: Immediately
Introduced: 8.5.111.04

Defines a list of aliases for the custom parameters submitted in Callback queries. If the disable_additional_columns_from_callbacks option is false, the Callback UI will use these aliases as Display Names for the columns that display the custom parameters' values.

The list must match the following format: { "parameter_key1" : "parameter_alias1", "parameter_key2" : "parameter_alias2", ..., "parameter_keyN": "parameter_aliasN" }

filter-keys

Section: callback
Default Value: _callback_state,_callback_reason,_request_queue_time_stat,_request_ewt_service,_vq
Valid Values: Comma-separated list of keys
Changes Take Effect: Immediately
Introduced: 8.5.111.04

Defines a list of filtering keys that can be passed in the Query Callback by Queues query of the Callback API.

log-background-activity

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


Set to true to provide more callback logs.

max_queued_callbacks_per_service

Section: callback
Default Value: 1000
Valid Values: Any integer
Changes Take Effect: Immediately


Added in 8.5.108.02
Maximum number of queued callbacks per service, if the option is not overridden in the callback service. Note that this option will not reject scheduled callbacks and applies only to immediate callbacks.

queue-polling-rate

Section: callback
Default Value: 60
Valid Values: Any positive integer
Changes Take Effect: Immediately


Polling interval (in seconds) at which GMS should verify if callbacks should be submitted for execution. In the case of an initial submission error, this interval impacts the occurrence of submission attempts.

queue-polling-rate-recover

Section: callback
Default Value: 3600
Valid Values: Any positive integer
Changes Take Effect: Immediately


Polling interval (in seconds) at which GMS should verify if old callbacks (with desired time past for more than 2 hours) should be pinged and possibly re-submitted for execution.

returned-keys

Section: callback
Default Value: _desired_time,_callback_state,_callback_state,_callback_reason,_ors_session_id
Valid Values: Comma-separated list of keys
Changes Take Effect: Immediately
Introduced: 8.5.111.04

Specifies a list of keys whose values must be returned when fetching callback records with the Query Callback by Queues or Query by properties queries of the Callback Services API.

Note that the following keys are always returned: _id, _desired_time, _service_name, _callback_state, _expiration_time, _customer_number, _url, _callback_reason (optional), in addition to the keys defined in the _customer_lookup_keys option.

[cassandra] Section

Changes take effect after restart.

nodes

Section: cassandra
Default Value: No default value
Valid Values: String
Changes Take Effect: After restart


Comma-separated list of Cassandra hosts or IP addresses of the local data center. For example: host1,192.168.1.2

create-embedded-server

Section: cassandra
Default Value: true
Valid Values: true, false
Changes Take Effect: After restart
Discontinued: 8.5.206.04

Set this option to false to connect to an external Cassandra instance. If set to true, creates and connects to the Cassandra server embedded with GMS and ignores the node and port options in the cassandra section.

create-schema

Section: cassandra
Default Value: true
Valid Values: true, false
Changes Take Effect: After restart
Discontinued: 8.5.207.05

If set to true, creates (if needed) keyspaces and column families for GMS. If set to false, does not create keyspaces.

keyspace-prefix

Section: cassandra
Default Value: No default value
Valid Values: Any string
Changes Take Effect: After restart


Specifies the prefix for GMS keyspace naming.

The default value is empty for backward compatibility. Note: If this value is left empty, the gsg and gsg_dd keyspaces will be created in Cassandra.

port

Section: cassandra
Default Value: 0
Valid Values: Any positive integer
Changes Take Effect: After restart
Discontinued: 8.5.203.02

The listening port of the Cassandra server (that is, the port on which Thrift listens for clients).

Starting in 8.5.203, use the new native-port option instead of this one.

strategy-class

Section: cassandra
Default Value: SimpleStrategy
Valid Values: SimpleStrategy, NetworkTopologyStrategy, or cassandra-topology
Changes Take Effect: After restart
Discontinued: 8.5.207.05

Specifies the strategy class that Cassandra uses for the cluster. Valid values are:

  • SimpleStrategy, which defines a single cluster without multiple Data Centers.
  • NetworkTopologyStrategy, which is a network strategy in conjunction with the cassandra-topology properties file (located in the install configuration directory for each Cassandra instance), defines the Data Centers for the Cassandra cluster. Multiple Data Centers are typically geographically dispersed.

strategy-option

Section: cassandra
Default Value: replication_factor:4
Valid Values: Any string
Changes Take Effect: After restart
Discontinued: 8.5.207.05

Specifies the replication factor value according to the strategy-class:

  • If the strategy class is SimpleStrategy, set this value to replication_factor:2, where 2 is the number of Cassandra nodes.
  • If the strategy class is NetworkTopologyStrategy, set this value to DC1:2;DC2:3, where DC is the Data Center topology.

[cassandra-authentication-security] Section

Important
The user name and password are replicated to all Cassandra nodes.

Changes take effect after restart.

username

Section: cassandra-authentication-security
Default Value: No default value
Valid Values: Any string
Changes Take Effect: After restart


The Cassandra user name.

Important
The user name and password are replicated to all Cassandra nodes.

password

Section: cassandra-authentication-security
Default Value: No default value
Valid Values: Any string
Changes Take Effect: After restart


The Cassandra password.

Important
The user name and password are replicated to all Cassandra nodes.

[chat] Section

This section configures additional chat parameters for the GMS application.

_client_timeout

Section: chat
Default Value: 900
Valid Values: Any positive integer
Changes Take Effect: After restart


Client timeout in seconds for Cometd chat sessions.

If the client does not interact with the Chat service (refresh, send message, send event), GMS stops to poll the Chat server, and the Chat session is closed. This option applies only to chat sessions implemented using Cometd connections. For non-Cometd implementation, Chat server timeout parameters apply. The default value for this option is 15 minutes.

chat_400_response_on_disconnected

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


If you set this option to true and if the agent disconnected from the chat session, when returning to foreground and calling the chat refresh API, your chat application receives a 400 Error. If you set this option to false (default), your application receives 200 OK in this scenario.

chat_load_balancer_url_path

Section: chat
Default Value: /WebAPI812/SimpleSamples812/ChatHA/ChatLBServerInfo.jsp
Valid Values: Valid URL
Changes Take Effect: Immediately upon notification.


Path of the Chat load balancer, see GMS examples

chat_refresh_rate

Section: chat
Default Value: 2000
Valid Values: Any integer >=500
Changes Take Effect: After restart


Sets the period in milliseconds for polling transcript changes from the chat server. This option applies to Cometd sessions only. Genesys recommends the default value (2000 msec) for most deployments. If you decrease this value, you increase the workload on GMS and chat servers.

chat_session_request_timeout

Section: chat
Default Value: 30000
Valid Values: Any positive integer
Changes Take Effect: Immediately upon notification.


Duration in milliseconds after which the chat interaction gets deleted.

default_chat_endpoint

Section: chat
Default Value: Environment:default
Valid Values: <tenant_name>:<chat_endpoint>
Changes Take Effect: Immediately upon notification.


This option is used for all chat services in order to define the queue (URS) where the chat session initiated by GMS will enter. The value of this option is the tenant name on which the service(s) will proceed, and the chat endpoint as defined in the ChatServer option. For example, the section endpoints for the tenant Environment in the chat options is written as endpoints:1. This section contains the endpoint options (for example, default=queue). The chat endpoint value to use this default endpoint in the Environment tenant is Environment:default.

Tip
You can supersede this option for each chat service using the _chat_endpoint option with the same <tenant_name:chat_endpoint> value.

ixn_server_submit_queue

Section: chat
Default Value: Chat In
Valid Values:
Changes Take Effect: Immediately upon notification.


Deprecated in: 8.5.005.03
Queue used to submit Chat Interaction.

Required Chat Server Options (HA)
Section: endpoints:1
Option Name Option Value
default Chat In
Section: settings
Option Name Option Value
session-restoration-mode simple
transcript-auto-save 2

[commons-connection] Section

Changes take effect: After restart. Supported since 8.5.103.10+

string-attributes-encoding

Section: commons-connection
Default Value: UTF-8
Valid Values:
Changes Take Effect: After restart


Added in: 8.5.103.10
Encodes attributes in UTF-8. You need this option for UTF-8 multi-locales support.

[cview] Section

enabled

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


Enables (true) or disables (false) the Context Services feature. If set to FALSE, the other options are ignored.

expiration

Section: cview
Default Value: 5y
Valid Values: <integer><letter>
Changes Take Effect: Immediately


Defines expiration time for conversation (service, states, tasks) after creation or last API update. The expiration time is formatted as follows: <integer><letter> where:

  • <integer> specifies the time period
  • <letter> is one of the following period type:
    • s: seconds
    • m: minutes
    • h: hours
    • d: days
    • w: weeks (7 days)
    • M: months (30 days)
    • y: years (365 days)

use-role

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


Enables (true) or disables (false) Role-Based Access Control.

allow-custom-ids

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


If true, enables custom IDs; this option is for migration purpose only and allows Context Services to replicate the UCS service identifier into Context Services storage. If false, Context Services generate new identifiers in response of "start" events.

data-validation

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


If true, allows additional checks of consistency during production. For example, if your application creates a State or a Task, the server checks that the service exists before it creates the inner object; if not, your application receives a Service Not Found Exception.

Warning
This data validation feature is a costly process that requires additional storage read access.

[elasticsearch] Section

allowedServiceTypes

Section: elasticsearch
Default Value: '"*"
Valid Values: String
Changes Take Effect: Immediately


Comma-separated list of the service types allowed to publish conversations to the elastic server. The service types are String or DBIDs matching the Business Attributes mapping; for example: Identification,Special Offers.

enabled

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


Set to true to push conversations to elastic search when services are completed.

server

Section: elasticsearch
Default Value: No default value
Valid Values: String
Changes Take Effect: Immediately


Elastic Search server URL; for instance: http://gax1dev:1664.

urlPattern

Section: elasticsearch
Default Value:
Valid Values:
Changes Take Effect:


Pattern to append to the server URL; for instance: ${service.type}-${date.year}.${date.month}.${date.day}/service/${service.id}. The possible pattern variables are:

  • date.year
  • date.month
  • date.day
  • service.type
  • service.id

[gms] Section

Changes take effect: Immediately.

http.client_port_range

Section: gms
Default Value: Assigned by the system
Valid Values: Integer Range (eg., 52000-53000) Max Range (0-65535)
Changes Take Effect: Immediately


All HTTP client requests from GMS to other servers will use a client socket port from the specified range.

  • If the selected port is already in use, the request is tried using the next port in a serial fashion.
  • If this option is not specified, the OS will assign a random available port for the request.

http.connection_timeout

Section: gms
Default Value: 10
Valid Values: Any positive integer
Changes Take Effect: Immediately


Connection timeout (in seconds) for http connections to be established from gms to other servers (ORS, httpcb and cluster resource service). Default is set pretty low, so should be on the fast network.

http.max_connections_per_route

Section: gms
Default Value: 20
Valid Values: Any positive integer
Changes Take Effect: Immediately


Number of concurrent connections to connect to each HTTP server. All subsequent concurrent requests will be queued.

http.max_connections_total

Section: gms
Default Value: 100
Valid Values: Any positive integer
Changes Take Effect: Immediately


Maximum number of concurrent connections to connect to any of the HTTP servers.

http.proxy-auto-config-file

Section: gms
Default Value: No default value
Valid Values: Any valid URL
Changes Take Effect: Immediately


Specifies the proxy auto-config (PAC) file location. For example:

  • file:///C:/GMS/proxy.pacfor a local file
  • http://127.0.0.1:8082/deploy/proxy.pac

http.proxy-cache-size

Section: gms
Default Value: 32
Valid Values: Any integer
Changes Take Effect: Immediately


Size of the cache that stores URLs that were already processed. If the requested URL is in the cache, GMS will not process the PAC file.

http.proxy-ttl

Section: gms
Default Value: 5
Valid Values: Any integer
Changes Take Effect: Immediately


Specifies the interval to refresh PAC content.

No results

http.ssl_trust_all

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


Enables GMS internode communication.

http.use_lax_redirect_strategy

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


Instructs GMS to use the Lax Redirect Strategy implementation that automatically redirects all HEAD, GET, and POST requests. This strategy relaxes restrictions on automatic redirection of POST methods imposed by the HTTP specification.

[lab] Section

disable-additional-columns-from-callbacks

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


If true, disables the display of additional callback columns that provide custom parameter values.

Starting in 8.5.114.09, this option was moved to the features section.

disable-bulk-cancel-and-export-callback

Section: lab
Default Value: false
Valid Values: true, false
Changes Take Effect: Immediately
Introduced: 8.5.111.04
Discontinued: 8.5.114.07

If true, disables the bulk export of cancelled Callback records in the Callback UI.

Starting in 8.5.114.09, this option was moved to the features section.

enable-bulk-cancel-and-export-callback

Section: lab
Default Value: false
Valid Values: true, false
Changes Take Effect: Immediately
Introduced: 8.5.110.07
Discontinued: 8.5.111.04

Enables the bulk export of cancelled Callback records in the Callback UI.

In 8.5.111.04, this option was renamed disable-bulk-cancel-and-export-callback.

[log] Section

According to your application and your needs, you can activate the following additional logs for your GMS application. By default, all these log options are set to false.

all

Section: log
Default Value:

Valid Values:
  • stdout Log events are sent to the Standard output (stdout).
  • stderr Log events are sent to the Standard error output (stderr).
  • network Log events are sent to Message Server, which can reside anywhere on the network. Message Server stores the log events in the Log Database. Setting the all log level option to the network output enables an application to send log events of the Standard, Interaction, and Trace levels to Message Server. Debug-level log events are neither sent to Message Server nor stored in the Log Database.
  • memory Log events are sent to the memory output on the local disk. This is the safest output in terms of the application performance.
  • [filename] Log events are stored in a file with the specified name. If a path is not specified, the file is created in the application's working directory.
    Changes Take Effect: Immediately.
    Specifies the outputs to which an application sends all log events. The log output types must be separated by a comma when more than one output is configured.
  • buffering

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


    True to turn operating system file buffering on. This option applies only to stderr and stdout output. Setting this option to true increases output performance. Note: When you enable buffering, messages may appear at the console with delay.

    CallbackService

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


    Enables log for Callback Service.

    ChatService

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


    Enables log for Chat Service.

    ClusterService

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


    Enables log for Cluster Service.

    consistency-errors-suppress

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


    Disables consistency level message errors when down to 1.

    CoreService

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


    Enables log for options at startup.

    DataDepotService

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


    Enables log for DataDepot Service.

    debug

    Section: log
    Default Value: stdout

    Valid Values:
  • stdout Log events are sent to the Standard output (stdout).
  • stderr Log events are sent to the Standard error output (stderr).
  • network Log events are sent to Message Server, which can reside anywhere on the network. Message Server stores the log events in the Log Database. Setting the all log level option to the network output enables an application to send log events of the Standard, Interaction, and Trace levels to Message Server. Debug-level log events are neither sent to Message Server nor stored in the Log Database.
  • memory Log events are sent to the memory output on the local disk. This is the safest output in terms of the application performance.
  • [filename] Log events are stored in a file with the specified name. If a path is not specified, the file is created in the application's working directory.
    Changes Take Effect: Immediately.
    Specifies the outputs to which an application sends the log events of the Debug level and higher (that is, log events of the Standard, Interaction, Trace, and Debug levels). The log output types must be separated by a comma when more than one output is configured.
  • DistributedJobExecutor

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


    Enables log for job engine executor.

    DistributedJobQueue

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


    Enables log for job engine queue.

    expire

    Section: log
    Default Value: 20

    Valid Values:
  • false No expiration; all generated segments are stored.
  • [number] file or [number] Sets the maximum number of log files to store. Specify a number from 1-100.
  • [number] day Sets the maximum number of days before log files are deleted. Specify a number from 1-100.
    Changes Take Effect: Immediately.
    Determines whether log files expire. If they do, sets the measurement for determining when they expire, along with the maximum number of files (segments) or days before the files are removed.
  • NotificationService

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


    Enables log for Notification Service.

    OrsService

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


    Enables log for ORS Service.

    segment

    Section: log
    Default Value: 10000

    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 a log file. If there is, sets the mode of measurement, along with the maximum size. If the current log segment exceeds the size set by this option, the file is closed and a new one is created.
  • ServicesService

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


    Enables log for Services.

    SharedService

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


    Enables log for Shared Service.

    standard

    Section: log
    Default Value: stdout

    Valid Values:
  • stdout Log events are sent to the Standard output (stdout).
  • stderr Log events are sent to the Standard error output (stderr).
  • network Log events are sent to Message Server, which can reside anywhere on the network. Message Server stores the log events in the Log Database. Setting the all log level option to the network output enables an application to send log events of the Standard, Interaction, and Trace levels to Message Server. Debug-level log events are neither sent to Message Server nor stored in the Log Database.
  • memory Log events are sent to the memory output on the local disk. This is the safest output in terms of the application performance.
  • [filename] Log events are stored in a file with the specified name. If a path is not specified, the file is created in the application's working directory.
    Changes Take Effect: Immediately.
    Specifies the outputs to which an application sends the log events of the Standard level. The log output types must be separated by a comma when more than one output is configured.
  • StatisticService

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


    Enables log for statistics.

    SubscriptionService

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


    Enables log for Subscription Service.

    trace

    Section: log
    Default Value: stdout

    Valid Values:
  • stdout Log events are sent to the Standard output (stdout).
  • stderr Log events are sent to the Standard error output (stderr).
  • network Log events are sent to Message Server, which can reside anywhere on the network. Message Server stores the log events in the Log Database. Setting the all log level option to the network output enables an application to send log events of the Standard, Interaction, and Trace levels to Message Server. Debug-level log events are neither sent to Message Server nor stored in the Log Database.
  • memory Log events are sent to the memory output on the local disk. This is the safest output in terms of the application performance.
  • [filename] Log events are stored in a file with the specified name. If a path is not specified, the file is created in the application's working directory.
    Changes Take Effect: Immediately.
    Specifies the outputs to which an application sends the log events of the Trace level and higher (that is, log events of the Standard, Interaction, and Trace levels). The log outputs must be separated by a comma when more than one output is configured.
  • UrsService

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


    Enables log for URS Service.

    verbose

    Section: log
    Default Value: standard

    Valid Values:
  • all All log events (that is, log events of the Standard, Trace, Interaction, and Debug levels) are generated.
  • debug The same as all.
  • trace Log events of the Trace level and higher (that is, log events of the Standard, Interaction, and Trace levels) are generated, but log events of the Debug level are not generated.
  • interaction Log events of the Interaction level and higher (that is, log events of the Standard and Interaction levels) are generated, but log events of the Trace and Debug levels are not generated.
  • standard Log events of the Standard level are generated, but log events of the Interaction, Trace, and Debug levels are not generated.
  • none No output is produced.
    Changes Take Effect: Immediately.
    Determines whether a log output is created. If it is, specifies the minimum level of log events generated. The log events levels, starting with the highest-priority level, are Standard, Interaction, Trace, and Debug.
  • For example:

    [log]
    ChatService=false
    ClusterService=false
    DataDepotService=false
    DistributedJobExecutor=false
    DistributedJobQueue=false
    SharedService=false
    [callback]
    log-background-activity=false


    [log-filter] and [log-filter-data] Section

    These sections enable to hide selected attached data in Logs. See Hiding Selected Data in Logs for details and examples about filters.

    • Changes take effect: Immediately.
    Option Default Description
    <KV-List-key>
    Optional
    N/A Describes the filter to hide parts or the totality of the associated string values in the logs.
    • copy
    • hide
    • hide-first,<n>
    • hide-last,<n>
    • unhide-first,<n>
    • unhide-last,<n>
    • skip
    • tag (*)
    • tag() (*)
    • tag(,) (*)
    • tag(<custom_prefix>, <custom_postfix>); for instance tag(!!!,!!!)

    (*) use default system prefix/postfix <# #>

    Important
    Passwords are automatically hidden in GMS logs.

    [notification] Section

    unsubscribe-delay

    Section: notification
    Default Value: 0
    Valid Values: Any positive integer
    Changes Take Effect: Immediately
    Introduced: 8.5.109.05

    Time in seconds to wait for deleting notification subscriptions. In scenarios where the publish notification and the delete subscription requests are received concurrently, the subscription may be deleted before the notification gets published. If you set this option to a value greater than 0, you will force GMS to wait for the specified duration before deleting the subscription and this will allow the pending push notifications to be sent out.

    [ors] Section

    Modified in 8.5.107

    _ors_lb_strategy

    Section: ors
    Default Value: circular
    Valid Values: circular, linear
    Changes Take Effect: After restart


    Added in: 8.5.107
    Strategy for ORS added to the Connections tab of the GMS application.

    enable_ors_loadbalancer

    Section: ors
    Default Value: true since 8.5.107; false previously
    Valid Values: true, false
    Changes Take Effect: After restart


    Enables GMS to send request to the /hearbeat URI of ORS to check availability.

    max_ors_idle_connection_time

    Section: ors
    Default Value: 3600
    Valid Values: Any integer
    Changes Take Effect: After restart


    Added in: 8.5.107
    Maximum idle time (seconds) for an ORS connection before this connection will be deleted from the load-balancer cache.

    ors_loadbalancer_refresh_rate

    Section: ors
    Default Value: 45000
    Valid Values: Integer>=30000
    Changes Take Effect: After restart


    Refresh rate of the ORS Load balancer in milliseconds. This option value must be greater than or equal to 30,000 (30 seconds). By default, all ORS URL values are checked every 45 seconds.

    [port_restrictions] Section

    You can control port access to GMS APIs by adding a port_restrictions section in the Options tab of GMS configuration, at the node level or cluster level. This section is optional and not defined in the default template. The content of this section is a list of key/values, where key is an URI pattern (/genesys/1/storage/*, /genesys/1/service/*, /genesys/1/service/request-interaction, and so on), and the value is a list of ports or a port range.


    Example [port_restrictions] section:

    Option Name Option Value Description
    /genesys/1/storage* 80-90 Storage API will be accessible from port 80 to port 90.
    /genesys/1/service/* 92-98,100 Services API will be accessible from port 92 to port 98, plus the port 100.
    Important
    • There are no default values or default option names. You can define various URL patterns; such as /genesys/1/resource*, /genesys/1/resource*, /genesys/1/service/*, /genesys/1/service/request-interaction, and so on.
    • If the request is sent on another port, an HTTP error 403 Forbidden occurs.
    • The Admin UI and APIs not listed in the port_restrictions section will be available on all ports listed in the port_restrictions section.

    See Restricting Ports for further information about these configuration options. Changes in this section require an update to the jetty-http.xml file on all GMS nodes, and then restarting GMS.

    [push] Section

    Changes take effect: After restart.

    The push configuration includes three logical groups of options: general configuration, push provider configuration, and OS-specific message formatting. For more information about providers and OS-specific message formatting refer to Genesys Mobile Services Push Notification Service.

    It is possible for some mandatory options to be absent in this section. In this case, the corresponding push type will be disabled (even if enabled using the push.pushEnabled option) and a log entry will be created.

    Important
    For security reasons, if you wish to hide some private keys that are specific to the notification mechanism, you can define sensitive options in a dedicated section.

    Common Notification Options

    customhttp.url

    Section: push
    Default Value:
    Valid Values: Any valid URL
    Changes Take Effect: After restart


    Mandatory URL where the notifications will be pushed. The subscriber must provide a URL that will be invoked. GMS posts the payload to this URL (using HTTP POST). The Payload is a JSON object that contains two properties: the deviceId, which is the custom id provided at subscription time by the subscriber, and the message, which is the notification message.

    This option describes the provider configuration used for accessing the target (APPLE APNS service, HTTP address).

    defaultSubscriptionExpiration

    Section: push
    Default Value:
    Valid Values: Any integer (>=30)
    Changes Take Effect: After restart


    Default subscription expiration (in seconds). If the option is not set or if you assign an incorrect value, the default value (30) will be used.

    filtering_chat_events

    Section: push
    Default Value: Notice.TypingStarted,Notice.TypingStopped
    Valid Values:
    Changes Take Effect: After restart


    Comma-separated list of the following events:

    • Notice.TypingStarted
    • Notice.TypingStopped
    • Notice.Joined
    • Notice.Left
    • Notice.PushUrl
    • Notice.Custom
    • Message.Text

    A comma-delimited list that sets the default value for the _filtering_chat_events service parameter. By default, this list is set to "Notice.TypingStarted,Notice.TypingStopped".

    pushEnabled

    Section: push
    Default Value: No default value
    Valid Values: android, gcm, ios, httpcb, orscb, customhttp, fcm
    Changes Take Effect: After restart.
    Modified: 8.5.112.05

    A comma-delimited list of strings that describe the enabled push types. Currently, the following push types are supported:

    • android
    • gcm
    • ios
    • httpcb
    • orscb
    • customhttp
    • fcm (starting in 8.5.112.05)

    Any other push type will be ignored. If an option value is not set, then it will be handled as empty string option value (that is, push will be disabled for all supported types and the push service will not work).

    httpcb.connection_max_connections_per_route

    Section: push
    Default Value: 20
    Valid Values: Any integer >= 2
    Changes Take Effect: After restart.


    The maximum allowed number of simultaneously opened connections for one route. Default value (used if option not set or incorrect) 20.

    httpcb.connection_timeout

    Section: push
    Default Value: 5
    Valid Values: Any positive integer
    Changes Take Effect: After restart.


    The http connection timeout in seconds. Default value is 5

    httpcb.max_connections_total

    Section: push
    Default Value: 200
    Valid Values: Any integer >= 5
    Changes Take Effect: After restart.


    The maximum allowed total number of simultaneously opened connections. Default value (used if option not set or incorrect) 200

    localizationFileLocation

    Section: push
    Default Value:
    Valid Values:
    Changes Take Effect: After restart.


    Location of the file containing the list of localized messages.

    Apple Notification Options

    Note: Please see the relevant documentation at developer.apple.com for information about OS-Specific message formatting options. Note that if no alert-related options are specified, the alert dictionary entry will not be included in the JSON sent to the Apple device.

    apple.alert

    Section: push
    Default Value: No default value
    Valid Values: Any string
    Changes Take Effect: After restart


    Enables an iOS standard alert and defines the text of this alert with two buttons: Close and View. If the user taps View, the application is launched. If this option is null, the alert property will not be added to the notification.

    apple.alertMessage.action-loc-key

    Section: push
    Default Value:
    Valid Values: Any string
    Changes Take Effect: After restart


    If set (not null), is used as an action-loc-key entry in the alert dictionary (iOS-specific).

    apple.alertMessage.body

    Section: push
    Default Value:
    Valid Values: any String, may be null(=absence of option)
    Changes Take Effect: After restart.


    If set, defines a body entry in the alert dictionary (iOS-specific).

    apple.alertMessage.launch-image

    Section: push
    Default Value:
    Valid Values: Any string
    Changes Take Effect: After restart


    If set, is used as the badge entry in the aps dictionary (iOS-specific).

    apple.alertMessage.loc-argnames

    Section: push
    Default Value:
    Valid Values: Any string
    Changes Take Effect: After restart


    If set (not null), used as a loc-args entry in the alert dictionary (iOS-specific).

    apple.alertMessage.loc-key

    Section: push
    Default Value:
    Valid Values: Any string
    Changes Take Effect: After restart


    If set (not null), used as loc-key entry in the alert dictionary (iOS-specific).

    apple.badge

    Section: push
    Default Value: 0
    Valid Values: any, may be null (=not set)
    Changes Take Effect: After restart.


    If set, number used as badge entry in the aps dictionary (iOS-specific). If this property is absent, any badge number currently shown is removed. If not set, the badge entry will not be part of the push notification.

    apple.content-available

    Section: push
    Default Value:
    Valid Values: Any string
    Changes Take Effect: After restart


    Set this key with a value of 1 to indicate that new content is available and let the remote notification act as a silent notification. This is used to support Newsstand apps and background content downloads. Newsstand apps are guaranteed to be able to receive at least one push with this key per 24-hour window.

    When a silent notification arrives, iOS wakes up your app in the background so that you can get new data from your server or do background information processing. Users aren’t told about the new or changed information that results from a silent notification, but they can find out about it the next time they open your app.

    apple.keystore

    Section: push
    Default Value:
    Valid Values: Valid file path
    Changes Take Effect: After restart.


    keystore location (path to file) for iOS push notifications

    apple.keystorePassword

    Section: push
    Default Value:
    Valid Values: Not null (but may be empty string)
    Changes Take Effect: After restart.


    Password to access keystore. If the password is incorrect, the attempts to push messages will fail with the corresponding log entries.

    apple.sound

    Section: push
    Default Value:
    Valid Values: any String, may be null(=absence of option)
    Changes Take Effect: After restart.


    If set, used as sound entry in the aps dictionary (iOS-specific). Use the name of a sound file in the application bundle. The sound in this file is played as an alert. If the sound file doesn’t exist or you set this value to default, the default alert sound is played. If not set, the corresponding entity will not be added to the notification.

    debug.apple.keystore

    Section: push
    Default Value: No default value
    Valid Values: Valid file path
    Changes Take Effect: After restart


    Keystore location (filepath) for iOS push notifications. This option applies to notifications whose debug value is set to true.

    debug.apple.keystorePassword

    Section: push
    Default Value: No default value
    Valid Values: Not null or empty string
    Changes Take Effect: After restart


    Password to access keystore. If the password is incorrect, the attempts to push messages will fail with the corresponding log entries. This option applies to notifications whose debug value is set to true.

    Android Notification Options

    android.collapseKey

    Section: push
    Default Value:
    Valid Values: not empty
    Changes Take Effect: After restart.


    An arbitrary string that is used to collapse a group of like messages when the device is offline, so that only the last message gets sent to the client. This is intended to avoid sending too many messages to the phone when it comes back online. Note that since there is no guarantee of the order in which messages get sent, the "last" message may not actually be the last message sent by the application server

    android.delayWhileIdle

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


    If included and true, indicates that the message should not be sent immediately if the device is idle. The server will wait for the device to become active (only 1 last message will be delivered to device when it becomes active). Default (if not specified) - false;

    android.gcm.apiKey

    Section: push
    Default Value:
    Valid Values: Valid Google api Key. See Google GCM description.
    Changes Take Effect: After restart.


    Valid Google API Key. See Google CDM description. Please see https://developers.google.com/cloud-messaging/gcm

    android.gcm.retryNumber

    Section: push
    Default Value: 2
    Valid Values: Any integer
    Changes Take Effect: After restart.


    Retry attempts (in case the GCM servers are unavailable).

    android.senderAccountType

    Section: push
    Default Value:
    Valid Values: not null, may be empty
    Changes Take Effect: After restart.


    Specified when initializing c2dm push service

    android.senderEmail

    Section: push
    Default Value: @gmail.com
    Valid Values: valid mail (sender account registered in Google service)
    Changes Take Effect: After restart.


    Valid name of mail account. The notifications will be sent from behalf of this account. After signing up for C2DM, the sender account will be assigned the default quota, which currently corresponds to approximately 200,000 messages per day.

    android.senderPassword

    Section: push
    Default Value:
    Valid Values: valid password of registered account
    Changes Take Effect: After restart.


    Password of account

    android.source

    Section: push
    Default Value:
    Valid Values: not empty
    Changes Take Effect: After restart.


    Specifying when sending push notification service

    android.ssl_trust_all

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


    If included and true, indicates that any SSL certificate provided during establishing https connection to https://www.google.com/accounts/ClientLogin and https://android.apis.google.com/c2dm/send addresses are considered valid, regardless of their presence in keystore/truststore used by environment. Default value - false. Please note that setting this option to true is highly unadvised. The most correct way is to configure the security system to permit the actually received certificates.

    android.unavailability_retry_timeout

    Section: push
    Default Value: 120
    Valid Values: Any positive integer
    Changes Take Effect: After restart.


    This parameter specifies the default timeout (in seconds) to wait before Google C2DM service can be accessed again if the request returned the 503 code (Service unavailable). Please note, that this value is ignored if the 503 response from Google contains valid Retry-After header. Default value for this parameter is 120 (used if value not set or incorrect).

    Firebase Cloud Messaging

    Introduced in: 8.5.112

    Due to recent changes in Google Cloud Messaging, GMS now supports Firebase Cloud Messaging (FCM). To configure Native Push Notification through Firebase Cloud Messaging, you can either specify an apiKey or create a dedicated section to secure passwords (recommended for production environments).

    Development
    [push]
    fcm.apiKey=<serverKey>
    pushEnabled=fcm
    Production
    [push]
    fcm=fcmsection
    pushEnabled=fcm
     
    [fcmsection]
    password=***** (<serverKey>)

    fcm.apiKey

    Section: push
    Default Value: No default value
    Valid Values: String
    Changes Take Effect: After restart
    Introduced: 8.5.112.05

    Valid Firebase Cloud Messaging API key. Refer to the official documentation for further details.

    debug.fcm.apiKey

    Section: push
    Default Value: No default value
    Valid Values: Any string
    Changes Take Effect: After restart
    Introduced: 8.5.114.09

    Valid Firebase Cloud Messaging API key to use if debug=true.

    You can also define title and body messaging for the event received at the provider event level detailed below below.

    fcm.title

    Section: push
    Default Value: No default value
    Valid Values: Any string
    Changes Take Effect: After restart
    Introduced: 8.5.114.09

    Firebase Cloud Messaging title for an event defined at the provider level.

    more...

    fcm.body

    Section: push
    Default Value: No default value
    Valid Values: Any string
    Changes Take Effect: After restart
    Introduced: 8.5.114.09

    Firebase Cloud Messaging body message for an event defined at the provider level.

    more...

    Windows Notification options

    wns.clientSecret

    Section: push
    Default Value:
    Valid Values:
    Changes Take Effect: After restart


    The secret key associated to the application. See Microsoft Official documentation.

    wns.notificationType

    Section: push
    Default Value:
    Valid Values:
    Changes Take Effect: After restart


    Type of notification that GMS will send to the Windows application. This value must match the X-WNS-Type header. For example, you can specify a toast notification by setting this option to wns/toast.

    wns.sid

    Section: push
    Default Value:
    Valid Values:
    Changes Take Effect:


    Unique identifier for your Windows Store app. See Microsoft Official documentation.

    wns.xmlTemplate

    Section: push
    Default Value:
    Valid Values:
    Changes Take Effect: After restart


    XML string that defines the notification. For example, to set up a toast notification, you can set this option to:

    <toast><visual><binding template="ToastText01"><text id="1">bodyText</text></binding></visual></toast>

    push.provider options

    Each provider can contain 2 channels for message sending - production and debug for each target type. The provider-affiliated options enlisted above describe the production channel. For each provider-related option <option-name> the sibling option can be provided with name debug.<option-name>. Such options will describe the provider-specific configuration of debug channel for corresponding target type. The debug channel will be enabled for enabled target type only if all mandatory options will be specified for debug channel. The OS-message formatting options do not have production-debug differentiation.

    push.provider.providername Section

    It is possible to create providers by adding push.provider.providername sections which contain the appropriate credential configuration options that are associated with a given provider. This allows you to control and isolate notifications and events between a given provider and the associated services/applications that are using it. This type of provider name section can only contain provider-related options (as listed in push section). All providers are isolated - if the option is not specified in provider's section, then it is not specified. If a mandatory option is missing then the corresponding target type will not be enabled, even if that type is present in the pushEnabled option.

    Please note that we have the following restriction on providername: it may only contain alphanumeric characters, the underscore (_), and the minus sign (-).

    push.provider.event Section

    You can define the event definitions associated across providers by adding your push.provider.event section, and then setting the appropriate OS-specific attribute options within. This will allow you to add OS-specific attributes to a published event message that is going to any provider’s push notification system. This section can contain OS formatting-related options. All other options will be ignored. For more information about providers and OS-specific message formatting refer to Genesys Mobile Services Push Notification Service.

    push.provider.event.eventname Section

    You can define the events associated across providers by adding a custom push.provider.event.eventname section, and then setting the appropriate OS-specific attribute options within. This will allow you add OS-specific attributes to a published event message that is going to a specific channel for given group of events tags.

    • This section can contain OS formatting-related options.
    • All other options will be ignored.
    Important
    For more information about providers and OS-specific message formatting, see Push Notification Service.


    For instance, you can create a push.provider.event.chat section to define options for chat events. The following configuration samples show how to configure iOS chat push alert text for chat events.

    Configuring iOS Chat Push Alert Text Without Localization

    1. Edit your GMS application (with Configuration Manager for example) and select the Options tab.
    2. Create a push.provider.event.chat.newagentmessage section.
    3. Click New to set the apple.alert parameter to an accurate value; for instance, New message from Agent.

    Configuring iOS Chat Push Alert Text Using Localization

    1. Edit your GMS application (with Configuration Manager for example) and select the Options tab.
    2. Create a push.provider.event.chat.newagentmessage section.
    3. Click New to set the apple.alertMessage.loc-key parameter to CHAT_NEW_AGENT_MESSAGE.
    4. Click New to set the apple.alertMessage.action-loc-key parameter to ACTION_KEY.
    Important
    CHAT_NEW_AGENT_MESSAGE and ACTION_KEY are keys to lookup the string values for the current language in the Localizable.strings resource of the iOS application. See also the official Apple documentation about Localized Formatted Strings.

    push.provider.providername.event.eventname Section

    You can define the event definitions associated with given provider by adding your push.provider.providername.event.eventname section, and then setting the appropriate OS-specific attribute options within. This will allow you add OS-specific attributes to a published event message that is going to a specific provider and channel for given group of events tags. This section can contain OS formatting-related options. All other options will be ignored. For more information about providers and OS-specific message formatting refer to Genesys Mobile Services Push Notification Service.

    [pulse] Section

    version

    Section: pulse
    Default Value: 2
    Valid Values: 1 or 2
    Changes Take Effect: Immediately
    Introduced: 8.5.103
    Modified: 8.5.110.07

    Enables version 2 of Pulse Dashboards starting in 8.5.103.

    Starting in 8.5.110, 2 is the default value for this option.

    (modified in 8.5.110)

    enabled

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


    If true, enables the Pulse feature in Context Services.

    No results

    password

    Section: pulse
    Default Value: No default value
    Valid Values: String
    Changes Take Effect: Immediately


    Password of the user who has pulse authorizations.

    servers

    Section: pulse
    Default Value:
    Valid Values: String
    Changes Take Effect: Immediately


    A list of one or more URLs separated by semicolons which point to Pulse applications for the Value; for instance: http://gax1dev:8283/gax;http://gax2dev:8283/gax.

    [reporting] Section

    This section activates URS reporting for the Stat Service API. See URS Stat Request for details.

    _urs_url

    Section: reporting
    Default Value:
    Valid Values:
    Changes Take Effect: Immediately


    URS URL or comma-separated list of URS URLs if the enable_urs_loadbalancer option is true. For example: http://host#1:7311,http://host#2:7311,http://host#3:7311
    GMS uses this list to query URS statistics.

    enable_urs_loadbalancer

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


    Set to true to enable multiple URS URLs in the _urs_url option.

    max_urs_idle_connection_time

    Section: reporting
    Default Value: 3600
    Valid Values: Any integer
    Changes Take Effect: Immediately


    Maximum idle time in seconds of an URS URL before GMS removes it from the list of available URLs.

    max_urs_request_attempts

    Section: reporting
    Default Value: 3
    Valid Values: Any integer
    Changes Take Effect: Immediately


    Maximum number of attempts to submit requests to URS.

    startup-statistics

    Section: reporting
    Default Value:
    Valid Values:
    Changes Take Effect: Immediately


    Comma-separated list of suffixes from the stat.<statname> section. This option lists one or more Stat Server statistics to be opened at Genesys Mobile Services startup.

    urs_heatbeat_url

    Section: reporting
    Default Value: /urs/console?x
    Valid Values: String
    Changes Take Effect: Immediately


    Path to add to the URS URL in order to check the healthiness of the underlying URS.

    urs_loadbalancer_refresh_rate

    Section: reporting
    Default Value: 45000
    Valid Values: Integer >= 30000
    Changes Take Effect: Immediately


    URS load balancer refresh rate (in milliseconds). This option value must be greater than 30000 (30 seconds) to check all the URS URLs' status using the urs_heatbeat_url path. By default, GMS will check every 45 seconds.

    [resources] Section

    patterns_list_name

    Section: resources
    Default Value: GMS_Patterns
    Valid Values: Valid CME name for List object
    Changes Take Effect: Immediately upon notification.


    Name of the Strategy configuration object (with type List), which holds the configuration of patterns and pattern groups.

    resources_list_name

    Section: resources
    Default Value: GMS_Resources
    Valid Values: Valid CME name for List object
    Changes Take Effect: Immediately upon notification.


    Name of the Strategy configuration object (with type List), which holds the configuration of resources and resource groups.

    user_control

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


    This option enables GMS to control resource access based on the gms_user header passed in the GMS request. This option is dynamic.

    List Object Options

    Each section in the Annex is a group that should have distinct list options specified. Changes take effect: Immediately.

    Option Default Description
    _allocation_strategy
    RANDOM, LOCAL, CLUSTER
    Optional
    RANDOM Supported strategies:
    • RANDOM—Allocate a randomly selected resource from the group. No reservations or locks are made, so the same resource can be selected by different users at the same time.
    • LOCAL—A resource is allocated from the group and reserved/locked, so that only one user can hold it at the time. For the resource to return to the group it should be released either by the corresponding API call or by a timeout.
    • CLUSTER—A resource is allocated from the group and reserved/locked through the GSG cluster, so that only one user can hold it at the time. For the resource to return to the group it should be released either by the corresponding API call or by a timeout.
    _booking_expiration_timeout
    Integer (s)
    Optional
    30 Determines the maximum amount of time, in seconds, that a resource may be allocated. If the resource is not released before this time limit elapses, it is automatically returned to the pool of available resources. This option is used with the LOCAL and CLUSTER allocation strategies.
    _backup_resource
    String
    Optional
    String The resource returned if there are no regular resources available. This option is used with the LOCAL and CLUSTER allocation strategies.

    List Entries

    Changes take effect: Immediately.

    Option Default Description
    All keys not starting with # or _
    String
    Optional
    N/A The value is put into the pool of resources. The option name may be anything (since that value is not currently used).

    The following screenshot shows an example of an application object configured in Configuration Manager.

    Gsg list.png

    Example

    [Dnis_Pool]
     _allocation_strategy = LOCAL
     _booking_expiration_timeout = 20
     dnis1 = 1-888-call-me1
     dnis2 = 1-888-call-me2
     dnis3 = 1-888-call-me3

    Note: For testing purposes, Genesys recommends that you include at least three numbers in the pool. If only a single number is defined in the pool, when the API call is made, that number is allocated for 30 seconds (default). If another API call is made before the number is returned to the pool, an error will occur. Alternatively, if using a single number, use _allocation_strategy = RANDOM.


    [server] Section

    Modified in 8.5.107

    _ors

    Section: server
    Default Value:
    Valid Values:
    Changes Take Effect: Immediately


    Comma-separated list of ORS URLs.

    http://host1:port1,http://host2:port2

    This list will be used for all services sections and can be overridden in each service.

    _ors_lb_strategy

    Section: server
    Default Value: circular
    Valid Values: circular, linear
    Changes Take Effect: Immediately


    Strategy for the ORS load balancer in the server section and service sections; this value can be overridden in each service. Supported values are: circular or linear.

    access_code_prefix

    Section: server
    Default Value:
    Valid Values: Any integer
    Changes Take Effect: Immediately


    This value is a range of access_code; the value must be unique for each GMS node across the cluster. GMS will randomly choose within this range the access_code_prefix that it will associate as the prefix for access_code. If the option is not present, GMS will use the nodeId value instead. An example range is 455,456-458 where the prefix can be 455, 456, 457, or 458.

    dateFormat

    Section: server
    Default Value:
    Valid Values:
    Changes Take Effect: Immediately


    The string used to format dates. The string syntax should match the expectations of the java class java.text.SimpleDateFormat. See Simple Date Format for details.

    external_url_base

    Section: server
    Default Value:
    Valid Values: Valid host name.
    Changes Take Effect: Immediately


    Specifies the external url used by the Storage Service to allow the retrieval of a binary attachment. This is useful in the case of a Load Balancer deployment. The valid value is http://<web_host>:<web_port>/, where web_host is used by the cluster service to identify a node; and where web_port is used by the cluster service to identify a node. The web_port value must be the same as the GMS port described in the jetty configuration file, otherwise an alarm will be displayed in Solution Control Interface (SCI) and GMS will stop.

    gsgadmin_redirect

    Section: server
    Default Value: default
    Valid Values:
    Changes Take Effect: Immediately


    Configures the host and port to use in the redirection message that is sent by GSG Admin upon logout process. In a load balancing deployment, you should set up this option to make sure that GMS redirects to the Load Balancer address instead of the local GMS.
    The possible values for this option are the following:

    • default—Redirects to the local GMS instance (default behavior).
    • external_url_base—Uses the value of external_url_base for the redirection.
    • <host>:<port>—Specifies another URL to use for the redirection.

    Limitation: Internet Explorer may not correctly depict the port redirection set in external_url_base.

    max-sessions

    Section: server
    Default Value: 9999
    Valid Values: Any integer
    Changes Take Effect: Immediately


    Maximum number of concurrent sessions for the Service Management UI.

    node_id

    Section: server
    Default Value: 1
    Valid Values:
    Changes Take Effect:


    Specifies a two digit number that should be unique in the GMS deployment. It is used in the generation of DTMF access tokens.

    Cluster Service options

    app_name

    Section: server
    Default Value:
    Valid Values: Any valid URL
    Changes Take Effect: Immediately


    Web application "context" path.

    web_host

    Section: server
    Default Value: Result of InetAddress.getLocalHost()
    Valid Values: Valid host name
    Changes Take Effect: Immediately


    The default InetAddress.getLocalHost() value will be used in the most cases. Change this configuration value if you have issues obtaining the local name when your environment has multiple network interfaces. In this scenario, to ensure GMS internode communication, set this option's value to the IP Address used by the Jetty interface (which is not configurable).

    This option is required for internode communication.

    web_port

    Section: server
    Default Value: 80
    Valid Values: Valid TCP port; for HTTPS internode communication, 8443 or check either your jetty configuration or restriction port
    Changes Take Effect: Immediately


    Sets a port different from the port that GMS uses. Note: GMS uses port 8080, which can be changed in the jetty-http.xml file. This option can be used in the case of proxy role of the customer to forward requests.

    At startup, GMS checks that a GMS is available on the port specified by web_port. If a GMS is not available, the web_port option alarm (EventId 2002) is thrown.


    Required to ensure the GMS internode communication.

    web_scheme

    Section: server
    Default Value: http
    Valid Values:
    Changes Take Effect: Immediately


    Scheme of the internal URL to https if GMS jetty is configured to support only SSL/TLS for one node or for a cluster of nodes.

    Optional, required for GMS internode communication.

    max-file-upload

    Section: server
    Default Value: 5000000
    Valid Values: Long (bytes)
    Changes Take Effect: Immediately


    Allowed maximum size before uploads are refused.

    • -1 indicates no limit


    Configuration Use Cases for web_host and Admin UI

    In scenarios that involve internode communication, the value of the web_host option can determine the successful display of the GMS nodes status in the Admin UI. Check the examples below and edit this option accordingly.

    Use case Action Comment
    The Configuration Server hosts do not have IP addresses and no DHCP has been setup, or you cannot resolve the hostname for any other reason Set the web_host option to the node's IP address for each GMS node In the Admin UI, the node status will be true but the node_hostipaddress field in the IP address response will be: <not provided>
    The Configuration Server hosts do not have IP addresses and the GMS host includes several network interfaces Set the web_host option to the node's IP address for each GMS node In the Admin UI, the node status will be true but the node_hostipaddress field in the IP address response will contain the IP address of another network interface of the host.
    The Configuration Server hosts have IP addresses N/A In the Admin UI, the node status will be true and the node_hostipaddress field in the IP address response will contain the correct IP address.

    [service.servicename] Section

    You can create customized services by adding your service.servicename section, and then setting the appropriate options within. Additional options vary depending on the type of service being created. For more information, refer to documentation for the corresponding service in the Genesys Mobile Services API Reference.

    For a list of the available options, refer to the Service option reference page.


    [stat.statname] Section

    This section defines Stat Server statistics that can be opened at startup by listing them in the [reporting] startup-statistics configuration option. You can also subscribe to these statistics using the Stat Service API. In either case, Genesys Mobile Services will initialize the statistics, start collecting the data from Stat Server, and place that data in the GMS cache.

    Please note that:

    • The cache is global and common to all GMS instances.
    • The statistics that are not used are removed and closed by a scheduled function every 10 minutes.

    filter

    Section: stat.statname
    Default Value: No default value
    Valid Values: Any string
    Changes Take Effect: After restart


    The business attribute value to use to filter the results.

    metric

    Section: stat.statname
    Default Value: No default value
    Valid Values: Any string
    Changes Take Effect: After restart


    The name of the metric, for example, TotalLoginTime. This option defines a Stat Server statistic that can be opened at startup by listing it in the [reporting] startup-statistics configuration option.

    notificationMode

    Section: stat.statname
    Default Value: No default value
    Valid Values: NoNotification, Reset, or Immediate
    Changes Take Effect: After restart


    Notification mode. Mandatory.

    objectId

    Section: stat.statname
    Default Value: No default value
    Valid Values: Any string
    Changes Take Effect: After restart


    Statistic object ID.

    objectType

    Section: stat.statname
    Default Value: No default value
    Valid Values: Any string
    Changes Take Effect: After restart


    Statistic object type; for example, Agent.

    tenant

    Section: stat.statname
    Default Value: No default value
    Valid Values: Any string
    Changes Take Effect: After restart


    Tenant name; for example, Environment.

    tenantPassword

    Section: stat.statname
    Default Value: No default value
    Valid Values: Any string
    Changes Take Effect: After restart


    Tenant password.

    Example

    [reporting]
    startup-statistics=stat1,stat2
     
    [stat.stat1]
    metric=TotalLoginTime
    notificationMode=NoNotification
    objectId=KSippola
    objectType=Agent
    tenant=Environment
    filter=Bronze
     
    [stat.stat2]
    metric=ExpectedWaitTime
    notificationMode=NoNotification
    objectId=9002@SIP_Switch
    objectType=Queue
    tenant=Environment


    [urs] Section

    Introduced in 8.5.107

    _urs_lb_strategy

    Section: urs
    Default Value: linear
    Valid Values: linear, circular
    Changes Take Effect: After restart
    Introduced: 8.5.107.15

    Strategy for URS added to the Connections tab of the GMS application.

    This page was last modified on December 20, 2017, at 10:13.

    Feedback

    Comment on this article:

    blog comments powered by Disqus