Jump to: navigation, search

server Section



     


_ors

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

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

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.

allow-file-control

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


True to enable the file upload control for the GMS Storage. Configure the list of supported mime files in the allowed-mime-types option. For additional details, refer to the GMS Storage API.

allowed-mime-types

Default Value: Empty
Valid Values: String
Changes Take Effect: Immediately


Comma-separated list of mime types that GMS allows for storage. Refer to IANA Media Type Reference for a detailed list of possible mime types.

app_name

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


Web application "context" path.

config-fast-loading

Default Value: true
Valid Values: true, false
Changes Take Effect: After restart
Introduced: 8.5.209.00
Modified: 8.5.220.06

If true, GMS loads Routing Point objects only at startup and discards further heavy loading operations to improve performances. If false, GMS loads in cache additional configuration objects retrieved from the Configuration Server; for example, RoutePoint or Agent. Some of these objects are used by the GMS Admin UI panels, but the amount of these objects can overload GMS on update service requests.

dateFormat

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

Default Value:
Valid Values: http://<hostname>:<port>/ or https://<hostname>:<port>/
Changes Take Effect: Immediately


Specifies the external URL used by the Storage Service to allow the retrieval of a binary attachment. Configure this option in the case of a Load Balancer deployment.

The valid value is http://<hostname>:<port>/, where:
  • <hostname> is used by the cluster service to identify a node
  • <port> is used by the cluster service to identify a node.

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

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-file-upload

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


Allowed maximum size before uploads are refused.

  • -1 indicates no limit

max-sessions

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


Maximum number of concurrent sessions for the Service Management UI.

node_id

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.

password

Default Value: No default value
Valid Values: Any string
Changes Take Effect: Immediately


Defines a global password for all services. With this option, Basic Authentication is turned on for all services. See Basic Authentication for further details.

realm

Default Value: Genesys Application Configuration Needed.
Valid Values: Any string
Changes Take Effect: Immediately


Defines the authentication scheme. See Basic Authentication for further details.

relative_url

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


If true, URLs returned in GMS responses are relative; otherwise, these URLs are absolute.

username

Default Value: No default value
Valid Values: Any string
Changes Take Effect: Immediately


Defines a global username for all services. See Basic Authentication for further details.

Note: Without the password option, no authentication is effective.

web_host

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

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

Default Value: http
Valid Values: http or https
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.

This page was last edited on March 8, 2017, at 14:48.
Comments or questions about this documentation? Contact us for support!