WikiSysop: Published

2023-01-18T16:26:13Z

Published

Matthew.west@genesys.com: Published

2021-05-27T18:06:33Z

Published

New page

{{Article
|Standalone=No
|DisplayName=Gplus Adapter support for Service Client API
|TocName=Service Client API
|Context=Gplus Adapter supports the Genesys Service Client API, which you can use for custom features.
|ComingSoon=No
|Platform=GenesysCloud
|Role=Administrator
|Section={{Section
|sectionHeading=Support for Service Client API in Salesforce Lightning
|anchor=SCAPI
|alignment=Vertical
|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 Lightning:
<ol><li>[https://trailhead.salesforce.com/en/content/learn/modules/identity_login/identity_login_my_domain Deploy your Salesforce domain.]</li>
<li>[https://developer.salesforce.com/docs/atlas.en-us.pages.meta/pages/message_channel_create.htm Create and deploy a message channel] using Salesforce CLI or a third-party tool such as [https://workbench.developerforce.com/login.php Workbench]. For example, here's a breakdown of the steps you must complete using Workbench:<ol type="a"><li>Create a folder called '''messagedeploy''' and add a new file called '''package.xml''' with the following contents:
<source lang="xml">
<?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> </source></li>
<li>In your '''messagedeploy''' folder, create a new folder called '''messageChannels''' and add a new file called '''GplusChannel.messageChannel''' with the following contents:
<source lang="xml">
<?xml version="1.0" encoding="UTF-8"?>
<LightningMessageChannel xmlns="http://soap.sforce.com/2006/04/metadata">
<masterLabel>GplusChannel</masterLabel>
<isExposed>true</isExposed>
<description>This Lightning Message Channel sends information from VF to LWC and back.</description>
</LightningMessageChannel> </source></li>
<li>Zip (compress) the '''messagedeploy''' folder.</li>
<li>Navigate to https://workbench.developerforce.com/login.php and log in to Salesforce with the account you will use for the Service Client API.</li>
<li>Open the '''migration''' menu, click '''Deploy''' and attach the zip you previously created.</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 {{Repository|gplus-service-client-api.js||here}}  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 the SCAPI example from {{Repository|sample.html||here}}.</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>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.
The value of the '''Salesforce Message Channel Name for Service Client API''' option must be specified using one of the following formats:
<ul><li><tt>NameSpacePrefix_ChannelName__c</tt></li>
<li><tt>ChannelName__c</tt></li>
</ul>
You must use this format to confirm to the Salesforce [https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/custom_fields.htm Naming Conventions for Custom Fields].
'''Troubleshooting:''' If you encounter an error after completing this configuration, Genesys might have to adjust your environment settings so that the value of '''CORS''' is set to <tt>*</tt> the '''Allow full service client API''' setting is enabled. Contact Genesys to confirm these settings.
</li>
<li>To attach key-value pairs to interaction UserData using SCAPI, use the '''{{Link-AnywhereElse|product=PEC-Developer|version=Current|manual=SCAPI|topic=InteractionNamespace|anchor=Methods|display text=interaction.setUserData}}''' Method.</li>
<li>To validate your Gplus Adapter configuration with SCAPI, login to Adapter, navigate to the SCAPI page and click one of the Methods, such as '''agent.get'''. If you see the result message '''SUCCEEDED''', then configuration is correct.</li>
<li>If some SCAPI Methods do not return '''SUCCEEDED''', verify that the Workspace options related to the SCAPI Method functionality are configured correctly.</li>
</ol>
|Status=No
}}{{Section
|sectionHeading=Support for Salesforce Lightning Component with Service Client API
|anchor=LightningComponent
|alignment=Vertical
|structuredtext=Gplus Adapter supports the Salesforce Lightning Component with Service Client API to enable custom integrations between Salesforce and Genesys. To enable this support, complete the following steps:

'''Prerequisites:'''

*[https://trailhead.salesforce.com/en/content/learn/modules/identity_login/identity_login_my_domain Deploy your Salesforce domain.]
*Create and deploy the {{Link-SomewhereInThisVersion|manual=Administrator|topic=GplusServiceClientAPI|anchor=SCAPI|display text=message channel}}.

'''References:'''

*[https://developer.salesforce.com/docs/atlas.en-us.lightning.meta/lightning/message_channel_intro.htm About the message channel in Lightning Aura Components].
*[https://developer.salesforce.com/docs/atlas.en-us.lightning.meta/lightning/message_channel_create.htm How to create a Message Channel].
*[https://developer.salesforce.com/docs/atlas.en-us.lightning.meta/lightning/message_channel_publish.htm How to publish a Message Channel].
*[https://developer.salesforce.com/docs/atlas.en-us.lightning.meta/lightning/message_channel_subscribe.htm How to subscribe to a Message Channel].
*[https://developer.salesforce.com/docs/atlas.en-us.lightning.meta/lightning/message_channel_considerations.htm Lightning Message Service limitations].

<ol>
<li>Download '''gplus-service-client-api-universal.js''' from {{Repository|gplus-service-client-api-universal.js||here}} and add it to your [https://help.salesforce.com/articleView?id=pages_static_resources_create.htm&type=5 static resources in Salesforce].</li>
<li>In Lightning mode open '''Setup > Developer Console'''.
</li>
<li>Create a new Lightning component: '''File > New > Lightning Component'''.</li>
<li>Name the new Lightning component '''ScapiComponent'''.
</li>
<li>Download '''component.html''' from {{Repository|gplus-service-client-api-component.html.zip||here}} and add the code to your component.</li>
<li>Download '''controller.js''' from {{Repository|gplus-service-client-api-controller.js.zip||here}} and add the code to the '''Controller'''.</li>
<li>Download '''style.css''' from {{Repository|gplus-service-client-api-style.css.zip||here}} and add the code to the '''Style'''.</li>
<li>Add your component to console. Open '''Setup > App Manager > <your app> > Edit > App Builder > Utility Items > Add utility Items''' and select '''ScapiComponent'''.</li>
<li>Your result should look something like this:
[[File:Gplus_900_ScapiComponent_Result_Sample.png|600px]]
</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 '''{{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.
The value of the '''Salesforce Message Channel Name for Service Client API''' option must be specified using one of the following formats:
<ul><li><tt>NameSpacePrefix_ChannelName__c</tt></li>
<li><tt>ChannelName__c</tt></li>
</ul>
You must use this format to confirm to the Salesforce [https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/custom_fields.htm Naming Conventions for Custom Fields].
'''Troubleshooting:''' If you encounter an error after completing this configuration, Genesys might have to adjust your environment settings so that the value of '''CORS''' is set to <tt>*</tt> the '''Allow full service client API''' setting is enabled. Contact Genesys to confirm these settings.
</li>
<li>To attach key-value pairs to interaction UserData using SCAPI, use the '''{{Link-AnywhereElse|product=PEC-Developer|version=Current|manual=SCAPI|topic=InteractionNamespace|anchor=Methods|display text=interaction.setUserData}}''' Method.</li>
<li>To validate your Gplus Adapter configuration with SCAPI, login to Adapter, navigate to the SCAPI page and click one of the Methods, such as '''agent.get'''. If you see the result message '''SUCCEEDED''', then configuration is correct.</li>
<li>If some SCAPI Methods do not return '''SUCCEEDED''', verify that the Workspace options related to the SCAPI Method functionality are configured correctly.</li>
</ol>
|Status=No
}}{{Section
|sectionHeading=Support for Service Client API in Salesforce Classic
|anchor=ClassicSCAPI
|alignment=Vertical
|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 Classic:

<ol>
<li>
Download the SCAPI script from {{Repository|service-client-api-classic.js|| here}}.
</li>
<li>
Download the SCAPI example from {{Repository|sample_classic.zip|| here}}.
</li>
<li>
Add '''service-client-api-classic.js''' 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] with SCAPI (according to the SCAPI example) or a custom console component.
</li>
<li>
[https://help.salesforce.com/articleView?id=dashboards_components_edit_lex.htm&type=5 Add the Visualforce page to your dashboard].
</li>
</ol>
|Status=No
}}
}}

@@ Line 78: / Line 78: @@
 <li>Name the new Lightning component '''ScapiComponent'''.
 </li>
-<li>Download '''component.html''' from {{Repository|gplus-service-client-api-component.html.zip||here}} and add the code to your component.</li>
+<li>Download '''component.html''' from {{Repository|gplus-service-client-api-component.html||here}} and add the code to your component.</li>
-<li>Download '''controller.js''' from {{Repository|gplus-service-client-api-controller.js.zip||here}} and add the code to the '''Controller'''.</li>
+<li>Download '''controller.js''' from {{Repository|gplus-service-client-api-controller.js||here}} and add the code to the '''Controller'''.</li>
-<li>Download '''style.css''' from {{Repository|gplus-service-client-api-style.css.zip||here}} and add the code to the '''Style'''.</li>
+<li>Download '''style.css''' from {{Repository|gplus-service-client-api-style.css||here}} and add the code to the '''Style'''.</li>
 <li>Add your component to console. Open '''Setup > App Manager > &lt;your app&gt; > Edit > App Builder > Utility Items > Add utility Items''' and select '''ScapiComponent'''.</li>
 <li>Your result should look something like this:
@@ Line 106: / Line 106: @@
 <ol>
 <li>
-<p>Download the SCAPI script from {{Repository|service-client-api-classic.js|| here}}.<!--<nowiki>https://<HOST>/ui/crm-workspace/build/service-client-api-classic/service-client-api-classic.js</nowiki>--></p>
+<p>Download the SCAPI script from {{Repository|gplus-service-client-api-classic.js|| here}}.<!--<nowiki>https://<HOST>/ui/crm-workspace/build/service-client-api-classic/service-client-api-classic.js</nowiki>--></p>
 </li>
 <li>
-<p>Download the SCAPI example from {{Repository|sample_classic.zip|| here}}.<!--<nowiki>https://<HOST>/ui/crm-workspace/build/service-client-api-classic/sample.html</nowiki>--></p>
+<p>Download the SCAPI example from {{Repository|adapter-scapi-sample-classic.html|| here}}.<!--<nowiki>https://<HOST>/ui/crm-workspace/build/service-client-api-classic/sample.html</nowiki>--></p>
 </li>
 <li>
-<p>Add '''service-client-api-classic.js''' to your [https://help.salesforce.com/articleView?id=pages_static_resources_create.htm&type=5 static resources in Salesforce].</p>
+<p>Add '''gplus-service-client-api-classic.js''' to your [https://help.salesforce.com/articleView?id=pages_static_resources_create.htm&type=5 static resources in Salesforce].</p>
 </li>
 <li>

PEC-GPA/Current/Administrator/GplusServiceClientAPI - Revision history

WikiSysop: Published

Matthew.west@genesys.com: Published