Jump to: navigation, search
(→‎Genesys Knowledge Center Configuration Options)
 
(24 intermediate revisions by 4 users not shown)
Line 1: Line 1:
−
= Genesys Knowledge Center Configuration Options=
+
= Knowledge Center=
−
 
+
__TOC__
−
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.
 
−
 
 
−
==Main configuration options==
 
−
{|
 
−
! '''Option'''
 
−
! '''Default'''
 
−
! '''Required'''
 
−
! '''Description'''
 
−
|-
 
−
| knowledge-center.auth
 
−
| empty string
 
−
| Yes
 
−
| Authorization token of the Knowledge-center cluster
 
−
|-
 
−
| knowledge-center.customerId
 
−
| empty string
 
−
| No
 
−
| Token that refers to the customer ID given in Interaction object
 
−
|-
 
−
| knowledge-center.kbId
 
−
| empty string
 
−
| No
 
−
| Token that refers to the pre-populated knowledge base ID given in Interaction object
 
−
|-
 
−
| knowledge-center.question
 
−
| empty string
 
−
| No
 
−
| knowledge-center.question
 
−
|-
 
−
| knowledge-center.sessionId
 
−
| empty string
 
−
| No
 
−
| Token that refers to the customer session ID given in Interaction object
 
−
|-
 
−
| knowledge-center.url
 
−
| empty string
 
−
| Yes
 
−
| URL (for example, http://[host]:[port]/gks-server/v1) of the Knowledge-center cluster
 
−
|-
 
−
| privilege.knowledge-center.can-use
 
−
| false
 
−
| Yes
 
−
| Permission to use the Knowledge center. Plugin wouldn't even be loaded without this option in '''true'''.
 
−
|}
 
  
 +
====knowledge-center.auth-active====
 +
* Default Value: <tt>false</tt>
 +
* Valid Values: <tt>true</tt>, <tt>false</tt>
 +
* Changes take effect: When the session is started or restarted.
 +
* Description: Specifies whether a basic HTTP authentication scheme is used to provide secure browser history requests to the Knowledge Center Server.
 +
====knowledge-center.auth-user====
 +
* Default Value: none
 +
* Valid Values: 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: none
 +
* Valid Values: 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: none
 +
* 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 with a customerId.
 +
====knowledge-center.kbId====
 +
* Default Value: none
 +
* 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 stores the knowledge base Id in the attached interaction data that this interaction is related to.
 +
====knowledge-center.question====
 +
* Default Value: none
 +
* 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 stores the last question a customer asked the knowledge system. The attached interaction data includes this key.
 +
====knowledge-center.sessionId ====
 +
* Default Value: none
 +
* 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 key name that stores the knowledge session Id in the attached data of the interaction.
 +
====knowledge-center.url====
 +
* Default Value: none
 +
* 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 is the load balancer's URL.
 +
====privilege.knowledge-center.can-author====
 +
* Default Value: <tt>true</tt>
 +
* Valid Values: <tt>true</tt>, <tt>false</tt>
 +
* Changes take effect: When the session is started or restarted.
 +
* Description: Enables an agent  to suggest new content to knowledge bases.
 +
====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. The plugin only loads if the value of this option is set to <tt>true</tt>.
 +
====knowledge-center.can-upvote-on-copycontent====
 +
* Default Value: <tt>true</tt>
 +
* Valid Values: <tt>true</tt>, <tt>false</tt>
 +
* Changes take effect: When the session is started or restarted.
 +
* Description: Enables or disables to vote automatic positive feedback after clicking the copy content button.
 
[[Category:V:HTCC:8.5.2DRAFT]]
 
[[Category:V:HTCC:8.5.2DRAFT]]

Latest revision as of 20:10, March 14, 2023

Knowledge Center

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

knowledge-center.auth-active

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

knowledge-center.auth-user

  • Default Value: none
  • Valid Values: 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: none
  • Valid Values: 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: none
  • 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 with a customerId.

knowledge-center.kbId

  • Default Value: none
  • 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 stores the knowledge base Id in the attached interaction data that this interaction is related to.

knowledge-center.question

  • Default Value: none
  • 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 stores the last question a customer asked the knowledge system. The attached interaction data includes this key.

knowledge-center.sessionId

  • Default Value: none
  • 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 key name that stores the knowledge session Id in the attached data of the interaction.

knowledge-center.url

  • Default Value: none
  • 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 is the load balancer's URL.

privilege.knowledge-center.can-author

  • Default Value: true
  • Valid Values: true, false
  • Changes take effect: When the session is started or restarted.
  • Description: Enables an agent to suggest new content to knowledge bases.

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. The plugin only loads if the value of this option is set to true.

knowledge-center.can-upvote-on-copycontent

  • Default Value: true
  • Valid Values: true, false
  • Changes take effect: When the session is started or restarted.
  • Description: Enables or disables to vote automatic positive feedback after clicking the copy content button.
This page was last edited on March 14, 2023, at 20:10.
Comments or questions about this documentation? Contact us for support!