Jump to: navigation, search

contact.multi-value-attribute-display.<contact-attribute>

Section: interaction-workspace
Default Value: Value, Description
Valid Values: A comma-separated list of fields from the following list: Value, Description.
Changes Take Effect: When the application is started or restarted.
Introduced: 8.5.144.05

Specifies the list of fields that are used to display the Contact Attributes that can have multiple values in user interface areas such as Team Communicator, Contact Directory, and the interaction Party contextual menus. The <contact-attribute> placeholder represents the name of the contact attribute. At this time, only the PhoneNumber attribute is supported.

contact.history.voice-detail-attributes

Section: interaction-workspace
Default Value: Date,Contact,PhoneNumber,Duration
Valid Values: A comma-separated value list of Attribute Value names that correspond to voice calls: Date, Contact, PhoneNumber, Duration.
Changes Take Effect: When the application is started or restarted.
Introduced: 8.5.144.05

Specifies the list of voice call attributes that are displayed History Details view.

contact.multi-value-attribute-display.<contact-attribute>

Section: interaction-workspace
Default Value: Value, Description
Valid Values: A comma-separated list of fields from the following list: Value, Description.
Changes Take Effect: When the application is started or restarted.
Introduced: 8.5.144.05

Specifies the list of fields that are used to display the Contact Attributes that can have multiple values in user interface areas such as Team Communicator, Contact Directory, and the interaction Party contextual menus. The <contact-attribute> placeholder represents the name of the contact attribute. At this time, only the PhoneNumber attribute is supported.

contact.history.voice-detail-attributes

Section: interaction-workspace
Default Value: Date,Contact,PhoneNumber,Duration
Valid Values: A comma-separated value list of Attribute Value names that correspond to voice calls: Date, Contact, PhoneNumber, Duration.
Changes Take Effect: When the application is started or restarted.
Introduced: 8.5.144.05

Specifies the list of voice call attributes that are displayed History Details view.

interaction.window-title

Section: interaction-workspace
Default Value: See the Description.
Valid Values: See the Description.
Changes Take Effect: When the application is started or restarted.
Modified: 8.5.124.08

Defines the title of the interaction window that appears in the Windows Task Bar by specifying a string that contains the valid field codes. This option can be overridden by a routing strategy, as described in Overriding Options by Using a Routing Strategy.

  • Default Value: ($Contact.FirstName$ $Contact.LastName$|$Interaction.MainParty$) - $Interaction.Type$ - $Window.Title$
  • Valid Values: $Window.Title$, $Application.Title$, $Application.Name$, $Agent.UserName$, $Agent.LastName$, $Agent.FirstName$, $Agent.EmployeeId$, $Contact.FirstName$, $Contact.LastName$, $Interaction.MainParty$, $Interaction.Type$

display-format.party-name-format

Section: interaction-workspace
Default Value: $Party.DisplayName$
Valid Values: A string that contains a compilation of characters or field codes from the following list: $Party.DisplayName$,$AttachedData.Y$
Changes Take Effect: Immediately.


Specifies the display format of parties which have not been identified as a customer or an agent, by specifying a string that contains either the name or the following field codes: $Party.DisplayName$ (the party phone number) or $AttachedData.Y$ (Y is the attached data key name where the value will be used as party name). This option can be overridden by a routing strategy, as described in Overriding Options by Using a Routing Strategy.

display-format.interaction-voice-name

Section: interaction-workspace
Default Value: $Interaction.Type$ ($Contact.FirstName$ $Contact.LastName$|$Interaction.MainParty$)
Valid Values: A string that contains a compilation of characters and field codes from the following list: $Interaction.Type$,$Interaction.MainParty$,$Contact.X$,$AttachedData.Y$ (where X is the name of contact attribute and Y is the attached data key name).
Changes Take Effect: Immediately.
Modified: 8.5.106.19

If the main interaction media type is voice, this option defines the format of the tooltip that is displayed when you place your mouse pointer on the 'Case' tab at the top of the window. It is specified by specifying a string of field codes: $Interaction.Type$,$Interaction.MainParty$,$Contact.X$,$AttachedData.Y$. Where X is the name of the contact attribute and Y is the name of the attached data key.

display-format.interaction-callback-name

Section: interaction-workspace
Default Value: $Interaction.Type$ ($Contact.FirstName$ $Contact.LastName$|$Interaction.MainParty$)
Valid Values: A string that contains a compilation of characters and field codes from the following list: $Interaction.Type$,$Interaction.CaseId$,$Interaction.MainParty$,$Contact.X$,$AttachedData.Y$ (where X is the name of contact attribute and Y is the attached data key name).
Changes Take Effect: Immediately.


If the main interaction is a Callback, this option defines the format of the tooltip that is displayed when you place your mouse pointer on the 'Case' tab at the top of the window. It is specified by specifying a string of field codes: $Interaction.Type$,$Interaction.CaseId$,$Interaction.Id$,$Interaction.MainParty$,$Contact.X$,$AttachedData.Y$
Where X is the name of the contact attribute and Y is the name of the attached data key.

display-format.customer-name-format

Section: interaction-workspace
Default Value: $Contact.FirstName$ $Contact.LastName$|$Party.DisplayName$
Valid Values: A string that contains a compilation of characters and field codes from the following list: $Contact.X$ (where X is the name of the contact attribute.)
Changes Take Effect: Immediately


Specifies the content of the text that represents the contact in the call participants area of the voice interaction interface. This option is applicable when a UCS Contact has been assigned either automatically or manually to the interaction. The content is populated based on contact attributes and attached data keys that are defined by a string that contains the following field codes: $Contact.X$,$AttachedData.Y$ (where X is the name of the contact attribute, and Y is the attached data key name). This option can be overridden by a routing strategy, as described in Overriding Options by Using a Routing Strategy.

display-format.case-name-format

Section: interaction-workspace
Default Value: $Contact.FirstName$ $Contact.LastName$|$Interaction.MainParty$
Valid Values: A string that contains a compilation of characters and field codes from the following list: $Case.Id$,$Interaction.MainParty$,$Contact.X$,$AttachedData.Y$ (X: name of contact attribute, Y: attached data key name)
Changes Take Effect: Immediately
Modified: 8.5.106.19

Defines the display format of the case label that is currently used by the application by specifying a string that contains the following field codes: $Case.Id$,$Interaction.MainParty$,$Contact.X$,$AttachedData.Y$ (X: name of contact attribute, Y: attached data key name). This option can be overridden by a routing strategy, as described in Overriding Options by Using a Routing Strategy.

display-format.caller-name

Section: interaction-workspace
Default Value: $Contact.FirstName$ $Contact.LastName$|$Interaction.MainParty$
Valid Values: A string that contains a composition of characters and field codes from the following list: $Interaction.CaseId$, $Interaction.MainParty$, $Contact.X$, $AttachedData.Y$, $OutboundRecord.PhoneType$, $OutboundRecord.PhoneNumber$, $OutboundRecordField.Z$ (where X: name of contact attribute, Y: attached data key name, Z: name of custom outbound field).
Changes Take Effect: Immediately.
Dependencies: interaction.case-data.content, toast.case-data.content
Modified: 8.5.143.08

Specifies the content of the 'Origin; field of the Case Information area. This option is enabled when the value of the interaction.case-data.content or toast.case-data.content option contains the History key. This content is typically used when placing an outbound call where the origin contains a string such as 'outbound call to xxx'.

The content is populated based on contact attributes, attached data keys, or outbound record fields that are defined by a string that contains at least one of the following field codes: $Interaction.CaseId$, $Interaction.MainParty$, $Contact.X$, $AttachedData.Y$, $OutboundRecord.PhoneType$, $OutboundRecord.PhoneNumber$, $OutboundRecordField.Z$ (where X: name of contact attribute, Y: attached data key name, Z: name of custom outbound field). If the values of the default field codes are empty, the following field code is used: $Interaction.MainParty$.

voice.show-hold-duration

Section: interaction-workspace
Default Value: false
Valid Values: true, false
Changes Take Effect: At the next interaction.
Introduced: 8.5.111.21

Specifies if the current hold call duration should be displayed as the primary timer in the Interaction Bar when a voice call is placed on hold. The total call duration remains accessible through the Interaction Bar tooltip.

voice.hold-indicator-timer

Section: interaction-workspace
Default Value: 30,60
Valid Values: Two integer values separated by a comma.
Changes Take Effect: At the next interaction.
Dependencies: voice.show-hold-duration
Introduced: 8.5.111.21

Specifies two alarm thresholds, in seconds, that warn agents that a voice call is on hold for a long time. Three levels are displayed by the progress indicator: before the warning time, between the warning time and the maximum time, and after the maximum time. If the value 0,0 means that the progress indicator is not enabled. This option can be enabled only if the value of the voice.show-hold-duration is set to true.

voice.show-post-call-duration

Section: interaction-workspace
Default Value: false
Valid Values: true, false
Changes Take Effect: At the next interaction.
Introduced: 8.5.111.21

Specifies if the current post call duration is displayed instead of the total call duration in the Interaction Bar when a voice call is disconnected. The previous total call duration can be viewed by using the Interaction Bar tooltip.

voice.show-hold-duration

Section: interaction-workspace
Default Value: false
Valid Values: true, false
Changes Take Effect: At the next interaction.
Introduced: 8.5.111.21

Specifies if the current hold call duration should be displayed as the primary timer in the Interaction Bar when a voice call is placed on hold. The total call duration remains accessible through the Interaction Bar tooltip.

voice.end-consultation-method

Section: interaction-workspace
Default Value: reconnect
Valid Values: reconnect, release
Changes Take Effect: At the next interaction.
Introduced: 8.5.103.10

Specifies the type of telephony action that is executed when an agent clicks End during a voice consultation call.

  • reconnect: A Reconnect Call action is applied, which results in the automatic retrieval of the leg which was on hold during the consultation.
  • release: A Release Call action is applied, which releases the consultation leg while keeping the principal leg on hold. This enables agents to make a subsequent consultation call without retrieving the main party first. Note: Genesys SIP Server supports this mode but not all switch environments can support it. For other switches, consult the corresponding documentation.

interaction.disposition.value-business-attribute

Section: interaction-workspace
Default Value: DispositionCode
Valid Values: A valid name of a Business Attribute.
Changes Take Effect: Immediately.


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.

Beginning with release 8.5, you can specify the display order of Business Attribute Values by creating an interaction-workspace section in the annex of the Business Attribute, and then add the interaction.disposition.order option.

This option contains a comma-separated list of Business Attributes Value Names that specifies the order of the Business Attribute Values. The Attributes Values that are not specified by the interaction.disposition.order option are put at the bottom of the list, except for the value None, which it is always the first item. This option can be overridden by a routing strategy, as described in Overriding Options by Using a Routing Strategy.

interaction.disposition.use-connection-id

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


Specifies whether the connection id is sent as part of the user event that is sent for disposition code. This option can be overridden by a routing strategy, as described in Overriding Options by Using a Routing Strategy.

interaction.disposition.use-attached-data

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


Enables the adding of attached data from the interaction in UserEvent. This option can be overridden by a routing strategy, as described in Overriding Options by Using a Routing Strategy.

interaction.disposition.key-name

Section: interaction-workspace
Default Value: DispositionCode
Valid Values: Letters A to Z and a to z. Numbers 0 through 9. The underscore and space characters.
Changes Take Effect: Immediately.


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 Overriding Options by Using a Routing Strategy.

interaction.disposition.is-read-only-on-idle

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


Prevents changes to the disposition code after a voice interation has been released. This option can be overridden by a routing strategy, as described in Overriding Options by Using a Routing Strategy.

interaction.disposition.is-mandatory

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


Specify 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 Overriding Options by Using a Routing Strategy.

voice.auto-answer.enable-reject

Section: interaction-workspace
Default Value: false
Valid Values: true, false
Changes Take Effect: At the next interaction.
Dependencies: outbound.push-preview.auto-answer, voice.auto-answer.timer
Introduced: 8.5.105.12

Specifies whether the Reject button is available in the interaction notification when the value of outbound.push-preview.auto-answer is set to true and the value of voice.auto-answer.timer is greater than 0. The privilege to reject interactions must be granted. This option can be overridden by a routing strategy, as described in Overriding Options by Using a Routing Strategy.

voice.auto-answer.timer

Section: interaction-workspace
Default Value: 0
Valid Values: Any integer greater than or equal to 0.
Changes Take Effect: At the next interaction.
Dependencies: voice.auto-answer
Introduced: 8.5.105.12

Specifies the time, in seconds, after which an incoming interaction is automatically answered if the value of voice.auto-answer is set to true. If the value 0 is specified, interactions are immediately auto-answered. If any positive integer value is specified, then an interaction notification is displayed to the agent and a timer counts down the seconds until the interactions is auto-answered. This option can be overridden by a routing strategy, as described in Overriding Options by Using a Routing Strategy.

voice.auto-answer

Section: interaction-workspace
Default Value: false
Valid Values: true, false
Changes Take Effect: At the next interaction.
Modified: 8.5.117.18

Specifies whether a voice interaction is automatically answered when a TServer Ringing event is received. This feature is disabled if the voice media that handles the interaction is in Logged Off state. This option can be overridden by a routing strategy, as described in Overriding Options by Using a Routing Strategy.

voice.mark-done-on-release

Section: interaction-workspace
Default Value: false
Valid Values: true, false
Changes Take Effect: At the next interaction.


Specify if an interaction should be closed automatically if a TServer Release event is received. This option can be overridden by a routing strategy, as described in Overriding Options by Using a Routing Strategy.

Voice

[Modified: 8.5.144.05]

Workspace employs the following privileges for all voice interactions:

  • Answer Call
  • Delete from conference
  • End Consultation Call
  • Forward Call
  • Hold/Retrieve Call
  • Make Call
  • One Step Conference
  • Two Step Conference
  • One Step Transfer
  • Two Step Transfer
  • Reject Call
  • Release Call
  • Set Interaction Disposition
  • Send DTMF
  • Suspend or Reinstate a Conference Party
  • Show Silent Monitoring
  • Use Voice Channel

Use the Voice and Interaction options in the interaction-workspace section to configure the handling of voice interactions. The following options are critical for configuring the behavior of the Voice channel:

SIP Calls

In environments that use SIP Server, in the SIP Server application object, use the sip-enable-call-info option to control the user experience.

  • Set the value to true to improve the display of call parties and enable blended interactions such as creating an email to the contact of voice interaction. This setting also ensures that caller information remains consistent when calls are transferred, conferenced, or routed between switches, for example in multi-site environments and business continuity environments.
  • Set the value to false to maintain the default behavior; however, caller identification might not be displayed consistently in the interaction notification and the interaction view.

Controlling Hold behavior

[Modified: 8.5.111.21]

During Consultation calls

[Added: 8.5.103.10]

Workspace supports two different call hold behaviors during consultation calls in SIP Server environments. During consultation call, the contact is put on hold automatically when an agent initiates the consultation. You can control whether after the consultation call is ended the hold ends automatically or whether agents must end the hold manually by using the voice.end-consultation-method option.

Forcing agents to end the hold manually enables them to make other consultation calls or perform other actions prior to reconnecting with the contact, rather than reconnecting and then immediately putting the contact back on hold.

Hold Indicator thresholds

[Added: 8.5.111.21]

Use the following configuration options to control the behavior of the Hold icon timer and progress indicator:

  • voice.show-hold-duration: Specifies if the current hold duration is displayed instead of the total call time timer in the Interaction Bar when a voice call is placed on hold. The total call duration is accessible by using the Interaction Bar tooltip.
  • voice.show-post-call-duration: Specifies if the current post call duration is displayed as the call timer in the Interaction Bar when a voice call is disconnected. The previous total call duration is accessible by using the Interaction Bar tooltip.
  • voice.hold-indicator-timer: Specifies two alarm thresholds, in seconds, that warn agents that a voice call is on hold for a long time. Three levels are displayed: before the warning time, between the warning time and the maximum time, and after the maximum time. This option can be enabled only if the value of the voice.show-hold-duration is set to true.

Dial Plan prefix management

The Dial Plan feature enables you to define the rules that Workspace applies to the dialed digits. The rules enable Workspace to transform the digits that it receives into the actual digits that are used to make the call.

Workspace receives digits from chat and SMS interactions when an agent uses the click-to-dial feature.

The Dial Plan Call Flow feature is applied to the following events:

  • TMakeCall
  • TInitiateTransfer
  • TInitiateConference
  • TSingleStepTransfer
  • TMuteTransfer
  • TSingleStepConference

Pattern matching

The table Dial plan pattern matching values provides the list of special characters that you can use to define dialed number patterns to be matched.

Dial plan pattern matching values
Special Character Pattern Matching
X Matches any single digit from 0-9.
Z Matches any single digit from 1-9.
N Matches any single digit from 2-9.
[...] Matches any one of the digits that are found in the square brackets. For example, using the special characters [12345], Workspace can match any of the digits: 1, 2, 3, 4, or 5.
[a-b] The hyphen inside square brackets acts as a range indicator. Matches any one digit that falls in a range of digits. For example, [125-8] matches any of the digits 1, 2, 5, 6, 7, 8.

The following are some examples of the use of special characters to match the patterns for dialed number Pattern Matching:

  • 9NXXXXXXXXX: Matches any 11-digit number that begins with 9, where the second digit is between 2 and 9.
  • 9[54]10XXXXXX: Matches any 11-digit number that begins with either 9510 or 9410.
  • [45]XXX: Matches any 4-digit number that begins with either 4 or 5.

Digit translation

After the number to be dialed is matched to the pattern that is defined in the dial-plan rule, Workspace uses the digits parameter to determine which number to use to make the call. These digits can be any alphanumeric string. The string must be terminated with a semicolon. This parameter can also use the {DIGITS} variable, which provides flexibility in defining the digits to be dialed. {DIGITS} Variable: The digits variable in the dial-plan rule must take one of the following formats:

  • ${DIGITS}
  • ${DIGITS:x}
  • ${DIGITS:x:y}

Where:

  • DIGITS defines the actual digits dialed from the endpoint.
  • X defines the starting position of the variable, identified by the character position in the digit string. The value 0 represents the first character in the string (starting from the left). This value can be negative, which indicates a character position that starts from the right instead of left. For example, -1 indicates the right-most character. The default value is 0.
  • Y specifies the number of characters to be included, starting from the position that is defined by X. By default, all characters in the string are included.

For example, if the number 96501235678 is dialed, here are some examples of how the {DIGITS} translate:

  • ${DIGITS} translates to 96501235678.
  • ${DIGITS:1} translates to 6501235678.
  • ${DIGITS:-4:4} translates to 5678.
  • ${DIGITS:0:4} translates to 9650.

You must configure a Dial-Plan Rule in the dial-plan-rule-<name> option that uses the following format: pattern => digit translation \# comment For example:

  • 5XXX=>4351707${DIGITS} # This rule matches any 4-digit number starting with 5 and translates it to the number 43517075XXX
  • 5002=>43517075002 # This rule matches the dialed number 5002 and translates it to the number 43517075002

Formatting and masking the contact phone number

[Added: 8.5.144.05]

Workspace enables you to control how contact information is displayed to agents in the following user interface elements. Controlling the display of contact information can be helpful if your organization has policies regarding the masking of specific contact information, such as a phone number, from agents. You can mask contact information in the following interface elements by using the options described in this section:

  • Call details in the Contact History.
  • Interaction creation menu options in the Interaction Party view Party Action menu.
  • Team Communicator tooltip.
  • Call Party List tooltip.
  • Callback reschedule Phone Number menu.
  • Interaction Action menu items in the Contact Directory.

The following options enable you to specify how the contact information is displayed:

The display-format.* option method enables you to hide information in specific interface elements. To mask contact information, such as the contact's phone number, using these options, you can include a text string in the option value instead of specifying a field code. In the following example, the default value will show the contact full name and will fallback to only the contact phone number if there is no first name, last name for this contact; the alternative option value will change the fallback to the configured string "Hidden Phone Number" when there is no first name, and last name.

Default value
$Contact.FirstName$ $Contact.LastName$|$Interaction.MainParty$
Masking value
$Contact.FirstName$ $Contact.LastName$|Hidden Phone Number

Use the contact.history.voice-detail-attributes option to specify which of the following contact attributes are displayed in the History views: Date, Contact, PhoneNumber, Duration.

Use the contact.multi-value-attribute-display.<contact-attribute> option to specify how a contact attribute, which might have multiple values is displayed. To use this option, substitute <contact-attribute> with the name of a contact attribute, such as PhoneNumber (contact.multi-value-attribute-display.PhoneNumber is the only supported option at this time). Specify Description and/or value (see the tables below for information on reformatting the phone number display).

Attributes that support multiple values often have a Description property to distinguish among the multiple values. Here are some examples of PhoneNumber attributes that might have multiple values.

Attribute format Attribute description and value
Description (Value)
Home (+15555555555)
Office (+15666666666)
(+15555555555)
Description
Office
Primary
Value
+15555555555
This page was last edited on November 24, 2021, at 14:10.
Comments or questions about this documentation? Contact us for support!