Jump to: navigation, search

standard-response.suggested-categories.max-number

Section: interaction-workspace
Default Value: 20
Valid Values: An integer between 1 and 20
Changes Take Effect: Immediately
Introduced: 9.0.000.76

Specifies the maximum number of suggested response categories displayed in the Responses view. This option can be overridden by a routing strategy as described in the Configuration Guide.

standard-response.suggested-responses.min-relevance

Section: interaction-workspace
Default Value: 50
Valid Values: Any integer between 1 to 100
Changes Take Effect: Immediately
Introduced: 9.0.000.76

Specifies the minimum level of relevance to filter the display of suggested responses in the Responses view. This option can be overridden by a routing strategy as described in the Configuration Guide.

privilege.standard-response.suggested-response.can-use

Section: interaction-workspace
Default Value: true
Valid Values: true, false.
Changes Take Effect: Immediately
Introduced: 9.0.000.76

Enables an agent to use suggested responses in the Responses view. This option can be overridden by a routing strategy as described in the Configuration Guide.

privilege.standard-response.shortcuts.can-filter

Section: interaction-workspace
Default Value: false
Valid Values: true, false.
Changes Take Effect: After the next platform configuration refresh interval.
Introduced: 9.0.000.72

Enables agents to filter Standard Responses in the Standard Responses tree view to show only those with shortcuts.

privilege.standard-response.shortcuts.can-use

Section: interaction-workspace
Default Value: false
Valid Values: true, false.
Changes Take Effect: After the next platform configuration refresh interval.
Introduced: 9.0.000.72

Enables agents to use shortcuts to insert Standard Responses.

standard-response.shortcuts.<keyword>

Section: interaction-workspace
Default Value: No default value
Valid Values: Path to the standard response as defined in the Knowledge Manager.
Changes Take Effect: After the next platform configuration refresh interval.
Introduced: 9.0.000.72

Specifies the 'keyword' for a shortcut where the name of the option represents the keyword to be entered by agents to use the shortcut. For example: 'standard-response.shortcuts.JulySale'. Specify the path to the Response that is defined in Knowledge Manager as the value for this option. For example '2021Specials\JulySale'.

editor.SRL.shortcuts.prefix

Section: interaction-workspace
Default Value: #
Valid Values: A valid character.
Changes Take Effect: After the next platform configuration refresh interval.
Introduced: 9.0.000.72

Specifies the prefix, such as '#', that identifies that a keyword is a shortcut for a Standard Response.

privilege.standard-response.favorites.can-use

Section: interaction-workspace
Default Value: true
Valid Values: true, false.
Changes Take Effect: After the next platform configuration refresh interval.
Introduced: 9.0.000.72

Enables agents to use favorites for Standard Responses.

privilege.SRL.can-quick-search

Section: interaction-workspace
Default Value: false
Valid Values: true, false.
Changes Take Effect: After the next platform configuration refresh interval.
Introduced: 9.0.000.31

Enables an agent to perform a Quick Search of the Standard Response Library.

standard-response.field.<CustomFieldCode>

Section: interaction-workspace
Default Value: No default value
Valid Values: Any valid text string.
Changes Take Effect: After the next platform configuration refresh interval.
Introduced: 9.0.000.50
Modified: 9.0.000.65

In the name of the option, CustomFieldCode represents a field code that is called in a Standard Response object created in eServices Manager and stored in Universal Contact Server. Use this option to specify a custom field code such as a role, department, or other qualification. The value of the option is specific to the agent, agent group, tenant, or application. The value of this option represents the data that is used to populate the corresponding field codes when a Standard Response is inserted into an interaction. You can format CustomFieldCode to represent a custom agent attribute. Example: standard-response.field.Department = Sales

standard-response.field.Agent.<CustomFieldCode>

Section: interaction-workspace
Default Value: No default value
Valid Values: Any valid text string.
Changes Take Effect: After the next platform configuration refresh interval.
Introduced: 9.0.000.50
Modified: 9.0.000.65

In the name of the option, CustomFieldCode represents a field code that is called in a Standard Response object created in eServices Manager and stored in Universal Contact Server. Use this option to specify a custom field code such as an agent nickname, role, department, or other qualification. The value of the option is specific to the agent, agent group, tenant, or application. The value of this option represents the data that is used to populate the corresponding field codes when a Standard Response is inserted into an interaction. You can format CustomFieldCode to represent a custom agent attribute. Example: standard-response.field.Agent.Nickname = Lee

standard-response.categories

Section: interaction-workspace
Default Value: $All$
Valid Values: A comma-separated value list of category names or full path category starting at the root category. $All$ to display Standard Responses from all categories.
Changes Take Effect: After the next platform configuration refresh interval.
Introduced: 9.0.000.31

Specifies the list of categories used to filter Standard Responses. Agents see only those Standard Responses that are part of the sub-tree of categories set in the value for this option.

This option can be overridden by a routing strategy as described in the Configuration Guide.

privilege.SRL.can-use

Section: interaction-workspace
Default Value: false
Valid Values: true, false.
Changes Take Effect: After the next platform configuration refresh interval.
Introduced: 9.0.000.31

Enables access to the Standard Response Library functions.

(Created target blank page For Version: HTCC:9.0.0DRAFT)
 
 
(30 intermediate revisions by 4 users not shown)
Line 1: Line 1:
<!-- Creation of the target page -->
+
=Standard Responses Library=
 +
The Standard Responses Library (SRL) enables agents to access a database of prewritten standard responses for interactions. Agents can insert these responses as replies into any email or chat message.
 +
 
 +
Agents can modify the contents of a standard response after inserting it into an email interaction or chat message.
 +
 
 +
To use the Standard Responses Library, you must set up the multimedia feature in Web Services, by using the <tt>features-definition.json</tt> file.
 +
 
 +
Agents can insert these responses as replies into any email, instant messaging, or chat message, or they can read them to the contact during a voice interaction.
 +
 
 +
Before you begin, ensure the following prerequisites are met:
 +
 
 +
* A <tt>GWS Application Server object</tt> object exists in the Configuration Database.
 +
* Workspace has a connection to [[Documentation/UCS|Universal Contact Server]].
 +
* The {{Optionslink|link=Options:Genesys_Web_Services:interaction-workspace:privilege-SRL-can-use}} option must be enabled.
 +
* The following options are configured:
 +
** {{Optionslink|link=Options:Genesys_Web_Services:interaction-workspace:standard-response-categories}}
 +
** {{Optionslink|link=Options:Genesys_Web_Services:interaction-workspace:standard-response-field-Agent-zCustomFieldCode-}} and/or {{Optionslink|link=Options:Genesys_Web_Services:interaction-workspace:standard-response-field-zCustomFieldCode-}}
 +
**:In the name of the option, <tt>CustomFieldCode</tt> represents a field code that is called in a Standard Response object created in [[Documentation:ESDA:ESMgr:fieldcode|eServices Manager]] and stored in Universal Contact Server. Use this option to specify a custom field code such as an agent nickname, role, department, or other qualification. The value of the option is specific to the agent, agent group, tenant, or application. Refer to [[IntSRL|Standard Responses Library]] for more information.
 +
**:The value of this option represents the data that is used to populate the corresponding field codes when a Standard Response is inserted into an interaction. You can format <tt>CustomFieldCode</tt> to represent a custom agent attribute using the following pattern: <tt>Agent.&lt;CustomAgentAttr&gt;</tt>, or any custom attribute by dropping the agent modifier: <tt>&lt;CustomFieldCode&gt;</tt>.
 +
**: '''Examples''':
 +
**:* <tt>standard-response.field.Agent.Nickname = Lee</tt>
 +
**:* <tt>standard-response.field.Department = Sales</tt>
 +
* Optional. To allow agents to use the Quick Search feature of the Responses database, enable the {{Optionslink|link=Options:Genesys_Web_Services:interaction-workspace:privilege-SRL-can-quick-search}} option.
 +
* Optional. To allow your agents to mark and unmark responses as favorites and filter the '''Responses''' tab to show only favorite responses, grant the {{Optionslink|link=Options:Genesys_Web_Services:interaction-workspace:privilege-standard-response-favorites-can-use}} privilege.
 +
* Optional. To create shortcuts for Standard Responses that an agent can type in the message composition field to automatically insert a Response into an active email or chat interaction, make the following configurations:
 +
** Define a prefix, such as "#", that will indicate that the following word is a keyword, such as "JulySale". Specify the prefix as the value for the {{Optionslink|link=Options:Genesys_Web_Services:interaction-workspace:editor-SRL-shortcuts-prefix}} option. In this example, the shortcut an agent would use is "#JulySale".
 +
** Define the keyword for the shortcut by creating the {{Optionslink|link=Options:Genesys_Web_Services:interaction-workspace:standard-response-shortcuts-zkeyword-}} option where the name of the option represents the keyword to be entered by agents to use the shortcut. For example: '''standard-response.shortcuts.JulySale'''. Specify the path to the Response that is defined in Knowledge Manager as the value for this option. For example '''2021Specials\JulySale'''.
 +
* Optional. To enable agents to use a shortcut to insert a Standard Response to an email or chat interaction, allow the following privileges:
 +
** {{Optionslink|link=Options:Genesys_Web_Services:interaction-workspace:privilege-standard-response-shortcuts-can-use}}: Allows an agent to use responses shortcuts.
 +
** {{Optionslink|link=Options:Genesys_Web_Services:interaction-workspace:privilege-standard-response-shortcuts-can-filter}}: Allows an agent to filter the '''Responses''' view to see only those with assigned shortcuts.
 +
* Optional. To enable agents to use the Suggested Responses feature to find the most relevant responses from the Standard Response Library, then insert a Standard Response to an email or chat interaction, allow the following privileges and set the following option:
 +
** {{Optionslink|link=Options:Genesys_Web_Services:interaction-workspace:privilege-standard-response-suggested-response-can-use}}: Enables an agent to use suggested responses in the '''Responses''' view.
 +
** {{Optionslink|link=Options:Genesys_Web_Services:interaction-workspace:standard-response-suggested-responses-min-relevance}}: Specifies the minimum level of relevance to filter the display of suggested responses in the '''Responses''' view.
 +
** {{Optionslink|link=Options:Genesys_Web_Services:interaction-workspace:standard-response-suggested-categories-max-number}}: Specifies the maximum number of suggested response categories displayed in the '''Responses''' view.
 +
* Optional. Ensure that privileges related to channels are enabled. For more details, see:
 +
** [[Documentation:HTCC:IWWDep:SettingUpAgents|Setting Up Agents]]
 +
** [[Documentation:HTCC:IWWDep:IntVoice|Voice Interactions]]
 +
** [[Documentation:HTCC:IWWDep:IntEmail|Email Interactions]]
 +
** [[Documentation:HTCC:IWWDep:IntChat|Chat Interactions]]
 +
<!--** [[Documentation:HTCC:IWWDep:IntTwitter|Twitter Interactions]]-->
 +
<!--** [[Documentation:HTCC:IWWDep:IntFacebook|Facebook Interactions]]-->
 +
 
 +
To enable an agent to access the [[Documentation/UCS|Universal Contact Server]] database of prewritten standard responses for interactions:
 +
 
 +
<OL type="1">
 +
<li>For information about creating and managing Standard Responses and standard response field codes, refer to [[Documentation:ESDA:ESMgr:fieldcode|eServices Manager]].
 +
</li>
 +
<li>Enable an index search on SRL in the [[Documentation/UCS|Universal Contact Server]] configuration.
 +
<ul>
 +
<li>Set the <tt>index\enabled</tt> option to <tt>true</tt>.</li>
 +
<li>Set the <tt>index.srl\enabled</tt> option to <tt>true</tt>.</li>
 +
</ul>
 +
For more details about these settings, refer to the [[Documentation:Options:ES:UniversalContactServer-index|UCS Configuration Options]].</li>
 +
<li>Configure the other [[Documentation:Options:HTCC:GWS-interaction-workspace:Current|Standard Response options]] to meet the requirements of your environment.</li>
 +
<li>(Optional) Create custom field codes for agents, agent groups, tenants, or at the application level that can be used by Standard Response objects. Use the <tt>standard-response.field.&lt;&#91;Agent.&#93;CustomFieldCode&gt;</tt> option to specify a custom field code and value, such as an agent nickname, role, department, or other qualification, and then insert the field code into a Standard Response object.<br><br>
 +
For example, you could create a set of field codes for a Standard Response for an agent signature such as the following:
 +
<source lang="text">
 +
Name: "Signature"
 +
Text: "<$ Agent.Title $> <$ Agent.FullName $> (< $Agent.NickName$ >) - <$ Agent.Position $>
 +
<$ Department $>"
 +
</source>
 +
In the Agent annex configure <tt>standard-response.field.&lt;[Agent.]CustomFieldCode&gt;</tt>:
 +
<ul>
 +
<li><tt>'interaction-workspace'/'standard-response.field.Agent.Title' = "Ms"</tt></li>
 +
<li><tt>'interaction-workspace'/'standard-response.field.Agent.NickName' = "Beth"</tt></li>
 +
<li><tt>'interaction-workspace'/'standard-response.field.Agent.Position' = "Technical Support Analyst"</tt></li>
 +
</ul>
 +
In the Agent Group annex (in Configuration Server):
 +
<ul>
 +
<li><tt>'interaction-workspace'/'standard-response.field.Department' = "Customer Care"</tt></li>
 +
</ul>
 +
</li>
 +
</ol>  
 +
 
 +
[[Category:V:HTCC:9.0.0DRAFT]]

Latest revision as of 19:01, July 27, 2022

Standard Responses Library

The Standard Responses Library (SRL) enables agents to access a database of prewritten standard responses for interactions. Agents can insert these responses as replies into any email or chat message.

Agents can modify the contents of a standard response after inserting it into an email interaction or chat message.

To use the Standard Responses Library, you must set up the multimedia feature in Web Services, by using the features-definition.json file.

Agents can insert these responses as replies into any email, instant messaging, or chat message, or they can read them to the contact during a voice interaction.

Before you begin, ensure the following prerequisites are met:

  • A GWS Application Server object object exists in the Configuration Database.
  • Workspace has a connection to Universal Contact Server.
  • The privilege.SRL.can-use option must be enabled.
  • The following options are configured:
    • standard-response.categories
    • standard-response.field.Agent.<CustomFieldCode> and/or standard-response.field.<CustomFieldCode>
      In the name of the option, CustomFieldCode represents a field code that is called in a Standard Response object created in eServices Manager and stored in Universal Contact Server. Use this option to specify a custom field code such as an agent nickname, role, department, or other qualification. The value of the option is specific to the agent, agent group, tenant, or application. Refer to Standard Responses Library for more information.
      The value of this option represents the data that is used to populate the corresponding field codes when a Standard Response is inserted into an interaction. You can format CustomFieldCode to represent a custom agent attribute using the following pattern: Agent.<CustomAgentAttr>, or any custom attribute by dropping the agent modifier: <CustomFieldCode>.
      Examples:
      • standard-response.field.Agent.Nickname = Lee
      • standard-response.field.Department = Sales
  • Optional. To allow agents to use the Quick Search feature of the Responses database, enable the privilege.SRL.can-quick-search option.
  • Optional. To allow your agents to mark and unmark responses as favorites and filter the Responses tab to show only favorite responses, grant the privilege.standard-response.favorites.can-use privilege.
  • Optional. To create shortcuts for Standard Responses that an agent can type in the message composition field to automatically insert a Response into an active email or chat interaction, make the following configurations:
    • Define a prefix, such as "#", that will indicate that the following word is a keyword, such as "JulySale". Specify the prefix as the value for the editor.SRL.shortcuts.prefix option. In this example, the shortcut an agent would use is "#JulySale".
    • Define the keyword for the shortcut by creating the standard-response.shortcuts.<keyword> option where the name of the option represents the keyword to be entered by agents to use the shortcut. For example: standard-response.shortcuts.JulySale. Specify the path to the Response that is defined in Knowledge Manager as the value for this option. For example 2021Specials\JulySale.
  • Optional. To enable agents to use a shortcut to insert a Standard Response to an email or chat interaction, allow the following privileges:
  • Optional. To enable agents to use the Suggested Responses feature to find the most relevant responses from the Standard Response Library, then insert a Standard Response to an email or chat interaction, allow the following privileges and set the following option:
  • Optional. Ensure that privileges related to channels are enabled. For more details, see:

To enable an agent to access the Universal Contact Server database of prewritten standard responses for interactions:

  1. For information about creating and managing Standard Responses and standard response field codes, refer to eServices Manager.
  2. Enable an index search on SRL in the Universal Contact Server configuration.
    • Set the index\enabled option to true.
    • Set the index.srl\enabled option to true.
    For more details about these settings, refer to the UCS Configuration Options.
  3. Configure the other Standard Response options to meet the requirements of your environment.
  4. (Optional) Create custom field codes for agents, agent groups, tenants, or at the application level that can be used by Standard Response objects. Use the standard-response.field.<[Agent.]CustomFieldCode> option to specify a custom field code and value, such as an agent nickname, role, department, or other qualification, and then insert the field code into a Standard Response object.

    For example, you could create a set of field codes for a Standard Response for an agent signature such as the following:
    Name: "Signature"
    Text: "<$ Agent.Title $> <$ Agent.FullName $> (< $Agent.NickName$ >) - <$ Agent.Position $>
    <$ Department $>"

    In the Agent annex configure standard-response.field.<[Agent.]CustomFieldCode>:

    • 'interaction-workspace'/'standard-response.field.Agent.Title' = "Ms"
    • 'interaction-workspace'/'standard-response.field.Agent.NickName' = "Beth"
    • 'interaction-workspace'/'standard-response.field.Agent.Position' = "Technical Support Analyst"

    In the Agent Group annex (in Configuration Server):

    • 'interaction-workspace'/'standard-response.field.Department' = "Customer Care"
This page was last edited on July 27, 2022, at 19:01.
Comments or questions about this documentation? Contact us for support!