Jump to: navigation, search

login.<media-type>.is-auto-ready

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


Specifies whether the indicated workitem channel is automatically set to the Ready state at login.

login.<media-type>.can-unactivate-channel

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


Specifies whether the agent can select and unselect (auto-login or not auto-login) the specific Workitem channel.

login.<media-type>.auto-not-ready-reason

Section: interaction-workspace
Default Value: false
Valid Values: A valid not ready reason
Changes Take Effect: When the application is started or restarted.
Dependencies: login.<keyworkitemchannel>.is-auto-ready

Specifies the Not Ready Reason that is displayed after an agent logs in on a channel that is not automatically set to Ready. The Not Ready Reason corresponds to the name of a Not Ready Action Code. If the reason is empty, no Not Ready Reason is displayed for the channel at log in time if the channel is in the Not Ready state. This option is ignored if the option login.<keyworkitemchannel>.is-auto-ready is set to true.

login.workmode

Section: interaction-workspace
Default Value: unknown
Valid Values: unknown, auto-in, manual-in
Changes Take Effect: When the application is started or restarted or if the agent changes place.


Specifies the workmode that is applied when the voice DN logs in. If this option is set to auto-in, the agent is automatically in Ready state. If this option is set to manual-in, the agent must manually activate the Ready state. To determine whether your switch supports the workmode, refer to the Deployment Guide of the relevant T-Server.

login.webcallback.is-auto-ready

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


Specifies whether the Web Callback channel is automatically set to the Ready state at login.

login.webcallback.can-unactivate-channel

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


Specifies whether the agent can select and unselect (auto-login or not auto-login) the web callback channel.

login.webcallback.auto-not-ready-reason

Section: interaction-workspace
Default Value:
Valid Values: A valid not ready reason
Changes Take Effect: When the application is started or restarted
Dependencies: login.webcallback.is-auto-ready

Specifies the Not Ready Reason that is displayed after an agent logs in on a channel that is not automatically set to Ready. The Not Ready Reason corresponds to the name of a Not Ready Action Code. If the reason is empty, no Not Ready Reason is displayed for the channel at log in time if the channel is in the Not Ready state. This option is ignored if the option login.webcallback.is-auto-ready is set to true.

login.voice.use-dn-less-login-extension

Section: interaction-workspace
Default Value: false
Valid Values: true, false
Changes Take Effect: At next voice channel login.
Introduced: 8.5.141.04
Related Options: login.voice.prompt-dn-less-phone-number

Specifies how the DN-less phone number provided by an agent during login is propagated to the Genesys back-end:

  • false: The phone number is stored in the agent's DN annex in Configuration Server.
  • true: The phone number is passed as an extension through the agent's login request to SIP Server (SIP Server 8.1.102.93 or higher is required).

login.voice.prompt-queue

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


Specifies whether the agent must enter the ACD Queue for the voice channel in the login window.

login.voice.prompt-dn-password

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


Specifies whether the agent must enter his password for the voice channel in the login window.

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

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


Specifies whether a DN-less phone number is prompted for in the login window. This option can be defined in a PlaceGroup Object. This option is specific to SIP Server environments.

login.voice.prompt-agent-login-id

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


Specifies whether the agent can select a login id from the configured ones for the voice channel in the login window.

login.voice.is-auto-ready

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


Specifies whether the voice channels are in the Ready state at login.

login.voice.force-relogin

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


Specifies whether the voice channels should be re-logged on automatically if logged off from outside the application. This option is applicable to SIP Server Business Continuity deployments only.

Notes:

  • This option was previously incorrectly documented as login.force-relogin
  • Genesys recommends that you do not use this feature if you are using the enhanced support of graceful shutdown in Business Continuity environments, beginning with release 8.5.108.11.

login.voice.can-unactivate-channel

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


Specifies whether the agent can select and unselect (auto-login or not auto-login) the voice channels.

login.voice.available-queues

Section: interaction-workspace
Default Value: ACDQueue
Valid Values: "", or a combination of ACDQueue,RoutingPoint,VirtualQueue
Changes Take Effect: When the application is started or restarted.


Specifies the way the list of available queues is displayed to the agent. If the option value is left blank, no queue is displayed to the agent; the agent can enter any valid login queue name. If this option is set to a combination of the valid values, the agent must select the queue from the list of objects that is provided by the configuration.

login.voice.auto-not-ready-reason

Section: interaction-workspace
Default Value:
Valid Values: A valid Not-Ready Reason Action Code name of type "Not Ready"
Changes Take Effect: When the application is started or restarted
Dependencies: login.voice.is-auto-ready, login.voice.auto-not-ready-reason
Related Options: login.im.auto-not-ready-reason

Specifies the Not Ready Reason that is displayed after an agent logs in on a channel that is not automatically set to Ready. The Not Ready Reason corresponds to the name of a Not Ready Action Code. If the reason is empty, no Not Ready Reason is displayed for the channel at log in time if the channel is in the Not Ready state. This option is ignored if the option login.voice.is-auto-ready is set to true. For a channel with the capacity "voice/im", if the login.voice.auto-not-ready-reason option is empty , the channel uses the value of the login.im.auto-not-ready-reason option to determine the Not Ready Reason.

login.store-username

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

Specifies whether the most recently used Username is stored locally in the user profile. If the value is false, the previous value is cleared.

login.store-recent-place

Section: interaction-workspace
Default Value: true
Valid Values: true, false
Changes Take Effect: When the application is started or restarted.
Dependencies: login.default-place

Specifies whether the most recently used Place or PlaceGroup is stored. This option is available if the login.default-place option is not set to $Agent.DefaultPlace$.

login.sms.is-auto-ready

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


Specifies whether the SMS channel is automatically in the ready state at agent login.

login.sms.can-unactivate-channel

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


Specifies whether the agent can select and unselect (activate and deactivate) the SMS channel.

login.sms.auto-not-ready-reason

Section: interaction-workspace
Default Value:
Valid Values: A valid Not-Ready Reason Action Code name of type "Not Ready"
Changes Take Effect: When the application is started or restarted
Dependencies: login.sms.is-auto-ready

Specifies the Not Ready Reason that is displayed after an agent logs in on a channel that is not automatically set to Ready. The Not Ready Reason corresponds to the name of a Not Ready Action Code. If the reason is empty, no Not Ready Reason is displayed for the channel at log in time if the channel is in the Not Ready state. This option is ignored if the option login.sms.is-auto-ready is set to true.

login.prompt-place

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


Specifies whether the agent must enter a Place or a PlaceGroup name in the login window.

login.place-state-timeout

Section: interaction-workspace
Default Value: 30
Valid Values: Any positive integer.
Changes Take Effect: When the application is started or restarted.


Specifies how long Workspace should wait for information about the state of a Place when checking Place availability at login time.

login.place-selection-type

Section: interaction-workspace
Default Value: Place
Valid Values: Comma separated list of types from the following list: Place, PlaceGroup.
Changes Take Effect: When the application is started or restarted.
Introduced: 8.5.114.08

Specifies the types of object that can be used to fill place selection. About PlaceGroup, see reference login.available-place-groups.

login.place-location-source

Section: interaction-workspace
Default Value: standard
Valid Values: A value from the following list: standard,machine-name,vdi
Changes Take Effect: When the application is started or restarted.
Dependencies: login.store-recent-place
Introduced: 8.5.112.08

Specifies how Workspace stores the last selected login Place or PlaceGroup in the Windows User Profile when the value of the login.store-recent-place option is set to true. The following values (modes) are supported:

  • standard — The most recently used Place or PlaceGroup is stored in the Windows User Profile without any information about the workstation. This is the legacy recent place storage model.
  • machine-name — The most recently used Place or PlaceGroup is stored in the Windows User Profile, along with the name of the machine where the Workspace application is running. Use this value when Workspace is installed on the physical workstation where the agent logs in.
  • vdi — The most recently used Place or PlaceGroup is stored in the Windows User Profile, along with the name of the physical machine from which the agent executes a virtual session (for example, in Citrix XenApp/XenDesktop, VMWare Horizon, and Windows Terminal Server environments). Use this value when Workspace is installed in a Virtual Desktop Environment. If the machine name of the VDI client is not found, for example because user is running Workspace on a physical workstation, the machine-name mode is used instead. Use this value in hybrid environments where agents use Workspace both on physical workstations and in virtual sessions.

login.im.prompt-queue

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


Specifies whether the agent must enter the ACD Queue for the IM channel in the login window.

login.im.prompt-dn-password

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


Specifies whether the agent must enter his password for the IM channel in the login window.

login.im.prompt-agent-login-id

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


Specifies whether the agent can select a login id from the configured ones for the IM channel in the login window.

login.im.is-auto-ready

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


Specifies whether the IM channel is automatically set to the Ready state at login.

login.im.can-unactivate-channel

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


Specifies whether the agent can select and unselect (auto-login or not auto-login) the Instant Messaging channel.

login.im.available-queues

Section: interaction-workspace
Default Value: ACDQueue
Valid Values: "" or a combination of: ACDQueue, RoutingPoint, VirtualQueue
Changes Take Effect: When the application is started or restarted.


Specifies the way the list of available queues is displayed to the agent. If the option value is left blank, no queue is displayed to the agent; the agent can enter any valid login queue name. If set to a combination of the valid values, the agent must select the queue from the list of objects that is provided by the configuration.

login.im.auto-not-ready-reason

Section: interaction-workspace
Default Value:
Valid Values: A valid Not-Ready Reason Action Code name of type "Not Ready"
Changes Take Effect: When the application is started or restarted
Dependencies: login.im.is-auto-ready
Related Options: login.voice.auto-not-ready-reason

Specifies the Not Ready Reason that is displayed after an agent logs in on a channel that is not automatically set to Ready. The Not Ready Reason corresponds to the name of a Not Ready Action Code. If the reason is empty, no Not Ready Reason is displayed for the channel at log in time if the channel is in the Not Ready state. This option is ignored if the option login.im.is-auto-ready is set to true. For a channel with the capacity "voice/im", if the login.voice.auto-not-ready-reason option is empty, the channel uses the value of the login.im.auto-not-ready-reason option to determine the Not Ready Reason.

login.enable-same-agent-place

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


Specifies whether the agent can login on the same Place from different workstations. The value prompt allows the agent to login on the same Place from different workstations, but the agent is first prompted for confirmation before an additional login is permitted.

Note: This option is applicable only when the agent is granted only Voice and/or Instant Messaging channels. It is not applicable for eServices medias.

login.enable-place-completion

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


This option is used for performance issue at login time (when a lot of agents logs in at the same time). Set this option to false to disable the load of all the places when the Workspace is started. This improves the performance if there are a lot of places in your environment. The restriction with this option set to false is that there is no longer a list of available places in the 2nd login panel.

login.enable-login-without-channel

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


Specifies whether agents can login to the Workspace application without being logged in to any channels.

login.email.is-auto-ready

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


Specifies whether the e-mail channel is automatically set to the Ready state at login.

login.email.can-unactivate-channel

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


Specifies whether the agent can select and unselect (auto-login or not) the e-mail channel.

login.email.auto-not-ready-reason

Section: interaction-workspace
Default Value:
Valid Values: A valid Not-Ready Reason Action Code name of type "Not Ready"
Changes Take Effect: When the application is started or restarted


Specifies the Not Ready Reason that is displayed after an agent logs in on a channel that is not automatically set to Ready. The Not Ready Reason corresponds to the name of a Not Ready Action Code. If the reason is empty, no Not Ready Reason is displayed for the channel at log in time if the channel is in the Not Ready state. This option is ignored if the option login.email.is-auto-ready is set to true.

login.default-place

Section: interaction-workspace
Default Value:
Valid Values: Valid place or place Group
Changes Take Effect: When the application is started or restarted.


Specify the Place or PlaceGroup name populated by default during login. This option can be filled by the variable $Agent.DefaultPlace$ (if the agent has a default place specified in the agent configuration, that Place is used; however, if no default Place exists, the agent must enter his or her Place in the Place field).

login.chat.is-auto-ready

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


Specifies whether the chat channel is automatically set to the Ready state at login.

login.chat.can-unactivate-channel

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


Specifies whether the agent can select and unselect (auto-login or not) the chat channel.

login.chat.auto-not-ready-reason

Section: interaction-workspace
Default Value:
Valid Values: A valid Not-Ready Reason Action Code name of type "Not Ready"
Changes Take Effect: When the application is started or restarted


Specifies the Not Ready Reason that is displayed after an agent logs in on a channel that is not automatically set to Ready. The Not Ready Reason corresponds to the name of a Not Ready Action Code. If the reason is empty, no Not Ready Reason is displayed for the channel at log in time if the channel is in the Not Ready state. This option is ignored if the option login.chat.is-auto-ready is set to true.

login.available-place-groups

Section: interaction-workspace
Default Value:
Valid Values: A comma-separated value list of valid Place Group object names or .
Changes Take Effect: When the application is started or restarted.
Introduced: 8.5.114.08

Specifies the list of Place Groups objects agent is allowed to used for login. If $All$ is configured, all the PlaceGroups objects that are contained in the Agent’s Tenant and on which the Agent has Read Access are available.

Login options

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

Related Resources

The following topic discusses the implementation of these options:

This page was last edited on July 21, 2020, at 18:24.
Comments or questions about this documentation? Contact us for support!