Knowledge Center Cluster Configuration Options
Section:
- cross-origin
- cms.cluster
- cms.general
- cms.ucs
- translation
- general
- index
- reporting
- search
- configuration
- security
- kibana
| Option | Name | Description | Value |
|---|---|---|---|
| Section: cross-origin | |||
| CORS Filter Configuration | allowedOrigins | A comma separated list of origins (for example, instrumented web sites) allowed to access the Knowledge Center. If an allowed origin contains one or more "*" characters (for example http://*.domain.com) then "*" characters are converted to ".*". Characters "." are converted to "\.". Thus obtained allowed origin can be interpreted as a regular expression. | Default value: "*" Value Type:string |
| Section: cms.cluster
Configuration of the Knowledge Center CMS Cluster. | |||
| Database connection URL | dbConnectionUrl | Database connection string for the selected persistent storage. Examples: for Microsoft SQL: jdbc:sqlserver://[host of MS SQL server]:[port of MS SQL server; 1433 by default];databaseName=[CMS DB name] for Oracle: jdbc:oracle:thin:[userName]/[password]@[host of Oracle DB]:[port of Oracle DB; 1521 by default]:[SID. for example ORCL] or jdbc:oracle:thin:@//[host of Oracle DB]:[port of Oracle DB; 1521 by default]/[Service Name] for PostgreSQL: jdbc:postgresql://[host of PostreSQL server]:[port of PostreSQL server; 5432 by default]/[CMS DB name]
|
Default value: <empty> Value Type:string |
| Database user password | dbPassword | Password for user for access JDBC database. | Default value: <empty> Value Type:string |
| Database user name | dbUsername | Name of user for access JDBC database. | Default value: <empty> Value Type:string |
| Storage type | type | Type of persistent storage provider used for Knowledge Center CMS repository. | Default value: mssql Value Type:enumerated type [+] mssql [+] oracle [+] postgre Changes Take Effect: At start/restart |
| Section: cms.general | |||
| Connection to CMS load balancer | externalURL | Public URL that is used to access the CMS directly or via load balancer (like http://<cms host>:<CMS default port>/gks-cms). This URL will be used to build the link on the attachments in knowledge documents. | Default value: <empty> Value Type:string |
| Approval flow default value | approvalFlow.default | (Introduced in 9.0.003) Default value for approval flow in knowledge bases. |
Default value: standard Value Type: enumerated type |
| Section: cms.ucs | |||
| Enable/disable SRL/SR | enabled | Enables authoring of screening rules and standard responses. | Default value: true Value Type:Boolean |
| Locale for Field Codes formatting | fieldcode-format-locale | When specified, defines the locale that must be used to format date, time, currency, and percent values in Field Codes. If not specified, the server uses the default platform. | Default value: <empty> Value Type:string |
| Replace blank Field Codes | replace-blank-fieldcode | Specifies whether field code names will be displayed in a response where the field code does not have any content. If set to true, this option applies to responses generated by desktops, but not to automated responses generated by E-mail Server (ACK, AutoResponse). | Default value: false Value Type:Boolean |
| Synchronization mode | config-synchro-mode | Configuration server SRL synchronization mode. | Default value: periodically Value Type:enumerated type [+] periodically [+] on-config-even [+] both Changes Take Effect: At start/restart |
| Standard responses synchronization delay | standard-responses-sync-delay | If the option synchronize-standard-responses is enabled, this option specifies, in milliseconds, the delay after which synchronization of standard responses occurs.
|
Default value: 10000 Value Type:integer |
| Enable standard responses synchronization | synchronize-standard-responses | Enables (true) or disables (false) the synchronization of standard responses from the CMS database to Business Attributes in the Configuration Server. If enabled, synchronization occurs shortly after any change to standard responses. | Default value: false Value Type:Boolean |
| Screening rules synchronization delay | screening-rules-sync-delay | If the option synchronize-screening-rules is enabled, this option specifies, in milliseconds, the delay after which synchronization of the screening rules occurs.
|
Default value: 10000 Value Type:integer |
| Enable screening rules synchronization | synchronize-screening-rules | Enables (true) or disables (false) the synchronization of screening rules from the UCS database to Business Attributes in the Configuration Server. If enabled, synchronization occurs shortly after any change to the screening rules. | Default value: false Value Type:Boolean |
| Synchronization delay | postpone-synchro-delay | Delay for postpone synchronization with config server. | Default value: 1000 Value Type:integer |
| Synchronization delay after fail | asyncsync-delay | Delay before retry, if previous synchronization failed. | Default value: 1000 Value Type:integer |
| Section: translation | |||
| API key | key | Translation service API key. Key is provided by translation provider and required as part of request authentication to API. | Default value: <empty> Value Type:string |
| Translation service | type | Defines translation service provider used by Knowledge Center CMS. | Default value: none Value Type:enumerated type [+] none [+] microsoft [+] yandex Changes Take Effect: At start/restart |
| Section: general | |||
| Time to live for session | sessionTtl | Specifies the length of time that the server will store session information while no activities are carried out. | Default value: 8h Value Type:regular expression [^[0-9]*(ms|m|h|d|w)] |
| Folder name for knowledge bases | knowledgebaseFolder | Name for folder in \"Script\" in Tenant in Configuration for storing Knowledge Base definitions for particular Knowledge Center Cluster. | Default value: knowledge Value Type:regular expression [^[a-zA-Z0-9_]*$] |
| Section: index | |||
| Number of replicas in historical index | historyNumberOfReplicas | Number of copies of historical index. Copies of index help to improve read performance and tolerate lost data nodes. On the other hand they consume your disc space. | Default value: 1 Value Type:integer |
| Number of shards in historical index | historyNumberOfShards | Number of shard (parts) that each historical index is divided into. Please follow Elasticsearch recommendations and projected load to estimate number of shards required. | Default value: 1 Value Type:integer |
| Index namespace | namespace | Namespace constant used as the prefix in the name of Elasticsearch indexes to ensure no naming conflict will arise while using the same Elasticsearch cluster for other tasks (including 2 independent Knowledge Center clusters)", | Default value: default Value Type:regular expression [^[a-zA-Z0-9_]*$] |
| History segment format | historySegmentFormat | History segment format as Java date | Default value: yyyy-MM Value Type: string |
| Section: reporting | |||
| IP geo location mode | geo | Determine the precision of IP geo location algorithm. | Default value: CITY Value Type:enumerated type [+] OFF [+] CITY [+] IP [+] COUNTRY Changes Take Effect: Immediately |
| Time to live | ttl | Specifies the length of time that records will be stored in the history. | Default value: 365d Value Type:regular expression [^[0-9]*(ms|m|h|d|w)] |
| Kibana provisioning | kibana.provision | Enable Kibana provisioning with dashboards and visualization. | Default value: true Value Type: Boolean |
| Overwrite Pulse Templates | pulse.provision | Enable Pulse provisioning with predefined templates. | Default value: true Value Type: Boolean |
| Section: search | |||
| Number of documents in result | numberOfAnswers | Number of documents returned as the result of search operation (if other not specified directly in request) | Default value: 6 Value Type:integer |
| Trending period | trendingPeriod | Number of the days from now that is document usage is analyzed for to show trending knowledge documents (the documents having most attention during the recent period). | Default value: 10 Value Type:integer |
| Access to public knowledge | privilege.can-access-public | Enables/disables access to public knowledge for agents (authorized user). If set to true, agents able to access both public and private knowledge bases. If set to false, all agents have access to private knowledge bases only unless agent is granted special privilege" | Default value: true Value Type:Boolean |
| Words per minute rate | wordsPerMin | Default words per minute rate that is used as basis in reading time calculation. | Default value: 160 Value Type:integer |
| Section: configuration | |||
| Agent refresh interval | usersRefreshInterval | Defines the time interval in which information about agents is cached in memory. The larger the interval, the fewer the requests sent to configuration server, but it will take more time (up to specified interval) to get recently updated information from Configuration Server. | Default value: 120s Value Type:regular expression [^[0-9]*(s|m|h)] |
| Business attributes refresh interval | attributesRefreshInterval | Defines time interval that information about business attributes (languages, media type) is cached in memory. The larger the interval, the fewer the requests sent to configuration server, but it will take more time (up to specified interval) to get recently updated information from Configuration Server. | Default value: 120s Value Type:regular expression [^[0-9]*(s|m|h)] |
| Skills refresh interval | skillsRefreshInterval | Defines time interval that information about skills is cached in memory. The larger the interval, the fewer the requests sent to configuration server, but it will take more time (up to specified interval) to get recently updated information from Configuration Server. | Default value: 120s Value Type:regular expression [^[0-9]*(s|m|h)] |
| Section: security | |||
| Authorization scheme | auth-scheme | Specifies the HTTP authentication scheme used to secure REST API requests to the Knowledge Server. With the Basic scheme, clients must be authenticated with a user ID and password. Applies to: Genesys Knowledge Center Server |
Default value: none Value Type:enumerated type [+] basic [+] none Changes Take Effect: Immediately |
| Password | password | The user password used in authentication for the REST API. Applies to: Genesys Knowledge Center Server. |
Default value: <empty> Value Type:string |
| User ID | user-id | The user identifier (login) used in authentication for the REST API. Applies to: Genesys Knowledge Center Server. |
Default value: <empty> Value Type:string |
| Section: kibana | |||
| Enable/disable Kibana | enabled | Configuration of Kibana component | Default value: false Value Type: Boolean |
| Path to kibana proxy | base_path | Path to mount Kibana for running it behind a proxy. It is important to enter exactly the value of "/gks-server/kibana" with no tailing slash. Exactly at this point knowledge server exposes its entry point for proxying kibana. | Default value: "" Value to enable proxy "/gks-server/kibana" |
| Kibana protected (internal) host | host | Specifies the address to which the Kibana server itself will bind. IP addresses and host names are both valid values. It is important to enter the name or ip address that is exposed internally, here. In any other case the kibana UI will not be workable, but its API will still be available externally at the kibana port and capable of performing harmful calls. | Default value: 0.0.0.0 Recommended value: localhost |