Jump to: navigation, search

keyboard.shortcut.jump-to-last-error

Section: interaction-workspace
Default Value: Alt+L
Valid Values: The name of a key or a key combination the begins with one of the following modifier key names: Ctrl, Shift, Alt, and ends with a character key. Separate the modifier key name from the character key with the '+' character.
Changes Take Effect: After the next platform configuration refresh interval.
Introduced: 9.0.000.31

Specifies the combination of keys that can be used as a keyboard shortcut to jump the focus to the last error.

keyboard.shortcut.interaction.previous

Section: interaction-workspace
Default Value: Alt+B
Valid Values: The name of a key or a key combination the begins with one of the following modifier key names: Ctrl, Shift, Alt, and ends with a character key. Separate the modifier key name from the character key with the '+' character.
Changes Take Effect: After the next platform configuration refresh interval.
Introduced: 9.0.000.31

Specifies the combination of keys that can be used as a keyboard shortcut to jump to the previous case interaction.

keyboard.shortcut.interaction.next

Section: interaction-workspace
Default Value: Alt+N
Valid Values: The name of a key or a key combination the begins with one of the following modifier key names: Ctrl, Shift, Alt, and ends with a character key. Separate the modifier key name from the character key with the '+' character.
Changes Take Effect: After the next platform configuration refresh interval.
Introduced: 9.0.000.31

Specifies the combination of keys that can be used as a keyboard shortcut to jump to the next case interaction.

accessibility.warning-message-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 warning message sound-configuration string. 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).

accessibility.voicemail-message-change-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 Voice Mail counter change sound-configuration string for new or old messages. 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).

accessibility.visual-impairment-profile

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 the profile for visually impaired users is active. This option enables users to navigate interface elements from keyboard navigation and tooltips by using a Screen Reader application. Some components might change their behavior in this mode. For example, Team Communicator is collapsed in this configuration.

accessibility.outbound-campaign-state-change-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 campaign state change sound-configuration string. 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).

accessibility.<media-type>.focus-on-interaction-toast

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 all Interaction Notification views receive the focus when they are displayed. This option does not rely on accessibility.visual-impairment-profile; therefore, it applies to all configured agents, not just visually impaired agents.

accessibility.interaction-state-change-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 interaction state change sound-configuration string. 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).

accessibility.focus-on-interaction-toast

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 all Interaction Notification views receive the focus when they are displayed. This option does not rely on accessibility.visual-impairment-profile; therefore, it applies to all configured agents, not just visually impaired agents.

accessibility.dialog-error-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 error alert sound-configuration string. 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).

accessibility.dialog-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 dialog sound-configuration string. 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).

accessibility.agent-state-change-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 agent state change sound-configuration string. 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).

reporting.case.report-case-in-focus-duration

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 the time that an interaction has been in the focus of the agent during its handling is reported to T-Server or Interaction Server at the end of its processing by the agent. When it is enabled, this notification allows Genesys Interaction Concentrator and Genesys Info Mart to calculate some focus time metrics.

interaction.disposition.folder-name-depth-<n>

Section: interaction-workspace
Default Value: No default value
Valid Values: Valid key name associated with a disposition.
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.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.

interaction.disposition.is-expanded-on-display

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 disposition tree is expanded rather than collapsed when displayed:

  • true: Expand all dispositions
  • false: Collapse all dispositions

interaction.disposition.cache-timeout-delay

Section: interaction-workspace
Default Value: -1
Valid Values: From -1 to MAXINT.
Changes Take Effect: After the next platform configuration refresh interval.
Introduced: 9.0.000.31
Modified: 9.0.000.65

Specifies the delay, in seconds, before the cache of a disposition request result is cleared. If set to -1, the dispositions are kept in cache until the browser page is refreshed, or until the agent logs out and logs back in.

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.

toast.case-data.content

Section: interaction-workspace
Default Value: History,CaseData
Valid Values: History, CaseData
Changes Take Effect: After the next platform configuration refresh interval.
Introduced: 9.0.000.31
Related Options: toast.case-data.format-business-attribute

Specifies the content of the Case Information area in the toast interaction preview. The CaseData key enables the display of the attached data that is defined by the toast.case-data.format-business-attribute option. The History key enables the display of interaction history information. The order in which the values are specified defines the order of the Case Data and History information in the Case Information area. This option can be overridden by a routing strategy as described in the Configuration Guide.

intercommunication.voice.make-call-caller-id-enable-anonymous

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.65

Specifies whether anonymous is enabled on make call with caller id. This option is only applicable for external calls. This functionality can currently only be used in conjunction with the SIP Server TServer\/enforce-p-asserted-identity option configured on the outbound PSTN Trunk DN. This must be configured in the environment where the PSTN Provider (Carrier) implements Calling Line Identification Restriction (CLIR) and allows masking the displayed number (Caller ID) only if privacy SIP headers are correctly constructed and 'anonymous@anonymous.invalid' is specified in the From field.

intercommunication.voice.make-call-caller-id-business-attribute

Section: interaction-workspace
Default Value: No default value
Valid Values: Letters A to Z and a to z. Numbers 0 through 9. The underscore and space characters.
Changes Take Effect: After the next platform configuration refresh interval.
Introduced: 9.0.000.31
Modified: 9.0.000.65

Specifies the name of the Business Attribute that contains the Attribute Values that are used as outbound caller IDs. This option is only applicable for external calls.

privilege.mychannels.pending-state.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 pending state to be displayed in the My Channels view while the agent is engaged in a call, chat, or email interaction. When the value of this option is set to true, if an agent sets his or her status to Not Ready or Not Ready Reason while he or she is still handling an interaction, the timer for that state will not start until the call is released, the chat is ended, or the email is sent or put into a workbin.

voice.cancel-after-call-work-on-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
Related Options: backwds-compat-acw-behavior

Specifies if the voice channel should be forced to its former status when the agent marks the voice interaction as Done while the voice channel is in After Call Work status. In environments where emulated agents are used, this option is dependent on the value set for backwds-compat-acw-behavior.

login.voice.is-auto-ready

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 the voice channels are in the Ready state at login.

agent-status.ready-workmode

Section: interaction-workspace
Default Value: unknown
Valid Values: A value from the following list: unknown, manual-in, auto-in. Empty means no workmode specified.
Changes Take Effect: After the next platform configuration refresh interval.
Introduced: 9.0.000.39
Related Options: login.voice.is-auto-ready

Specifies which workmode is applied on Ready operation done manually from the Global State menu and My Channels. This option is also applicable for the login.voice.is-auto-ready option. Supported workmodes are unknown, manual-in, auto-in.

agent-status.not-ready-reasons

Section: interaction-workspace
Default Value: No default value
Valid Values: Comma-separated list of Action Code names of type Not Ready; empty means all not ready action codes are considered
Changes Take Effect: After the next platform configuration refresh interval.
Introduced: 9.0.000.31

Specifies the available reasons in the Agent Status menus (global and My Channels). The reason commands are displayed in the order in which they appear in the list.

agent-status.after-call-work-reasons

Section: interaction-workspace
Default Value: No default value
Valid Values: Comma-separated list of Action Code names of type After Call Work; empty means all not ready action codes are considered
Changes Take Effect: After the next platform configuration refresh interval.
Introduced: 9.0.000.31

Specifies the available reasons in the Agent Status menus (global and My Channels). Workspace displays the reason commands in the order in which they appear in the list.

privilege.mychannels.pending-state.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 pending state to be displayed in the My Channels view while the agent is engaged in a call, chat, or email interaction. When the value of this option is set to true, if an agent sets his or her status to Not Ready or Not Ready Reason while he or she is still handling an interaction, the timer for that state will not start until the call is released, the chat is ended, or the email is sent or put into a workbin.

agent-status.enabled-actions-global

Section: interaction-workspace
Default Value: Ready,NotReady,NotReadyReason,AfterCallWork,AfterCallWorkReason,LogOff
Valid Values: Comma-separated list of action names from the following list: Ready, NotReady, Dnd, NotReadyReason, AfterCallWork, AfterCallWorkReason, LogOff.
Changes Take Effect: After the next platform configuration refresh interval.
Introduced: 9.0.000.31
Modified: 9.0.000.68,9.0.000.61

Specifies the available agent states in the global Status menu. The agent state commands are displayed in the order in which they appear in the list.

agent-status.enabled-actions-by-channel

Section: interaction-workspace
Default Value: Ready,NotReady,NotReadyReason,AfterCallWork,AfterCallWorkReason,LogOff
Valid Values: Comma-separated list of action names from the following list: Ready, NotReady, NotReadyReason, AfterCallWork, AfterCallWorkReason, Dnd, LogOff.
Changes Take Effect: After the next platform configuration refresh interval.
Introduced: 9.0.000.31
Modified: 9.0.000.68

Specifies the available agent state actions in the My Channels contextual menu. The actions are displayed in the order in which they appear in the list.

login.voice.expression.dn-less-phone-number

Section: interaction-workspace
Default Value: No default value
Valid Values: A regular expression
Changes Take Effect: After the next platform configuration refresh interval.
Introduced: 9.0.000.31

Specifies the valid format for a new phone number. A regular expression can be used to check the DN-less phone number format in the login window.

login.voice.dn-less-phone-number.valid-format

Section: interaction-workspace
Default Value: No default value
Valid Values: A string
Changes Take Effect: After the next platform configuration refresh interval.
Introduced: 9.0.000.31

Specifies the correct format information to be displayed to the agent when the DN less phone number format is not correct.

login.voice.nb-dn-less-phone-number-stored

Section: interaction-workspace
Default Value: 1
Valid Values: An integer value from 0 through 10.
Changes Take Effect: After the next platform configuration refresh interval.
Introduced: 9.0.000.31
Related Options: login.voice.prompt-dn-less-phone-number.enable-dynamic-dn

Specifies the number of phone numbers which are stored for the agent. For this option to apply, the value of login.voice.prompt-dn-less-phone-number.enable-dynamic-dn must be true.
0: no phone number is pre-filled in the second login screen.
1: the last entered phone number is displayed in the second login screen.
A number greater than 1 specifies the maximum number of phone numbers that can be displayed in the second login screen.

login.voice.prompt-dn-less-phone-number

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 a new page is displayed during the login phase to show the current phone number assigned to the agent and also permits the agent to update it. This option is specific to SIP Server environment with no Config Server proxy connected to GWS.

login.workmode

Section: interaction-workspace
Default Value: unknown
Valid Values: A value from the following list: unknown, auto-in, manual-in.
Changes Take Effect: After the next platform configuration refresh interval.
Introduced: 9.0.000.39

Specifies the workmode that is applied when the voice DN logs in. To determine whether your switch supports the workmodem refer to the deployment guide of the relevant T-Server.

login.list-available-locales

Section: interaction-workspace
Default Value: No default value
Valid Values: Comma-separated list of valid locale names based on format LanguageCode-CountryCode from the following list: $All$, en-US, pt-BR, fr-FR, fr-CA, de-DE, ja, es, ko, it, nl, pl, zh-CN, zh-CHT.
Changes Take Effect: Immediately
Introduced: 9.0.000.31
Modified: 9.0.000.84, 9.0.000.61, 9.0.000.72, 9.0.000.80

Specifies the language that the agent can select at login time.
Either, set this option empty to prevent the agent from selecting the language or set this option to $All$ to get all the languages available, or set this option to a list of languages (possible values are Brazilian (pt-BR), French (fr-FR), French Canadian (fr-CA), German (de-DE), Japanese (ja), Spanish (es), Korean (ko), Italian (it), Dutch (nl), Polish (pl), Simplified Chinese (zh-CN) and Traditional Chinese (zh-CHT)). English is the default language, and is always available.

agent-status.ready-workmode

Section: interaction-workspace
Default Value: unknown
Valid Values: A value from the following list: unknown, manual-in, auto-in. Empty means no workmode specified.
Changes Take Effect: After the next platform configuration refresh interval.
Introduced: 9.0.000.39
Related Options: login.voice.is-auto-ready

Specifies which workmode is applied on Ready operation done manually from the Global State menu and My Channels. This option is also applicable for the login.voice.is-auto-ready option. Supported workmodes are unknown, manual-in, auto-in.

login.voice.is-auto-ready

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 the voice channels are in the Ready state at login.

login.voice.prompt-queue

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 the agent must enter the ACD Queue for the voice channel in the login window.

login.voice.list-available-queues

Section: interaction-workspace
Default Value: No default value
Valid Values: Comma-separated list of queues.
Changes Take Effect: After the next platform configuration refresh interval.
Introduced: 9.0.000.31

Specifies the ACD Queues that are displayed in the login window. If the option value is left blank, no queue is displayed to the agent; the agent can enter any valid login queue name. If a single queue is specified and the value of the login.voice.prompt-queue no queue information is displayed during login.

login.voice.prompt-queue

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 the agent must enter the ACD Queue for the voice channel in the login window.

login.voice.auto-not-ready-reason

Section: interaction-workspace
Default Value: No default value
Valid Values: A valid not ready reason.
Changes Take Effect: After the next platform configuration refresh interval.
Introduced: 9.0.000.31

Specifies the NotReady Reason code if the Voice channel is automatically set to NotReady when the agent logs in.

login.prompt-place

Section: interaction-workspace
Default Value: false
Valid Values: true, false.
Changes Take Effect: Immediately
Introduced: 9.0.000.31
Modified: 9.0.000.74
Related Options: login.voice.prompt-dn-less-phone-number

Specifies whether the agent must enter his place in the login window. When this option is set to true, a new page is displayed during the login phase to specify a place. Enabling this option disables login.voice.prompt-dn-less-phone-number.

login.store-recent-place

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
Related Options: login.prompt-place

Specifies whether the most recently used Place is stored. This option is available if the login.prompt-place option is set to true.

privilege.sipendpoint.can-use

Section: interaction-workspace
Default Value: false
Valid Values: true, false.
Changes Take Effect: Immediately
Introduced: 9.0.000.31
Modified: 9.0.000.74
Related Options: login.prompt-place

Enables the usage of Genesys Softphone. Depends on 'Voice - Can Use Voice Channel'.

login.voice.prompt-dn-less-phone-number

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 a new page is displayed during the login phase to show the current phone number assigned to the agent and also permits the agent to update it. This option is specific to SIP Server environment with no Config Server proxy connected to GWS.

login.prompt-place

Section: interaction-workspace
Default Value: false
Valid Values: true, false.
Changes Take Effect: Immediately
Introduced: 9.0.000.31
Modified: 9.0.000.74
Related Options: login.voice.prompt-dn-less-phone-number

Specifies whether the agent must enter his place in the login window. When this option is set to true, a new page is displayed during the login phase to specify a place. Enabling this option disables login.voice.prompt-dn-less-phone-number.

security.inactivity-alert-dialog-before-timeout

Section: interaction-workspace
Default Value: 30
Valid Values: An integer value greater than or equal to 0.
Changes Take Effect: After the next platform configuration refresh interval.
Introduced: 9.0.000.31
Related Options: security.inactivity-timeout

Specifies when Workspace displays an alert dialog to warn the agent of the upcoming inactivity timeout. The value of this option, in seconds, tells Workspace how soon to display the alert before the timeout occurs. You must set this option to a value less than the value of security.inactivity-timeout.

security.inactivity-timeout

Section: interaction-workspace
Default Value: 0
Valid Values: An integer value greater than or equal to 0.
Changes Take Effect: After the next platform configuration refresh interval.
Introduced: 9.0.000.31
Modified: 9.0.000.68

Specifies the amount of time, in minutes, of agent inactivity (no mouse or keyboard usage) that triggers the application to log out. If the agent has been inactive longer than the number of minutes that are specified by this inactivity timeout, the agent session is ended. A value of 0 disables this inactivity timeout.

workspace.web-content

Section: interaction-workspace
Default Value: No default value
Valid Values: A comma-separated value list of option section names that correspond to the extension views, for example: Extension1, Extension2, etc...
Changes Take Effect: After the next platform configuration refresh interval.
Introduced: 9.0.000.31

The list of Web Applications that are configured to be displayed at the Workspace level. Refer to the Procedure: Enabling integration of web applications in the agent interface for information about creating web application objects in the configuration layer.

interaction.web-content

Section: interaction-workspace
Default Value: No default value
Valid Values: A comma-separated list of option section names that correspond to web extension views. For example: Extension1, Extension2
Changes Take Effect: After the next platform configuration refresh interval.
Introduced: 9.0.000.31

Specifies the list of Web Applications that are configured to be displayed at the Interaction level. Refer to 'Enabling integration of web applications in the agent interface' in the Configuration Guide for information about creating web application objects in the configuration layer. This option can be overridden by a routing strategy as described in the Configuration Guide.

interaction.web-content

Section: interaction-workspace
Default Value: No default value
Valid Values: A comma-separated list of option section names that correspond to web extension views. For example: Extension1, Extension2
Changes Take Effect: After the next platform configuration refresh interval.
Introduced: 9.0.000.31

Specifies the list of Web Applications that are configured to be displayed at the Interaction level. Refer to 'Enabling integration of web applications in the agent interface' in the Configuration Guide for information about creating web application objects in the configuration layer. This option can be overridden by a routing strategy as described in the Configuration Guide.

interaction.web-content

Section: interaction-workspace
Default Value: No default value
Valid Values: A comma-separated list of option section names that correspond to web extension views. For example: Extension1, Extension2
Changes Take Effect: After the next platform configuration refresh interval.
Introduced: 9.0.000.31

Specifies the list of Web Applications that are configured to be displayed at the Interaction level. Refer to 'Enabling integration of web applications in the agent interface' in the Configuration Guide for information about creating web application objects in the configuration layer. This option can be overridden by a routing strategy as described in the Configuration Guide.

agent-status.enabled-actions-global

Section: interaction-workspace
Default Value: Ready,NotReady,NotReadyReason,AfterCallWork,AfterCallWorkReason,LogOff
Valid Values: Comma-separated list of action names from the following list: Ready, NotReady, Dnd, NotReadyReason, AfterCallWork, AfterCallWorkReason, LogOff.
Changes Take Effect: After the next platform configuration refresh interval.
Introduced: 9.0.000.31
Modified: 9.0.000.68,9.0.000.61

Specifies the available agent states in the global Status menu. The agent state commands are displayed in the order in which they appear in the list.

agent-status.enabled-actions-by-channel

Section: interaction-workspace
Default Value: Ready,NotReady,NotReadyReason,AfterCallWork,AfterCallWorkReason,LogOff
Valid Values: Comma-separated list of action names from the following list: Ready, NotReady, NotReadyReason, AfterCallWork, AfterCallWorkReason, Dnd, LogOff.
Changes Take Effect: After the next platform configuration refresh interval.
Introduced: 9.0.000.31
Modified: 9.0.000.68

Specifies the available agent state actions in the My Channels contextual menu. The actions are displayed in the order in which they appear in the list.

agent-status.enabled-actions-global

Section: interaction-workspace
Default Value: Ready,NotReady,NotReadyReason,AfterCallWork,AfterCallWorkReason,LogOff
Valid Values: Comma-separated list of action names from the following list: Ready, NotReady, Dnd, NotReadyReason, AfterCallWork, AfterCallWorkReason, LogOff.
Changes Take Effect: After the next platform configuration refresh interval.
Introduced: 9.0.000.31
Modified: 9.0.000.68,9.0.000.61

Specifies the available agent states in the global Status menu. The agent state commands are displayed in the order in which they appear in the list.

agent-status.enabled-actions-by-channel

Section: interaction-workspace
Default Value: Ready,NotReady,NotReadyReason,AfterCallWork,AfterCallWorkReason,LogOff
Valid Values: Comma-separated list of action names from the following list: Ready, NotReady, NotReadyReason, AfterCallWork, AfterCallWorkReason, Dnd, LogOff.
Changes Take Effect: After the next platform configuration refresh interval.
Introduced: 9.0.000.31
Modified: 9.0.000.68

Specifies the available agent state actions in the My Channels contextual menu. The actions are displayed in the order in which they appear in the list.

<media-type>.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 that is played when the 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).

voice.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 a voice 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).

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).

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).

chat.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 a chat 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).

chat.new-message-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 a new chat message arrives. 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).

accessibility.warning-message-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 warning message sound-configuration string. 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).

accessibility.outbound-campaign-state-change-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 campaign state change sound-configuration string. 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).

accessibility.interaction-state-change-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 interaction state change sound-configuration string. 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).

accessibility.agent-state-change-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 agent state change sound-configuration string. 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).

system.log-level

Section: interaction-workspace
Default Value: Trace
Valid Values: Select a value from the following list: Trace, Debug, Info, Warning, Error, Off.
Changes Take Effect: After the next platform configuration refresh interval.
Introduced: 9.0.000.31

Specifies the global log level.

system.cometd.timeout

Section: interaction-workspace
Default Value: 60000
Valid Values: An integer value greater than or equal to 0.
Changes Take Effect: After the next platform configuration refresh interval.
Introduced: 9.0.000.31

Specifies the duration, in milliseconds, before the session is considered closed when the connection with the server is lost.

system.cometd.timeout

Section: interaction-workspace
Default Value: 60000
Valid Values: An integer value greater than or equal to 0.
Changes Take Effect: After the next platform configuration refresh interval.
Introduced: 9.0.000.31

Specifies the duration, in milliseconds, before the session is considered closed when the connection with the server is lost.

system.feedback.submit-after-disconnect

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: system.cometd.timeout

Specifies whether a Feedback dialog box is displayed the next time the agent logs in after a session closed due to the Cometd defense. Managed by the system.cometd.timeout option.

system.feedback

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 a Feedback button is displayed in the About window.

privilege.contact.can-delete-contact

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 delete contacts from the contact database.

privilege.contact.can-create-contact

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 agents to create contacts.

privilege.contact.can-use-save-contact

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 agents to commit (save) modifications to contact information.

privilege.contact.can-use-interaction-notepad

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 display and edit the interaction notepad while handling an interaction.

privilege.contact.can-use-assign-contact

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 assign a contact to an interaction.

privilege.contact.can-use-contact-information

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 agents to view and manage contact information.

interaction-bar.quick-access-modes

Section: interaction-workspace
Default Value: Pinned,Floating
Valid Values:
Changes Take Effect: After the next platform configuration refresh interval.
Introduced: 9.0.000.31
Related Options: interaction-bar.quick-access-modes.<media-type>

Specifies the list of modes that are available to present interactions. The available modes are:

  • Pinned: the interaction view occupies the full available size, shared with Supporting Views like Contact and Responses.
  • Floating: the interaction view is presented in a floating window that is painted above any other kind of content and that fits the visual material to display. This view cannot display content displayed on the right part, such as Contact Profile or Responses.
    When more than one mode is specified, by default the first mode in the configured list is used. The end user can switch from one mode to the other using a dedicated control. For a given media type, this option can be overridden by the interaction-bar.quick-access-modes.<media-type> option.

interaction-bar.quick-access-modes.<media-type>

Section: interaction-workspace
Default Value: Pinned,Floating
Valid Values:
Changes Take Effect: After the next platform configuration refresh interval.
Introduced: 9.0.000.31
Related Options: interaction-bar.quick-access-modes

Use this option as a template to specify the list of modes available to present interactions of the given media type. The available modes are:

  • Pinned: the interaction view occupies the full available size, shared with Supporting Views like Contact and Responses.
  • Floating: the interaction view is presented in a floating window that is painted above any other kind of content and that fits the visual material to display. This view cannot display content displayed on the right part, such as Contact Profile or Responses.
    When more than one mode is specified, by default the first mode in the configured list is used. The end user can switch from one mode to the other using a dedicated control. When it is defined for a media type, this option overwrites the definition of the generic interaction-bar.quick-access-modes option.

interaction-bar.quick-access-modes.<media-type>

Section: interaction-workspace
Default Value: Pinned,Floating
Valid Values:
Changes Take Effect: After the next platform configuration refresh interval.
Introduced: 9.0.000.31
Related Options: interaction-bar.quick-access-modes

Use this option as a template to specify the list of modes available to present interactions of the given media type. The available modes are:

  • Pinned: the interaction view occupies the full available size, shared with Supporting Views like Contact and Responses.
  • Floating: the interaction view is presented in a floating window that is painted above any other kind of content and that fits the visual material to display. This view cannot display content displayed on the right part, such as Contact Profile or Responses.
    When more than one mode is specified, by default the first mode in the configured list is used. The end user can switch from one mode to the other using a dedicated control. When it is defined for a media type, this option overwrites the definition of the generic interaction-bar.quick-access-modes option.

interaction-bar.quick-access-modes

Section: interaction-workspace
Default Value: Pinned,Floating
Valid Values:
Changes Take Effect: After the next platform configuration refresh interval.
Introduced: 9.0.000.31
Related Options: interaction-bar.quick-access-modes.<media-type>

Specifies the list of modes that are available to present interactions. The available modes are:

  • Pinned: the interaction view occupies the full available size, shared with Supporting Views like Contact and Responses.
  • Floating: the interaction view is presented in a floating window that is painted above any other kind of content and that fits the visual material to display. This view cannot display content displayed on the right part, such as Contact Profile or Responses.
    When more than one mode is specified, by default the first mode in the configured list is used. The end user can switch from one mode to the other using a dedicated control. For a given media type, this option can be overridden by the interaction-bar.quick-access-modes.<media-type> option.

main-window.window-title

Section: interaction-workspace
Default Value: $Window.Title$
Valid Values: $Window.Title$,$Application.Title$,$Agent.UserName$,$Agent.LastName$,$Agent.FirstName$,$Agent.EmployeeId$.
Changes Take Effect: After the next platform configuration refresh interval.
Introduced: 9.0.000.31

Specifies the title of the browser window or tab. You can specify any string andor combination of valid field codes up to the maximum width of the browser window title bar or tab. If all field codes are empty, the following field codes are used: $Window.Title$.

alert.timeout

Section: interaction-workspace
Default Value: 10
Valid Values: An integer value greater than or equal to 0.
Changes Take Effect: After the next platform configuration refresh interval.
Introduced: 9.0.000.31

Specifies the duration, in seconds, that contextual warning messages are displayed in the windows of the application.

sipendpoint.wait-user-max-attempts

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

Specifies the number of failed waiting user-actions that are allowed before timeout.

sipendpoint.uri

Section: interaction-workspace
Default Value: No default value
Valid Values: A correct uri
Changes Take Effect: After the next platform configuration refresh interval.
Introduced: 9.0.000.31

Specifies the URI of the SIP endpoint used in connector mode. For example: https://localhost:8000. See the Genesys Softphone Deployment Guide for information about setting this value for Genesys Softphone.

sipendpoint.transport-protocol

Section: interaction-workspace
Default Value: UDP
Valid Values: Select a value from the following list: UDP, TCP, TLS, HTTP, HTTPS.
Changes Take Effect: After the next platform configuration refresh interval.
Introduced: 9.0.000.31

Specifies whether UDP, TCP, TLS, HTTP, or HTTPS is used for the SIP transport protocol.

sipendpoint.sip-server-address.peer

Section: interaction-workspace
Default Value: No default value
Valid Values: A correct URI. In case of DNS SRV: <FQDN>; in case of A-Record: <FQDN>:<port>; for IP Address: <IP>:<port>.
Changes Take Effect: Immediately
Introduced: 9.0.000.31
Modified: 9.0.000.93

In a Business Continuity environment designed for dual SIP registration, specifies the FQDN, hostname, or IP Address of the SIP Entity (Session Border Controller, SIP Proxy, SIP Server) corresponding to the secondary SIP destination where the SIP REGISTER request will be sent by Genesys Softphone (Tip: To set the Domain\/Realm of your contact center instead of an IP when Workspace SIP Endpoint tries to register through a session border controller (SBC) device, set the value of this option to the FQDN of your domain instead of just the IP Address).

sipendpoint.sip-server-address

Section: interaction-workspace
Default Value: No default value
Valid Values: A correct URI. In case of DNS SRV: <FQDN>; in case of A-Record: <FQDN>:<port>; for IP Address: <IP>:<port>.
Changes Take Effect: Immediately
Introduced: 9.0.000.31
Modified: 9.0.000.93

Specifies the FQDN, hostname, or IP Address of the SIP Entity (Session Border Controller, SIP Proxy, SIP Server) where the SIP REGISTER request will be sent by Genesys Softphone. In a Business Continuity environment designed for dual SIP registration, this corresponds to the preferred site registration (Tip: To set the Domain\/Realm of your contact center instead of an IP when Workspace SIP Endpoint tries to register through a session border controller (SBC) device, set the value of this option to the FQDN of your domain instead of just the IP Address).

sipendpoint.register-max-attempts

Section: interaction-workspace
Default Value: 10
Valid Values: A valid integer
Changes Take Effect: Immediately
Introduced: 9.0.000.31
Modified: 9.0.000.76

Specifies the number of checks after a registration request is made that Workspace makes while waiting for Genesys Softphone to become active.

sipendpoint.register-interval

Section: interaction-workspace
Default Value: 1500
Valid Values: A valid integer
Changes Take Effect: Immediately
Introduced: 9.0.000.31
Modified: 9.0.000.76
Related Options: sipendpoint.register-max-attempts

Specifies the interval, in milliseconds, that Workspace waits between each check for the successful registration to Genesys Softphone. The number of attempted checks is specified by the sipendpoint.register-max-attempts option.

sipendpoint.ping-interval

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

Specifies the interval, in milliseconds, between each ping of the Genesys Softphone.

sipendpoint.max-failed-ping

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

Specifies the number of failed pings allowed on Genesys Softphone.

sipendpoint.headset-unplugged-set-not-ready

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 agent SIP DN is set automatically to Not Ready when the headset that is configured for the agent is unplugged.

sipendpoint.headset-unplugged-set-not-ready

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 agent SIP DN is set automatically to Not Ready when the headset that is configured for the agent is unplugged.

sipendpoint.headset-unplugged.not-ready-reason

Section: interaction-workspace
Default Value: No default value
Valid Values: A valid not ready reason
Changes Take Effect: After the next platform configuration refresh interval.
Introduced: 9.0.000.31
Related Options: sipendpoint.headset-unplugged-set-not-ready

Specifies the Not Ready reason that is to be set for the SIP DN when the headset that is used by the agent is unplugged if the value of the sipendpoint.headset-unplugged-set-not-ready option is set to true.

privilege.sipendpoint.can-mute-speaker

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

Enables an agent to mute and unmute the speaker. Depends on 'Voice - Can Use Voice Channel' and 'Workspace Web SIP Endpoint Options - Can Use Genesys Softphone'.

privilege.sipendpoint.can-mute-microphone

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

Enables an agent to mute and unmute the microphone. Depends on 'Voice - Can Use Voice Channel' and 'Workspace Web SIP Endpoint Options - Can Use Genesys Softphone'.

privilege.sipendpoint.can-change-speaker-volume

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 change the volume of the speaker.

privilege.sipendpoint.can-change-microphone-volume

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 change the volume of the microphone.

login.prompt-place

Section: interaction-workspace
Default Value: false
Valid Values: true, false.
Changes Take Effect: Immediately
Introduced: 9.0.000.31
Modified: 9.0.000.74
Related Options: login.voice.prompt-dn-less-phone-number

Specifies whether the agent must enter his place in the login window. When this option is set to true, a new page is displayed during the login phase to specify a place. Enabling this option disables login.voice.prompt-dn-less-phone-number.

privilege.voice.can-use

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

Enables the agent to use the Voice channel.

privilege.sipendpoint.can-use

Section: interaction-workspace
Default Value: false
Valid Values: true, false.
Changes Take Effect: Immediately
Introduced: 9.0.000.31
Modified: 9.0.000.74
Related Options: login.prompt-place

Enables the usage of Genesys Softphone. Depends on 'Voice - Can Use Voice Channel'.

intercommunication.voice.make-call-caller-id-business-attribute

Section: interaction-workspace
Default Value: No default value
Valid Values: Letters A to Z and a to z. Numbers 0 through 9. The underscore and space characters.
Changes Take Effect: After the next platform configuration refresh interval.
Introduced: 9.0.000.31
Modified: 9.0.000.65

Specifies the name of the Business Attribute that contains the Attribute Values that are used as outbound caller IDs. This option is only applicable for external calls.

interaction.reject-route

Section: interaction-workspace
Default Value: No default value
Valid Values: A string that represents an attached data key.
Changes Take Effect: Immediately
Introduced: 9.0.000.31
Modified: 9.0.000.85

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 this option 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>. When reject-method is specified, ensure that the following characters are also specified: :, @, and the switch field. The following are possible values for the reject-method attribute:

sst: Reject applies the following action: SingleStepTransfer(OtherDN=<dn>,Location=<switch>).
release: Reject applies the following action: releaseCall. This value must be applied when the value of the TServer/divert-on-ringing SIP Server configuration option is set to false.
redirect: Reject applies the following action: redirectCall

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.

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.

contact.ucs-interaction.voice.enable-create

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

voice.use-caller-id-display-name

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: intercommunication.voice.make-call-caller-id-business-attribute

Specifies that the Caller Id Display Name is to be used when caller id is used. This feature requires that the value of the SIP Server TServer/use-display-name option be set to true. The Caller Id Display Name should be the display name of the caller ID in business attribute value specified by the intercommunication.voice.make-call-caller-id-business-attribute option.

voice.reject.counter-key-name

Section: interaction-workspace
Default Value: No default value
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 a counter in attached data when a call is rejected. This option can be overridden by a routing strategy as described in the Configuration Guide.

voice.hold-indicator-timer

Section: interaction-workspace
Default Value: 30,60
Valid Values: A comma-separated list value: warning time, maximum time
Changes Take Effect: After the next platform configuration refresh interval.
Introduced: 9.0.000.31

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.

voice.hold-active-call-on-make-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

Specifies whether the active call is turned to hold before placing an independent call. When disabled, the make call operation isn't available when there is a call on hold.

voice.floating-interaction-mode.auto-collapse

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 new floating voice interactions are displayed collapsed automatically.

voice.enable-dtmf-tone

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 a tone is played when an agent clicks a DTMF key.

voice.clear-conference-on-release

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 the conference call is cleared (all the parties in the conference are released) when the last agent leaves the conference.

voice.cancel-after-call-work-on-business-call

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 voice channel should be canceled its After Call Work status when the agents switches from After Call Work to Ready or Not Ready during a business call. This option is specific to SIP Server environment.

voice.caller-id.key-name

Section: interaction-workspace
Default Value: IW_SelectedCallerId
Valid Values: An attached data key name (string)
Changes Take Effect: After the next platform configuration refresh interval.
Introduced: 9.0.000.31
Modified: 9.0.000.65

Specifies the key name of the attached data that contains the selected caller id information.

voice.prompt-for-end

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 Workspace displays a confirmation message when the agent clicks End. This option can be overridden by a routing strategy as described in the Configuration Guide.

voice.mark-done-on-release

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 an interaction should be closed automatically if a Release message is received. This option can be overridden by a routing strategy as described in the Configuration Guide.

voice.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 a voice interaction is automatically answered when a EventRinging message is received. This option can be overridden by a routing strategy as described in the Configuration Guide.

voice.auto-answer.is-enabled-on-already-in-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
Related Options: voice.auto-answer

Specifies whether a voice interaction is automatically answered if there is other active call(s) (used only with voice.auto-answer set to true). This option can be overridden by a routing strategy as described in the Configuration Guide.

voice.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 a voice interaction is automatically answered when a EventRinging message is received. This option can be overridden by a routing strategy as described in the Configuration Guide.

privilege.voice.single-step-transfer.can-use-caller-id

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 use caller ID for single-step transfers.

privilege.voice.single-step-conference.can-use-caller-id

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 use caller ID for single-step conferences.

privilege.voice.show-monitoring.can-use

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

Enables agents to be notified that the current call is monitored by a supervisor.

privilege.voice.make-call.can-use-caller-id

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 agents to use caller ID for making calls.

privilege.voice.consultation.can-use-caller-id

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 use caller ID for consultations.

privilege.voice.can-two-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 two-step transfer of a voice call.

privilege.voice.can-two-step-conference

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 two-step conference for voice calls.

privilege.voice.can-show-post-call-duration

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 see the post call duration in the tooltip and in the interaction bar of a voice call.

privilege.voice.can-show-hold-duration

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 see the amount of time that a voice call has been on hold.

privilege.voice.can-send-dtmf

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 agents to send DTMF during a voice call by using the on screen number keypad.

privilege.voice.can-release-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 agents to manually end voice calls.

privilege.voice.can-reject-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 reject an incoming voice call.

privilege.voice.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 instant conferencing of a voice call.

privilege.voice.can-one-step-conference

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 instant conferencing of a voice call.

privilege.voice.can-make-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 make a new voice call from any area enabling voice calls.

privilege.voice.can-hold-retrieve-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 and agent to hold or retrieve a voice call.

privilege.voice.can-forward

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 forward voice calls.

privilege.voice.can-extend-after-call-work

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

Enables an agent to extend the After Call Work state.

privilege.voice.can-answer-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 manually answer an incoming voice call. Setting this option to false hides the Accept button in the Interaction notification pop-up.

privilege.voice.can-use

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

Enables the agent to use the Voice channel.

(Created target blank page For Version: HTCC:9.0.0)
 
(Update with the copy of version: 9.0.0DRAFT)
Line 1: Line 1:
<!-- Creation of the target page -->
+
= Setting Up Agents On The System=
 +
__TOC__
 +
After you have created Agent objects you can set up your agents and [[SettingUpSupervisors|supervisors]] to use different functionality. The following procedures assume that you know how to use the [[Documentation:GA:user:Welcome|Genesys Administrator Extension]] application to [[IntroToConfigOptions#ConfigAdmin|configure agent objects]].
 +
 
 +
Workspace Agent Desktop functionality is configured on the <tt>Cloud_Cluster</tt> object in the <tt>interaction-workspace</tt> section. You must create this section and then create the individual configuration options that you need.
 +
 
 +
{{NoteFormat|For agents who also handle multimedia (chat, email, and so on) interactions or for multimedia-only (non-voice) agents, refer to [[HandlingInteractions|Handling Interactions]] and the individual channels in the sub-topics.|2}}
 +
{{AnchorDiv|ProvisionVoice}}
 +
==Provisioning Workspace Agent Desktop for the Voice channel==
 +
'''Purpose:'''
 +
To enable an agent to log in to the Voice channel.
 +
 
 +
'''Prerequisites'''
 +
* A working knowledge of Genesys Administrator Extension (GAX).
 +
* A <tt>Cloud_Cluster</tt> object exists in the Configuration Database.
 +
* T-Server with the associated switch and switching office.
 +
* Agents with logins configured with DNs that correspond to agent devices in the switch.
 +
* A Place that contains one or more DNs from the switch.
 +
'''Start'''
 +
 
 +
For each agent that you want to configure to use the Voice channel, do the following:
 +
<ol type="1">
 +
<li>Select at least one <tt>AgentLogin</tt> from the switch.</li>
 +
<li>Reference a default place.</li>
 +
<li>In GAX, set the value of the <tt>Agent</tt> property to <tt>True</tt>.</li>
 +
<li>Verify that the Voice media in [[Documentation:HTCC:IWWDep:SettingUpAgents#ProvisionVoice|Web Services]] is enabled.</li>
 +
<li>Configure the [[Documentation:Options:HTCC:HTCC-interaction-workspace|Voice]] options in the <tt>interaction-workspace</tt> section of the <tt>Cloud_Cluster</tt> object.</li>
 +
</ol>
 +
'''End'''
 +
 
 +
{{AnchorDiv|VoicePrivileges}}
 +
 
 +
==Granting Voice Privileges==
 +
To enable agents to use the voice channel, grant the following privilege: {{Optionslink|link=Options:Genesys_Web_Services:interaction-workspace:privilege-voice-can-use}}
 +
 
 +
Workspace Agent Desktop uses the following privileges to enable voice-related functionality:
 +
{| class="no-border"
 +
|
 +
*{{Optionslink|link=Options:Genesys_Web_Services:interaction-workspace:privilege-voice-can-answer-call}}
 +
*{{Optionslink|link=Options:Genesys_Web_Services:interaction-workspace:privilege-voice-can-extend-after-call-work}}
 +
*{{Optionslink|link=Options:Genesys_Web_Services:interaction-workspace:privilege-voice-can-forward}}
 +
*{{Optionslink|link=Options:Genesys_Web_Services:interaction-workspace:privilege-voice-can-hold-retrieve-call}}
 +
*{{Optionslink|link=Options:Genesys_Web_Services:interaction-workspace:privilege-voice-can-make-call}}
 +
*{{Optionslink|link=Options:Genesys_Web_Services:interaction-workspace:privilege-voice-can-one-step-conference}}
 +
*{{Optionslink|link=Options:Genesys_Web_Services:interaction-workspace:privilege-voice-can-one-step-transfer}}
 +
*{{Optionslink|link=Options:Genesys_Web_Services:interaction-workspace:privilege-voice-can-reject-call}}
 +
*{{Optionslink|link=Options:Genesys_Web_Services:interaction-workspace:privilege-voice-can-release-call}}
 +
*{{Optionslink|link=Options:Genesys_Web_Services:interaction-workspace:privilege-voice-can-send-dtmf}}
 +
|
 +
*{{Optionslink|link=Options:Genesys_Web_Services:interaction-workspace:privilege-voice-can-show-hold-duration}}
 +
*{{Optionslink|link=Options:Genesys_Web_Services:interaction-workspace:privilege-voice-can-show-post-call-duration}}
 +
*{{Optionslink|link=Options:Genesys_Web_Services:interaction-workspace:privilege-voice-can-two-step-conference}}
 +
*{{Optionslink|link=Options:Genesys_Web_Services:interaction-workspace:privilege-voice-can-two-step-transfer}}
 +
*{{Optionslink|link=Options:Genesys_Web_Services:interaction-workspace:privilege-voice-consultation-can-use-caller-id}}
 +
*{{Optionslink|link=Options:Genesys_Web_Services:interaction-workspace:privilege-voice-make-call-can-use-caller-id}}
 +
*{{Optionslink|link=Options:Genesys_Web_Services:interaction-workspace:privilege-voice-show-monitoring-can-use}}
 +
*{{Optionslink|link=Options:Genesys_Web_Services:interaction-workspace:privilege-voice-single-step-conference-can-use-caller-id}}
 +
*{{Optionslink|link=Options:Genesys_Web_Services:interaction-workspace:privilege-voice-single-step-transfer-can-use-caller-id}}
 +
|}
 +
 
 +
==Controlling the behavior of voice interactions==
 +
You can use the following options in the '''[interaction-workspace]''' section to configure voice interactions:
 +
* {{Optionslink|link=Options:Genesys_Web_Services:interaction-workspace:voice-auto-answer}}: Specifies whether a voice interaction is automatically answered when a TServer Ringing event is received.
 +
* {{Optionslink|link=Options:Genesys_Web_Services:interaction-workspace:voice-auto-answer-is-enabled-on-already-in-call}}: When <tt>{{Optionslink|link=Options:Genesys_Web_Services:interaction-workspace:voice-auto-answer}}</tt> is set to <tt>true</tt>, this option specifies whether a voice interaction is automatically answered if there is another active call.
 +
* {{Optionslink|link=Options:Genesys_Web_Services:interaction-workspace:voice-mark-done-on-release}}: Specifies whether the Mark Done function is required to complete the release of the call.
 +
* {{Optionslink|link=Options:Genesys_Web_Services:interaction-workspace:voice-prompt-for-end}}: Specifies whether Workspace displays a confirmation message when the agent clicks 'End'.
 +
* {{Optionslink|link=Options:Genesys_Web_Services:interaction-workspace:voice-caller-id-key-name}}: Specifies the key name of the attached data that contains the selected caller id information.
 +
* {{Optionslink|link=Options:Genesys_Web_Services:interaction-workspace:voice-cancel-after-call-work-on-business-call}}:Specifies if the After Call Work status of the voice channel should be canceled when the agents switches from After Call Work to Ready or Not Ready during a business call. This option is specific to SIP Server environments.
 +
* {{Optionslink|link=Options:Genesys_Web_Services:interaction-workspace:voice-clear-conference-on-release}}: Specifies whether all the parties in the conference are released when the last agent leaves the conference.
 +
* {{Optionslink|link=Options:Genesys_Web_Services:interaction-workspace:voice-enable-dtmf-tone}}: Specifies whether a tone is played when the agent selects a {{Glossaryterm|term=DTMF|addlink=true}} key.
 +
* {{Optionslink|link=Options:Genesys_Web_Services:interaction-workspace:voice-floating-interaction-mode-auto-collapse}}: Specifies whether new floating voice interactions are automatically collapsed.
 +
* {{Optionslink|link=Options:Genesys_Web_Services:interaction-workspace:voice-hold-active-call-on-make-call}}: Specifies whether the active call is placed on hold when an agent makes an independent call. When disabled, the make call operation isn't available if there is a call on hold.
 +
* {{Optionslink|link=Options:Genesys_Web_Services:interaction-workspace:voice-hold-indicator-timer}}: Specifies two alarm thresholds, in seconds, that warn agents when 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.
 +
* {{Optionslink|link=Options:Genesys_Web_Services:interaction-workspace:voice-reject-counter-key-name}}: Specifies the key that is used to populate a counter in attached data when a call is rejected.
 +
* {{Optionslink|link=Options:Genesys_Web_Services:interaction-workspace:voice-use-caller-id-display-name}}: Enables the Caller Id Display Name and allows it to be used when caller id is used.
 +
* {{Optionslink|link=Options:Genesys_Web_Services:interaction-workspace:contact-ucs-interaction-voice-enable-create}}: Enable the interaction history to be generated in Universal Contact Server (UCS) for Voice interactions.
 +
* {{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.
 +
* {{Optionslink|link=Options:Genesys_Web_Services:interaction-workspace:interaction-disposition-key-name}}: 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.
 +
* {{Optionslink|link=Options:Genesys_Web_Services:interaction-workspace:interaction-disposition-use-attached-data}}: Enables the adding of attached data from the interaction in UserEvent.
 +
* {{Optionslink|link=Options:Genesys_Web_Services:interaction-workspace:interaction-disposition-value-business-attribute}}: Specifies the name of the Business Attribute that contains the Attribute Values that are used as an enumerated value for a disposition code.
 +
* {{Optionslink|link=Options:Genesys_Web_Services:interaction-workspace:interaction-reject-route}}: Enables the <tt>reject route</tt> 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.
 +
* {{Optionslink|link=Options:Genesys_Web_Services:interaction-workspace:intercommunication-voice-make-call-caller-id-business-attribute}}:  A character string that specifies the name of the Business Attribute that contains the Attribute Values used as an enumerated value to select the caller id during a make call.
 +
 
 +
{{AnchorDiv|SIPEndpoint}}
 +
 
 +
==Setting up your SIP Endpoint==
 +
If you are using Genesys Softphone for your SIP Endpoint, see [[SIPPhoneConfig|Genesys Softphone integration]] for information about setting it up and using it.
 +
 
 +
To enable your agents to use another SIP Endpoint, you can grant the following privileges:
 +
 
 +
* {{Optionslink|link=Options:Genesys_Web_Services:interaction-workspace:privilege-sipendpoint-can-use}}: Enables use  of a SIP Endpoint. Depends on {{Optionslink|link=Options:Genesys_Web_Services:interaction-workspace:privilege-voice-can-use}}. The {{Optionslink|link=Options:Genesys_Web_Services:interaction-workspace:login-prompt-place}} option must not be enabled if this privilege is granted.
 +
* {{Optionslink|link=Options:Genesys_Web_Services:interaction-workspace:privilege-sipendpoint-can-change-microphone-volume}}: Allows agents to change the volume of the microphone.
 +
* {{Optionslink|link=Options:Genesys_Web_Services:interaction-workspace:privilege-sipendpoint-can-change-speaker-volume}} : Allows agents to change the volume of the speaker.
 +
* {{Optionslink|link=Options:Genesys_Web_Services:interaction-workspace:privilege-sipendpoint-can-mute-microphone}}: Allows agents to mute and unmute the microphone.
 +
* {{Optionslink|link=Options:Genesys_Web_Services:interaction-workspace:privilege-sipendpoint-can-mute-speaker}}: Allows agents to mute and unmute the speaker.
 +
 
 +
Use the following options to manage SIP Endpoints, such as the Genesys Softphone:
 +
* {{Optionslink|link=Options:Genesys_Web_Services:interaction-workspace:sipendpoint-headset-unplugged-not-ready-reason}}: Specifies the Not Ready reason that is to be set for the SIP DN when the headset that is used by the agent is unplugged if the value of the {{Optionslink|link=Options:Genesys_Web_Services:interaction-workspace:sipendpoint-headset-unplugged-set-not-ready}} option is set to <tt>true</tt>.
 +
* {{Optionslink|link=Options:Genesys_Web_Services:interaction-workspace:sipendpoint-headset-unplugged-set-not-ready}}: Specifies whether the agent SIP DN is set automatically to Not Ready when the headset that is configured for the agent is unplugged.
 +
* {{Optionslink|link=Options:Genesys_Web_Services:interaction-workspace:sipendpoint-max-failed-ping}}: Specifies the number of failed pings allowed on Genesys Softphone.
 +
* {{Optionslink|link=Options:Genesys_Web_Services:interaction-workspace:sipendpoint-ping-interval}}: Specifies the interval, in milliseconds, between each ping of the Genesys Softphone.
 +
* {{Optionslink|link=Options:Genesys_Web_Services:interaction-workspace:sipendpoint-register-interval}}: Specifies the interval, in milliseconds, between each register on the Genesys Softphone.
 +
* {{Optionslink|link=Options:Genesys_Web_Services:interaction-workspace:sipendpoint-register-max-attempts}}: Specifies the number of failed attempts allowed on check if register is done.
 +
* {{Optionslink|link=Options:Genesys_Web_Services:interaction-workspace:sipendpoint-sip-server-address}}: Specifies the address of the SIP server and, optionally, the port using the <tt>&lt;address&gt;:&lt;port&gt;</tt> format. If the port is not specified, the Genesys Softphone uses DNS SRV resolution for the specified address.
 +
* {{Optionslink|link=Options:Genesys_Web_Services:interaction-workspace:sipendpoint-sip-server-address-peer}}: In a Business Continuity environment, specifies the address of the peer SIP server and, optionally, the port using the <tt>&lt;address&gt;:&lt;port&gt;</tt> format. If the port is not specified, the Genesys Softphone uses DNS SRV resolution for the specified address. Requires Genesys Softphone 8.5.400.08 or higher.
 +
* {{Optionslink|link=Options:Genesys_Web_Services:interaction-workspace:sipendpoint-transport-protocol}}: Specifies whether UDP, TCP, or TLS is used for the SIP transport protocol.
 +
* {{Optionslink|link=Options:Genesys_Web_Services:interaction-workspace:sipendpoint-uri}}: URI of the SIP endpoint used in connector mode. For example: <nowiki>https://localhost:8000</nowiki>
 +
* {{Optionslink|link=Options:Genesys_Web_Services:interaction-workspace:sipendpoint-wait-user-max-attempts}}: Specifies the number of failed waiting user actions that are allowed before timeout.
 +
 
 +
<!--== WebRTC==
 +
If your environment uses WebRTC, you must use the following privileges and options in addition to the Voice privileges and options to enable agents to handle voice calls.
 +
 
 +
===Granting Voice Privileges===
 +
To enable agents to integrate the WebRTC voice channel, grant the following privilege: {{Optionslink|link=Options:Genesys_Web_Services:interaction-workspace:privilege-web-rtc.can-use}}.  Depends on {{Optionslink|link=Options:Genesys_Web_Services:interaction-workspace:privilege-voice-can-use}}.
 +
 
 +
Workspace Agent Desktop uses the following privileges to enable WebRTC voice-related functionality:
 +
*{{Optionslink|link=Options:Genesys_Web_Services:interaction-workspace:privilege-web-rtc-can-mute-microphone}}
 +
*{{Optionslink|link=Options:Genesys_Web_Services:interaction-workspace:privilege-web-rtc-can-mute-speaker}}
 +
*{{Optionslink|link=Options:Genesys_Web_Services:interaction-workspace:privilege-web-rtc-can-send-dtmf}}
 +
 
 +
===Controlling the behavior of WebRTC voice interactions===
 +
You can use the following options in the [interaction-workspace] section to configure WebRTC voice interactions:
 +
* {{Optionslink|link=Options:Genesys_Web_Services:interaction-workspace:web-rtc-enable-dtmf-tone}}: Specifies whether a tone is played when the agent selects a DTMF key.
 +
* {{Optionslink|link=Options:Genesys_Web_Services:interaction-workspace:web-rtc-gateway-uri}}: Specifies the host for the WebRTC gateway.
 +
<!--* {{Optionslink|link=Options:Genesys_Web_Services:interaction-workspace:web-rtc-identifier-x-last-digit-displayed}}: Specifies the number of digits of the WebRTC identifier to display in Workspace.-->
 +
<!--* {{Optionslink|link=Options:Genesys_Web_Services:interaction-workspace:web-rtc-phone-number-prefix}}: Specifies the prefix that is used for the phone number that is dynamically created for WebRTC.-->
 +
<!--* {{Optionslink|link=Options:Genesys_Web_Services:interaction-workspace:web-rtc-quality-alert-timeout}}: Specifies the time, in seconds, that passes before an alert is displayed to notify that timeout occurred during a test call.
 +
* {{Optionslink|link=Options:Genesys_Web_Services:interaction-workspace:web-rtc-quality-score-key-name}}: Specifies the key in the UserEvent that Workspace should use for the call quality score set by the agent. The agent only provides this score if the WebRTC API detects low quality of audio for the call.
 +
* {{Optionslink|link=Options:Genesys_Web_Services:interaction-workspace:web-rtc-quality-statistics-key-name}}: Specifies the key in the UserEvent that Workspace should use for the call quality statistics it receives from the WebRTC API.
 +
* {{Optionslink|link=Options:Genesys_Web_Services:interaction-workspace:web-rtc-request-quality-interval}}: Specifies the interval, in seconds, to request audio call quality from the [[Documentation:WRTC:Developer:Welcome|Genesys WebRTC JavaScript API]].
 +
* {{Optionslink|link=Options:Genesys_Web_Services:interaction-workspace:web-rtc-ringing-bell}}: Specifies the voice channel ringing sound-configuration string.
 +
* {{Optionslink|link=Options:Genesys_Web_Services:interaction-workspace:web-rtc-stun-uri}}: Specifies the URI to the STUN server.
 +
* {{Optionslink|link=Options:Genesys_Web_Services:interaction-workspace:web-rtc-troubleshooting-enable-feedback}}: Enables WebRTC to send a user event that contains diagnostic information.
 +
* {{Optionslink|link=Options:Genesys_Web_Services:interaction-workspace:web-rtc-turn-password}}: Specifies the password for the TURN server.
 +
* {{Optionslink|link=Options:Genesys_Web_Services:interaction-workspace:web-rtc-turn-username}} Specifies the username for TURN server.
 +
* {{Optionslink|link=Options:Genesys_Web_Services:interaction-workspace:web-rtc-turn-uri}}: Specifies the URI to the TURN server.
 +
 
 +
{{NoteFormat|{{Optionslink|link=Options:Genesys_Web_Services:interaction-workspace:login-voice-prompt-dn-less-phone-number}} is mandatory for WebRTC.}}-->
 +
<!--== Enabling WebRTC==
 +
You can enable agents to use [[Documentation/WRTC|WebRTC]] for basic call control capabilities, such as:
 +
*Making a call
 +
*Answer a call
 +
*Disconnect a call
 +
*Place call on and off hold
 +
*Transfer
 +
*Conference
 +
*Place a consultation call
 +
*Generate DTMF tones using a keypad
 +
Workspace also allows agents to provide feedback on call quality for calls that have low scores returned by the [[Documentation:WRTC:Developer:Welcome|Genesys WebRTC JavaScript API]].<br/><br/>
 +
 
 +
Before you begin, ensure that the following prerequisites are met:
 +
 
 +
* You have {{#Widget:ExtLink|link=https://wiki.eclipse.org/Jetty/Howto/Configure_SSL|displaytext=configured Jetty for SSL}}.
 +
* A working knowledge of Genesys Administrator Extension (GAX).
 +
* The <tt>Cloud_Cluster</tt> application object exists in the Configuration Database.
 +
 
 +
{{NoteFormat|[[Documentation:HTCC:IWWDep:LoginVoice#login.voice.prompt-dn-less-phone-number|login.voice.prompt-dn-less-phone-number]] is mandatory for WebRTC.}}
 +
 
 +
To enable WebRTC:
 +
 
 +
<ol>
 +
<li>Configure the [[WebRTC|WebRTC]] options in the <tt>interaction-workspace</tt> section of the <tt>Cloud_Cluster</tt> application object. </li>
 +
<li>You should also make sure that {{Optionslink|link=Options:Genesys_Web_Services:interaction-workspace:privilege-voice-can-use}} is set to <tt>true</tt>.</li>
 +
</ol>
 +
-->
 +
 
 +
==Setting up the user interface behavior==
 +
Use the following option to control the behavior of system messages:
 +
* {{Optionslink|link=Options:Genesys_Web_Services:interaction-workspace:alert-timeout}}: Specifies the duration, in seconds, that contextual warning messages are displayed in the windows of the application.
 +
Use the following options to control the behavior and appearance of the Workspace Agent Desktop application:
 +
* {{Optionslink|link=Options:Genesys_Web_Services:interaction-workspace:main-window-window-title}}: Specifies the title of the browser window or tab.
 +
* {{Optionslink|link=Options:Genesys_Web_Services:interaction-workspace:interaction-bar-quick-access-modes}}: Specifies the list of modes that are available to present interactions.  The available modes are:
 +
** <tt>Pinned</tt>: the interaction view occupies the full available size, shared with Supporting Views like '''Contact''' and '''Responses'''.
 +
** <tt>Floating</tt>: the interaction view is presented in a floating window that is painted above any other kind of content and that fits the visual material to display. This view cannot display content displayed on the right part, such as '''Contact Profile''' or '''Responses'''.   
 +
*:When more than one mode is specified, by default the first mode in the configured list is used. The end user can switch from one mode to the other using a dedicated control. For a given media type, this option can be overridden by option {{Optionslink|link=Options:Genesys_Web_Services:interaction-workspace:interaction-bar-quick-access-modes-zmedia-type-}}.
 +
*{{Optionslink|link=Options:Genesys_Web_Services:interaction-workspace:interaction-bar-quick-access-modes-zmedia-type-}}:  Use this option as a template to specify the list of modes available to present interactions of the given media type. The available modes are:
 +
** <tt>Pinned</tt>: the interaction view occupies the full available size, shared with Supporting Views like '''Contact''' and '''Responses'''.
 +
** <tt>Floating</tt>: the interaction view is presented in a floating window that is painted above any other kind of content and that fits the visual material to display. This view cannot display content displayed on the right part, such as '''Contact Profile''' or '''Responses'''.
 +
*:When more than one mode is specified, by default the first mode in the configured list is used. The end user can switch from one mode to the other using a dedicated control. When it is defined for a media type this option overwrites the definition of generic option {{Optionslink|link=Options:Genesys_Web_Services:interaction-workspace:interaction-bar-quick-access-modes}}.
 +
 
 +
==Granting basic Contact and Interaction History privileges==
 +
When interactions are received, you can control how agent can view and interact with an interaction:
 +
* {{Optionslink|link=Options:Genesys_Web_Services:interaction-workspace:privilege-contact-can-use-contact-information}}: Enable the agent to view the Contact Information view in an interaction.
 +
* {{Optionslink|link=Options:Genesys_Web_Services:interaction-workspace:privilege-contact-can-use-assign-contact}}: Enable an agent to assign a contact to an interaction.
 +
* {{Optionslink|link=Options:Genesys_Web_Services:interaction-workspace:privilege-contact-can-use-interaction-notepad}}: Enable an agent to display and edit the interaction notepad while handling an interaction.
 +
* {{Optionslink|link=Options:Genesys_Web_Services:interaction-workspace:privilege-contact-can-use-save-contact}}: Enable an agent to make and commit modifications made to contact information.
 +
* {{Optionslink|link=Options:Genesys_Web_Services:interaction-workspace:privilege-contact-can-create-contact}}: Enables agents to create contacts in the contact database.
 +
* {{Optionslink|link=Options:Genesys_Web_Services:interaction-workspace:privilege-contact-can-delete-contact}}: Enables agents to delete contacts from the contact database.
 +
 
 +
==Setting up the system behavior==
 +
Use the following options to control the display of the System Feedback menu and dialog:
 +
* {{Optionslink|link=Options:Genesys_Web_Services:interaction-workspace:system-feedback}}: When this option is set to true, the '''Feedback''' menu item appears in the '''Help''' menu
 +
* {{Optionslink|link=Options:Genesys_Web_Services:interaction-workspace:system-feedback-submit-after-disconnect}}: When this option is set to <tt>true</tt>, a feedback dialog box is displayed when a user logs in again after a session disconnects due to the Cometd defense managed by the {{Optionslink|link=Options:Genesys_Web_Services:interaction-workspace:system-cometd-timeout}} option.
 +
 
 +
Use the following option to control session behavior when the system connection drops:
 +
* {{Optionslink|link=Options:Genesys_Web_Services:interaction-workspace:system-cometd-timeout}}: Specifies the duration, in milliseconds, before the session is considered closed when the connection with the server is lost.
 +
 
 +
Use the following option to control session logging:
 +
* {{Optionslink|link=Options:Genesys_Web_Services:interaction-workspace:system-log-level}}: Specifies the global log level.
 +
 
 +
==Enabling Workspace to use ring tones==
 +
'''Purpose:'''
 +
To enable Workspace Agent Desktop to use ring tones for incoming interactions and state changes. You can set different tones for different types of interactions using either absolute URLs that point to custom sounds or the set of aliases Workspace provides for standard sounds:
 +
*BELL
 +
*RING
 +
*CHORD
 +
*WARNING
 +
 
 +
'''Prerequisites'''
 +
* A working knowledge of Genesys Administrator Extension (GAX).
 +
* A <tt>Cloud_Cluster</tt> object exists in the Configuration Database.
 +
'''Start'''
 +
#In the Configuration Layer, you can set any of the following options to enable ring tones on incoming interactions and state changes:
 +
#*{{Optionslink|link=Options:Genesys_Web_Services:interaction-workspace:accessibility-agent-state-change-bell}}
 +
#*{{Optionslink|link=Options:Genesys_Web_Services:interaction-workspace:accessibility-interaction-state-change-bell}}
 +
#*{{Optionslink|link=Options:Genesys_Web_Services:interaction-workspace:accessibility-outbound-campaign-state-change-bell}}
 +
#*{{Optionslink|link=Options:Genesys_Web_Services:interaction-workspace:accessibility-warning-message-bell}}
 +
#*{{Optionslink|link=Options:Genesys_Web_Services:interaction-workspace:chat-new-message-bell}}
 +
#*{{Optionslink|link=Options:Genesys_Web_Services:interaction-workspace:chat-ringing-bell}}
 +
#*{{Optionslink|link=Options:Genesys_Web_Services:interaction-workspace:email-ringing-bell}}
 +
<!--#*{{Optionslink|link=Options:Genesys_Web_Services:interaction-workspace:facebook-ringing-bell}}-->
 +
#*{{Optionslink|link=Options:Genesys_Web_Services:interaction-workspace:outbound-callback-ringing-bell}}
 +
<!--#*{{Optionslink|link=Options:Genesys_Web_Services:interaction-workspace:twitter-ringing-bell}}-->
 +
#*{{Optionslink|link=Options:Genesys_Web_Services:interaction-workspace:voice-ringing-bell}}
 +
#*{{Optionslink|link=Options:Genesys_Web_Services:interaction-workspace:-media-type-zringing-bell}}: Specifies the ring tone file for the specified Media Type.
 +
'''End'''
 +
 
 +
==Declaring and using new Not-Ready Reason codes==
 +
'''Purpose:'''
 +
To enable an agent to use custom Not-Ready Reason codes.
 +
 
 +
Custom Not-Ready Reason codes must be defined by creating an Action Code in the <tt>Action Codes</tt> folder of the <tt>Desktop</tt> folder in the <tt>Provisioning</tt> view of Genesys Administrator Extension.
 +
 
 +
'''Prerequisites'''
 +
* A working knowledge of Genesys Administrator Extension (GAX).
 +
* A <tt>Cloud_Cluster</tt> object exists in the Configuration Database.
 +
'''Start'''
 +
<ol type="1">
 +
<li>In the Configuration Layer, create an Action Code of type <tt>Not Ready</tt> by using the [[ActionCodes|Action Codes - NotReady procedure]]. Each Not Ready Reason Action Code object that you create must have a unique name and a Not Ready Reason code. You can create Action Codes only for the Tenant object.</li>
 +
<li>Enable this feature by specifying the <tt>NotReadyReason</tt> as the value for the {{Optionslink|link=Options:Genesys_Web_Services:interaction-workspace:agent-status-enabled-actions-by-channel}} and {{Optionslink|link=Options:Genesys_Web_Services:interaction-workspace:agent-status-enabled-actions-global}} options.</li>
 +
<!--<li>Configure the Workspace {{Optionslink|link=Options:Genesys_Web_Services:interaction-workspace:agent-status-not-ready-reasons}} option to include the value that is specified in the Action Code (refer to the [[AgentStatus|Agent status]] configuration option reference). Not-Ready Reasons are displayed in the order that is defined by the value of the <tt>agent-status.not-ready-reasons</tt> option. If no value is specified for the <tt>agent-status.not-ready-reasons</tt> option, the default behavior is to display all Not-Ready Reasons that are defined and enabled in the Action Code folder.</li>-->
 +
</ol>
 +
'''End'''
 +
 
 +
==Declaring and using new After Call Work Reason codes==
 +
'''Purpose:'''
 +
To enable an agent to use custom After Call Work Reason codes.
 +
 
 +
The only After Call Work state that Workspace Agent Desktop supports by default is <tt>After Call Work</tt>. Custom After Call Work codes must be defined by creating an Action Code in the <tt>Action Codes</tt> folder of the <tt>Desktop</tt> folder in the <tt>Provisioning</tt> view of Genesys Administrator Extension.
 +
 
 +
'''Prerequisites'''
 +
* A working knowledge of Genesys Administrator Extension (GAX).
 +
* A <tt>Cloud_Cluster</tt> object exists in the Configuration Database.
 +
'''Start'''
 +
<ol type="1">
 +
<li>In the Configuration Layer, create an Action Code of type <tt>Not Ready</tt> by using the [[ActionCodes|Action Codes - NotReady procedure]]. Each Not Ready Reason Action Code object that you create must have a unique name and a Not Ready Reason code. You can create Action Codes only for the Tenant object.</li>
 +
<li>To define this Action Code as an After Call Work Reason code, perform the following steps:
 +
<ol type="a">
 +
<li>In the annex of the Action Code, create a section named: <tt>htcc</tt></li>
 +
<li>In this section add the <tt>workmode</tt> option and specify the value <tt>AfterCallWork</tt>.</li>
 +
</ol>
 +
</li>
 +
<li>Enable this feature by specifying the value <tt>AfterCallWork</tt> for the {{Optionslink|link=Options:Genesys_Web_Services:interaction-workspace:agent-status-enabled-actions-by-channel}} and/or {{Optionslink|link=Options:Genesys_Web_Services:interaction-workspace:agent-status-enabled-actions-global}} options.</li>
 +
</ol>
 +
'''End'''
 +
 
 +
 
 +
==Enabling integration of web applications in the agent interface==
 +
'''Purpose:'''
 +
To enable an agent to view or use a third-party web application or website in Workspace Agent Desktop as either a tab, a popup window, in the background at the interaction level, or hidden.
 +
 
 +
To avoid any conflict and security constraints between Workspace and the external website or web application, the external web site or web application is displayed in a dedicated iframe.
 +
 
 +
'''Prerequisites'''
 +
* A working knowledge of Genesys Administrator Extension (GAX).
 +
* A <tt>Cloud_Cluster</tt> object exists in the Configuration Database.
 +
'''Start'''
 +
<ol type="1">
 +
<li>You must create a new option section for each third-party web application that you want to use in Workspace. These sections must be created in the <tt>Cloud_Cluster</tt> object options, Tenant, Agent Group, or Agent annex. For example, create sections called <tt>SearchEngine</tt>, <tt>MyCompanyWebApp</tt> and <tt>SearchLocation</tt>.</li>
 +
<li>In each section, you must create the following options:
 +
 
 +
<ul>
 +
<li><tt>label</tt>:Specifies the label to be used for the name of the tab in the workspace or the button in multimedia interaction.</li>
 +
<li><tt>url</tt>: Specifies the URL of the web application. This URL can contain field codes.
 +
 
 +
{{NoteFormat|
 +
<ul>
 +
<li>If this attribute is left blank, Workspace does not display the web application.</li>
 +
<li>If you configured Web Services to use HTTPS (for example, the URL for Workspace is in the following format: <tt><nowiki>https://<host>:<securePort>/ui/wwe/index.html</nowiki></tt>), then the URL for the external web application must also be in HTTPS.</li>
 +
</ul>
 +
|1}}
 +
 
 +
The following field codes are supported for both the <tt>label</tt> and <tt>url</tt> options:
 +
<ul>
 +
<li><tt>Agent.FullName</tt></li>
 +
<li><tt>Agent.UserName</tt></li>
 +
<li><tt>Agent.LastName</tt></li>
 +
<li><tt>Agent.FirstName</tt></li>
 +
<li><tt>Agent.EmployeeId</tt></li>
 +
<!-- <li><tt>Interaction.MainParty</tt></li> -->
 +
<li><tt>AttachedData.Y</tt> ('''Note:''' This field code is only applicable for custom views; refer to the {{Optionslink|link=Options:Genesys_Web_Services:interaction-workspace:interaction-web-content}} option.)</li>
 +
<li><tt>Interaction.Id</tt> ('''Note:''' This is a client-side ID that is lost on the next session or refresh. This field code is applicable for custom views; refer to the {{Optionslink|link=Options:Genesys_Web_Services:interaction-workspace:interaction-web-content}} option.)</li>
 +
</ul>
 +
An external web site URL can be defined using the <tt>$AttachedData.Y$</tt> parameter to have flexible text in the URL where <tt>Y</tt> represents an attached data name.
 +
{{NoteFormat|
 +
<ul>
 +
<li>If the <tt>$AttachedData.Y$</tt> parameter is specified for the external website URL, and <tt>Y</tt> is not part of the attached data associated with an interaction, the external website is not displayed.</li>
 +
<li>If an agent manually adds the attached data to the interaction (or if it's added by any other means), then the external website tab is displayed with the content of the external website.</li>
 +
</ul>
 +
Refer to the description of <tt>attached-data-update-handle-mode</tt> below for more information.
 +
|3}}
 +
<br>
 +
For example, the external website specified as follows:
 +
<source lang="text">
 +
label = Customer Location
 +
url = http://www.bing.com/search?q=$AttachedData.CustomerLocation$
 +
</source>
 +
With this URL, if an interaction is received with a <tt>CustomerLocation</tt> attached data with the value of <tt>Paris</tt>, then the external website will be displayed in a dedicated tab called '''Customer Location''', and the external web site will be <tt><nowiki>http://www.bing.com/search?q=Paris</nowiki></tt>
 +
</li>
 +
<li><tt>mode</tt>: Specifies the mode Workspace uses to display the web application. The default value is <tt>INTERNAL</tt>. The possible values are:
 +
<ul>
 +
<li><tt>INTERNAL</tt>: The web application is displayed in a dedicated tab in Workspace. It can be viewed and used when the agent clicks the tab to display it. This is the default behavior.</li>
 +
<li><tt>EXTERNAL</tt>: The web application is displayed in a popup window.</li>
 +
<li><tt>BACKGROUND</tt>: The web application is displayed in the background (Workspace area) when the interaction is selected. When the interaction is deselected or closed, the third-party website is replaced with the previous panel that was displayed in the background. This mode is only applicable at the interaction level.</li>
 +
<li><tt>HIDDEN</tt>:The web application is loaded but not displayed in Workspace. You can use this mode to integrate Workspace with a non-web application.</li>
 +
</ul>
 +
</li>
 +
<li><tt>attached-data-update-handle-mode</tt>: Specifies how to handle attached data changes when an external website is configured with attached data. The possible values are:
 +
<ul>
 +
<li><tt>0</tt> (default value): Specifies that when the attached data is updated or deleted, the external website is not updated.</li>
 +
<li><tt>1</tt>: Specifies the following actions to occur:
 +
<ul>
 +
<li>When the attached data is updated, the external website is updated with the new URL.</li>
 +
<li>When the attached data is deleted, the external website is not updated.</li>
 +
</ul>
 +
</li>
 +
<li><tt>2</tt>: Specifies the following actions to occur:
 +
<ul>
 +
<li>When the attached data is updated, the external website is updated with the new URL.</li>
 +
<li>When the attached data is deleted, the external website disappears.</li>
 +
</ul>
 +
</li>
 +
</ul>
 +
</li>
 +
</ul>
 +
</li>
 +
<li>Configure one or both of the following options in the <tt>interaction-workspace</tt> section, depending on whether the application is to be displayed in the interaction view or the workspace view:
 +
<ul>
 +
<li>{{Optionslink|link=Options:Genesys_Web_Services:interaction-workspace:interaction-web-content}}: Defines the list of option section names that represent Web Applications which are configured to be displayed at the interaction level. For example: <tt>SearchLocation</tt></li>
 +
<li>{{Optionslink|link=Options:Genesys_Web_Services:interaction-workspace:workspace-web-content}}: Defines the list of option section names that represent Web Applications which are configured to be displayed at the Workspace level. For example: <tt>SearchEngine</tt>, <tt>MyCompanyWebApp</tt>.</li>
 +
</ul>
 +
{{NoteFormat|Refer to [[ConfigUI|Configuring the User Interface]] for more information.|2}}
 +
</li>
 +
</ol>
 +
'''End'''
 +
 
 +
For example, in the tenant object, configure the following sections and options:
 +
 
 +
<source lang="text">
 +
[SearchEngine]
 +
label=Bing
 +
url=http://www.bing.com
 +
 
 +
[MyCompanyWebApp]
 +
label=Genesys
 +
url=http://www.genesys.com
 +
 
 +
[SearchLocation]
 +
attached-data-update-handle-mode=1
 +
label=Search Location
 +
url=http://myhost/service-client-api/GoogleMaps.html?InteractionId=$Interaction.Id$&att=$AttachedData.GSW_CAMPAIGN_NAME$
 +
mode=BACKGROUND
 +
 
 +
[interaction-workspace]
 +
interaction.web-content=SearchLocation
 +
workspace.web-content=MyCompanyWebApp,SearchEngine
 +
 
 +
</source>
 +
 
 +
==Enabling Security==
 +
'''Purpose:'''
 +
To configure Workspace to log out an agent from the application if the agent has not used the keyboard or mouse for a period that you specify. When this happens, Workspace saves the agent's work, ends the session, logs out the agent on all media channels, and goes back to the login page.
 +
 
 +
'''Prerequisites'''
 +
* A working knowledge of Genesys Administrator Extension (GAX).
 +
* A <tt>Cloud_Cluster</tt> object exists in the Configuration Database.
 +
 
 +
'''Start'''
 +
#In GAX, open the <tt>Cloud_Cluster</tt> application.
 +
#Select the Options tab.
 +
#You must configure the following options in the '''[interaction-workspace]''' section:
 +
#*{{Optionslink|link=Options:Genesys_Web_Services:interaction-workspace:security-inactivity-timeout}}: Specifies the period of inactivity that triggers Workspace to log out the agent. {{NoteFormat|After the timeout occurs, the Workspace login dialog should be blank; however, if the agent has allowed the browser to remember his or her password, then the login dialog will still be populated with the agent's credentials. For security, agents should not allow web browsers to remember their login credentials.|3}}
 +
#*{{Optionslink|link=Options:Genesys_Web_Services:interaction-workspace:security-inactivity-alert-dialog-before-timeout}}: Specifies when to display an alert to the agent about an upcoming inactivity timeout.
 +
'''End'''
 +
 
 +
==Agent Login And Authentication==
 +
 
 +
When an agent launches Workspace Agent Desktop, the agent must provide a user name and password to be authenticated. After authentication, the Configuration Layer is accessed by Workspace Agent Desktop to obtain the list of functions that are granted to the agent as well as the configuration of the Workspace application for that agent.
 +
 
 +
The first time that an agent logs in they must follow a two-step process. After providing the user name and password and clicking '''Log In''', the Change Password dialog box is displayed and the agent must provide a new password.
 +
 
 +
Refer to the [[Documentation:System:SDG:Welcome|Genesys Security Deployment Guide]] for a complete description of password policies and how to configure the Reset Password functionality for agents.
 +
 
 +
Use the following application options in the <tt>interaction-workspace</tt> section to control agent login:
 +
*{{Optionslink|link=Options:Genesys_Web_Services:interaction-workspace:login-prompt-place}}: Specifies whether a new view is displayed during the login phase to specify a place. Enabling this option disables {{Optionslink|link=Options:Genesys_Web_Services:interaction-workspace:login-voice-prompt-dn-less-phone-number}}. Do not enable this option if the {{Optionslink|link=Options:Genesys_Web_Services:interaction-workspace:privilege-sipendpoint-can-use}} privilege is granted.
 +
*{{Optionslink|link=Options:Genesys_Web_Services:interaction-workspace:login-store-recent-place}}: Specifies to store the most recently used place. This option is available if the {{Optionslink|link=Options:Genesys_Web_Services:interaction-workspace:login-prompt-place}} option is set to <tt>true</tt>.
 +
*{{Optionslink|link=Options:Genesys_Web_Services:interaction-workspace:login-voice-auto-not-ready-reason}}: Specifies the <tt>NotReady</tt> reason code if the Voice channel is automatically set to <tt>NotReady</tt> when the agent logs in.
 +
*{{Optionslink|link=Options:Genesys_Web_Services:interaction-workspace:login-voice-prompt-queue}}: Specifies whether a new view is displayed during the login phase to select or specify a queue.
 +
*{{Optionslink|link=Options:Genesys_Web_Services:interaction-workspace:login-voice-list-available-queues}}: Specifies the ACD Queues that are displayed in the login window. If the option value is left blank, no queue is displayed to the agent; the agent can enter any valid login queue name. If a single queue is specified and the value of the {{Optionslink|link=Options:Genesys_Web_Services:interaction-workspace:login-voice-prompt-queue}} no queue information is displayed during login.
 +
*{{Optionslink|link=Options:Genesys_Web_Services:interaction-workspace:login-voice-is-auto-ready}}: Specifies whether the voice channel is in the Ready state at login. See also {{Optionslink|link=Options:Genesys_Web_Services:interaction-workspace:agent-status-ready-workmode}}.
 +
*{{Optionslink|link=Options:Genesys_Web_Services:interaction-workspace:login-list-available-locales}}: Specifies the language that the agent can select at login time. This option applies only to specific T-Servers<!--, such as Avaya,--> that support workmode.
 +
*{{Optionslink|link=Options:Genesys_Web_Services:interaction-workspace:login-workmode}}: Specifies the workmode that is applied when the voice DN logs in. To determine whether your switch supports the workmode, refer to the Configuration Guide of the relevant [[Documentation/TS|T-Server]].
 +
===DN-less Login===
 +
If you want agents to be able to login to the system and take calls on a number that is different than the DN configured for their user account, you can set up a DN-less login to allow agents, agent groups, or all users to specify a new phone number during login. This feature is specific to SIP Server environments. Use the following configuration option to enable this feature:
 +
* {{Optionslink|link=Options:Genesys_Web_Services:interaction-workspace:login-voice-prompt-dn-less-phone-number}}: Specifies whether a new page is displayed during the login phase to show the current phone number assigned to the agent and also permits the agent to update it. This option is specific to SIP Server environment with no Config Server proxy connected to GWS.
 +
* {{Optionslink|link=Options:Genesys_Web_Services:interaction-workspace:login-voice-nb-dn-less-phone-number-stored}}: Specifies the number of phone numbers to be stored for an agent in a DN-less environment.
 +
* {{Optionslink|link=Options:Genesys_Web_Services:interaction-workspace:login-voice-dn-less-phone-number-valid-format}}: Specifies the correct format information to be displayed to the agent when the DN-less phone number format is not correct.
 +
* {{Optionslink|link=Options:Genesys_Web_Services:interaction-workspace:login-voice-expression-dn-less-phone-number}}: Specifies the valid format for a new phone number. A regular expression can be used to check the DN-less phone number format in the login window.
 +
 
 +
<!--===Agent login using a URL===
 +
Agents can log in to Workspace Agent Desktop by using a URL that contains their credentials. When they use a URL, the agent can bypass the Log In window and can directly access the Agent Desktop. The following arguments can be included in the URL:
 +
* place: Required when {{Optionslink|link=Options:Genesys_Web_Services:interaction-workspace:login-prompt-place}} is set to <tt>true</tt>. -->
 +
<!---Hidden option until fully tested * <tt>locale</tt>: See the list of supported locales {{Optionslink|link=Options:Genesys_Web_Services:interaction-workspace:login-list-available-locales}} option.--->
 +
<!--
 +
{{NoteFormat|The username and password arguments are not applicable for Security Assertion Markup Language (SAML) authentication. }}
 +
 
 +
If Workspace Agent Desktop is hosted on <nowiki>https://mydomain/ui/ad/v1/index.html</nowiki>, use the following syntax to automatically log in the agent:
 +
 
 +
<source lang="text">https://mydomain/ui/ad/v1/index.html?username=<username>&password=<password>&place=<place></source>
 +
 
 +
Consider the following examples:
 +
 
 +
* <nowiki>https://mydomain/ui/ad/v1/index.html?username=JohnDoe&password=genesys</nowiki>
 +
* <nowiki>https://mydomain/ui/ad/v1/index.html?username=JohnDoe&password=genesys&place=Place_29820</nowiki>
 +
* <nowiki>https://mydomain/ui/ad/v1/index.html?authType=saml&place=Place_29820</nowiki>
 +
-->
 +
 
 +
==Managing Agent Status==
 +
Workspace Agent Desktop provides options that enable agents to control their status. Use these options to populate the Workspace status menu with one or more of the following selections:
 +
*Global Ready
 +
*Global Not Ready (with reason code)
 +
*Global DND (Do Not Disturb)
 +
*Global After Call Work
 +
*Global Log Off
 +
*Global Login
 +
 
 +
The options enable the following agent states:
 +
*Logged off
 +
*DND (Do Not Disturb)
 +
*After Call Work
 +
*Not Ready - Full (Multiple Reasons)
 +
*Not Ready - Full (Single Reason)
 +
*Ready - Partial (for example, ready on one channel)
 +
*Ready - Full
 +
 
 +
Workspace Agent Desktop also enables detailed agent and place status management through options. Agents can set individual channels to the following states:
 +
*Ready
 +
*Not Ready
 +
*Do Not Disturb
 +
*After Call Work
 +
*Logged off
 +
*Call Forwarded (for voice)
 +
 
 +
You can use the following options in the <tt>interaction-workspace</tt> section to control the contents of the command menu in the Workspace Main Window.
 +
* {{Optionslink|link=Options:Genesys_Web_Services:interaction-workspace:agent-status-enabled-actions-by-channel}}: Specifies the available agent state actions in the My Channels contextual menu. The actions are displayed in the order in which they appear in the list.
 +
* {{Optionslink|link=Options:Genesys_Web_Services:interaction-workspace:agent-status-enabled-actions-global}}: Specifies the available agent states in the global Status menu. The agent state commands are displayed in the order in which they appear in the list.
 +
*{{Optionslink|link=Options:Genesys_Web_Services:interaction-workspace:privilege-mychannels-pending-state-can-use}}: Permits the pending state to be displayed in the '''My Channels''' view while the agent engaged in a call, chat, or email interaction. When the value of this option is set to <tt>true</tt>, if an agent sets his or her status to Not Ready, Not Ready Reason, or any other state while he or she is still handling an interaction, the timer for that state will not start until the call is released, the chat is marked as Done, or the email is sent or put into a workbin.
 +
* {{Optionslink|link=Options:Genesys_Web_Services:interaction-workspace:agent-status-after-call-work-reasons}}: Specifies the available reasons in the Agent Status menus (global and My Channels). Workspace displays the reason commands in the order in which they appear in the list.
 +
* {{Optionslink|link=Options:Genesys_Web_Services:interaction-workspace:agent-status-not-ready-reasons}}: Specifies the available reasons in the global Status menu. The reason commands are displayed in the order in which they appear in the list.
 +
* {{Optionslink|link=Options:Genesys_Web_Services:interaction-workspace:agent-status-ready-workmode}}: Specifies which workmode is applied when the agent manually specifies the Ready  state for the voice DN from the Global State menu or from My Channels. This option applies only to specific T-Servers<!--, such as Avaya,--> that support workmode. This option also applies to the value specified for the <tt>{{Optionslink|link=Options:Genesys_Web_Services:interaction-workspace:login-voice-is-auto-ready}}</tt> option. To determine whether your switch supports the workmode, refer to the Deployment Guide of the relevant [[Documentation/TS|T-Server]].
 +
 
 +
For the Voice channel, you can configure Workspace Agent Desktop to automatically set the agent status to the former status when '''Done''' is clicked. This enables an agent to return to their former status as soon as he or she has completed after call work,  instead of having to manually change status.
 +
*  {{Optionslink|link=Options:Genesys_Web_Services:interaction-workspace:voice-cancel-after-call-work-on-done}}: Specifies that the After Call Work state is changed to the former status when an agent clicks '''Done'''.
 +
 
 +
{{NoteFormat|If an agent manually changes state while still engaged in a voice interaction, their state will display the change, but the time in state will be suspended until the call is ended. This behavior is dependent on the {{Optionslink|link=Options:Genesys_Web_Services:interaction-workspace:privilege-mychannels-pending-state-can-use}} privilege being granted.|1}}
 +
 
 +
==Enabling and Disabling Agents==
 +
'''Purpose:'''
 +
To enable or disable an agent to be available for use by Web Services. Disabled Agents will not be imported into Web Services.
 +
 
 +
'''Prerequisites'''
 +
* A working knowledge of Genesys Administrator Extension (GAX).
 +
* An <tt>Person</tt> object exists in the Configuration Database.
 +
'''Start'''
 +
<ol type="1">
 +
<li>In the configuration layer, use GAX to select <tt>State Enabled</tt> to enable an agent for use. Deselect <tt>State Enabled</tt> to disable an agent.</li>
 +
</ol>
 +
'''End'''
 +
==Enabling caller ID selection==
 +
 
 +
You can enable agents to select a caller ID from pre-defined list of caller IDs.
 +
 
 +
Before you begin, ensure that the following prerequisites are met:
 +
 
 +
*A working knowledge of Genesys Administrator Extension (GAX).
 +
*A <tt>Cloud_Cluster</tt> object exists in the Configuration Database.
 +
 
 +
To enable caller ID selection:
 +
 
 +
<ol>
 +
<li>In GAX, create a Business Attribute that contains the possible caller ID values you want agents to be able to select. In its Business Attribute Values, the name is used to specify the actual phone number Workspace dials. If the Display Name is specified, this is the information Workspace presents to the agent (in alphabetical order).</li>
 +
{{NoteFormat|If the Business Attribute doesn't contain any Business Attribute Values, then the feature isn't enabled. Also, if the attribute contains only one value, then the adapter automatically uses that caller ID so the agent doesn't see a popup when making a call. }}
 +
<li>Set the {{Optionslink|link=Options:Genesys_Web_Services:interaction-workspace:intercommunication-voice-make-call-caller-id-business-attribute}} option to the name of your Business Attribute. For example, if you create a Business Attribute named '''CallerID''', then you would set '''intercommunication.voice.make-call-caller-id-business-attribute''' to <tt>CallerID</tt>.</li>
 +
<li>Set the {{Optionslink|link=Options:Genesys_Web_Services:interaction-workspace:intercommunication-voice-make-call-caller-id-enable-anonymous}} option to <tt>true</tt> to specify whether anonymous is enabled on make call with caller id.</li>
 +
</ol>
 +
 
 +
==Specifying the content of interaction notifications==
 +
 
 +
You can specify the content and appearance of interaction preview notifications (toasts).
 +
 
 +
Before you begin, ensure that the following prerequisites are met:
 +
 
 +
* A working knowledge of Genesys Administrator Extension (GAX).
 +
* A <tt>Business Attribute</tt> object containing the dispositions exists in the Configuration Database.
 +
* A <tt>Cloud_Cluster</tt> application object exists in the Configuration Database.
 +
* The agent object is configured to use one or more of the following media channels:
 +
** [[SettingUpAgents#ProvisionVoice|Voice]]
 +
** [[IntEmail|Email]]
 +
** [[IntChat|Chat]]
 +
** [[IntWorkitems|Workitems]]
 +
<!--** [[EnablingComms|Facebook]]
 +
** [[EnablingComms|Twitter]]-->
 +
 
 +
You  can use the following configuration options to control interaction notifications:
 +
* {{Optionslink|link=Options:Genesys_Web_Services:interaction-workspace:toast-case-data-content}}: Specifies the content of the Case Information area in the toast interaction preview.
 +
* {{Optionslink|link=Options:Genesys_Web_Services:interaction-workspace:toast-case-data-format-business-attribute}}: 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.
 +
* {{Optionslink|link=Options:Genesys_Web_Services:interaction-workspace:toast-window-title}}: Specifies the title of the Interactive Notification window.
 +
{{AnchorDiv|Enablingdispositioncodes}}
 +
==Enabling disposition codes==
 +
 
 +
You can enable agents to specify the outcome (disposition) of an interaction. Disposition Codes are set up as Business Attributes in Configuration Server and set to <tt>State Enabled</tt>.
 +
 
 +
Before you begin, ensure that the following prerequisites are met:
 +
 
 +
* A working knowledge of Genesys Administrator Extension (GAX).
 +
* A <tt>Business Attribute</tt> object containing the dispositions exists in the Configuration Database.
 +
* A <tt>Cloud_Cluster</tt> application object exists in the Configuration Database.
 +
* The agent object is configured to use one or more of the following media channels:
 +
** [[SettingUpAgents#ProvisionVoice|Voice]]
 +
** [[IntEmail|Email]]
 +
** [[IntChat|Chat]]
 +
** [[IntWorkitems|Workitems]]
 +
<!--** [[EnablingComms|Facebook]]
 +
** [[EnablingComms|Twitter]]-->
 +
 
 +
To enable disposition codes:
 +
 
 +
<ol type="1">
 +
<li>In GAX, create or update a Business Attribute in the tenant that contain(s) your agents.
 +
* The <tt>Type</tt> of the Business Attribute is <tt>Interaction Operation Attributes</tt>.
 +
<!--* The <tt>Display Name</tt> of the Business Attribute is used as the name of the section in the Agent interface.-->
 +
* The Attribute values are the codes that are available for the agent:
 +
** <tt>name</tt>&mdash;Used in attached data.
 +
** <tt>display name</tt>&mdash;Used in the Agent interface.
 +
</li>
 +
<li>In the <tt>interaction-workspace</tt> section, set the value of the <tt>interaction.disposition.value-business-attribute</tt> option to the name of the Business Attribute that you previously configured.</li>
 +
<li>Configure the following Interaction options in the <tt>interaction-workspace</tt> section of the <tt>Cloud_Cluster</tt> object:
 +
<ul>
 +
<li>{{Optionslink|link=Options:Genesys_Web_Services:interaction-workspace:interaction-disposition-cache-timeout-delay}}: Specifies the delay, in seconds, before the cache of a disposition request result is cleared. If set to -1, the dispositions are kept in cache until the browser page is refreshed, or until the agent logs out and logs back in.</li>
 +
<li>{{Optionslink|link=Options:Genesys_Web_Services:interaction-workspace:interaction-disposition-is-expanded-on-display}}: Specifies whether the Dispositions tree is expanded by default.</li>
 +
<li>{{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.</li>
 +
<li>{{Optionslink|link=Options:Genesys_Web_Services:interaction-workspace:interaction-disposition-key-name}}: 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.</li>
 +
<li>{{Optionslink|link=Options:Genesys_Web_Services:interaction-workspace:interaction-disposition-use-attached-data}}: Specifies whether attached data can be added to the interaction in UserEvent.</li>
 +
<li>{{Optionslink|link=Options:Genesys_Web_Services:interaction-workspace:interaction-disposition-value-business-attribute}}: Specifies 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.</li>
 +
</ul>
 +
</li>
 +
</ol>
 +
===Hierarchical Dispositions===
 +
Workspace Agent Desktop supports the display of disposition codes in a hierarchy tree, with expanding and collapsing controls. The dispositions hierarchy is enabled by [[SettingUpAgents#Enablingdispositioncodes|setting up the annex for the disposition Business Attribute]].
 +
 
 +
The hierarchy is configured by adding folders under the Disposition Code Business Attribute in Configuration Server using the following option: {{Optionslink|link=Options:Genesys_Web_Services:interaction-workspace:interaction-disposition-folder-name-depth-zn-}}: Specifies the Attached Data key that stores the n-th level of the disposition folder hierarchy.<!--Specifies the key that is used to populate attached data or a user event based on the folder name of a disposition path when a disposition code is submitted to the back-end system, such as T-Server, Interaction Server, and Contact Server.-->
 +
 
 +
{{AnchorDiv|EditCaseInfo}}
 +
 
 +
==Enabling case information editing ==
 +
 
 +
You can enable an agent to edit the contents of [[CustomerCase|case information]].
 +
 
 +
Before you begin, ensure that the following prerequisites are met:
 +
 
 +
*A working knowledge of Genesys Administrator Extension (GAX).
 +
*A <tt>Cloud_Cluster</tt> object exists in the Configuration Database.
 +
*One or more custom Case Information Business Attributes in the Configuration Layer.
 +
 
 +
To enable case information editing:
 +
 
 +
#In GAX, open a Case Information Business Attribute.
 +
#In the Attributes Values tab, open the attribute value that you want to enable Agent to edit.
 +
#Select the Options tab.
 +
#Add a new section named <tt>interaction-workspace</tt>.
 +
#Configure the option according to the values in the [[CustomerCase#Editing_Case_Information|Editing Case Information]] table.
 +
#Save your updates.
 +
{{AnchorDiv|FocusDuration}}
 +
==Focus duration==
 +
Workspace is an ''omni-channel application'' which means that agents might be handling multiple interactions on different channels for the same contact, or for multiple contacts. For example, an agent might be talking on the phone with a contact, sending the contact text information by the Chat channel, while composing an email to the contact; or, an agent might be handling multiple chats for multiple contacts while handling email interactions or workitems. In both of these example scenarios, the agent spends a little bit of time focused on each individual interaction; however, from a reporting perspective, the duration of handling is the total time from when each interaction was initiated until it was marked Done. This gives a false representation of the amount of time that an agent was actually handling each individual interaction.
 +
 
 +
When the value of the {{Optionslink|link=Options:Genesys_Web_Services:interaction-workspace:reporting-case-report-case-in-focus-duration}} option is set to <tt>true</tt>, which specifies whether the time that an interaction has been in the focus of the agent during its handling is reported to T-Server or Interaction Server at the end of its processing by the agent. When it is enabled, this notification allows Genesys Interaction Concentrator and Genesys Infomart to calculate focus time metrics. Workspace reports to the Genesys back-end the time, in seconds, that an individual interaction had the focus, that is, the time that the agent actually spent working directly or indirectly on this interaction. The duration of each interaction is reported as the sum of the times that the interaction had the focus of the agent. The assignment of focus-time to an interaction is based on the following rules:
 +
# At any given time, only one Case can be considered as ''in focus''.
 +
#:Therefore, the sum of the focus-times of the agent cannot exceed the total focus-time.
 +
# When a Case is considered to be ''in focus'', the time in focus is assigned to the Main interaction of the case; that is, the interaction that initiated the case (for example an inbound chat or an outbound call).
 +
# The Case that contains the current Active Voice Call (<tt>Established</tt>) is considered as ''in focus'', whether the voice call in the Case is the main interaction, a secondary interaction, or a consultation.
 +
#: There cannot be more that one Active Voice Call at a given time.
 +
# When there is no Active Voice Call, the Case that has the visual focus, corresponding to the selected view, is considered as ''in focus''. This can be a Case that contains a non-Active Voice Call (for example, <tt>Dialing</tt>, <tt>On Hold</tt>, or <tt>Released</tt>).
 +
# If Workspace loses the application focus, the Case that had visual focus at the time Workspace lost the focus continues to be considered as ''in focus''.
 +
 
 +
==Enabling Accessibility features==
 +
 
 +
Use the following options in the <tt>interaction-workspace</tt> section to configure Accessibility features:
 +
 
 +
* {{Optionslink|link=Options:Genesys_Web_Services:interaction-workspace:accessibility-agent-state-change-bell}}: Specifies the agent state change sound-configuration string. For example: 'BELL|7|0'. The value has three components that are separated by the pipe ('|') character. The first is the sound file name (the BELL, RING, CHORD or WARNING predefined aliases or an absolute URL to a MP3 file). The second is a priority &mdash; the higher the integer, the higher the priority. The last is the duration, which can have the following values:
 +
**<tt>-1</tt> &mdash; play and repeat the sound until an explicit message, such as event established, causes it to stop.
 +
**<tt>0</tt> &mdash; play the whole sound once
 +
**an integer greater than <tt>0</tt> &mdash; the length of time, in milliseconds, to play and repeat the sound
 +
* {{Optionslink|link=Options:Genesys_Web_Services:interaction-workspace:accessibility-dialog-bell}}: Specifies the dialog sound-configuration string. For example: 'BELL|7|0'. The value has three components that are separated by the character '|'. The first is the sound file name (BELL, RING, CHORD or WARNING predefined aliases or an absolute URL to a MP3 file). The second is a priority &mdash; the higher the integer, the higher the priority. The last is the duration, which can have the following values:
 +
**<tt>0</tt> &mdash; play the whole sound once
 +
**an integer greater than <tt>0</tt> &mdash; the length of time, in milliseconds, to play and repeat the sound
 +
* {{Optionslink|link=Options:Genesys_Web_Services:interaction-workspace:accessibility-dialog-error-bell}}: Specifies the error alert sound-configuration string. For example: 'BELL|7|0'. The value has three components that are separated by the character '|'. The first is the sound file name (BELL, RING, CHORD or WARNING predefined aliases or an absolute URL to a MP3 file). The second is a priority &mdash; the higher the integer, the higher the priority. The last is the duration, which can have the following values:
 +
**<tt>0</tt> &mdash; play the whole sound once
 +
**an integer greater than <tt>0</tt> &mdash; the length of time, in milliseconds, to play and repeat the sound
 +
* {{Optionslink|link=Options:Genesys_Web_Services:interaction-workspace:accessibility-focus-on-interaction-toast}}: Specifies whether the '''Interaction Notification''' views  receive the focus when they are displayed. This option does not rely on the '''accessibility.visual-impairment-profile''' option; therefore, it applies to all configured agents, not just visually impaired agents.
 +
* {{Optionslink|link=Options:Genesys_Web_Services:interaction-workspace:accessibility-interaction-state-change-bell}}: Specifies the interaction state change sound-configuration string. For example: 'BELL|7|0'. The value has three components that are separated by the pipe ('|') character. The first is the sound file name (the BELL, RING, CHORD or WARNING predefined aliases or an absolute URL to a MP3 file). The second is a priority &mdash; the higher the integer, the higher the priority. The last is the duration, which can have the following values:
 +
**<tt>-1</tt> &mdash; play and repeat the sound until an explicit message, such as event established, causes it to stop.
 +
**<tt>0</tt> &mdash; play the whole sound once
 +
**an integer greater than <tt>0</tt> &mdash; the length of time, in milliseconds, to play and repeat the sound
 +
{{AnchorDiv|accessibility.media-type.focus-on-interaction-toast}}
 +
* {{Optionslink|link=Options:Genesys_Web_Services:interaction-workspace:accessibility-zmedia-type-zfocus-on-interaction-toast}}: Specifies whether the '''Interaction Notification''' views associated with the specified media type receive the focus when they are displayed. This option does not rely on the accessibility.visual-impairment-profile option; therefore, it applies to all configured agents, not just visually impaired agents.
 +
* {{Optionslink|link=Options:Genesys_Web_Services:interaction-workspace:accessibility-outbound-campaign-state-change-bell}}: Specifies the outbound campaign state change sound-configuration string. For example: 'BELL|7|0'. The value has three components that are separated by the pipe ('|') character. The first is the sound file name (the BELL, RING, CHORD or WARNING predefined aliases or an absolute URL to an MP3 file). The second is a priority &mdash; the higher the integer, the higher the priority. The last is the duration, which can have the following values:
 +
**<tt>0</tt> &mdash; play the whole sound once
 +
**an integer greater than <tt>0</tt> &mdash; the length of time, in milliseconds, to play and repeat the sound
 +
* {{Optionslink|link=Options:Genesys_Web_Services:interaction-workspace:accessibility-visual-impairment-profile}}: Specifies whether the profile for visually impaired users is active. This option enables users to navigate interface elements from keyboard navigation and tooltips by using a Screen Reader application. Some components might change their behavior in this mode. For example, Team Communicator is collapsed in this configuration.
 +
* {{Optionslink|link=Options:Genesys_Web_Services:interaction-workspace:accessibility-voicemail-message-change-bell}}: Specifies the Voice Mail counter change sound-configuration string for new or old messages. For example: <tt>'BELL|7|0'</tt>. The value has three components that are separated by the pipe character '|'.
 +
**Sound file name (BELL, RING, CHORD or WARNING, predefined aliases, or an absolute URL to a mp3 file).
 +
**Priority level. The higher the integer, the higher the priority.
 +
**Duration. 0 means to play the whole sound one time. An integer greater than 0 means a time in milliseconds to play and repeat the sound.
 +
* {{Optionslink|link=Options:Genesys_Web_Services:interaction-workspace:accessibility-voicemail-new-message-change-bell}}: Specifies the Voice Mail counter change sound-configuration string for new messages. For example: <tt>'BELL|7|0'</tt>. The value has three components that are separated by the pipe character '|'.
 +
**Sound file name (BELL, RING, CHORD or WARNING, predefined aliases, or an absolute URL to a mp3 file).
 +
**Priority level. The higher the integer, the higher the priority.
 +
**Duration. 0 means to play the whole sound one time. An integer greater than 0 means a time in milliseconds to play and repeat the sound.
 +
* {{Optionslink|link=Options:Genesys_Web_Services:interaction-workspace:accessibility-warning-message-bell}}: Specifies the warning message sound-configuration string. For example: 'BELL|7|0'. The value has three components that are separated by the pipe ('|') character. The first is the sound file name (the BELL, RING, CHORD or WARNING predefined aliases or an absolute URL to a MP3 file). The second is a priority &mdash; the higher the integer, the higher the priority. The last is the duration, which can have the following values:
 +
**<tt>-1</tt> &mdash; play and repeat the sound until an explicit message, such as event established, causes it to stop.
 +
**<tt>0</tt> &mdash; play the whole sound once
 +
**an integer greater than <tt>0</tt> &mdash; the length of time, in milliseconds, to play and repeat the sound
 +
{{AnchorDiv|KeyboardShortcuts}}
 +
 
 +
==Enabling keyboard shortcuts==
 +
Workspace enables you to navigate the user interface by using the keyboard and keyboard shortcuts instead of the mouse to enhance your productivity. Navigation works panel to panel, and within a panel, component to component. Keyboard navigability enables users who are using a device for accessibility that relies on keyboard navigation to manipulate the desktop components.
 +
 
 +
* {{Optionslink|link=Options:Genesys_Web_Services:interaction-workspace:keyboard-shortcut-interaction-next}}: The combination of keys that a user can use as a keyboard shortcut to jump to the next case interaction.
 +
{{AnchorDiv|shortcutPrevious}}
 +
* {{Optionslink|link=Options:Genesys_Web_Services:interaction-workspace:keyboard-shortcut-interaction-previous}}: The combination of keys that a user can use as a keyboard shortcut to jump to the previous case interaction.
 +
{{AnchorDiv|shortcutLastError}}
 +
* {{Optionslink|link=Options:Genesys_Web_Services:interaction-workspace:keyboard-shortcut-jump-to-last-error}}: The combination of keys that a user can use as a keyboard shortcut to jump the focus to the last error.
 +
 
 +
[[Category:V:HTCC:9.0.0]]

Revision as of 15:03, April 15, 2019

Setting Up Agents On The System

After you have created Agent objects you can set up your agents and supervisors to use different functionality. The following procedures assume that you know how to use the Genesys Administrator Extension application to configure agent objects.

Workspace Agent Desktop functionality is configured on the Cloud_Cluster object in the interaction-workspace section. You must create this section and then create the individual configuration options that you need.

Tip
For agents who also handle multimedia (chat, email, and so on) interactions or for multimedia-only (non-voice) agents, refer to Handling Interactions and the individual channels in the sub-topics.

Provisioning Workspace Agent Desktop for the Voice channel

Purpose: To enable an agent to log in to the Voice channel.

Prerequisites

  • A working knowledge of Genesys Administrator Extension (GAX).
  • A Cloud_Cluster object exists in the Configuration Database.
  • T-Server with the associated switch and switching office.
  • Agents with logins configured with DNs that correspond to agent devices in the switch.
  • A Place that contains one or more DNs from the switch.

Start

For each agent that you want to configure to use the Voice channel, do the following:

  1. Select at least one AgentLogin from the switch.
  2. Reference a default place.
  3. In GAX, set the value of the Agent property to True.
  4. Verify that the Voice media in Web Services is enabled.
  5. Configure the Voice options in the interaction-workspace section of the Cloud_Cluster object.

End

Granting Voice Privileges

To enable agents to use the voice channel, grant the following privilege: privilege.voice.can-use

Workspace Agent Desktop uses the following privileges to enable voice-related functionality:

Controlling the behavior of voice interactions

You can use the following options in the [interaction-workspace] section to configure voice interactions:

Setting up your SIP Endpoint

If you are using Genesys Softphone for your SIP Endpoint, see Genesys Softphone integration for information about setting it up and using it.

To enable your agents to use another SIP Endpoint, you can grant the following privileges:

Use the following options to manage SIP Endpoints, such as the Genesys Softphone:


Setting up the user interface behavior

Use the following option to control the behavior of system messages:

  • alert.timeout: Specifies the duration, in seconds, that contextual warning messages are displayed in the windows of the application.

Use the following options to control the behavior and appearance of the Workspace Agent Desktop application:

  • main-window.window-title: Specifies the title of the browser window or tab.
  • interaction-bar.quick-access-modes: Specifies the list of modes that are available to present interactions. The available modes are:
    • Pinned: the interaction view occupies the full available size, shared with Supporting Views like Contact and Responses.
    • Floating: the interaction view is presented in a floating window that is painted above any other kind of content and that fits the visual material to display. This view cannot display content displayed on the right part, such as Contact Profile or Responses.
    When more than one mode is specified, by default the first mode in the configured list is used. The end user can switch from one mode to the other using a dedicated control. For a given media type, this option can be overridden by option interaction-bar.quick-access-modes.<media-type>.
  • interaction-bar.quick-access-modes.<media-type>: Use this option as a template to specify the list of modes available to present interactions of the given media type. The available modes are:
    • Pinned: the interaction view occupies the full available size, shared with Supporting Views like Contact and Responses.
    • Floating: the interaction view is presented in a floating window that is painted above any other kind of content and that fits the visual material to display. This view cannot display content displayed on the right part, such as Contact Profile or Responses.
    When more than one mode is specified, by default the first mode in the configured list is used. The end user can switch from one mode to the other using a dedicated control. When it is defined for a media type this option overwrites the definition of generic option interaction-bar.quick-access-modes.

Granting basic Contact and Interaction History privileges

When interactions are received, you can control how agent can view and interact with an interaction:

Setting up the system behavior

Use the following options to control the display of the System Feedback menu and dialog:

Use the following option to control session behavior when the system connection drops:

  • system.cometd.timeout: Specifies the duration, in milliseconds, before the session is considered closed when the connection with the server is lost.

Use the following option to control session logging:

Enabling Workspace to use ring tones

Purpose: To enable Workspace Agent Desktop to use ring tones for incoming interactions and state changes. You can set different tones for different types of interactions using either absolute URLs that point to custom sounds or the set of aliases Workspace provides for standard sounds:

  • BELL
  • RING
  • CHORD
  • WARNING

Prerequisites

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

Start

  1. In the Configuration Layer, you can set any of the following options to enable ring tones on incoming interactions and state changes:

End

Declaring and using new Not-Ready Reason codes

Purpose: To enable an agent to use custom Not-Ready Reason codes.

Custom Not-Ready Reason codes must be defined by creating an Action Code in the Action Codes folder of the Desktop folder in the Provisioning view of Genesys Administrator Extension.

Prerequisites

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

Start

  1. In the Configuration Layer, create an Action Code of type Not Ready by using the Action Codes - NotReady procedure. Each Not Ready Reason Action Code object that you create must have a unique name and a Not Ready Reason code. You can create Action Codes only for the Tenant object.
  2. Enable this feature by specifying the NotReadyReason as the value for the agent-status.enabled-actions-by-channel and agent-status.enabled-actions-global options.

End

Declaring and using new After Call Work Reason codes

Purpose: To enable an agent to use custom After Call Work Reason codes.

The only After Call Work state that Workspace Agent Desktop supports by default is After Call Work. Custom After Call Work codes must be defined by creating an Action Code in the Action Codes folder of the Desktop folder in the Provisioning view of Genesys Administrator Extension.

Prerequisites

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

Start

  1. In the Configuration Layer, create an Action Code of type Not Ready by using the Action Codes - NotReady procedure. Each Not Ready Reason Action Code object that you create must have a unique name and a Not Ready Reason code. You can create Action Codes only for the Tenant object.
  2. To define this Action Code as an After Call Work Reason code, perform the following steps:
    1. In the annex of the Action Code, create a section named: htcc
    2. In this section add the workmode option and specify the value AfterCallWork.
  3. Enable this feature by specifying the value AfterCallWork for the agent-status.enabled-actions-by-channel and/or agent-status.enabled-actions-global options.

End


Enabling integration of web applications in the agent interface

Purpose: To enable an agent to view or use a third-party web application or website in Workspace Agent Desktop as either a tab, a popup window, in the background at the interaction level, or hidden.

To avoid any conflict and security constraints between Workspace and the external website or web application, the external web site or web application is displayed in a dedicated iframe.

Prerequisites

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

Start

  1. You must create a new option section for each third-party web application that you want to use in Workspace. These sections must be created in the Cloud_Cluster object options, Tenant, Agent Group, or Agent annex. For example, create sections called SearchEngine, MyCompanyWebApp and SearchLocation.
  2. In each section, you must create the following options:
    • label:Specifies the label to be used for the name of the tab in the workspace or the button in multimedia interaction.
    • url: Specifies the URL of the web application. This URL can contain field codes.
      Important
      • If this attribute is left blank, Workspace does not display the web application.
      • If you configured Web Services to use HTTPS (for example, the URL for Workspace is in the following format: https://<host>:<securePort>/ui/wwe/index.html), then the URL for the external web application must also be in HTTPS.

      The following field codes are supported for both the label and url options:

      • Agent.FullName
      • Agent.UserName
      • Agent.LastName
      • Agent.FirstName
      • Agent.EmployeeId
      • AttachedData.Y (Note: This field code is only applicable for custom views; refer to the interaction.web-content option.)
      • Interaction.Id (Note: This is a client-side ID that is lost on the next session or refresh. This field code is applicable for custom views; refer to the interaction.web-content option.)

      An external web site URL can be defined using the $AttachedData.Y$ parameter to have flexible text in the URL where Y represents an attached data name.

      Warning
      • If the $AttachedData.Y$ parameter is specified for the external website URL, and Y is not part of the attached data associated with an interaction, the external website is not displayed.
      • If an agent manually adds the attached data to the interaction (or if it's added by any other means), then the external website tab is displayed with the content of the external website.

      Refer to the description of attached-data-update-handle-mode below for more information.


      For example, the external website specified as follows:

      label = Customer Location
      url = http://www.bing.com/search?q=$AttachedData.CustomerLocation$

      With this URL, if an interaction is received with a CustomerLocation attached data with the value of Paris, then the external website will be displayed in a dedicated tab called Customer Location, and the external web site will be http://www.bing.com/search?q=Paris

    • mode: Specifies the mode Workspace uses to display the web application. The default value is INTERNAL. The possible values are:
      • INTERNAL: The web application is displayed in a dedicated tab in Workspace. It can be viewed and used when the agent clicks the tab to display it. This is the default behavior.
      • EXTERNAL: The web application is displayed in a popup window.
      • BACKGROUND: The web application is displayed in the background (Workspace area) when the interaction is selected. When the interaction is deselected or closed, the third-party website is replaced with the previous panel that was displayed in the background. This mode is only applicable at the interaction level.
      • HIDDEN:The web application is loaded but not displayed in Workspace. You can use this mode to integrate Workspace with a non-web application.
    • attached-data-update-handle-mode: Specifies how to handle attached data changes when an external website is configured with attached data. The possible values are:
      • 0 (default value): Specifies that when the attached data is updated or deleted, the external website is not updated.
      • 1: Specifies the following actions to occur:
        • When the attached data is updated, the external website is updated with the new URL.
        • When the attached data is deleted, the external website is not updated.
      • 2: Specifies the following actions to occur:
        • When the attached data is updated, the external website is updated with the new URL.
        • When the attached data is deleted, the external website disappears.
  3. Configure one or both of the following options in the interaction-workspace section, depending on whether the application is to be displayed in the interaction view or the workspace view:
    • interaction.web-content: Defines the list of option section names that represent Web Applications which are configured to be displayed at the interaction level. For example: SearchLocation
    • workspace.web-content: Defines the list of option section names that represent Web Applications which are configured to be displayed at the Workspace level. For example: SearchEngine, MyCompanyWebApp.
    Tip
    Refer to Configuring the User Interface for more information.

End

For example, in the tenant object, configure the following sections and options:

[SearchEngine]
label=Bing
url=http://www.bing.com

[MyCompanyWebApp]
label=Genesys
url=http://www.genesys.com

[SearchLocation]
attached-data-update-handle-mode=1
label=Search Location
url=http://myhost/service-client-api/GoogleMaps.html?InteractionId=$Interaction.Id$&att=$AttachedData.GSW_CAMPAIGN_NAME$
mode=BACKGROUND

[interaction-workspace]
interaction.web-content=SearchLocation
workspace.web-content=MyCompanyWebApp,SearchEngine

Enabling Security

Purpose: To configure Workspace to log out an agent from the application if the agent has not used the keyboard or mouse for a period that you specify. When this happens, Workspace saves the agent's work, ends the session, logs out the agent on all media channels, and goes back to the login page.

Prerequisites

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

Start

  1. In GAX, open the Cloud_Cluster application.
  2. Select the Options tab.
  3. You must configure the following options in the [interaction-workspace] section:
    • security.inactivity-timeout: Specifies the period of inactivity that triggers Workspace to log out the agent.
      Warning
      After the timeout occurs, the Workspace login dialog should be blank; however, if the agent has allowed the browser to remember his or her password, then the login dialog will still be populated with the agent's credentials. For security, agents should not allow web browsers to remember their login credentials.
    • security.inactivity-alert-dialog-before-timeout: Specifies when to display an alert to the agent about an upcoming inactivity timeout.

End

Agent Login And Authentication

When an agent launches Workspace Agent Desktop, the agent must provide a user name and password to be authenticated. After authentication, the Configuration Layer is accessed by Workspace Agent Desktop to obtain the list of functions that are granted to the agent as well as the configuration of the Workspace application for that agent.

The first time that an agent logs in they must follow a two-step process. After providing the user name and password and clicking Log In, the Change Password dialog box is displayed and the agent must provide a new password.

Refer to the Genesys Security Deployment Guide for a complete description of password policies and how to configure the Reset Password functionality for agents.

Use the following application options in the interaction-workspace section to control agent login:

DN-less Login

If you want agents to be able to login to the system and take calls on a number that is different than the DN configured for their user account, you can set up a DN-less login to allow agents, agent groups, or all users to specify a new phone number during login. This feature is specific to SIP Server environments. Use the following configuration option to enable this feature:


Managing Agent Status

Workspace Agent Desktop provides options that enable agents to control their status. Use these options to populate the Workspace status menu with one or more of the following selections:

  • Global Ready
  • Global Not Ready (with reason code)
  • Global DND (Do Not Disturb)
  • Global After Call Work
  • Global Log Off
  • Global Login

The options enable the following agent states:

  • Logged off
  • DND (Do Not Disturb)
  • After Call Work
  • Not Ready - Full (Multiple Reasons)
  • Not Ready - Full (Single Reason)
  • Ready - Partial (for example, ready on one channel)
  • Ready - Full

Workspace Agent Desktop also enables detailed agent and place status management through options. Agents can set individual channels to the following states:

  • Ready
  • Not Ready
  • Do Not Disturb
  • After Call Work
  • Logged off
  • Call Forwarded (for voice)

You can use the following options in the interaction-workspace section to control the contents of the command menu in the Workspace Main Window.

  • agent-status.enabled-actions-by-channel: Specifies the available agent state actions in the My Channels contextual menu. The actions are displayed in the order in which they appear in the list.
  • agent-status.enabled-actions-global: Specifies the available agent states in the global Status menu. The agent state commands are displayed in the order in which they appear in the list.
  • privilege.mychannels.pending-state.can-use: Permits the pending state to be displayed in the My Channels view while the agent engaged in a call, chat, or email interaction. When the value of this option is set to true, if an agent sets his or her status to Not Ready, Not Ready Reason, or any other state while he or she is still handling an interaction, the timer for that state will not start until the call is released, the chat is marked as Done, or the email is sent or put into a workbin.
  • agent-status.after-call-work-reasons: Specifies the available reasons in the Agent Status menus (global and My Channels). Workspace displays the reason commands in the order in which they appear in the list.
  • agent-status.not-ready-reasons: Specifies the available reasons in the global Status menu. The reason commands are displayed in the order in which they appear in the list.
  • agent-status.ready-workmode: Specifies which workmode is applied when the agent manually specifies the Ready state for the voice DN from the Global State menu or from My Channels. This option applies only to specific T-Servers that support workmode. This option also applies to the value specified for the login.voice.is-auto-ready option. To determine whether your switch supports the workmode, refer to the Deployment Guide of the relevant T-Server.

For the Voice channel, you can configure Workspace Agent Desktop to automatically set the agent status to the former status when Done is clicked. This enables an agent to return to their former status as soon as he or she has completed after call work, instead of having to manually change status.

Important
If an agent manually changes state while still engaged in a voice interaction, their state will display the change, but the time in state will be suspended until the call is ended. This behavior is dependent on the privilege.mychannels.pending-state.can-use privilege being granted.

Enabling and Disabling Agents

Purpose: To enable or disable an agent to be available for use by Web Services. Disabled Agents will not be imported into Web Services.

Prerequisites

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

Start

  1. In the configuration layer, use GAX to select State Enabled to enable an agent for use. Deselect State Enabled to disable an agent.

End

Enabling caller ID selection

You can enable agents to select a caller ID from pre-defined list of caller IDs.

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

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

To enable caller ID selection:

  1. In GAX, create a Business Attribute that contains the possible caller ID values you want agents to be able to select. In its Business Attribute Values, the name is used to specify the actual phone number Workspace dials. If the Display Name is specified, this is the information Workspace presents to the agent (in alphabetical order).
  2. Important
    If the Business Attribute doesn't contain any Business Attribute Values, then the feature isn't enabled. Also, if the attribute contains only one value, then the adapter automatically uses that caller ID so the agent doesn't see a popup when making a call.
  3. Set the intercommunication.voice.make-call-caller-id-business-attribute option to the name of your Business Attribute. For example, if you create a Business Attribute named CallerID, then you would set intercommunication.voice.make-call-caller-id-business-attribute to CallerID.
  4. Set the intercommunication.voice.make-call-caller-id-enable-anonymous option to true to specify whether anonymous is enabled on make call with caller id.

Specifying the content of interaction notifications

You can specify the content and appearance of interaction preview notifications (toasts).

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

  • A working knowledge of Genesys Administrator Extension (GAX).
  • A Business Attribute object containing the dispositions exists in the Configuration Database.
  • A Cloud_Cluster application object exists in the Configuration Database.
  • The agent object is configured to use one or more of the following media channels:

You can use the following configuration options to control interaction notifications:

Enabling disposition codes

You can enable agents to specify the outcome (disposition) of an interaction. Disposition Codes are set up as Business Attributes in Configuration Server and set to State Enabled.

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

  • A working knowledge of Genesys Administrator Extension (GAX).
  • A Business Attribute object containing the dispositions exists in the Configuration Database.
  • A Cloud_Cluster application object exists in the Configuration Database.
  • The agent object is configured to use one or more of the following media channels:

To enable disposition codes:

  1. In GAX, create or update a Business Attribute in the tenant that contain(s) your agents.
    • The Type of the Business Attribute is Interaction Operation Attributes.
    • The Attribute values are the codes that are available for the agent:
      • name—Used in attached data.
      • display name—Used in the Agent interface.
  2. In the interaction-workspace section, set the value of the interaction.disposition.value-business-attribute option to the name of the Business Attribute that you previously configured.
  3. Configure the following Interaction options in the interaction-workspace section of the Cloud_Cluster object:

Hierarchical Dispositions

Workspace Agent Desktop supports the display of disposition codes in a hierarchy tree, with expanding and collapsing controls. The dispositions hierarchy is enabled by setting up the annex for the disposition Business Attribute.

The hierarchy is configured by adding folders under the Disposition Code Business Attribute in Configuration Server using the following option: interaction.disposition.folder-name-depth-<n>: Specifies the Attached Data key that stores the n-th level of the disposition folder hierarchy.

Enabling case information editing

You can enable an agent to edit the contents of case information.

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

  • A working knowledge of Genesys Administrator Extension (GAX).
  • A Cloud_Cluster object exists in the Configuration Database.
  • One or more custom Case Information Business Attributes in the Configuration Layer.

To enable case information editing:

  1. In GAX, open a Case Information Business Attribute.
  2. In the Attributes Values tab, open the attribute value that you want to enable Agent to edit.
  3. Select the Options tab.
  4. Add a new section named interaction-workspace.
  5. Configure the option according to the values in the Editing Case Information table.
  6. Save your updates.

Focus duration

Workspace is an omni-channel application which means that agents might be handling multiple interactions on different channels for the same contact, or for multiple contacts. For example, an agent might be talking on the phone with a contact, sending the contact text information by the Chat channel, while composing an email to the contact; or, an agent might be handling multiple chats for multiple contacts while handling email interactions or workitems. In both of these example scenarios, the agent spends a little bit of time focused on each individual interaction; however, from a reporting perspective, the duration of handling is the total time from when each interaction was initiated until it was marked Done. This gives a false representation of the amount of time that an agent was actually handling each individual interaction.

When the value of the reporting.case.report-case-in-focus-duration option is set to true, which specifies whether the time that an interaction has been in the focus of the agent during its handling is reported to T-Server or Interaction Server at the end of its processing by the agent. When it is enabled, this notification allows Genesys Interaction Concentrator and Genesys Infomart to calculate focus time metrics. Workspace reports to the Genesys back-end the time, in seconds, that an individual interaction had the focus, that is, the time that the agent actually spent working directly or indirectly on this interaction. The duration of each interaction is reported as the sum of the times that the interaction had the focus of the agent. The assignment of focus-time to an interaction is based on the following rules:

  1. At any given time, only one Case can be considered as in focus.
    Therefore, the sum of the focus-times of the agent cannot exceed the total focus-time.
  2. When a Case is considered to be in focus, the time in focus is assigned to the Main interaction of the case; that is, the interaction that initiated the case (for example an inbound chat or an outbound call).
  3. The Case that contains the current Active Voice Call (Established) is considered as in focus, whether the voice call in the Case is the main interaction, a secondary interaction, or a consultation.
    There cannot be more that one Active Voice Call at a given time.
  4. When there is no Active Voice Call, the Case that has the visual focus, corresponding to the selected view, is considered as in focus. This can be a Case that contains a non-Active Voice Call (for example, Dialing, On Hold, or Released).
  5. If Workspace loses the application focus, the Case that had visual focus at the time Workspace lost the focus continues to be considered as in focus.

Enabling Accessibility features

Use the following options in the interaction-workspace section to configure Accessibility features:

  • accessibility.agent-state-change-bell: Specifies the agent state change sound-configuration string. For example: 'BELL|7|0'. The value has three components that are separated by the pipe ('|') character. The first is the sound file name (the BELL, RING, CHORD or WARNING predefined aliases or an absolute URL to a MP3 file). The second is a priority — the higher the integer, the higher the priority. The last is 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
  • accessibility.dialog-bell: Specifies the dialog sound-configuration string. For example: 'BELL|7|0'. The value has three components that are separated by the character '|'. The first is the sound file name (BELL, RING, CHORD or WARNING predefined aliases or an absolute URL to a MP3 file). The second is a priority — the higher the integer, the higher the priority. The last is the duration, which can have the following values:
    • 0 — play the whole sound once
    • an integer greater than 0 — the length of time, in milliseconds, to play and repeat the sound
  • accessibility.dialog-error-bell: Specifies the error alert sound-configuration string. For example: 'BELL|7|0'. The value has three components that are separated by the character '|'. The first is the sound file name (BELL, RING, CHORD or WARNING predefined aliases or an absolute URL to a MP3 file). The second is a priority — the higher the integer, the higher the priority. The last is the duration, which can have the following values:
    • 0 — play the whole sound once
    • an integer greater than 0 — the length of time, in milliseconds, to play and repeat the sound
  • accessibility.focus-on-interaction-toast: Specifies whether the Interaction Notification views receive the focus when they are displayed. This option does not rely on the accessibility.visual-impairment-profile option; therefore, it applies to all configured agents, not just visually impaired agents.
  • accessibility.interaction-state-change-bell: Specifies the interaction state change sound-configuration string. For example: 'BELL|7|0'. The value has three components that are separated by the pipe ('|') character. The first is the sound file name (the BELL, RING, CHORD or WARNING predefined aliases or an absolute URL to a MP3 file). The second is a priority — the higher the integer, the higher the priority. The last is 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
  • accessibility.<media-type>.focus-on-interaction-toast: Specifies whether the Interaction Notification views associated with the specified media type receive the focus when they are displayed. This option does not rely on the accessibility.visual-impairment-profile option; therefore, it applies to all configured agents, not just visually impaired agents.
  • accessibility.outbound-campaign-state-change-bell: Specifies the outbound campaign state change sound-configuration string. For example: 'BELL|7|0'. The value has three components that are separated by the pipe ('|') character. The first is the sound file name (the BELL, RING, CHORD or WARNING predefined aliases or an absolute URL to an MP3 file). The second is a priority — the higher the integer, the higher the priority. The last is the duration, which can have the following values:
    • 0 — play the whole sound once
    • an integer greater than 0 — the length of time, in milliseconds, to play and repeat the sound
  • accessibility.visual-impairment-profile: Specifies whether the profile for visually impaired users is active. This option enables users to navigate interface elements from keyboard navigation and tooltips by using a Screen Reader application. Some components might change their behavior in this mode. For example, Team Communicator is collapsed in this configuration.
  • accessibility.voicemail-message-change-bell: Specifies the Voice Mail counter change sound-configuration string for new or old messages. For example: 'BELL|7|0'. The value has three components that are separated by the pipe character '|'.
    • Sound file name (BELL, RING, CHORD or WARNING, predefined aliases, or an absolute URL to a mp3 file).
    • Priority level. The higher the integer, the higher the priority.
    • Duration. 0 means to play the whole sound one time. An integer greater than 0 means a time in milliseconds to play and repeat the sound.
  • No results: Specifies the Voice Mail counter change sound-configuration string for new messages. For example: 'BELL|7|0'. The value has three components that are separated by the pipe character '|'.
    • Sound file name (BELL, RING, CHORD or WARNING, predefined aliases, or an absolute URL to a mp3 file).
    • Priority level. The higher the integer, the higher the priority.
    • Duration. 0 means to play the whole sound one time. An integer greater than 0 means a time in milliseconds to play and repeat the sound.
  • accessibility.warning-message-bell: Specifies the warning message sound-configuration string. For example: 'BELL|7|0'. The value has three components that are separated by the pipe ('|') character. The first is the sound file name (the BELL, RING, CHORD or WARNING predefined aliases or an absolute URL to a MP3 file). The second is a priority — the higher the integer, the higher the priority. The last is 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

Enabling keyboard shortcuts

Workspace enables you to navigate the user interface by using the keyboard and keyboard shortcuts instead of the mouse to enhance your productivity. Navigation works panel to panel, and within a panel, component to component. Keyboard navigability enables users who are using a device for accessibility that relies on keyboard navigation to manipulate the desktop components.

Comments or questions about this documentation? Contact us for support!