WFM Server Restricted Options
This page includes information about hidden options in the following configuration sections:
elasticsearch-sdr0 Section
client
Default Value: None
Valid Values: off or any valid location of the cluster node(s) of the Elasticsearch cluster, properly formatted
Changes Take Effect: On the next ETL cycle
Dependencies: None
Introduced: 8.5.001.09
Modified: 8.5.009.20 (repurposed for REST API configuration with Elasticsearch version 5.0+)
This option specifies one or more nodes in the Elasticsearch cluster that Genesys Info Mart uses to retrieve data from an Elasticsearch database version 5.0 or higher. Genesys Info Mart uses the REST API client to communicate with the Elasticsearch cluster. You must specify the REST API URL address(es) for the REST client in the following format:
- rest(http://<es-node>:<port>[,http://<es-node>:<port>]*)
Note: The option was originally introduced to retrieve Session Detail Record (SDR) data in deployments with Genesys Designer. Starting with release 8.5.009.20, the option is repurposed for generic Elasticsearch data support using the REST API client.
cluster.name
Default Value: elasticsearch
Valid Values: Any valid name
Changes Take Effect: On the next ETL cycle
Dependencies: None
Introduced: 8.5.001.09
Related Options: client
This option specifies the name of the Elasticsearch cluster from which Genesys Info Mart must retrieve Session Detail Record (SDR) data. Setting the cluster.name option is only necessary if the name of the Elasticsearch cluster is changed from the default, elasticsearch, in the Elasticsearch configuration.
g:tenant-prefix
Default Value: No default value
Valid Values: A string identifying the tenant on a shared Elasticsearch cluster
Changes Take Effect: On the next ETL cycle
Dependencies: None
Introduced: 8.5.011.15
In Genesys Engage cloud deployments, the option defines a cloud tenant prefix for Elasticsearch indexes on an Elasticsearch cluster shared across multiple cloud tenants. The tenant prefix enables Genesys Info Mart to identify Elasticsearch indexes related to the particular cloud tenant.
If specified, the option value overrides the index-pattern and index-regexp values from the XML source metadata, and the tenant prefix is included in index pattern and regexp strings.
Example
The following table illustrates the effect of specifying a tenant prefix, where the source type is sdr and the source ID is sdr0.
| [elasticsearch-sdr0].g:tenant-prefix | index-pattern | index-regexp |
|---|---|---|
| Not defined | ‘sdr’-yyyy.MM.dd | sdr-* |
| -my-tenant | ’sdr-my-tenant’-yyyy.MM.dd | sdr-my-tenant-* |