Jump to: navigation, search


Section: settings
Default Value: 32768
Valid Values: Any integer from 200-104857600
Changes Take Effect: Immediately

Sets a limit on the size of incoming XML packets. This limit helps prevent Chat Server from hanging during XML parsing of overly large amounts of incoming data.


Section: settings
Default Value: 180
Valid Values: 30-1728000
Changes Take Effect: After restart

Specifies the length of time, in seconds, that will pass before an active chat session is terminated by the Server. The session is terminated if, during this timespan, there are no inbound or outbound messages and the chat events NewPartyInfo (a new party joined the chat) and PartyLeftInfo (a party left the chat) are not received.


Section: settings
Default Value: none
Valid Values: none, simple
Changes Take Effect: Immediately

Allows ("simple") or prohibits ("none") Chat Server's processing of requests for session restoration (when Chat Server is working in high availability mode).


Section: settings
Default Value: true
Valid Values: true, false
Changes Take Effect: At start/restart

If this option is set to true, Chat Server creates and updates records in the Universal Contact Server database for each session that is created. If set to false, Chat Server does not interact with Universal Contact Server.


Section: settings
Default Value: 0
Valid Values: 0, 1, 2
Changes Take Effect: Immediately

If this option is set to 1 or 2, Chat Server sends the updated chat session transcript to Universal Contact Server after each submitted message. If set to 0, no UCS records are updated until the chat session ends. For the value 2, Chat Server also sends a special notification for basic clients.


Section: settings
Default Value: never
Valid Values: always, never, noagents, noanswer
Changes Take Effect: Immediately
Modified: 8.5.301.06

Specifies how Chat Server handles chat interactions (in Interaction Server) when the chat session is finished. Possible values:
  • always: interactions are always stopped when the chat session is finished (not recommended value).
  • never: interactions are never stopped by Chat Server (recommended value).
  • noagents: interactions are stopped only if there are currently no agents or supervisors in the session (use value wisely).
  • noanswer: interactions are stopped only if no agents ever joined the session - in other words, the session was never answered (use value wisely).
Note: The legacy "true" and "false" values are also supported and converted to new values as following:
  • "false" is interpreted as "never"
  • "true" is interpreted as "noanswer"
By default, Chat Server does not stop any interaction after the chat session is finished. Instead, Chat Server updates the IsOnline interaction property to false and attaches reporting statistics. If your deployment includes Genesys Info Mart reporting, Genesys recommends that you set the value of this option to "noanswer", to enable accurate reporting of abandoned chats. In all other deployments, Genesys recommends that you set the value of this option to "never", and have the agent desktop and/or a workflow stop the interaction. Values other than "never" must be used cautiously, as stopping the interaction from Chat Server may lead to conflicts with updates from the agent desktop.

Deploying Apple Business Chat


  • Computer with access to the Genesys Hub REST API
  • Java 8 or above
  • Chat Server 8.5.301.06 or later
  • Universal Contact Server 8.5.300.09
  • Workspace Desktop Edition or later
  • Digital Messaging Server or later
  • eServices Manager 8.5.304.09 or later
  • Create an Apple Business Chat channel in Genesys Hub

Deploy Digital Messaging Server

Follow the installation procedure for Digital Messaging Server.

Install the channel driver

The following steps describe how to use Genesys Administrator Extension (GAX) deploy the Genesys Driver for use with Apple Business Chat via Hub.

Upload the driver installation package and template

  1. Log in to GAX.
  2. Go to Administration > Installation Packages.
  3. Click + (New) to upload a new installation package.
  4. In the Software Installation Wizard panel, select Installation Package Upload (includes templates).
  5. Click Next.
  6. The panel updates. Click Choose File to select the file to upload.
  7. Click Finish.
  8. The file begins uploading from your file system to GAX. When the upload is complete, the IP will be displayed in the Installation Packages list.

Deploy the driver installation package and template

  1. In GAX, go to Administration > Installation Packages.
  2. Click the Apple Business Chat driver installation package to view its properties.
  3. Verify the Status field has a value of Complete.
  4. Click ES DMS90 GAXGear.png and select Install to open the IP Deployment Wizard panel.
  5. Run the installation for Genesys Driver for use with Apple Business Chat via Hub, selecting the desired Digital Messaging Server object.
  6. Locate the AbcHubDriver.cfg configuration file in the \<Digital Messaging Server application>\media-channel-drivers\channel-abc-hub directory.
  7. In GAX, open your Digital Messaging Server Application, go to the Options tab, and import options from the AbcHubDriver.cfg file.


All options are documented in the Options Reference.

Configuring Chat Server

You must use a separate Chat Server for Apple Business Chat messages. Set the following Chat Server options:

Ensure that the following Chat Server options are set to their default values:

There is a limit on the concurrent chat sessions Chat Server can support at a time. It depends on the hardware and chat session scenario, but as a rule of thumb you can expect a maximum of 1,000 concurrent sessions on one Chat Server.


  • Chat Server: in the [endpoints] section, add a queue called async-chat-greet-queue.
  • Digital Messaging Server: in the [channel-*any name*] section for your Apple Business Chat channel, add an endpoint called session-ABC.

ES MessAppsGuide ABCBPEndpointAsync.png

Deploy Apple Business Chat Plug-in for Workspace Desktop Edition

  1. Configure Workspace Desktop Edition. Note that to use role-based access control, you must use Genesys Administrator to configure Workspace Desktop Edition and the plugin.
  2. Install Workspace using the non-ClickOnce deployment procedure, also known as "installing the Workspace Application" (the Apple Business Chat plugin does not support ClickOnce deployment).
  3. Configure and install the plugin, being sure that your configuration procedure includes importing the template and metadata for the plugin (see Genesys Administrator 8.1 Help for information on importing metadata). This makes roles and other required items available.
  4. If you are using role-based access control,
    • You must assign all Workitem privileges. The plugin does not support unassigned Workitem privileges.
    • Assign InteractionWorkspace.AppleBusinessChat.canUse privileges. This allows agents to load the Apple Business Chat plugin. If this permission is not set, the plugin will not load.
  5. Provide values for the configuration options that you added to your Workspace Application, as described in the next section.

Configuring the Plugin

Plugin Options

All options for the Apple Business Chat plugin are located in the [interaction-workspace] section. Options are documented in the Options Reference.

When using the Asynchronous chat subroutine, set the following configuration options in the [interaction-workspace] section:

  • applebcsession.on-hold-queue to async-chat-return-queue
  • workbin.applebcsession.in-progress to async-chat-main-workbin

Workspace Desktop Edition Options

Workspace Desktop Edition options are documented in the Configuration Options Reference section of the Workspace Desktop Edition Deployment Guide. The following settings are recommended:

  • contact.directory-displayed-columns = LastName,FirstName,PhoneNumber,EmailAddress,_msg_ProfileNickname
  • contact.directory-search-attributes = LastName,FirstName,PhoneNumber,EmailAddress,_msg_ProfileNickname
  • contact.displayed-attributes = Title,FirstName,LastName,PhoneNumber,EmailAddress,_msg_ProfileNickname
  • display-format.case-name-format = $Contact._msg_ProfileNickname$|$Contact.FirstName$ $Contact.LastName$|$Interaction.MainParty$
  • display-format.customer-name-format = $Contact._msg_ProfileNickname$|$Contact.FirstName$ $Contact.LastName$|$Party.DisplayName$
  • interaction.window-title = ($Contact.FirstName$ $Contact.LastName$ $Interaction._msg_ProfileNickname$|$Interaction.MainParty$) - $Interaction.Type$ - $Window.Title$
  • toast.window-title = ($Contact._msg_ProfileNickname$|$Contact.FirstName$ $Contact.LastName$|$Interaction.MainParty$) - $Window.Title$
The plugin supports only the Default and HighContrast themes. If any other theme is specified, the plugin icons will be missing.

Other configuration

  • Create the following media type in the Configuration Server database: applebcsession.
  • Genesys recommends that you increase the default value of the session-shutdown-timeout option in DMS to 1800 (30 minutes).
  • Genesys recommends that you increase the default value of the xml-request-max-size option in Chat Server to 100 (kilobytes).

Contact Attributes

In Genesys Administrator or Configuration Manager, create the following Business Attribute Values for the Contact Attributes Business Attribute:


  • Name_msg_ProfileUserId_ABC
  • Display NameProfile User ID for Apple Business Chat

In the Annex tab, add the following options in the [settings] section:

  • is-searchable = true
  • is-sortable = true
  • search-order-level = 1

Profile Nickname

  • Name_msg_ProfileNickname
  • Display NameProfile Nickname

In the Annex tab, add the following options in the [settings] section:

  • is-searchable = false
  • is-sortable = false


Comment on this article:

blog comments powered by Disqus
This page was last modified on November 9, 2018, at 09:46.