Jump to: navigation, search
(Genesys Knowledge Center Configuration Options)
(Genesys Knowledge Center Configuration Options)
Line 1: Line 1:
 
= Genesys Knowledge Center Configuration Options=
 
= Genesys Knowledge Center Configuration Options=
  
All interactions occur through the configuration options populated in '''gws/cloud-server/agent-desktop/metadate.json''' which you can access through Ctr + F > '''Knowledge Center'''.
+
Workspace Web Edition provides the following options for managing Knowledge Center:
  
To make the Genesys Knowledge Center plugin work, you need to provide following options or, at minimum, those that are listed as ''required'' in the table below.
+
====knowledge-center.auth====
  
==Main configuration options==
+
* Default Value: <tt>empty string</tt>, <tt>Floating</tt>
{|
+
* Valid Values: <tt>Valid authorization token</tt>
! '''Option'''
+
* Changes take effect: When the session is started or restarted.
! '''Default'''
+
* Description: Authorization token of the Knowledge-center cluster.
! '''Required'''
+
 
! '''Description'''
+
====knowledge-center.customerId====
|-
+
 
| knowledge-center.auth
+
* Default Value: <tt>empty string</tt>
| empty string
+
* Valid Values: <tt>?</tt>
| Yes
+
* Changes take effect: When the session is started or restarted.
| Authorization token of the Knowledge-center cluster  
+
* Description: Token that refers to the customer ID given in Interaction object.
|-
+
 
| knowledge-center.customerId  
+
====knowledge-center.kbId====
| empty string
+
 
| No
+
* Default Value: <tt>empty string</tt>
| Token that refers to the customer ID given in Interaction object
+
* Valid Values: <tt>?</tt>
|-
+
* Changes take effect: When the session is started or restarted.
| knowledge-center.kbId
+
* Description: Token that refers to the pre-populated knowledge base ID given in Interaction object.
| empty string
+
 
| No
+
====knowledge-center.question====
| Token that refers to the pre-populated knowledge base ID given in Interaction object
+
 
|-
+
* Default Value: <tt>empty string</tt>, <tt>Floating</tt>
| knowledge-center.question
+
* Valid Values: <tt>Pinned</tt>, <tt>Floating</tt>
| empty string
+
* Changes take effect: When the session is started or restarted.
| No
+
* Description: knowledge-center.question.
| knowledge-center.question
+
 
|-
+
====knowledge-center.sessionId ====
| knowledge-center.sessionId
+
 
| empty string
+
* Default Value: <tt>empty string</tt>
| No
+
* Valid Values: <tt>?</tt>
| Token that refers to the customer session ID given in Interaction object
+
* Changes take effect: When the session is started or restarted.
|-
+
* Description: Token that refers to the customer session ID given in Interaction object.
| knowledge-center.url
+
 
| empty string
+
====knowledge-center.url====
| Yes
+
 
| URL (for example, http://[host]:[port]/gks-server/v1) of the Knowledge-center cluster
+
* Default Value: <tt>empty string</tt>
|-
+
* Valid Values: <tt>Valid HTTP URL</tt>
| privilege.knowledge-center.can-use
+
* Changes take effect: When the session is started or restarted.
| false
+
* Description:URL (for example, http://[host]:[port]/gks-server/v1) of the Knowledge-center cluster  
| Yes
+
 
| Permission to use the Knowledge center. Plugin wouldn't even be loaded without this option in '''true'''.
+
 
|}
+
 
 +
====privilege.knowledge-center.can-use====
 +
 
 +
* Default Value: <tt>false</tt>
 +
* Valid Values: <tt>true</tt>, <tt>false</tt>
 +
* Changes take effect: When the session is started or restarted.
 +
* Description: Permission to use the Knowledge center. Plugin wouldn't even be loaded without this option in '''true'''.
  
 
[[Category:V:HTCC:8.5.2DRAFT]]
 
[[Category:V:HTCC:8.5.2DRAFT]]

Revision as of 00:01, May 30, 2015

Genesys Knowledge Center Configuration Options

Workspace Web Edition provides the following options for managing Knowledge Center:

knowledge-center.auth

  • Default Value: empty string, Floating
  • Valid Values: Valid authorization token
  • Changes take effect: When the session is started or restarted.
  • Description: Authorization token of the Knowledge-center cluster.

knowledge-center.customerId

  • Default Value: empty string
  • Valid Values: ?
  • Changes take effect: When the session is started or restarted.
  • Description: Token that refers to the customer ID given in Interaction object.

knowledge-center.kbId

  • Default Value: empty string
  • Valid Values: ?
  • Changes take effect: When the session is started or restarted.
  • Description: Token that refers to the pre-populated knowledge base ID given in Interaction object.

knowledge-center.question

  • Default Value: empty string, Floating
  • Valid Values: Pinned, Floating
  • Changes take effect: When the session is started or restarted.
  • Description: knowledge-center.question.

knowledge-center.sessionId

  • Default Value: empty string
  • Valid Values: ?
  • Changes take effect: When the session is started or restarted.
  • Description: Token that refers to the customer session ID given in Interaction object.

knowledge-center.url

  • Default Value: empty string
  • Valid Values: Valid HTTP URL
  • Changes take effect: When the session is started or restarted.
  • Description:URL (for example, http://[host]:[port]/gks-server/v1) of the Knowledge-center cluster


privilege.knowledge-center.can-use

  • Default Value: false
  • Valid Values: true, false
  • Changes take effect: When the session is started or restarted.
  • Description: Permission to use the Knowledge center. Plugin wouldn't even be loaded without this option in true.
Comments or questions about this documentation? Contact us for support!