Difference between revisions of "PEC-GPA/Current/Administrator/GPlusGenFeatures"

From Genesys Documentation
Jump to: navigation, search
m (Text replacement - "\|Platforms?=([^\|]*)PureEngage([\|]*)" to "|Platform=$1GenesysEngage-onpremises$2")
(Published)
Line 6: Line 6:
 
|ComingSoon=No
 
|ComingSoon=No
 
|Platform=GenesysEngage-onpremises
 
|Platform=GenesysEngage-onpremises
|Prereq=
 
 
|Section={{Section
 
|Section={{Section
 
|sectionHeading=Agent Status Display in Gplus Adapter
 
|sectionHeading=Agent Status Display in Gplus Adapter
 
|anchor=Status
 
|anchor=Status
 
|alignment=Vertical
 
|alignment=Vertical
|Media=
 
|image=
 
 
|structuredtext=Gplus Adapter displays agent status in the Utility Bar whether the Adapter window is minimized or maximized. Agent status is obtained from Workspace Agent Desktop. This feature enables agents to monitor their status even when the Adapter window is minimized.
 
|structuredtext=Gplus Adapter displays agent status in the Utility Bar whether the Adapter window is minimized or maximized. Agent status is obtained from Workspace Agent Desktop. This feature enables agents to monitor their status even when the Adapter window is minimized.
  
 
[[File:GAPI_900_Gplus_Status_WWE_Status.png|500px]]
 
[[File:GAPI_900_Gplus_Status_WWE_Status.png|500px]]
|structuredtextwide=
 
|FAQHeading=
 
 
|Status=No
 
|Status=No
 
}}{{Section
 
}}{{Section
Line 23: Line 18:
 
|anchor=Dock,undock,move,andresizeAdapter
 
|anchor=Dock,undock,move,andresizeAdapter
 
|alignment=Vertical
 
|alignment=Vertical
|Media=
 
|image=
 
 
|structuredtext=By default, the Adapter window launches in the bottom-left corner in the Salesforce Utility Bar.
 
|structuredtext=By default, the Adapter window launches in the bottom-left corner in the Salesforce Utility Bar.
  
Line 30: Line 23:
  
 
Agents can dock (restore) the window back to its original position by clicking the [[File:icon_pop_out.png|link=]] icon.
 
Agents can dock (restore) the window back to its original position by clicking the [[File:icon_pop_out.png|link=]] icon.
|structuredtextwide=
 
|FAQHeading=
 
 
|Status=No
 
|Status=No
 
}}{{Section
 
}}{{Section
Line 37: Line 28:
 
|anchor=Maximize
 
|anchor=Maximize
 
|alignment=Vertical
 
|alignment=Vertical
|Media=
 
|image=
 
 
|structuredtext=If an agent has minimized Adapter to handle other tasks in Salesforce, the Adapter window is automatically maximized by the following events:
 
|structuredtext=If an agent has minimized Adapter to handle other tasks in Salesforce, the Adapter window is automatically maximized by the following events:
  
Line 46: Line 35:
 
*Receiving connections error notifications
 
*Receiving connections error notifications
 
*Receiving confirmation that an interaction has been added to the Genesys Universal Contact Server (UCS) database
 
*Receiving confirmation that an interaction has been added to the Genesys Universal Contact Server (UCS) database
|structuredtextwide=
 
|FAQHeading=
 
 
|Status=No
 
|Status=No
 
}}{{Section
 
}}{{Section
Line 53: Line 40:
 
|anchor=RunApex
 
|anchor=RunApex
 
|alignment=Vertical
 
|alignment=Vertical
|Media=
+
|structuredtext=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  [https://developer.salesforce.com/docs/atlas.en-us.apexcode.meta/apexcode/apex_dev_guide.htm Salesforce Apex Developer Guide]. Apex can be initiated by the following Genesys interaction events: DIALING, RINGING, ESTABLISHED, and RELEASED.
|image=
 
|structuredtext=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  [https://developer.salesforce.com/docs/atlas.en-us.apexcode.meta/apexcode/apex_dev_guide.htm Salesforce Apex Developer Guide]. Apex can be initiated by the following Genesys interaction events: DIALING, RINGING, ESTABLISHED, and RELEASED.
 
  
 
Your Apex class should have one method and accept the following two string parameters: eventName and eventUserDataContent.
 
Your Apex class should have one method and accept the following two string parameters: eventName and eventUserDataContent.
Line 73: Line 58:
 
*Provide Salesforce Alert to Agent for reminders on how to handle a workflow in Salesforce.
 
*Provide Salesforce Alert to Agent for reminders on how to handle a workflow in Salesforce.
  
Configure which events you want to trigger runApex code by using the '''Run Salesforce Apex on Interaction Events''' option in {{Link-AnywhereElse|product=PEC-AS|version=Current|manual=ManageCC|topic=Salesforce_options|anchor=SFOptions|display text=Agent Setup}}.
+
Configure which events you want to trigger runApex code by using the '''{{Link-AnywhereElse|product=PEC-AS|version=Current|manual=ManageCC|topic=Salesforce_options|anchor=General|display text=Run Salesforce Apex on Interaction Events}}''' option in {{Link-AnywhereElse|product=PEC-AS|version=Current|manual=ManageCC|topic=Salesforce_options|anchor=SFOptions|display text=Agent Setup}}.
  
Configure the name of the custom Apex Class to execute by using the '''Apex Class Name''' option in {{Link-AnywhereElse|product=PEC-AS|version=Current|manual=ManageCC|topic=Salesforce_options|anchor=SFOptions|display text=Agent Setup}}.
+
Configure the name of the custom Apex Class to execute by using the '''{{Link-AnywhereElse|product=PEC-AS|version=Current|manual=ManageCC|topic=Salesforce_options|anchor=General|display text=Apex Class Name}}''' option in {{Link-AnywhereElse|product=PEC-AS|version=Current|manual=ManageCC|topic=Salesforce_options|anchor=SFOptions|display text=Agent Setup}}.
|structuredtextwide=
 
|FAQHeading=
 
 
|Status=No
 
|Status=No
 
}}{{Section
 
}}{{Section
Line 83: Line 66:
 
|anchor=Localization
 
|anchor=Localization
 
|alignment=Vertical
 
|alignment=Vertical
|Media=
 
|image=
 
 
|structuredtext=Gplus Adapter automatically selects the same language that Salesforce is configured to display in, if the language is supported by Workspace Agent Desktop; otherwise, Gplus Adapter displays in English. For example, if Salesforce is configured to display in French, then Adapter displays in French.
 
|structuredtext=Gplus Adapter automatically selects the same language that Salesforce is configured to display in, if the language is supported by Workspace Agent Desktop; otherwise, Gplus Adapter displays in English. For example, if Salesforce is configured to display in French, then Adapter displays in French.
  
 
Refer to  [https://help.salesforce.com/articleView?id=usersetup_lang_time_zone.htm&type=5 Edit Your Language and Locale Settings] for information about setting the display language in Salesforce Lightning.
 
Refer to  [https://help.salesforce.com/articleView?id=usersetup_lang_time_zone.htm&type=5 Edit Your Language and Locale Settings] for information about setting the display language in Salesforce Lightning.
|structuredtextwide=
 
|FAQHeading=
 
 
|Status=Yes
 
|Status=Yes
 
}}{{Section
 
}}{{Section
Line 95: Line 74:
 
|anchor=Recording
 
|anchor=Recording
 
|alignment=Vertical
 
|alignment=Vertical
|Media=
 
|image=
 
 
|structuredtext=The Gplus Adapter console supports Genesys Interaction Recording (GIR). For an overview of Genesys Interaction Recording, see [https://docs.genesys.com/Documentation:CR:Solution:Overview About Genesys Interaction Recording].
 
|structuredtext=The Gplus Adapter console supports Genesys Interaction Recording (GIR). For an overview of Genesys Interaction Recording, see [https://docs.genesys.com/Documentation:CR:Solution:Overview About Genesys Interaction Recording].
  
Line 104: Line 81:
  
 
To manage the call recording features of an agent, see {{Link-AnywhereElse|product=PEC-AS|version=Current|manual=ManageCC|topic=Recording_options|display text=Recording setup}}.
 
To manage the call recording features of an agent, see {{Link-AnywhereElse|product=PEC-AS|version=Current|manual=ManageCC|topic=Recording_options|display text=Recording setup}}.
|structuredtextwide=
 
|FAQHeading=
 
 
|Status=No
 
|Status=No
 
}}{{Section
 
}}{{Section
Line 111: Line 86:
 
|anchor=SCAPI
 
|anchor=SCAPI
 
|alignment=Vertical
 
|alignment=Vertical
|Media=
 
|image=
 
 
|structuredtext=Gplus Adapter supports the {{Link-AnywhereElse|product=PEC-Developer|version=Current|manual=SCAPI|display text=Service Client API}}, which you can use for custom features such as invoking click-to-email, starting or stopping a recording when a sensitive field is on the screen, and attaching data from Salesforce to Genesys key/value pairs. Complete the following steps in Salesforce:
 
|structuredtext=Gplus Adapter supports the {{Link-AnywhereElse|product=PEC-Developer|version=Current|manual=SCAPI|display text=Service Client API}}, which you can use for custom features such as invoking click-to-email, starting or stopping a recording when a sensitive field is on the screen, and attaching data from Salesforce to Genesys key/value pairs. Complete the following steps in Salesforce:
 
<ol><li>[https://trailhead.salesforce.com/en/content/learn/modules/identity_login/identity_login_my_domain Deploy your Salesforce domain.]</li>
 
<ol><li>[https://trailhead.salesforce.com/en/content/learn/modules/identity_login/identity_login_my_domain Deploy your Salesforce domain.]</li>
Line 138: Line 111:
 
<li>Open the '''info''' menu, click '''Metadata Types & Components''' and choose '''LightningMessageChannel''' - you created this in step 2-a.</li></ol></li>
 
<li>Open the '''info''' menu, click '''Metadata Types & Components''' and choose '''LightningMessageChannel''' - you created this in step 2-a.</li></ol></li>
 
<li>Download '''gplus-service-client-api.js''' from <tt>https://[YOUR_HOST]/ui/crm-workspace/build/service-client-api/gplus-service-client-api.js</tt> and add it to your [https://help.salesforce.com/articleView?id=pages_static_resources_create.htm&type=5 static resources in Salesforce].</li>
 
<li>Download '''gplus-service-client-api.js''' from <tt>https://[YOUR_HOST]/ui/crm-workspace/build/service-client-api/gplus-service-client-api.js</tt> and add it to your [https://help.salesforce.com/articleView?id=pages_static_resources_create.htm&type=5 static resources in Salesforce].</li>
<li>[https://help.salesforce.com/articleView?id=pages_creating.htm&type=5 Create a Visualforce page] in Salesforce that uses your new message channel and the Service Client API to implement your custom functionality.</li>
+
<li>[https://help.salesforce.com/articleView?id=pages_creating.htm&type=5 Create a Visualforce page] in Salesforce that uses your new message channel (from step 2-b) and the Service Client API to implement your custom functionality.</li>
 
<li>[https://help.salesforce.com/articleView?id=dashboards_components_edit_lex.htm&type=5 Add the Visualforce page to your dashboard].</li>
 
<li>[https://help.salesforce.com/articleView?id=dashboards_components_edit_lex.htm&type=5 Add the Visualforce page to your dashboard].</li>
<li>In Agent Setup, {{Link-AnywhereElse|product=PEC-AS|version=Current|manual=ManageCC|topic=Salesforce_options|display text=configure Gplus Adapter to use your message channel}} with the '''Salesforce Message Channel Name for Service Client API''' option.</li></ol>
+
<li>In Agent Setup, {{Link-AnywhereElse|product=PEC-AS|version=Current|manual=ManageCC|topic=Salesforce_options|display text=configure Gplus Adapter to use your message channel}} with the '''{{Link-AnywhereElse|product=PEC-AS|version=Current|manual=ManageCC|topic=Salesforce_options|anchor=General|display text=Salesforce Message Channel Name for Service Client API}}''' option.</li></ol>
|structuredtextwide=
+
|Status=No
|FAQHeading=
 
|Status=Yes
 
 
}}{{Section
 
}}{{Section
 
|sectionHeading=Support for browser-based WebRTC calling
 
|sectionHeading=Support for browser-based WebRTC calling
 
|anchor=WebRTC
 
|anchor=WebRTC
 
|alignment=Vertical
 
|alignment=Vertical
|Media=
 
|image=
 
 
|structuredtext=Gplus Adapter supports browser-based WebRTC voice calling. **'''NOTE:''' Refer to WebRTC docs from Bill Mitchell** Enable this feature by configuring the {{Link-AnywhereElse|product=PEC-AS|version=Current|manual=ManageCC|topic=Voice_options|display text=WebRTC options}} in the '''Voice''' section in Agent Setup.
 
|structuredtext=Gplus Adapter supports browser-based WebRTC voice calling. **'''NOTE:''' Refer to WebRTC docs from Bill Mitchell** Enable this feature by configuring the {{Link-AnywhereElse|product=PEC-AS|version=Current|manual=ManageCC|topic=Voice_options|display text=WebRTC options}} in the '''Voice''' section in Agent Setup.
|structuredtextwide=
+
|Status=No
|FAQHeading=
 
|Status=Yes
 
 
}}
 
}}
 
}}
 
}}
 
<!---->
 
<!---->

Revision as of 19:01, July 16, 2020

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.

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 Workspace Agent Desktop. This feature enables agents to monitor their status even when the Adapter window is minimized.

GAPI 900 Gplus Status WWE Status.png

Dock, undock, move, and resize Adapter

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

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, 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

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: DIALING, RINGING, ESTABLISHED, and RELEASED.

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

For example:

public class TestApex {public void eventCollector (

string eventName, string eventData) { …

…… }

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

  • Create Salesforce Case with user data from an interaction.
  • Provide Salesforce Alert to Agent for reminders on how to handle a workflow in Salesforce.

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.

Localization in Gplus Adapter

Gplus Adapter automatically selects the same language that Salesforce is configured to display in, if the language is supported by Workspace Agent Desktop; 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 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.

Support for Service Client API

Gplus Adapter supports the Service Client API, which you can use for custom features such as invoking click-to-email, starting or stopping a recording when a sensitive field is on the screen, and attaching data from Salesforce to Genesys key/value pairs. Complete the following steps in Salesforce:

  1. Deploy your Salesforce domain.
  2. Create and deploy a message channel using Salesforce CLI or a third-party tool such as Workbench. For example, here's a breakdown of the steps you must complete using Workbench:
    1. Create a folder called messagedeploy and add a new file called package.xml with the following contents:
      <?xml version="1.0" encoding="UTF-8"?>
      <Package xmlns="http://soap.sforce.com/2006/04/metadata">
          <types>
              <members>*</members>
              <name>LightningMessageChannel</name>
          </types>
          <version>47.0</version>
      </Package>
    2. In your messagedeploy folder, create a new folder called messageChannels and add a new file called GplusChanel.messageChannel with the following contents:
      <?xml version="1.0" encoding="UTF-8"?>
      <LightningMessageChannel xmlns="http://soap.sforce.com/2006/04/metadata">
          <masterLabel>GplusChanel</masterLabel>
          <isExposed>true</isExposed>
          <description>This Lightning Message Channel sends information from VF to LWC and back.</description>
      </LightningMessageChannel>
    3. Zip (compress) the messagedeploy folder.
    4. Navigate to https://workbench.developerforce.com/login.php and log in to Salesforce with the account you will use for the Service Client API.
    5. Open the migration menu, click Deploy and attach the zip you previously created.
    6. Open the info menu, click Metadata Types & Components and choose LightningMessageChannel - you created this in step 2-a.
  3. Download gplus-service-client-api.js from https://[YOUR_HOST]/ui/crm-workspace/build/service-client-api/gplus-service-client-api.js and add it to your static resources in Salesforce.
  4. Create a Visualforce page in Salesforce that uses your new message channel (from step 2-b) and the Service Client API to implement your custom functionality.
  5. Add the Visualforce page to your dashboard.
  6. In Agent Setup, configure Gplus Adapter to use your message channel with the Salesforce Message Channel Name for Service Client API option.

Support for browser-based WebRTC calling

Gplus Adapter supports browser-based WebRTC voice calling. **NOTE: Refer to WebRTC docs from Bill Mitchell** Enable this feature by configuring the WebRTC options in the Voice section in Agent Setup.


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