Web Services Setting Groups

This section provides more information about the settings groups that Web Services uses for Genesys Interaction Recording, so that you can maintain these settings groups after deployment. These settings groups are configured using the API.

Screen Recording Storage Settings

Web Services provides location-based storage settings so that the Web Services node can access external storage. The following example shows how to create the storage settings with the properties described in the table below:

POST http://<htcc-cluster-address>/api/v2/settings/screen-recording

{
    "name":"storage",
    "location": "/US/CA/",
    "value":[
        {
            "storageType": "webDAV",
            "active": true,
            "credential": 
            {
                "userName": "user",
                "password": "pass",
                "storagePath": "http://<IP Address>:<Port>/webdav"
            }
        }
    ]
}

Property	Description
storageType	The storage location. Set it to webDAV, to store the recordings on the physical server.
active	Determines whether the storage location is enabled and available to store the recordings. If set to true, the storage location is enabled.
credential	userName—The user that has access to the WebDAV storage location. password—The password for the WebDAV storage location. storagePath—The URL of the WebDAV storage location.

Screen Recording Decrypt Uri Prefix

Web Services defers the decryption process of screen recordings to the Recording Crypto Server. Web Services provides a URI that directs the SpeechMiner application to the Recording Crypto Server for the decrypted screen recording, and for the mediaUri member in a Get Screen Recording Meta-Data response. The following example shows how to create the decryption URI prefix settings. Note that the value must be set to the URL of the Recording Crypto Server instance.

POST http://<htcc-cluster-address>/api/v2/settings/screen-recording

{
    "name":"decrypt-uri-prefix",
    "location": "/US/CA/",
    "value":"https://<IP Address>/rcs"
}

SpeechMiner Settings for MLM Purge

During the call recording purge, Web Services issue the call recording purge request to SpeechMiner for the corresponding records on the SpeechMiner database. The Web Services node that executes the purge, determines the SpeechMiner API URI prefix and the credentials based on the SpeechMiner group setting with the location-based interaction-receiver settings. The following example shows how to create the Interaction Receiver settings with the properties described in the table below:

POST http://<htcc-cluster-address>/api/v2/settings/speechminer

{
    "name":"interaction-receiver",
    "location": "/US/CA",
    "value": {
        "uri-prefix": "http://<IP Address>:<Port>/interactionreceiver",
        "userName": "interaction receiver user name",
        "password": "interaction receiver password"
    }
}

Property	Description
uri-prefix	The URL of the Interaction Receiver server.
userName	The username that is used to access the Interaction Receiver server.
password	The password that is used to access the Interaction Receiver server.

Removing Cross-site Access Restriction

A new setting will be introduced to application.yaml that will control the time to live (TTL) of a regions setting for a location from Cassandra in a cache. A cache is used so that an extra Cassandra access is not introduced for every access of a recording or its metadata for streaming, deleting, etc. The default value for this TTL is 5 minutes, however this implies that after regions settings are modified as described in the above section, this amount of time must pass before it can be assured that all nodes are using the newly introduced settings. For functional testing, this setting should be turned down into the realm of seconds so the tests do not have to wait too long for new settings to take effect.

A setting to application.yaml controls the Time To Live (TTL) of a region's setting, for a location from Cassandra in a cache. The cache prevents additional Cassandra access during every access of a recording or its metadata for streaming, deleting, etc.

Default value 5 minutes, the amount of time allowed for all nodes to adopt the new settings. To speed up functional testing, turn down this setting to a few seconds.

The following is how the setting looks in application.yaml:

serverSettings:
.
.
.
  recordingSettings:
    .
    .
    .
    regionsSettingsCacheSecondsTTL: 300