Jump to: navigation, search

Configuration Options

It is not mandatory to set the values of the following configuration options. All options have default values.

To override options based on Attached Data an Transaction object, see the Overriding Configuration Options topic. All options supporting this feature, have in the description: "This option can be overridden by a routing strategy as described in this Deployment Guide."

To use these configuration options, use Genesys Administrator (or in Configurations Manager) to add the interaction-workspace section to the WWEWS Cluster application object, then create the configuration options that you want to use in the interaction-workspace section.

Agent status

agent-status.enabled-actions-by-channel

  • Default Value: Ready,NotReady,NotReadyReason,AfterCallWork,Dnd,LogOff
  • Valid Values: Comma-separated list of action names from the following list: Ready, NotReady, NotReadyReason, AfterCallWork, Dnd, LogOn, LogOff.
  • Changes take effect: When the session is started or restarted.
  • Description: Defines 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

  • Default Value: Ready,NotReady,NotReadyReason,AfterCallWork,Dnd,LogOff
  • Valid Values: Ready, NotReady, NotReadyReason, AfterCallWork, Dnd, LogOff
  • Changes take effect: When the session is started or restarted.
  • Description: Defines 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.

Application

alert.timeout

  • Default Value: 10
  • Valid Values: An integer value greater than or equal to 0.
  • Changes take effect: When the session is started or restarted.
  • Description: Specifies the duration, in seconds, that contextual warning messages are displayed in the windows of the application.

application.wiki-help-site

  • Default Value: http://www.genesyslab.info/wiki/
  • Valid Values: A valid url.
  • Changes take effect: When the session is started or restarted.
  • Description: Path to the Workspace Web Edition Help. By default the help documentation is located on the Genesys Documentation website. You might have to create an exception for this URL in your firewall to enable agents to access the help. If you do not want to allow your agents to access the help stored on the Genesys Documentation website, you can request a PDF of the help document, which you can load locally.

system.cometd.timeout

  • Default Value: 60000
  • Valid Values: An integer value greater than or equal to 0.
  • Changes take effect: When the session is started or restarted.
  • Description: Specifies the duration, in milliseconds, before the session is considered closed when the connection with the server is lost.

system.notif.enabled-websocket

  • Default Value: false
  • Valid Values: true, false
  • Changes take effect: When the session is started or restarted.
  • Description: Enable websocket transport.

workspace.web-content

  • Default Value: ""
  • Valid Values: A comma-separated value list of option section names that correspond to the extension views, for example: Extension1,Extension2,Extention3
  • Changes take effect: When the session is started or restarted.
  • Description: 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.

Case Data

case-data.float-separator

  • Default Value: .
  • Valid Values: A valid float separator. Typical float separators are: '.' ',' '\'
  • Changes take effect: When the session is started or restarted.
  • Description: Specifies the float separator that is used for Case data. This option should be used when the decimal symbol in the regional settings of the agent's workstation or browser is different from the one provided by the database.

Chat

chat.agent.prompt-color

  • Default Value: #385078
  • Valid Values: Valid Hexadecimal (HTML) color code
  • Changes take effect: When the session is started or restarted.
  • Description: Specifies the color of the prompt for the messages that are entered by the agent in the Chat view.

chat.agent.text-color

  • Default Value: #385078
  • Valid Values: Valid Hexadecimal (HTML) color code
  • Changes take effect: When the session is started or restarted.
  • Description: Specifies the color of the text of the messages that are entered by the agent in the Chat view.

chat.auto-answer

  • Default Value: false
  • Valid Values: true, false
  • Changes take effect: When the session is started or restarted.
  • Description: Specifies whether a chat interaction is automatically accepted and joined when a Interaction Server Invite event is received. This option can be overridden by a routing strategy as described in this Deployment Guide.

chat.client.prompt-color

  • Default Value: #166FFF
  • Valid Values: Valid Hexadecimal (HTML) color code
  • Changes take effect: When the session is started or restarted.
  • Description: Specifies the color of the text of the messages that are entered by the target client in the Chat view.

chat.client.text-color

  • Default Value: #166FFF
  • Valid Values: Valid Hexadecimal (HTML) color code
  • Changes take effect: When the session is started or restarted.
  • Description: Specifies the color of the client text in the Chat view.

chat.enable-auto-disconnect

  • Default Value: true
  • Valid Values: true, false
  • Changes take effect: When the session is started or restarted.
  • Description: Specifies whether the chat session is automatically disconnected if the agent is the last party remaining in the chat session.

chat.nickname

  • Default Value: $Agent.UserName$
  • Valid Values: A string that contains a compilation of characters and field codes from the following list: $Agent.UserName$,$Agent.LastName$,$Agent.FirstName$,$Agent.FullName$,$Agent.EmployeeId$.
  • Changes take effect: When the session is started or restarted.
  • Description: Specifies the nickname that is used to join the chat session (presented to the customer) by a string that can contain regular characters and the field codes.
    This option can be overridden by a routing strategy as described in this Deployment Guide.

chat.pending-response-to-customer

  • Default Value: 30,50
  • Valid Values: <A comma-separated list value: warning time, maximum time>
  • Changes take effect: When the session is started or restarted.
  • Description: Specifies two alarm thresholds, in seconds, that warn agents that they have a pending response to a chat from a customer. Three levels are displayed: before the warning time, between the warning time and the maximum time, and after the maximum time.

chat.prompt-for-done

  • Default Value: false
  • Valid Values: true, false
  • Changes take effect: When the session is started or restarted.
  • Description: Specifies if the application prompts a confirmation message when a user clicks Done. This option is only available for interaction open media. This option can be overridden by a routing strategy as described in this Deployment Guide.

chat.prompt-for-end

  • Default Value: false
  • Valid Values: true, false
  • Changes take effect: When the session is started or restarted.
  • Description: Specifies if the application prompts a confirmation message when a user clicks End. This option can be overridden by a routing strategy as described in this Deployment Guide.

chat.system.text-color

  • Default Value: #8C8C8C
  • Valid Values: Valid Hexadecimal (HTML) color code.
  • Changes take effect: When the session is started or restarted.
  • Description: Specifies the color of the text for system messages in the Chat view.

chat.time-stamp

  • Default Value: true
  • Valid Values: true, false
  • Changes take effect: When the session is started or restarted.
  • Description: Specifies whether the time stamp is displayed in the Chat transcript area.

chat.typing-is-enabled

  • Default Value: true
  • Valid Values: true, false
  • Changes take effect: When the session is started or restarted.
  • Description: Specifies whether typing notification is enabled. It should be disabled for Chat Server lower than 8.0.1.

chat.typing-timeout

  • Default Value: 10
  • Valid Values: From 0 to MAXINT
  • Changes take effect: When the session is started or restarted.
  • Description: Defines the duration, in seconds, that the typing notification is displayed after the last keystroke and before the agent or contact sends their message.

privilege.chat.can-use

  • Default Value: true
  • Valid Values: true, false
  • Changes take effect: When the session is started or restarted.
  • Description: When the value is set to true, the agent is permitted to use the Chat channel.

Contact

contact.available-directory-page-sizes

  • Default Value: 5,10,25,50
  • Valid Values: A comma-separated list of numbers that define the number of rows per result page from which the agent can make selections.
  • Changes take effect: When the session is started or restarted.
  • Description: Specifies the possible values for the number of rows per page in the contact directory search result view.

contact.cache-timeout-delay

  • Default Value: 600
  • Valid Values: An integer from 1 through 3600.
  • Changes take effect: When the session is started or restarted.
  • Description: Specifies the delay, in seconds, before the cache of the result of a Universal Contact Server request is cleared.

contact.default-directory-page-size

  • Default Value: 10
  • Valid Values: An integer from 1 through 50.
  • Changes take effect: When the session is started or restarted.
  • Description: Specifies the default value for the number of rows per page in the contact directory search result view. The value must be defined in the option contact.available-directory-page-size.

contact.directory-default-mode

  • Default Value: ListView
  • Valid Values: ListView, GridView
  • Changes take effect: When the session is started or restarted.
  • Description: Specifies which view of the Contact Directory is displayed by default. ListView: Quicker search performance and tokenized search items, but no sort on the result. GridView: Results are sortable result, but the search is less powerful, and the search items are non-tokenized.

contact.directory-displayed-columns

  • Default Value: LastName,FirstName,PhoneNumber,EmailAddress
  • Valid Values: A comma-separated value list of Attribute Value names that correspond to contact field names -- for example: LastName,FirstName,PhoneNumber,EmailAddress.
  • Changes take effect: When the session is started or restarted.
  • Description: The list of contact fields that are displayed when the results of a contact search are displayed.

contact.directory-search-attributes

  • Default Value: LastName,FirstName,PhoneNumber,EmailAddress
  • Valid Values: A comma-separated value list of Attribute Value names that correspond to contact field names that can be used as search parameters.
  • Changes take effect: When the session is started or restarted.
  • Description: The list of Contact fields that can be used as search parameters.

contact.displayed-attributes

  • Default Value: Title,FirstName,LastName,PhoneNumber,EmailAddress
  • Valid Values: A comma-separated value list of Attribute Value names that correspond to contact field names.
  • Changes take effect: When the session is started or restarted.
  • Description: The list of contact fields that are displayed when a Contact record is displayed.

contact.mandatory-attributes

  • Default Value: FirstName,LastName
  • Valid Values: A comma-separated value list of Attribute Value names that correspond to contact field names--for example: LastName,FirstName,PhoneNumber,EmailAddress.
  • Changes take effect: When the session is started or restarted.
  • Description: Specifies the list of Contact fields that must be completed for a contact.

contact.multiple-value-attributes

  • Default Value: PhoneNumber,EmailAddress
  • Valid Values: A comma separated value list of Attribute Value names that correspond to contact field names.
  • Changes take effect: When the session is started or restarted.
  • Description: A list of contact attributes that can support multiple values.

Contact Center Statistics

statistics.displayed-statistics

  • Default Value: An empty string.
  • Valid Values: A comma-separated list of Statistic names.
  • Changes take effect: When the session is started or restarted.
  • Description: Specifies the statistics that are displayed in the Contact Center Statistics tab. The statistics specified by this option match the names of the statistics defined in the options of the Application sections. Refer to the Procedure: Enabling Agent View KPIs and Contact Center Statistic for more information.

Email

email.auto-answer

  • Default Value: false
  • Valid Values: true, false
  • Changes take effect: When the session is started or restarted.
  • Description: Specifies whether an e-mail interaction is automatically accepted when a Interaction Server Invite event is received. This option can be overridden by a routing strategy as described in this Deployment Guide.

email.default-queue

  • Default Value: An empty string.
  • Valid Values: A valid name of a Script of type Interaction Queue.
  • Changes take effect: When the session is started or restarted.
  • Description: Specifies the Interaction queue in which new or reply outbound e-mails are submitted.

email.from-addresses

  • Default Value: An empty string.
  • Valid Values: Letters A to Z and a to z. Numbers 0 through 9. The underscore and space characters.
  • Changes take effect: When the session is started or restarted.
  • Description: Specifies a character string that specifies the name of the Business Attribute which contains the Attribute Values that are used as available addresses. These come from the addresses of e-mail interactions.

email.html-format

  • Default Value: true
  • Valid Values: true, false
  • Changes take effect: When the session is started or restarted.
  • Description: Specifies the format of a new outbound e-mail. When set to 'true', new e-mail will be formatted in HTML.

email.include-original-text-in-reply

  • Default Value: true
  • Valid Values: true, false
  • Changes take effect: When the session is started or restarted.
  • Description: Specifies whether the text of the original inbound e-mail is included in the outbound reply e-mail. This option can be overridden by a routing strategy, as described in this Deployment Guide.

email.max-attachment-size

  • Default Value: 0
  • Valid Values: A positive integer.
  • Changes take effect: When the session is started or restarted.
  • Description: Specifies the maximum number of megabytes of one file that agents can attach to an external e-mail interaction. The attachment is refused by the system and an error message is displayed to the agent if the size in megabytes of the attached file exceeds this value. The value 0 means that there is no restriction.

email.max-attachments-size

  • Default Value: 0
  • Valid Values: A positive integer.
  • Changes take effect: When the session is started or restarted.
  • Description: Specifies the maximum number of total megabytes of files that agents can attach to an external e-mail interaction. An error message is displayed to the agent if the total number of megabytes for all attached files exceeds this value. The value 0 means that there is no restriction.

email.outbound-queue

  • Default Value: An empty string.
  • Valid Values: A valid name of a Script of type Interaction Queue.
  • Changes take effect: When the session is started or restarted.
  • Description: Specifies the Interaction Queue in which outbound e-mails are placed when agents click 'Send' or 'Send Interim'. This options is used only when Interaction Workflow does not set 'Queue for New Interactions' when it is routing Inbound E-mails to Agents.

email.prompt-for-done

  • Default Value: false
  • Valid Values: true, false
  • Changes take effect: When the session is started or restarted.
  • Description: Specifies if the application prompts a confirmation message when the user clicks Done. This option is only available for interaction open media. This option can be overridden by a routing strategy, as described in this Deployment Guide.

email.quote-char

  • Default Value: >
  • Valid Values: Any valid character string.
  • Changes take effect: When the session is started or restarted.
  • Description: For outbound e-mail that is formatted as plain text, specifies the characters that are used to quote the contents of the inbound e-mail interaction in the outbound e-mail interaction body.

email.quote-header

  • Default Value: On <date>, <contact> wrote:
  • Valid Values: Any valid character string.
  • Changes take effect: When the session is started or restarted.
  • Description: Specifies the character string that is used to introduce the quoted inbound e-mail content in the body of the outbound e-mail. The following tags can be used: <contact>, <date>. These tags are replaced respectively by the contact name and the date and time of the interaction when they appear in the outbound e-mail.

email.reply-format

  • Default Value: auto
  • Valid Values: auto, html, plain-text
  • Changes take effect: When the session is started or restarted.
  • Description: Specifies the format of an outbound e-mail reply:
    • auto: outbound e-mail reply format is the same as corresponding inbound e-mail.
    • html: outbound e-mail reply format is forced to html.
    • plain-text: outbound e-mail reply format is forced to plain text.

email.reply-prefix

  • Default Value: Re:
  • Valid Values: Any valid character string.
  • Changes take effect: When the session is started or restarted.
  • Description: Specifies the reply-prefix that is added to subject of the inbound e-mail.

email.signature.line-<n>

  • Default Value: An empty string.
  • Valid Values: Any valid character string.
  • Changes take effect: When the session is started or restarted.
  • Description: Specifies the row number of the signature by a string that can contain regular characters and the following field codes: $Agent.LastName$,$Agent.FirstName$,$Agent.FullName$. <n> is starting at 0. This option can be overridden by a routing strategy as described in this Deployment Guide.

privilege.email.can-use

  • Default Value: true
  • Valid Values: true, false
  • Changes take effect: When the session is started or restarted.
  • Description: When the value of this option is set to true, the agent is permitted to use the E-mail channel.

Expression

expression.phone-number

  • Default Value: ^[\(\)\-\.\+\d\s\*#]*[0-9]+[\(\)\-\.\+\d\s\*#]*$
  • Valid Values: A regular expression.
  • Changes take effect: When the session is started or restarted.
  • Description: Specifies the regular expression that identifies a phone number in the chat or SMS transcript. This option can be overridden by a routing strategy as described in this Deployment Guide.

expression.phone-number.supported-characters

  • Default Value: 0123456789+
  • Valid Values: Letters A to Z and a to z. Numbers 0 through 9. All special characters that are valid Windows file names.
  • Changes take effect: When the session is started or restarted.
  • Description: Specifies the characters that are permitted when building a request to the T-Server that relies on a phone number. Any other characters from the original string coming from the User Interface are removed. This option can be overridden by a routing strategy as described in this Deployment Guide.

Facebook

facebook.auto-answer

  • Default Value: false
  • Valid Values: true, false
  • Changes take effect: When the session is started or restarted.
  • Description: Specifies whether a Facebook interaction is automatically accepted when an Interaction Server Invite event is received. This option can be overridden by a routing strategy as described in the Deployment Guide.

facebook.comments-pagination-size

  • Default Value: 2
  • Valid Values: Any positive integer.
  • Changes take effect: When the session is started or restarted.
  • Description: Specifies the number of comments are initially displayed and then added when Show More is clicked.

facebook.default-queue

  • Default Value: Facebook Outbound Queue
  • Valid Values: A valid name of a Script of type Interaction Queue.
  • Changes take effect: When the session is started or restarted.
  • Description: Specifies the name of the queue in which outbound interactions are first created. This name must be identical to the the name of the default queue in the configuration layer.

facebook.outbound-queue

  • Default Value: Facebook Outbound Queue
  • Valid Values: A valid name of a Script of type Interaction Queue.
  • Changes take effect: When the session is started or restarted.
  • Description: Specifies the name of the queue in which an outbound interaction is to be placed when an agent has completed editing it.

facebook.prompt-for-done

  • Default Value: false
  • Valid Values: true, false
  • Changes take effect: When the session is started or restarted.
  • Description: Specifies if the application prompts a confirmation message when the user clicks Done. This option can be overridden by a routing strategy, as described in the Deployment Guide.

privilege.facebook.can-use

  • Default Value: true
  • Valid Values: true, false
  • Changes take effect: When the session is started or restarted.
  • Description: When the value of this option is set to true, the agent is permitted to use the Facebook channel.

Interaction

interaction.case-data.content

  • Default Value: History,CaseData
  • Valid Values: History, CaseData
  • Changes take effect: When the session is started or restarted.
  • Description: Defines the content of the Case Information area in the interaction. The CaseData key enables the display of the attached data that is defined by the interaction.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 Deployment Guide.

interaction.case-data.format-business-attribute

  • Default Value: An empty string.
  • Valid Values: Letters A to Z and a to z. Numbers 0 through 9. The underscore and space characters.
  • Changes take effect: When the session is started or restarted.
  • Description: Specifies the name of the Business Attribute that contains the Business Attribute values that are used to filter and render attached data in the interaction.
    This option can be overridden by a routing strategy as described in this Deployment Guide.
    You can define the display order of Business Attribute Values by creating an interaction-workspace section in the annex of the Business Attribute, then add the interaction.case-data.order option. This option is a comma-separated list of Business Attributes Value Names that specifies the order of the Business Attribute Values. The Attributes Values that are not listed in interaction.case-data.order option are put at the bottom of the list.

interaction.case-data.frame-color

  • Default Value: #FFBA00
  • Valid Values: Valid Hexidecimal (HTML) color code.
  • Changes take effect: When the session is started or restarted.
  • Description: Specifies the color of the border of the Case Data view frame. Examples: #FFBA00 for a Gold color, #6F7074 for a Silver color, #B8400B for a Bronze color. This option can be overridden by a routing strategy as described in this Deployment Guide.

interaction.case-data.header-foreground-color

  • Default Value: #15428B
  • Valid Values: Valid Hexidecial (HTML) color code
  • Changes take effect: When the session is started or restarted.
  • Description: Specifies the color of the foreground of the Case Data view header. Example #FFFFFF for white color. This option can be overridden by a routing strategy as described in this Deployment Guide.

interaction.disposition.is-mandatory

  • Default Value: false
  • Valid Values: true, false
  • Changes take effect: When the session is started or restarted.
  • Description: 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 this Deployment Guide.

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

  • Default Value: false
  • Valid Values: true, false
  • Changes take effect: When the session is started or restarted.
  • Description: Prevents changes to the disposition code after a voice interaction has been released. This option can be overridden by a routing strategy as described in this Deployment Guide.

interaction.disposition.key-name

  • Default Value: DispositionCode
  • Valid Values: Letters A to Z and a to z. Numbers 0 through 9. The underscore and space characters.
  • Changes take effect: When the session is started or restarted.
  • Description: 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 this Deployment Guide.

interaction.disposition.use-attached-data

  • Default Value: false
  • Valid Values: true, false
  • Changes take effect: When the session is started or restarted.
  • Description: Enables the adding of attached data to the interaction in UserEvent. This option can be overridden by a routing strategy as described in this Deployment Guide.

interaction.disposition.value-business-attribute

  • Default Value: DispositionCode
  • Valid Values: Letters A to Z and a to z. Numbers 0 through 9. The underscore and space characters.
  • Changes take effect: When the session is started or restarted.
  • Description: 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. This option can be overridden by a routing strategy as described in this Deployment Guide.

interaction.override-option-key

  • Default Value: An empty string.
  • Valid Values: An attached data key name (string). The list is provided in the Attached Data in the strategy.
  • Changes take effect: When the session is started or restarted.
  • Description: Enables the overriding of certain application options by using a transaction object. This option provides the key name of the attached data that contains the list of transaction objects.

interaction.web-content

  • Default Value: ""
  • Valid Values: A section name corresponding to the web extension view, for example: Search
  • Changes take effect: When the session is started or restarted.
  • Description: Specifies the Web Application that is configured to be displayed at the Interaction 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.

Intercommunication

intercommunication.chat.queue

  • Default Value: An empty string.
  • Valid Values: Name of a valid Script object of type Interaction Queue
  • Changes take effect: When the session is started or restarted.
  • Description: Specifies the name of the Interaction Queue that is used by the 'routing-based' feature for Chat. The following attached data are added by Worskpace: IW_RoutingBasedOriginalEmployeeId,IW_RoutingBasedTargetId,IW_RoutingBasedTargetType,IW_RoutingBasedRequestType.

intercommunication.chat.routing-based-actions

  • Default Value: OneStepTransfer
  • Valid Values: A comma-separated list of valid operation names from the following list: OneStepTransfer.
  • Changes take effect: When the session is started or restarted.
  • Description: Specifies the list of 'routing-based' actions that an agent is allowed to perform.

intercommunication.chat.routing-based-targets

  • Default Value: An empty string.
  • Valid Values: Blank or a comma-separated list of valid object types from the following list: Agent
  • Changes take effect: When the session is started or restarted.
  • Description: Defines the list of targets that are contacted through the 'routing-based' mechanism for the requests that are defined in the option intercommunication.chat.routing-based-actions.
    Note: The targets 'AgentGroup' and 'Skill' are always addressed through routing; therefore, they are not affected by this option.

intercommunication.email.queue

  • Default Value: An empty string.
  • Valid Values: The name of a valid Script object of type Interaction Queue
  • Changes take effect: When the session is started or restarted.
  • Description: Specifies the name of the Interaction Queue that is used by the 'routing-based' feature for E-Mail. The following attached data are added by Worskpace: IW_RoutingBasedOriginalEmployeeId,IW_RoutingBasedTargetId,IW_RoutingBasedTargetType,IW_RoutingBasedRequestType.

intercommunication.email.routing-based-actions

  • Default Value: OneStepTransfer
  • Valid Values: A comma-separated list of valid operation names from the following list: OneStepTransfer.
  • Changes take effect: When the session is started or restarted.
  • Description: Specifies the list of 'routing-based' actions that an agent is allowed to perform.

intercommunication.email.routing-based-targets

  • Default Value: An empty string.
  • Valid Values: A comma-separated list of valid object types from the following list: Agent
  • Changes take effect: When the session is started or restarted.
  • Description: Specifies the list of targets that are contacted through the 'routing-based' mechanism for the requests that are defined in the option intercommunication.email.routing-based-actions.
    Note: The targets 'AgentGroup' and 'Skill' are always addressed through routing; therefore, they are not affected by this option.

intercommunication.voice.routing-based-actions

  • Default Value: MakeCall,OneStepConference,InitConference,OneStepTransfer,InitTransfer
  • Valid Values: A comma-separated list of valid operation names from the following list: MakeCall, OneStepTransfer, InitTransfer, InitConference, OneStepConference.
  • Changes take effect: When the session is started or restarted.
  • Description: Defines the list of routing-based actions that an agent may perform.

intercommunication.voice.routing-based-targets

  • Default Value: An empty string.
  • Valid Values: A comma-separated list of valid object types from the following list: Agent, RoutingPoint, TypeDestination.
  • Changes take effect: When the session is started or restarted.
  • Description: Defines the list of targets that are contacted through the 'routing-based' mechanism for the requests that are defined in the option intercommunication.voice.routing-based-actions.
    Note: The targets 'AgentGroup' and 'Skill' are always addressed through routing; therefore, they are not affected by this option.

intercommunication.voice.routing-points

  • Default Value: An empty string.
  • Valid Values: A call number name in the following format: $dn_name$
  • Changes take effect: When the session is started or restarted.
  • Description: Determines the call number that is used by the routing-based feature. The following attached data are added by Worskpace: IW_RoutingBasedOriginalEmployeeId,IW_RoutingBasedTargetId,IW_RoutingBasedTargetType,IW_RoutingBasedRequestType.

intercommunication.voice.single-step-conference-enabled

  • Default Value: Agent,AgentGroup,RoutingPoint,Contact,TypeDestination
  • Valid Values: A comma-separated list of valid object types from the following list: Agent, AgentGroup, RoutingPoint, Contact, TypeDestination.
  • Changes take effect: When the session is started or restarted.
  • Description: Specifies the list of targets that are enabled in Team Communication for a single-step conference.

KPI

kpi.displayed-kpis

  • Default Value: An empty string.
  • Valid Values: A comma-separated list of KPI names.
  • Changes take effect: When the session is started or restarted.
  • Description: Defines the KPIs that are displayed to the agent. The KPI names refer to the names of the Application Option sections that are defining the KPIs. Refer to the Procedure: Enabling Agent View KPIs and Contact Center Statistic for more information.

Login Voice

login.voice.auto-not-ready-reason

  • Default Value: An empty string.
  • Valid Values: A valid NotReady Reason.
  • Changes take effect: When the session is started or restarted.
  • Description: If the Voice channel is automatically set to NotReady when the agent logs in, this option defines the NotReady Reason code.

login.voice.is-auto-ready

  • Default Value: false
  • Valid Values: true, false
  • Changes take effect: When the session is started or restarted.
  • Description: Specifies whether the voice channels are in the Ready state at login.

Team Communicator

presence.evaluate-presence

  • Default Value: true
  • Valid Values: true, false
  • Changes take effect: When the session is started or restarted.
  • Description: When this option is set to true, to display agent presence in Team Communicator when the agent is displayed in the Team Communicator search results.

teamcommunicator.always-clear-textbox-on-new-interaction

  • Default Value: true
  • Valid Values: true, false
  • Changes take effect: When the session is started or restarted.
  • Description: When this option is set to true, Workspace clears the team communicator search text box when the interaction is initiated by pressing 'Enter' or by clicking on one of the medias of team communicator results. When it is set to false, this option clears the team communicator search text box only when the interaction is initiated by pressing 'Enter'

teamcommunicator.corporate-favorites

  • Default Value: ""
  • Valid Values: A comma-separated list of favorite names (section names) that are defined in the Workspace application.
  • Changes take effect: When the session is started or restarted.
  • Description: Specifies the list of corporate favorites (quick dial favorites) that are configured in the Configuration Server for an Agent, Agent Group, Skill, Routing Point, or Custom Contact. See the Procedure: Creating Corporate Favorites for information about creating Corporate Favorite objects in the configuration layer.

teamcommunicator.custom-favorite-fields

  • Default Value: Category,FirstName,LastName,PhoneNumber,EmailAddress
  • Valid Values: A comma-separated list of valid interaction queue names.
  • Changes take effect: When the application is started or restarted.
  • Description: The list of fields that are displayed to an agent when adding or editing a favorite that is created from a typed phone number or e-mail address.

teamcommunicator.list-filter-showing

  • Default Value: Agent,AgentGroup,RoutingPoint,Skill,Contact
  • Valid Values: A comma-separated value list of filter items to be displayed in the team communicator, for example: Agent,AgentGroup,RoutingPoint,Skill,Contact.
  • Changes take effect: When the session is started or restarted.
  • Description: Specifies the list of filters that an agent can use to search for contacts and internal targets by using the team communicator. The object types are presented in the specified order.

teamcommunicator.max-size

  • Default Value: 50
  • Valid Values: An integer value from 1 through 50.
  • Changes take effect: When the session is started or restarted.
  • Description: Specifies the maximum size of the favorites list that is displayed while an agent is displaying favorites or the default list when the value of teamcommunicator.show-all-internal-targets is set to true.

teamcommunicator.max-suggestion-size

  • Default Value: 10
  • Valid Values: An integer value from 1 through 50.
  • Changes take effect: When the session is started or restarted.
  • Description: Specifies the maximum size of the suggestion list that is displayed while an agent is entering a contact or target name.

teamcommunicator.recent-max-records

  • Default Value: 10
  • Valid Values: An integer value from 1 through 50.
  • Changes take effect: When the session is started or restarted.
  • Description: Specifies the number of recent internal targets to display in the list of recent targets.

teamcommunicator.request-start-timer

  • Default Value: 500
  • Valid Values: An integer value from 1 through 5000.
  • Changes take effect: When the session is started or restarted.
  • Description: Specifies the request start timer wait interval, in milliseconds, between the last key pressed and the beginning of the search through the contact database.

teamcommunicator.show-all-internal-targets

  • Default Value: false
  • Valid Values: true, false.
  • Changes take effect: When the session is started or restarted.
  • Description: Specify whether all internal targets are displayed by default in the Team Communicator when an agent is searching for a transfer or conference target, including all Agents, Agent Groups, Skills, and Routing Points.

Team Lead

privilege.teamlead.can-use

  • Default Value: true
  • Valid Values: true, false
  • Changes take effect: When the session is started or restarted.
  • Description: Enables a supervisor to use the agent call monitoring fuctionality.

teamlead.monitoring-scope

  • Default Value: call
  • Valid Values: Select a value from the following list: agent, call
  • Changes take effect: When the session is started or restarted.
  • Description: Specifies the scope of monitoring that is to be used for voice interactions. If the value call is specified, the supervisor remains on the call until it is finished. This mode enables barge-in. If the value agent is specified, the system disconnects the supervisor automatically from the call when the monitored agent leaves the call. In this mode, the barge-in operation is not possible.

Toast

toast.case-data.content

  • Default Value: History,CaseData
  • Valid Values: History, CaseData
  • Changes take effect: When the session is started or restarted.
  • Description: Defines 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 Deployment Guide.

toast.case-data.format-business-attribute

  • Default Value: An empty string.
  • Valid Values: Letters A to Z and a to z. Numbers 0 through 9. The underscore and space characters.
  • Changes take effect: When the session is started or restarted.
  • Description: 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.
    This option can be overridden by a routing strategy as described in this Deployment Guide.
    You can define the display order of Business Attribute Values by creating an interaction-workspace section in the annex of the Business Attribute, then add the toast.case-data.order option. This option is a comma-separated list of Business Attributes Value Names that specifies the order of the Business Attribute Values The Attributes Values that are not listed in option toast.case-data.order are put at the bottom of the list.

Twitter

privilege.twitter.can-use

  • Default Value: true
  • Valid Values: true, false
  • Changes take effect: When the session is started or restarted.
  • Description: The agent is permitted to use the Twitter channel.

twitter.auto-answer

  • Default Value: false
  • Valid Values: true, false
  • Changes take effect: When the session is started or restarted.
  • Description: Specifies whether a Twitter interaction is automatically accepted when an Interaction Server Invite event is received. This option can be overridden by a routing strategy as described in Deployment Guide.

Voice

privilege.voice.can-one-step-conference

  • Default Value: true
  • Valid Values: true, false
  • Changes take effect: When the session is started or restarted.
  • Description: Enables instant conferencing of a voice call. Depends on privilege.voice.can-use.

privilege.voice.can-one-step-transfer

  • Default Value: true
  • Valid Values: true, false
  • Changes take effect: When the session is started or restarted.
  • Description: Enables instant conferencing of a voice call. Depends on privilege.voice.can-use.

privilege.voice.can-send-dtmf

  • Default Value: false
  • Valid Values: true, false
  • Changes take effect: When the application is started or restarted.
  • Description: Enables agents to send DTMF during a voice call. Depends on privilege.voice.can-use.

privilege.voice.can-use

  • Default Value: true
  • Valid Values: true, false
  • Changes take effect: When the session is started or restarted.
  • Description: When the value of this option is set to true, the agent is permitted to use the Voice channel.

privilege.voice.show-monitoring.can-use

  • Default Value: true
  • Valid Values: true, false
  • Changes take effect: When the session is started or restarted.
  • Description: Enables agents to be notified that the current call is monitored by a supervisor.

voice.auto-answer

  • Default Value: false
  • Valid Values: true, false
  • Changes take effect: When the application is started or restarted.
  • Description: 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 this Deployment Guide.

voice.mark-done-on-release

  • Default Value: false
  • Valid Values: true, false
  • Changes take effect: When the session is started or restarted.
  • Description: 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 this Deployment Guide.

voice.prompt-for-end

  • Default Value: false
  • Valid Values: true, false
  • Changes take effect: When the session is started or restarted.
  • Description: Specifies whether Workspace displays a confirmation message when the agent clicks 'End'. This option can be overridden by a routing strategy as described in this Deployment Guide.

Workbin

workbin.email.draft

  • Default Value: An empty string.
  • Valid Values: The name of a valid Script object of type Interaction Workbin that is owned by Agents.
  • Changes take effect: When the session is started or restarted.
  • Description: Specifies the name of the workbin to be used to store draft e-mail.

workbin.email.in-progress

  • Default Value: An empty string.
  • Valid Values: Specifies the name of a valid Script object of type Interaction Workbin that is owned by Agents.
  • Changes take effect: When the session is started or restarted.
  • Description: The name of the workbin that is to be used to store inbound e-mail for later processing, after an agent explicitly saved the e-mail or submitted an outbound reply.

workbin.facebook.draft

  • Default Value: ""
  • Valid Values: The name of a valid Script object of type Interaction Workbin that is owned by Agents.
  • Changes take effect: When the session is started or restarted.
  • Description: The name of the workbin that is used to store draft Facebook posts.

workbin.facebook.in-progress

  • Default Value: ""
  • Valid Values: The name of a valid Script object of type Interaction Workbin that is owned by Agents.
  • Changes take effect: When the session is started or restarted.
  • Description: The name of the workbin that is used to store inbound Facebook posts for later processing, after an agent explicitly saved the Facebook post or submitted an outbound reply.

workbin.twitter.draft

  • Default Value: ""
  • Valid Values: The name of a valid Script object of type Interaction Workbin that is owned by Agents.
  • Changes take effect: When the session is started or restarted.
  • Description: The name of the workbin that is used to store draft Twitter posts.

workbin.twitter.in-progress

  • Default Value: ""
  • Valid Values: The name of a valid Script object of type Interaction Workbin that is owned by Agents.
  • Changes take effect: When the session is started or restarted.
  • Description: The name of the workbin that is used to store inbound Twitter posts for later processing, after an agent explicitly saved the Twitter post or submitted an outbound reply.
This page was last edited on October 31, 2023, at 13:35.
Comments or questions about this documentation? Contact us for support!