Genesys Documentation - User contributions [en]

ATC/PureEngagePrereqs

2019-05-07T07:39:28Z

Ejoyce: Reverted edits by Ejoyce (talk) to last revision by DannaShirley

{{ArticleUnstructured
|DisplayName=Prerequisites for PureEngage Hybrid Deployments
|Platform=PureEngage
|TocName=PureEngage Prerequisites
|Context={{MINTYDOCSPRODUCT}} has specific prerequisites <span>for PureEngage hybrid deployments</span>.
|Section={{Section
}}
}}
==Genesys prerequisites==
{{NoteFormat|The following table shows the '''minimum''' versions of the Genesys components that are required for use with {{MINTYDOCSPRODUCT}}.|1}}
{| class="wikitable"
|-
! Genesys Component!! Version !! Notes
|-
| Framework || 8.5.1 || Configuration Server, LCA, Message Server, Solution Control Server
|-
| Widgets || 9.0 || 9.0.002.06 minimum
|-
| Pacing Service || 9.0 ||
|-
| Stat Server || 8.5.1 || 8.5.104.20 minimum
|-
| Workspace Desktop Edition || 8.5.1 ||
|-
| Genesys Mobile Services || 8.5.1 || 8.5.2 Highly Recommended
|-
| Chat || 8.5.1 || 8.5.105 minimum, 8.5.109+ recommended
|}
{{#css:
button#version-dropdown { display: none; }
}}

ATC/PureEngagePrereqs

2019-05-07T07:38:08Z

Ejoyce: undefined (Saved using "Save and continue" button in form)

{{ArticleUnstructured
|DisplayName=Prerequisites for PureEngage Hybrid Deployments
|Platform=PureEngage
|TocName=PureEngage Prerequisites
|Context={{MINTYDOCSPRODUCT}} has specific prerequisites <span>for PureEngage hybrid deployments</span>.
|Section={{Section
}}
}}
==Genesys prerequisites==
{{NoteFormat|The following table shows the '''minimum''' versions of the Genesys components that are required for use with {{MINTYDOCSPRODUCT}}.|1}}
{| class="wikitable"
|-
! Genesys Component!! Version !! Notes
|-
| Framework || 8.5.1 || Configuration Server, LCA, Message Server, Solution Control Server
|-
| Widgets || 9.0 || 9.0.002.06 minimum
|-
| Pacing Service || 9.0 ||
|-
| Stat Server || 8.5.1 || 8.5.104.20 minimum
|-
| Workspace Desktop Edition || 8.5.1 ||
|-
| Genesys Mobile Services || 8.5.1 || 8.5.2 Highly Recommended
|-
| Chat || 8.5.1 || 8.5.133.02 minimum
|}
{{#css:
button#version-dropdown { display: none; }
}}

ATC/Current/WDEPlugin/Configure GenAdmin

2018-11-06T09:36:37Z

Ejoyce:

{{ArticleUnstructured
|DisplayName=Configure the Altocloud Plugin for Workspace Desktop Edition
|Platform=PureEngage
|TocName=Configure the plugin
|Context=Configure the Altocloud plugin for Workspace Desktop Edition.
}}
=Configure the Altocloud Plugin for Workspace Desktop Edition
{{NoteFormat|'''Prerequisite''': To configure the Altocloud Plugin for Workspace Desktop Edition, you need the Altocloud Plugin Installation Package. The installation package contains the application template files that Genesys Administrator uses to create the configuration.}}

To configure the Altocloud Plugin with Genesys Administrator:
# [[#create_template_ga|Create the Altocloud Plugin application template]]
# [[#config_options_ga|Set Altocloud configuration options]]
# [[#role_priv_ga|Set Altocloud role privileges for Interaction Workspace users]]

{{AnchorDiv|create_template_ga}}
==1. Create the Altocloud Plugin application template==
The Altocloud Plugin application template allows you to associate PureEngage users to the new roles and permissions that are specific to the Altocloud Plugin for Workspace Desktop Edition.

In Genesys Administrator, import the Altocloud Plugin application template from the Altocloud Installation Package. The Altocloud Installation Package provides the following:
* Altocloud_plugin_Workspace_Desktop_Edition_900.apd. This is the application template file.
* Altocloud_plugin_Workspace_Desktop_Edition_900.xml. This is the metadata file.

For more information, see ''Importing Application Templates'' and ''Importing Application Metadata'' in [https://docs.genesys.com/Documentation/GA/8.5.2/user/CfgAppPrototype Application Templates].

{{AnchorDiv|config_options_ga}}
==2. Set Altocloud configuration options for Workspace Desktop Edition==
When you imported the application template, application options were also imported. Each application option has a default value that you need to set for your organization. These options allow the Altocloud Plugin to authenticate with Altocloud servers to display customer journey data in Workspace Desktop Edition.

To configure Workspace Desktop Edition to work with Altocloud, set the Altocloud options within the Workspace Desktop Edition application options. The quickest way to do this is to export the Altocloud option and then import them into the Workspace Desktop Edition options.

{{NoteFormat|'''Prerequisite''': Before you set the following options, create an OAuth application in Altocloud that grants PureEngage access to Altocloud data. For information on how to create an OAuth application, see {{#mintydocs_link:manual=AdminGuide|topic=OAuth_Client_settings|link text=Create an OAuth client}}.|1}}

===Export application options===
# In the Altocloud application template, click the '''Options''' tab.
#: [[File:Options.png|large|]]
# Click '''Export'''.
# Click '''Conf/Cfg''' and then click '''Export'''.
#: [[File:Export options.png|large]]

===Import the Altocloud options into Workspace Desktop Edition===
# Open Environment -> Applications. Open Workspace Desktop Edition.
# Click the '''Options''' tab.
# Click '''Choose File'''.
#: [[File:Choose file options.png|large]]
# At the prompt, click '''Yes''' to overwrite pre-existing Altocloud options.
#: [[File:Import prompt.png|large]]
# In the Configuration Options Import dialog box, click '''Add'''.
#: [[File:Uploader.png|large]]
# Select the file that was created when you exported the Altocloud options.
# Type "altocloud" into the options name filter to display the newly added Altocloud options.
# Configure the imported Altocloud options with your organization credentials. For information on each option, see [[#ConfigOptionsDefined|Configuration options]].

{{AnchorDiv|ConfigOptionsDefined}}
===Configuration options===
{| class="genesystable"| width="100%”
! width= "20%"|Option
! width= "40%"|Description
! width= "40"|Notes

|-
| altocloud.client-id
| Use the Client ID value of the OAuth application {{#mintydocs_link:manual=AdminGuide|topic=OAuth_Client_settings|link text=that you created for PureEngage}}.
| This allows the client to be authenticated to the Altocloud server.

|-
| altocloud.client-secret
| Use the Client Secret value of the OAuth application {{#mintydocs_link:manual=AdminGuide|topic=OAuth_Client_settings|link text=that you created for PureEngage}}.
| This allows the client to be authenticated to the Altocloud server.

|-
| altocloud.region
| The region of the Altocloud Organization
| | Value for your region can be found at [https://all.docs.genesys.com/ATC/Draft/Developers/Regions Altocloud Region Values] page. If you do not know your region, contact [mailto:customercare@genesys.com customercare@genesys.com].

|-
| altocloud.gadget-uri
| This is where the Altocloud gadgets are hosted. This has a default value within the options template that will work for any configuration
|

|-
| altocloud.organization-id
| This is a unique ID assigned by Genesys.
| If you do not know your organization ID, contact [mailto:customercare@genesys.com customercare@genesys.com].

|-
| altocloud.proxy-address
| Set this option accordingly if you require the use of proxy server to access Internet resources.
| This is optional setting for organizations who need a proxy to access the Altocloud functionality.

|-
| altocloud.proxy-username
| User name used to access the proxy (if applicable)
| This is optional setting for organizations who need a proxy to access the Altocloud functionality.

|-
| altocloud.proxy-password
| Password of the proxy, if applicable
| This is optional setting for organizations who need a proxy to access the Altocloud functionality.
|}

{{AnchorDiv|role_priv_ga}}
==3. Set Altocloud role privileges for Workspace Desktop Edition users==
Altocloud role privileges allow agents to use the Altocloud Plugin based on their assigned roles within Genesys Administrator. After you create the application template, you see the Altocloud role privileges when you configure a role in Genesys Administrator. They appear under the "''Workspace''" product.

[[File:ATCRoles.png|large|]]

To configure your Workspace Desktop Edition with roles and privileges for agents, see [https://docs.genesys.com/Documentation/IW/latest/Dep/SettingUpAgentsOnTheSystem Creating a Role and allowing a Workspace privilege and assigning a Role to an agent or agent group].

After you successfully create the Altocloud application template, Altocloud role privileges appear under "'''Altocloud Plug-in Case Gadgets Privileges'''". To see the description of a role, click the arrow to the left of its row.

ATC/Current/AdminGuide/DeployTrackingSnippet

2018-11-06T09:24:58Z

Ejoyce:

{{Article
|DisplayName=Deploy the tracking snippet
|Platform=PureEngage, PureConnect, PureCloud
|TocName=Deploy the tracking snippet
|Context=Deploy the Altocloud tracking snippet to enable visitor tracking on your website.
|Section={{Section
|sectionHeading=About the tracking snippet
|anchor=AboutSnippet
|Type=Unstructured
|freetext=The following code is the Altocloud tracking snippet that enables you to track visitor activity on your webpages.

<source lang="javascript">
<script>
(function(a,t,c,l,o,u,d){a['_genesysJourneySdk']=o;a[o]=a[o]||function(){
(a[o].q=a[o].q||[]).push(arguments)},a[o].l=1*new Date();u=t.createElement(c),
d=t.getElementsByTagName(c)[0];u.async=1;u.src=l;d.parentNode.insertBefore(u,d)
})(window, document, 'script', 'https://app.genesys.cloud/journey/sdk/js/web/v1/ac.js', 'ac');
ac('init', 'YOUR-ORGANIZATION-ID', { datacenter: 'YOUR-ORGANIZATION-REGION' });
ac('pageview');
</script>
</source>
}}{{Section
|sectionHeading=Prerequisites
|anchor=prerequisites
|Type=Unstructured
|freetext=In order to deploy the Altocloud tracking snippet on your website, you will need:
* Your organization ID
* Your organization region. A list of regions and their values can be found at [https://all.docs.genesys.com/ATC/Draft/Developers/Regions Altocloud Regions]. If you do not know which region your organization is in, contact [mailto:customercare@genesys.com customercare@genesys.com]
}}{{Section
|sectionHeading=Use a tag management system
|anchor=DeploySnippetTagMgmt
|Type=Structured
|alignment=Vertical
|structuredtext=To easily deploy the tracking snippet, use a tag management system such as Google Tag Manager, Tealium, Adobe, and any others that provide the option to add custom JavaScript code.
|fullwidth=No
}}{{Section
|sectionHeading=Use the Admin UI
|anchor=DeploySnippetAdminUI
|Type=Structured
|alignment=Vertical
|structuredtext=The Altocloud Admin UI also provides a way to copy and paste the tracking snippet.
# Copy and paste the code from this article, or go to '''Settings> Account Settings'''. <br />
# On the '''Tracking Code''' tab, copy the code.
# Paste the tracking snippet at the top of your website template page before the closing <tt></tt> tag. <br />
# Pass the correct variable from consent gadget to ensure that you do not load the Altocloud tracking snippet unless the visitor provides consent to be tracked. <br />
# Supply your organization ID and your Genesys data center.
{{NoteFormat|<br />
* The last argument in the Altocloud tracking snippet is <tt>'ac'</tt>. If your webpage or any third-party JavaScript uses this variable name globally, pass a custom value.<br />
* When you call <tt>`ac`</tt>, the commands after it, such as <tt>init</tt>, <tt>pageview</tt>, and so on, are queued. When the website template file is completely downloaded, the queued commands are executed.|1}}
|fullwidth=No
}}
}}

File:Uploader.png

2018-10-26T15:28:31Z

Ejoyce:

File:Import prompt.png

2018-10-26T15:28:12Z

Ejoyce:

File:Export options.png

2018-10-26T15:27:33Z

Ejoyce:

File:Choose file options.png

2018-10-26T14:54:51Z

Ejoyce: