Jump to: navigation, search

interaction.case-data.format-business-attribute

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
Related Options: interaction.case-data.order

Specifies the name of the Business Attribute that contains the Business Attribute values that are used to filter and render attached data in the interaction. This option can be overridden by a routing strategy as described in the Configuration Guide. You can define the display order of Business Attribute Values by creating an interaction-workspace section in the annex of the Business Attribute, then add the interaction.case-data.order option. This option is a comma-separated list of Business Attributes Value Names that specifies the order of the Business Attribute Values. The Attributes Values that are not listed in interaction.case-data.order option are put at the bottom of the list.

toast.window-title

Section: interaction-workspace
Default Value: ($Contact.FirstName$$Contact.LastName$|$Interaction.MainParty$)
Valid Values: $Window.Title$,$Agent.UserName$,$Agent.LastName$,$Agent.FirstName$,$Agent.EmployeeId$,$Interaction.CaseId$,$Interaction.MainParty$,$Contact.X$,$AttachedData.Y$ (X: name of contact attribute, Y: attached data key name).
Changes Take Effect: After the next platform configuration refresh interval.
Introduced: 9.0.000.31

Specifies the title of the Toast window by defining a string that contains the following field codes:$Window.Title$,$Agent.UserName$,$Agent.LastName$,$Agent.FirstName$,$Agent.EmployeeId$,$Interaction.CaseId$,$Interaction.MainParty$,$Contact.X$,$AttachedData.Y$ (X: name of contact attribute, Y: attached data key name). If all field codes are empty, the following field codes are used: '$Window.Title$ - $Interaction.MainParty$'.

toast.case-data.format-business-attribute

Section: interaction-workspace
Default Value: No default value
Valid Values: The valid name of a Business Attribute.
Changes Take Effect: After the next platform configuration refresh interval.
Introduced: 9.0.000.31
Related Options: toast.case-data.order

Specifies the name of the Business Attribute that contains the Business Attribute Values that are used to filter and render attached data in the toast interaction preview.

You can define the display order of Business Attribute Values by creating an interaction-workspace section in the annex of the Business Attribute, then add the toast.case-data.order option. Use this option to specify a comma-separated list of Business Attributes Value Names that define the order of the Business Attribute Values. The Attributes Values that are not listed in toast.case-data.order option are put at the bottom of the list.

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

contact.ucs-interaction.voice-campaign.enable-create

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 that the feature that generates the interaction history in Universal Contact Server (UCS) for Voice Outbound Campaign interactions is activated. This option can be overridden by a routing strategy as described in the Configuration Guide.

outbound.timed-preview-auto-dial

Section: interaction-workspace
Default Value: -1
Valid Values: Any integer greater than or equal to -1
Changes Take Effect: After the next platform configuration refresh interval.
Introduced: 9.0.000.49

Specifies whether agents in Preview, Push preview, and Reschedule preview campaigns can manually dial a record, have the call auto-dialed as soon as the record is accepted, or have the call auto-dialed after a specified number of seconds. If set to 0, the interaction is dialed as soon as it is accepted. A value of -1 disables automatic dialing. This option can be overridden by a routing strategy as described in the Configuration Guide.

outbound.preview.max-simultaneous-preview-record

Section: interaction-workspace
Default Value: -1
Valid Values: An integer.
Changes Take Effect: After the next platform configuration refresh interval.
Introduced: 9.0.000.31

Specifies the maximum number of simultaneous Outbound Preview records an agent can view in the interaction window. A 0 or a negative value indicates no limit.

outbound-callback.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 outbound callback ringing sound configuration string of a scheduled callback pushed to the agent as a preview. 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).

outbound.call-result-automatically-selected

Section: interaction-workspace
Default Value: No default value
Valid Values: Any available call result value.
Changes Take Effect: After the next platform configuration refresh interval.
Introduced: 9.0.000.31
Related Options: outbound.call-result-values

Specifies the call result to be selected by default for outbound records. The specified call result must be defined by the values that are specified for the outbound.call-result-values option. If set to an empty value, the current call result of the outbound record is selected, or unknown is selected if there is no current value.

outbound.call-result-values

Section: interaction-workspace
Default Value: Answered,AnsweringMachine,Busy,NoAnswer,WrongNumber
Valid Values: Select at least one item from the list.
Changes Take Effect: After the next platform configuration refresh interval.
Introduced: 9.0.000.31

Specifies the list of call results that are available for the agent to use for an outbound interaction. The call results are displayed in the order in which they appear in the list.

privilege.outbound.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 Outbound Campaign functions.

privilege.outbound.push-preview.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
Modified: 9.0.000.68

Enables access to the Push Preview Outbound Campaign functions.

privilege.outbound.can-set-call-result

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 set a call result to the outbound record.

privilege.outbound.can-reschedule-on-new-number

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 reschedule an outbound record on a new number (which adds a new record to the chain).

privilege.outbound.can-reschedule-before-call

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 reschedule an outbound record before calling the contact.

privilege.outbound.can-reschedule

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
Related Options: privilege.outbound.can-reschedule-before-call

Enables an agent to reschedule an outbound record for an active call. Use the privilege.outbound.can-reschedule-before-call privilege to allow rescheduling before the call is dialed.

privilege.outbound.can-reject-record

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 decline a preview record. If an agent declines a preview record, it can be processed by another agent in the campaign.

privilege.outbound.can-mark-do-not-call

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 mark a contact as Do Not Call.

privilege.outbound.can-get-next-preview-record

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 request a new preview record while processing of the previous preview record terminates.

privilege.outbound.can-dial-alternative-chained-record

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 dial a number from the preview record chain that is different than the number selected by the system.

privilege.outbound.can-cancel-record

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 cancel a preview record. If an agent cancels a preview record, it is not processed again during the current campaign.

privilege.outbound.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 Outbound Campaign functions.

(Update with the copy of version: 9.0.0DRAFT)
(Update with the copy of version: 9.0.0DRAFT)
Line 44: Line 44:
 
*{{Optionslink|link=Options:Genesys_Web_Services:interaction-workspace:outbound-callback-ringing-bell}}: Specifies the outbound callback ringing sound configuration string of a scheduled callback pushed to the agent as a preview.
 
*{{Optionslink|link=Options:Genesys_Web_Services:interaction-workspace:outbound-callback-ringing-bell}}: Specifies the outbound callback ringing sound configuration string of a scheduled callback pushed to the agent as a preview.
 
*{{Optionslink|link=Options:Genesys_Web_Services:interaction-workspace:outbound-preview-max-simultaneous-preview-record}}: Specifies the maximum number of simultaneous Outbound Preview records an agent can view in the interaction window. A 0 or a negative value indicates no limit.
 
*{{Optionslink|link=Options:Genesys_Web_Services:interaction-workspace:outbound-preview-max-simultaneous-preview-record}}: Specifies the maximum number of simultaneous Outbound Preview records an agent can view in the interaction window. A 0 or a negative value indicates no limit.
 +
*{{Optionslink|link=Options:Genesys_Web_Services:interaction-workspace:outbound-timed-preview-auto-dial|outbound.timed-preview-auto-dial}}: Specifies whether agents in Preview, Push preview, and Reschedule preview campaigns can manually dial a record, have the call auto-dialed as soon as the record is accepted, or have the call auto-dialed after a specified number of seconds.
 
*{{Optionslink|link=Options:Genesys_Web_Services:interaction-workspace:contact-ucs-interaction-voice-campaign-enable-create}}: Enables the interaction history to be generated in the Universal Contact Server (UCS) for Voice Outbound Campaign interactions.
 
*{{Optionslink|link=Options:Genesys_Web_Services:interaction-workspace:contact-ucs-interaction-voice-campaign-enable-create}}: Enables the interaction history to be generated in the Universal Contact Server (UCS) for Voice Outbound Campaign interactions.
 
{{NoteFormat|You can [[SettingUpAgents#EditCaseInfo|edit case information]] to include custom fields in the case information for an Outbound interaction. }}
 
{{NoteFormat|You can [[SettingUpAgents#EditCaseInfo|edit case information]] to include custom fields in the case information for an Outbound interaction. }}

Revision as of 14:33, September 26, 2019

Outbound campaigns

Workspace Agent Desktop supports the following Outbound campaign types:

  • Preview: Contacts are retrieved manually by the agent and dialed manually by the agent. These are low volume/high value campaigns, in which campaign calls are made by using a preset calling list for a specific campaign.
  • Push-Preview: Contacts are retrieved automatically by the campaign, but the agent dials the call manually. These are low volume/high value campaigns, in which campaign calls are made by using a preset calling list. Agents are provided with a preview of the call, and then can either have the opportunity to accept it, or to reject it and return it to the top of the queue or discard the record.
  • Progressive: Contacts are retrieved and dialed automatically by the campaign. These are low volume/high value campaigns, in which outbound calls are directed to the agent desktop.
  • Predictive: Contacts are retrieved and dialed automatically by the campaign. These are high volume/low value campaigns, in which outbound calls are directed to the agent desktop.

Enabling agents to join an Outbound Campaign

You can enable agents to join an Outbound Campaign call to a contact that is stored in Outbound Contact Server (OCS).

Before you begin, ensure that the following prerequisites are met:

  • A working knowledge of Genesys Administrator Extension (GAX).
  • The Application object exists in the Configuration Database.

To enable agents to join an Outbound Campaign call to a contact:

  1. Allow the Outbound privileges for the role to which the agent is assigned.
  2. Configure the Outbound options in the interaction-workspace section of the Workspace Application object.

Outbound privileges

Workspace Agent Desktop employs the following Outbound privileges for all Outbound campaign voice interactions:

Outbound options configuration

After you grant privilege.outbound.can-use, use the following options in the interaction-workspace section to configure outbound interactions:

  • outbound.call-result-values: Specifies the list of call results that are available for the agent to use for an outbound interaction. The call results are displayed in the order in which they appear in the list. For example: Answered,NoAnswer,AnsweringMachine,Busy,WrongNumber
  • outbound.call-result-automatically-selected: Specifies the call result to be selected by default for outbound records. The specified call result must be defined by the values that are specified for the outbound.call-result-values option. If set to an empty value, the current call result of the outbound record is selected, or unknown is selected if there is no current value.
  • outbound-callback.ringing-bell: Specifies the outbound callback ringing sound configuration string of a scheduled callback pushed to the agent as a preview.
  • outbound.preview.max-simultaneous-preview-record: Specifies the maximum number of simultaneous Outbound Preview records an agent can view in the interaction window. A 0 or a negative value indicates no limit.
  • outbound.timed-preview-auto-dial: Specifies whether agents in Preview, Push preview, and Reschedule preview campaigns can manually dial a record, have the call auto-dialed as soon as the record is accepted, or have the call auto-dialed after a specified number of seconds.
  • contact.ucs-interaction.voice-campaign.enable-create: Enables the interaction history to be generated in the Universal Contact Server (UCS) for Voice Outbound Campaign interactions.
Important
You can edit case information to include custom fields in the case information for an Outbound interaction.

Provisioning Case Data

It is possible to display specific outbound campaign information in the Case Information area.

This information can be displayed in the Toast or Case Information area, and/or in the interaction Case Information area.

To display this information, you will need to add some business attribute values to the business attribute configured for Toast or Case Information. The toast business attributes is configured in the Workspace Agent Desktop option toast.case-data.format-business-attribute.

To specify a title for the Toast window, configure field values for the title in the toast.window-title configuration option.

The interaction business attribute is configured in the Workspace Agent Desktop option interaction.case-data.format-business-attribute.

Within these business attributes, you can add business attribute values for OCS Outbound Reserved Fields and OCS Custom fields.

OCS Outbound Reserved Fields

Create a business attribute value by following this pattern:

  • Display Name: <Whatever you want>
  • Name: The OCS Reserved key for this outbound field (for example, GSW_CAMPAIGN_NAME for the name of the campaign).
  • Limitation: For From and Until campaign fields (GSW_FROM, GSW_UNTIL), the presented value will be the number of seconds since midnight.

There are 3 specific OCS reserved fields for which it's needed to add a dedicated section in the annex to display the field correctly:

  • GSW_PHONE_TYPE
  • GSW_RECORD_STATUS
  • GSW_RECORD_TYPE

Here is the configuration to be created to be able to display the fields.

PhoneType

  • Display Name=Phone Type (or something else)
  • Name=GSW_PHONE_TYPE
  Annex=
    Section=interaction-workspace
        display-type=enum
        enum.business-attribute=PhoneTypes (or something else)

Then create the PhoneTypes business attribute, with the following business attribute values:

Name=0, Display Name=No Contact Type
Name=1, Display Name=Home Phone
Name=2, DisplayName=Direct Business Phone
Name=3, DisplayName=Business With Ext
Name=4, Display Name=Mobile
Name=5, Display Name=Vacation Phone
Name=6, Display Name=Pager
Name=7, Display Name=Modem
Name=8, Display Name=Voice Mail
Name=9, Display Name=Pin Pager
Name=10, Display Name=Email Address
Name=11, Display Name=Instant Messaging

RecordStatus

  • Display Name: Record Status (or something else)
  • Name: GSW_RECORD_STATUS
  Annex=
    Section=interaction-workspace
        display-type=enum
        enum.business-attribute=RecordStatus (or something else)

Then create the RecordStatus business attribute, with the following business attribute values:

Name=0, Display Name=No Record Status 
Name=1, Display Name=Ready
Name=2, DisplayName=Retrieved
Name=3, DisplayName=Updated
Name=4, Display Name=Stale
Name=5, Display Name=Cancelled
Name=6, Display Name=Agent Error 
Name=7, Display Name=Chain Updated
Name=8, Display Name=Missed Callback

RecordType

  • Display Name: Record Type (or something else)
  • Name: GSW_RECORD_TYPE
  Annex=
    Section=interaction-workspace
        display-type=enum
        enum.business-attribute=RecordTypes (or something else)

Then create the RecordTypes business attribute, with the following business attribute values:

Name=0, Display Name=No Record Type
Name=1, Display Name=Unknown
Name=2, DisplayName=General
Name=3, DisplayName=Campaign Rescheduled
Name=4, Display Name=Personal Rescheduled
Name=5, Display Name=Personal Callback
Name=6, Display Name=Campaign Callback
Name=7, Display Name=No Call

OCS Custom fields

  • Display Name: Whatever you want
  • Name: the send_attribute for the outbound custom field.

Depending on the custom field type, some information should be added within the annex of the business attribute value. If the custom field type is:

  • char, varchar: no annex is needed
  • int: add, in annex, a section titled "interaction-workspace" with a display-type=int option
  • float: add, in annex, a section titled "interaction-workspace" with a display-type=float option
  • datetime: add, in annex,a section titled "interaction-workspace" with a display-type=date option

Unsupported Use Cases

The following are unsupported outbound use cases.

Outbound Operations

  • Not possible to update the Outbound Campaign Record (Custom Fields).
  • Not possible to reschedule the Outbound Campaign Record
Comments or questions about this documentation? Contact us for support!