Jump to: navigation, search

Configuration Options

UsersGuide.png Purpose: Lists the configuration options that your application can read.

Description

The tables in the following sections present the UCS configuration options that Context Services can read from the Configuration Layer:

  • cview section—Options and values specific to Context Services.
  • archiving section—Activates set-based archiving.
  • authentication section—Enables and configures authentication control.
  • business-attributes section—Maps Context Service keys to Business Attribute key-value pairs.
  • log-filter section—Implements security log filtering.
  • log-filter-data section—Also relates to security log filtering.

You can modify all these option values in the Configuration Manager. However, the change may not be effective immediately. For some options you have to restart UCS for changes to take effect (see the tables below). In Configuration Manager and Genesys Administrator, you can see many options other than those described here. They relate to UCS's functioning in eServices (short description here), and are described in the eServices Reference Manual.

Also, this page describes options that are displayed on the Options tab of the UCS Application object in Configuration Manager and Genesys Administrator. Some options that can be added to the Annex Tab in Configuration Manager, or to Advanced View (Annex) in Genesys Administrator, are described in Using Configuration Options to Schedule Service Pruning.

[cview] Section

This section adjusts the overall configuration of Context Services.

cview Section
Name Restart UCS<ref name="restart">This column indicates whether you must restart UCS for changes in the option value to take effect.</ref> Description
enabled Yes
  • true to enable Context Services functionality in UCS<ref name="ucs">Universal Contact Server</ref>.
  • false (default) to disable Context Services.
port-http
Deprecated since: 8.1.0
 Yes The HTTP port used to deploy UCS/CS (defaults to 8080).
No longer available in 8.1. Releases 8.1 and later configure listening ports on the Server Info tab.
port-https
Deprecated since: 8.1.0
 Yes The HTTPS port used to deploy UCS/CS (defaults to 8083).
Deprecated since: 8.1.0. Releases 8.1 and later configure listening ports on the Server Info tab.
base-url Yes The base URL used to deploy Context Services. Based on this configuration, the services are available at the following URL:
http://${ip-address}:${port}/${base-url}/${operation}

Where:

  • ${ip-address} is the IP address configured below.
  • ${port} is the port on which the web services are deployed (see above).
  • ${base-url} is the base URL used to deploy Context Services.

For example, if the ip-address is 192.168.1.1, the port 8080, and the base URL cms, the Set Server Mode operation would be available at the following URL:

http://192.168.1.1:8080/cms/server/mode
ip-address Yes IP address used to deploy Context Services (localhost by default).
data-validation No
  • true to enable data validation, which enforces additional checks on data provided by the connected clients.
  • false to disable data validation.
keyPassword
Deprecated since: 8.1.0
 Yes Password for the certificate.
Deprecated since: 8.1.0. See the Security and Authentication page.
keystorePassword
Deprecated since: 8.1.0
 Yes Password for the keystore file.
Deprecated since: 8.10. See the Security and Authentication page.
keystorePath
Deprecated since: 8.1.0
 Yes Path to standard JKS file.
Deprecated since: 8.1.0. See the Security and Authentication page.
keystoreType
Deprecated since: 8.1.0
 Yes JKS or other JSSE-supported type.
Deprecated since: 8.1.0. See the Security and Authentication page.
start-mode Yes Start-mode of the server mode:
  • maintenance
  • production
tenant-id Yes Defaults to 101. Specifies the numeric tenant ID associated with Context Services: subsequent customer/contact records created through your application are associated with this tenant.
metadata-cache
Available since: 8.0.3
 No
  • true to enable the caching of metadata in the memory.
  • false to disable the metadata caching. In that case, each access to the metadata triggers a DB query.
The cache contains metadata for contact attributes, identification keys, profiles, services, states and tasks extensions.

<references />

[archiving] Section

This section activates and deactivates set-based archiving. It is not present on the UCS template; you must create it. It contains just one option:

archiving Section
Name Restart UCS<ref name="restart">This column indicates whether you must restart UCS for changes in the option value to take effect.</ref> Description
use-np Yes
  • true to enable set-based archiving.
  • false (default) to disable set-based archiving.

<references />

[authentication] Section

This section configures authentication for clients connecting to UCS. Authentication, available since release 8.0.300.02, applies to UCS/CS only. See also:

authentication Section
Name Restart UCS<ref name="restart">This column indicates whether you must restart UCS for changes in the option value to take effect.</ref> Description
enabled Yes
  • false to disable authentication (default).
  • true to enable authentication.
mode Yes Authentication mode:
  • single-user to authenticate using UCS options (default).
  • multi-users to authenticate using Persons from Configuration Server.
password Yes Password to check the identity of the specified user. Effective only if mode is set to single-user.</tt>
username Yes User name allowed to connect to the Context Services API. Effective only if mode is set to single-user.</tt>
use-role Yes
  • false to disable the use of roles in authentication (default).
  • true to enable the use of roles in authentication.

<references />

Section 'authentication' in Configuration Manager.

[business-attributes] Section

This section defines the mapping between Context Services and the Business Attributes configured in the Genesys Configuration Server. The Business Attribute values are defined in the Tenant.

business-attributes Section
Name Restart UCS<ref name="restart">This column indicates whether you must restart UCS for changes in the option value to take effect.</ref> Description
${resource name}.${field name}
 No Associates a Business Attribute key with the name of the Business Attribute configured in the proper tenant. The option key name follows this syntax:
${resource name}.${field name}

Possible ${resource name} values are:

  • Service
  • State
  • Task

Possible ${field name} values to map are:

  • type (for service type)
  • disposition
  • application_type
  • resource_type
  • media_type

Such as, for instance: Service.service_type, Task.disposition, State.media_type. Notes:

  • if there is no configuration for a given field, Context Services automatically allows any valid integer value for this field. In this case, your application is responsible for the value's validity.
  • A Business Attribute can be mapped to several resource fields. For instance, the Service.media_type and Task.media_type string can both point to "MediaType" Business Attributes.
map-names No Possible values are:
  • true to return the Names of Business Attribute Values instead of DB IDs in the responses for GET operations.
  • false (default) to return the DB IDs of Business Attribute Values in the responses for GET operations.

<references />

Mapping Example

This first screenshot shows the section in UCS options, with the list of mapped keys, such as, for instance: Service.service_type, Task.disposition, State.media_type.

Business Attribute Configuration in UCS Options

The following screenshot shows one of the mapped business attributes, the key and the associated values, which your application can retrieve in the result of GET operations by setting to true the map-names UCS options, as stated above.

Related State Type Business Attribute

[log-filter] Section

This section contains general settings for how or whether user data keys appear in the logs. Its settings can be overridden for specified keys by options in the log-filter-data section.

log-filter Section
Name Restart UCS<ref name="restart">This column indicates whether you must restart UCS for changes in the option value to take effect.</ref> Description
default-filter-type No Sets the default for filtering the output of user data keys to the UCS server log.

Possible values:

  • skip&#151;Does not output key-value pairs.
  • hide&#151;Outputs the keys but hides their values.
  • copy (default)&#151;Outputs both the keys and their values.

This default filter applies to all user data keys, except that is is overridden by any settings for individual keys in the log-filter-data section.

filter-depth No Depth used while filtering nested key-value pairs. The default is 99. Any value greater than this is not checked. Using a high value can result in lower performance in the case of deeply nested key-values.

<references />

[log-filter-data] Section

This section enables you to override the log-filter section's setting for one or more specific data keys. You do this by creating options with the name <keyname> and the value <filtering mode>, where:

  • <keyname> is the user data key affected.
  • <filtering mode> is skip, hide, or copy, the same as the possible values of default-filter-type in the log-filter section.
This page was last edited on July 17, 2020, at 15:52.
Comments or questions about this documentation? Contact us for support!