Configuration Options Reference

Important

This page provides descriptions and explanations of Genesys Mobile Services-specific options. Refer to the Genesys Mobile Services Options Reference for a full list of options.

Default Configuration Sections

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

Services Configuration Sections

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

The Services and Tools UI will create these options for you.

[chat] Section

This section configures additional chat parameters for the GMS application.

**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

[config] Section

Added in 8.5.209.02

Options in the config section enable you to manage configuration objects' caching in GMS. By default, only Route Point objects are loaded at startup; other objects are not loaded unless you enable the corresponding option. See the [config] section in the Genesys Mobile Engagement Configuration Options Reference guide for a detailed list of options.

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

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.

[log-hidden-attributes] Section

Introduced: 8.5.200

Use this section to hide selected Genesys internal message attributes in Logs. See Hiding Selected Data in Logs for details.

Changes Take Effect: Immediately

Option	Description
<ProtocolName>.<MessageName>	Comma-separated list of message attributes.
<ProtocolName>.<Complex AttributeName>	Comma-separated list of complex attribute's attributes.

Here is a configuration sample, which hides the content of the chat text from the logs while GMS communicates with the Chat Server:

[log-hidden-attributes]
FlexChat.EventInfo=Text
FlexChat.MessageText=Text
FlexChat.NoticeText=Text

[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
Discontinued: 8.5.219.03

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

You can use the HTTPS scheme without adding the server certificate if you configure the http.ssl_trust_all option to true in the [gms] section.

If you do not use the http.ssl_trust_all option, add the server certificate to the Java cacerts.

For example, in a Linux platform:

keytool -import -alias genesys -keystore /etc/pki/java/cacerts -file /security/custom_https_server_certificate.crt -noprompt -storepass changeit

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: comet
Valid Values: android, gcm, ios, httpcb, orscb, customhttp, fcm,comet
Changes Take Effect: After restart.
Modified: 8.5.113.10, 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)
comet (starting in 8.5.103.10)

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

Note: Starting in 8.5.103.10, this option requires the default value (comet) even if you do not enable push notifications. If you enable push notifications, use one of the above valid values.

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.