email.inline-forward-header
Section: interaction-workspace
Default Value: $FullHeader$
Valid Values: Any valid character string.
Changes Take Effect: After the next platform configuration refresh interval.
Introduced: 9.0.000.31
Specifies the character string that is used to introduce the inbound email content in the body of the inline forward email. The value $FullHeader$ inserts the entire header of the inbound email interaction into the inline forwarded email. You can also choose to include any other text. The following tags are supported: <contact>, <date>. This enables you to create a custom header, such as: 'On <date>, <contact> wrote:'.
email.inline-forward-prefix
Section: interaction-workspace
Default Value: Fwd:
Valid Values: Any valid character string.
Changes Take Effect: After the next platform configuration refresh interval.
Introduced: 9.0.000.31
Specifies the inline forward prefix that is added to subject of the forwarded inbound email interaction.
email.inline-forward-queue
Section: interaction-workspace
Default Value: No default value
Valid Values: A valid name of a Script of type Interaction Queue.
Changes Take Effect: After the next platform configuration refresh interval.
Introduced: 9.0.000.31
Specifies the Interaction queue in which in-line forwarded inbound emails are submitted.
privilege.contact.can-inline-forward.email.from-history
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 agents to forward email interactions from the Interaction History that are marked as Done.
privilege.email.can-inline-forward
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 agents to forward an email in a new email interaction. The forwarded email appears inline in the new email.
email.signature.line-<n>
Section: interaction-workspace
Default Value: No default value
Valid Values: Any valid character string.
Changes Take Effect: After the next platform configuration refresh interval.
Introduced: 9.0.000.31
Specifies the row number of the signature by a string that can contain regular characters and the following field codes: $Agent.LastName$,$Agent.FirstName$,$Agent.FullName$. <n> is starting at 0. This option can be overridden by a routing strategy as described in the Configuration Guide.
email.signature
Section: interaction-workspace
Default Value: No default value
Valid Values: \"response:\" followed by the response path to the standard response
Changes Take Effect: After the next platform configuration refresh interval.
Introduced: 9.0.000.31
Specifies the type and location of the signature template that Workspace should add to outgoing emails. The value has two components that are separated by a colon:
1. 'response'
2. The standard response name and the full path of the parent category in the Standard Response Library.
For example, 'response:Signatures\Classic'.
This option can be overridden by a routing strategy as described in the Configuration Guide.
editor.default-font-size
Section: interaction-workspace
Default Value: 9
Valid Values: A value from the following list: the following list: 8, 9, 10, 11, 12, 14, 16, 18, 20, 22, 24, 26, 28, 36, 48, 72. Empty means no default font size specified.
Changes Take Effect: After the next platform configuration refresh interval.
Introduced: 9.0.000.31
Specifies the default font size in the Font Size menu of new and reply HTML formatted email interactions. If empty, the last selected font size is used for email interactions by default.
editor.default-font
Section: interaction-workspace
Default Value: Serif
Valid Values: A value from the following list: the following list: Serif, Sans-serif, Monospace, Cursive, Fantasy, Tahoma, Roboto. Empty means no default font specified.
Changes Take Effect: After the next platform configuration refresh interval.
Introduced: 9.0.000.31
Modified: 9.0.000.50
Specifies the default font in the Font menu of new and reply HTML format email interactions. If this option is left empty, the last selected font is used for email interactions by default.
editor.font-sizes
Section: interaction-workspace
Default Value: 8,
Valid Values: Comma-separated list of font sizes from the following list: 8, 9, 10, 11, 12, 14, 16, 18, 20, 22, 24, 26, 28, 36, 48, 72.
Changes Take Effect: After the next platform configuration refresh interval.
Introduced: 9.0.000.31
Specifies the font sizes available in the Font Size menu of new and reply HTML formatted email interactions. The sizes are displayed in the order in which they appear in the list.
editor.fonts
Section: interaction-workspace
Default Value: Serif,
Valid Values: Comma-separated list of fonts from the following list: Serif, Sans-serif, Monospace, Cursive, Fantasy, Tahoma, Roboto, Arial, Helvetica.
Changes Take Effect: After the next platform configuration refresh interval.
Introduced: 9.0.000.31
Modified: 9.0.000.61
Specifies the list of available fonts in the Fonts menu of new and reply HTML format email interactions. The fonts are displayed in the order in which they appear in the list.
interaction.disposition.value-business-attribute
Section: interaction-workspace
Default Value: DispositionCode
Valid Values: A valid Business Attribute name.
Changes Take Effect: After the next platform configuration refresh interval.
Introduced: 9.0.000.31
Specifies the name of the Business Attribute that contains the Attribute Values that are used as an enumerated value for a disposition code. This option can be overridden by a routing strategy as described in the Configuration Guide.
interaction.disposition.use-attached-data
Section: interaction-workspace
Default Value: false
Valid Values: true, false
Changes Take Effect: After the next platform configuration refresh interval.
Introduced: 9.0.000.68
Specifies that attached data can be added to the interaction in UserEvent. This option can be overridden by a routing strategy as described in the Configuration Guide.
interaction.disposition.key-name
Section: interaction-workspace
Default Value: DispositionCode
Valid Values: A valid key name.
Changes Take Effect: After the next platform configuration refresh interval.
Introduced: 9.0.000.31
Specifies the key that is used to populate attached data or a user event when a disposition code is submitted to the back-end system, such as T-Server, Interaction Server, and Contact Server. This option can be overridden by a routing strategy as described in the Configuration Guide.
interaction.disposition.is-mandatory
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
Specifies whether it is mandatory for the agent to set a disposition code before Marking Done an interaction. This option can be overridden by a routing strategy as described in the Configuration Guide.
email.ringing-bell
Section: interaction-workspace
Default Value: No default value
Valid Values: All special characters that are valid URL file path, '|' separator and numeric values.
Changes Take Effect: Immediately
Introduced: 9.0.000.31
Modified: 9.0.000.88
Specifies the path of the sound file Workspace plays when an email interaction is ringing. For example: 'BELL|7|0|100'. The value has four components that are separated by the pipe ('|') character.
1. The sound file name (the BELL, RING, CHORD or WARNING predefined aliases or an absolute URL to a MP3 file).
2. A priority: the higher the integer, the higher the priority.
3. The duration, which can have the following values:
- -1: play and repeat the sound until an explicit message, such as event established, causes it to stop,
- 0: play the whole sound once,
- an integer greater than 0: the length of time, in milliseconds, to play and repeat the sound.
4. The volume from 0 to 100 (100 is the default).
email.reply-prefix
Section: interaction-workspace
Default Value: Re:
Valid Values: Any valid character string.
Changes Take Effect: After the next platform configuration refresh interval.
Introduced: 9.0.000.31
Specifies the reply prefix that is added to subject of the inbound email interaction.
email.reply-format
Section: interaction-workspace
Default Value: auto
Valid Values: Select a value from the following list: auto, html, plain-text.
Changes Take Effect: After the next platform configuration refresh interval.
Introduced: 9.0.000.31
Specifies the format of an outgoing email reply:
- auto: outgoing email reply format is the same as corresponding inbound email.
- html: outgoing email reply format is forced to html.
- plain-text: outgoing email reply format is forced to plain text.
email.quote-header
Section: interaction-workspace
Default Value: On <date>, <contact> wrote:
Valid Values: Any valid character string.
Changes Take Effect: After the next platform configuration refresh interval.
Introduced: 9.0.000.31
Specifies the character string that is used to introduce the quoted inbound email interaction content in the body of the outgoing email. The value $FullHeader$ inserts the entire header of the inbound email into the outgoing email. You can also choose to include any other text. The following tags are supported: <contact>, <date>. This enables you to create a custom header, such as: 'On <date>, <contact> wrote:'.
email.quote-char
Section: interaction-workspace
Default Value: >
Valid Values: Any valid character string.
Changes Take Effect: After the next platform configuration refresh interval.
Introduced: 9.0.000.31
For outgoing email that is formatted as plain text, specifies the characters that are used to quote the contents of the inbound email interaction in the outgoing email interaction body.
email.prompt-for-done
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
Specifies if the application prompts a confirmation message when the user clicks Done. This option is only available for interaction open media. This option can be overridden by a routing strategy as described in the Configuration Guide.
email.include-original-text-in-reply
Section: interaction-workspace
Default Value: true
Valid Values: true, false.
Changes Take Effect: After the next platform configuration refresh interval.
Introduced: 9.0.000.31
Specifies whether the text of the original inbound email interaction is included in the outgoing reply email. This option can be overridden by a routing strategy as described in the Configuration Guide.
email.html-format
Section: interaction-workspace
Default Value: true
Valid Values: true, false.
Changes Take Effect: After the next platform configuration refresh interval.
Introduced: 9.0.000.31
Specifies the format of a new outgoing email. When set to true, new email is formatted in HTML.
email.from-addresses
Section: interaction-workspace
Default Value: No default value
Valid Values: The name of a valid Business Attribute.
Changes Take Effect: After the next platform configuration refresh interval.
Introduced: 9.0.000.31
Specifies a character string that specifies the name of the Business Attribute which contains the Attribute Values that are used as available addresses. These come from the addresses of email interactions. You can set a default value by using the flag from the Business Attribute value. This option can be overridden by a routing strategy as described in the Configuration Guide.
email.auto-answer
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
Specifies whether an email interaction is automatically accepted when a Interaction Server Invite event is received. This option can be overridden by a routing strategy as described in the Configuration Guide.
attachment.restrict-to-file-types
Section: workspace-service
Default Value: jpg,png,gif,pdf,doc,docx,ppt,pptx,xls,xlsx,txt,json
Valid Values: A comma-separated list of file extensions that represent file types that are allowed.
Changes Take Effect: Immediately
Introduced: 9.0.000.31
Specifies the list of file extensions that represent file types that are allowed to be used as attachments. The request is rejected if extension of file is not part of restricted types. This option cannot be overridden and must be set in the WS_Cluster application.
email.max-attachments-size
Section: interaction-workspace
Default Value: 0
Valid Values: A positive integer.
Changes Take Effect: After the next platform configuration refresh interval.
Introduced: 9.0.000.31
Specifies the maximum number of total megabytes of files that agents can attach to an external email interaction. An error message is displayed to the agent if the total number of megabytes for all attached files exceeds this value. The value 0 means that there is no restriction.
email.max-attachment-size
Section: interaction-workspace
Default Value: 0
Valid Values: A positive integer.
Changes Take Effect: After the next platform configuration refresh interval.
Introduced: 9.0.000.31
Related Options: attachment.max-file-upload-size
Specifies the maximum number of megabytes of one file that agents can attach to an external email interaction. The attachment is refused by the system and an error message is displayed to the agent if the size in megabytes of the attached file exceeds this value. The value 0 means that the value specified by the attachment.max-file-upload-size option is used.
workbin.email.in-progress
Section: interaction-workspace
Default Value: No default value
Valid Values: The name of a valid Script object of type Interaction Workbin that is owned by Agents.
Changes Take Effect: After the next platform configuration refresh interval.
Introduced: 9.0.000.31
Specifies the name of the workbin that is to be used to store inbound email for later processing, after an agent explicitly saved the email or submitted an outbound reply.
email.outbound-queue
Section: interaction-workspace
Default Value: No default value
Valid Values: A valid name of a Script of type Interaction Queue.
Changes Take Effect: After the next platform configuration refresh interval.
Introduced: 9.0.000.31
Specifies the Interaction Queue in which outgoing emails are placed when agents click Send or Send Interim. This options is used only when Interaction Workflow does not set Queue for New Interactions when it is routing inbound email interactions to agents.
email.default-queue
Section: interaction-workspace
Default Value: No default value
Valid Values: A valid name of a Script of type Interaction Queue.
Changes Take Effect: After the next platform configuration refresh interval.
Introduced: 9.0.000.31
Specifies the Interaction queue in which new or reply outgoing emails are submitted.
privilege.email.can-send
Section: interaction-workspace
Default Value: true
Valid Values: true, false.
Changes Take Effect: After the next platform configuration refresh interval.
Introduced: 9.0.000.31
Enables an agent to send outgoing email interactions.
privilege.email.can-save
Section: interaction-workspace
Default Value: true
Valid Values: true, false.
Changes Take Effect: After the next platform configuration refresh interval.
Introduced: 9.0.000.31
Enables an agent to save in-progress outgoing email interactions.
privilege.email.can-reply-all
Section: interaction-workspace
Default Value: true
Valid Values: true, false.
Changes Take Effect: After the next platform configuration refresh interval.
Introduced: 9.0.000.31
Enables an agent to reply to all parties included in the distribution of inbound email interactions.
privilege.email.can-reply
Section: interaction-workspace
Default Value: true
Valid Values: true, false.
Changes Take Effect: After the next platform configuration refresh interval.
Introduced: 9.0.000.31
Enables an agent to reply to inbound email interactions.
privilege.email.can-one-step-transfer
Section: interaction-workspace
Default Value: true
Valid Values: true, false.
Changes Take Effect: After the next platform configuration refresh interval.
Introduced: 9.0.000.31
Enables an agent to one-step transfer email interactions.
privilege.email.can-move-to-workbin
Section: interaction-workspace
Default Value: true
Valid Values: true, false.
Changes Take Effect: After the next platform configuration refresh interval.
Introduced: 9.0.000.31
Enables an agent to move email interactions to workbins.
privilege.email.can-mark-done
Section: interaction-workspace
Default Value: true
Valid Values: true, false.
Changes Take Effect: After the next platform configuration refresh interval.
Introduced: 9.0.000.31
Enables the agent to mark done an interaction without further processing.
privilege.email.can-delete
Section: interaction-workspace
Default Value: true
Valid Values: true, false.
Changes Take Effect: After the next platform configuration refresh interval.
Introduced: 9.0.000.31
Enables an agent to delete outgoing email interactions.
privilege.email.can-decline
Section: interaction-workspace
Default Value: true
Valid Values: true, false.
Changes Take Effect: After the next platform configuration refresh interval.
Introduced: 9.0.000.31
Enables the agent to decline incoming email interactions. Depends on 'Email - Can Use Email Channel'.
privilege.email.can-add-attachment
Section: interaction-workspace
Default Value: true
Valid Values: true, false.
Changes Take Effect: After the next platform configuration refresh interval.
Introduced: 9.0.000.31
Enables an agent to add attached files to outgoing emails.
workbin.email.in-progress
Section: interaction-workspace
Default Value: No default value
Valid Values: The name of a valid Script object of type Interaction Workbin that is owned by Agents.
Changes Take Effect: After the next platform configuration refresh interval.
Introduced: 9.0.000.31
Specifies the name of the workbin that is to be used to store inbound email for later processing, after an agent explicitly saved the email or submitted an outbound reply.
workbin.email.draft
Section: interaction-workspace
Default Value: No default value
Valid Values: The name of a valid Script object of type Interaction Workbin that is owned by Agents.
Changes Take Effect: After the next platform configuration refresh interval.
Introduced: 9.0.000.31
Specifies the name of the workbin to be used to store draft email.
email.outbound-queue
Section: interaction-workspace
Default Value: No default value
Valid Values: A valid name of a Script of type Interaction Queue.
Changes Take Effect: After the next platform configuration refresh interval.
Introduced: 9.0.000.31
Specifies the Interaction Queue in which outgoing emails are placed when agents click Send or Send Interim. This options is used only when Interaction Workflow does not set Queue for New Interactions when it is routing inbound email interactions to agents.
email.default-queue
Section: interaction-workspace
Default Value: No default value
Valid Values: A valid name of a Script of type Interaction Queue.
Changes Take Effect: After the next platform configuration refresh interval.
Introduced: 9.0.000.31
Specifies the Interaction queue in which new or reply outgoing emails are submitted.
privilege.email.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 the agent is use the Email channel.
(Created target blank page For Version: HTCC:9.0.0) |
(Update with the copy of version: 9.0.0DRAFT) |
||
Line 1: | Line 1: | ||
− | <!-- | + | =Email= |
+ | __TOC__ | ||
+ | Workspace Agent Desktop enables agents to handle email interactions, including the following functionality: | ||
+ | * Decline an interaction | ||
+ | * Release an interaction | ||
+ | * Move an interaction to a Workbin | ||
+ | * Reply to an interaction (with or without the original text) | ||
+ | * Reply All to an interaction (with or without the original text) | ||
+ | * Add Attachments to an interaction | ||
+ | * Send an interaction | ||
+ | * Save an interaction | ||
+ | * Delete an interaction | ||
+ | * Create new outbound emails | ||
+ | * Check the spelling of an outbound email | ||
+ | * Apply a signature to an outbound email | ||
+ | * Store emails in a workbin | ||
+ | * Transfer an email to an internal target | ||
+ | * Set a disposition code | ||
+ | * Mark the interaction as Done | ||
+ | * View and copy links to non-embedded images in inbound and outbound email interactions | ||
+ | * View and insert Standard Responses | ||
+ | * Paste content from browsers and other applications that display HTML | ||
+ | * Paste images from browsers and other applications that display HTML | ||
+ | |||
+ | ==Mandatory Functionality== | ||
+ | The following are mandatory options for correct email interaction handling: | ||
+ | * {{Optionslink|link=Options:Genesys_Web_Services:interaction-workspace:privilege-email-can-use}}: Mandatory to use the email channel. When the value of this option is set to <tt>true</tt>, the agent is permitted to use the Email channel. | ||
+ | * {{Optionslink|link=Options:Genesys_Web_Services:interaction-workspace:email-default-queue}}: Specifies the default queue for email interactions. | ||
+ | * {{Optionslink|link=Options:Genesys_Web_Services:interaction-workspace:email-outbound-queue}}: Specifies the default queue for email interactions. | ||
+ | * {{Optionslink|link=Options:Genesys_Web_Services:interaction-workspace:workbin-email-draft}}: Specifies the name of the Workbin to be used to store draft emails | ||
+ | * {{Optionslink|link=Options:Genesys_Web_Services:interaction-workspace:workbin-email-in-progress}}: Specifies the workbin to be used to store emails which are in the <tt>In Progress</tt> state. | ||
+ | ==Granting Email Privileges== | ||
+ | Workspace Agent Desktop uses the following privileges to enable email-related functionality: | ||
+ | {| class="no-border" | ||
+ | | | ||
+ | *{{Optionslink|link=Options:Genesys_Web_Services:interaction-workspace:privilege-email-can-add-attachment}} | ||
+ | *{{Optionslink|link=Options:Genesys_Web_Services:interaction-workspace:privilege-email-can-decline}} | ||
+ | *{{Optionslink|link=Options:Genesys_Web_Services:interaction-workspace:privilege-email-can-delete}} | ||
+ | *{{Optionslink|link=Options:Genesys_Web_Services:interaction-workspace:privilege-email-can-mark-done}} | ||
+ | *{{Optionslink|link=Options:Genesys_Web_Services:interaction-workspace:privilege-email-can-move-to-workbin}} | ||
+ | | | ||
+ | *{{Optionslink|link=Options:Genesys_Web_Services:interaction-workspace:privilege-email-can-one-step-transfer}} | ||
+ | *{{Optionslink|link=Options:Genesys_Web_Services:interaction-workspace:privilege-email-can-reply}} | ||
+ | *{{Optionslink|link=Options:Genesys_Web_Services:interaction-workspace:privilege-email-can-reply-all}} | ||
+ | *{{Optionslink|link=Options:Genesys_Web_Services:interaction-workspace:privilege-email-can-save}} | ||
+ | *{{Optionslink|link=Options:Genesys_Web_Services:interaction-workspace:privilege-email-can-send}} | ||
+ | |} | ||
+ | |||
+ | == Enabling the Email channel== | ||
+ | You can enable agents to use Email to correspond with a contact that is stored in Universal Contact Server (UCS). | ||
+ | |||
+ | Before you begin, ensure that the following prerequisites are met: | ||
+ | |||
+ | * A working knowledge of Genesys Administrator Extension (GAX). | ||
+ | * The <tt>Cloud_Cluster</tt> application object exists in the Configuration Database. | ||
+ | * The <tt>Cloud_Cluster</tt> application has a connection to Universal Contact Server and Interaction Server. | ||
+ | * [[EnablingAgentsToManageContacts|Procedure: Enabling agents to manage contacts]]. | ||
+ | * A [[Documentation/R|capacity rule]] that allows Agents to receive email interactions. | ||
+ | |||
+ | To enable agents to email contacts: | ||
+ | |||
+ | <ol type="1"> | ||
+ | <li>Configure the [[IntEmail#Mandatory_Functionality|mandatory Email options]] in the <tt>interaction-workspace</tt> section of the <tt>Cloud_Cluster</tt> application object.</li> | ||
+ | <li>Configure the email queue options in the <tt>email</tt> section that are mandatory for basic email processing: {{Optionslink|link=Options:Genesys_Web_Services:interaction-workspace:email-default-queue}} and {{Optionslink|link=Options:Genesys_Web_Services:interaction-workspace:email-outbound-queue}}.</li> | ||
+ | <li>Configure the [[IntWorkbins|Workbin]] options in the <tt>interaction-workspace</tt> section of the <tt>Cloud_Cluster</tt> application object, them), in particular: {{Optionslink|link=Options:Genesys_Web_Services:interaction-workspace:workbin-email-in-progress}} and <tt>workbin.email.draft</tt>.</li> | ||
+ | <li>To control the size of an attachment that agents are allowed to attach to an external email interaction, configure the {{Optionslink|link=Options:Genesys_Web_Services:interaction-workspace:email-max-attachment-size}} option in the <tt>interaction-workspace</tt> section of the <tt>Cloud_Cluster</tt> application object.</li> | ||
+ | <li>To control the total size of attachments that agents are allowed to attach to an external email interaction, configure the {{Optionslink|link=Options:Genesys_Web_Services:interaction-workspace:email-max-attachments-size}} option in the <tt>interaction-workspace</tt> section of the <tt>Cloud_Cluster</tt> application object.</li> | ||
+ | <li>To specify the list of file extensions that represent file types that are to be prevented from being used as attachments, configure the {{Optionslink|link=Options:Genesys_Web_Services:workspace-service:attachment-restrict-to-file-types}} option in the <tt>workspace-service</tt> section of the <tt>Cloud_Cluster</tt> application object.</li> | ||
+ | <li>To specify the list of file extensions that represent file types that are to be prevented from being used as attachments specifically for the email channel, configure the {{Optionslink|link=Options:Genesys_Web_Services:workspace-service:attachment-zmedia-name-zrestrict-to-file-types}} (<tt>attachment.email.restrict-to-file-types</tt>) option in the <tt>workspace-service</tt> section of the <tt>Cloud_Cluster</tt> application object.</li> | ||
+ | </ol> | ||
+ | |||
+ | ==Optional Functionality== | ||
+ | You can also use the following options for email interaction handling: | ||
+ | * {{Optionslink|link=Options:Genesys_Web_Services:interaction-workspace:email-auto-answer}}: Specifies whether an email interaction is automatically accepted when a Interaction Server Invite event is received. | ||
+ | * {{Optionslink|link=Options:Genesys_Web_Services:interaction-workspace:email-from-addresses}}: Specifies a character string that specifies the name of the Business Attribute which contains the Attribute Values that are used as available addresses. You can set a default value by using the flag from the Business Attribute value. These come from the addresses of email interactions. This option can be overridden by a routing strategy. | ||
+ | * {{Optionslink|link=Options:Genesys_Web_Services:interaction-workspace:email-html-format}}: Specifies the format of a new outbound email. When set to <tt>true</tt>, new email will be formatted in HTML. | ||
+ | * {{Optionslink|link=Options:Genesys_Web_Services:interaction-workspace:email-include-original-text-in-reply}}: Specifies whether the text of the original inbound email is included in the outbound reply email. | ||
+ | * {{Optionslink|link=Options:Genesys_Web_Services:interaction-workspace:email-prompt-for-done}}: Specifies if the application prompts a confirmation message when the user clicks Done. This option is only available for interaction open media. | ||
+ | * {{Optionslink|link=Options:Genesys_Web_Services:interaction-workspace:email-quote-char}}: For outbound email that is formatted as plain text, specifies the characters that are used to quote the contents of the inbound email interaction in the outbound email interaction body. | ||
+ | * {{Optionslink|link=Options:Genesys_Web_Services:interaction-workspace:email-quote-header}}: Specifies the character string that is used to introduce the quoted inbound email content in the body of the outbound email. The value $FullHeader$ inserts the entire header of the inbound email into the outbound email. You can also choose to include any other text. The following tags are supported: <contact>, <date>. This enables you to create a custom header, such as: "On <date>, <contact> wrote:" | ||
+ | * {{Optionslink|link=Options:Genesys_Web_Services:interaction-workspace:email-reply-format}}: Specifies the format of an outbound email reply. | ||
+ | * {{Optionslink|link=Options:Genesys_Web_Services:interaction-workspace:email-reply-prefix}}: Specifies the reply-prefix that is added to subject of the inbound email. | ||
+ | * {{Optionslink|link=Options:Genesys_Web_Services:interaction-workspace:email-ringing-bell}}: Specifies the path of the sound file Workspace plays when an email interaction is ringing. | ||
+ | * {{Optionslink|link=Options:Genesys_Web_Services:interaction-workspace:interaction-disposition-is-mandatory}}: Specifies whether it is mandatory for the agent to set a disposition code before Marking Done an interaction. This option can be overridden by a routing strategy. | ||
+ | * {{Optionslink|link=Options:Genesys_Web_Services:interaction-workspace:interaction-disposition-key-name}}: The key that is used to populate attached data or a user event when a disposition code is submitted to the back-end system, such as T-Server, Interaction Server, and Contact Server. This option can be overridden by a routing strategy. | ||
+ | * {{Optionslink|link=Options:Genesys_Web_Services:interaction-workspace:interaction-disposition-use-attached-data}}: Enables the adding of attached data from the interaction in UserEvent. This option can be overridden by a routing strategy. | ||
+ | * {{Optionslink|link=Options:Genesys_Web_Services:interaction-workspace:interaction-disposition-value-business-attribute}}: A character string that specifies the name of the Business Attribute that contains the Attribute Values that are used as an enumerated value for a disposition code. This option can be overridden by a routing strategy. | ||
+ | You can use the following options to control the default and available fonts for outgoing email interactions: | ||
+ | * {{Optionslink|link=Options:Genesys_Web_Services:interaction-workspace:editor-fonts}}: the list of available fonts in the font menu. | ||
+ | * {{Optionslink|link=Options:Genesys_Web_Services:interaction-workspace:editor-font-sizes}}: the list of available font sizes in the font size menu. | ||
+ | * {{Optionslink|link=Options:Genesys_Web_Services:interaction-workspace:editor-default-font}}: the default font for all new or reply outgoing email interactions. | ||
+ | * {{Optionslink|link=Options:Genesys_Web_Services:interaction-workspace:editor-default-font-size}}: the default font size for all new or reply outgoing email interactions. | ||
+ | |||
+ | == Signatures == | ||
+ | Workspace Agent Desktop enables you to assign default signature templates to outbound email interactions. Email signatures allow the insertion of tagged-data fields with data that is related to the agent, such as name, job title, department, phone number, email address, and so on. Refer to "Using UCS Data in Standard Responses: System Variables" in the "Genesys Knowledge Management: Basics" chapter of the [[Documentation/ES|eServices]] User's Guide for more information about the tagged data field. Signatures also support linked image(s) and hyperlinks. | ||
+ | |||
+ | Use the {{Optionslink|link=Options:Genesys_Web_Services:interaction-workspace:email-signature}} configuration option in the '''[interaction-workspace]''' section to specify the type and location of the signature template that Workspace should add to outbound emails. | ||
+ | |||
+ | Use the {{Optionslink|link=Options:Genesys_Web_Services:interaction-workspace:email-signature-line-zn-}} configuration option in the '''[interaction-workspace]''' section to specify the path and name of the signature file or the location of the Response in the Standard Response Library that is to be used as the default signature. | ||
+ | |||
+ | {{NoteFormat|This option can be overridden by a routing strategy based on the attached data of the interaction.|2}} | ||
+ | |||
+ | ==Forwarding Inbound Email== | ||
+ | Workspace Agent Desktop enables agents to forward active and closed inbound email interactions to an external resource by selecting a valid email address in Team Communicator, either by manually entering the address or by selecting it from a searched Contact or a Corporate or Personal Favorite. Email Forward supports both '''To''' and '''CC''' (carbon copy) addressing and multiple recipient targets. Agents can also add additional information about the forwarded interaction in a dedicated text box. | ||
+ | |||
+ | Two types of forwarding are supported: | ||
+ | # Inline forwarding (quoted) | ||
+ | # Forwarding as an attachment (if supported by the email server) | ||
+ | |||
+ | Depending on the Business Process that you are using, the agent who has forwarded an email interaction to an external resource can still retain the ownership of the interaction and be responsible for closing the interaction. | ||
+ | |||
+ | ===Business Processes=== | ||
+ | A set of key-value pairs that include the destination email address and other information is added to the inbound email before it is placed in the Forward queue so that they can be used in a Business Process: | ||
+ | ====Inline Forwarding==== | ||
+ | * <tt>IW_OriginalAgentEmployeeId</tt>: The Empoyee Id of the agent. | ||
+ | *<tt>OriginalAgentUserName</tt>: The UserName of the agent. | ||
+ | Refer to [[Documentation/ES|eServices]] email workflow samples for more information about forwarding email interactions to external resources. | ||
+ | <!-- | ||
+ | ====Forward as an Attachment==== | ||
+ | * <tt>IW_OriginalAgentEmployeeId</tt>: The Empoyee Id of the agent. | ||
+ | * <tt>IW_TransferrerUserName</tt>: The UserName of the agent. | ||
+ | * <tt>IW_EmailNotepad</tt>: The current notepad text of the email view. | ||
+ | * <tt>IW_ExternalAgentAddress</tt>: The '''To''' email address destination. If the value of the {{Optionslink|link=Options:Genesys_Web_Services:interaction-workspace:email-forward-enable-multiple-to-addresses}} option is set to <tt>true</tt>, the value of <tt>IW_ExternalAgentAddress</tt> is a comma separated list of '''To''' addresses. This list has to be parsed in the Business Process. For each extracted address, the Business Process has to do the following: | ||
+ | *# Assign the extracted address to a variable. | ||
+ | *# Use this variable in the Forward Email block. | ||
+ | * <tt>IW_ExternalAgentCcAddress</tt>: The '''CC''' email address destination. This is added only if the value of the {{Optionslink|link=Options:Genesys_Web_Services:interaction-workspace:email-forward-enable-cc-addresses}} option is set to <tt>true</tt> (Enable the CC address field where agents can specify one or several CC addresses). The value is a comma separated list of '''CC''' addresses. With this list, the Business Process has to do the following: | ||
+ | *# Assign the list to a variable. | ||
+ | *# Use this variable in the Forward Email block. | ||
+ | * <tt>IW_ExternalAgentInstructions</tt>: The text provided by the agent who is forwarding the email interaction. This is added only if the value of the {{Optionslink|link=Options:Genesys_Web_Services:interaction-workspace:email-forward-enable-instructions}} option is set to <tt>true</tt> (Enable the forward instructions field). This value can be used as a Field Code in the Standard Response that is contained in the Forward Email block to give forward instructions to an external resource. | ||
+ | Refer to [[Documentation/ES|eServices]] email workflow samples for more information about forwarding email interactions to external resources. | ||
+ | --> | ||
+ | |||
+ | ===Privileges=== | ||
+ | The following privilege controls the use of the forwarding feature: | ||
+ | * {{Optionslink|link=Options:Genesys_Web_Services:interaction-workspace:privilege-email-can-inline-forward}}: Allows forwarding of an email as an inline (quoted) email. | ||
+ | *:If both privileges are granted, the '''Forward''' button becomes a split button, and the following menu options are available: | ||
+ | **Forward (Inline forwarding) | ||
+ | **Forward as an Attachment | ||
+ | * {{Optionslink|link=Options:Genesys_Web_Services:interaction-workspace:privilege-contact-can-inline-forward-email-from-history}}: Allows forwarding of a closed email interaction as an inline email from the History. | ||
+ | |||
+ | ===Configuration Options=== | ||
+ | Use the following configuration options in the '''[interaction-workspace]''' section to configure the forwarding features: | ||
+ | ====Inline Forwarding Specific Configuration Options==== | ||
+ | * {{Optionslink|link=Options:Genesys_Web_Services:interaction-workspace:email-inline-forward-queue}}: Specifies the Interaction Queue in which the inbound email is placed when an agent forwards it as an inline email. | ||
+ | * {{Optionslink|link=Options:Genesys_Web_Services:interaction-workspace:email-inline-forward-prefix}}: Specifies the in-line forward prefix that is added to subject of the inbound email. | ||
+ | * {{Optionslink|link=Options:Genesys_Web_Services:interaction-workspace:email-inline-forward-header}}: Specifies the header information that is added inline to the forwarded email interaction. | ||
+ | [[Category:V:HTCC:9.0.0]] |
Revision as of 15:04, April 15, 2019
Contents
Workspace Agent Desktop enables agents to handle email interactions, including the following functionality:
- Decline an interaction
- Release an interaction
- Move an interaction to a Workbin
- Reply to an interaction (with or without the original text)
- Reply All to an interaction (with or without the original text)
- Add Attachments to an interaction
- Send an interaction
- Save an interaction
- Delete an interaction
- Create new outbound emails
- Check the spelling of an outbound email
- Apply a signature to an outbound email
- Store emails in a workbin
- Transfer an email to an internal target
- Set a disposition code
- Mark the interaction as Done
- View and copy links to non-embedded images in inbound and outbound email interactions
- View and insert Standard Responses
- Paste content from browsers and other applications that display HTML
- Paste images from browsers and other applications that display HTML
Mandatory Functionality
The following are mandatory options for correct email interaction handling:
- privilege.email.can-use: Mandatory to use the email channel. When the value of this option is set to true, the agent is permitted to use the Email channel.
- email.default-queue: Specifies the default queue for email interactions.
- email.outbound-queue: Specifies the default queue for email interactions.
- workbin.email.draft: Specifies the name of the Workbin to be used to store draft emails
- workbin.email.in-progress: Specifies the workbin to be used to store emails which are in the In Progress state.
Granting Email Privileges
Workspace Agent Desktop uses the following privileges to enable email-related functionality:
Enabling the Email channel
You can enable agents to use Email to correspond with a contact that is stored in Universal Contact Server (UCS).
Before you begin, ensure that the following prerequisites are met:
- A working knowledge of Genesys Administrator Extension (GAX).
- The Cloud_Cluster application object exists in the Configuration Database.
- The Cloud_Cluster application has a connection to Universal Contact Server and Interaction Server.
- Procedure: Enabling agents to manage contacts.
- A capacity rule that allows Agents to receive email interactions.
To enable agents to email contacts:
- Configure the mandatory Email options in the interaction-workspace section of the Cloud_Cluster application object.
- Configure the email queue options in the email section that are mandatory for basic email processing: email.default-queue and email.outbound-queue.
- Configure the Workbin options in the interaction-workspace section of the Cloud_Cluster application object, them), in particular: workbin.email.in-progress and workbin.email.draft.
- To control the size of an attachment that agents are allowed to attach to an external email interaction, configure the email.max-attachment-size option in the interaction-workspace section of the Cloud_Cluster application object.
- To control the total size of attachments that agents are allowed to attach to an external email interaction, configure the email.max-attachments-size option in the interaction-workspace section of the Cloud_Cluster application object.
- To specify the list of file extensions that represent file types that are to be prevented from being used as attachments, configure the attachment.restrict-to-file-types option in the workspace-service section of the Cloud_Cluster application object.
- To specify the list of file extensions that represent file types that are to be prevented from being used as attachments specifically for the email channel, configure the No results (attachment.email.restrict-to-file-types) option in the workspace-service section of the Cloud_Cluster application object.
Optional Functionality
You can also use the following options for email interaction handling:
- email.auto-answer: Specifies whether an email interaction is automatically accepted when a Interaction Server Invite event is received.
- email.from-addresses: Specifies a character string that specifies the name of the Business Attribute which contains the Attribute Values that are used as available addresses. You can set a default value by using the flag from the Business Attribute value. These come from the addresses of email interactions. This option can be overridden by a routing strategy.
- email.html-format: Specifies the format of a new outbound email. When set to true, new email will be formatted in HTML.
- email.include-original-text-in-reply: Specifies whether the text of the original inbound email is included in the outbound reply email.
- email.prompt-for-done: Specifies if the application prompts a confirmation message when the user clicks Done. This option is only available for interaction open media.
- email.quote-char: For outbound email that is formatted as plain text, specifies the characters that are used to quote the contents of the inbound email interaction in the outbound email interaction body.
- email.quote-header: Specifies the character string that is used to introduce the quoted inbound email content in the body of the outbound email. The value $FullHeader$ inserts the entire header of the inbound email into the outbound email. You can also choose to include any other text. The following tags are supported: <contact>, <date>. This enables you to create a custom header, such as: "On <date>, <contact> wrote:"
- email.reply-format: Specifies the format of an outbound email reply.
- email.reply-prefix: Specifies the reply-prefix that is added to subject of the inbound email.
- email.ringing-bell: Specifies the path of the sound file Workspace plays when an email interaction is ringing.
- interaction.disposition.is-mandatory: Specifies whether it is mandatory for the agent to set a disposition code before Marking Done an interaction. This option can be overridden by a routing strategy.
- interaction.disposition.key-name: The key that is used to populate attached data or a user event when a disposition code is submitted to the back-end system, such as T-Server, Interaction Server, and Contact Server. This option can be overridden by a routing strategy.
- interaction.disposition.use-attached-data: Enables the adding of attached data from the interaction in UserEvent. This option can be overridden by a routing strategy.
- interaction.disposition.value-business-attribute: A character string that specifies the name of the Business Attribute that contains the Attribute Values that are used as an enumerated value for a disposition code. This option can be overridden by a routing strategy.
You can use the following options to control the default and available fonts for outgoing email interactions:
- editor.fonts: the list of available fonts in the font menu.
- editor.font-sizes: the list of available font sizes in the font size menu.
- editor.default-font: the default font for all new or reply outgoing email interactions.
- editor.default-font-size: the default font size for all new or reply outgoing email interactions.
Signatures
Workspace Agent Desktop enables you to assign default signature templates to outbound email interactions. Email signatures allow the insertion of tagged-data fields with data that is related to the agent, such as name, job title, department, phone number, email address, and so on. Refer to "Using UCS Data in Standard Responses: System Variables" in the "Genesys Knowledge Management: Basics" chapter of the eServices User's Guide for more information about the tagged data field. Signatures also support linked image(s) and hyperlinks.
Use the email.signature configuration option in the [interaction-workspace] section to specify the type and location of the signature template that Workspace should add to outbound emails.
Use the email.signature.line-<n> configuration option in the [interaction-workspace] section to specify the path and name of the signature file or the location of the Response in the Standard Response Library that is to be used as the default signature.
Forwarding Inbound Email
Workspace Agent Desktop enables agents to forward active and closed inbound email interactions to an external resource by selecting a valid email address in Team Communicator, either by manually entering the address or by selecting it from a searched Contact or a Corporate or Personal Favorite. Email Forward supports both To and CC (carbon copy) addressing and multiple recipient targets. Agents can also add additional information about the forwarded interaction in a dedicated text box.
Two types of forwarding are supported:
- Inline forwarding (quoted)
- Forwarding as an attachment (if supported by the email server)
Depending on the Business Process that you are using, the agent who has forwarded an email interaction to an external resource can still retain the ownership of the interaction and be responsible for closing the interaction.
Business Processes
A set of key-value pairs that include the destination email address and other information is added to the inbound email before it is placed in the Forward queue so that they can be used in a Business Process:
Inline Forwarding
- IW_OriginalAgentEmployeeId: The Empoyee Id of the agent.
- OriginalAgentUserName: The UserName of the agent.
Refer to eServices email workflow samples for more information about forwarding email interactions to external resources.
Privileges
The following privilege controls the use of the forwarding feature:
- privilege.email.can-inline-forward: Allows forwarding of an email as an inline (quoted) email.
- If both privileges are granted, the Forward button becomes a split button, and the following menu options are available:
- Forward (Inline forwarding)
- Forward as an Attachment
- privilege.contact.can-inline-forward.email.from-history: Allows forwarding of a closed email interaction as an inline email from the History.
Configuration Options
Use the following configuration options in the [interaction-workspace] section to configure the forwarding features:
Inline Forwarding Specific Configuration Options
- email.inline-forward-queue: Specifies the Interaction Queue in which the inbound email is placed when an agent forwards it as an inline email.
- email.inline-forward-prefix: Specifies the in-line forward prefix that is added to subject of the inbound email.
- email.inline-forward-header: Specifies the header information that is added inline to the forwarded email interaction.