Jump to: navigation, search

Configuration Options

Purpose: Lists the configuration options that your application can read in UCS.

This configuration options do not apply to GMS. Refer to the main options reference for details.


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.
  • 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 and UCS Options for TLS.

[cview] Section

This section adjusts the overall configuration of Context Services.

cview Section
Name [+] Restart UCS Description
enabled Yes
  • true to enable Context Services functionality in Universal Contact Server (UCS).
  • false (default) to disable Context Services.
base-url Yes The base URL used to deploy Context Services. Based on this configuration, the services are available at the following URL:


  • ${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, the port 8080, and the base URL cms, the Set Server Mode operation would be available at the following URL:

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

[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 Description
use-np Yes
  • true to enable set-based archiving.
  • false (default) to disable set-based archiving.

[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 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.
username Yes User name allowed to connect to the Context Services API. Effective only if mode is set to single-user.
use-role Yes
  • false to disable the use of roles in authentication (default).
  • true to enable the use of roles in authentication.

Config authentication.png

[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 Description
default-filter-type No Sets the default for filtering the output of user data keys to the UCS server log.

Possible values:

  • skip—Does not output key-value pairs.
  • hide—Outputs the keys but hides their values.
  • copy (default)—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.

[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.
blog comments powered by Disqus