Maintenance Notice - PDF Generation
Dynamic PDF generation for web-based content is temporarily unavailable. This maintenance affects dynamic PDF files that are generated from either the HTML-based page or manual that you are viewing. Links that normally allow this functionality have been hidden, and will reappear as soon as the feature is restored.


Note: Access to static files, including PDF files that are not dynamically generated from our web-based content, is unaffected.

Jump to: navigation, search

whatsappsession.default-notification-language

Section: interaction-workspace
Default Value: en_US
Valid Values: Any valid language code described in the official WhatsApp documentation: https://developers.facebook.com/docs/whatsapp/business-management-api/message-templates
Changes Take Effect: Immediately
Introduced: 9.1.002.07

Specifies the default notification language.

whatsappsession.default-notification-id

Section: interaction-workspace
Default Value:
Valid Values: Any string
Changes Take Effect: Immediately
Introduced: 9.1.002.07

Specifies the default notification message ID.

whatsappsession.default-notification-text

Section: interaction-workspace
Default Value:
Valid Values: Any notification text with a single parameter
Changes Take Effect: Immediately
Introduced: 9.1.002.07

Specifies the default notification message text.

whatsappsession.free-msg-timespan

Section: interaction-workspace
Default Value: 24
Valid Values: Any integer from 1 to Int32 MaxValue
Changes Take Effect: At the next interaction
Introduced: 9.1.002.07

Specifies the number of hours from the last inbound message.

whatsappsession.enable-free-msg-timespan-monitoring

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

Specifies if a free text message timespan should be enforced.

session-shutdown-timeout

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.

whatsappsession.on-hold-queue

Section: interaction-workspace
Default Value:
Valid Values: Any valid Interaction Queue script name
Changes Take Effect: At the next interaction attempt to put the chat in the queue


Specifies the Interaction Queue where the chat interaction is placed when the agent hits the "Place chat on hold" button.

xml-request-max-size

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

Sets a limit on the size (in bytes) of incoming XML packets. This limit helps prevent Chat Server from hanging during an XML parsing of overly large amounts of incoming data. The actual payload size (in symbols) could be estimated roughly as the XML packet size multiplied by 0.45.

transcript-auto-save

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


If this option is set to 1 (recommended for HA) 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 TRANSCRIPT_SAVE_DONE notification for basic clients (which can be used in custom agent desktops only).

Deploying WhatsApp

Prerequisites

  • Computer with access to the Genesys Hub REST API
  • Java 8 or above
  • Digital Messaging Server (DMS) 9.1.002.02 or later
  • Chat Server 8.5.306.03 or later
  • UCS 8.5.300.09 or later (8.5.300.16 or later for outbound support)
  • Workspace Desktop Edition 8.5.127.06 or later
  • eServices Manager 9.0.000.09 or later
  • Genesys Hub account that contains the following values:
    • Username
    • Password
    • API key
    • Configured channel with channelId

Deploy Digital Messaging Server

Follow the installation procedure for Digital Messaging Server.

Install the channel driver

  1. Navigate to the folder that contains the installation package for Genesys Driver for use with Genesys Hub.
  2. Run the installation for Genesys Driver for use with Genesys Hub:
    On Windows, run setup.exe
    On Linux, run install.sh
  3. When prompted by the installation dialog, specify the proper Configuration Server parameters for your environment and select the desired Digital Messaging Server application.
  4. After installation, locate the GenesysHubDriver.cfg configuration file in the \<Digital Messaging Server application>\media-channel-drivers\channel-ghub\Configuration folder.
  5. In GAX, open your Digital Messaging Server Application, go to the Options tab, and import options from the GenesysHubDriver.cfg file.

Configuration

All options are documented in the Options Reference.

Configuring Chat Server

Set the following Chat Server options:

  • transcript-auto-save = 1
    This setting automatically saves the chat transcript in UCS in case of a solution failure.
  • xml-request-max-size = 100000
    Setting this value to 100 KB or more is required when using rich messaging functionality.

Follow Deployment guidelines for async and regular chat in the Chat Server Administration guide.

Endpoints

  • 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 WhatsApp channel, add an endpoint called session-chat.

(You must use a comma before the tenant ID. For example: ,1:session-chat.)

MSGA WhatsApp900 Endpoint.png

Deploy Genesys Hub Plug-in for Workspace Desktop Edition

  1. Install Workspace using the ClickOnce deployment procedure.
  2. Configure and install the plugin, ensuring that your configuration procedure includes importing the template and metadata for the plugin. This makes roles and other required items available.
  3. Open the Workspace Desktop Edition Deployment Manager.
  4. Create a deployment package. In the Customization section, ensure that you select Genesys Hub Plug-in for Workspace Desktop Edition.
    MSGA WhatsApp900 Deploy1.png
  5. Deploy the package on a web server.
    MSGA WhatsApp900 Deploy2.png
  6. If you are using role-based access control,
    • You must assign all Workitem privileges. The plugin does not support unassigned Workitem privileges.
    • Assign InteractionWorkspace.WhatsApp.canUse privileges. This allows agents to load the WhatsApp plugin. If this permission is not set, the plugin will not load.
  7. 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 plugin are located in the [interaction-workspace] section. Options are documented in the Options Reference.

When using the sample business process, set the following configuration options in the [interaction-workspace] section:

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$
Important
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: whatsappsession. Next, add the whatsappsession media type to your environment's capacity rules and specify how many instances of whatsappsession interactions are allowed simultaneously.
  • Create a Business Attribute of type Interaction Subtype with the name InternalConferenceInvite.
  • Genesys recommends that you increase the default value of the session-shutdown-timeout option in DMS to 1800 (30 minutes).

Automatic notifications configuration

The following options are used to configure the automatic notifications feature for WhatsApp:

Important
Values of options, whatsappsession.default-notification-text, whatsappsession.default-notification-id, and whatsappsession.default-notification-language must match with the values in the WhatsApp template for the default notification. For more information, refer to Create message templates for your WhatsApp Business API account.

Uninstalling or upgrading

Driver

Uninstalling the driver

  1. Stop the DMS application with the driver. This can be done for example via GAX (or Services if using Windows).
  2. Uninstall the driver:
    • On Windows through Control Panel > Programs and Features.
    • On Linux by running the ./uninstall_custom.sh script from the media-channel-drivers/channel-ghub/uninstall folder.
  3. Verify that the folder channel-ghub was removed under folder media-channel-drivers.

Upgrading the driver

  1. Follow the procedure above to uninstall the old version of the driver.
  2. Install the new version of the driver, using the instructions above on this page.
  3. Start the DMS application with the driver.

Plugin

Uninstalling the plugin

  1. Uninstall the plugin.
  2. Create a deployment package with Workspace Desktop Edition Deployment Manager.
  3. Deploy the package onto a web server.

Upgrading the plugin

  1. Follow the procedure above to uninstall the old version of the plugin.
  2. Install the new version of the plugin, using the instructions above on this page.
  3. Create a deployment package with Workspace Desktop Edition Deployment Manager. Ensure you select the plugin in the Customization section.
  4. Deploy the package and plugin onto a web server.
This page was last edited on October 24, 2019, at 12:15.

Feedback

Comment on this article:

blog comments powered by Disqus