Jump to: navigation, search
(→‎Genesys Knowledge Center Configuration Options)
Line 1: Line 1:
−
= Genesys Knowledge Center Configuration Options=
+
= Knowledge Center=
  
 
Workspace Web Edition provides the following options for managing Knowledge Center:  
 
Workspace Web Edition provides the following options for managing Knowledge Center:  
  
−
====knowledge-center.auth====
+
====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'''.
 +
 
 +
====knowledge-center.url====
  
 
* Default Value: <tt>empty string</tt>
 
* Default Value: <tt>empty string</tt>
−
* Valid Values: <tt>Valid authorization token</tt>
+
* Valid Values: <tt>Valid HTTP URL</tt>
 
* Changes take effect: When the session is started or restarted.
 
* Changes take effect: When the session is started or restarted.
−
* Description: Authorization token of the Knowledge-center cluster.
+
* Description: URL of the Knowledge Center cluster, for example, http://[host]:[port]/gks-server/v1. Typically, this will be the load balancer's URL.  
  
−
====knowledge-center.customerId====
+
====knowledge-center.auth-active====
  
−
* Default Value: <tt>empty string</tt>
+
* Default Value: <tt>false</tt>
−
* Valid Values: <tt>?</tt>
+
* Valid Values: <tt>true</tt>, <tt>false</tt>
 
* Changes take effect: When the session is started or restarted.
 
* Changes take effect: When the session is started or restarted.
−
* Description: Token that refers to the customer ID given in Interaction object.
+
* Description: Specifies whether basic HTTP authentication scheme used to provide for secure browser history requests to the Knowledge Center Server.
  
−
====knowledge-center.kbId====
+
====knowledge-center.auth-user====
  
 
* Default Value: <tt>empty string</tt>
 
* Default Value: <tt>empty string</tt>
−
* Valid Values: <tt>?</tt>
+
* Valid Values: <tt>A valid user ID.</tt>
 
* Changes take effect: When the session is started or restarted.
 
* 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.
+
* Description: Specifies the user ID used to authenticate browser history requests to the Knowledge Center Server.
  
−
====knowledge-center.question====
+
====knowledge-center.auth-password====
  
−
* Default Value: <tt>empty string</tt>, <tt>Floating</tt>
+
* Default Value: <tt>empty string</tt>
−
* Valid Values: <tt>Pinned</tt>, <tt>Floating</tt>
+
* Valid Values: <tt>A valid password.</tt>
 
* Changes take effect: When the session is started or restarted.
 
* Changes take effect: When the session is started or restarted.
−
* Description: knowledge-center.question.  
+
* Description: Specifies the password used to authenticate browser history requests to the Knowledge Center Server.
  
−
====knowledge-center.sessionId ====
+
====knowledge-center.customerId====
  
 
* Default Value: <tt>empty string</tt>
 
* Default Value: <tt>empty string</tt>
−
* Valid Values: <tt>?</tt>
+
* Valid Values: <tt>Letters A to Z and a to z. Numbers 0 through 9. The underscore and space characters.</tt>
 
* Changes take effect: When the session is started or restarted.
 
* Changes take effect: When the session is started or restarted.
−
* Description: Token that refers to the customer session ID given in Interaction object.
+
* Description: Specifies the name of the contact attribute that is used to match customerId with.
  
−
====knowledge-center.url====
+
====knowledge-center.kbId====
  
 
* Default Value: <tt>empty string</tt>
 
* Default Value: <tt>empty string</tt>
−
* Valid Values: <tt>Valid HTTP URL</tt>
+
* Valid Values: <tt>Letters A to Z and a to z. Numbers 0 through 9. The underscore and space characters.</tt>
 
* Changes take effect: When the session is started or restarted.
 
* 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
+
* Description: Specifies the name of the key that is used to store knowledge base id in the attached data of the interaction that this interaction related to.
  
 +
====knowledge-center.question====
  
 +
* Default Value: <tt>empty string</tt>
 +
* Valid Values: <tt>Letters A to Z and a to z. Numbers 0 through 9. The underscore and space characters.</tt>
 +
* Changes take effect: When the session is started or restarted.
 +
* Description: Specifies the name of the key that is used to store last question customer asked the knowledge system. Key is looked up in in the attached data of the interaction.
  
−
====privilege.knowledge-center.can-use====
+
====knowledge-center.sessionId ====
  
−
* Default Value: <tt>false</tt>
+
* Default Value: <tt>empty string</tt>
−
* Valid Values: <tt>true</tt>, <tt>false</tt>
+
* Valid Values: <tt>Letters A to Z and a to z. Numbers 0 through 9. The underscore and space characters.</tt>
 
* Changes take effect: When the session is started or restarted.
 
* 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'''.
+
* Description: Specifies the name of the key that is used to store knowledge session Id in the attached data of the interaction.
  
 
[[Category:V:HTCC:8.5.2DRAFT]]
 
[[Category:V:HTCC:8.5.2DRAFT]]

Revision as of 18:51, June 2, 2015

Knowledge Center

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

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.

knowledge-center.url

  • Default Value: empty string
  • Valid Values: Valid HTTP URL
  • Changes take effect: When the session is started or restarted.
  • Description: URL of the Knowledge Center cluster, for example, http://[host]:[port]/gks-server/v1. Typically, this will be the load balancer's URL.

knowledge-center.auth-active

  • Default Value: false
  • Valid Values: true, false
  • Changes take effect: When the session is started or restarted.
  • Description: Specifies whether basic HTTP authentication scheme used to provide for secure browser history requests to the Knowledge Center Server.

knowledge-center.auth-user

  • Default Value: empty string
  • Valid Values: A valid user ID.
  • Changes take effect: When the session is started or restarted.
  • Description: Specifies the user ID used to authenticate browser history requests to the Knowledge Center Server.

knowledge-center.auth-password

  • Default Value: empty string
  • Valid Values: A valid password.
  • Changes take effect: When the session is started or restarted.
  • Description: Specifies the password used to authenticate browser history requests to the Knowledge Center Server.

knowledge-center.customerId

  • Default Value: empty string
  • Valid Values: Letters A to Z and a to z. Numbers 0 through 9. The underscore and space characters.
  • Changes take effect: When the session is started or restarted.
  • Description: Specifies the name of the contact attribute that is used to match customerId with.

knowledge-center.kbId

  • Default Value: empty string
  • Valid Values: Letters A to Z and a to z. Numbers 0 through 9. The underscore and space characters.
  • Changes take effect: When the session is started or restarted.
  • Description: Specifies the name of the key that is used to store knowledge base id in the attached data of the interaction that this interaction related to.

knowledge-center.question

  • Default Value: empty string
  • Valid Values: Letters A to Z and a to z. Numbers 0 through 9. The underscore and space characters.
  • Changes take effect: When the session is started or restarted.
  • Description: Specifies the name of the key that is used to store last question customer asked the knowledge system. Key is looked up in in the attached data of the interaction.

knowledge-center.sessionId

  • Default Value: empty string
  • Valid Values: Letters A to Z and a to z. Numbers 0 through 9. The underscore and space characters.
  • Changes take effect: When the session is started or restarted.
  • Description: Specifies the name of the key that is used to store knowledge session Id in the attached data of the interaction.
Comments or questions about this documentation? Contact us for support!