Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 9 Current »


Overview

There are three different integrations between Genesys Cloud and eMite - Application, Data, and Users.

  • The Application Integration describes the configuration of eMite as an App within Genesys Cloud and shared user authentication for SSO functionality.

  • The Data Integration describes the configuration of OAuth credentials within Genesys Cloud for access to Genesys Cloud APIs and Notification Service.

  • The Users Integration describes the configuration of Genesys Cloud groups for shared permissions and data visibility within eMite.


Custom Application Configuration

This guide is intended for a Genesys Cloud Administrator and requires Admin privileges within Genesys Cloud.

Integration Checkpoint

All configuration items configured below must be sent to eMite using the Genesys Cloud Integration Details Form.


Generic Integration Information

Genesys Cloud Region

Your Genesys Cloud region will determine the URLs used in the integrations between eMite and Genesys Cloud. If you do not know your region, please refer to your login URL to determine the corresponding region, as below:

Login Domain

Region Name

Region Code

login.mypurecloud.com.au

Asia Pacific (Sydney)

au

login.mypurecloud.jp

Asia Pacific (Tokyo)

jp

login.mypurecloud.ie

EMEA (Dublin)

eu

login.mypurecloud.de

EMEA (Frankfurt)

eucentral

login.euw2.pure.cloud

EMEA (London)

uk

login.mypurecloud.com

Americas (US East)

useast

login.usw2.pure.cloud

Americas (US West)

uswest

login.cac1.pure.cloud

Canada (Central Canada)

cnd

login.mec1.pure.cloud

Middle East (UAE)

me

Organization Short Name

The Organization short name is stored in the Account settings. It is a unique name which is used to identify the Genesys Cloud organization.

1. Login to Genesys Cloud and select Admin.

2. Under Account Settings, click Organization Settings.

3. The Organization short name is listed on the Organization Details tab.

Your Organization Short Name is always in lowercase, and should not contain any special characters or spaces.

Application Redirect URL

To configure Single Sign-On between Genesys Cloud and eMite, you will need to provide an authorized redirect URL.

This URL will be determined by your Region Code and Organization Short Name. The URL will be in the form:

https://<RegionCode>-cloud.emite.com/emite/<organizationShortName>/Auth/OAuthPureCloud?org=<organizationShortName> 

This is a case sensitive URL. Ensure that this is configured correctly.

Generic Integration Checkpoint

These details can now be sent to eMite:

  • Organization Short Name

  • Application Redirect URL


Application Integration

The following processes are required to create an application integration within Genesys Cloud for eMite:

  • Genesys Cloud user group for application access

  • Application link in Genesys Cloud Apps menu

  • OAuth Client for SSO Authentication


Create Access Group

1. Select Admin from Genesys Cloud main menu.

2. Under Directory, click Groups.

3. Click Add Group and add the following groups:

  • Name: emite_Access

  • Type: Official

  • Visibility: Public

This group will be used to provide access to the eMite application.

Assign Users to Groups

1. Select Admin from Genesys Cloud main menu.

2. Under Directory, click Groups.

3. Search the group name that you would like to add users.

4. Under Group Details tab, select Edit.

5. Input the name of each user that you want to add to the group in the Add User field.

6. Click Save.


Create Custom Client Application

1. Select Admin from Genesys Cloud main menu.

2. Under Integrations, click Integrations.

3. Click (plus) Integrations

4. In Custom Client Application, click Install.

5. Under Details tab, set the Name to "eMite Advanced Analytics".

6. Set Status to Active.

7. Select Yes in the Change Status prompt.

8. Select the Configuration tab, and complete configuration as follows:

  • Application URL: This will be in the format https://<RegionCode>-cloud.emite.com/emite/<organizationShortName>/Auth/OAuthPureCloud?org=<organizationShortName> as defined in General Integration Information above.

  • Application Type: select Standalone

  • Application Category: <blank>

  • Iframe Sandbox Options: allow-scripts, allow-same-origin, allow-forms, allow-modals, allow-popups, allow-downloads

  • Group Filtering: Add the emite_Access group created above

9. Click Save.


Create OAuth Client

1. Select Admin from Genesys Cloud main menu.

2. Under Integrations, Click OAuth.

3. Click Add Client.

4. Fill in the following fields:

  • App Name: emite_SSO

  • Description: <leave blank> (This is an extended field to provide a more detailed description if desired)

  • Token Duration: 86400 (default value; equal to 24 hours)

  • Grant Types: Select Code Authorization

  • Authorized Redirect: This is the eMite redirect URL as described above

  • Add Scopes: authorization:readonly, groups:readonly, integrations:readonly, oauth:readonly, organization:readonly, user:readonly

5. Click Save. The following should be presented:

  • Client ID: This is the OAuth Client ID that is required by eMite

  • Client Secret: This is the OAuth Client Secret that is required by eMite

Application Integration Checkpoint

These details can now be sent to eMite:

  • emite_SSO OAuth Client ID

  • emite_SSO OAuth Client Secret


Data Integration

The following processes are required for data integration between Genesys Cloud and eMite:

  • Genesys Cloud Role for OAuth permissions

  • OAuth Client for API Polls (Historical data)

  • OAuth Client for Notification Subscription (Real-time data)

  • Optional OAuth Clients for WFM data


Create an eMite Adapter Role

1. Log on to Genesys Cloud and select Admin.

2. Under People & Permissions, click Roles / Permissions.

3. Click Add Role.

4. Under Role Details tab, set the Name to “eMite Data Integration”.

5. Click the Permissions tab and assign permissions defined in the table below.

  • Input the permission name in the Permission search field.

  • Select the checkbox for the required permission level.

The account being used to assign these permissions to the OAuth credential must already have these permissions assigned to itself.

6. Once all the permissions have been selected, click Save.

All Outbound Permissions listed must be selected, even if your organization does not use outbound campaigns.

#

Type

Permission Name

Permission Level

1

Analytics

Conversation Detail

View

2

Analytics

Conversation Aggregate

View

3

Analytics

Conversation properties

All Permissions

4

Analytics

Evaluation Aggregate

View

5

Analytics

Queue Observation

View

6

Analytics

User Aggregate

View

7

Analytics

User Detail

View

8

Analytics

User observation

View

9

Analytics

Flow Aggregate

View

10

Analytics

Survey Aggregate

View

11

Architect

Flow

View

12

Authorization

Grant

View

13

Directory

User

View

14

Directory

User profile

View

15

External Contacts

Contact

View

16

Outbound

Campaign sequence

View

17

Outbound

Campaign

View

18

Outbound

Contact list

View

19

Outbound

Contact

View

20

Outbound

Response set

View

21

Outbound

Wrap up code mapping

View

22

Routing

Queue

View

23

Routing

Queue

Join

24

Routing

Queue

Search

25

Routing

Wrap up code

View

26

Quality

Evaluation Form

View

27

Quality

Evaluation

View

28

Quality

Survey

View

29

WFM

Agent

View

30

WFM

Agent

Edit

31

WFM

Historical Adherence

View

32

WFM

Realtime Adherence

View

33

WFM

Adhoc Forecast

View

34

WFM

Agent Schedule

View

35

WFM

Intraday

View

36

WFM

Agent Schedule Notification

View

37

WFM

Activity Code

View

38

WFM

Management Unit

View

39

WFM

Management Unit

Edit

40

WFM

Time Off Request

View

7. Add the newly created eMite Data Integration role to yourself.

  • Navigate to Admin → People & Permissions → People

  • Search and select your User Name

  • Select the Roles tab

  • Select View All roles

  • Search for the eMite Adapter role

  • Toggle the Assigned button to assign it to yourself

  • Click Save

Unless you have assigned the role to yourself, you will not be able to assign it to any OAuth later in the process.


Create OAuth Client for API Integration (Historical Data)

1. Select Admin from the Genesys Cloud main menu.

2. Under Integrations, click OAuth.

3. Click Add Client.

4. Fill out the following fields:

  • App Name: emite_APIdata

  • Description: <leave blank> (This is an extended field to provide a more detailed description if desired)

  • Token Duration: 86400 (default value; equal to 24 hours)

  • Grant Types: Select Client Credentials

5. Select Role tab.

6. Enable the eMite Data Integration role that you created previously.

7. Add All Divisions to the enabled role.

8. Go back to Client Details tab.

9. Click Save and the following should be presented:

  • Client ID: This is the OAuth Client ID that is required by eMite

  • Client Secret: This is the OAuth Client Secret that is required by eMite

Data Integration Checkpoint

These details can now be sent to eMite:

  • emite_APIdata OAuth Client ID

  • emite_APIdata OAuth Client Secret


OAuth Client for Genesys Cloud Channel Subscription (Real-time data)

1. Select Admin from the Genesys Cloud main menu.

2. Under Integrations, click OAuth.

3. Click Add Client.

4. Fill out the following fields:

  • App Name: emite_RealtimeData

  • Description: <leave blank> (This is an extended field to provide a more detailed description if desired)

  • Token Duration: 86400 (default value; equal to 24 hours)

  • Grant Types: Select Client Credentials

5. Select Role tab.

6. Enable the eMite Data Integration role that you created previously.

7. Add All Divisions to the enabled role.

8. Go back to Client Details tab.

9. Click Save and the following should be presented:

  • Client ID: This is the OAuth Client ID that is required by eMite

  • Client Secret: This is the OAuth Client Secret that is required by eMite

Data Integration Checkpoint

These details can now be sent to eMite:

  • emite_RealtimeData OAuth Client ID

  • emite_RealtimeData OAuth Client Secret


OPTIONAL: OAuth Clients for Genesys Cloud WFM

These additional OAuth Clients are only required if your Organization is using Genesys Cloud WFM.

There are two different modules used by eMite to poll Workforce Management data in order to cover scheduling and adherence. This requires that two separate OAuth Clients are generated for use with WFM, as outlined in the previous 2 sections.

  1. One additional OAuth for API Integration (i.e. Historical) - named emite_WFMLookback

  2. One additional OAuth for Channel Subscription (i.e. Real-time) - named emite_WFMActivity


User Integration

Create Groups

1. Select Admin from Genesys Cloud main menu.

2. Under Directory, click Groups.

3. Click Add Group and add the following groups:

  • Name: emite_DashboardViewer Members of this group will be able to only view dashboard pages & reports within eMite.

  • Type: Official

  • Visibility: Public

Note: Users that are added to the _DashboardViewer group will get access to see the Out-Of-The-Box wallboards and dashboards provided in eMite.

  • Name: emite_DashboardCreator Members of this group will be able to view, edit, and create dashboard pages & reports within eMite.

  • Type: Official

  • Visibility: Public

Note: Users that are added to the _DashboardCreator group will be able to create, edit, and share additional wallboards and dashboards in eMite.

Assign Users to Groups

1. Select Admin from Genesys Cloud main menu.

2. Under Directory, click Groups.

3. Search the group name that you would like to add users.

4. Under Group Details tab, select Edit.

5. Input the name of each user that you want to add to the group in the Add User field.

6. Click Save.

The ability for your users to access the Advanced Analytics dashboards is determined by their membership to the group names which are specified here. If you make any changes to these group names, please contact emitesupport@prophecyinternational.com

User Integration Checkpoint

All configuration items configured above must be sent to eMite using the Genesys Cloud Integration Details Form.

  • Full names for all emite groups created


Assign eMite Roles and Permissions

The eMite application onboards data for every agent in your Genesys Cloud Organization. It utilizes a data onboarding license which is tracked using the integration > emiteApps > View Genesys Cloud permission.
This means that every agent that eMite collects data for must have the integration > emiteApps > View permission assigned, no matter how many users actually access the eMite dashboards.

It is a data onboarding license, rather than an application access license.

There are currently two methods to add the eMite permission to all of your agents:

1) The Manual Method:

  1. Create a division specific Role for each Division that is utilizing eMite, using the format eMite_DivisionName (if it does not already exist). In the example screenshot above, the role would be named eMite_Home.

  2. Add the integration > emiteApps > View permission to the above role.

  3. Assign the above role to all agents (Genesys Cloud 1, 2 or 3 users) in the division.

  4. Repeat steps 1 to 3 for all remaining Divisions in your org that eMite is onboarding data for / providing reporting for.

Please refer to the following instructions from Genesys on how to create roles, assign permissions and assign roles to users:

2) The Automated Method:

Note: The Automated Method is only supported in 6 out of 12 Genesys Cloud regions. If your Genesys Cloud Org is not within one of these regions, please use the manual method to assign the eMite permission to your agents. You can check your region based on your corresponding login URL, here: https://help.mypurecloud.com/articles/aws-regions-for-purecloud-deployment/.

  1. Login to your Genesys Cloud org with administrative privileges. You need to have the ability to create roles, assign permissions to those roles, and assign those roles to users within each division.

  2. In another browser tab, open one of the following links based on your Genesys Cloud org region: (You can check your region based on your corresponding login URL, here: https://help.mypurecloud.com/articles/aws-regions-for-purecloud-deployment/ )


Integration Checkpoint

Integration Checkpoint

All configuration items configured above must be sent to eMite using the Genesys Cloud Integration Details Form.

  • No labels