Configuring and Using General Features

From Genesys Documentation
Jump to: navigation, search

Gplus Adapter integrates Genesys interaction handling capabilities into Salesforce. The Adapter window is accessed through the Adapter button in the Salesforce Utility Bar. The Adapter window displays agent status at all times. The Adapter window can be docked, undocked, moved, resized, minimized, and maximized. Some Genesys interactions events cause the Adapter window to be maximized automatically.

The information about support for Service Client API in Salesforce has moved here: Gplus Adapter support for Service Client API.

Configuring Gplus to run Salesforce Apex

If you want to customize Salesforce by running Salesforce Apex on Genesys interaction events, you can configure Gplus Adapter to create and execute Salesforce Apex. See the Salesforce Apex Developer Guide.

Apex can be initiated by the following Genesys interaction events:

Genesys Workspace Web Edition events initiating Run Apex
Name Description
Voice channel events
RINGING Inbound call is ringing.
DIALING Outbound call is ringing
ESTABLISHED Call is established
RELEASED Call is released
Digital channels events
INVITED Digital interaction invitation received
ACCEPTED Digital interaction is accepted
CREATED Digital interaction is created
REMOVED Digital interaction is removed

Your Apex class should have one method and accept the following two string parameters: eventName and eventData.

For example:

public class tstapex {  
    public void eventCollector (string eventName, string eventData) {
        String data;
        Map<String, Object> interaction =(Map<String, Object>)JSON.deserializeUntyped(eventData);
        if (eventName == 'RINGING'){
        if (eventName == 'DIALING'){
        if (eventName == 'ESTABLISHED'){
        if (eventName == 'RELEASED'){

        if (eventName == 'INVITED'){
        if (eventName == 'ACCEPTED'){
        if (eventName == 'CREATED'){
        if (eventName == 'REMOVED'){
    data=EncodingUtil.urlDecode(data, 'UTF-8');
    Case c = new Case();
    c.Type = 'ICM';
    c.Origin = 'SHIP';
    c.Status = 'New';
    c.Subject = eventName;
    c.Description = data;
    Insert c;

Examples of how to use the Run Salesforce Apex on interaction events functionality include:

  • Provide Salesforce Alerts to an agent for reminders about how to handle a workflow in Salesforce.
  • Link a newly created Salesforce Case record to the existing (Account, Contact, and so on) record.

Configure which events you want to trigger runApex code by using the Run Salesforce Apex on Interaction Events option in Agent Setup.

Configure the name of the custom Apex Class to execute by using the Apex Class Name option in Agent Setup.

Gplus Adapter can send a list of interaction userData key-value pairs (KVPs) to Salesforce Apex for the specified interaction event. To specify the list of userData key names for voice interactions, configure the Apex Data option in Agent Setup. To specify the event that triggers Salesforce Apex for digital channel interactions, specify the value by configuring the option in the Agent Annex in Agent Setup. Specify one of the following values: INVITED, ACCEPTED, CREATED, or REMOVED.

This feature depends on the Run Salesforce Apex on Interaction Events option being enabled in Agent Setup. When the specified event, such as RINGING, occurs, Gplus Adapter collects the userData KVPs and sends them to the Apex class specified by the Apex Class Name option.

When you configure Apex Data, ensure that the key names that you specify exist in the interaction userData; Gplus Adapter skips non-existent key names. To avoid this situation, either add the key name to the userData, remove non-existent key names from the option, or ensure that Apex properly processes non-existent key names. If an empty list is specified for the value of Apex Data, the original interaction object data is sent to the Apex eventData parameter.

Support for Smart Failover

Gplus Adapter supports Genesys Smart Failover for disaster recovery scenarios. This feature enables you to switch agents automatically to a backup URL configured in Salesforce in the event that the primary URL is inaccessible. After Smart Failover has been configured in Genesys Web Services, configure Smart Failover in your Salesforce deployment.

The Gplus Adapter for Salesforce Agent Guide contains information about the agent experience during Smart Failover scenarios.

If Adapter cannot establish connection to Genesys data center on the primary URL after the configured timeout (Use CTI API) expires, Adapter will attempt to load from the backup URL (CTI Adapter Backup URL). After Adapter loads, Genesys Smart Failover handles disaster recovery events.

Configuring Smart Failover for Gplus Adapter for Salesforce

To perform the following procedure, you need to set up a new call center using an XML file that Genesys provides to you.

Gplus 900 DRCallCenter Config.png

Before you begin, ensure that you have:

  • A Salesforce administrator role account
  • The DR-lightning-callcenter.xml file
  • Host and port information required to specify call center settings. Genesys provides this information to you.


  1. Get the DR-lightning-callcenter.xml file from Genesys and save to a local folder.
  2. Log into with your administrator credentials to open the Home page.
  3. Select Setup.
  4. In the Quick Find field, type Call Center.
  5. Click Call Centers.
  6. Click Import.
  7. Click Choose File and navigate to the folder where you saved the DR-lightning-callcenter.xml file.
  8. Click Import.
  9. Click Edit and fill in the CTI Adapter URL and CTI Adapter Backup URL that Genesys provided to you. Refer to the screen shot for an example of what a configuration looks like. When you paste the URLs that Genesys gives you, add the following parameters to CTI Adapter URL: ?site-1=<GWSHOST from Backup URL>

    Here is an example (NOTE: the URLs in your environment will be different):

    • CTI Adapter URL:
    • CTI Adapter Backup URL

      (reqStandbyUrl) - Represents the location that hosts the backup Adapter URL. The backup Adapter is used after the timeout period has elapsed for the primary Adapter and the notifyInitializationComplete() for Salesforce method hasn’t been called within the required timeout period. When you specify a backup URL, also specify the timeout value in the Use CTI API field.

    • Use CTI API: 30000 (default)

      (reqTimeout) - Represents the time in milliseconds after which the backup URL is used to load Adapter. When you specify a required timeout, also specify the Adapter backup URL in the CTI Adapter Backup URL field.

  10. After you add your disaster recovery call center, you must provision the call center with users. If you have a previous Salesforce Call Center, remove users from that Call Center and add the users to the new call center you just added.


Agent Status Display in Gplus Adapter

Gplus Adapter displays agent status in the Utility Bar whether the Adapter window is minimized or maximized. Agent status is obtained from Agent Workspace. This feature enables agents to monitor their status even when the Adapter window is minimized.

Agent status in Lightning:

GAPI 900 Gplus Status WWE Status.png

Agent status in Classic:

GAPI 900 Gplus Status WWE Status Classic.png

Dock, undock, move, and resize Adapter

By default, the Adapter window launches in the bottom-left corner in the Salesforce Utility Bar (bottom-right corner in Classic).

Agents can undock the Adapter window then move it to a different location. To undock (pop out) the window, they click the Icon pop out.png icon in the top-right corner of the Adapter window and drag it where they want to place it. Once the window is undocked, agents can move or resize the window as needed.

Agents can dock (restore) the window back to its original position by clicking the Icon pop out.png icon.

Interaction Events causing the Adapter window to Maximize

If an agent has minimized Adapter to handle other tasks in Salesforce, the Adapter window is automatically maximized by the following events:

  • Receiving voice, chat, SMS, email, or workitem interactions
  • Releasing interactions
  • Marking Done interactions
  • Receiving connections error notifications
  • Receiving confirmation that an interaction has been added to the Genesys Universal Contact Server (UCS) database

Note: If an agent receives an SMS from an unassigned contact in the Communication tab, the Agent Workspace window will be maximize if it was minimized on SMS invite; however, if the contact in the Communication tab is assigned, no action occurs.

Activity timeout

Gplus Adapter logs an agent out if there has been a period of inactivity. Use the Keep Alive Sync option to prevent the agent from being logged out of Salesforce when there is no activity in Salesforce beyond the configured time period. If enabled, Adapter refreshes the Salesforce session at short intervals and keeps the Adapter-Salesforce session alive. If the browser with Gplus Adapter loaded or the agent's device becomes idle, Keep Alive functionality also becomes idle.

Using Gplus Adapter in multiple browser tabs

Agents can use Gplus Adapter in multiple browser tabs. The following describes how the main Gplus Adapter functions are supported in multiple browser tabs:

  • Click-to-dial: If an agent clicks-to-dial in one Salesforce browser tab, an outbound call is initiated in Adapter in all browser tabs. The agent can continue to handle the interaction in any open browser tab.
  • Screen pop: By default the screen pop is displayed in all browser tabs that are running Gplus Adapter. Screen pop FLOW, screen pop NEW_RECORD_MODAL, and creation and screen pop of new Salesforce record are triggered only in the active tab (refer to Screen pop by Salesforce object type).
  • Activity history: The activity history on interaction Mark Done or Salesforce screen pop is created once for each interaction irrespective of how many browser tabs are running Gplus Adapter.
  • Run Apex: If you have configured Salesforce Run Apex, calls to Run Apex occur in the active browser tab.

Genesys recommends logging in to Adapter in the first browser tab before opening Gplus Adapter in multiple tabs. Before using Adapter in any open browser tab or opening Adapter in a new tab, make sure that Adapter has finished operations in your active page and is fully loaded. Refer to the Agent Workspace Agent Help for more information.

Load Gplus Adapter in only one browser tab

If the user opens Salesforce in multiple browser tabs, Gplus Adapter, by default, automatically loads into each browser tab. If you want Gplus Adapter to open only in one of the browser tabs running Salesforce, enable the Prevent Gplus in Browser Multitab option in Agent Setup to prevent Gplus Adapter from opening in multiple browser tabs.

Salesforce Shield Platform Encryption support

Gplus Adapter supports Salesforce Shield Platform Encryption. Gplus Adapter works with encrypted Salesforce record fields, such as in the following scenarios:

  • Searching Salesforce data for screen pop with record ID, custom fields, or standard fields.
  • Adding data to Salesforce, such as when creating new objects on screen pop or creating Activity Tasks on mark done.
  • Updating Salesforce data when an Activity Task is updated after creation or after mark done.

Salesforce Shield Platform Encryption is also supported when you add your own code to a Flow or to run Apex triggered by Adapter, including code that contains functionality that works with the Salesforce database.

Localization in Gplus Adapter

Gplus Adapter automatically selects the same language that Salesforce is configured to display in, if the language is supported by Agent Workspace; otherwise, Gplus Adapter displays in English. For example, if Salesforce is configured to display in French, then Adapter displays in French.

Refer to Edit Your Language and Locale Settings for information about setting the display language in Salesforce Lightning.

Support for Genesys Softphone

Gplus Adapter functionality supports calls established through Genesys Softphone in Connector mode.

Support for Genesys Interaction Recording

The Gplus Adapter console supports Genesys Interaction Recording (GIR). For an overview of Genesys Interaction Recording, see About Genesys Interaction Recording.

Genesys Interaction Recording is only supported for Voice channel and is not supported when Gplus Adapter is popped out of the Salesforce window.

To configure Genesys Interaction Recording for the Gplus Adapter, see Enable Screen Recording in the Genesys Interaction Recording Solution Guide. In this procedure, refer to the Integrating with Workspace Web Edition section.

To manage the call recording features of an agent, see Recording setup.

Integrating Genesys Universal Contact Server (UCS)

You can enable agents to use Team Communicator to call a contact that is stored in the Universal Contact Server (UCS). You can view the detailed contact information from the Contacts tab. For more information, see Configure global login.

Support for browser-based WebRTC calling

Gplus Adapter supports browser-based WebRTC voice calling. Enable this feature by configuring the WebRTC options in the Voice section in Agent Setup.

Support for Supervisor functions

Gplus Adapter supports supervisor monitoring, coaching, and barging-in of calls handled by agents. While supervisors are performing these functions, the Gplus Adapter features such as Screen Pop occur only on the supervised agent's Gplus Adapter.

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