Latest revision as of 06:53, November 24, 2023

Installing and configuring the adapter in Salesforce - WWE option

Installing the adapter in Salesforce

Prerequisites

You have installed and configured Web Services.
You have set up SSL for Jetty. For more information, see Configure SSL.

The adapter installation procedure involves the following steps:

Creating a Gplus Adapter URL

From the Agent Workspace URL, copy the domain name and substitute it in the following URL:

https://<domain-name>/ui/crm-workspace/index.html?crm=salesforce

Configuring Gplus Adapter for Salesforce - Workspace Web Edition (WWE)

Follow these steps:

Click the gear icon in the top right corner and then click Setup.
Using the Quick Find field, search for and access the Call Centers setup page.
From the Call Center settings page, using the Import functionality, import the crm-workspace-callcenter.xml file from your computer. If you have not already downloaded the file, download it from here.
From the All Call Centers list, click the Call Center you just imported. For example, Gplus85.
From the Call Center Edit page, in the CTI Adapter URL field, specify the Adapter URL that you constructed in the Creating a Gplus Adapter URL section. For example, https://www.genesysgplustest.com/ui/crm-workspace/index.html?crm=salesforce
Set Salesforce Compatibility mode to Classic_and_Lightning.
Save the changes.

Adding users to Call Center

The next step after you setup your Adapter is to add users to your call center. You must add at least one user to your call center.

In the Call Centers setup page, click Manage Call Center Users.
Click Add More Users.
On the Search for New Users page, you can enter search criteria to find users. Select the ones you want to add to the Gplus Adapter for Salesforce - Workspace Web Edition (WWE) option.
Click Add to Call Center.
Your selected users are added to the list. You can remove a user on this page at any time.

Configuring the Utility bar

In the setup page, using the Quick Find field, search for and access the App Manager settings page.
Create a new application by clicking New Lightning App. Follow the steps in the Lightning App creation procedure in Salesforce documentation.
When creating a new Lightning app, follow the additional steps below to configure the utility items for your Gplus Adapter for Salesforce - Workspace Web Edition (WWE).
- In the App Options step, ensure that you select Console Navigation. Gplus Adapter for Salesforce - Workspace Web Edition (WWE) does not support Standard Navigation.
- In the Utility Items step, add Open CTI Softphone by clicking Add Utility Item.
- For the soft phone, you can modify the display properties such as Label, Panel Width, and Panel Height.
- Select Start automatically to start loading the data when the Gplus Adapter first opens to ensure that it initializes immediately; otherwise, Gplus Adapter does not load until an agent first opens it from the Utility Bar. If Gplus Adapter for Salesforce - Workspace Web Edition (WWE) is not initialized immediately, then agents do not receive voice calls until they first open the application.
Specify Navigation Items and User Profiles for the new Lightning app by referring to Salesforce documentation.
Save the application.

Configuring the whitelist domain for your Salesforce Console

Complete this procedure to add the Genesys domain to the whitelist domains for your Salesforce Console. You need to complete this procedure to allow your users to access the adapter in Salesforce Console in a separate browser window.

Start

If you haven't already, login to Salesforce and go to App Setup > Create > Apps and select your console app — "Sample Console" in the image below:
Click Edit. In Whitelist Domains, add the host and port for your installation of Web Services. For example: 198.51.100.23:8090
Click Save.

End

Configuring screen pops in Salesforce

When an agent receives an external call, the adapter can initiate a screen pop that causes Salesforce to show an appropriate record for the caller. To set up this functionality in Salesforce, login and go to Setup > Customize > Call Center > SoftPhone Layouts to create a SoftPhone Layout. Check out the Salesforce documentation for details about configuration.

In general, there are a couple of things to consider when you set up a SoftPhone Layout for the adapter:

The Gplus Adapter for Salesforce ignores the SoftPhone Layout settings that control call-related fields. Instead, the adapter gets this information from toast and case data you configure in the Genesys environment.
Make sure you configure the Screen Pop Settings in the "CTI 2.0 or Higher Settings" section. These settings control whether the screen pop opens in a new window, tab, or Visualforce page.

See Screen pop for more information about configuring screen pops in your Genesys environment.

Accessing Gplus Adapter for Salesforce - WWE Option

Classic Mode

You can access Gplus Adapter in Salesforce Console by clicking the phone icon in the bottom-right corner.

Lightning Mode

You can access Gplus Adapter in Salesforce Lightning by clicking the phone icon in the bottom-left corner.

@@ Line 1: / Line 1: @@
-= Installing and configuring the adapter in Salesforce=
+= Installing and configuring the adapter in Salesforce - WWE option=
 __TOC__
 If you're using the WWE option, complete the procedures on this page to install and configure the adapter in your Salesforce environment.
@@ Line 9: / Line 9: @@
 * [[InstallingAndDeploying|You have installed and configured Web Services.]]
 * You have set up SSL for Jetty<!--Workspace Web Edition & Web Services-->. For more information, see {{#Widget:ExtLink|link=https://wiki.eclipse.org/Jetty/Howto/Configure_SSL|displaytext=Configure SSL}}.
-'''Start'''
-<ol>
-<li>Open the following URL to install the latest Gplus Adapter for Salesforce package in Salesforce: {{#Widget:ExtLink|link=https://login.salesforce.com/packaging/installPackage.apexp?p0=04to0000000C3VD|displaytext=https://login.salesforce.com/packaging/installPackage.apexp?p0=04to0000000C3VD}}
-<br/>
-If you're not logged in, Salesforce prompts for your username and password.
-{{NoteFormat|The Salesforce installation package includes a call center definition. If you need to create additional call centers, you can find the latest call center definition file in the Web Services .war file. To get a copy of the file, navigate to the following URL:
-<tt><nowiki>http://<WS_HOST>:<WS_PORT>/ui/cti/callcenterdef/GPlusForSalesforceCallCenterDef.xml</nowiki></tt>
-*<tt><WS_HOST></tt> is your Web Services host name or IP address.
-*<tt><WS_PORT></tt> is your Web Services port.
-You can save this file locally and then upload to Salesforce to create a new call center. }}
-</li>
-<li>Now you should see the '''Install Genesys Gplus Adapter for Salesforce''' page. Select an installation type. Generally, you should select '''Grant access to all users''', but if you want to limit access to the adapter to specific profiles, then you can choose '''Install for Specific Profiles ...'''. Click '''Install'''.
-<br/><br/>[[File:GplusSFInstall.png|border|center]]<br/></li>
-<li>When you see the "Installation Complete!" message, click '''Done'''.
-<br/><br/>[[File:GplusSFDone.png|border|center]]<br/>
-You should be redirected to the '''Installed Packages''' page, with "Genesys Gplus for Salesforce" included in the list.</li>
-[[File:GplusSFInstalledPackages.png|border|center]]<br/></li>
-</ol>
-'''End'''
-==Configuring the adapter in Salesforce==
+The adapter installation procedure involves the following steps:
-Complete this procedure to define your call center in Salesforce. The call center was created when you installed the Gplus Adapter for Salesforce package.
-<br/><br/>
+#[[{{FULLPAGENAME}}#GplusURL|Creating a Gplus Adapter URL]].
-'''Start'''
+#[[{{FULLPAGENAME}}#ConfigureGplus|Configuring Gplus Adapter for Salesforce - Workspace Web Edition (WWE)]].
-<ol>
+#[[{{FULLPAGENAME}}#AddGplusUsers|Adding users to Call Center]].
-<li>If you haven't already, login to Salesforce and go to '''Setup > Build > Customize > Call Center > Call Centers'''. Or, you can search for "Call Centers" in the '''Search All Setup''' field and select the "Call Centers" result. You should see the '''Introducing Salesforce CRM Call Center''' page. '''Note:''' You must have administrator privileges. </li>
+#[[{{FULLPAGENAME}}#ConfigureGplusUtility|Configuring the Utility bar]].
-<li>You can select '''Don't show me this page again''' if you want to hide the page in the future, and click '''Continue'''. </li>
+#[[{{FULLPAGENAME}}#ConfigureWhitelistDomain|Configuring the whitelist domain for your Salesforce Console]].
-<li>On the '''All Call Centers''' page, click '''Edit''' next to the Genesys Gplus for Salesforce entry.
+#[[{{FULLPAGENAME}}#ConfigureScreenPops|Configuring screen pops in Salesforce]].
-<li>In the '''CTI Adapter URL''' field, replace the text with the following URL: <tt><nowiki>https://</nowiki>''WS_HOST:WS_PORT''<nowiki>/ui/crm-workspace/index.html</nowiki></tt>
+#[[{{FULLPAGENAME}}#AccessGplusWWE|Accessing Gplus Adapter for Salesforce - WWE Option]].
-You'll need to change <tt>''WS_HOST:WS_PORT''</tt> to the correct host and port for your installation of [[InstallingAndDeploying|Web Services]]. For example: <tt><nowiki>https://198.51.100.23:8090/ui/crm-workspace/index.html</nowiki></tt>
-<br/><br/>
+{{AnchorDiv|GplusURL}}
-If you're enabling single sign-on in the adapter, add the <tt>authType=saml</tt> parameter to the '''CTI Adapter URL'''. For example: <tt><nowiki>https://198.51.100.23:8090/ui/crm-workspace/index.html&authType=saml</nowiki></tt></li>
+=== Creating a Gplus Adapter URL ===
-<li>You might also want to adjust '''Softphone Height''' and '''Softphone Width''' to larger numbers (in pixels) so the adapter displays at an adequate size by default.
+From the Agent Workspace URL, copy the domain name and substitute it in the following URL:
-<br/><br/>
-You should leave the other options at their default values so the adapter works correctly in Salesforce.
+<tt>https://<domain-name>/ui/crm-workspace/index.html?crm=salesforce</tt>
-<br/><br/>[[File:GplusADCCDetails.png|border|center]]<br/></li>
-<li>Click '''Save'''.</li>
+{{AnchorDiv|ConfigureGplus}}
-<li>Click '''Manage Call Center Users''' and then click '''Add users'''.
+=== Configuring Gplus Adapter for Salesforce - Workspace Web Edition (WWE) ===
-<br/><br/>[[File:GplusSFAddUser.png|border|center]]<br/></li>
+Follow these steps:
-<li>On the '''Search for New Users''' page, you can enter search criteria to find users. Select the ones you want to be able to use the adapter and click '''Add to Call Center'''.
-<br/><br/>[[File:GplusSFSearchUser.png|border|center]]<br/>
+[[File:CTI_URLConfiguration.png|700px]]
-Your selected users are added to the list. You can remove a user on this page at any time.
+#Click the gear icon in the top right corner and then click '''Setup'''.
-<br/>[[File:GplusSFAddedUsers.png|border|center]]<br/></li>
+#Using the '''Quick Find''' field, search for and access the '''Call Centers setup''' page.
-<li>To access the adapter in Salesforce Console, click the '''Workspace''' button in the bottom right corner.
+#From the '''Call Center''' settings page, using the '''Import''' functionality, import the {{Repository|crm-workspace-callcenter.xml||crm-workspace-callcenter.xml}} file from your computer. If you have not already downloaded the file, download it from {{Repository|crm-workspace-callcenter.xml||here}}.
-<br/><br/>[[File:GplusADServiceCloud.png|thumb|700px|center|The adapter in Salesforce Console.]]<br/>
+#From the '''All Call Centers''' list, click the '''Call Center''' you just imported. For example, Gplus85.
-</li>
+#From the '''Call Center Edit''' page, in the '''CTI Adapter URL''' field, specify the Adapter URL that you constructed in the '''Creating a Gplus Adapter URL''' section. For example, <nowiki>https://www.genesysgplustest.com/ui/crm-workspace/index.html?crm=salesforce</nowiki>
-</ol>
+#Set '''Salesforce Compatibility mode''' to '''Classic_and_Lightning'''.
-'''End'''
+#Save the changes.
+{{AnchorDiv|AddGplusUsers}}
+=== Adding users to Call Center ===
+The next step after you setup your Adapter is to add users to your call center. You must add at least one user to your call center.
+#In the '''Call Centers setup''' page, click '''Manage Call Center Users'''.
+#Click '''Add More Users'''.
+#:[[File:GplusSFAddUser.png|border]]
+#On the '''Search for New Users''' page, you can enter search criteria to find users. Select the ones you want to add to the Gplus Adapter for Salesforce - Workspace Web Edition (WWE) option.
+#Click '''Add to Call Center'''.
+#:[[File:GplusSFSearchUser.png|border]]
+#Your selected users are added to the list. You can remove a user on this page at any time.
+#:[[File:GplusSFAddedUsers.png|border]]
+{{AnchorDiv|ConfigureGplusUtility}}
+=== Configuring the Utility bar ===
+#In the setup page, using the '''Quick Find''' field, search for and access the '''App Manager settings''' page.
+#Create a new application by clicking '''New Lightning App'''. Follow the steps in the [https://trailhead.salesforce.com/en/content/learn/modules/lightning_app_builder Lightning App creation procedure] in Salesforce documentation.
+#When creating a new Lightning app, follow the additional steps below to configure the utility items for your Gplus Adapter for Salesforce - Workspace Web Edition (WWE).
+#:*In the '''App Options''' step, ensure that you select '''Console Navigation'''. Gplus Adapter for Salesforce - Workspace Web Edition (WWE) does not support Standard Navigation.
+#:*In the '''Utility Items''' step, add '''Open CTI Softphone''' by clicking '''Add Utility Item'''.
+#:*For the soft phone, you can modify the display properties such as '''Label''', '''Panel Width''', and '''Panel Height'''.
+#:*Select '''Start automatically''' to start loading the data when the Gplus Adapter first opens to ensure that it initializes immediately; otherwise, Gplus Adapter does not load until an agent first opens it from the '''Utility Bar'''. If Gplus Adapter for Salesforce - Workspace Web Edition (WWE) is not initialized immediately, then agents do not receive voice calls until they first open the application.
+#:[[File:GplusLightUtility.png|700px]]
+#Specify '''Navigation Items''' and '''User Profiles''' for the new Lightning app by referring to Salesforce documentation.
+#Save the application.
-==Configuring the whitelist domain for your Salesforce Console==
+{{AnchorDiv|ConfigureWhitelistDomain}}
+===Configuring the whitelist domain for your Salesforce Console===
 Complete this procedure to add the Genesys domain to the whitelist domains for your Salesforce Console. You need to complete this procedure to allow your users to access the adapter in Salesforce Console in a separate browser window.
 <br/><br/>
@@ Line 70: / Line 78: @@
 '''End'''
-==Configuring screen pops in Salesforce==
+{{AnchorDiv|ConfigureScreenPops}}
+===Configuring screen pops in Salesforce===
 When an agent receives an external call, the adapter can initiate a screen pop that causes Salesforce to show an appropriate record for the caller. To set up this functionality in Salesforce, login and go to '''Setup > Customize > Call Center > SoftPhone Layouts''' to create a SoftPhone Layout. Check out the {{#Widget:ExtLink|link=https://help.salesforce.com/HTViewHelpDoc?id=cti_admin_phonelayoutscreate.htm&language=en_US|displaytext=Salesforce documentation}} for details about configuration.
@@ Line 80: / Line 89: @@
 See [[Documentation:HTCC:IWWDep:GPAB#Screen_pop|Screen pop]] for more information about configuring screen pops in your Genesys environment.
+{{AnchorDiv|AccessGplusWWE}}
+=== Accessing Gplus Adapter for Salesforce - WWE Option===
+==== Classic Mode ====
+You can access Gplus Adapter in Salesforce Console by clicking the phone icon in the bottom-right corner.
+[[File:AccessGplusAdapterinSF.png|750px]]
+====Lightning Mode====
+You can access Gplus Adapter in Salesforce Lightning by clicking the phone icon in the bottom-left corner.
+[[File:AccessGplusAdapterinSFLightning.png|750px]]
 [[Category:V:HTCC:8.5.2DRAFT]]