Cloud Configuration

The following sections provide configuration details and initialization examples for Workspace Web Edition & Web Services deployed in Cloud mode.

Configuring Workspace Web Edition & Web Services

Workspace Web Edition & Web Services reads a series of configuration files from the location defined by the config.path system property. When starting Workspace Web Edition & Web Services, the config.path property must be defined or the server will fail to start. On the standard Workspace Web Edition & Web Services voice machine, this property is set in the startup script in /etc/init.d and points to /opt/jetty/genconfig. It is also commonly set using -Dconfig.path=<location>.

Start of Procedure
As described below, modify (or remove) each of the following Workspace Web Edition & Web Services configuration files:

• server-settings.yaml
• onpremise-settings.yaml
• cassandra-cluster.yaml

The guidance provided here is specific to deployment of Workspace Web Edition & Web Services in Cloud mode. For a more general description of available Workspace Web Edition & Web Services configuration options, please see the options reference.

1. In the server-settings.yaml, review the options and modify or retain as as appropriate for the deployment. This file contains a number of core parameters used by the server.

The following is an unmodified file:


:externalApiUrl: [ToBeChanged: "PUBLIC_SCHEMA_HOST_PORT"]/api/v1
internalApiUrl: [ToBeChanged: "INTERNAL_SCHEMA_HOST_PORT"]/api/v1
externalApiUrlV2: [ToBeChanged: "PUBLIC_SCHEMA_HOST_PORT"]/api/v2
internalApiUrlV2: [ToBeChanged: "INTERNAL_SCHEMA_HOST_PORT"]/api/v2
reconnectAttempts: [ToBeChanged: "RECONNECT_ATTEMPTS"]
reconnectTimeout: [ToBeChanged: "RECONNECT_TIMEOUT"]
activationTimeout: [ToBeChanged: "ACTIVATION_TIMEOUT"]
contactCenterSynchronizationTimeout: 60000
opsUserName: [ToBeChanged: "OPS_USER_NAME"]
opsUserPassword: [ToBeChanged: "OPS_USER_PASSWORD"]
applicationName: [ToBeChanged: "APPLICATION_NAME"]
applicationType: [ToBeChanged: "APPLICATION_TYPE"]
cmeUserName: [ToBeChanged: "CME_USER_NAME"]
cmePassword: [ToBeChanged: "CME_PASSWORD"]
syncNode: [ToBeChanged: true|false]
cmeAuthenticationEnabled: [ToBeChanged: true|false]
nodeId: [ToBeChanged: unique id of the node]

The following is a modified sample file:

externalApiUrl: http://hpe-voicevm-84.genesyslab.com/api/v1
internalApiUrl: http://hpe-voicevm-84.genesyslab.com/api/v1
externalApiUrlV2: http://hpe-voicevm-84.genesyslab.com/api/v2
internalApiUrlV2: http://hpe-voicevm-84.genesyslab.com/api/v2
reconnectAttempts: 1
reconnectTimeout: 10000
activationTimeout: 120000
contactCenterSynchronizationTimeout: 60000
opsUserName: ops
opsUserPassword: ops
applicationName: Cloud
applicationType: CFGGenericClient
cmeUserName: default
cmePassword: password
syncNode: true
nodeId: hpe-voicevm-84

2. Remove onpremise-settings.yaml This configuration file is not applicable to Cloud mode deployments and must be removed to ensure proper behavior of the server.
3. Review cassandra-cluster.yaml. The options settings are as follows:

thrift_port: 9160
jmx_port: 7199
keyspace: sipfs
nodes: hpe-voicevm-84.genesyslab.com
should_sync_schema: TRUE
write_consistency_level: CL_ONE
read_consistency_level: CL_ONE
max_conns_per_host: 16
max_cons:  16
max_pending_conns_per_host: 80
max_blocked_threads_per_host: 160
retry_sleep_time_ms: 5000
retry_max_attempt: 1
#replication_factor: 1

4. For a single-node Cassandra cluster, confirm that write_consistency_level and read_consistency_level are CL_ONE, and replication_factor are 1, as shown above.
5. For a multi-node Cassandra cluster, set write_consistency_level and read_consistency_level to CL_QUORUM and replication_factor to 3.
6. If desired, specify retry_sleep_time_ms and retry_max_attempt, which define the GWS retry policy as a Cassandra client. These parameters are optional. If not specified, the retry_max_attempt is 1 and retry_sleep_time_ms is 5000 (which equals 5 seconds).

End of Procedure

Workspace Web Edition & Web Services Sync Node

To facilitate administration using standard Genesys tools such and Configuration Manager and Genesys Administator, Workspace Web Edition & Web Services can optionally examine the contents of the Configuration Database, import objects into Workspace Web Edition & Web Services, and subscribe to change notifications from Configuration Server.

In a multi-node Workspace Web Edition & Web Services deployment, only a single node should be configured with this responsibility. The syncNode option in server-settings.yaml is used to control this functionality. The Workspace Web Edition & Web Services node that performa synchronization tasks should be configured with syncNode set to true, and all the other Workspace Web Edition & Web Services nodes configured with syncNode set to false.

Reporting Configuration

There are several steps required to allow Workspace Web Edition & Web Services to use, store, and expose statistical data. Workspace Web Edition & Web Services uses several statistics internally to support contact availability and also provides a default set of statistics used by the bundled client applications.

The steps below include the configuration of Workspace Web Edition & Web Services node, Statistics Time-to-Live, Stat Server, and Contact Center Stat Server host and port.

Start of Procedure

1. Open server-settings.yaml file.
2. Configure the Workspace Web Edition & Web Services node by setting the nodeId property. The value of this option must be a unique identifier for the Workspace Web Edition & Web Services node.
   Each Workspace Web Edition & Web Services node in a cluster must define a unique nodeId. All Workspace Web Edition & Web Services nodes that share the same Cassandra storage will read the contact centers that require statistic and divide the monitoring tasks among the Workspace Web Edition & Web Services nodes.
3. In the same file, configure the Statistics Time-to-Live by doing the following:
   1. Define the "time-to-live" for statistic storage using the statisticsTTL property. If you do not define this optional parameter, the default value of 86400 (24 hours) will be used.
   2. Confirm that the statistics.yaml is present in the main Workspace Web Edition & Web Services config folder (defined by the config.path variable, /opt/jetty/genconfig, by default on the ubuntu voice machine). Modifications to this file are not typically necessary.
      The statistics.yaml file defines which statistics, and for what object types, Workspace Web Edition & Web Services will request from StatServer. A default statistics.yaml file is included with the Workspace Web Edition & Web Services distribution and contains all the statistics Workspace Web Edition & Web Services needs internally as well as those required by the bundled UI applications.
4. Configure any Stat Server applications in Genesys environment(s) to which the Workspace Web Edition & Web Services node/cluster will connect such that they include a set of statistic definitions that match those included in statistics.yaml. You must do this for both the primary and backup Stat Server in each Genesys environment that will be accessed by Workspace Web Edition & Web Services.
   HOW WILL THIS SAMPLE BE PROVIDED: A sample StatServer configuration can be found in the following option export. This file can be copied locally and imported using Configuration Manager or Genesys Administrator for both the primary and backup Stat Servers.
5. When you are creating contact centers through the ops API, configure the host and port for the primary and back up Stat Server. See the Contact Center Initialization Samples for more details. Each example includes primary and backup StatServer information.

End of Procedure