Jump to: navigation, search

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$

interaction.window.show-in-taskbar

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


Indicates whether the interaction window has a Windows taskbar button. If not, when minimized the window can be restored from the Interaction Bar. Enables the minimizing of Interaction windows to the Interaction bar of the Main Window instead of the Windows taskbar.

interaction.window.show-case-interaction-panel-button

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


Specifies whether the collapse/expand button on interaction windows is enabled. If the value of this option is set to true, the button is enabled, and agents can collapse and expand the interaction view (left panel). The interaction view contains the controls and content of the interaction. If this view is collapsed, only the right panel is displayed. This is typically the Contact Information and Contact History view or Standard Responses view or any available customized view. If the value of this option is set to false, the button is not enabled, and the interaction view cannot be collapsed.

interaction.window.popup-topmost-z-order

Section: interaction-workspace
Default Value: true
Valid Values: true, false
Changes Take Effect: At the next interaction if the value is changed to 'true', or when the application is started or restarted if the value is changed to 'false'.


Indicates whether the interaction window can steal focus from other active applications when auto-answer in enabled. When set to false, the Interaction Window tries to gracefully get the focus; however, due to certain Windows Operating System settings, this might not result in moving the interaction window to the front.

interactions.window.allows-transparency-on-winos6

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


Specifies whether the interaction window is presented in transparent style on Windows OS version 6 or higher. Unmanaged controls, such as web browsers, are not able to function in Windows Vista and Windows 7 if non-transparent windows are used. Set the value to false to permit the display of unmanaged controls.

interaction.unconditional-force-close

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

Specifies whether the Force Close This Case contextual menu is always enabled (true) or is available only if specific conditions are met where the current interaction/case can no longer be closed by the agent through standard interaction handling procedures.

interaction.reject-route

Section: interaction-workspace
Default Value:
Valid Values: A string that represents an attached data key.
Changes Take Effect: At the next interaction.


Workspace enables the Reject voice call operation in SIP Server environments that use multi-site routing. The reject route mechanism has been extended to accommodate different types of 'reject' implementations, depending on the context. Use the interaction.reject-route to enable the reject route mechanism by specifying a string as a key to be used at run-time to retrieve the behavior description from the interaction user data. It is the responsibility of the administrator to define the multi-site reject criteria.

The reject route is specified in the interaction user-data in the following format: <reject-method>:<dn>@<switch>.

Note: In releases 8.1.2 and earlier, the format was defined by <dn>@<switch> only.

The <reject-method> attribute is optional to maintain backward-compatibility with pre-8.1.3 configurations.

When <reject-method> is specified, ensure that the following characters are also specified: ':', '@', and the <switch> field.

The following are the possible values for the <reject-method> attribute:

  • pullback — Reject applies the following action: SingleStepTransfer(OtherDN='',Location=<switch>,extensions contains *pullback*). This is the legacy behavior for multi-site reject. This approach works only when the value of the TServer/divert-on-ringing SIP Server configuration option is set to true.
  • sst — Reject applies the following action: SingleStepTransfer(OtherDN=<dn>,Location=<switch>). Warning, if the value of dn@switch corresponds to the same routing point as the one that is handling the call that is being delivered to the agent, the action will succeed only if the value of the TServer/divert-on-ringing SIP Server configuration option is set to true
  • release — Reject applies the following action: releaseCall. This value must be applied when the value of the TServer/divert-on-ringing SIP Server option is set to false.

interaction.override-option-key

Section: interaction-workspace
Default Value: IW_OverrideOptions
Valid Values: An attached data key name (string).
Changes Take Effect: At the next interaction.


Enables overriding of certain application options by using one or several transaction objects. This option provides the key name of the attached data that contains the list of transaction objects. Note: the key named in this option will not be copied into any interaction that is created from the current interaction, such as consultations, reply emails, and so on. Refer to Modifying a Routing Strategy to Override Workspace Options, Based on Attached Data

interaction.evaluate-real-party-for-agent.expression

Section: interaction-workspace
Default Value: .*
Valid Values: A regular expression
Changes Take Effect: When the application is started or restarted.
Dependencies: interaction.evaluate-real-party-for-agent
Introduced: 8.5.110.13

When the value of the interaction.evaluate-real-party-for-agent option is set to true, this option specifies a regular expression that is used to match the parties in a voice call that should be evaluated and transformed into a real agent name. For example, in environments where agent DNs are defined by a 7-digit number starting with a 7 or 8, the value of this option would be set to the following value: "^[78]\d{6}".

interaction.evaluate-real-party-for-agent

Section: interaction-workspace
Default Value: true
Valid Values: true, false
Changes Take Effect: When the application is started or restarted.
Related Options: interaction.evaluate-real-party-for-agent.expression

Specifies whether Workspace attempts to transform the name of the party DN into an Agent name during a voice interaction.

If the value of this option is set to true, the names of all the parties on a call are displayed, if possible. This includes the contact party. In general, agent DNs are defined using a dialing rule, the interaction.evaluate-real-party-for-agent.expression option can be used to define a regular expression that recognizes internal parties on a call and displays the agent name instead of the DN.

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.

interaction.disposition.email.mandatory-actions

Section: interaction-workspace
Default Value: No default value
Valid Values: A comma separated list of actions from the following list: Transfer, Forward
Changes Take Effect: The next time an agent transfers and/or forwards an e-mail interaction.
Introduced: 8.5.103.10
Modified: 8.5.117.18
Related Options: interaction.disposition.is-mandatory

Some email interaction actions, such as 'Transfer' and 'Forward as an attachment', have an uncertain final status. This option enables you to specify whether the mandatory disposition code must be completed by the agent before applying a 'Transfer' or 'Forward as an attachment' action. If Transfer and/or Forward are specified for this option, agents must complete the disposition code that is configured as mandatory before completing one of these actions. This option can be overridden by a routing strategy, as described in Overriding Options by Using a Routing Strategy.

interaction.disposition.display-mode

Section: interaction-workspace
Default Value: tree-view
Valid Values: Select one value from the following list: tree-view,radio-buttons
Changes Take Effect: When the application is started or restarted.
Introduced: 8.5.108.11

Specifies the display mode of the Disposition tab in the interaction view.

  • tree-view—Disposition codes are contained within a hierarchy of folders. Agent can search for disposition codes.
  • radio-buttons—The disposition codes are presented in a flat radio-button list (legacy mode).

interaction.consult-user-data

Section: interaction-workspace
Default Value: public
Valid Values: Select a value from the following list: public, private, none
Changes Take Effect: Immediately.


Specifies if and how the business data (original interaction user data, contact identifier, and so on) of the customer interaction is shared in a consultation interaction and how. This option can be overridden by a routing strategy, as described in Overriding Options by Using a Routing Strategy.

  • none — No data is shared in the consultation.
  • public — User data of the customer interaction is shared in the consultation. The user data is copied at the root level of the consultation user data. Keys that start with an underscore are not copied into the consultation leg.
  • private — User data of the customer interaction is shared in the consultation. The user data is copied in a sub-list of the consultation user data, named SharedInformation. Keys that start with an underscore are not copied into the consultation leg. This is Interaction Workspace 8.1.0 compatibility mode.

interaction.case-data.is-read-only-on-idle

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

If the value of this option is true, changes are prevented to the case data after a voice or chat interaction has ended. This option can be overridden by a routing strategy, as described in Overriding Options by Using a Routing Strategy.

interaction.case-data.header-foreground-color

Section: interaction-workspace
Default Value: #FFFFFFFF
Valid Values: The hexadecimal Alpha (from '00' for fully transparent color to 'FF' for regular plain color) followed by the RGB hexadecimal color code (3 values in the '00'-'FF' range).
Changes Take Effect: At the next interaction.
Modified: 8.5.106.19

Specifies the color of the text of the Case Information view header. Example #FFFFFFFF for white color. This option can be overridden by a routing strategy, as described in Overriding Options by Using a Routing Strategy.

interaction.case-data.frame-color

Section: interaction-workspace
Default Value: #FF17849D
Valid Values: The hexadecimal Alpha (from '00' for fully transparent color to 'FF' for regular plain color) followed by the RGB hexadecimal color code (3 values in the '00'-'FF' range).
Changes Take Effect: At the next interaction.
Modified: 8.5.106.19

Specifies the background color of the Case Information view header. Examples: #FFFFBA00 for a Gold color, #FF6F7074 for a Silver color, #FFB8400B for a Bronze color. This option can be overridden by a routing strategy, as described in Overriding Options by Using a Routing Strategy.

interaction.case-data.format-business-attribute

Section: interaction-workspace
Default Value:
Valid Values: Letters A to Z and a to z. Numbers 0 through 9. The underscore and space characters.
Changes Take Effect: At the next interaction
Related Options: interaction.case-data.order, toast.case-data.format-business-attribute

Specifies the name of the Business Attribute that contains the Attribute Values that are used to filter and render attached data. This option can be overridden by a routing strategy, as described in Overriding Options by Using a Routing Strategy.

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 the interaction.case-data.order option are put at the bottom of the list.

Starting with the 8.1.1 release this option no longer controls the display of case information in the toast view. Refer to the toast.case-data.format-business-attribute option for this purpose.

interaction.case-data.enable-url-preview

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

Enables the display of a preview of the web page that is linked from the Case Information if the value is set to true. Also see expression.url. This option can be overridden by a routing strategy, as described in Overriding Options by Using a Routing Strategy.

interaction.case-data.content

Section: interaction-workspace
Default Value: History,CaseData
Valid Values: History, CaseData
Changes Take Effect: At the next interaction.
Modified: 8.5.106.19
Related Options: toast.case-data.content, display-format.caller-name

Specifies the content of the Case Information area in the interaction preview.

  • The CaseData key enables the display of the attached data that is defined by the interaction.case-data.format-business-attribute option; the relative order of case data keys can be specified in the configured Business Attribute object as described in that option.
  • The History key enables the display of interaction history information such as 'origin', 'queue', 'call type'. The content displayed in the 'history' block is controlled by the application and the list of keys depends on the context. Administrators do not have control over this content.
  • The order of the values in the option defines the order of the Case Data (as a block) and History (as another block) information in the Case Information area of the interaction preview
  • This option can be overridden by a routing strategy, as described in Overriding Options by Using a Routing Strategy. Starting from the 8.1.1 release, this option no longer controls the display of case information in the toast view. Please refer to the toast.case-data.content option for this purpose.

interaction.auto-focus.<media-type>

Section: interaction-workspace
Default Value: true
Valid Values: true, false
Changes Take Effect: When the application is started or restarted.
Introduced: 8.5.116.10
Related Options: interaction.auto-focus

Specifies whether a new inbound interaction of the specified media type should be in focus automatically when is accepted. When this option is defined it overrides the interaction.auto-focus option.

interaction.auto-focus

Section: interaction-workspace
Default Value: true
Valid Values: true, false
Changes Take Effect: When the application is started or restarted.
Introduced: 8.5.116.10

Specifies whether the inbound interaction should be in focus automatically when it is accepted.

Interaction options

Tip
For the most up to date Workspace Desktop Edition configuration options, see the Genesys Configuration Option Database.

Related Resources

The following topics discuss the implementation of these options:

This page was last edited on July 21, 2020, at 16:11.
blog comments powered by Disqus