
Understand the overview of Genesys Cloud
Learn the role and responsibilities of an Administrator
Understand the Genesys Cloud architecture
Course Overview
Familiarze the Admin Interface
Understand the Admin settings
Add a destination for issue submissions(click the link in the resources)
Prerequisites
Admin role
An account in Genesys Cloud, Collaborate, or Communicate
Configure who receives suggestions and concerns about Genesys Cloud at your company.
Click Admin.
Under Account Settings, click Organization Settings.
Click the Settings tab.
Enter one email address in the Issue Reporting Email Address field.
Click Save.
Notes:
If you do not supply an email address for the issue distribution list, Genesys Cloud sends the email to anyone in your organization who has the Admin role assigned through People and Permissions.
You can specify only one email address. Therefore, we recommend that you create an issue distribution list that includes designated contacts and Level 1 and Level 2 support personnel if an issue escalates.
Become a Designated Contact by first reviewing the Customer areas of responsibility. Then go to the Customer Care log in page and select Get Started to request a My Support account and get access to our Genesys support tools. Allow 48 business hours to receive your credentials.
Add secondary statuses for a primary status(click on link in the resources)
Prerequisites
Admin role
Presence:presencedefinition:Edit permission
Note: You can have up to 10 active secondary statuses for each primary status. Deactivated statuses are not included in this number.
Click Admin.
Under Account Settings, click Organization Settings.
Click Status Management.
Select the primary status.
Click Add Status.
Type the secondary status in the box.
Note: You can use up to 32 characters in a secondary status.
To create another secondary status, click Add Status.
Click Save.
Allow IP addresses(click on link in the resources)
Prerequisites
Admin role
When managing organization settings, the Allowed IP Addresses section enables you to limit access to your Genesys Cloud account to only those users visiting from a specified IP address.
Warning: If you use dynamic IPs, do not enable this functionality.
Click Admin.
Under Account Settings, click Organization Settings.
Click the Settings tab.
In the IP Addresses box, enter the list of CIDR (Classless Inter-Domain Routing) blocks you would like to allow. You can enter one CIDR per line (for example 192.168.100.0/22) up to a maximum of 150 CIDRs.
When creating or updating an allowlist, ensure that your IP is added to or already in the allowlist.
Notes:
You can convert IP addresses using this CIDR Utility Tool. If you do not enter anything in the Allowed IP Addresses field, all IP addresses can access your Genesys Cloud account.
If you incorrectly enter a formatted CIDR, the system disables the Save button until you correct the format. Genesys Cloud checks to ensure that the IP address of the user who configures the allowlist appears in one of the CIDR entries.
If you want to grant access to users or groups from other Genesys Cloud organizations (authorized organizations), then include their CIDRs in the Allowed IP Addresses list.
The Allowed IP Addresses list also applies to applications that interface with Genesys Cloud using its API.
IP addresses originating from a Genesys Cloud Data Actions integration are automatically allowed and do not have to be explicitly added to the allowlist.
If you use Genesys resources other than Data Actions Integrations, make sure to include the necessary IP address ranges listed here among your allowed IP addresses.
Only IPv4 addresses are supported.
Do not include private IP addresses in your list.
Click Save.
Allow PII in email notifications for voicemail(click on link in the resources)
Prerequisite:
Directory > Organization > Admin permission
Include or remove Personally Identifiable Information (PII) in email notifications for voicemail.
Click Admin.
Under Account Settings, click Organization Settings.
Click the Settings tab.
Under Security & Compliance, enable Voicemail Notifications.
Turn the Allow PII in email notifications toggle switch on or off:
ON — Includes PII in email notifications for voicemail.
OFF — Removes PII in email notifications for voicemail.
(Optional) Enable or disable the Voicemail Transcription settings.
Click Save.
Note: In organizations with HIPAA enabled and this setting OFF, the user receives email notifications that do not include PII information, .wav attachments of voicemail, or voicemail transcriptions.
Automatically backfill roles with new permissions(click on link in the resources)
Prerequisites
Either of the following permissions assigned to any user role:
Directory > Organization > Admin
Authorization > Settings > Edit
You can choose to direct Genesys Cloud to assign permissions automatically for new features as they become available. Alternatively, you can choose to assign these permissions manually as you deem appropriate within your organization’s structure.
Automatically assigning new permissions and backfilling existing roles simplifies the process of permission assignment, eliminating the potentially labor-intensive task of a manual update for individual user roles. Manually assigning permissions enables you to maintain more granular access control over user access to features and resources.
To enable or disable automatic permission backfill, perform these steps:
Click Admin.
Under Account Settings, click Organization Settings.
Click the Settings tab.
Under Role Backfill, do one of the following:
To add new permissions automatically as they become available, enable the Role Backfill setting.
To assign new permissions manually, disable the Role Backfill setting.
Click Save.
Change the default country code(click on link in the resources)
Prerequisite
Directory > Organization > Admin permission
Change the country code that Genesys Cloud uses when you add phone numbers. By default, this value is “United States.” To set a different country code:
Click Admin.
Under Account Settings, click Organization Settings.
Click the Settings tab.
Under Default Country Code, select a country code.
Click Save.
Change the default language(click on link in the resources)
Prerequisites
Admin role
Set the default language to use for notification emails such as invitations to the organization and reset password links. This setting does not override the personal settings of organization members.
Click Admin.
Under Account Settings, click Organization Settings.
Click the Settings tab.
Under Global Settings > Default language, select a language.
Click Save.
Change the retention days for Collaborate chat messages(click on link in the resources)
Prerequisites
Admin role
Chat > Setting > View
Chat > Setting > Edit
Collaborate chat messages are retained for a set number of days. You can change this retention period to any number of days from 10 to 3650, which is the default.
Notes:
The removal of messages begins after business hours on the day the retention period changes.
When the retention period reduces substantially, it takes up to a week to complete the removal of all messages dated outside the new period.
ACD chat messages are not affected by this setting.
File attachments in chat messages are retained as per the organizational level retention policy set for chat messages.
To change the number of Collaborate chat message retention days for your org:
Click Admin.
Under Account Settings, click Organization Settings.
Click Settings.
Under Security & Compliance, set Chat Message Retention Days by entering the number of days to retain chat messages. You can enter any number of days from 10 to 3650.
Click Save.
Choose the organization’s default TTS engine(click on link in the resources)
Select a default text-to-speech (TTS) engine and optionally override the default voice per language.
Note: The organization's default text-to-speech (TTS) engine is Genesys TTS. To access additional third-party TTS engines in Architect, first obtain them from the Genesys AppFoundry. Then, configure them in Genesys Cloud. For more information, see About text-to-speech (TTS) engines.
Click Admin.
Under Account Settings, click Organization Settings.
Click the Settings tab.
Under Telephony, select the default TTS engine:
Genesys TTS (default)
An installed third-party TTS integration
(Optional) Override the default voice per language:
Under Language Overrides, click Add.
Under Language, click the arrow and select the appropriate language from the list.
Under Engine, click the arrow and select the appropriate TTS engine for this language.
Under Voice, click the arrow and select the default voice for this language.
Click Save.
Configure invite links(click on link in the resources)
Prerequisites
Admin role
Change settings for invite links used to add people to your organization. To create an invite link, see Add people one at a time.
Click Admin.
Under Account Settings, click Organization Settings.
Click the Settings tab.
Update the following settings as needed:
Auto Invite
· ON — Automatically sends invites by default when adding people. Admins can still turn it off on a case-by-case basis.
· OFF — Turns Auto Invite off by default and allows admins to select it on a case-by-case basis.
Open Admission
· ON — Enables the current invite link. Turning from OFF to ON also creates a new link.
· OFF — Disables the current invite link permanently.
Allowed Email Domain(s)
Specifies the email address domains that a person must use to create a new Genesys Cloud account when responding to a sign-up link.
Click Save.
Enable automatic redaction of sensitive information(click on link in the resources)
Prerequisites
Admin role
When you use Speech and Text Analytics and enable voice transcription or topic spotting for an interaction in Genesys Cloud, you can redact sensitive information from call recordings or voice transcripts.
To redact sensitive information automatically:
Click Admin.
Under Account Settings, click Organization Settings.
Click the Settings tab.
Under Security & Compliance, turn the Sensitive Data Redaction for Payment Cards or Sensitive Data Redaction for Personal Information toggle switch on or off:
ON — Enables automatic redaction of sensitive information of the customer in recordings and voice transcriptions.
OFF — Disables automatic redaction of sensitive information of the customer in recordings and voice transcriptions.
Notes:
On a best effort basis, the option when switched on automatically redacts Payment Card Industry (PCI) entities and personal information entities from recordings and transcripts. This capability is only available if speech or text analytics is enabled for the interaction. Users with Recording > Recording > ViewSensitiveData permission can still access the original recording, regardless of the security setting option. Administrator must explicitly grant this permission to the user.
Genesys recommends that you use Secure Pause or Secure Call Flows as the first line of defense. Only Secure Pause and Secure Call Flows are valid by an external Qualified Security Assessor as Level 1 PCI DSS compliant. For more information about PCI DSS compliance, see PCI DSS compliance.
The following table lists the sensitive information that is redacted based on the option that you choose:
Redaction option
Redacted information
Sensitive Data Redaction for Payment Cards
Credit card and debit card numbers
Card expiration date
Card Verification Value (CVV) or Card Identification (CID) number, a three-digit or four-digit number printed on the front or back of the card
Person name
Note: Person name is classified as PCI if it appears in proximity to a credit card. Otherwise, it is considered as PII.
Sensitive Data Redaction for Personal Information
User information
Phone number
Email address
Person name
Zip or postal code
Passwords
Locations
National Identification Number
Other PII such as license plate number and bank account number
Notes:
Person name is classified as PCI if it appears in proximity to a credit card. Otherwise, it is considered as PII.
Locations encompass countries, cities, and addresses.
The coverage for National Identification Number includes only the following countries:
Australia
Canada
UK
US
Enable communication level After Call Work(click on link in the resources)
Prerequisites
Admin role
Conversation > Settings > Edit permission
Conversation > Settings > View permission
Administrators and supervisors can set After Call Work (ACW) at the communication level for all the channels including voice, chat, email, message, and callback. Once enabled, the communication level ACW applies across all the ACW options, including time-boxed and agent requested options. The timed ACW timeout settings also extend to all digital interactions in addition to voice allowing administrators to control the agent experience for digital interactions.
Supervisors gain more granular control over the time spent by agents in ACW to improve the overall KPI and productivity of the agents. Communication level ACW delivers better analytics and paves way for all future ACW enhancements.
To enable ACW at the communication level for all the channels:
Click Admin.
Under Account Settings, click Organization Settings.
Click the Settings tab.
Under the Contact Center, enable Enforce Communication Level After Call Work (ACW).
(Optional) To wrap up the interactions that are in ACW and don’t have a timeout when the agents log out or close the Genesys Cloud desktop app or web app, enable the End Interactions Automatically when Agents Logoff setting.
Click Save.
To configure after-call settings, see Configure after call work settings.
Note: When you use the Agent Requested option for ACW, ensure that the agents have the Conversation > Settings > View permission to view the Request After Call Work option in the call controls.
Enable voicemail notifications(click on link in the resources)
Prerequisite:
Directory > Organization > Admin permission
Set Genesys Cloud to send an email notification when a user receives a voicemail.
Click Admin.
Under Account Settings, click Organization Settings.
Click the Settings tab.
Under Security & Compliance, turn the Voicemail Notifications toggle switch on or off:
ON — Enables email notifications for voicemail across the organization. Genesys Cloud sends users an email when they receive a voicemail.
OFF — Disables email notifications for voicemail across the organization. Users can still view and listen to their voicemails in their voicemail box in Genesys Cloud.
(Optional) Enable or disable the Allow PII in Email Notifications and Voicemail Transcription settings.
Click Save.
Enable voicemail transcription(click on link in the resources)
Prerequisite:
Directory > Organization > Admin permission
Enable Allow PII in Email Notifications for voicemail
Include written transcriptions of voicemails in email notifications for voicemails. The transcriptions within an email apply only to Communicate or non-ACD voicemails. The transcriptions do not appear in the Genesys Cloud voicemail box.
Click Admin.
Under Account Settings, click Organization Settings.
Click the Settings tab.
Under Security & Compliance, enable Voicemail Notifications.
Enable Allow PII in Email Notifications and then turn the Voicemail Transcription toggle switch on or off:
ON — Enables voicemail transcription across the organization.
OFF — Disables voicemail transcription across the organization.
Click Save.
Notes:
Genesys includes voicemail transcription minutes in its Genesys Cloud fair use policy. If you exceed the number of minutes included in the fair use policy, you are billed an overage charge.
Users receive transcriptions in the language that they have selected for Genesys Cloud. For more information, see User settings.
Voicemail transcription is not available in the FedRAMP region.
Manage Genesys Cloud embedding(click on link in the resources)
Restrict Genesys Cloud Embedding is an optional security setting that prevents external websites from embedding an instance of your Genesys Cloud org in an iframe. It combats “clickjacking,” a malicious technique that redirects a user to a website under the attacker’s control. The malicious website impersonates the victim’s website by embedding it within an iframe element.
Warning: Enabling this feature makes unusable any Genesys Cloud application or integration that embeds Genesys Cloud into an iframe, whose domain does not appear in Allowed Embeddable Domain(s) box.
Configure Genesys Cloud to allow iframes for the legitimate domains with which your organization works. If you do not add these domains, integrations such as Genesys Cloud for Salesforce, Genesys Cloud for Zendesk, Genesys Cloud for Chrome, Genesys Cloud for Firefox, and Genesys Cloud Embeddable Framework will not work. For more information, see Manage Genesys Cloud embedding with the Genesys Cloud embedded clients.
Using deceptively crafted style sheets, iframes, and text boxes, clickjacking makes users think they are interacting with the genuine web application, when they are actually interacting with an invisible iframe controlled by an attacker.
The malicious site monitors actions performed by the user and may use transparent or opaque layers to trick a user into clicking a button or link that appears to be legitimate. By “hijacking” user clicks, an attacker can route the user to a different page, application, or domain. Keystrokes can be hijacked using similar techniques. A clickjacking victim can inadvertently pass credentials or other information to an attacker.
To restrict Genesys Cloud embedding:
By default, Restrict Genesys Cloud Embedding setting is not enabled in your Genesys Cloud organization. Before enabling the Restrict Genesys Cloud Embedding setting, add any domains who can legitimately iframe your Genesys Cloud org in the Allowed Embeddable Domain(s) box. If you do not add these domains, then integrations and embedded clients do not work.
Click Admin.
Under Account Settings, click Organization Settings.
Click the Settings tab.
Scroll to the Security & Compliance section.
5. In the Allowed Embeddable Domain(s) box, add the name of any domains that legitimately iframe your Genesys Cloud org. The table below lists domains that each Genesys Cloud embedded client must be able to access. Use wildcards to include subdomains. Enter each domain entry on its own line. You can add up to 10 domain entries to this list.
Genesys Cloud embedded client
Domain
Genesys Cloud Embeddable Framework
Parent domain
Genesys Cloud for Chrome
chrome-extension://onbcflemjnkemjpjcpkkpcnephnpjkcb
Genesys Cloud for Firefox
moz-extension://*
Genesys Cloud for Salesforce
*.salesforce.com, *.force.com
Genesys Cloud for Zendesk
*.zendesk.com, *.zdusercontent.com
Genesys Cloud for Microsoft Teams
*.teams.microsoft.com, *.skype.com
6. Enable the Restrict Genesys Cloud Embedding setting and add domains. The system displays a warning to remind that this feature, when enabled, could make integrations and apps unusable if the list of allowed domains is empty or invalid.
×Warning: Enabling this feature could cause Genesys Cloud integrations, Genesys Cloud apps, and any other application or integration that uses an iframe to load in Genesys Cloud, whose domain is not listed in Allowed Embeddable Domain(s), to be unusable.
7. Click Save.
Important: When you enable or disable Restrict Genesys Cloud Embedding, users must log out and log back in to their embedded clients.
Technical Notes
When Restrict Genesys Cloud Embedding is on, Genesys Cloud uses the Content Security Policy (CSP) frame-ancestors directive to restrict which domains can embed an instance of Genesys Cloud using <frame>, <iframe>, <object>, <embed>, or <applet> elements. For a list of compatible browsers, see CSP:frame-ancestors at Mozilla Developer Network web documentation.
When the feature is turned on, users must log out and log in, to obtain a new cookie that applies security headers to HTML requests. When the feature is turned off, the Auth API will delete their cookie at the next login.
Reset an agent’s routing score after presence changes(click on link in the resources)
Prerequisites
The following permissions:
Routing > Settings > Edit
Routing > Settings > All Permissions
As an administrator, you can specify that all queue routing methods use changes in an agent’s presence to reset the ACD routing score.
With each presence change, the agent’s internal routing score resets, placing the agent at the back of the queue. When the agent logs in and goes on queue, their score resets and the counter begins running to determine when the next interaction routes to them.
As a result, interactions route to the agent that is in idle or available status for the longest amount of time. By default, interactions route based on the time since an agent’s last interaction.
To reset an agent’s routing score after presence changes:
Click Admin.
Under Account Settings, click Organization Settings.
Click the Settings tab.
Under Contact Center, enable Routing Includes Agent Presence.
Click Save.
Restore previous presence for agents who disconnect and then reconnect to Genesys Cloud(click on link in the resources)
Prerequisites
Presence > Settings > View permission
Presence > Settings > Edit permission
By default, the users who reconnect to Genesys Cloud within 1 minute after an unexpected disconnect automatically return to their most recent presence state. Administrators can configure the time frame between 1 minute and 1440 minutes to return user presence to the most recent state when they reconnect to Genesys Cloud. Administrators can also return the reconnecting users to their on-queue presence. This capability applies to all users within the organization.
To configure the time frame for renewing the user’s presence to their prior state:
Click Admin.
Under Account Settings, click Organization Settings.
Click the Settings tab.
Under the Contact Center section, enable the Renew Presence on Reconnect toggle switch.
In the Time Frame for Reconnect, enter the time between 1 minute and 1440 minutes.
Note: If the user reconnects to Genesys Cloud after the specified time frame, the user’s presence is set to Available.
(Optional) To renew the on queue statuses of all users, enable the Renew On Queue Connections toggle switch.
Click Save.
Route email to multiple destinations(click on link in the resources)
Prerequisites:
Admin role
Define whether an inbound email with multiple recipients that belong to multiple destinations such as queues or flows, must be routed to all the destinations in the email.
Click Admin.
Under Account Settings, click Organization Settings.
Click the Settings tab.
Under Contact Center, enable Route Email to multiple destinations.
Click Save.
When you enable this option, the system creates an interaction for each recipient in the email and routes the interaction to a queue or flow. For example, if an email from a customer includes sales@example and service@example.com, it routes to two separate queues and creates two separate interactions. The agents in the corresponding queues can see the email recipients and they can reply to them. When they reply to all of them, an email thread updates for the included interactions and the agents.
Email with multiple destinations goes through an Architect email flow, which uses the Email.Message.route.id field that allows them to make routing decisions within the flow. For more information, see Architect built-in variables.
Set an automatic inactivity timeout(click on link in the resources)
Prerequisite:
Directory > Organization > Admin permission
Administrators can set Genesys Cloud to log out users automatically after a specified period of inactivity. When Genesys Cloud logs out a user due to inactivity, it changes their presence to Offline and displays a message to the user notifying them that they must log back in. After the user logs back in, they return to the same page they were on before Genesys Cloud automatically logged them out.
If a user is an agent and is On Queue, their routing status changes to Off Queue when they are logged out. To accept new interactions, agents must log in and go back On Queue. Also, when this setting is enabled, Genesys Cloud does not provide refresh token for code authorization.
The timeout applies to all members of an organization, works for both desktop and web app users, and works for organizations that use single sign-on (SSO). However, Genesys does not recommend the use of this feature for organizations that use an embedded client or a custom-developed client.
To enable the automatic timeout and set the amount of idle time before Genesys Cloud logs out a user, complete the following steps:
Click Admin.
Under Account Settings, click Organization Settings.
Click the Settings tab.
Click the Enable Inactivity Timeout toggle switch to on.
Enter in the amount of time, in minutes, that users can be idle before Genesys Cloud logs them off. The feature allows any amount of time between five minutes and eight hours (480 minutes).
Notes:
Genesys Cloud determines activity by calls to the API. Even if the user is not typing or actively working with Genesys Cloud, the Genesys Cloud user interface can make a request on behalf of the user, for example, fetching data to keep the application up to date or saving application logs. Any request resets the idle timeout. The Genesys Cloud excludes the following API calls from resetting the timer:
api/v2/featuretoggles
api/v2/diagnostics/newrelic/insights
api/v2/diagnostics/trace
api/v2/integrations/clientapps
api/v2/users/me
Organizations with HIPAA enabled automatically have a 15-minute inactivity timeout, even if the inactivity timeout is off. If the inactivity timeout is on, the maximum amount of time allowed for the timeout is 15 minutes.
This feature provides an additional layer of functionality to help customers control costs and security implications for users who forget to log out when they leave stations. Genesys recommends that customers also use the supervisor feature to log out agents and extend training to the agents to enforce best practices to log out. It is the user’s responsibility to log themselves out.
Set Genesys Cloud password requirements(click on link in the resources)
Prerequisites
Admin role
This procedure explains how to configure Genesys Cloud password requirements. If you want to disable Genesys Cloud login and use a single-sign-on (SSO) provider instead, see Configure Genesys Cloud to authenticate with SSO only.
Notes:
If you change your password requirements, with the exception of Password Expiration, existing users are not affected until they change their passwords.
If a user enters a password that doesn’t fit your organization’s minimum and maximum requirements, the user receives an error message.
The maximum length for a password is 400 characters.
Genesys Cloud protects accounts from password-guessing scripts and other abusive behavior by locking out accounts after six unsuccessful consecutive login attempts. The lockout duration is five minutes.
Click Admin.
Under Account Settings, click Organization Settings.
Click the Authentication tab.
Configure the fields.
Edit this field…
To set…
Minimum Length
Minimum number of characters.
Note: The default minimum length for a password is 8 characters, including a default minimum of:
1 lowercase letter
1 uppercase letter
1 number
1 special character
Minimum Letters
Minimum number of letters. Use this field if you allow your users to use any combination of uppercase and lowercase letters.
Minimum Lower Case Letters
Minimum number of lowercase letters. Use this field if you want to require your users to use some lowercase letters.
Minimum Upper Case Letters
Minimum number of uppercase letters. Use this field if you want to require your users to use some uppercase letters.
Minimum Numerals
Minimum number of numbers.
Minimum Special Characters
Minimum number of special characters.
Allowable characters: !”#$%&'()*+,-./:;<=>?@[\]^_`{|}~
Password Expiration
Length of time in days before a password expires.
Notes:
When you change this value, the change goes into effect immediately and affects all existing passwords.
Any existing passwords that are older than the number of days you specify must be changed immediately.
When a user’s password expires, that user must reset their password before they can log in to Genesys Cloud.
If a user is logged in when their password expires, they will remain logged in. However, after they log off, the user must reset their password in order to log back in.
Minimum Age
Length of time in seconds before a user can change a password.
Set the maximum interaction data retention time(click on link in the resources)
Prerequisites
Analytics > DataRetention > Edit
Analytics > DataRetention > View
Recording > Recording > View
When the maximum interaction data retention time is set, Genesys Cloud interaction data will not be retained longer than the set retention time. Genesys Cloud interaction data refers to interaction data and its respective recording. For more information, see Retention period for analytics data and recording.
If the maximum interaction data retention time is never set, the default retention periods listed in the Retention period for analytics data and recording article will apply.
Important:
The default value for the maximum interaction data retention time is null. After you set the maximum interaction data retention time, you can change the value to a shorter or longer duration, but you cannot change the value back to null.
When you increase the interaction data retention time, any existing recordings will still have the retention period set to the original value. If you want to increase the retention period for any existing recordings, you must use the Recording bulk job API.
If historical interactions were configured with a deletion date beyond the maximum interaction data retention time you are trying to set, you will be notified of this conflict and you will not be able to set the intended time period. To delete historical interactions, you must first shorten the deletion dates for all existing interactions to a time period within their respective maximum interaction data retention time. To do this in bulk, see Recording bulk job API.
If QM policies were configured with a retention period longer than the maximum interaction data retention time you are trying to set, you will be notified of this conflict and you will not be able to set the intended time period. You must first update these QM policies by shortening their retention period so that it is within the maximum interaction data retention time.
To set the maximum interaction data retention time:
Click Admin.
Under Account Settings, click Organization Settings.
Click Settings.
Under Security & Compliance, enter the number of days in the Maximum Interaction Data Retention Time field.
Click Save.
Set the maximum voicemail length(click on link in the resources)
Prerequisites:
Directory > Organization > Admin permission
Administrators can set the maximum voicemail recording length for all users in their organization.
Click Admin.
Under Account Settings, click Organization Settings.
Click the Settings tab.
In the Maximum Voicemail Length field, enter in the number of minutes. You can set the voicemail length to a minimum of three and maximum of 15 minutes. Default length is three minutes.
Click Save.
Notes:
The .wav files for longer voicemail messages can exceed 10 MB. If a voicemail message causes the email notification exceed 10 MB, Genesys Cloud does not attach the recording. Instead, you receive a message that the attachment is too large. You can listen to the voicemail in your inbox. For more information, see Enable voicemail notifications and Open and play a voicemail.
For information about how the Architect default voicemail flow collects voicemail snippets, see Voicemail collection in the Architect default voicemail flow.
Strip skills from voice interactions on blind transfers by agents(click on link in the resources)
Prerequisites
The following permissions:
Routing > Settings > Edit
Routing > Settings > All Permissions
As an administrator, you can configure voice interaction blind transfers so that the system removes all skills from agent requirements. When an agent makes a blind transfer to a different queue, the required agent skills are removed. The agent can then pick up the transferred interaction in the targeted queue, even if the second agent does not have the same skills as the previous agent. Stripping skills from the agent requirements prevents interactions from getting stuck and abandoned.
To remove skills from blind transfers:
Click Admin.
Under Account Settings, click Organization Settings.
Click the Settings tab.
Under Contact Center, enable Strip Skills on Blind Transfer.
Click Save.
Note: The system always preserves the language skill.
Turn off file uploading in internal chats(click on link in the resources)
Prerequisites
Admin role
Users can exchange files in Genesys Cloud by uploading them to internal chat sessions or workspaces in Documents.
Genesys Cloud does not scan files for viruses or malware; it only transfers them. Customers who share files are responsible for implementing adequate client-side anti-virus/anti-malware measures. For more information, see Malware and antispam protection best practices.
Some customers or partners may have the ability to upload files without first scanning them for viruses and malware, as a security vulnerability. In line with this concern, a Genesys Cloud administrator can disable file uploading in chat at the organization level. In addition, a Genesys Cloud administrator can withhold a permission to prevent users from using Documents. See Documents roles and permissions.
To disable file uploading in chat for your org:
Click Admin.
Under Account Settings, click Organization Settings.
Click Settings.
Under Security & Compliance, set Disable Chat File Uploads to ON. This prevents all users in your org from attaching files to the body of an internal chat. This option is applicable only to internal chat.
Click Save.
Turn off geolocation detection(click on link in the resources)
Prerequisites
Admin role
Turn geolocation detection on or off across the organization. Geolocation detection automatically displays users’ geolocation information for users who choose to share their current geolocation. When you turn off geolocation detection, Genesys Cloud does not display geolocation information for any users in the organization.
Click Admin.
Under Account Settings, click Organization Settings.
Click the Settings tab.
Turn the Geolocation Detection toggle switch on or off:
ON — Enables geolocation detection across the organization.
OFF — Disables geolocation detection across the organization.
Click Save.
Turn off voicemail PIN(click on link in the resources)
Prerequisites
Admin role
Turn off the requirement that organization members must enter a PIN to access voicemail.
Click Admin.
Under Account Settings, click Organization Settings.
Click the Settings tab.
Set the Voicemail PIN setting:
ON — Requires organization members to use a PIN to access their voicemail.
OFF — Allows organization members to access their voicemail without a PIN.
Click Save.
Turn on free seating(click on link in the resources)
Prerequisites
Admin role
To place or receive calls, a user must select a station every time they log in. Free seating controls whether Genesys Cloud retains a user’s selected phone when the user is not using it. When free seating is turned on, Genesys Cloud automatically releases a user’s phone for use by another user when the user logs off.
Click Admin.
Under Account Settings, click Organization Settings.
Click the Settings tab.
Move the Free Seating switch to the desired setting:
ON — Enables free seating across the organization.
OFF — Disables free seating across the organization.
View your security and compliance settings(click on link in the resources)
Prerequisites
Admin role
Click Admin.
Under Account Settings, click Organization Settings.
Click the Settings tab.
Under Security & Compliance, view your compliance settings.
The HIPAA setting enables compliance with the Health Insurance Portability and Accountability Act (HIPAA). If your organization requires a HIPAA compliant Genesys Cloud organization, this toggle must be on. For more information, see HIPAA compliance.
Note: If you enable the HIPAA setting, Genesys Cloud automatically disables the Allow PII in Email Notifications setting. Depending on your voicemail settings, users may still receive notifications without PII.
The PCI DSS setting enables compliance with the Payment Card Industry Data Security Standard (PCI DSS) for handling payment cardholder data. If your organization requires a PCI compliant Genesys Cloud organization, this toggle must be on. For more information, see PCI DSS compliance.
The Voicemail Notifications setting enables Genesys Cloud to send email notifications when callers leave voicemail.
The Allow PII in Email Notifications setting determines whether the email notifications for voicemail contain personally identifiable information. To hide PII, disable this option.
The Fax Notification setting enables Genesys Cloud to send email notifications when faxes arrive.
The Allow PII in Email Notifications setting determines whether the email notifications for faxes contain personally identifiable information. To hide PII, disable this option.
The Sensitive Data Redaction for Payment Cards setting enables Genesys Cloud to redact PCI DSS entities from call recordings or voice transcripts when voice transcription or topic spotting is enabled for an interaction. This option is available only if you use Speech and Text Analytics in Genesys Cloud. Users with the Recording > Recording > ViewSensitiveData permission can access the original recording and view the transcript unredacted. For more information, see Enable automatic redaction of sensitive information.
The Sensitive Data Redaction for Personal Information setting enables Genesys Cloud to redact Personally Identifiable Information (PII), such as name, username, email address, password, phone number, and location from call recordings or voice transcripts when voice transcription or topic spotting is enabled for an interaction. Users with the Recording > Recording > ViewSensitiveData permission can access the original recording and view the transcript unredacted. For more information, see Enable automatic redaction of sensitive information.
To enable HIPAA or PCI DSS compliance, contact Genesys Cloud Support.
User Profiles
User Permissions
Roles and Access Control
Add a field to the profile configuration(click on link in the resources)
Note: When you create a custom profile field, you cannot delete it from Genesys Cloud. You can only disable it so that users cannot see or use it. With Admin permissions, you can re-enable disabled fields at any time.
Click Admin.
Under Directory, click Profile Fields. The Profile Fields page appears.
Click the section that you want to contain the new field.
Click Add Field.
Note: This button is available only if fields are available for you to add.
In the Field Details tab, click an option from the Field Type menu:
Text — Creates a field where you enter text values, like the Name and Biography fields.
Tag — Creates a field where you enter searchable tags, like the Skills and Certifications fields.
6. Under Configuration, do the following depending on the selection in the previous step:
For this field type…
Do the following…
Text
Enter the maximum number of characters allowed in the new field in the Maximum Length field.
Tag
1. Enter the maximum number of characters allowed for each tag in the Maximum Tag Length field.
2. Enter the maximum number of tags allowed in the field in the Maximum Tag Count field.
7. Click the Field Labels tab and add user-facing text for the new field in all applicable languages:
Field Name — Provides the name of the field.
Instruction Text — Provides the text that displays when you hover over the help icon next to the field name in edit mode.
Click Save.
Note: After you save a field, you cannot change the field type or field configuration settings.
Add a section to the profile configuration(click on link in the resources)
Important: Profile sections cannot be deleted. Make sure that changes to the profile configuration have approval from your organization.
Click Admin.
Under Directory, click Profile Fields.
Click Add Section.
Add user-facing text for the new section in all applicable languages:
Section Name — The name of the section.
Instruction Text — The text that appears when you hover over the help icon next to the section name.
Click Done.
From the Profile Fields page, click Save.
Copy and customize an existing role(click on link in the resources)
Click Admin.
Under People and Permissions, click Roles/Permissions.
Find a role similar to the role you want to create.
Click More and from the menu that appears, click Copy Role.
Edit the role name and optional description.
Click the Permissions tab to assign permissions to the role:
Under Permissions, click to expand a category.
Next to each permission to add, enable the check box.
Click Save.
Create a new role(click on link in the resources)
Click Admin.
Under People and Permissions, click Roles/Permissions.
Click Add Role.
Enter a name and optional description in the fields.
Click the Permissions tab to assign permissions to the role:
Under Permissions, click a category to expand it.
Next to each permission to add, enable the check box.
Click Save.
Disable fields in the profile configuration(click on link in the resources)
Note: You cannot delete fields from Genesys Cloud profiles. You can disable some profile fields so that they do not appear to users.
Genesys Cloud profiles provide information about users. Core functionality requires some fields, but others are optional. To prevent users from editing optional fields, you must disable them.
Click Admin.
Under Directory, click Profile Fields.
Click the section that contains the field so that the field is visible on the right.
From the Edit Field menu, click Disable Field.
Note: You cannot disable fields that do not have the Edit Field option.
To confirm this action, click Yes when prompted.
Enable fields in the profile configuration(click on link in the resources)
To enable profile fields, do the following:
Click Admin.
Under Directory, click Profile Fields.
To view disabled fields, select the Display disabled field check box. This check box only appears when you have disabled fields.
“Field disabled” appears next to disabled field names.
To enable a disabled field, click Enable Field.
Rename a field in the profile configuration(click on link in the resources)
Click Admin.
Under Directory, click Profile Fields.
Click the section that contains the field that you want to rename. The fields appear in the right column.
Click Edit Field.
Click the Field Labels tab.
Enter the new name in the Field Name field for all applicable languages.
Press Enter.
Click Save.
Rename a section in the profile configuration(click on link in the resources)
Click Admin.
Under Directory, click Profile Fields.
To the right of the section name, click Edit.
In the Section Name field, enter the new name.
Click Done.
At the bottom of the page, click Save.
Reorder fields in the profile configuration(click on link in the resources)
Click Admin.
Under Directory, click Profile Fields.
Click the section that contains the field so that the field is visible on the right.
Hover the mouse pointer over the up and down arrow until the cursor becomes Move.
Click Move and drag the field into a new position.
Reorder sections in the profile configuration(click on link in the resources)
Click Admin.
Under Directory, click Profile Fields.
Hover the mouse pointer over the up and down arrow until the cursor becomes Move.
Click Move and drag the section to a new position.
Create & Configure Queues
Utilization & Canned Responses
Create Wrap-Up Codes & Agent Scripts
Email, Response Assets, Widgets, Analytics, & Panel Manager
Add a knowledge base(click on link in the resources)
Access the knowledge workbench from the link provided by your administrator.
Create a new knowledge base or open an existing one.
Click Create Article.
Click Add Question And Answer. The Create a Question and Answer dialog opens.
Under Question, add the FAQ question.
(Optional) Under Category, do one of the following:
Select an existing question and answer category from the list.
Click Add New Category and under Category, enter a name for the new category.
(Optional) In the Alternative box, to add varieties of the original question do the following:
Click Add Alternate Question.
Under Alternate Questions, add another version of the question.
To add another alternative question, click Add and repeat step b.
In the Answer box, add the FAQ answer.
Click Create.
Import FAQs to the knowledge base
You can import a questions and answer file in CSV format.
Access the Knowledge Workbench from the link provided by your administrator.
Create a new knowledge base or open an existing one.
Click Import. The Import Knowledge dialog appears.
(Optional) To download a question and answer template and edit with your own information, click Download Knowledge Template.
Under Select a CSV file, click Browse.
Navigate to your .csv file and select the file.
Click Validate. The system checks for any errors in your file and returns a list of items to check before you continue.
If the validation check includes no errors, click Import. The system imports the question and answer pairs as individual FAQs.
You can now train and test your FAQs.\
Add phrases to a knowledge base V2 article(click on link in the resources)
Phrases are alternative ways of expressing the same intent. As the following example demonstrates, sometimes one answer is suitable for various questions.
Answer: “To see more details, log in with your username and password.”
Question 1: “How do I see my account details?”
Question 2: “Where can I find my balance?”
The knowledge base automatically learns more phrases to existing questions. However, you can add other phrases to an existing question and answer article, which accelerates the learning process and optimizes your knowledge base.
The original question and answer remains the same and is visible to your users. Adding more phrases teaches the knowledge base system to recognize other questions and return the same answer.
Add phrases to a knowledge base question and answer article
To add phrases to a question and answer article, follow these steps:
Notes:
The minimum number of characters in a phrase is three.
You can add an unlimited number of phrases to an article.
1. Access the knowledge workbench from the link provided by your administrator.
Under Knowledge, click Articles.
Create a new knowledge base or open an existing one.
Open an existing question and answer article or create a new one.
Under Set up the Question, click the Phrasings tab.
Under Phrase, add a phrase or sentence that represents another way that a user asks the primary question in the article.
Click Add.
To help a user complete the phrase by generating this phrase as a prediction of the intended question, enable the Autocomplete check box.
Do one of the following:
To save the article and continue working, click Save.
To save the article and close the knowledge base, click Save & Close.
Add a knowledge base(click on link in the resources)
Access the knowledge workbench from the link provided by your administrator.
Create a new knowledge base or open an existing one.
Click Create Article.
Click Add Question And Answer. The Create a Question and Answer dialog opens.
Under Question, add the FAQ question.
(Optional) Under Category, do one of the following:
Select an existing question and answer category from the list.
Click Add New Category and under Category, enter a name for the new category.
(Optional) In the Alternative box, to add varieties of the original question do the following:
Click Add Alternate Question.
Under Alternate Questions, add another version of the question.
To add another alternative question, click Add and repeat step b.
In the Answer box, add the FAQ answer.
Click Create.
Import FAQs to the knowledge base
You can import a questions and answer file in CSV format.
Access the Knowledge Workbench from the link provided by your administrator.
Create a new knowledge base or open an existing one.
Click Import. The Import Knowledge dialog appears.
(Optional) To download a question and answer template and edit with your own information, click Download Knowledge Template.
Under Select a CSV file, click Browse.
Navigate to your .csv file and select the file.
Click Validate. The system checks for any errors in your file and returns a list of items to check before you continue.
If the validation check includes no errors, click Import. The system imports the question and answer pairs as individual FAQs.
You can now train and test your FAQs.
Add labels to a knowledge base(click on link in the resources)
You can tag content in your knowledge base articles with labels. For more information, see Understand knowledge base V2 categories and labels.
Add a label
To add a label for your knowledge articles, follow these steps:
Click Admin.
Under Knowledge, click Categories & Labels.
Click the Labels tab.
Under Label name, type a meaningful name for the label.
Click the Label color list and select the appropriate color for the label.
Click Create label.
Repeat steps 4–6 for each additional label that you want to add.
Create a Canned Response Library(click on link in the resources)
Prerequisites
Responses > All > All permission
Note: You can create up to 200 libraries.
Click Admin.
Under Contact Center, click Canned Responses
Click Manage Libraries.
Click Add Library.
In the Library Name box, type a descriptive name.
Note: Each library name can up to 256 characters.
Click Save.
Create responses(Click on link in the resources)
Prerequisites
Responses > All Permissions
Note: You can create up to 200 libraries, and each library can have up to 200 responses.
To create a response, follow these steps:
Click Admin.
Under Contact Center, click Canned Responses.
Under Libraries, click the library where the response belongs.
Click Add Response.
In the Response Name box, type a meaningful name. Agents see this name.
The Library list already contains the library you selected in step 3. To specify a different library, click the library name from this list.
For a standard response, under Response Type, enable Standard. For more information about template messages, see Add a WhatsApp template message.
In the Content box, type the content of your message.
Notes:
Remember that this response is part of a larger email or chat conversation. Leave out unnecessary details such as greetings or transition words.
To improve the readability of your canned responses, you can add formatting. For more information, see Format canned responses.
You can add an image to your response.
To create another response, enable the Create Another check box. The new response belongs to the same library by default. However, you can select a different library if necessary.
Click Save.
Use substitutions in responses
To use a substitution, place your cursor at the appropriate spot in your response, and under Insert Substitution, click the letter beside the substitution you want to add. When an agent uses the response, Genesys Cloud replaces the substitution with the correct information.
Add a wrap-up code(click on link in the resources)
Click Admin.
Under Contact Center, click Wrap-Up Codes.
Click Create Wrap-up Code. The Add Wrap-up Code dialog box opens.
In the Name box, enter a unique wrap-up code name.
Click Save.
Create a script(click on link in the resources)
Prerequisites
The following permissions:
Scripter > Script > All
Scripter > PublishedScript > Add
Scripter > PublishedScript > View
Click Admin.
Under Contact Center, click Scripts.
Click Create.
Type a name for the script. A selection of script templates displays. Templates are complete or partially complete scripts that you can base your new script on. The selection of templates includes templates that other people in your organization create.
Choose one template. If you are unsure about which template to choose, click Default Inbound Script or Blank Script.
Blank Script—a blank script without any customizations.
Default Callback Script—the default script that pops for callbacks. Use this script if you did not specify another script in Architect to run in response to an in-queue callback action.
Default Inbound Script—the default script that pops for inbound calls.
Default Outbound Script—A default script for outbound dialing. This script contains a control for updating contact list fields. When you base a script on this template, you must select a contact list in the script’s properties. Otherwise, Scripter shows no edit fields.
The new script displays in the script editor.
To save the script, on the Script menu, click Save.
Note: You must save a new script manually.
Note: If, while editing a script, you navigate away, the script editor preserves your unsaved changes. When you return, the script editor reloads your draft with unsaved changes in place. If you leave your computer and open your script on another computer or browser, the following message appears:
After six minutes this message disappears, and the script editor discards any unsaved changes.
The autosave feature is only available with scripts you have saved at least once.
Add a domain(click on link in the resources)
Click Admin.
Under Contact Center, click Email. The Domains Dashboard page opens.
Click Add Domain. The Add Domain page opens.
From the Domain Type list, select Custom.
Under Domain Name, type the fully qualified domain name.
Click Save. The email address page opens for the new domain.
Click Add email address and follow the instructions in the next section, Add email addresses to the domain.
Add email addresses to the domain(click on link in the resources)
To add email addresses to the domain, follow these steps:
Click Admin.
Under Contact Center, click Email. The Domains Dashboard page opens.
Click the domain name and then click Add Email Address. The Email Address Details page opens.
In the Email Address box, type the email address the customer uses to send an email.
In the From Name box, optionally type the agent, department, or organization name that appears to the recipient when a representative responds to an email.
In the From Email Address box, type the email address that the recipient sees when the agent responds to an email.
In the Reply To box, optionally type the email address that appears when a customer clicks Reply in response to an email from the Genesys Cloud agent.
Under BCC Recipients, type up to five email addresses that you want to blind copy to the email.
Under Email Routing, select to route all email, excluding email the system considers as spam, to a queue or a flow.
Note: For outbound email only, you can also select not to route to a queue or flow.
If you choose to route to a queue, do the following:
Click the Queue list and choose the appropriate queue.
To ensure that associated emails route to an agent with matching skills, in the Skills box add any ACD skills.
To ensure that associated emails route to an agent with a matching language, click the Language list and choose a language.
In the Priority box, optionally enter the email's priority.
If you choose to route to a flow, under Always route to this flow select a flow from the list.
(Optional) To configure how to route email that the system suspects is spam, under Spam Routing, do one of the following:
Select Route spam email to this flow and then select a flow from the list.
Select Disconnect all email that is detected as spam.
To apply an email signature automatically to the outbound email, select Use Email Signature.
Note: Agents cannot see the automatic email signature appended to their outbound emails. Inform the agents beforehand to avoid duplication of the email signature.
To choose a signature that you created in Canned Response, select Signature. For more information, see Add an email signature response.
To keep the agent signature before the email history and to allow agents to edit the email signature, select Insert signature in the editor before message history.
Select the emails for which you want to apply the automatic email signatures. Set one of the following:
All Outbound Emails
Only the Initial Email
To include or exclude email history by default in your outbound emails, under Email History, set one of the following options:
o
Always auto-include email history with each agent response
Never include email history with each agent's response
Let agents decide for each response
Note: Regardless of the setting, agents can see the email history on their email editor. However, the receiver of the email can view the history only if you or the agent includes the history in the email. All changes to this setting take immediate effect.
To allow agents to perform multiple actions such as forwarding and replying more than once on an email, click the Enable Multiple Actions option.
Click Save.
To add more email addresses, click Add Email Address and repeat the procedure.
Create a widget for web chat(click on link in the resources)
Prerequisites
Genesys Cloud CX 2, Genesys Cloud CX 3, Genesys Cloud CX 1 Digital Add-on II, Genesys Cloud CX 2 Digital, or Genesys Cloud CX 3 Digital license
Widgets > Deployment > All or Web Chat > Deployment > All permission
Create a widget to allow you to add web chat to your website so that your customers can chat with agents directly from their web browsers. A deployment key created with each widget identifies your website’s configuration to Genesys Cloud. Use the deployment key when you add a widget to your website. For more information about adding the Version 1.0 and 1.1 widgets and deployment key to your website, see Web chat. For more information about adding Version 2 widget and deployment key to your website, see Widget – Version 2.
You can create multiple widgets for different purposes. For example, you could create a widget to track a customer’s journey on your website and even prompt them to start a chat with Predictive Engagement. You could also create a widget that requires users to authenticate with your site before they can contact an agent by using authenticated chat. Then create another widget to allow anonymous users to ask general questions.
Genesys Cloud supports three different types of widgets. Choose which type of widget to use based on your needs:
Version 2: Supports Predictive Engagement. Optimized for mobile browsers. Allows customization options.
Version 1.1: Supports authenticated chat and HTTP chat APIs. Does not support Predictive Engagement.
Version 1.0: Supports authenticated chat, screen sharing, and co-browse. Does not support Predictive Engagement.
Third Party: Support for web chat widgets not developed by Genesys. Does not support Predictive Engagement.
For more information about the differences between the different widget types, see Widget feature comparison.
To create a widget, see the appropriate section for the type of widget you want to create.
Version 2
Click Admin.
Under Contact Center, click Widgets.
Click Create Widget.
Enter a Name and Description for the deployment.
Select Version 2.
(Optional) Specify the domain(s) from which to initiate web chat:
Click Add Domain.
Enter an allowed domain, for example, https://www.example.com.
Click Add.
Repeat a through c for each domain you want to allow.
Note: If you do not specify one or more domains, all domains are allowed.
(Optional) To connect the widget to a chat flow, search for and select a chat flow under Route to Flow. For more information, see Inbound chat flows overview.
Click Save.
Notes:
Version 2 widgets are always active. You cannot deactivate them.
To ensure full feature functionality supported for Version 2 widgets, use the most recent script version in the Developer Center. For more information, see Widget – Version 2 in the Developer Center.
Version 1.1
Click Admin.
Under Contact Center, click Widgets.
Click Create Widget.
Enter a Name and Description for the deployment.
Select Version 1.1.
To require users to authenticate with your website before they can start a web chat, enable Require Authentication.
If you enable Require Authentication, the Authentication URL box appears and you must specify the URL of the web service that makes signing requests to Genesys Cloud. For examples in GitHub, see Authenticated web chat server examples.
To specify how the web chat interface looks on your website, choose a Chat Appearance option:
Basic: This option provides you with a simple interface.
Modern: This option provides you with an interface that has a more contemporary look and feel.
Basic
Modern
(Optional) To connect the widget to a chat flow, search for and select a chat flow under Route to Flow. For more information, see Inbound chat flows overview.
Click Save.
By default, Genesys Cloud activates widgets when you create them.
To deactivate a Version 1.1 widget, a website developer must first set up the configuration, following the example provided for web chat schedules. Then click the Widget is Activated switch in the widget configuration screen.
Version 1.0
Click Admin.
Under Contact Center, click Widgets.
Click Create Widget.
Enter a Name and Description for the deployment.
Select Version 1.0.
To require users to authenticate with your website before they can start a web chat, enable Require Authentication.
If you enable Require Authentication, the Authentication URL box appears and you must specify the URL of the web service that makes signing requests to Genesys Cloud. For examples in GitHub, see Authenticated web chat server examples.
To specify how the web chat interface looks on your website, choose a Chat Appearance option:
Basic: This option provides you with a simple interface.
Modern: This option provides you with an interface that has a more contemporary look and feel.
Basic
Modern
Click Save.
By default, Genesys Cloud activates widgets when you create them.
To deactivate a Version 1.0 widget, a website developer must first set up the configuration, following the example provided for web chat schedules. Then click the Widget is Activated switch in the widget configuration screen.
Third Party
Notes:
If you choose to use a third party widget, you must build your own widget.
Third party widgets do not have custom options, such as the ability to deactivate the widget or change the chat appearance.
Click Admin.
Under Contact Center, click Widgets.
Click Create Widget.
Enter a Name and Description for the deployment.
Select Third Party.
(Optional) Specify the domain(s) from which to initiate web chat:
Click Add Domain.
Enter an allowed domain, for example, https://www.example.com.
Click Add.
Repeat a through c for each domain you want to allow.
Note: If you do not specify one or more domains, all domains are allowed.
(Optional) To connect the widget to a chat flow, search for and select a chat flow under Route to Flow. For more information, see Inbound chat flows overview.
Click Save.
Create and configure queues(Click on link in the resources)
Prerequisites
Routing Queue Add, Edit, Delete, Join, and View
Routing Queue Readonly
Routing Queue Member Manage
Architect UI View
The following permissions are required to edit or view prompts in Architect (for whisper audio)
Architect UserPrompt View
Architect UserPrompt Edit
The following permission is required for agents to request for after call work when the setting is Agent Requested
Conversations Settings View
Queues are the “waiting lines” of interactions. Agents select the On Queue status to enter their predefined queues. Contact center queue settings include creating and managing queues for voice and chat channels for the entire organization.
Notes:
An organization can add up to 5000 queues.
Membership is limited to 5000 members per queue.
Each queue name must be unique. You cannot duplicate a queue name.
A queue name cannot contain asterisks.
Create and configure queues for voice, chat, email, callback, and social expression channels for the entire organization from the Admin Contact Center Queues page.
Collapse All
Create a queue
Click Admin.
Under Contact Center, click Queues. The Manage Queues page opens.
Click Create Queue.
In the Name box, type a name that is unique to the queue.
In the Peer Id, type a unique ID that can be used to identify the queue from an external platform. Peer Id is most commonly used to synchronize queues from an external platform in an organization using the Genesys Cloud EX product. For more information, see Genesys Cloud EX.
Note: Once created, the peer Id cannot be updated.
Click the Division list and follow these steps:
Note: If you do not type anything in the search list, the first 10 divisions appear by default.
Begin typing the first few letters of the division in which you want to place the queue.
To locate the required division, scroll through the list of available divisions.
Select the appropriate division from the list.
To copy the configuration and membership from an existing queue, under Copy settings and members from, search for and select an existing queue.
Note: You can edit the new queue's membership and settings after you copy the existing configuration.
Click Save. The queue configuration opens to the General tab.
Configure after call work (ACW) settings
Configure after call work settings
Select the after call work option:
Click the After Call Work list and select whether after call work is:
Optional: This option allows agents to opt out of selecting a wrap-up code after a call. This feature is useful if your organization does not use wrap-up codes and your agents do not need after call work time.
Mandatory, Discretionary: This option enables agents to choose how long to remain in ACW status. In this case, they will set their status back to available when they complete after call work.
Note: If you choose Optional or Mandatory, Discretionary, the interaction closes only when the agents manually end the interaction after it moves to ACW. If an agent logs off or closes the browser without ending an interaction that is currently in ACW, the interaction does not wrap up. To force wrap up to such interactions, configure the End Interactions Automatically when Agents Logoff organization-level setting. The interactions close with a system wrap-up code, ININ-SYSTEM-LOGOUT. For more information, see Enable communication level after call work.
Mandatory, Time-boxed: This option sets the maximum amount of time that agents remain in the ACW state to complete after call work. If they finish after call work early, they can change status to receive new interactions, or automatically become available at the end of the time specified.
Mandatory, Time-boxed no early exit: This option prevents agents from setting themselves back to available if they complete after call work early. They remain in ACW status and automatically return to available status at the end of the time-out period. This feature is useful to give agents a "cool down" period between interactions.
Agent Requested: This option needs agents to specifically make a request for after call work before they disconnect the interaction.
Note:
For agents to view the option to request ACW, you must enable Enforce Communication Level After Call Work (ACW) and grant agents the Conversations Settings View permission. For more information, see Enable communication level after call work.
If agents request ACW: After the interaction disconnects, they move to ACW status for the time period set on the queue and experience the same process as Mandatory, Time-Boxed ACW.
If agents do not request ACW: After the interaction disconnects, they move to an idle state and become available for the next interaction in the queue. The agents can no longer go into ACW.
Agents can save the wrap-up codes and notes that they select during an interaction only if they request for ACW time and enter the ACW period after the interaction ends. If the agents do not request for ACW, they cannot save the notes or wrap-up codes.
(Applicable only to Mandatory, Time-boxed, Mandatory, Time-boxed no early exit, and Agent Requested settings) In the After Call Work Timeout (Seconds) field, set the time that the agents have for after call work before they receive more interactions. The maximum number that you can enter here is 900 seconds. This timeout period applies only to voice interactions. To apply the timeout period to other channels such as chat, email, message, and callbacks, enable Enforce Communication Level After Call Work (ACW). For more information, see Enable communication level after call work.
Note: If an interaction (assigned to an agent in a queue that has ACW configured and requires a wrap-up code to be selected) is direct transferred to another user, and if the receiving agent is not the member of a queue and does not have permissions to assign wrap-up codes, the agent will still have ACW time for their segment of the interaction and will still have to select a wrap-up code from the list available in the queue for the previous segment.
Note: Agents usually assign wrap-up codes during after call work. If agents do not assign a wrap-up code before the specified time expires, Genesys Cloud assigns the default ININ-WRAP-UP-TIMEOUT wrap up code. In some circumstances, outbound dialing assigns wrap-up codes. These codes appear in exported contact lists or conversation events. For more information, see Wrap-up codes assigned by outbound dialing. Genesys recommends that you do not use the Agent requested option in outbound dialing because it allows agents to skip after call work that may result in outbound campaigns performing inaccurately.
Enable manual assignment
To enable manual assignment for a queue from the General tab, enable the Enable Manual Assignment check box. For more information about assigning interactions in a queue, see Manually assign waiting interactions.
Enable auto answer
To enable manual assignment for a queue from the General tab, enable Auto answer. This enables auto answer for all channels. For more information, see Auto answer incoming interactions.
Specify routing method
For more information about how Genesys Cloud uses routing methods to determine how to match interactions and agents, see Evaluation and routing methods.
Choose the routing method
Click the Routing tab.
Under Scoring Method, choose how to score the waiting interactions for ranking. In an interaction surplus scenario, when an agent becomes available, the interaction with the highest rank routes first, based on the routing method and evaluation method that you specify.
Conversation score - A combination of time in queue (in minutes) plus or minus a priority value (in minutes). For example, if a call waits in a queue for 5 minutes and has a priority of 10, the conversation score is 15. This value increases by one for each minute of wait time or increases if the priority value updates to something higher.
Priority score - The priority value assigned by Genesys Cloud.
Note: When different queues have different scoring methods, Genesys Cloud first routes the interactions in queues that have the priority score method set.
You can view the priority of an interaction on the Interaction panel. For more information, see Queues Activity Detail view.
Under Routing Method, select which routing method you want to use:
Standard routing (default)
Predictive routing
Bullseye routing
Preferred agent routing
Conditional group routing
Follow the instructions below for your selected routing method.
Configure standard routing
Under Evaluation Method, select the method by which to match interactions and agents:
All skills matching
Best available skills
Disregard skills, next agent (The agent with the longest time since last interaction.)
Click Save.
Configure predictive routing
Predictive routing currently supports voice, email, and asynchronous message interactions. By default, all threaded emails and messages that occur within 72 hours of the first exchange are forwarded to the agent who last handled the email interaction.
For more information about predictive routing, see Predictive routing overview.
In the Key Performance Indicator box, click the KPI to optimize.
In the Predictive Routing Timeout box, type the timeout period (from 12-259,200 seconds or 72 hours).
Select one of the following predictive routing modes:
To run comparison testing, where some interactions process using predictive routing and the rest by the selected baseline routing method:
Click Run in Comparison Test Mode.
In the Predictive Routing Comparison Test pane, click the routing method to test against predictive routing.
Configure the alternative routing method using the instructions in this article for the method that you chose.
For more information about comparison testing, see Test predictive routing for your queues.
To use predictive routing for all interactions that the queue processes:
Click Use for All Queue Interactions.
To route interactions using predictive routing 80% of the time and the selected baseline routing method 20% of the time:
Click Ongoing Value Monitoring.
In the Ongoing Value Monitoring pane, click the routing method to compare against predictive routing.
Notes:
Selecting this option allows you to measure the ongoing benefit of predictive routing. Genesys recommends that you run ongoing value monitoring for at least a few months. Changing to another mode prematurely may interfere with the evaluation.
You cannot change the 80:20 time split ratio.
For more information about measuring the ongoing benefit, see Monitor ongoing value of predictive routing.
To use workload balancing with predictive routing, set Workload Balancing to On.
To compare the existing occupancy rate with desired occupancy values and then balance the workload, select Set agent occupancy threshold and set the minimum and the maximum values in the slider. Occupancy percentages appear in the Agents Status Summary view. This option ignores the agent wait time.
To use skill matching with predictive routing, set Skill Matching to On.
Under Timeout Routing, click the evaluation method to use when an interaction reaches the predictive routing timeout period and requires a fallback routing method. The fallback method is always standard routing.
Click Save. The Queue list page appears, showing Predictive [Processing...] in the Routing Method column. For more information about the processing phase, see The KPI processing phase.
Configure bullseye routing
Genesys Cloud offers two ways to define bullseye routing rings. First, define up to five rings with the appropriate delays between each ring. Next, perform one of the following steps:
Option 1: Save your changes and from the Members tab assign specific users or groups to each ring. To ensure compatibility with WEM forecasting and scheduling, you can manage expansion by creating skill expression groups defined with the same skills but with varying levels of proficiency.
Option 2: From the Routing tab, add the skills to be removed from routing consideration in each ring.
For more information on bullseye routing, see Advanced routing overview.
Option 1: Configure bullseye routing by assigning specific users or groups to each ring
Define up to five rings with the appropriate delays between each ring.
Click Save & Continue.
Click the Members tab.
To add users to a bullseye routing ring,
Click the Users tab.
Click Add User.
Search for the required user using the search filters.
To add the user or users to the queue, click Add Selected.
To add groups to a bullseye routing ring, perform these steps:
Click the Groups tab.
Click Add Group.
Note: If you are configuring the queue for WEM forecasting and scheduling, add skill expression groups.
Select to search for one of these group types:
Groups only
Skill groups only
Work teams only
In the Enter a name box, begin typing the first few letters of the group and select the appropriate match from the results.
To add the group or groups to the queue, click Add Selected.
Under Bullseye Ring Number, select the ring to which to associate the group.
Repeat steps b–f to add more groups to the queue.
To remove a user or group from the bullseye ring, under Action click X next to the member or group name.
Option 2: Configure bullseye routing by removing skills from routing consideration
Define up to five rings with the appropriate delays between each ring.
In the Time Interval box, type the number of seconds to wait before passing the call to the next consecutive ring.
In the Skills to remove on exit box, click the X next to the skill or skills you want to remove from the selected agents if the exact target is not available to receive the interaction.
Note: The maximum number of skills that you can remove on a single bullseye ring is 50.
To expand the pool of available agents if Genesys Cloud finds no match in the first ring, click Add Ring and repeat steps 1-2 for each consecutive ring, up to six rings.
To remove a ring, click Delete Ring.
Click Save.
Create & Manage Groups, Work Teams, and People
Create & Manage Locations
Create & Manage External Contacts & Authorized Orgs
Add a contact(click on link in the resources)
Prerequisites
The following permissions:
externalContacts > contact > add
externalContacts > contact > edit
External Contacts is a comprehensive repository of data about the people and businesses that your organization interacts with.
You can create external contacts in the following ways:
Salesforce CRM Sync
CSV Upload
External Contacts API
On the profile panel in the CX agent workspace
Within the Directory, as follows:
Click Directory > External Contacts.
Click Add and then Contact.
Type the contact’s name. The First and Last name are required fields.
Click the right arrow. The Contact Information form appears. All Contact Information fields are optional.
(Optional) Search for and select the contact’s organization.
Note: To associate a contact with an organization, add the organization first.
(Optional) Type the contact’s email addresses (Work, Personal, Other).
(Optional) To set up the contact’s phone numbers, do the following:
In the Work, Cell, Home, and Other fields, add the respective telephone numbers.
Notes:
· Genesys recommends that you enter the full E.164 number. You can add non-E.164 numbers to any field, but they are not searchable. Genesys Cloud does not support extension-only numbers.
To add a satellite phone number, enter before the number.
· Genesys Cloud’s default country code is +1 for the United States; however, your admin can change that setting.
To indicate whether a phone number accepts SMS messages, click click to enable SMS or click to disable SMS.
(Optional) To provide a link to additional information about the contact, in the Links section, next to External System, type the URL to an external system.
(Optional) To add social media channel information, click create one?
(Optional) To add a mailing address, type the contact’s address.
(Optional) Set the contact’s survey preferences.
(Optional) To use custom fields, from the Contact Type list, click the contact type and complete the custom fields.
Click Save.
(Optional) Manage notes
Add people one at a time(click on link in the resources)
Prerequisites
Directory > User > All permission
General > Person Administration permission
To avoid invite emails arriving in Spam folders, request that your IT department add the mypurecloud.com domain to their trusted sites list.
Name and email address are required when creating a user account in Genesys Cloud. The following additional information is preferred but optional:
Title
Department
Work phone
Manager’s email*
Office location
Role
Queue
* Having an assigned manager is required for using hierarchy views.
When you create new users, Genesys Cloud automatically sets their status as active whether you send the invitation now or later.
If you choose to send invitations to new users later and manually set their status to inactive, when you send the invitations Genesys Cloud automatically changes their status to active.
Click Admin.
Under People and Permissions, click People.
Click Add Person. The Add People to the Organization dialog box opens.
Click the Person tab.
Complete the mandatory Name and Email fields.
(Optional) Enter additional information by clicking Optional Fields.
Note: The Manager field is optional but recommended. Genesys Cloud uses manager assignments to create hierarchy views.
(Optional) To add the person to a queue, do the following:
Under Assign Queues, begin typing the first few letters of the desired queue.
Select it from the list.
Repeat steps a-b for each additional queue to which to add the person.
Note: Make sure you assign the Employee role, along with any other role. Typically, the employee role is assigned by default. However, manually adding roles during user creation overrides the employee’s assigned default.
(Optional) To add roles for the person, do the following:
Under Assign Roles, begin typing the first few letters of the desired role.
Select it from the list.
Repeat steps a-b for each additional role to assign.
Send the invite automatically by selecting Send invite now.
Note: The people you add cannot join Genesys Cloud until they receive an invite. If you don’t do this now, remember to do it later.
Click Create.
Add an ACD skill(click on link in the resources)
Prerequisites
Routing > Skill > Manage permission
Click Admin.
Under Contact Center, click ACD Skills. The Manage ACD Skills page opens.
From the Category drop-down list, select the category under which you want the skill to be organized:
Languages. For example, an agent who speaks or comprehends Japanese and can assist Japanese-speaking callers.
Skills. For example, if an agent is highly competent in warranty specifications, he or she can be a first choice when the system routes warranty calls to agents.
Select Add Skill. The Add Skill dialog box opens.
In the New ACD Skill text box, type the name of the skill you want to add. .
Note: To make the most of ACD skills, keep your entries short and follow a consistent format. For example:
Accounting, Warranty, Service, Windows, Mac.
Not: Some accounting, Knows warranty, Uses Windows but knows some Mac.
Spanish – Oral, Spanish – Written, French – Oral, French – Written.
Not: Spanish–Oral, Speaks French, can read Chinese.
Click Save. A message appears, informing you the new ACD skill tag was successfully created.
You can now assign the skill to agents. For more information, see the Suggested content.
Create a general group(click on link in the resources)
Prerequisites
The following permissions:
To create a group: General > Group Administration
To create a skill expression group: Routing > Skillgroup > Add
To delete a skill expression group: Routing > Skillgroup > Delete
To edit a skill expression group: Routing > Skillgroup > Edit
To view a skill expression group: Routing > Skillgroup > View
If you have a non-admin role with Group permissions, see Create groups (non-admins).
Genesys Cloud features two kinds of groups: general groups and skill expression groups.
You can create membership rules for general groups based on profile data like department or skill. To create a membership rule based on profile data, make sure that your users have the appropriate data in their profiles. For more information, see Group membership rules.
To create a general group, do the following:
Click Admin.
Under Directory, click Groups.
Click the General tab.
Click Add General Group.
In the Name box, type the name as you want it to appear in profiles and search results.
From the Type list, select one of the following:
Official: The group is work-related.
Social: The group is not work-related.
From the Visibility list, select who can find the group:
Public: Anyone can find the group.
Members Only: Only members of the group can find the group.
Note: An owner is a member of a group that they own and can find the group.
Owners Only: Only owners of the group can find the group.
Click Save.
Create a skill expression group(click on link in the resources)
Prerequisites
The following permissions:
To create a group: General > Group Administration
To create a skill expression group: Routing > Skillgroup > Add
To delete a skill expression group: Routing > Skillgroup > Delete
To edit a skill expression group: Routing > Skillgroup > Edit
To view a skill expression group: Routing > Skillgroup > View
If you have a non-admin role with Group permissions, see Create groups (non-admins).
Skill expression groups enable administrators to manage user membership based on skill expressions, which include a skill and a proficiency value. To manage membership based on ACD skills, make sure that your agents have the appropriate ACD skills assigned.
Notes:
Only admins can create skill expression groups.
Unlike general groups, skill expression groups do not have associated chat rooms.
Skill expression groups do not appear in Directory searches.
To create a skill expression group, do the following:
Click Admin.
Under Directory, click Groups.
Click the Skill Expression tab.
Click Add Skill Expression Group.
In the Name box, type the name of your group.
Optionally, in the Description box, add a description for your group.
Under Division, from the list, select the appropriate division.
To save your new group, click Save.
Now that you have created your skill expression group, you can build skill expressions and add members.
Create a work team(click on link in the resources)
Prerequisites
Groups > Team >Add permission
You can create work teams of agents to make it easier to monitor work team performance. Use work teams to configure reports and display agent performance statistics.
Note: There is a limit of 200 work teams per org.
Click Admin.
Under Directory, click Work Teams.
Click New Team.
In the Name box, type the name as it is to appear in views and lists.
In the Description box, type an explanation of the work team’s purpose.
In the Division box, select the division to which this work team belongs.
Note: The Create Work team permission is Division aware. You can create work teams only for divisions where you have the Create Work team permission. Team members must belong to the same division.
Click Save.
Create a division(click on link in the resources)
Create and configure divisions that can include certain object types.
Notes:
An organization can create up to 50 divisions.
Division names are limited to 500 characters.
You can view user and queue information in certain views, regardless of division restrictions.
To create a division, follow these steps:
Click Admin.
Under People & Permissions, click Divisions.
Click Create Division.
Enter the division name and click Save. The new division opens to the Settings tab.
(Optional) Add a more detailed description to the division and then click Save.
At this point, you must grant yourself or another user the appropriate role in the division so that someone can move objects into the new division. If you are unable to move an object into a division, confirm that you have permission to edit that type of object in:
The division in which the object currently belongs.
The division into which you want to move the object.
Schedules, Schedule Groups & Emergency Groups
Call & Message Routing
Prompt Management
Disconnecting Stuck Interactions
Create a schedule(click on link in the resources)
Prerequisites
Routing > Schedule > Add, Edit, View, Delete permissions
Use schedules to determine how to manage routing for inbound and outbound interactions. For example, a schedule can determine which flow to run during open or closed hours.
Note: Genesys Cloud evaluates schedules in the following order:
Holiday
Closed
Open
If Emergency routing is activated, Genesys Cloud first evaluates emergencies or performs emergency routing, before it evaluates the Holiday schedule.
Click Admin.
Under Routing, click Scheduling.
Click the Schedules tab.
Click Add Schedule.
In the Name box, type a unique name to represent the schedule. This name appears in your list of entries on the Schedules tab.
In the Division list, select the division to which this schedule belongs.
Note: A schedule must belong to a division. The default is the Home division. Association with a division restricts which administrators are able to manage the schedule. For more information, see Divisions overview.
Set a schedule in the When does the schedule first occur and repeat? area. Choose one of these options:
To set a schedule that starts and ends on the same day, set the date and time.
To set a schedule that runs for multiple days, check the This occurrence spans multiple days check box and perform the following steps:
Click in the From calendar box and select the date and time in which to start the schedule.
Click in the To calendar box and select the date in which to stop the schedule.
To run the schedule continuously for the entire duration of the selected date or dates, click All Day.
Set the recurrence of this schedule in the How often does this schedule repeat? field.
The subsequent configuration options change, depending on your selection.
One-time Recurrence
Use this option to schedule any one-time event that will not repeat anytime in future. For example, if your business is closed for an election day, set up a one-time event for the occurrence.
If you are scheduling a one-time event, no other configuration is required.
Click Create or Create and Add New. The Create and Add New option creates the current schedule group and then presents a fresh page to create another schedule.
Daily Recurrence
Use this option to schedule events that occur every day or every few days. For example, if your business does system maintenance every two days between 10:00 PM and 11:00 PM, you can set up a daily occurrence to occur every two days for the required duration.
If the schedule is a daily occurrence, perform the following steps:
To configure the schedule frequency, in the When does this schedule occur? area, in the Every field, select the frequency in which you want the schedule to run. For example, to set a schedule that happens every 10 days, enter 10. The default frequency option is every day, that is one (1).
To configure the schedule end time, in the When does this schedule stop repeating? area, set one of the following:
To run the schedule indefinitely, leave the default Never setting unchanged.
To end the schedule after a specific period, select On and then set the end date and time. To end the schedule automatically at the end of the day, click End of day.
To end the schedule after a specific number of days, select After and then enter the number of occurrences.
Click Create or Create and Add New. The Create and Add New option creates the current schedule group and then presents a fresh page to create another schedule.
The Occurs area displays the schedule summary.
The Upcoming Occurrences displays the first few scheduled occurrence dates.
Weekly Recurrence
Use this option to schedule events that occur on weekly basis. For example, if your business operates between 9:00 AM and 5:00 with a Wednesday holiday, set up a schedule to run for the rest of the days for the required duration. If the schedule is a weekly occurrence, perform the following steps:
Configure the schedule frequency, in the When does this schedule occur during the week? area, set the following:
To configure the days in which the schedule runs, in the Days section, select the days in which you want the schedule to run.
Note: To customize the first day of the week, click the Week Start option and choose the required day.
To configure the frequency of occurrence, set the frequency in the Every field.
To configure the schedule end time, in the When does this schedule stop repeating? area, set one of the following:
To run the schedule indefinitely, leave the default Never setting unchanged.
To end the schedule after a specific period, select On and then set the end date and time. To end the schedule automatically at the end of the day, click End of day.
To end the schedule after a specific number of days, select After and then enter the number of occurrences.
Click Create or Create and Add New. The Create and Add New option creates the current schedule group and then presents a fresh page to create another schedule.
The Occurs area displays the schedule summary.
The Upcoming Occurrences displays the first few scheduled occurrence dates.
Monthly Recurrence
Use this option to schedule events that occur on a monthly basis. For example, if your business operates between 9:00 AM and 12:00 noon the first Sunday of the month, set up a schedule to occur the first Sunday of the month for the required duration.
If the schedule is a monthly occurrence, perform the following steps:
Configure the schedule frequency, in the When does this schedule occur during the month? area, in the On Day field, set the following:
To run the schedule on a specific date or dates of the month, enter the calendar day or days. For example, to run the report on the tenth day of the month, enter 10.
Note: If you enter 31, and the month does not have 31 days, the schedule does not run that month.
To run the schedule on specific days of the month, select the days in which you want the schedule to run.
To run the schedule on a specific day of the week during the month, set the occurrence of the day and the day. For example, set the schedule to run the first day of the month.
To select the frequency in which you want the schedule to run, set the frequency in the Every field. For example, to set a schedule that happens every other month, enter 2.
To configure the schedule end time, in the When does this schedule stop repeating? area, set one of the following:
To run the schedule indefinitely, leave the default Never setting unchanged.
To end the schedule after a specific period, select On and then set the end date and time. To end the schedule automatically at the end of the day, click End of day.
To end the schedule after a specific number of days, select After and then enter the number of occurrences.
Click Create or Create and Add New. The Create and Add New option creates the current schedule group and then presents a fresh page to create another schedule.
The Occurs area displays the schedule summary.
The Upcoming Occurrences displays the first few scheduled occurrence dates.
Yearly Recurrence
Use this option to schedule events that happen once a year. For example, schedules for Christmas holiday.
If the schedule is a yearly occurrence, perform the following steps:
Configure the schedule frequency, in the When does this schedule occur during the year? area, set the following:
Set the month of occurrence in the On Month field.
Set the days of occurrence of schedule in the month specified in the On Day field. Set the following:
To run the schedule on a specific date or dates of the month, enter the calendar day or days. For example, to run the report on the tenth day of the month, enter 10.
Note: If you enter 31, and the month does not have 31 days, the schedule does not run that month.
To run the schedule on specific days of the month, select the days in which you want the schedule to run.
To run the schedule on a specific day of the week during the month, set the occurrence of the day and the day. For example, set the schedule to run the first day of the month.
To select the frequency in which you want the schedule to run, set the frequency in the Every field. For example, to set a schedule that happens every other month, enter 2.
To configure the schedule end time, in the When does this schedule stop repeating? area, set one of the following:
To run the schedule indefinitely, leave the default Never setting unchanged.
To end the schedule after a specific period, select On and then set the end date and time. To end the schedule automatically at the end of the day, click End of day.
To end the schedule after a specific number of days, select After and then enter the number of occurrences.
Click Create or Create and Add New. The Create and Add New option creates the current schedule group and then presents a fresh page to create another schedule.
The Occurs area displays the schedule summary.
The Upcoming Occurrences displays the first few scheduled occurrence dates.
Custom Recurrence
To set a custom schedule, enter a recurrence rule such as the following.
FREQ=YEARLY;INTERVAL=1;BYMONTH=12;BYMONTHDAY=25;BYDAY=MO,TU,WE,TH,FR;BYSETPOS=1 (December 25 for the specified interval if the date falls on a Monday, Tuesday, Wednesday, Thursday, or Friday, with no yearly end date)
FREQ=YEARLY;WKST=SU;BYMONTH=5;INTERVAL=1;BYDAY=MO;BYSETPOS=-1 (the last Monday in May for the specified interval, with no end date)
FREQ=WEEKLY;UNTIL=20190101T000000Z;INTERVAL=2;BYDAY=SA (every other Saturday for the specified interval, ending on January 1, 2019 in UTC time)
FREQ=WEEKLY;INTERVAL=1;BYDAY=MO,WE,FR (weekly on Mondays, Wednesdays, and Fridays for the specified interval, with no end date)
Click Create or Create and Add New. The Create and Add New option creates the current schedule group and then presents a fresh page to create another schedule.
The Occurs area displays the schedule summary.
The Upcoming Occurrences displays the first few scheduled occurrence dates.
Create a schedule group(click on link in the resources)
Prerequisites
Routing > Schedule Group > Add, Edit, View, Delete permissions
When you create a schedule group, you can combine individual schedules into a single group, assign the schedules into a designated time zone, and group the schedules by type. Each schedule group must contain at least one open schedule.
Note: Genesys Cloud evaluates schedules in the following order:
Holiday
Closed
Open
If Emergency routing is activated, Genesys Cloud first evaluates emergencies or performs emergency routing, before it evaluates the Holiday schedule.
To create a schedule group, perform these steps:
Click Admin.
Under Routing, click Scheduling. The Scheduling page opens to the Schedules tab.
Click the Schedule Groups tab.
Click Add Schedule Group.
In the Name box, type a unique name to represent the schedule group. This name appears in your list of entries on the Schedules Group tab.
In the Division list, select the division to which this schedule group belongs.
A schedule group must belong to a division. The default is the Home division. Association with a division restricts which administrators are able to manage the schedule group. For more information, see Divisions overview.
7. From the Time Zone list, choose the time zone to which the grouped schedules apply.
If the selected time zone uses daylight saving time (DST), this is factored into the time the schedule starts.
In the Schedules tab, categorize the schedules as open, closed, and holiday.
Choose the schedule you want to designate as open times:
In the Open Schedules area, under the Open Schedules section, click in the Add existing schedules box.
Begin typing a few letters of the schedule.
Select the required schedules from the list.
Choose the schedule you want to exclude from open schedules:
In the Closed Schedules area, click the Add existing schedules box.
Begin typing a few letters of the schedule.
Select the required schedules from the list.
Choose the schedule you want to designate as for holidays:
In the Holiday Schedules area, click the Add existing schedules box.
Begin typing a few letters of the schedule.
Select the required schedules from the list.
Click Create or Create and Add New. The Create and Add New option creates the current schedule group and then presents a fresh page to create another schedule group.
Use the Calendar tab to view a visual representation of the schedules that are part of a day. You can change the calendar layout to view the schedules for a week, 10 days, or a month.
Add an emergency group(click on link in the resources)
Prerequisites
Routing > Emergency Group > Add, Edit, View, Delete permissions
Create an emergency group and associate it with a call route to quickly and efficiently turn on routing functionality that modifies call routing behavior during unplanned or semi-planned critical events, such as fire, natural disasters, and power outages. Use the activate and deactivate feature to test functionality prior to an actual emergency.
Click Admin.
Under Routing, click Emergency Groups. The Emergency Group page opens.
Click plus.
In the Name box, type a unique name to represent the emergency group. This name appears in your list of entries on the Emergencies page.
Click Save.
Add a call route(click on link in the resources)
Prerequisites
The following permissions:
Architect > Flow > View
Routing > Call Route > Add, Edit, View, Delete
Routing > Emergency Group > Edit, View
Routing > Schedule Group > View
Add a call routing configuration entry to associate a telephone number or numbers with a call route. When callers dial a number specified in the call routing configuration, they will be routed to the appropriate call flow.
Note: You can add an unlimited number of addresses to a call route. However, the more addresses in the call route, the slower the Edge is to process them.
Create the call route entry and associate inbound numbers
Click Admin.
Under Routing, click Call Routing.
Click Add Call Route.
In the Name field, type a unique call routing name. This name appears in your list of entries on the Call Routing page.
In the Division field, enter the division of the call route. This name appears in your list of entries on the Call Routing page.
To add phone numbers to associate with the configuration, do the following:
From the Inbound Numbers drop-down list and select the required inbound numbers.
Begin typing the telephone number string in numeric format only. When the number appears in the list, select the check box beside the number. Already assigned numbers are indicated as such, including the identification and type of assignee.
Repeat step 6b to add more telephone numbers.
Configure call flow routing
To use time-based routing, do the following:
Under When is this call route open?, click the Based on a schedule group radio button.
Click the Select a schedule group… list, type the first few letters of the schedule group to associate to the configuration, and select it from the list.
Under the What call flows should be used?, click the Open list, type the first few letters of the published call flow to associate to the configuration's open hours, and select it from the list.
Click the Closed list, type the first few letters of the published call flow to associate to the configuration's closed hours, and select it from the list.
Choose the method of holiday routing:
Closed Call Flow: Choose to set the call flow to which you want to route calls when the call route is closed.
Route to: Choose to set a holiday call flow.
Bypass Holiday Routing: Choose if you require the call route to ignore any holiday schedules that are configured on the schedule group.
To always route to a single call flow, do the following:
Under When is this call route open?, ensure that the Always radio button is disabled.
Under the What call flow should be used?, click the Route to list, and select an open call flow.
To select a flow to route calls in emergency situations, Select This call route closes in emergency cases radio button, and in the What emergency group should close this call route? section, set the following:
The emergency group in the Select an emergency group… field.
The emergency call flow in the Select an emergency call flow… field.
Click Save. A message appears, indicating that your entry was saved. Your entry may take a few minutes to appear in search results.
Note: Only call flows previously published in Architect appear in this list. You cannot associate a call route configuration with an unpublished call flow.
Add an inbound message route(click on link in the resources)
Prerequisites
The following permissions:
Architect > Flow > View
Routing > Message > Manage
Routing > Queue > Add, Delete, Join, and View
Create a message routing entry and associate inbound numbers or addresses with an inbound message flow. When callers message a number or address specified in the message routing configuration, Genesys Cloud routes them to the appropriate inbound message flow.
Click Admin.
Under Routing, click Message Routing.
Click plus. The Message Routing page opens.
Click Select flow.
Begin typing the first few letters of the inbound message flow you want to use and select it from the list.
To add inbound numbers or addresses to associate with the configuration, do the following:
Under Addresses, click plus.
Click Select address. All available numbers appear.
Click the number you want to add.
Click Add.
Repeat step 6 to add more numbers.
Click Save.
Add a prompt(click on link in the resources)
In Architect, user prompts are company-specific prompts created by Architect users. If you have the appropriate role, you can create, modify, and delete user prompts. From the User Prompts tab, you can add user prompts.
Collapse All
Prompt naming conventions
A prompt name cannot:
Contain spaces or special characters
Begin with a numeric or special character
Include a name already in use
A prompt name can:
Contain letters, numbers, and underscore characters
Begin with a letter
Architect prevents you from creating a prompt that begins with a numeric or special character and prompts you with a message if the prompt name is already in use.
Add a new user prompt
From the Architect home page, click or hover over the Prompts tab and select User Prompts.
Click Add. The Create Prompt dialog box opens.
Enter the prompt name and, optionally, a description of the prompt.
Click Create Prompt. The Edit Prompt dialog box opens.
Do one of the following:
To configure the prompt later, click OK. The system returns to the Prompts tab.
To configure the prompt now, see Configure prompt resources.
Upload an audio file
You can upload .wav audio files to use as user prompts. For more information about supported audio file formats, as well as prompt resources, language, and behavior, see About prompts.
Notes:
The maximum file size is 25MB.
If Architect cannot convert an audio file to a playable format, the upload will fail. All prompt audio files should be in .wav format. In a .csv, Architect assumes specified files without extensions are .wav files.
From the Architect home page, click or hover over the Prompts menu and select User.
Select the check box next to the prompt for which you want to add audio and click the Edit button. The Edit Prompt page opens.
In the Language Resources area, locate the language to which you want to add audio and select the Add Audio link.
From the menu that appears, choose Upload…. The Upload Audio dialog box opens.
Click the Select audio file to import link and navigate to the location where your audio file is stored
To preview the audio file, press the Play button.
Click Upload. Architect processes the audio.
Click OK to close the Edit Prompt dialog box.
Record a prompt from your browser
If you have a microphone installed on your computer or device, you can record a prompt from your browser in .wav format. You can add new user prompts, and you can override the default resources for the languages of system prompts.
Note: Currently, you can only record prompts from the following web browsers:
Firefox: two versions and 1 ESR release previous to the current release
Chrome: two versions previous to the current release
Firefox and Chrome update automatically. Versions of Firefox and Chrome are only an issue if IT restrictions prevent automatic updates. At the time of this release, Genesys Cloud Architect does not support recording prompts from Internet Explorer.
From the Architect home page, click or hover over the Prompts menu and select System or User.
Do one of the following to open the Edit Prompt dialog box:
Create a new user prompt.
Select the check box next to the prompt for which you want to add audio and click the Edit button.
Click the prompt in the Name column.
In the Language Resources area of the Edit Prompt dialog box, locate the language in which you want to add audio and select Add Audio.
From the menu that appears, select Record from browser. The Record Audio dialog box opens, asking you to accept the request at the top of the browser to use the microphone.
At the top of the browser, click Allow.
Note: If you select Deny, a camera icon appears in your browser’s address bar. To record from the browser, click the camera icon, grant appropriate permission to use the microphone, and refresh the page. Depending on whether your application is hosted behind HTTPS or not, you may need to complete this step once or each time you record a prompt.
In the Record Audio dialog box, click Start Recording.
Record your prompt.
When you complete the recording, click the Stop Recording button. Play and Download recording options become available.
Do one of the following:
To download the recording to your computer or device, click the Download recording link and save the file to the desired location.
To playback the recording, click the play button.
To rerecord the audio, click Cancel and repeat Steps 6 through 8.
Click Upload to save the recording, and in the Edit Prompt dialog box click OK to return to the appropriate prompts tab.
Add text to speech to a user prompt
You can enter text-to-speech content to a user prompt, which Architect converts to spoken audio for the caller.
From the Architect home page, click or hover over the Prompts menu and select User.
Do one of the following to open the Edit Prompt dialog box:
Create a new User prompt.
Select the check box next to the prompt for which you want to add audio and click the Edit button.
Click the prompt in the Name column.
In the Resources area of the Edit Prompt dialog box, locate the language in which you want to add text to speech and click the Enter text to speech field.
Add the words or phrases that Architect will convert to speech and play back to the caller.
Select OK.
Disconnect interactions(Click on link in Resources)
Prerequisites
Conversation > Communication > Disconnect permission
This tool allows you to disconnect an interaction that you determine is stuck or, for whatever reason, does not disconnect and clear from the queue. Some behaviors that cause an interaction to remain active include an interaction that appears as active in real-time views but was completed by the agent, an interaction that is not visible and therefore unavailable to an agent, interactions placed on hold when using WebRTC with a persistent connection. Before you disconnect an interaction, consider the following:
To disconnect an interaction, you must have the interaction ID.
Use caution when disconnecting active interactions. Disconnecting an active interaction immediately terminates it.
This tool may not disconnect some interactions. If the issue persists, contact Genesys Cloud Customer Care.
To disconnect an interaction, follow these steps:
Click Admin.
Under Routing, click Disconnect Interactions.
Enter the interaction ID.
Click Disconnect Interaction.
In the Confirm Disconnect dialog box, click Disconnect.
API Usage
OAuth, Integrations & Data Actions
SSO & Authorized Applications
Expand on Schedule Management in Architect
Add a Genesys Cloud data action integration(click on link in the resources)
Important: You can install up to 10 integrations of each integration type in a single Genesys Cloud organization.
Prerequisites
Genesys Cloud OAuth client in your Genesys Cloud organization
To use the integration, add one or more Genesys Cloud data actions integrations to your Genesys Cloud organization. Multiple integrations allow you to use different configurations and data actions to act on data from the Platform API.
Note: When you add more than one integration of a particular type, Genesys Cloud automatically makes the names unique by adding a number after the default name of each additional instance. Unique integration names differentiate the integrations and the associated data actions in the Genesys Cloud applications that reference them.
Add an integration.
The integration opens to the Details tab. On the Details tab, you can change the integration name and add notes about the integration.
Note: If you change the integration name, be sure to use unique names to differentiate the integrations and the associated actions in the Genesys Cloud applications that reference them.
Add credentials.
The credentials use the Genesys Cloud OAuth client credentials.
Click the Configuration tab.
Click the Credentials tab.
Click Configure.
The Configure Credentials dialog box appears.
Enter the following information:
Client ID: The ID generated when you create a Genesys Cloud OAuth client.
Client Secret: The secret generated when you create a Genesys Cloud OAuth client.
Click OK.
Click Save.
A list of all integrations that you have installed appears.
Activate the integration.
Note: If you do not activate the integration, then you cannot test any data actions associated with the integration and the data actions will not appear in Genesys Cloud applications.
Under the integration that you just added, click the Status toggle to change it from Inactive to Active.
A Change Status dialog box appears.
Click Yes.
Add a Web Services data action integration(click on link in the resources)
Important: You can install up to 10 integrations of each integration type in a single Genesys Cloud organization.
To use the integration, add one or more web services data actions integrations to your Genesys Cloud organization. Multiple integrations allow you to use different configurations and custom actions to act on data through different web services.
Note: When you add more than one integration of a particular type, Genesys Cloud automatically makes the names unique by adding a number after the default name of each additional instance. Unique integration names differentiate the integrations and the associated data actions in the Genesys Cloud applications that reference them.
Add an integration.
The integration opens to the Details tab. On the Details tab, you can change the integration name and add notes about the integration.
Note: If you change the integration name, be sure to use unique names to differentiate the integrations and the associated actions in the Genesys Cloud applications that reference them.
Add credentials (if required for the web service).
Click the Configuration tab.
Click the Credentials tab.
Click Configure.
The Configure Credentials dialog box appears.
Select a Credential Type and enter credential information. For more information, see Credential types.
Warning: Do not change a credential type after you configure the integration and publish actions. Changing the credential type could break any actions that are in use. To migrate an active integration to a new credential type, contact Genesys Cloud Customer Care.
Basic Auth
Enter information for the following items:
Username: Your web service login ID.
Password (optional): Password for your web service login ID.
User Defined
Click Add Credential Field.
Add Field Name and Value.
Repeat steps i and ii for more user-defined field names and values.
For more information, see How to use the User Defined credential type.
User Defined (OAuth)
Click Add Credential Field.
Add Field Name and Value.
Repeat steps i and ii for more user-defined field names and values.
For more information, see How to use the User Defined (OAuth) credential type and Workflow for the User Defined (OAuth) credential type.
Click OK.
Click Save.
A list of all integrations that you have installed appears.
Activate the integration.
Note: If you do not activate the integration, then you cannot test any data actions associated with the integration and the data actions will not appear in Genesys Cloud applications.
Under the integration that you just added, click the Status toggle to change it from Inactive to Active.
A Change Status dialog box appears.
Click Yes.
Add a Google data action integration(click on link in the resources)
Important: You can install up to 10 integrations of each integration type in a single Genesys Cloud organization.
To use the integration, add one or more Google data actions integrations to your Genesys Cloud organization. Multiple integrations allow you to use different configurations and data actions to act on data in different Google accounts.
Note: When you add more than one integration of a particular type, Genesys Cloud automatically makes the names unique by adding a number after the default name of each additional instance. Unique integration names differentiate the integrations and the associated data actions in the Genesys Cloud applications that reference them.
Add an integration.
The integration opens to the Details tab. On the Details tab, you can change the integration name and add notes about the integration.
Note: If you change the integration name, be sure to use unique names to differentiate the integrations and the associated actions in the Genesys Cloud applications that reference them.
Add credentials.
Click the Configuration tab.
Click the Credentials tab.
Click Configure.
The Configure Credentials dialog box appears.
Select the Credential Type for the Google application that you will use with this data actions integration.
For Google Cloud Platform, select googleCloudPlatformServiceAccount.
For G Suite, select googleGSuiteServiceAccount.
Enter the following information based on the Credential Type selected:
googleCloudPlatformServiceAccount
Client ID: The unique ID for your Google service account. Also, client_id in the JSON key file that your account generates.
Client Email: The email for your Google service account. Also, client_email in the JSON key file that your account generates.
Private Key ID: private_key_id in the JSON key file that your Google service account generates.
Private Key: private_key in the JSON key file that your Google service account generates.
Tip: To prevent errors in the value, copy the entire contents between the quotes, but not inclusive of the quotes. The action service correctly processes the additional characters.
googleGSuiteServiceAccount
Click OK.
Click Save.
A list of all integrations that you have installed appears.
Activate the integration.
Note: If you do not activate the integration, then you cannot test any data actions associated with the integration and the data actions will not appear in Genesys Cloud applications.
Under the integration that you just added, click the Status toggle to change it from Inactive to Active.
A Change Status dialog box appears.
Click Yes.
Add a Microsoft Dynamics 365 data action integration(click on link in the resources)
Important: You can install up to 10 integrations of each integration type in a single Genesys Cloud organization.
Prerequisites
The integration registered in Azure Active Directory
To use the integration, add one or more Microsoft Dynamics 365 data actions integrations to your Genesys Cloud organization. Multiple integrations allow you to use different configurations and data actions to act on data in different Microsoft Dynamics 365 accounts.
Note: When you add more than one integration of a particular type, Genesys Cloud automatically makes the names unique by adding a number after the default name of each additional instance. Unique integration names differentiate the integrations and the associated data actions in the Genesys Cloud applications that reference them.
Add an integration.
The integration opens to the Details tab. On the Details tab, you can change the integration name and add notes about the integration.
Note: If you change the integration name, be sure to use unique names to differentiate the integrations and the associated actions in the Genesys Cloud applications that reference them.
Add credentials.
Click the Configuration tab.
Click the Credentials tab.
Click Configure.
The Configure Credentials dialog box appears.
Enter the following information:
Username: Your Microsoft Dynamics 365 login ID.
The user must be able to access any data that you want to make available to the Microsoft Dynamics 365 data action integration.
Password: Password for your Microsoft Dynamics 365 login ID.
Root Organization Web Address: The URL of your Microsoft Dynamics 365 organization, for example, https://contoso.crm.dynamics.com.
Application ID: The ID for your Microsoft Dynamics 365 organization.
The application ID is created through the application registration in Azure Active Directory. For more information, see Register the integration.
Click OK.
Click Save.
A list of all integrations that you have installed appears.
Activate the integration.
Note: If you do not activate the integration, then you cannot test any data actions associated with the integration and the data actions will not appear in Genesys Cloud applications.
Under the integration that you just added, click the Status toggle to change it from Inactive to Active.
A Change Status dialog box appears.
Click Yes.
Add a Salesforce data action integration(click on link in the resources)
Important: You can install up to 10 integrations of each integration type in a single Genesys Cloud organization.
To use the integration, add one or more Salesforce data actions integrations to your Genesys Cloud organization. Multiple integrations allow you to use different configurations and data actions to act on data in different Salesforce accounts.
Note: When you add more than one integration of a particular type, Genesys Cloud automatically makes the names unique by adding a number after the default name of each additional instance. Unique integration names differentiate the integrations and the associated data actions in the Genesys Cloud applications that reference them.
Add an integration.
The integration opens to the Details tab. On the Details tab, you can change the integration name and add notes about the integration.
Note: If you change the integration name, be sure to use unique names to differentiate the integrations and the associated actions in the Genesys Cloud applications that reference them.
Add credentials.
Click the Configuration tab.
Click the Credentials tab.
Click Configure.
The Configure Credentials dialog box appears.
Enter the following information:
Username: Your Salesforce login ID.
Use a Salesforce profile that has API Enabled selected and View All selected for accounts, cases, and contacts. This user (preferably a system admin) must be able to access any standard and custom fields that are used in Genesys Cloud applications.
Password: Password for your Salesforce login ID.
Security Token: The API token generated for the Salesforce organization.
The token is an alphanumeric string like AS4DFA9SasdJas2HIasd1asdf.
Login URL: Salesforce URL used to connect to the API.
The service defaults to https://login.salesforce.com. For a test organization, select https://test.salesforce.com.
Click OK.
Click Save.
A list of all integrations that you have installed appears.
Activate the integration.
Note: If you do not activate the integration, then you cannot test any data actions associated with the integration and the data actions will not appear in Genesys Cloud applications.
Under the integration that you just added, click the Status toggle to change it from Inactive to Active.
A Change Status dialog box appears.
Click Yes.
Add a Zendesk data action integration(click on link in the resources)
Important: You can install up to 10 integrations of each integration type in a single Genesys Cloud organization.
To use the integration, add one or more Zendesk data actions integrations to your Genesys Cloud organization. Multiple integrations allow you to use different configurations and data actions to act on data in different Zendesk accounts.
Note: When you add more than one integration of a particular type, Genesys Cloud automatically makes the names unique by adding a number after the default name of each additional instance. Unique integration names differentiate the integrations and the associated data actions in the Genesys Cloud applications that reference them.
Add an integration.
The integration opens to the Details tab. On the Details tab, you can change the integration name and add notes about the integration.
Note: If you change the integration name, be sure to use unique names to differentiate the integrations and the associated actions in the Genesys Cloud applications that reference them.
Add credentials.
Click the Configuration tab.
Click the Credentials tab.
Click Configure.
The Configure Credentials dialog box appears.
Enter the following information:
Email: Your Zendesk login ID.
Base Service URL: The URL of the Zendesk service used to connect to the API, formatted as https://{subdomain}.zendesk.com.
API Token: The API token generated for your Zendesk organization.
Click OK.
Click Save.
A list of all integrations that you have installed appears.
Activate the integration.
Note: If you do not activate the integration, then you cannot test any data actions associated with the integration and the data actions will not appear in Genesys Cloud applications.
Under the integration that you just added, click the Status toggle to change it from Inactive to Active.
A Change Status dialog box appears.
Click Yes.
Add an Adobe data action integration(click on link in the resources)
Important: You can install up to 10 integrations of each integration type in a single Genesys Cloud organization.
To use the integration, add one or more Adobe data actions integrations to your Genesys Cloud organization. Multiple integrations allow you to use different configurations and data actions to act on data in different Adobe accounts.
Note: When you add more than one integration of a particular type, Genesys Cloud automatically makes the names unique by adding a number after the default name of each additional instance. Unique integration names differentiate the integrations and the associated data actions in the Genesys Cloud applications that reference them.
Add an integration.
The integration opens to the Details tab. On the Details tab, you can change the integration name and add notes about the integration.
Note: If you change the integration name, be sure to use unique names to differentiate the integrations and the associated actions in the Genesys Cloud applications that reference them.
Add credentials.
Click the Configuration tab.
Click the Credentials tab.
Click Configure.
The Configure Credentials dialog box appears.
Enter the following information:
Client ID: The client ID generated in the Adobe I/O Console.
Client Secret: The client secret generated in the Adobe I/O Console.
Organization ID: The organization ID in the Adobe I/O Console, formatted as org_ident@AdobeOrg.
Technical Account ID: The technical account ID in the Adobe I/O console, formatted as id@techacct.adobe.com.
Private Key: The private key that matches the public key in the Adobe I/O Console.
The private key could be generated by the Adobe I/O Console, or the private key could be part of a public/private key pair generated by the customer.
Login URL: The Adobe URL used to connect to the API.
The service defaults to https://ims-na1.adobelogin.com/ims/exchange/jwt.
Audience: The audience field for generating a JWT token, formatted as https://ims-na1.adobelogin.com/c/{api_key}.
For more information, see JWT (Service Account) Authentication in the Adobe I/O documentation.
Adobe Metascopes Assertions: The pipe-delimited metascope URLs for Adobe JSON Web Token (JWT) assertions.
The service defaults to https://ims-na1.adobelogin.com/s/ent_dataservices_sdk. For more information, see JWT Metascopes in the Adobe documentation.
Sandbox Name (optional): The name of the default sandbox that the integration uses.
If the sandbox name is set in a data action, the value used in the data action overrides the value in the credentials.
e. For more information, see Integration overview and prerequisites in the Adobe documentation.
Click OK.
Click Save.
A list of all integrations that you have installed appears.
Activate the integration.
Note: If you do not activate the integration, then you cannot test any data actions associated with the integration and the data actions will not appear in Genesys Cloud applications.
Under the integration that you just added, click the Status toggle to change it from Inactive to Active.
A Change Status dialog box appears.
Click Yes.
Add an AWS Lambda data action integration(click on link in the resources)
Important: You can install up to 10 integrations of each integration type in a single Genesys Cloud organization.
Prerequisites
IAM resources created in your AWS account
To use the integration, add one or more AWS Lambda data actions integrations to your Genesys Cloud organization. Multiple integrations allow you to use different configurations and custom actions to act on data through different AWS Lambda functions.
Note: When you add more than one integration of a particular type, Genesys Cloud automatically makes the names unique by adding a number after the default name of each additional instance. Unique integration names differentiate the integrations and the associated data actions in the Genesys Cloud applications that reference them.
Add an integration.
The integration opens to the Details tab. On the Details tab, you can change the integration name and add notes about the integration.
Note: If you change the integration name, be sure to use unique names to differentiate the integrations and the associated actions in the Genesys Cloud applications that reference them.
Add credentials.
Click the Configuration tab.
Click the Credentials tab.
Click Configure.
The Configure Credentials dialog box appears.
Enter the following information:
Role ARN: The role in your AWS account that has access to one or more of your AWS Lambda functions. This credential allows Genesys Cloud to access and invoke the AWS Lambda functions associated with this role.
Click OK.
Click Save.
A list of all integrations that you have installed appears.
Activate the integration.
Note: If you do not activate the integration, then you cannot test any data actions associated with the integration and the data actions will not appear in Genesys Cloud applications.
Under the integration that you just added, click the Status toggle to change it from Inactive to Active.
A Change Status dialog box appears.
Click Yes.
Add Google Workspace as a single sign-on provider(click on link in the resources)
Prerequisites:
Single Sign-on > Provider > Add, Delete, Edit, View permissions
Admin role in your organization’s Google Workspace account
User email addresses are the same in both Google Workspace and Genesys Cloud
Add Genesys Cloud as an application that organization members can access with the credentials to their Google Workspace account.
Notes:
Genesys Cloud does not support assertion encryption for single sign-on third-party identity providers. The Genesys Cloud log in service requires Transport Layer Security (TLS). Since the channel is encrypted, there is no need to encrypt parts of the message.
Administrators can optionally disable the default Genesys Cloud login and enforce authentication using a single sign-on provider. For more information, see Configure Genesys Cloud to authenticate with SSO only.
Google Workspace does not support the automatic log out of SSO provider.
The Google Workspace SSO integration does not work with third-party applications, including Chromium-based apps.
Administrators can choose to store one more certificate to ensure business continuity. If one certificate becomes invalid or expires, the backup certificate preserves the integration.
· There is a general problem when a Service Provider (SP) receives a SAML response from an Identity Provider (IdP) and their system clocks are not in sync. This problem can result in users getting locked out of their single sign-on when logging in. The problem might be caused by the length of the clock skew between the SP and the IdP. Clock skews between Genesys Cloud and your identity provider cannot be greater than 10 seconds.
Configure Google Workspace
Create a custom Genesys Cloud application
In the Admin console, click Google > Apps > SAML.
Click (+) in the bottom-right corner.
In Step 1 Enable SSO for SAML Application, click Setup my own custom app.
In Step 2 Google IdP Information, complete the following fields and leave the rest of the fields blank or at the default settings.
Field
Description
SSO URL
Copy and save this URL to use as the Target URI in the Genesys Cloud configuration.
Entity ID
Copy and save this URL to use as the Issuer URI in the Genesys Cloud configuration.
Certificate
Download the certificate.
In Step 3 Basic Information for your Custom App, complete the following field and leave the rest of the fields blank or at the default settings.
Field
Description
Application Name
Type your Genesys Cloud application name.
In Step 4 Service Provider Details, complete the following fields and leave the rest of the fields blank or at the default settings.
Field
Description
ACS URL
Type the URL of your Genesys Cloud organization for the AWS region:
US East (N. Virginia): https://login.mypurecloud.com/saml
US East 2 (Ohio): https://login.use2.us-gov-pure.cloud/saml
US West (Oregon): https://login.usw2.pure.cloud/saml
Canada (Canada Central): https://login.cac1.pure.cloud/saml
South America (São Paulo): https://login.sae1.pure.cloud/saml
EU (Frankfurt): https://login.mypurecloud.de/saml
EU (Ireland): https://login.mypurecloud.ie/saml
EU (London): https://login.euw2.pure.cloud/saml
Asia Pacific (Mumbai) https://login.aps1.pure.cloud/saml
Asia Pacific (Seoul): https://login.apne2.pure.cloud/saml
Asia Pacific (Sydney): https://login.mypurecloud.com.au/saml
Asia Pacific (Tokyo): https://login.mypurecloud.jp/saml
Entity ID
Type a unique string that you want to use to identify the Entity ID, for example: mypurecloud.com/google
Name ID Format
From the list, select TRANSIENT.
In Step 5 Attribute Mapping, leave the default settings.
Click Finish.
SAML attributes
If the following extra SAML attributes are present in the assertion, Genesys Cloud acts on the attributes. The attributes are case-sensitive.
Attribute name
Attribute value
OrganizationName
For identity provider-initiated single sign-on: Use the organization short name.
For service provider-initiated single sign-on: Make sure that the organization name matches the organization name that you select. It is applicable when an organization maintains multiple Genesys Cloud organizations using a single identity provider.
Email address of the Genesys Cloud user to be authenticated.
You must be an existing Genesys Cloud user.
If the identity provider does not use an email address as the subject NameID, you require a valid email address.
ServiceName
(Optional) A valid URL for the browser to be redirected to after successful authentication, or one of the following keywords:
directory (redirects to the Genesys Cloud Collaborate client)
directory-admin (redirects to the Genesys Cloud Admin UI)
Configure Genesys Cloud
In Genesys Cloud, click Admin.
Under Integrations, click Single Sign-on.
Click the Google G Suite tab.
Type the identity provider metadata gathered from Google Workspace.
Field
Description
Certificate
To upload X.509 certificates for SAML signature validation, do one of the following.
1. To upload a certificate, click Select Certificates to upload.
2. Select the X.509 certificate.
3. Click Open.
4. Optionally, to load a backup certificate, repeat steps 1–3.
Or you can:
5. Drag and drop your certificate file.
6. Optionally, to load a backup certificate, repeat the first step.
Uploaded certificates appear with their expiration date. To remove a certificate, click X.
Issuer URI
Type the Entity ID from Step 2 Google IDP Information in the Google Workspace Genesys Cloud custom application, for example:
https://accounts.google.com/o/saml2?idpid=C0151g8I9
Target URI
Type the SSO URL from Step 2 Google IDP Information in the Google Workspace Genesys Cloud custom application, for example: https://accounts.google.com/o/saml2/idp?idpid=C0151g8I9
Relying Party Identifier
Type the Entity ID from Step 4 Service Provider Details in the Google Workspace Genesys Cloud custom application, for example: mypurecloud.com/google
Note: The values and functionality of the Entity ID in the Google IDP Information is different from the Entity ID in the Service Provider Details for your Genesys Cloud application.
Click Save.
Add Microsoft ADFS as a single sign-on provider(click on link in the resources)
Prerequisites:
Single Sign-on > Provider > Add, Delete, Edit, View permissions
Admin role in your organization’s ADFS account
User email addresses are the same in both ADFS and Genesys Cloud
Any Microsoft ADFS version that supports SAML 2.0. There are some differences in the configuration, depending on the version.
Add Genesys Cloud as an application that organization members can access with the credentials to their Microsoft ADFS account.
Notes:
Genesys Cloud does not support assertion encryption for single sign-on third-party identity providers. The Genesys Cloud log in service requires Transport Layer Security (TLS). Since the channel is encrypted, there is no need to encrypt parts of the message.
Administrators can optionally disable the default Genesys Cloud login and enforce authentication using an SSO provider only. For more information, see Configure Genesys Cloud to authenticate with SSO only.
Administrators can choose to store one additional certificate to ensure business continuity. If one certificate becomes invalid or expires, the backup certificate will preserve the integration.
· There is a general problem when a Service Provider (SP) receives a SAML response from an Identity Provider (IdP) and their system clocks are not in sync. This problem can result in users getting locked out of their single sign-on when logging in. The problem might be caused by the length of the clock skew between the SP and the IdP. Clock skews between Genesys Cloud and your identity provider cannot be greater than 10 seconds.
The Genesys Cloud desktop app does not support the installation of browser extensions. If you have configured an Azure Conditional Access policy that requires a browser extension, you will need to use a Genesys Cloud supported browser that has the Azure AD extension installed. Single sign-on will not work using the desktop app in this configuration.
Configure Microsoft ADFS
Get the certificate for ADFS configuration
In Genesys Cloud, click Admin.
Under Integrations, click Single Sign-on.
Click the ADFS/Azure AD (Premium) tab.
Under Genesys Cloud Signing Certificate, click Download Certificate.
Save the file.
Add a Relying Party Trust
Go to Administrative Tools > AD FS.
In the console tree, go to AD FS > Trust Relationships > Relying Party Trusts.
To open the wizard, click Add Relying Party Trust.
On the Select Data Source page, click Enter data about the replying party manually.
On the Specify Display Name page, enter a name for the replying party (that is Genesys Cloud).
On the Choose Profile page, click AD FS profile to select SAML.
Skip the Configure Certificate page.
In the Configure URL page, do the following steps:
Click Enable support for SAML 2.0 WebSSO protocol.
b. In the field below the check box, type the following URL of your Genesys Cloud organization based on the AWS region.
AWS Region
URL
US East (N. Virginia)
https://login.mypurecloud.com/saml
US East 2 (Ohio)
https://login.use2.us-gov-pure.cloud/saml
US West (Oregon)
https://login.usw2.pure.cloud/saml
Canada (Canada Central)
https://login.cac1.pure.cloud/saml
South America (São Paulo)
https://login.sae1.pure.cloud/saml
EU (Frankfurt)
https://login.mypurecloud.de/saml
EU (Ireland)
https://login.mypurecloud.ie/saml
EU (London)
https://login.euw2.pure.cloud/saml
Asia Pacific (Mumbai)
https://login.aps1.pure.cloud/saml
Asia Pacific (Seoul)
https://login.apne2.pure.cloud/saml
Asia Pacific (Sydney)
https://login.mypurecloud.com.au/saml
Asia Pacific (Tokyo)
https://login.mypurecloud.jp/saml
In the Configure Identifiers page, type a value for the Relying party trust identifier. The value can be any unique string that you want to use to identify the relying party trust. On identifying a relying party in a request to the Federation Service, AD FS uses prefix matching logic to determine a matching party trust in the AD FS configuration database.
On the Configure Multi-factor authentication now page, choose whether to configure MFA.
Note: This document does not cover the procedure to configure MFA.
Leave all other settings at their defaults and click Close.
On the Relying Party Trusts page, right-click the trust that you created in the previous procedure and select Properties.
In the Endpoints tab, click Add SAML.
For Endpoint Type, choose SAML Logout.
AWS Region
URL
US East (N. Virginia)
https://login.mypurecloud.com/saml/logout
US East 2 (Ohio)
https://login.use2.us-gov-pure.cloud/saml/logout
US West (Oregon)
https://login.usw2.pure.cloud/saml/logout
Canada (Canada Central)
https://login.cac1.pure.cloud/saml/logout
South America (São Paulo)
https://login.sae1.pure.cloud/saml/logout
EU (Frankfurt)
https://login.mypurecloud.de/saml/logout
EU (Ireland)
https://login.mypurecloud.ie/saml/logout
EU (London)
https://login.euw2.pure.cloud/saml/logout
Asia Pacific (Mumbai)
https://login.aps1.pure.cloud/saml/logout
Asia Pacific (Seoul)
https://login.apne2.pure.cloud/saml/logout
Asia Pacific (Sydney)
https://login.mypurecloud.com.au/saml/logout
Asia Pacific (Tokyo)
https://login.mypurecloud.jp/saml/logout
Click OK.
In the Signature tab, click Add.
Choose the certificate saved in step 5 of “Get the certificate for ADFS configuration” and click Open.
Click OK.
Add the claim rules
Add three claim rules: Email, Email to NameID, and Org Name.
On the Relying Party Trusts page, right-click the trust that you created in the previous procedure and select Edit Claim Rules.
Add the Email rule:
Click Add Rule.
b. Configure the claim rule with the following settings:
Property
Description
Claim rule template
Select Send LDAP Attributes as Claims.
Claim rule name
Type Email.
Attribute store
Select Active Directory.
LDAP Attribute
Select E-Mail Addresses.
Outgoing claim type
Select E-Mail Address.
Click Finish.
Add the Email to NameID rule:
Click Add Rule.
b. Configure the claim rule with the following settings:
Property
Description
Claim rule template
Select Transform an Incoming Claim.
Claim rule name
Type Email to NameID.
Incoming claim type
Select E-Mail Address.
Outgoing claim type
Select Name ID.
Outgoing name ID format
Select Transient Identifier.
Pass through all claims
Select Pass through all claim values.
c. Click Finish.
4. Add the Org Name rule:
Click Add Rule.
b. Configure the claim rule with the following settings:
Property
Description
Claim rule template
Select Send Claims Using a Custom Rule.
Claim rule name
Type Org Name.
Custom rule
Enter the following text, and replace OrgName with the shortname of your Genesys Cloud organization. The organization name is case-sensitive.
=> issue(Type = "OrganizationName", Value = "OrgName");
Click Finish.
In the Issuance Transform Rules tab, make sure that the rules are in the following order:
Email to NameID
Org Name
SAML attributes
If the following SAML attributes are present in the assertion, Genesys Cloud acts on those attributes. The attributes are case-sensitive.
Attribute name
Attribute value
OrganizationName
For identity provider-initiated single sign-on: Use the organization short name.
For service provider-initiated single sign-on: The organization name must match the organization that you select. Applicable when an organization maintains multiple Genesys Cloud organizations using a single identity provider.
Email address of the Genesys Cloud user to be authenticated.
You must be an existing Genesys Cloud user.
If the identity provider does not use an email address as the subject NameID, you require a valid email address.
ServiceName
(Optional) A valid URL for the browser to be redirected to after successful authentication, or one of the following keywords:
directory (redirects to the Genesys Cloud Collaborate client)
directory-admin (redirects to the Genesys Cloud Admin UI)
Get the certificate for Genesys Cloud configuration
In the console tree, go to AD FS > Service > Certificates.
Right-click the certificate under Token-signing and select View Certificate.
Click the Details tab and click Copy to file.
For the export file format, select Base-64 encoded X.509 (.CER).
For the file name, do the following steps:
Click Browse.
Type a file name.
Click Save.
Click Finish.
Get the metadata for Genesys Cloud configuration
The metadata file contains the issuer (entityID) and the redirect URL for configuring Genesys Cloud.
In the console tree, go to AD FS > Service > Endpoints.
Navigate to and download the file called FederationMetadata.xml.
Select authentication methods
Select the authentication methods for logging into Genesys Cloud on the extranet and the intranet.
In the console tree, go to AD FS > Authentication Policies.
Under Primary Authentication > Global Settings, click Edit.
Under Extranet, check Forms Authentication.
Under Intranet, check Forms Authentication and Windows Authentication.
Click OK.
Configure Genesys Cloud
In Genesys Cloud, click Admin.
Under Integrations, click Single Sign-on.
Click the ADFS/Azure AD (Premium) tab.
4. Enter the Identity Provider metadata gathered from Microsoft ADFS.
Field
Description
Certificate
To upload X.509 certificates for SAML signature validation, do one of the following.
1. To upload a certificate, click Select Certificates to upload.
2. Select the X.509 certificate.
3. Click Open.
4. Optionally, to load a backup certificate, repeat steps 1–3.
Or you can:
5. Drag and drop your certificate file.
6. Optionally, to load a backup certificate, repeat the first step.
Uploaded certificates appear with their expiration date. To remove a certificate, click X.
Issuer URI
Enter the entityID from the FederationMetadata.xml file.
Target URI
Find the SingleSignOnService tag in the FederationMetadata.xml file with Binding equal to “urn:oasis:names:tc:SAML:2.0:bindings:HTTP-Redirect.” For example: <SingleSignOnService Binding="urn:oasis:names:tc:SAML:2.0:bindings:HTTP-Redirect" Location="https://your-adfs.com/adfs/ls”>
Use the URL contained in the “Location” attribute. For example: https://your-adfs.com/adfs/ls
Single Logout URI
Find the SingleLogoutService tag in the FederationMetadata.xml file with Binding equal to “urn:oasis:names:tc:SAML:2.0:bindings:HTTP-Redirect,” for example: <SingleLogoutService Binding="urn:oasis:names:tc:SAML:2.0:bindings:HTTP-Redirect" Location="https://your-adfs.com/adfs/ls”>
Use the URL contained in the “Location” attribute. For example: https://your-adfs.com/adfs/ls
Single Logout Binding
Select HTTP Redirect.
Relying Party Identifier
Add the unique identifier configured in step 9 when adding the Relying Party Trust.
Click Save.
Add Okta as a single sign-on provider(click on link in the resources)
Prerequisites:
Single Sign-on > Provider > Add, Delete, Edit, and View permissions
Admin role in your organization’s Okta account
User email addresses are the same in both Okta and Genesys Cloud
Add Genesys Cloud as an application that organization members can access with the credentials to their Okta account.
Notes:
Genesys Cloud does not support assertion encryption for single sign-on third-party identity providers. The Genesys Cloud log in service requires Transport Layer Security (TLS). Since the channel is encrypted, there is no need to encrypt parts of the message.
Administrators can optionally disable the default Genesys Cloud login and enforce authentication using an SSO provider only. For more information, see Configure Genesys Cloud to authenticate with SSO only.
Administrators can choose to store one additional certificate to ensure business continuity. If one certificate becomes invalid or expires, the backup certificate will preserve the integration.
· There is a general problem when a Service Provider (SP) receives a SAML response from an Identity Provider (IdP) and their system clocks are not in sync. This problem can result in users getting locked out of their single sign-on when logging in. The problem might be caused by the length of the clock skew between the SP and the IdP. Clock skews between Genesys Cloud and your identity provider cannot be greater than 10 seconds.
The Genesys Cloud desktop app does not support the installation of browser extensions. If you have configured an Azure Conditional Access policy that requires a browser extension, you will need to use a Genesys Cloud supported browser that has the Azure AD extension installed. Single sign-on will not work using the desktop app in this configuration.
Configure Okta
Get the certificate for Okta configuration
In Genesys Cloud, click Admin.
Under Integrations, click Single Sign-on.
Click the Okta tab.
Under Genesys Cloud Signing Certificate, click Download Certificate.
Save the file.
Create a SAML application
Create a SAML application for Genesys Cloud. Follow the instructions for setting up a SAML application in Okta in the Okta developer documentation.
2. In the General > Single sign on URL field, type the URL of your Genesys Cloud organization based on the AWS region.
AWS Region
URL
US East (N. Virginia)
https://login.mypurecloud.com/saml
US East 2 (Ohio)
https://login.use2.us-gov-pure.cloud/saml
US West (Oregon)
https://login.usw2.pure.cloud/saml
Canada (Canada Central)
https://login.cac1.pure.cloud/saml
South America (São Paulo)
https://login.sae1.pure.cloud/saml
EU (Frankfurt)
https://login.mypurecloud.de/saml
EU (Ireland)
https://login.mypurecloud.ie/saml
EU (London)
https://login.euw2.pure.cloud/saml
Asia Pacific (Mumbai)
https://login.aps1.pure.cloud/saml
Asia Pacific (Seoul)
https://login.apne2.pure.cloud/saml
Asia Pacific (Sydney)
https://login.mypurecloud.com.au/saml
Asia Pacific (Tokyo)
https://login.mypurecloud.jp/saml
3. In General > Audience URI, the value can be any unique string that you want to use to identify your Genesys Cloud organization.
4. For General > Name ID Format, choose EmailAddress.
5. Click Show Advanced Settings.
For the General > Signature Certificate field, click Browse.
Choose the certificate file saved in step 5 of “Get the Certificate for Okta Configuration.”
Click Upload Certificate.
9. Click the General > Enable Single Logout check box.
10. In General > Single Logout URL, type the URL of your Genesys Cloud organization based on the AWS region.
AWS Region
URL
US East (N. Virginia)
https://login.mypurecloud.com/saml/logout
US East 2 (Ohio)
https://login.use2.us-gov-pure.cloud/saml/logout
US West (Oregon)
https://login.usw2.pure.cloud/saml/logout
Canada (Canada Central)
https://login.cac1.pure.cloud/saml/logout
South America (São Paulo)
https://login.sae1.pure.cloud/saml/logout
EU (Frankfurt)
https://login.mypurecloud.de/saml/logout
EU (Ireland)
https://login.mypurecloud.ie/saml/logout
EU (London)
https://login.euw2.pure.cloud/saml/logout
Asia Pacific (Mumbai)
https://login.aps1.pure.cloud/saml/logout
Asia Pacific (Seoul)
https://login.apne2.pure.cloud/saml/logout
Asia Pacific (Sydney)
https://login.mypurecloud.com.au/saml/logout
Asia Pacific (Tokyo)
https://login.mypurecloud.jp/saml/logout
Use the default values for other fields.
Specify the organization so that Genesys Cloud users do not need to enter it when they log in. Create a new entry in Attributes Statements (Optional) with the following values:
Field
Description
Name
Type OrganizationName.
Name Format
Leave set to Unspecified.
Value
Type the short name of your Genesys Cloud organization. If you do not know the short name of your organization, click Admin > Account Settings > Organization Settings in Genesys Cloud.
SAML attributes
If the following extra SAML attributes are present in the assertion, Genesys Cloud acts on the attributes. The attributes are case-sensitive.
Attribute name
Attribute value
Email address of the Genesys Cloud user to be authenticated.
You must be an existing Genesys Cloud user.
If the identity provider does not use an email address as the subject NameID, you require a valid email address.
ServiceName
(Optional) A valid URL for the browser to be redirected to after successful authentication, or one of the following keywords:
directory (redirects to the Genesys Cloud Collaborate client)
directory-admin (redirects to the Genesys Cloud Admin UI)
Get the metadata for Genesys Cloud configuration
In Sign on > Settings, click View Setup Instructions to display setup information.
Note the following Identity Provider metadata that you need for the Genesys Cloud configuration.
Metadata
Description
Identity Provider Single Sign-on URL
Use for the Target URI setting in Genesys Cloud.
Identity Provider Single Logout URL
Use for the Single Logout URI setting in Genesys Cloud.
Identity Provider Issuer
Use for the Okta Issuer URI setting in Genesys Cloud.
X.509 Certificate
Use for the Okta Certificate setting in Genesys Cloud.
Get the certificate for Genesys Cloud configuration
On the Identity Provider metadata page, click Download certificate.
Save the file as a .crt or .pem file.
Configure Genesys Cloud
In Genesys Cloud, click Admin.
Under Integrations, click Single Sign-on.
Click the Okta tab.
Provide the Identity Provider metadata gathered from Okta.
Field
Description
Certificate
To upload X.509 certificates for SAML signature validation, do one of the following.
1. To upload a certificate, click Select Certificates to upload.
2. Select the X.509 certificate.
3. Click Open.
4. Optionally, to load a backup certificate, repeat steps 1–3.
Or you can:
5. Drag and drop your certificate file.
6. Optionally, to load a backup certificate, repeat the first step.
Uploaded certificates appear with their expiration date. To remove a certificate, click X.
Issuer URI
Type the Identity Provider Issuer.
Target URL
Type the Identity Provider Single Sign-on URL.
Single Logout URI
Type the Identity Provider Single Logout URL.
Single Logout Binding
Choose HTTP Redirect.
Audience (Entity ID)
Type the value used in step 3 of “Create a SAML application.”
Click Save.
Add OneLogin as a single sign-on provider
Prerequisites
Single Sign-on > Provider > Add, Delete, Edit, View permissions
Admin role in your organization’s OneLogin account
OneLogin Desktop Single Sign-on (SSO) unavailable
User email addresses are the same in both OneLogin and Genesys Cloud
Add Genesys Cloud as an application that organization members can access with the credentials to their OneLogin account.
Notes:
Genesys Cloud does not support assertion encryption for single sign-on third-party identity providers. The Genesys Cloud log in service requires Transport Layer Security (TLS). Since the channel is encrypted, there is no need to encrypt parts of the message.
Administrators can optionally disable the default Genesys Cloud login and enforce authentication using an SSO provider only. For more information, see Configure Genesys Cloud to authenticate with SSO only.
Administrators can choose to store one additional certificate to ensure business continuity. If one certificate becomes invalid or expires, the backup certificate will preserve the integration.
· There is a general problem when a Service Provider (SP) receives a SAML response from an Identity Provider (IdP) and their system clocks are not in sync. This problem can result in users getting locked out of their single sign-on when logging in. The problem might be caused by the length of the clock skew between the SP and the IdP. Clock skews between Genesys Cloud and your identity provider cannot be greater than 10 seconds.
The Genesys Cloud desktop app does not support the installation of browser extensions. If you have configured an Azure Conditional Access policy that requires a browser extension, you will need to use a Genesys Cloud supported browser that has the Azure AD extension installed. Single sign-on will not work using the desktop app in this configuration.
Configure OneLogin
Create a SAML application
Add the OneLogin app called SAML Custom Connector (Advanced).
In the app page, click the Configuration tab.
3. Complete the following fields and leave the remaining fields blank.
Field
Description
Audience (Entity ID)
Type a value used for identifying your organization to the Identity Provider, that is “genesys.cloud.my-org.”
ACS (Consumer) URL Validator
Type the URL of your Genesys Cloud organization for the AWS region:
US East (N. Virginia): ^https:\/\/login\.mypurecloud\.com\/saml
US East 2 (Ohio): ^https:\/\/login\.use2.us-gov-pure\.cloud\/saml
US West (Oregon): ^https:\/\/login\.usw2\.pure\.cloud\/saml
Canada (Canada Central): ^https:\/\/login\.cac1\.pure\.cloud\/saml
South America (São Paulo): ^https:\/\/login\.sae1\.pure\.cloud\/saml
EU (Frankfurt): ^https:\/\/login\.mypurecloud\.de\/saml
EU (Ireland): ^https:\/\/login\.mypurecloud\.ie\/saml
EU (London): ^https:\/\/login\.euw2\.pure\.cloud\/saml
Asia Pacific (Mumbai): ^https:\/\/login\.aps1\.pure\.cloud\/saml
Asia Pacific (Seoul): ^https:\/\/login\.apne2\.pure\.cloud\/saml
Asia Pacific (Sydney): ^https:\/\/login\.mypurecloud\.com\.au\/saml
Asia Pacific (Tokyo): ^https:\/\/login\.mypurecloud\.jp\/saml
ACS (Consumer) URL
Type the URL of your Genesys Cloud organization for the AWS region:
US East (N. Virginia): https://login.mypurecloud.com/saml
US East 2 (Ohio): https://login.use2.us-gov-pure.cloud/saml
US West (Oregon): https://login.usw2.pure.cloud/saml
Canada (Canada Central): https://login.cac1.pure.cloud/saml
South America (São Paulo): https://login.sae1.pure.cloud/saml
EU (Frankfurt): https://login.mypurecloud.de/saml
EU (Ireland): https://login.mypurecloud.ie/saml
EU (London): https://login.euw2.pure.cloud/saml
Asia Pacific (Mumbai): https://login.aps1.pure.cloud/saml
Asia Pacific (Seoul): https://login.apne2.pure.cloud/saml
Asia Pacific (Sydney): https://login.mypurecloud.com.au/saml
Asia Pacific (Tokyo): https://login.mypurecloud.jp/saml
Single Logout URL
Type the URL of your Genesys Cloud organization for the AWS region:
US East (N. Virginia): https://login.mypurecloud.com/saml/logout
US East 2 (Ohio): https://login.use2.us-gov-pure.cloud/saml/logout
US West (Oregon): https://login.usw2.pure.cloud/saml/logout
Canada (Canada Central): https://login.cac1.pure.cloud/saml/logout
South America (São Paulo): https://login.sae1.pure.cloud/saml/logout
EU (Frankfurt): https://login.mypurecloud.de/saml/logout
EU (Ireland): https://login.mypurecloud.ie/saml/logout
EU (London): https://login.euw2.pure.cloud/saml/logout
Asia Pacific (Mumbai): https://login.aps1.pure.cloud/saml/logout
Asia Pacific (Seoul): https://login.apne2.pure.cloud/saml/logout
Asia Pacific (Sydney): https://login.mypurecloud.com.au/saml/logout
Asia Pacific (Tokyo): https://login.mypurecloud.jp/saml/logout
Sign SLO Request
Check the box.
Sign SLO Response
Check the box.
Click the Parameters tab.
Click Add parameter.
Complete the following fields.
Field
Description
Name
Type OrganizationName.
Flags
Check Include in SAML assertion.
Click Save.
Click the newly created OrganizationName parameter.
In the Value field:
From the list, select Macro.
Type the short name of your Genesys Cloud organization. If you do not know the short name of your organization, click Admin > Account Settings > Organization Settings in Genesys Cloud.
Click Save.
SAML attributes
If the following extra SAML attributes are present in the assertion, Genesys Cloud acts on the attributes. The attributes are case-sensitive.
Attribute name
Attribute value
Email address of the Genesys Cloud user must be authenticated.
You must be an existing Genesys Cloud user.
If the identity provider does not use an email address as the subject NameID, you need a valid email address.
ServiceName
(Optional) A valid URL for the browser to be redirected to after successful authentication, or one of the following keywords:
directory (redirects to the Genesys Cloud Collaborate client)
directory-admin (redirects to the Genesys Cloud Admin UI)
Get the certificate for the Genesys Cloud configuration
Click the SSO tab.
Under Certificate, click View Details.
Under the X.509 Certificate, select “X.509 PEM” and click Download.
Save the certificate for later use.
Get the metadata for the Genesys Cloud configuration
Note: Genesys Cloud supports the http-redirect SAML URL only. The OneLogin SSO tab no longer shows this URL by default in the SAML 2.0 Endpoint (HTTP) field. (It now shows the http-post URL instead.) However, the http-redirect URL is still available in the SAML Metadata file.
Click the SSO tab.
Copy the following metadata that you need for the Genesys Cloud configuration to a text file.
Field
Description
Issuer URL
Copy the URL from the Issuer URL field.
SAML 2.0 Endpoint (HTTP)
1. Under More Actions, click SAML Metadata.
2. Download and open the SAML Metadata file.
3. Find the SingleSignOnService tag with Binding equal to “urn:oasis:names:tc:SAML:2.0:bindings:HTTP-Redirect,” for example: <SingleSignOnService Binding="urn:oasis:names:tc:SAML:2.0:bindings:HTTP-Redirect" Location="https://your-organization/onelogin.com/trust/saml2/http-redirect/sso/123456>
4. Copy the URL following “Location =,” for example:
https://your-organization/onelogin.com/trust/saml2/http-redirect/sso/123456
SLO Endpoint (HTTP)
Copy the URL from the SLO Endpoint (HTTP) field.
Configure Genesys Cloud
In Genesys Cloud, click Admin.
Under Integrations, click Single Sign-on.
Click the OneLogin tab.
Enter the information gathered in the previous procedure:
Field
Description
Certificate
To upload X.509 certificates for SAML signature validation, do one of the following.
1. To upload a certificate, click Select Certificates to upload.
2. Select the X.509 certificate.
3. Click Open.
4. Optionally, to load a backup certificate, repeat steps 1–3.
Or you can:
5. Drag and drop your certificate file.
6. Optionally, to load a backup certificate, repeat the first step.
Uploaded certificates appear with their expiration date. To remove a certificate, click X.
OneLogin Issuer URI
Type the URL from the Issuer URL field in OneLogin.
Target URL
Type the URL from the SAML 2.0 Endpoint (HTTP) field.
Single Logout URI
Type the URL from the SLO Endpoint (HTTP) field in OneLogin.
Single Logout Binding
Select HTTP Redirect.
Audience (Entity ID)
Type the OneLogin Audience (EntityID) value. Make sure that this value is the same in both Genesys Cloud and OneLogin.
Click Save.
Add Ping Identity as a single sign-on provider(click on link in the resources)
Prerequisites:
Single Sign-on > Provider > Add, Delete, Edit, View permissions
Admin role in your organization’s Ping Identity account
User email addresses are the same in both Ping Identity and Genesys Cloud
Add Genesys Cloud as an application that organization members can access with the credentials to their Ping Identity account.
Notes:
Genesys Cloud does not support assertion encryption for single sign-on third-party identity providers. The Genesys Cloud log in service requires Transport Layer Security (TLS). Since the channel is encrypted, there is no need to encrypt parts of the message.
Administrators can optionally disable the default Genesys Cloud login and enforce authentication using an SSO provider only.
Administrators can choose to store one additional certificate to ensure business continuity. If one certificate becomes invalid or expires, the backup certificate will preserve the integration.
· There is a general problem when a Service Provider (SP) receives a SAML response from an Identity Provider (IdP) and their system clocks are not in sync. This problem can result in users getting locked out of their single sign-on when logging in. The problem might be caused by the length of the clock skew between the SP and the IdP. Clock skews between Genesys Cloud and your identity provider cannot be greater than 10 seconds.
The Genesys Cloud desktop app does not support the installation of browser extensions. If you have configured an Azure Conditional Access policy that requires a browser extension, you will need to use a Genesys Cloud supported browser that has the Azure AD extension installed. Single sign-on will not work using the desktop app in this configuration.
Configure Ping Identity
Create a custom Genesys Cloud application
In PingIdentity, click Connections > Applications.
Click the plus sign next to Applications.
Click Web App and click Configure for the SAML option.
In the Create App Profile page, complete the following fields and leave the remaining fields blank or at the default settings.
Field
Description
Application Name
Type your Genesys Cloud application name.
Application Description
Type a short description of the application.
In the Configure SAML Connection page, complete the following fields and leave the remaining fields blank or at the default settings.
Field
Description
ACS URLS
Type the URL of your Genesys Cloud organization for the AWS region:
US East (N. Virginia): https://login.mypurecloud.com/saml
US East 2: (Ohio): https://login.use2.us-gov-pure.cloud/saml
US West (Oregon): https://login.usw2.pure.cloud/saml
Canada (Canada Central): https://login.cac1.pure.cloud/saml
South America (São Paulo): https://login.sae1.pure.cloud/saml
EU (Frankfurt): https://login.mypurecloud.de/saml
EU (Ireland): https://login.mypurecloud.ie/saml
EU (London): https://login.euw2.pure.cloud/saml
Asia Pacific (Mumbai): https://login.aps1.pure.cloud/saml
Asia Pacific (Seoul): https://login.apne2.pure.cloud/saml
Asia Pacific (Sydney): https://login.mypurecloud.com.au/saml
Asia Pacific (Tokyo): https://login.mypurecloud.jp/saml
Signing Key
1. Click Download Signing Certificate.
2. Choose X509 PEM (.crt).
3. Save the file.
Signing Algorithm
Select RSA_SHA256.
Entity ID
Type a unique string that you want to use to identify your Genesys Cloud organization, for example: genesys.cloud.my-org.
SLO Endpoint
Type the URL of your Genesys Cloud organization for the AWS region:
US East (N. Virginia): https://login.mypurecloud.com/saml/logout
US East 2 (Ohio): https://login.use2.us-gov-pure.cloud/saml/logout
US West (Oregon): https://login.usw2.pure.cloud/saml/logout
Canada (Canada Central): https://login.cac1.pure.cloud/saml/logout
South America (São Paulo): https://login.sae1.pure.cloud/saml/logout
EU (Frankfurt): https://login.mypurecloud.de/saml/logout
EU (Ireland): https://login.mypurecloud.ie/saml/logout
EU (London): https://login.euw2.pure.cloud/saml/logout
Asia Pacific (Mumbai): https://login.aps1.pure.cloud/saml/logout
Asia Pacific (Seoul): https://login.apne2.pure.cloud/saml/logout
Asia Pacific (Sydney): https://login.mypurecloud.com.au/saml/logout
Asia Pacific (Tokyo): https://login.mypurecloud.jp/saml/logout
SLO Binding
Select HTTP Redirect.
Subject NameID Format
Select “urn:oasis:names:tc:SAML:1.1:nameid-format:emailAddress.”
Assertion Validity Duration (In Seconds)
Type a value that determines how long the assertions in the SAML authentication response are valid. 60 seconds are sufficient.
In the Attribute Mapping page, add these attributes.
Attribute
Description
Select Email Address.
OrganizationName
1. Click Add Attribute.
2. Click Advanced Expression.
3. In the Expression field, type your Genesys Cloud organization short name in quotes. Example: “my-org-name.”
4. Click Save.
ServiceName
(Optional) A valid URL for the browser to be redirected to after successful authentication, or one of the following keywords:
· directory (redirects to the Genesys Cloud Collaborate client)
· directory-admin (redirects to the Genesys Cloud Admin UI)
7. Click Add Attribute.
8. Click Advanced Expression.
9. In the Expression field, type your Genesys Cloud organization short name in quotes. Example: “directory.”
10. Click Save.
Click Save and Publish.
Get the metadata for Genesys Cloud configuration
In PingIdentity, click Connections > Applications.
Expand the application created for Genesys cloud, click the Configuration tab. Note the following Identity Provider metadata that you need for the Genesys Cloud configuration.
Metadata
Description
Issuer ID
Use for the Ping Issuer URI setting in Genesys Cloud.
Single Logout Service
Use for the Single Logout URI setting in Genesys Cloud.
Single Signon Service
Use for the Target URL setting in Genesys Cloud.
Configure Genesys Cloud
In Genesys Cloud, click Admin.
Under Integrations, click Single Sign-on.
Click the Ping Identity tab.
Enter the Identity Provider metadata gathered from PingIdentity.
Field
Description
Certificate
To upload X.509 certificates for SAML signature validation, do one of the following.
1. To upload a certificate, click Select Certificates to upload.
2. Select the X.509 certificate.
3. Click Open.
4. Optionally, to load a backup certificate, repeat steps 1–3.
Or you can:
5. Drag and drop your certificate file.
6. Optionally, to load a backup certificate, repeat the first step.
Uploaded certificates appear with their expiration date. To remove a certificate, click X.
Issuer URI
Type the Issuer ID.
Target URL
Type the Single Signon Service.
Single Logout URI
Type the Single Logout Service.
Single Logout Binding
Select HTTP Redirect.
Relying Party Identifier
Type the unique string that you specified as the Entity ID in PingIdentity.
Click Save.
Add a generic single sign-on provider(click on link in the resources)
Prerequisites:
Single Sign-on > Provider > Add, Delete, Edit, View permissions
Admin role in your organization’s identity provider account
User email addresses are the same in your organization’s identity provider account and in Genesys Cloud
The generic identity provider configuration enables Genesys Cloud customers to integrate with most identity providers that support SAML 2.0.
Notes:
Genesys Cloud does not support assertion encryption for single sign-on third-party identity providers. The Genesys Cloud log in service requires Transport Layer Security (TLS). Since the channel is encrypted, there is no need to encrypt parts of the message.
Administrators can optionally disable the default Genesys Cloud login and enforce authentication using an SSO provider only. For more information, see Configure Genesys Cloud to authenticate with SSO only.
Administrators can choose to store one additional certificate to ensure business continuity. If one certificate becomes invalid or expires, the backup certificate will preserve the integration.
· There is a general problem when a Service Provider (SP) receives a SAML response from an Identity Provider (IdP) and their system clocks are not in sync. This problem can result in users getting locked out of their single sign-on when logging in. The problem might be caused by the length of the clock skew between the SP and the IdP. Clock skews between Genesys Cloud and your identity provider cannot be greater than 10 seconds.
The Genesys Cloud desktop app does not support the installation of browser extensions. If you have configured an Azure Conditional Access policy that requires a browser extension, you will need to use a Genesys Cloud supported browser that has the Azure AD extension installed. Single sign-on will not work using the desktop app in this configuration.
Configure your organization’s identity provider
Get the certificate for Genesys Cloud configuration
Find and download your identity provider’s encoded public certificate for SAML signature validation.
Note: Genesys Cloud accepts PEM and DER encoded certificates, and Base64 encoded certificates.
Get the metadata for Genesys Cloud configuration
Find and download your identity provider’s metadata file containing the issuer (entityID), single sign-on URL, and Single Logout URL for configuring Genesys Cloud in your organization’s identity provider account.
Provide the Assertion Consumer Service (ACS) URL
When prompted to enter the Assertion Consumer Service (ACS) URL, select the appropriate URL based on your AWS deployment region.
AWS Region
URL
US East (N. Virginia)
https://login.mypurecloud.com/saml
US East 2 (Ohio)
https://login.use2.us-gov-pure.cloud/saml
US West (Oregon)
https://login.usw2.pure.cloud/saml
Canada (Canada Central)
https://login.cac1.pure.cloud/saml
South America (São Paulo)
https://login.sae1.pure.cloud/saml
EU (Frankfurt)
https://login.mypurecloud.de/saml
EU (Ireland)
https://login.mypurecloud.ie/saml
EU (London)
https://login.euw2.pure.cloud/saml
Asia Pacific (Mumbai)
https://login.aps1.pure.cloud/saml
Asia Pacific (Seoul)
https://login.apne2.pure.cloud/saml
Asia Pacific (Sydney)
https://login.mypurecloud.com.au/saml
Asia Pacific (Tokyo)
https://login.mypurecloud.jp/saml
Provide the Single Logout URL
When prompted to enter the Single Logout URL, select the appropriate URL based on your AWS deployment region.
AWS Region
URL
US East (N. Virginia)
https://login.mypurecloud.com/saml/logout
US East 2 (Ohio)
https://login.use2.us-gov-pure.cloud/saml/logout
US West (Oregon)
https://login.usw2.pure.cloud/saml/logout
Canada (Canada Central)
https://login.cac1.pure.cloud/saml/logout
South America (São Paulo)
https://login.sae1.pure.cloud/saml/logout
EU (Frankfurt)
https://login.mypurecloud.de/saml/logout
EU (Ireland)
https://login.mypurecloud.ie/saml/logout
EU (London)
https://login.euw2.pure.cloud/saml/logout
Asia Pacific (Mumbai)
https://login.aps1.pure.cloud/saml/logout
Asia Pacific (Seoul)
https://login.apne2.pure.cloud/saml/logout
Asia Pacific (Sydney)
https://login.mypurecloud.com.au/saml/logout
Asia Pacific (Tokyo)
https://login.mypurecloud.jp/saml/logout
Provide the Service Provider Entity ID
When prompted to enter the Service Provider Entity ID, the value can be any unique string that you want to use to identify your Genesys Cloud organization. The field is also sometimes called Issuer or Audience URI.
Provide the Genesys Cloud Signing Certificate
When prompted to enter a signing certificate, upload the file obtained from Genesys cloud.
In Genesys Cloud, click Admin.
Under Integrations, click Single Sign-on.
Click the Okta tab.
Under Genesys Cloud Signing Certificate, click Download Certificate.
Save the file.
Configure user attributes and claims
Configure these Genesys Cloud user attributes for your identity provider. The attributes are case-sensitive.
Attribute name
Attribute value
OrganizationName
For identity provider-initiated single sign-on: Use the organization short name.
For service provider-initiated single sign-on: Make sure that the organization name matches the organization name that you select. It is applicable when an organization maintains multiple Genesys Cloud organizations using a single identity provider.
Email address of the Genesys Cloud user to be authenticated.
You must be an existing Genesys Cloud user.
If the identity provider does not use an email address as the subject NameID, you require a valid email address.
ServiceName
(Optional) A valid URL for the browser to be redirected to after successful authentication, or one of the following keywords:
directory (redirects to the Genesys Cloud Collaborate client)
directory-admin (redirects to the Genesys Cloud Admin UI)
Note: To add a custom claim, consult your identity provider’s documentation.
Configure Genesys Cloud
In Genesys Cloud, click Admin.
Under Integrations, click Single Sign-on.
Click the Generic SSO Provider tab.
4. Enter the metadata gathered from your organization’s identity provider.
Field
Description
Provider Logo
Insert an SVG image, no larger than 25 KB.
Provider Name
Type the identity provider name.
The Provider’s Certificate
To upload X.509 certificates for SAML signature validation, do one of the following.
1. To upload a certificate, click Select Certificates to upload.
2. Select the X.509 certificate.
3. Click Open.
4. Optionally, to load a backup certificate, repeat steps 1–3.
Or you can:
5. Drag and drop your certificate file.
6. Optionally, to load a backup certificate, repeat the first step.
Uploaded certificates appear with their expiration date. To remove a certificate, click X.
The Provider’s Issuer URI
Enter the entityID provided in the identity provider’s metadata file.
Target URL
Enter the Single Sign On URL provided in the identity provider’s metadata file.
Single Logout URI
Enter the Single Logout URL provided in the identity provider’s metadata file.
Single Logout Binding
Choose the same binding as the one selected in the identity provider. If no binding is specified, choose HTTP Redirect.
Relying Party Identifier
Enter the string to identify Genesys Cloud to the identity provider.
Note: If the identity providers expect the service provider to specify the relying party identifier, enter a string to input both Genesys Cloud and the identity provider. If the identity providers generate a relying party identifier in their metadata file, enter that string.
Name Identifier Format
Choose the Name Identifier Format that your identity provider supports. If your provider supports Email Address, that is the preferred format. If no Name Identifier Format is known, choose Unspecified.
(Optional) Select Endpoint Compression to compress the Genesys Cloud authentication request. Make sure to select and uncheck this field only if the identity provider does not support compression for the HTTP Redirect binding.
Click Save.
Add PureConnect as a single sign-on provider(click on link in the resources)
Prerequisites:
Single Sign-on > Provider > Add, Delete, Edit, View permissions
PureConnect 2020 R2 or later
Admin role in the Genesys Cloud organization associated with your PureConnect hybrid system
User syncing enabled in your PureConnect hybrid system
Add Genesys Cloud as an application that PureConnect hybrid organization users can access with their PureConnect credentials.
Notes:
If your PureConnect hybrid organization already uses a single sign-on third party identity provider such a Microsoft Azure AD or Okta, this configuration is not needed.
Only PureConnect supported languages are available to PureConnect users when they log in to Genesys Cloud. Verify that the required languages are available on the PureConnect CIC server.
Administrators can choose to store one additional certificate to ensure business continuity. If one certificate becomes invalid or expires, the backup certificate will preserve the integration.
Configure PureConnect
Get the certificate for Genesys Cloud configuration
Find and download PureConnect’s encoded public certificate for SAML signature validation.
Open Interaction Administrator on the PureConnect CIC server.
Click Secure Token Server Configuration.
Click the Configuration tab.
Download the certificate in Certificate Path.
Save the certificate to a text file.
Configure Genesys Cloud
In Genesys Cloud, click Admin.
Under Integrations, click Single Sign-on.
Click the Generic SSO Provider tab.
4. Enter the metadata gathered from PureConnect.
In this field…
Do this…
Provider Logo
Insert an SVG image, no larger than 25 KB. The image can be your company’s logo or any other image.
Provider Name
Type the provider name to match your provider logo.
The Provider’s Certificate
To upload X.509 certificates for SAML signature validation, do one of the following.
1. To upload a certificate, click Select Certificates to upload.
2. Select the X.509 certificate.
3. Click Open.
4. Optionally, to load a backup certificate, repeat steps 1–3.
Or you can:
5. Drag and drop your certificate file.
6. Optionally, to load a backup certificate, repeat the first step.
Uploaded certificates appear with their expiration date. To remove a certificate, click X.
The Provider’s Issuer URI
Type the URI for your PureConnect system’s single sign-on proxy host. The value is based on your PureConnect system’s single sign-on proxy configuration. To learn how to modify your proxy server configuration for single sign-on, see the Genesys Cloud for PureConnect Administrator’s Guide.
Target URL
Type the URL for your PureConnect system’s single sign-on proxy location. The value is based on your PureConnect system’s single sign-on proxy configuration. To learn how to modify your proxy server configuration for single sign-on, see the Genesys Cloud for PureConnect Administrator’s Guide.
Relying Party Identifier
Type the URL for the AWS region where your Genesys Cloud organization is located:
US East (N. Virginia): https://login.mypurecloud.com/saml
US East 2 (Ohio): Not supported
US West (Oregon): https://login.usw2.pure.cloud/saml
Canada (Canada Central): https://login.cac1.pure.cloud/saml
South America (São Paulo): Not supported
EU (Frankfurt): https://login.mypurecloud.de/saml
EU (Ireland): https://login.mypurecloud.ie/saml
EU (London): https://login.euw2.pure.cloud/saml
Asia Pacific (Seoul): https://login.apne2.pure.cloud/saml
Asia Pacific (Sydney): https://login.mypurecloud.com.au/saml
Asia Pacific (Tokyo): https://login.mypurecloud.jp/saml
Select Endpoint Compression to compress the Genesys Cloud authentication request.
Note: This setting is required. The configuration will not work without it.
Click Save.
Add Salesforce as a single sign-on provider(click on link in the resources)
Prerequisites:
Single Sign-on > Provider > Add, Delete, Edit, View permissions
Admin role in your organization’s Salesforce account
Salesforce enabled as an identity provider
Salesforce domain deployed to all users
User email addresses are the same in both Salesforce and Genesys Cloud
Add Genesys Cloud as an application that organization members can access with the credentials to their Salesforce account.
Notes:
Genesys Cloud does not support assertion encryption for single sign-on third-party identity providers. The Genesys Cloud log in service requires Transport Layer Security (TLS). Since the channel is encrypted, there is no need to encrypt parts of the message.
Administrators can optionally disable the default Genesys Cloud login and enforce authentication using an SSO provider only.
Administrators can choose to store one additional certificate to ensure business continuity. If one certificate becomes invalid or expires, the backup certificate will preserve the integration.
· There is a general problem when a Service Provider (SP) receives a SAML response from an Identity Provider (IdP) and their system clocks are not in sync. This problem can result in users getting locked out of their single sign-on when logging in. The problem might be caused by the length of the clock skew between the SP and the IdP. Clock skews between Genesys Cloud and your identity provider cannot be greater than 10 seconds.
The Genesys Cloud desktop app does not support the installation of browser extensions. If you have configured an Azure Conditional Access policy that requires a browser extension, you will need to use a Genesys Cloud supported browser that has the Azure AD extension installed. Single sign-on will not work using the desktop app in this configuration.
Configure Salesforce
Troubleshoot errors using the Identity Provider Event Log.
1. In the Apps menu, create a connected app for Genesys Cloud.
2. In the Connected Apps menu, enter the following settings in the connected app for Genesys Cloud:
Field
Description
Entity ID
The value can be any unique string that you want to use to identify your Genesys Cloud organization.
ACS URL
The AWS region of your Genesys Cloud organization:
US East (N. Virginia): https://login.mypurecloud.com/saml
US East 2 (Ohio): https://login.use2.us-gov-pure.cloud/saml
US West (Oregon): https://login.usw2.pure.cloud/saml
Canada (Canada Central): https://login.cac1.pure.cloud/saml
South America (São Paulo): https://login.sae1.pure.cloud/saml
EU (Frankfurt): https://login.mypurecloud.de/saml
EU (Ireland): https://login.mypurecloud.ie/saml
EU (London): https://login.euw2.pure.cloud/saml
Asia Pacific (Mumbai): https://login.aps1.pure.cloud/saml
Asia Pacific (Seoul): https://login.apne2.pure.cloud/saml
Asia Pacific (Sydney): https://login.mypurecloud.com.au/saml
Asia Pacific (Tokyo): https://login.mypurecloud.jp/saml
Enable Single Logout
Check the box.
Single Logout URL
The AWS region of your Genesys Cloud organization:
US East (N. Virginia): https://login.mypurecloud.com/saml/logout
US East 2 (Ohio): https://login.use2.us-gov-pure.cloud/saml/logout
US West (Oregon): https://login.usw2.pure.cloud/saml/logout
Canada (Canada Central): https://login.cac1.pure.cloud/saml/logout
South America (São Paulo): https://login.sae1.pure.cloud/saml/logout
EU (Frankfurt): https://login.mypurecloud.de/saml/logout
EU (Ireland): https://login.mypurecloud.ie/saml/logout
EU (London): https://login.euw2.pure.cloud/saml/logout
Asia Pacific (Mumbai): https://login.aps1.pure.cloud/saml/logout
Asia Pacific (Seoul): https://login.apne2.pure.cloud/saml/logout
Asia Pacific (Sydney): https://login.mypurecloud.com.au/saml/logout
Asia Pacific (Tokyo): https://login.mypurecloud.jp/saml/logout
Single Logout Binding
Select HTTP Redirect.
Subject Type
User name
Issuer
Your Salesforce domain name (https://yourID.my.salesforce.com)
Name ID Format
urn:oasis:names:tc:SAML:2.0:nameid-format:emailAddress
3. Gather the following data from the app page:
Field
Description
Certificate
1. Click the certificate name next to IdP Certificate.
2. On the Certificate and Key Detail page, click Download Certificate.
3. Save the certificate as a .cer file.
Issuer URI
Copy the Issuer value.
Target URI
Copy the value labeled SP-Initiated Redirect Endpoint.
Single Logout URI
Copy the value labeled Single Logout Endpoint.
Provide Salesforce users with access to the connected app for Genesys Cloud.
In Manage Users > Users, click Edit on a user.
Click the required profile type, for example, Sales, Services, or Administrator to open the profile page.
Under connected app Access, click the connected app for Genesys Cloud.
SAML attributes
If the following SAML attributes are present in the assertion, Genesys Cloud acts on those attributes. The attributes are case-sensitive.
Attribute name
Attribute value
OrganizationName
For identity provider-initiated single sign-on: Use the organization short name.
For service provider-initiated single sign-on: Make sure that the organization name matches the organization name that you select. It is applicable when an organization maintains multiple Genesys Cloud organizations using a single identity provider.
Email address of the Genesys Cloud user to be authenticated.
You must be an existing Genesys Cloud user.
If the identity provider does not use an email address as the subject NameID, you require a valid email address.
ServiceName
(Optional) A valid URL for the browser to be redirected to after successful authentication, or one of the following keywords:
directory (redirects to the Genesys Cloud Collaborate client)
directory-admin (redirects to the Genesys Cloud Admin UI)
Configure Genesys Cloud
In Genesys Cloud, click Admin.
Under Integrations, click Single Sign-on.
Click the Salesforce tab.
4. Enter the information gathered from Salesforce.
Field
Description
Certificate
To upload X.509 certificates for SAML signature validation, do one of the following.
1. To upload a certificate, click Select Certificates to upload.
2. Select the X.509 certificate.
3. Click Open.
4. Optionally, to load a backup certificate, repeat steps 1–3.
Or you can:
5. Drag and drop your certificate file.
6. Optionally, to load a backup certificate, repeat the first step.
Uploaded certificates appear with their expiration date. To remove a certificate, click X.
Issuer URI
Enter your Salesforce domain name (https://yourID.my.salesforce.com)
Target URI
Enter the URL labeled SP-Initiated Redirect Endpoint in the Salesforce app page.
Single Logout URI
Enter the URL labeled Single Logout Endpoint in the Salesforce app page.
Single Logout Binding
Select HTTP Redirect.
Relying Party Identifier
Add the unique identifier that you provided as the Entity ID in the Salesforce app page.
Click Save.
Authorize users and groups to work in your organization(click on link in the resources)
Prerequisites
See Roles and permissions for pairing organizations and Roles and permissions for authorized users and groups.
After you approve a pairing request, you must authorize users and groups to work in your organization. To authorize users and groups, assign them the roles their work requires.
Note: When granting system access to another user or group (“permitted user”), be aware that you are responsible for how the permitted user uses your system. Genesys is not responsible for any misuse of data, change to configuration, etc.
When an administrator sends you a pairing link, the administrator can request authorization for multiple users and groups. Later, the administrator can request authorization for other users and groups as well. The maximum number of users that can access another organization is 25.
Click Admin.
Under People and Permissions, click Authorized Organizations.
Click Access To My Organization.
Click the name of the paired organization.
Click the user’s or group’s name.
Under Roles, search for and select the roles for the user or group.
Notes:
The default Master Admin role has all the permissions that are necessary for a user or group to administer your organization. When you seek assistance, Customer Care may require other permissions and roles.
The permissions that a role contains are what enables a user to perform an action. Because you can modify existing roles, it is important to be sure that a role has the permission(s) required to perform a specified action.
Until an administrator assigns one or more roles to a user or group, the user or group cannot work in the organization.
When an administrator selects a role for a user or group, that user or group receives access immediately.
Create a Platform API OAuth client(click on link in the resources)
Prerequisites
OAuth > Client > Add permission
OAuth clients allow you to make requests to the Platform API or to authenticate against Genesys Cloud, or to sync entities between Genesys Cloud and third-party systems.
This procedure is for application providers who want their app to receive a token allowing it to make requests to the Genesys Cloud Platform API. The token represents a user’s permission for the app to access Genesys Cloud data. It is used when the app must authorize a request to an API endpoint. To see a list of Genesys Cloud Platform APIs, see the API resources in the Genesys Cloud Developer Center.
Click Admin.
Under Integrations, click OAuth.
3. Click Add client. The Client Details tab appears.
Set App Name to a descriptive name of the app. This name is shown when someone authorizes this OAuth client.
(Optional) Type a brief description of the app in the Description box.
Next, set the duration of time until tokens created with this client expire. Accept the default duration, or enter a value between 300 and 172800 seconds. This sets the lifetime of the token to a maximum of 2 days or less.
Note: When HIPAA compliance is enabled for your organization, Genesys Cloud enforces an idle timeout of 15 minutes and this idle timeout is also applicable to tokens issued by OAuth clients. For more information, see HIPAA compliance.
7. Make a selection below Grant Types. Grant Types set the way an application gets an access token. Genesys Cloud supports the OAuth 2 authorization grant types listed below. Clicking the name of a grant type displays more information about it from the Genesys Cloud Developer Center.
· Client Credentials Grant: A single-step authentication process exclusively for use by non-user applications (e.g. a Windows Service or cron job). The client application provides OAuth client credentials in exchange for an access token. This authorization type is not in the context of a user and therefore will not be able to access user-specific APIs (e.g GET /v2/users/me).
· Code Authorization Grant: A two-step authentication process where a user authenticates with Genesys Cloud, then the client application is returned an authorization code. The client application provides OAuth client credentials and uses the authorization code to get an access token. The access token can then be used when making authenticated API calls. This is the most secure option and ideal for websites where API requests will be made server-side (e.g. ASP.NET or PHP) and some desktop applications where a thin client would authorize the user and pass the auth code to a back-end server to exchange for an auth token and make API requests.
· Implicit Grant (Browser): A single-step authentication process where a user authenticates with Genesys Cloud and the client application is directly returned an access token. This option provides less security for the access token than the authorization code grant, but is ideal for client-side browser applications (i.e. JavaScript) and most desktop applications (e.g. .NET WPF/WinForms or Java desktop programs).
· SAML2 Bearer: An authentication process wherein a client application may use a Security Assertion Markup Language (SAML2) assertion to request a bearer token.
Note: A single Code Authorization or Implicit grant type can be used in all regions.
8. Supply parameters required by the grant type.
· Roles: If you selected Client Credentials, click the Roles tab. This opens a list of roles to choose from. Assign a minimum set of roles to determine what your OAuth client integration can do.
Note: To grant roles to an OAuth client, you must have those roles assigned to your profile.
You must also associate each role with a division. Determine what divisions should be associated with roles for the Client Credential Grant. All Client Credential grant roles are scoped to the Home Division by default. Update with appropriate divisions so that the applications and systems which use those grants can access the appropriate data. If a client credential grant is supplied by a 3rd party, check with the 3rd party to understand the use of the grant and update the divisions for the roles appropriately. No other grant types are affected by access control.
· Authorized redirect URIs (one per line, up to 125): These are the URIs that authorization code is posted to, to be exchanged for an access token used later to authenticate subsequent API calls.
· Scope: All grant types except Client Credentials have a Scope setting. Click the Scope box to display a list of scopes available to your app. As a best practice, select only the minimum scopes your app needs. For information about scopes, see OAuth Scopes in the Developer Center.
Click Save. Genesys Cloud creates a Client ID and a Client Secret (token).
Create a Genesys Cloud SCIM OAuth client(click on link in the resources)
Prerequisites
OAuth > Client > Add permission
SCIM Integration role assigned to your user
If SCIM Integration does not appear, restore default roles to your Genesys Cloud organization. Use API Explorer to make an API call to POST /api/v2/authorization/roles/default. For more information, see Developer tools quick start (Genesys Cloud Developer Center). To access API Explorer, go to https://developer.genesys.cloud/developer-tools/#/api-explorer.
To use Genesys Cloud SCIM (Identity Management), create a Genesys Cloud OAuth client. The OAuth client generates a Client ID and Client Secret that you add to your identity management system.
Click Admin.
Under Integrations, click OAuth.
Click Add client. The Client Details tab appears.
Set App Name to a descriptive name of the app.
App Name is the name shown when someone authorizes this OAuth client. For more information, see Authorize an OAuth client.
(Optional) Type a brief description of the app in the Description box.
Set Token Duration.
Token Duration is the duration of time until tokens created with this client expire. Accept the default duration of 86,400 or enter a value between 300 and 38,880,000 seconds. This sets the lifetime of the token to a maximum of 450 days.
Note: You can only set the maximum to 38,880,000 seconds if you use the SCIM Integration role or a custom role that has the exact same permissions.
Under Grant Types, select Client Credentials.
Click the Roles tab and assign the SCIM Integration role.
Important:
To grant this role to your OAuth client, you must have this role assigned to your profile.
Do not assign other roles to your OAuth client or other permissions to the SCIM Integration role. If you do assign other roles or permissions, Token Duration that you set in step 6 reverts to the default of 86,400 seconds.
Include all divisions that that you will be managing with SCIM.
Click Save
Create a Genesys Cloud Embeddable Framework OAuth client(click on link in the resources)
Prerequisites
OAuth > Client > Add permission
If either situation applies, create an OAuth client for Genesys Cloud Embeddable Framework:
You are implementing a public deployment.
You are implementing a private deployment that accesses the getAuthToken method in your framework.js file. For more information, see User.getAuthToken (Genesys Cloud Developer Center).
An OAuth client generates a Client ID that developers can use for the clientIds in the framework.js file. For more information, see clientIds (Genesys Cloud Developer Center).
Click Admin.
Under Integrations, click OAuth.
Click Add client. The Client Details tab appears.
Set App Name to a descriptive name of the app.
App Name is the name shown when someone authorizes this OAuth client. For more information, see Authorize an OAuth client.
(Optional) Type a brief description of the app in the Description box.
Set the duration of time until tokens created with this client expire.
Accept the default duration, or enter a value between 300 and 172800 seconds. This duration sets the lifetime of the token to a maximum of two days or less.
Tip: Genesys recommends that you set the token duration to 18 hours (64800 seconds). This duration generally causes the token to expire outside of an agent’s normal workday.
Under Grant Types, select Implicit Grant (Browser).
For more information, see Authorization (Genesys Cloud Developer Center) and Grant – Implicit (Genesys Cloud Developer Center).
8. Under Authorized redirect URIs, add https://apps.mypurecloud.com/crm/index.html, customized according to your Genesys Cloud region.
Notes:
Use the AWS region according to your deployment.
If you set dedicatedLoginWindow to true in your framework.js file, also add https://apps.mypurecloud.com/crm/authWindow.html under Authorized redirect URIs. For more information, see dedicatedLoginWindow under settings (Genesys Cloud Developer Center).
After Genesys publishes your public deployment, Genesys will provide you with a new URI to use.
Under Scope, add all required scopes. You can also add additional scopes.
For a list of required scopes, see Administrator requirements for the Genesys Cloud embedded clients. For information about scopes, see OAuth Scopes (Genesys Cloud Developer Center).
Click Save.
Genesys Cloud creates a Client ID and a Client Secret.
Give the developers the Client ID.
Quality & Performance Monitoring
Analytics & Reporting Features
Queues & Agent Performance
Gamification
Create a development and feedback module(click on link in the resources)
Prerequisites:
Master admin role with the following permissions:
Learning > Assignment > All permission
Learning > Module > All permission
Learning > Rule > All permission
Learning > Cover Art > All permission
or
Performance admin role with the following permissions:
Learning > Assignment > Add, Delete, Reset, View permissions
Learning > Module > Add, Archive, Delete, Edit, Publish permissions
Learning > Rule > Edit, View permissions
Learning > Cover Art > All permission
When you work with Development and Feedback, you can create three different modules.
Learning – Enables agents to increase their knowledge.
Learning with Assessment – Enables agents to evaluate and increase their knowledge.
Assessment – Enables agents to evaluate their knowledge through a standalone assessment.
Note:
After you create a module, you cannot change its module type.
When you work with Development and Feedback, you can only create, work with, edit, and assign a feedback module in divisions for which you have permission. That is, you can only view data from the divisions in which you belong. For more information, see Divisions overview and Assign roles, divisions, licenses, and add-ons.
Create a learning module
Click Admin.
Under Performance & Engagement, click Development and Feedback.
Click New Module and then select Learning.
From the Details tab, give the module a Name and Description. This information appears on the module landing page.
In the Recommended Completion Date field, set a timeframe to complete the module.
In the Recommended Time to Complete fields, enter the number of hours and minutes to recommend that the agent takes to complete the module.
From the Details tab, upload a Cover Image.
Click Select image. If an image is not selected, the system uses the default image.
Click Upload to add a new image to the list.
Notes:
The cover image can only be in .jpg, .jpeg, .png, .bmp, or .gif format.
After you select a cover image, a thumbnail of that image appears in the Details tab.
When you select a cover image, then the Upload and Delete icons appear next to a thumbnail of the selected cover image.
If you upload another cover image, the new image replaces the current cover image for the current module. Modules that you previously created remain with the initial cover image.
The recommended minimum size for the cover image is 1024 x 768.
Click the Content tab and then add content
Click the Auto Assign tab and then assign the module.
Click Save and Preview or Save and Publish.
Create a learning with assessment module
Click Admin.
Under Performance & Engagement, click Development and Feedback.
Click New Module and select Learning with Assessment.
From the Details tab, give the module a Name and Description. This information appears on the module landing page.
In the Recommended Completion Date field, set a timeframe to complete the module.
In the Recommended Time to Complete fields, enter the number of hours and minutes to recommend that the agent takes to complete the module.
From the Details tab, upload a Cover Image.
Click Select image. If you do not select an image, the system uses the default image.
To add a new image to the list, click Upload.
Notes:
The cover image can only be in .jpg, .jpeg, .png, .bmp, or .gif format.
After you select a cover image, a thumbnail of that image appears in the Details tab.
When you select a cover image, then Upload and Delete icons appear next to a thumbnail of the selected cover image.
If you upload another cover image, the new image replaces the current cover image for the current module. Modules that you previously created remain with the initial cover image.
The recommended minimum size for the cover image is 1024 x 768.
Click the Content tab and then add content
Click the Questions tab and then add questions
Click the Auto Assign tab and then assign the module
Click Save and Preview or Save and Publish.
Create an assessment module
Click Admin.
Under Performance & Engagement, click Development and Feedback.
Click New Module and then select Assessment.
From the Details tab, give the module a Name and Description. This information appears on the module landing page.
In the Recommended Completion Date field, set a timeframe to complete the module.
In the Recommended Time to Complete fields, enter the number of hours and minutes to recommend that the agent takes to complete the module.
From the Details tab, upload a Cover Image.
Click the Select image button.
If an image is not selected, the system uses the default image.
Click Upload to add a new image to the list.
Notes:
The cover image can only be in .jpg, .jpeg, .png, .bmp, or .gif format.
After you select a cover image, a thumbnail of that image appears in the Details tab.
When you select a cover image, then the Upload and Delete icons appear next to a thumbnail of the selected cover image.
If you upload another cover image, the new image replaces the current cover image for the current module. Modules that you previously created remain with the initial cover image.
The recommended minimum size for the cover image is 1024 x 768.
Click the Questions tab and then add questions
Click the Auto Assign tab and then assign the module
Click Save and Preview or Save and Publish.
Add questions to a development and feedback module
Prerequisites:
Master admin role with the following permissions:
Learning > Assignment > All
Learning > Module > All
Learning > Rule > All
or
Performance admin role with the following permissions:
Learning > Assignment > Add, Delete, Reset, View
Learning > Module > Add, Archive, Delete, Edit, Publish
Learning > Rule > Edit, View
As you create a Learning with Assessment or Assessment module, you must add questions in the module. You can also add and edit questions to a previously created module. You cannot add questions to a Learning module. For more information, see Create a development and feedback module.
Note:
When working with development and feedback, you can only create, work with, edit, and assign a feedback module in divisions for which you have permission. That is, you can only view data from the divisions that you are a member of. For more information, see Divisions overview and Assign roles, divisions, licenses, and add-ons.
Add questions to a development and feedback Learning with Assessment or Assessment module.
Click Admin.
Under Performance & Engagement, click Development and Feedback.
Click New Module and select Learning with Assessment or Assessment.
Click the Questions tab.
Enter a pass mark % in the field provided. The user must achieve this score to pass the module. The pass mark appears at the bottom of the Details tab.
Click [Question group name here]. Add a name of a question group. A question group is a label that categorizes a set of questions, for example, Product Knowledge.
In the Question Group Properties area, you can select the following options:
· N/A Enabled Question Group—Allows evaluators to select N/A (not applicable), which skips all questions in the group.
· Answers Default To: Specifies whether you assign answers to the highest scoring answer or N/A by default.
Note: If you select both options, the default selection is the N/A option for a question that has N/A as an answer.
Display Conditionally—This option allows you to set criteria for whether this question group is shown. Also, this option does not appear in the first question group. It only appears in subsequent question groups.
8. Insert a question type. By default, you can insert a multiple choice, yes/no, or free text question. If they are available, then you can insert custom question types.
Add a multiple choice question
A multiple choice question allows the respondent to select a single answer from a list of choices.
a. Click Multiple Choice.
b. Click [Question text here]. Add a question. As you type, options appear in the editor.
c. Add explanatory text about the question to the Help Text box (optional). In the evaluation form, the explanatory text appears as a tooltip.
To preview the explanatory text, click Preview Off. Move your cursor over the question mark.
To return to edit mode, click Preview On.
d. Select N/A Enabled Question (optional). In the evaluation form, an N/A check box appears. If the respondent selects N/A, then other choices in the question are cleared and unavailable.
e. Select Comments Required (optional). This selection requires a respondent to add comments after an answer.
f. Select Critical Question and Fatal Question (optional). The Critical Question and Fatal Question check boxes work together. A critical question requires the respondent to select one of only two possible answers. Assign the correct answer a value of one. Assign the incorrect answer a value of zero.
If the respondent selects the incorrect answer and the question is a Fatal Question, when an evaluator scores the evaluation, the fail result is assigned. To select Fatal Question, first select Critical Question.
g. Click [Answer text here]. Add answers for the respondent to select.
h. Add numeric values to the Value box. Generally, correct answers have a value of one. Incorrect answers have a value of zero.
i. To add more answers, select the last answer and click +. Repeat step g and step h.
j. To delete an answer, select the answer and click the Trash icon.
k. To reuse this question on other forms, click Save Question As Template. Add a descriptive name. Click Save.
l. To hide settings for this question, click outside the edit controls.
Add a yes or no question
Add a free text question
9. To add another question to this question group, click Add Question again.
10. To add a new question group, click the name of the current question group. Click Add Question Group.
11. To move a question group, click the title of the question group. Then click the up or down arrows.
12. When you finish adding groups and questions, click Save or Save and Publish.
Note: To preview the form, click Preview Off.
Assign a development and feedback module(click on link in the resources)
Prerequisites:
Master admin role with the following permissions:
Learning > Assignment > All permission
Learning > scheduleSlot > View permissio
Learning > Module > All permission
Learning > Rule > All permission
Learning > CoverArt > All permission
or
Performance admin role with the following permissions:
Learning > Assignment > Add, Delete, Reset, View permissions
Learning > Module > Add, Archive, Delete, Edit, Publish permissions
Learning > Rule > Edit, View permissions
Learning > Cover Art > All permission
You can enable auto assign to assign modules automatically to agents after you publish them. If you enable auto assign for a published module, the system assigns the module immediately. Genesys Cloud regularly checks the rules nightly or when you publish a new version of the module and assigns modules to agents that match added or updated rules. If an agent no longer matches the rules, and they did not start the module, the system automatically removes the module assignment. Genesys Cloud does not unassign modules if the modules are in progress or completed.
Notes:
When working with Development and Feedback, you can only create, work with, edit, and assign a feedback module in divisions for which you have permission. That is, you can only view data from the divisions in which you are a member. For more information, see Divisions overview and Assign roles, divisions, licenses, and add-ons.
As a supervisor you can reset a module when an agent makes a mistake and assign a module again to determine an agent’s progress. For more information, see Reset and assign a module again.
You can disable auto assign so that the system no longer automatically assigns modules to agents.
When auto assign for a published module is disabled, existing in progress or completed items remain assigned. Any items that an agent has not started are unassigned.
Collapse All
Auto assign a module
In the module creator, click the Auto Assign tab.
To assign modules automatically based on rules that you create, enable Auto assign.
Create a rule.
Select Include or Exclude.
Select the ACD skills, division, group, and queue.
Add the lists of people that you want to include. The right column displays the people that belong to the lists you add.
If you want to add another rule, click Add rule, and then repeat steps 3a-3c.
When you finish creating the rules, click Save.
Note:
You can modify module rules. You can edit published or draft views. When you update a rule and save the new criteria, the system applies it when you save the rule and to future scheduled executions of the automated assignment.
If the rule changes the assignment and the module is in progress or complete, any prior assignment remains. If an agent did not start the module, the system unassigns it.
Assign a module manually
Click Performance > Workspace.
Under Employment Engagement, select Agent Development.
Click the Development tab.
Choose the agent that you want to assign a module.
Click the Assign Module button at the top of the page.
In the field at the top of the Assign Module window, search for the module you want to assign.
Note: The system performs the search on the module title and description.
From the list provided to the right of the Search field, filter the module list according to the following.
Planned – The module is assigned to the agent. To view the module’s due date, hover over the Planned status.
In Progress – The agent is performing the module. To view the module’s due date, hover over the In Progress status.
Completed – The agent completed the module. To view when it was due, when it was completed, and its score, hover over the Completed status.
Not Yet Assigned – The module is not assigned to the agent. By default, the module list first appears with modules that have the Not Yet Assigned status.
Invalid Schedule – The assigned module was deleted or moved to a different schedule.
Scroll through the list of modules that appears and click Assign to assign a specific module.
Note: If a recommended duration is configured for a module, the recommended duration appears for the specific module.
If the module status is In Progress or Completed, an Assign Again option appears. For more information, see Reset and assign a module again.
If the module status is Invalid Schedule, select Reschedule.
Select one of the following options.
Turn on the Use Schedule option.
Note: This option adds the training to the agents schedule.
Select the date range in which you want the agent to take the training and the duration of the appointment.
Click Check and then select a time slot. In the calendar in the right side of the screen, you can see the best available time slot options as well as the schedule for the agent.
Note: If the agent is associated with a Workforce Management Business Unit, 10 optimal time slots appear
Use the Complete by fields to select the date and time by which the agent must complete the module and then click Next.
Click Next.
Review the details and click Confirm.
Notes:
To verify that the module is assigned successfully, open your Inbox or open your Activity page and search for the assigned module in the Assigned Modules section.
When an assignment becomes out of sync with your schedule, the assignment is marked as Invalid Schedule, and you must reschedule it. Agents can still complete assignments with an Invalid Schedule status without the need to reschedule.
Work with a program(click on link in the resources)
Prerequisites
Programs, topics, and phrases requirements
Programs are a package of topics that instruct the speech and text analytics feature about which business level intents to look for in recorded conversations between interaction participants. Programs are mapped to specific queues or flows and can contain topics of varying languages or dialects. This is essential since different parts of the contact center may have different business interest intents.
Topics must be defined before you can add them to a program. However, you can change topic contents after you add it to the program. The topic contents that are defined when the program is applied are the contents that speech and text analytics searches for. For more information, see Work with a topic.
Note:
· The Programs feature includes one preconfigured program that includes a set of preconfigured topics. The preconfigured program is automatically set as the default program. The default program can be changed at any time. To change the default program, see Set a default program below.
Collapse All
View and understand the program list
Click Admin > Quality.
Click Programs. A list of all of the available programs is displayed.
Click the image to enlarge.
The following information and options appear in the Programs list:
·
Create Program – Click the Create Program button to create a new program. For more information, see Create a program below.
Publish – Click the Publish button to publish one or more programs. For more information, see Publish a program below.
# Unpublished programs – Shows the number of programs that are not published.
Name – A unique program name.
Description – A free text description of the program.
Tags – The Tags column shows the tags associated with the specific program.
Assigned Queues – Indicates the number of queues associated with the specific program. For more information, see Create and configure queues.
Assigned Flows – Indicates the number of flows associated with the specific program. For more information, see Manage flows.
Delete Program – Enables you to delete the specific program. Click the x associated with the program you want to delete. Click Yes when you are asked if you are sure you want to delete the program.
All Tags (#) – Select one or more tags to filter the programs list to show the programs associated with the selected tags.
Select Queue(s) – Select one or more queues to filter the programs list to show the programs associated with the selected queues.
Select Flow(s) – Select one or more flows to filter the programs list to show the programs associated with the selected flows.
Search – Use the Search field to find a specific program.
View a program
Click Admin > Quality.
Click Programs. A list of all available programs are displayed.
From the Name column, click the name of the program you want to view. The selected program details are displayed.
Click the image to enlarge.
Review the program details:
Program Name – Enter a unique name that is easy to correlate to the business issue.
Description – Enter a free text description of the program.
Tags – A tag enables you to classify and group programs and topics. Click the tag field to open the tag list and view the selected tags.
Queues – Queues currently mapped to the program. For more information, see Create and configure queues.
Flows – Flows currently mapped to the program. For more information, see Manage flows.
Transcription Engines – Select the dialect and transcription engine that should transcribe the interactions. Click Add Engine to add an additional transcript engine.
Click the Selected topics (#) tab to see the list of topics associated with the selected program. For more information, see Work with a topic.
o
Select Show selected only to see a list of the topics associated with the specific program.
Use the Search field to find a specific topic.
Filter the Selected topics list using the following filter options:
All Tag (#) – Select one or more tags to filter the programs list to show the programs associated with the selected tags.
All Dialects (#) – Select one or more dialects to filter the topics list to show the topics associated with the selected dialects.
Click Close to return to the programs list.
Create a program
Note:
Fields marked with a red asterisk (*) are mandatory. You cannot create a program if you do not fill in the fields marked with a red asterisk.
The maximum number of tags per program and per topic is 20.
The maximum number of programs per organization is 100.
A program is limited to 500 queues and to 500 flows.
The maximum number of queues and flows for the entire system is 20,000.
Click Admin > Quality.
Click Programs. A list of available programs is displayed.
Click the Create Program button at the top of the program list.
Configure the following program details:
Program Name – Enter a unique name that is easy to correlate to the business issue. The program name is case sensitive and is limited to 100 characters.
Description – Enter a free text description of the program. The program description is limited to 10240 characters.
Tags – A tag enables you to classify and group programs and topics. Select one or more existing tags and/or create one or more new tags. In the field provided type the tag name. If the tag exists, it appears in the tag list. If you are creating a new tag the word appears with (New Tag) next to it. The tag name is case sensitive and is limited to 100 characters. Press Enter to add the new tag.
Queues – Select one or more queues to map to the program. For more information, see Create and configure queues.
Flows – Select one or more flows to map to the program. For more information, see Manage flows.
Transcription Engines – Select the dialect and transcription engine that should transcribe the interactions. Click Add Engine to add an additional transcript engine.
Click the Selected topics (#) tab to add one or more topics to the new program.
Click the checkbox next to the topic(s) you want to add to the program. For more information, see Work with a topic.
Click Save Draft to create the new program. A Program successfully saved as a draft message appears in the top right corner of the screen.
Click Close on the left to return to the programs list.
Note:
To implement new programs and/or program changes you must publish the specific program. After you publish the new and/or updated programs all new interactions in the database are processed according to the updated and new programs.
Edit a program
Note:
Fields marked with a red asterisk (*) are mandatory. You cannot create a program if you do not fill in the fields marked with a red asterisk.
Click Admin > Quality.
Click Programs. A list of all available programs is displayed.
From the Name column, click the name of the program you want to change. The selected program details are displayed.
Change one or more of the program details:
Program Name – A unique name that is easy to correlate to the business issue. The program name is case sensitive and is limited to 100 characters.
Description – A free text description of the program. The program description is limited to 10240 characters.
Tags – A tag enables you to classify and group programs and topics. Select one or more existing tags and/or create one or more new tags. In the field provided type the tag name. If the tag exists, it appears in the tag list. If you are creating a new tag the word appears with (New Tag) next to it. The tag name is case sensitive and is limited to 100 characters.
Queues – Queues currently mapped to the program. Queues can be added or removed from the program from this drop down menu. For more information, see Create and configure queues.
Flows –Flows currently mapped to the program. Flows can be added or removed from the program from this drop down menu. For more information, see Manage flows.
Transcription Engines – Select the dialect and transcription engine that should transcribe the interactions. Click Add Engine to add an additional transcript engine.
Click the Selected topics (#) tab to see or change the topics associated with the selected program. For more information, see Work with a topic.
Select Show selected only to see a list of the topics associated with the specific program.
Use the Search field to find a specific topic.
Filter the Selected topics list using the following filter options:
All Tags (#) – Select one or more tags to filter the topics list to show the topics associated with the selected tags.
All Dialects (#) – Select one or more dialects to filter the topics list to show the topics associated with the selected dialects
Click Save Draft to save your changes. A Program successfully updated as draft message appears in the top-right corner of the screen.
Click Close on the left to return to the programs list.
Note:
To implement new programs and/or program changes you must publish the specific program. After you publish the new and/or updated programs all new interactions in the database are processed according to the updated and new programs.
Copy a program
Click Admin > Quality.
Click Programs. A list of available programs is displayed.
From the Name column, click the name of the program you want to copy. The selected program details are displayed.
Click Copy.
The following message appears:
“You successfully copied the <program name>. The copied program will only be created after you click Save Draft. “
Make one or more changes to the copied program and click Save Draft. A Program successfully saved as a draft message appears in the top-right corner of the screen.
Click Close to return to the programs list.
Delete a program
When you delete a program, the deletion is published automatically.
Click Admin > Quality.
Click Programs. A list of all of the available programs is displayed.
From the Name column, click the name of the program you want to delete. The selected program details are displayed.
Click Delete Program in the bottom right corner of the screen. A Program Editor message appears asking you if you are sure you want to delete the selected program.
Click Yes. A Program successfully deleted message appears in the top-right corner of the screen.
Publish a program
To implement new programs and/or program changes you must publish the specific program. After you publish the new and/or updated programs all new interactions in the database are processed according to the updated and new programs.
Note:
A maximum of 10 programs are published at one time. You can publish a program from the Programs list and from the specific program page.
When publishing a program that includes topics whose changes have not been published (that is, at the topic level), a force publish will be performed on the unpublished topics.
Publish a program from the program page
Click Admin > Quality.
Click Programs. A list of all available programs is displayed.
From the Name column, click the name of the program you want to publish. The selected program details are displayed.
Click Publish. The following three messages (the third message is an example), appear in the top-right corner of the screen.
Program successfully updated as a draft.
Program successfully published.
The publish request for {count} programs made at {timeStamp}, was completed successfully.
Click Close to return to the programs list.
Publish a program from the Programs list
Click Admin > Quality.
Click Programs. A list of all available programs is displayed.
Click Publish.
In the Publish Programs window select the programs that you want to publish.
Click Publish Programs. The following messages appear in top-right corner of the screen.
Program successfully published.
The publish request for {count} programs made at {timeStamp}, was completed successfully.
Set a default program
Click Admin.
Under Quality, click Speech and Text Analytics.
Under Default Program, select the fallback program to use for topic detection if no program is mapped to a Queue or Flow.
Create a policy(click on link in the resources)
Feature coming soon: Support for queues, percentages and agent connected duration policies to enable additional control over the generation of evaluations
Prerequisites
Recording > Retention Policy > Add permission
Recording > Retention Policy > Edit permission
Recording > Retention Policy > View permission
Policies specify which interaction recordings to retain or delete. You can also use policies to automate some repetitive Quality Management tasks, such as creating evaluations or starting a calibration.
Policies do not generate quality management evaluations for interactions that took place prior to enabling the policy. Policies only apply to interactions that happen after you enable the policy.
Note:
· When a policy has an action to Create Evaluations by Evaluator, Create Evaluations by Interactions, or Create Calibration Evaluations, the policy selects the first agent connected to the interaction as the agent to be evaluated.
· When a policy creates an evaluation for Create evaluations by agents, the policy selects the last agent that participated in the interaction that meets the specified users or teams matching criteria. The policy will not select a user who was a monitor or coach.
· When there are overlapping policies, and a policy retains a recording for longer than another, Genesys uses the policy that keeps the recording in the system for longer to prevent potential configuration issues.
This applies to policies which retain a recording for an indefinite time and to policies where the date of deletion is further in the future.
To create a policy, complete the following steps:
1. Click Admin.
2. Under Quality, click Policies.
3. Click Create New Policy.
4. Enter a name for the policy.
5. Enter a description of the policy’s function.
Tip: Use the Description text box to indicate the policy’s purpose such as “evaluate inbound support calls” or “delete all calls less than 30 seconds.”
6. Click a media type tab and enable or disable the policy for each media type.
7. Fill out the Matching Criteria and Actions to Perform for each media type separately.
8. Optionally, choose one or more of the following Matching Criteria:
Conversation directions — Indicates whether to capture inbound or outbound interactions.
Specific users — Matches against one or more contact center users.
Specific work teams – Matches against interactions serviced by one or more work teams.
Time sets — Matches against interactions during the specified time ranges.
Specific queues — Matches against one or more queues.
Specific wrap-up codes — Matches against one or more wrap-up codes.
Date range — Matches against interactions on certain dates.
Conversation duration — Matches against a specified conversation duration. Conversation duration includes any part of the interaction, including time in queue and after call work.
Customer participation — Matches against email and message interactions during which a customer participated, or a customer did not participate.
Notes: If you select Create evaluations by agents, you must select one or more users or teams in the matching criteria. For more information, see Create evaluations by agents.
Genesys Cloud does not record internal calls within your organization.
Policies are not automatically modified when an agent, queue, or wrap-up code is deleted.
Recordings
Recording Retention (Required) — Specifies whether to retain or delete a recording.
Retain recordings – You must retain interactions for evaluations, calibrations, and surveys. Retrieve recorded interactions from the interaction’s details page.
Do not save recordings – Interactions are not saved for long term storage. If selected, other recording options, as well as evaluation and survey options are not
applicable and are not shown.
Delete even if another policy retains — This option appears when you select “Do not save recordings.” By default, if there is a policy overlap, Genesys Cloud retains recordings. For example, if one policy retains a recording, but another deletes it, Genesys Cloud keeps the recording. To override that behavior and delete recordings that match this policy, even if there is an overlap with another policy, select this option.
Note: Call recording requires that Line Recording is enabled on the SIP trunk. Contact your telephony administrator and refer them to the Enable Line Recording procedure. For more information, see Enable line recording.
Archive recording after — Specifies a length of time to retain the recording in immediately available storage. After this interval, Genesys Cloud moves the recording to long-term storage.
Delete recordings after — Specifies the number of days before deleting the recording.
Note: If the maximum interaction data retention time is set, the number of days cannot be longer than the maximum interaction data retention time. For more information, see Set the maximum interaction data retention time.
Export copy of recordings — Automatically export recordings, including screen recordings (if selected), to an AWS S3 bucket. For more information about the integration, see About the AWS S3 recording bulk actions integration.
Note: Genesys Cloud exports recordings one time. If you create an export that matches a recording that has already been exported, that recording will be skipped.
Initiate screen recording — Specifies whether to start a screen recording. You can specify whether to record after call work and archive the recording. You must enter a delete date, and you can keep screen recordings for a maximum of 365 days.
Note:
Genesys Cloud can record screens only during ACD interactions. You cannot create a policy to initiate recording during non-ACD interactions.
The actions to perform on screen recordings are only performed by the policy that initiates the screen recording.
Evaluations
Create evaluations by evaluators — Automatically creates the specified number of evaluations per time period for each evaluator specified in the policy. You can specify a form, one or multiple evaluators, when to assign evaluations, and the number of evaluations per time interval that the policy assigns to the selected quality evaluators. For example, if you specify 5 evaluators and choose 2 evaluations per day, Genesys Cloud will assign 5 evaluations x 2 times per day for a total of 10 evaluations per day.
Create evaluations by Agents — Automatically creates the specified number of evaluations per time period for each agent listed in the matching criteria. Select the number of evaluations per time period, the time zone, evaluation form to use, specify the connected time and one or multiple evaluators. Genesys Cloud assigns evaluations evenly among the selected evaluators. For more information about this action, see Create evaluations by agents.
Create evaluations by interaction — Automatically creates an evaluation for every matching interaction. You can specify a form and one or multiple evaluators. If multiple evaluators are specified, they will each be assigned the same set of interactions to evaluate. For example, if 20 interactions fit the policy matching criteria, Genesys Cloud will create evaluations for all 20 interactions and assign them to all of the selected evaluators in the policy.
Create calibration evaluations — Automatically creates a calibration evaluation for every matching interaction. You can specify a form, two or more evaluators, an expert evaluator, and a calibrator.
Note:
You can choose to create up to the maximum number of evaluations per agent per time period. This limit prevents policies from accidentally assigning more evaluations than an evaluator can complete.
The maximum number of evaluations that you can create per agent per time interval:
Day: 50
Week: 175
Month: 700
A policy creates an evaluation to interactions without a recording on the agent side of the interaction. For example, if an agent dismisses and does not reply to an email, then Genesys Cloud does not create a recording for the agent and the policy cannot create an evaluation for the interaction. However, you can still manually assign an evaluation to the interaction.
Surveys
Send web survey — Automatically sends a web survey email invitation for matching interactions. Select a survey form, survey invite flow, email domain, and number of invitations to send. For more information, see Create a web survey policy.
Repeat steps 6 through 9 for each media type that you want the policy to match.
Click Save.
Add a new topic miner(click on link in the resources)
You can access the topic miner from Admin > Quality > Topic Miner. For more information, see Access the topic miner. You can also create a new topic miner by importing a .json file from an external source.
Collapse All
Show me: Create a miner from the topic miner
This example demonstrates how to create a new topic miner.
To create a new topic miner, perform the following steps:
Click Admin.
Under Quality, click Topic Miner.
Click Create a New Miner. The New Miner page opens.
Under Name, add a descriptive name for the miner.
Click the Language list and select the language in which to mine topics.
Note: Currently, topic mining supports the following dialects: en-US, en-AU, en-GB, en-IN, and en-ZA.
To mine data from Genesys Cloud, perform these steps:
Under Data Source, click Genesys Cloud.
Under Date range, use the calendars to select the date range in which the miner searches conversations between the agent and the customer.
Note: The conversations limit is 30,000.
Under Media Type, select Chat, Call, or Message transcripts.
Click the Participants list and select whether to mine topics from internal agents, external customers, or both.
Click the Queues list and select up to five queues from which to mine transcripts.
Note: If you do not specify any queues, the system selects all queues by default.
To upload a file from another source, perform these steps:
Under Data Source, click External File.
Under File upload, click Click to upload.
Select and upload the JSON file source.
Click Confirm.
The mining process begins and the Miner Status column displays the progress. If the system encounters an error, you can open the session, review and correct the error, and then restart the session.
Create topics from a completed miner(click on link in the resources)
After you add a new topic mining session and the mining completes, click it to review the results. The results show the topics that the topic miner derived from the conversation transcripts, and the percentage of total conversations within that topic. For each mined topic, the results display the following metrics:
The percentage of total conversations that include the topic
The number of conversations that include the topic
The number of sentences, comprised of one turn from the agent or the customer, that include the topic
The number of segments or phrases within a conversation that include the topic
The following example shows data for the “exchange rate” topic in the Silver Springs Ski Resort miner:
In this example, the topic miner mined two topics. The topic “exchange rate” appeared in 21.74% of the total conversations. The topic appeared in five conversations and in five sentences from either the agent or the customer, and the phrase was used five times.
To view the associated phrases, click a topic in the mined topics column. You can select the phrase that you want to import to your new or existing topic, and then view the list in the Topics column.
In the topics list, a mark indicates a published topic. A draft mark indicates a draft topic.
Click the image to enlarge.
View relevant snippets from transcripts
To view the conversation fragment that includes the selected phrase, click More and from the menu that appears, click View Snippets.
To view the snippet of the transcript in which the phrase exists, click the information button next to the topic miner name. Topic miner captures each time that a phrase appears in a transcript snippet, so if a phrase appears more than once, it appears in numerical order.
Note: The topic miner masks personally identifiable data (PII).
Show me
Choose phrases to add to the topic
To choose phrases to add to the topic, perform these steps:
In the topics column, click the appropriate topic. The topic’s phrases appear in the middle column.
In the phrases column, select each phrase that you want to add to the bot.
To add the phrases to an existing topic, follow these steps:
Navigate to the topic and click the down arrow to expand it.
From the list that appears, select the existing topic.
Click Add Phrases. The phrase or phrases for the selected topic move to the Topics area.
Click Confirm.
To add the phrases to a new topic, follow these steps:
Click New Draft Topic.
Under Topic Name, add a meaningful topic name.
Click Create.
Click Add Phrases. The phrases for the selected topic move to the new draft topic.
Click Confirm.
Repeat steps 1–4 for each new phrase that you want to add.
(Optional) To remove any phrases from a topic, next to the phrase to remove, click Delete .
You can now work with and refine the configuration for the topic in Admin > Quality > Topics. For more information, see Work with a topic.
Create a topic
For information about how to create a topic from the topic miner, see Create topics from a completed miner.
Note:
Fields marked with a red asterisk (*) are mandatory. You cannot create a program if you do not fill in the fields marked with a red asterisk.
The maximum number of tags per program and per topic is 20.
Click Admin > Quality.
Click Topics. The list of available topics is displayed.
Click the Create Topic button at the top of the program list.
Configure the following topic details:
Topic Name – Enter a unique name that is easy to correlate to the business issue.
Description – Enter a free text description of the topic. The description is limited to 1000 characters.
Tags – A tag enables you to classify and group programs and topics. Select existing tags or create new tags. In the field provided type the tag name (100 character limit). If the tag exists it will appear in the tag list. If you are creating a new tag the word will appear with (New Tag) next to it. Press Enter to add the new tag.
Programs – Contains the number of programs associated with the selected topic. Click inside the Programs field to see the selected programs, to select or deselect programs and to search for specific programs. For more information, see Work with a program.
Strictness – Indicates how strict the matching algorithm is when matching phrases in a transcript. The matching algorithm looks at phrase confidence after stemming to determine if the phrase is a match. For additional details, refer to the following definitions:
Phrase confidence – A score between 0 and 100 generated by speech and text analytics during phrase matching. Phrase confidence depends on word order and any missing or substituted words within the transcript.
Stemming – The process of transforming a word to the base root of that specific word. As a result, different tenses or plurals of a specific word are considered a match (for example, when the root word is cancel, then canceled, cancels, cancelling, etc. are considered a match).
Dialect – Indicates the dialect associated with the specific topic. Select a dialect from the Dialect field.
Participants – Indicates the participant associated with the specific topic. Click within the Participants field to select one of the following participants:
External – Indicates that the specific topic will only be recognized when its phrases were said by the Customer.
Internal – Indicates that the specific topic will only be recognized when its phrases were said by IVR, ACD, agent, conference, or voicemail.
All – Indicates that the specific topic will only be recognized when its phrases were said by an external participant, internal participant, or both.
Click the Phrases (#) tab to add a list of phrases. For more information, see Work with a phrase.
Click Save Draft to create the new topic. A Topic successfully saved as a draft message appears in the top right corner of the screen.
Click Close to return to the topics list.
Create a web survey form(click on link in the resources)
Prerequisites
Genesys Cloud CX 3, Genesys Cloud CX 1 WEM Add-on II, or Genesys Cloud CX 2 WEM Add-on I license
The following permissions:
Quality > Survey Form > Add
Quality > Survey Form > Edit
Quality > Survey Form > View
Create the survey that customers see to rate their last interaction with your contact center. After you create the survey form, set up the survey invite flow in Architect and create a policy to send out the survey.
Click Admin.
Under Quality, click Survey Forms.
Click Create.
Select a Survey Language. Genesys Cloud translates the survey form editor and default survey text, such as Clear or characters remaining, to your chosen language. However, Genesys Cloud does not translate any text you add, such as questions or directions.
In [Survey name here], enter a name for your survey. Customers completing the form do not see the survey name.
Optionally, to add a header to your survey, click add header. You can add information about your company, instructions, or images to the header. For more information about formatting the header, see Format the header and footer in a web survey form.
Add question groups and questions to the survey form.
To see a preview of how the survey will appear to customers, click Preview off.
To return to editing the survey, click Preview on.
To save the survey, click Save. You cannot save a survey if you did not select a language, if you did not enter a name for the survey, or if any questions or answer choices are blank.
To publish the survey, click Publish. Every time you edit, save, and republish a survey, Genesys Cloud saves the edits as a new version of the survey. Genesys Cloud sends the newest version of a survey to customers.
Create and publish an evaluation form(click on link in the resources)
Prerequisites
Genesys Cloud CX 1 WEM Add-on II, Genesys Cloud CX 2, or Genesys Cloud CX 3 license
The following permissions:
Quality administrator permissions
Evaluation forms measure script adherence, compliance with business practices, customer satisfaction, or other business benchmarks.
Note: When you create an evaluation form, consider the following evaluation form limits.
Form name: 250 characters
Form max question count: 200 questions
Question group name: 250 characters
Question text length: 500 characters
Evaluation assistance condition: maximum of 10 topics in total for one answer.
When you create an evaluation form, one or more of the following icons may appear:
Evaluation assistance
Click Admin.
Under Quality, click Evaluation Forms.
Click Create.
In the Evaluation Form Name field, enter a name for the evaluation form.
In the Question Group Name field, enter a name for the first question group. A question group is a label that categorizes a set of questions, for example, Product Knowledge.
Note: When you begin to create the first group, an evaluation form table of contents appears under the Content tab. This table of contents grows as you add more questions and groups to your evaluation form.
(Optional) Select the Scoring tab and then turn on the Scaled Scoring On option. If scoring is enabled, in the Group Score Scaling Factor field under the Question Group Name, assign a numeric weighting factor for the question group.
Note: You can add a group and answer score directly in the group and answer itself. You can also add/change a group and answer score from the Score tab in the right side of the screen. For more information about weights, see Evaluation form weights.
In the Question Group Properties area, select the following options:
· N/A Enabled Question Group: Allows evaluators to select N/A (not applicable), which skips all questions in the group.
· Answers Default To: Specifies whether you assign answers to the highest scoring answer or N/A by default.
Note: If you select both options, the default selection is the N/A option for a question that has N/A as an answer.
· Display Conditionally: This option allows you to set criteria for whether this question group is shown.
8. Select Add Question and select one of the following question types. By default, you can insert a multiple choice, range, or yes/no question. If they are available, then you can insert custom question types.
Add a multiple choice question
A multiple choice question allows the respondent to select a single answer from a list of choices.
a. From the Add Question list, select Multiple Choice.
b. In the Question field, enter the question name.
c. In the Help Text field (optional), add explanatory text about the question. In the evaluation form, the explanatory text appears as a tooltip.
To preview the explanatory text, click Preview Form Off and then move your cursor over the question mark.
To return to edit mode, click Preview Form On.
Enter an answer in each of the fields provided. Click +Add Answer to add another answer to the multiple choice question.
Add numeric values to the Points box. Generally, correct answers have a value of one. Incorrect answers have a value of zero.
(Optional) Click the +Add Evaluation Assistance Condition.
Note: Selecting the Add Evaluation Assistance Condition option enables you to configure the system to automatically fill out evaluation forms based on what speech and text analytics detects throughout the interaction. For more information, see the Evaluation Assistance section at the bottom of this page.
(Optional) Select one or more of the following options.
Add N/A as an Answer: In the evaluation form, an N/A check box appears. If the respondent selects N/A, then other choices in the question are cleared and unavailable.
Require Additional Comments: This selection requires a respondent to add comments after an answer.
Display This Question Conditionally: This option allows you to set criteria for whether this question is shown.
Critical Question and Fatal Question: The Critical Question and Fatal Question check boxes work together.
Note: A critical question requires the respondent to select one of only two possible answers. Assign the correct answer a value of one. Assign the incorrect answer a value of zero. If the respondent selects the incorrect answer and the question is a Fatal Question, when an evaluator scores the evaluation, the fail result is assigned. To select Fatal Question, first select Critical Question.
To delete an answer, select the answer and click Trash.
i. To reuse this question on other forms, click Save As Template. Add a descriptive name in the Template Name field and then click Save.
To add the exact question to your question favorites list, select Make this a favorite template.
To complete the question, click Done.
Add a range question
A range question prompts the respondent to select a single numeric answer, for example, to rank agent performance from 1 to 5. You can customize the answer to display any numeric or string choice, and you can configure the score for each answer.
· In the Question field, enter the question name.
· In the Help Text field (optional), add explanatory text about the question. In the evaluation form, the explanatory text appears as a tooltip.
o To preview the explanatory text, click Preview Form Off and then move your cursor over the question mark.
o To return to edit mode, click Preview Form On.
Enter an answer in each of the fields provided. Click +Add Answer to add another answer to the multiple choice question.
Add numeric values to the Points box. Generally, correct answers have a value of one. Incorrect answers have a value of zero.
(Optional) Click the +Add Evaluation Assistance Condition.
o Note: Selecting the Add Evaluation Assistance Condition option enables you to configure the system to automatically fill out evaluation forms based on what was detected by speech and text analytics throughout the interaction. For more information, see the Evaluation Assistance section at the bottom of this page.
(Optional) Select one or more of the following options.
Add N/A as an Answer: In the evaluation form, an N/A check box appears. If the respondent selects N/A, then other choices in the question are cleared and unavailable.
Require Additional Comments: This selection requires a respondent to add comments after an answer.
Display This Question Conditionally: This option allows you to set criteria for whether this question is shown.
Critical Question and Fatal Question: The Critical Question and Fatal Question check boxes work together.
Note: A critical question requires the respondent to select one of only two possible answers. Assign the correct answer a value of one. Assign the incorrect answer a value of zero. If the respondent selects the incorrect answer and the question is a Fatal Question, when an evaluator scores the evaluation, the fail result is assigned. To select Fatal Question, first select Critical Question.
o
To delete an answer, select the answer and click Trash.
· To reuse this question on other forms, click Save As Template. Add a descriptive name in the Template Name field and click Save.
You can select the Make this a favorite template to add the exact question to your question favorites list.
To complete the question, click Done.
Add a yes or no question
A yes/no question prompts the respondent for one answer.
· In the Question field, enter the question name.
· In the Help Text field (optional), add explanatory text about the question. In the evaluation form, the explanatory text appears as a tooltip.
o To preview the explanatory text, click Preview Form Off in the right corner of the screen. Move your cursor over the question mark.
o To return to edit mode, click Preview Form On.
Enter an answer in each of the fields provided. Click +Add Answer to add another answer to the multiple choice question.
Add numeric values to the Points box. Generally, correct answers have a value of one. Incorrect answers have a value of zero.
(Optional) Click the +Add Evaluation Assistance Condition.
o Note: An evaluation assistance condition can only be configured for one answer per question.
Selecting the Add Evaluation Assistance Condition option enables you to configure the system to automatically fill out evaluation forms based on what was detected by speech and text analytics throughout the interaction. For more information, see the Evaluation Assistance section at the bottom of this page.
o
(Optional) Select one or more of the following options.
Add N/A as an Answer: In the evaluation form, an N/A check box appears. If the respondent selects N/A, then other choices in the question are cleared and unavailable.
Require Additional Comments: This selection requires a respondent to add comments after an answer.
Display This Question Conditionally: This option allows you to set criteria for whether this question is shown.
Critical Question and Fatal Question: The Critical Question and Fatal Question check boxes work together.
o Note: A critical question requires the respondent to select one of only two possible answers. Assign the correct answer a value of one. Assign the incorrect answer a value of zero. If the respondent selects the incorrect answer and the question is a Fatal Question, when an evaluator scores the evaluation, the fail result is assigned. To select Fatal Question, first select Critical Question.
To delete an answer, select the answer and click Trash.
· To reuse this question on other forms, click Save As Template. Add a descriptive name in the Template Name field and click Save.
You can select the Make this a favorite template to add the exact question to your question favorites list.
To complete the question, click Done.
a) To add another question to this question group, click Add Question.
b) To add a new question group, click the name of the current question group and then click Add Question Group.
c) Use the arrows next to the question group name to move the question group.
a. Note: To move a question group all of its answers must be complete.
d) When you finish adding groups and questions, click Save.
a. Note: If you do not configure a group or question properly, a red border appears around it. The Save button is not available until you properly configure all groups and questions.
e) Click Publish Form.
a. Note: You cannot assign a form to quality evaluators until you publish the form. The Publish Form button is not available until you click Save.
f) (Optional) Click Preview Form On to preview the form.
Evaluation assistance
You can add one to 10 evaluation assistance conditions to each evaluation form question.
An evaluation assistance condition is made up of topics. Topics are collections of phrases that indicate a business level intent. For example, if you want to identify interactions where the customer wants to cancel a service, create a topic named Cancellation and include several phrases, such as “close out my account” or “I wish to cancel.” In addition, topics help to boost the recognition of specific words and phrases in the interaction because they adapt the underlying language model to look for organization-specific language in conversations.
When you add an evaluation assistance condition to a form question, speech and text analytics must locate interactions with the topics included in the condition. When an interaction with the specific topic is located, an answer to the specific question is automatically generated. For more information, see Understand programs, topics, and phrases and Work with a topic.
Notes:
A topic cannot be used in more than one evaluation assistance condition.
When you delete a topic, the condition that includes the deleted topic is no longer valid.
Add an evaluation assistance condition to a form question
Create an evaluation form question.
Click Add Evaluation Assistance Condition that is associated with the answer for which you want an answer to be automatically generated.
From the select if conversation list, select if you want the conversation to include or exclude one or more topics.
From the these topics list, select one or more topics.
(Optional) Click the Add Evaluation Assistance Condition option again to add another condition to the same answer.
Notes:
An evaluation assistance condition can only be configured for one answer per question.
When more than one topic is selected for a single Includes condition, only one of the topics must be found for the condition to be true.
When more than one topic is selected for a single Excludes condition, only one of the topics must be found for the condition to be false (that is, all topics must be absent from the interaction for the condition to be true).
When more than one condition is created for a single answer, all the conditions must be true for the answer to be automatically entered.
Configure external metrics for performance scorecards(click on link in the resources)
Prerequisites
Genesys Cloud CX 3, Genesys Cloud CX 3 Digital, or Genesys Cloud EX license, Genesys Cloud CX 1 WEM Add-on II, Genesys Cloud CX 2 WEM Add-on I, Genesys Cloud CX 3 Digital, or Genesys Cloud EX license
Employee Performance > External Metric Definition > View permission
Employee Performance > External Metric Definition > Add, Delete, and Edit
External metrics data supplied with an API connection. For more information, see the Genesys Cloud Gamification API.
Performance Management Admin role
Note: The Performance Management Admin role is enabled for all new organizations. However, anyone with an existing org must add this new role by using the Authorization API to restore all default roles.
Performance management and Gamification is focused on defining performance goals and expectations, and then measuring against these goals to see how individuals and teams are performing. This feature allows you to import external metrics and make them an integral part of an employee’s performance scorecard. As a result, supervisors receive a single and complete view of agent performance on all key measures that your organization cares about. For more information, see Configure gamification profile metrics.
Note: External metrics data must be supplied by an API connection. The metric data uploaded via an API connection will be grouped and calculated by workday. For more information, see the Genesys Cloud Gamification API .
Some examples of external metrics are:
CSAT (Customer satisfaction scores – often from 3rd parties)
Daily Sales
First Contact Resolution Rate
Number of Leads Generated
Number of visits booked
Retention Rate
Refund Rate
Net Promoter Score
Perform the following steps to measure employee performance using external metrics
Configure external metric definition in Genesys Cloud. For more information, see the sections in the External metric definition configurations section below.
Add and enable the external metric for gamification profiles
Upload metric data using the Genesys Cloud External Metric API.
Note:
Upload external metrics for the current workday: gamification reflects the update in a few seconds.
Upload external metrics for workdays for the previous workday and up to 7 days in the past: gamification reflects the update during the nightly job.
Upload external metrics for future dates: gamification reflects the update on the specified future date, during the nightly job. This means that the update will be available on the selected future day, early in the morning.
Upload external metrics for workdays more than 7 days in the past: gamification does not reflect the update.
External metric definition configurations
Collapse All
1. Add new external metric definitions
Click Admin.
Under Performance & Engagement, click External Metric Definitions.
Click New External Metric.
Click the image to enlarge.
Configure the following:
Metric Name – The name of the type of external metric being defined.
Metric Unit – Select from either number, seconds, percent, or currency. The metric unit indicates the unit of measurement for the specific metric. For example, the metric unit for the Total Daily Sales metric can be currency, Avg. Hold Time can be seconds, and CSAT can be a number. The metric unit is used by gamification when setting up metric objectives and when displaying the metric data on the agent’s scorecard.
Rounding Precision – Select how many digits to round to when the metric is displayed in the UI.
Default Objective Type – Indicates the default that will be used when a user tries to add the specific external metric to a gamification profile. For more information, see Configure gamification profile metrics.
Move the Disabled slider to the right to enable the metric. Metric enablement takes effect immediately.
Click Save Metric.
Note: Once the external metric definition is created and enabled, it can be added to one or more gamification profiles. For more information, see Configure gamification profile metrics.
2. Edit external metric definitions
Click Admin.
Under Performance & Engagement, click External Metric Definitions.
From the list provided, click the external metric definition you want to edit.
Click the image to enlarge.
Change one of more of the following:
Metric Name – The name of the type of external metric being defined.
Metric Unit – Select from either number, seconds, percent, or currency. The metric unit indicates the unit of measurement for the specific metric. For example, the metric unit for the Total Daily Sales metric can be currency, Avg. Hold Time can be seconds, and CSAT can be a number. The metric unit is used by gamification when setting up metric objectives and when displaying the metric data on the agent’s scorecard.
Rounding Precision – Select how many digits to round to when the metric is displayed in the UI.
Default Objective Type – Indicates the default that will be used when a user tries to add the specific external metric to a gamification profile. For more information, see Configure gamification profile metrics.
Perform one of the following:
Move the Disabled slider to the right to enable the metric. Metric enablement takes effect immediately.
Move the Enabled slider to the left to disable the metric. Metric disablement takes effect at the end of the current workday.
Click Save Metric.
Note:
Once the external metric definition is created it includes the following information:
Data Refreshed – The last date (that is, timestamp) on which data was last uploaded for the external metric definition.
External Metric ID – A unique ID that is generated by the system when a new external metric definition is created. This ID appears in the UI and uniquely identifies each metric definition in the system. It helps match the associated data uploaded for the metric.
3. Delete external metric definitions
Click Admin.
Under Performance & Engagement, click External Metric Definitions.
From the list provided, click the Delete from the menu in the Actions column associated with the external metric you want to delete.
When asked if you are sure you want to delete this external metric, click Yes, Delete.
Note: You cannot delete an external metric definition if it has been enabled and used with a gamification profile.
Topology & Certificate Authorities
Trunks & Sites
Edges & Edge Groups
Phone Management, DID Numbers & Extensions
Metrics
Configure certificate authorities(click on link in the resources)
Prerequisites
Telephony > Plugin > All permission
Note: The digital certificates described in this article only apply to the BYOC Premises. For information on digital certificates for BYOC Cloud, see TLS trunk transport protocol specification.
Digital certificates ensure the identification of a trusted authority through encryption. Genesys Cloud supports two types of digital certificates: Managed and Remote.
Managed
There is only one managed digital certificate for your Genesys Cloud organization, and it is set up and managed by Genesys. Genesys Cloud uses this managed certificate authority to create trusted TLS connections for components such as the Edge and managed phones. This managed certificate authority also allows remote SIP devices to trust and accept secure connections to External Trunks connected to the Edge.
Remote
You can add remote certificate authorities in Genesys Cloud by importing the digital certificate files issued to your organization. These remote digital certificates allow the Edge to trust a remote TLS endpoint.
Note: You cannot add, edit, or delete managed certificate authorities. The Type column identifies certificate authorities as managed or remote.
Add a remote certificate authority
There are two ways that you can import a remote digital certificate into Genesys Cloud.
Click Admin.
Under Telephony, click Certificate Authorities.
Click Create New.
Under Add Certificate Authority, select the appropriate option.
Upload from computer
Click Browse.
Find the .crt file.
Click Open.
Paste text from a file
Copy the contents of your certificate file.
Paste the contents in the Enter Your Certificate Authority box.
In the Select Service for Use box, type or select the appropriate services from the list.
Click Save Certificate Authority.
Edit a remote certificate authority
Learn how to edit a remote certificate authority
You can edit a remote certificate authority by adding or deleting a service.
Click Admin.
Under Telephony, click Certificate Authorities.
Click the check box next to the common name.
Click Edit.
In the Select Services for use box
To delete an existing service, select the service type and click Remove.
To add a new service, select the appropriate service type from the list.
Click Save Certificate Authority.
Delete a remote certificate authority
Learn how to delete a remote certificate authority
Click Admin.
Under Telephony, click Certificate Authorities.
Click the check box next to the common name.
Click Delete. A confirmation message appears.
Click OK.
Manage DID and toll-free number assignments(click on link in the resources)
Prerequisites
Telephony > Plugin > All permission
After you set up numbers on the DID Ranges tab, you use the DID assignments tab to assign DID and toll-free numbers to a person, a phone, or a call flow. You can also unassign numbers. The main display consists of a table that allows you to view all the available and assigned numbers. You can customize the table by adding and removing columns or use the View option to display the numbers by their assignment status. A search feature allows you to search certain columns in the table.
Assign a number
Click Admin.
Under Telephony, click DID Numbers.
Click the DID Assignments tab.
Select a check box next to the DID number that you want to assign.
Click Assign to access the Assign a DID number panel.
Select one of the following items from the Assignee Type list and fill in associated information:
Collapse All
Person
Select Person from the Assignee Type list.
Select a user from the Assignee list.
Select one of the following from the Save Number as list.
Work Phone
Work Phone 2
Work Phone 3
Work Phone 4
Home Phone
Mobile Phone
Call Flow
Select Call Flow from the Assignee Type list.
Select a call flow from the Assignee list.
Phone
Select Phone from the Assignee Type list.
Select a phone from the Assignee list.
Select a line key name from the Save Number To box.
The DID Number box contains the number you selected. However, can select another unassigned number from the list.
Click Save.
Unassign numbers
Access the DID Assignments tab.
Select a check box next to the DID number that you want to unassign.
Click Unassign.
Click Unassign to confirm.
Extension pools(click on link in the resources)
Prerequisites
Telephony > Plug-in > All permission
Telephony > Extensions > Add, Edit, View, and Delete permission
Add a single extension or a range of extension numbers and assign them to a division within your organization.
Note: Before you assign an extension number to a user, you must first add the number to an extension pool.
Collapse All
Add a single extension number
Click Admin.
Under Telephony, click Extensions.
Click the Extension Pools tab.
Click Add Extension Pool.
In the Extension Start field, type the extension number that you want to add to the organization.
Leave the Extension End field unchanged.
From the Division list, select a division.
Click Create.
The extension number is now available for assignment to a user.
Column
Description
Extension Start
The single extension number, or the first sequential number in a range of extension numbers.
Extension End
The last sequential number in a range of extension numbers. This field is blank if only one extension number was entered in the Extension Start box.
Division
The division in your organization in which you want to place the extension.
Note: Only people with Telephony > Extension Pool > View permission in this division can use this pool. For more information, see Divisions overview.
Add a range of extension numbers
Click Admin.
Under Telephony, click Extensions.
Click the Extension Pools tab.
In the Extension Start field, type the first sequential extension number for the range that you want to assign to the organization.
In the Extension End field, type the last sequential extension number for the range that you want to assign to the organization.
From the Division list, select a division.
Click Create.
The extension numbers are now available for assignment to users.
Column
Description
Extension Start
The single extension number, or the first sequential number in a range of extension numbers.
Extension End
The last sequential number in a range of extension numbers. This field is blank if only one extension number was entered in the Extension Start box.
Division
The division in your organization in which you want to place the extension.
Note: Only people with Telephony > Extension Pool > View permission in this division can use this pool. For more information, see Divisions overview.
Add an extension number to a user
Click Admin.
Under People and Permissions, click People. The Manage People page displays.
In the Search field, begin typing the user's first or last name and click Edit Person next to the appropriate match. The user's profile displays.
In the Person Details tab, click View Edit Mode.
In Contact Information, click Edit.
Under Phone, find the phone number that you want to add the extension number to and type it in the ext. field.
Note: Do not add an extension number in a Work Phone entry that contains a previously entered phone number. This action prevents Genesys Cloud from generating a dial plan for the user, and the extension does not appear in the list of extensions on the Assignments page. Add the extension number in an empty Work Phone entry.
Click Save.
Delete extension numbers
If the extension number you want to remove exists within a range, you must delete the entire range of extensions. You cannot delete a single extension from a range unless it was originally entered as a single extension number. Also, you cannot delete an extension pool when an extension within the pool's range is assigned to a user.
Click Admin.
Under Telephony, click Extensions.
Click the Extension Pools tab.
Select the extension number or range of numbers that you want to remove.
Click More.
From the menu that appears, click Delete.
When you see the confirmation dialog, click Yes, Delete.
Modify the Extension Pools view
Task
Description
Rearrange columns
Click any column and drag it to a new position.
Add/Remove columns
You can customize the Extension Pools view by adding and removing columns. Use Choose the data to display and select next to the columns you want to display.
Column
Description
Pool
Display the extension pool.
Division
Display the division.
ID
Display the ID. This is a unique ID that a developer can use to work with the extension pool in the public API.
To return the Extension Pools view to its default configuration, clear all the check boxes and click Save.
Set row density
You can customize the Extension Pools view with the row density setting. Use Choose the data to display and select one of the row density options. Comfy increases the amount of space between rows and Compact condenses the amount of space between rows.
Create base settings for a remote phone(click on link in the resources)
Prerequisites
Telephony > Plugin > All permission
Any phone, such as a cell phone, can be configured to work with Genesys Cloud using a remote phone base settings profile. This profile contains only a few basic configuration settings. These settings are found on the Base Phone tab.
Click Admin.
Under Telephony, click Phone Management.
Click the Base Settings tab.
Click Add Base Settings.
Base Phone tab
Configure settings on the Base Phone tab.
Type a name in the Base Settings Name box.
From the Phone Make and Model drop-down list, select Remote.
Choose one of the following steps:
To use the default base settings, click Save Base Settings and proceed to the Create a remote phone article.
To customize the base settings, proceed to the Customize the base settings section of this article.
Customize the base settings
In the Phone Configuration section of the Base Phone tab, there are two expandable sections: General and Custom that allow you to change the base settings for a remote phone.
To customize the base settings:
Select the appropriate settings from each expandable section.
To use the custom base settings, click Save Base Settings.
Configure the Genesys Cloud WebRTC phone(click on link in the resources)
Prerequisites
Telephony > Plugin > All permission
The process to configure a Genesys Cloud WebRTC phone is a two-step operation. First, create and configure the base settings. Second, create and configure the phone.
If the base settings for the Genesys Cloud WebRTC phone are already configured, you only need to create and configure the phone.
Notes:
When you configure a Genesys Cloud WebRTC phone to use under Genesys Cloud Voice, keep in mind that the Genesys Cloud Voice configuration enables the external trunk by default. So, you only need to create the base settings and phone settings for your Genesys Cloud WebRTC phones.
You can only create one WebRTC phone per user.
Create the base settings
The base settings configuration contains a group of settings that define how the Genesys Cloud WebRTC phone operates in Genesys Cloud. After you create a base settings configuration, save it with the default settings or customize the settings.
To create the base settings:
Click Admin.
Under Telephony, click Phone Management.
Click the Base Settings tab.
Click Add.
Type a name in the Base Settings Name box.
From the Phone Make and Model list, select Genesys Cloud WebRTC Phone.
Choose one of the following steps:
To use the default base settings, click Save Base Settings and proceed to the Create the phone section of this article.
To customize the base settings, proceed to the Customize the base settings section of this article.
Create the base settings(click on link in the resources)
Genesys, AudioCodes, and Poly/Polycom phones
Prerequisites
Telephony > Plugin > All permission
Before you can create a phone, create a base settings configuration for that phone model. The base settings configuration contains a group of settings found on the Base Phone and Base Line Appearance tabs that define how a particular phone model is to operate in Genesys Cloud. Once you create a base settings configuration, you can save it with the default settings or you can customize the settings.
Click Admin.
Under Telephony, click Phone Management.
Click the Base Settings tab.
Click Add Base Settings.
Base Phone tab
Configure settings on the Base Phone tab.
Type a name in the Base Settings Name box.
From the Phone Make and Model list, select your phone.
Leave Standalone Features set to Off unless you are creating a base settings configuration for conference room phones. See Enable standalone features.
Perform one of the following:
To use the default base phone settings, click Save Base Settings and proceed to the Configure the base line appearance section of this article.
To customize the base phone settings, proceed to the Find your phone’s configuration settings article, locate your phone, and follow the link to get the details.
Base Line Appearance tab
Configure settings on the Base Line Appearance tab.
Type a name in the Key Label box.
If you want this appearance to be available on the other keys, select the Span appearance to remaining keys check box.
Perform one of the following:
To use the default base phone settings, click Save Base Settings. You can now Create a phone.
To customize the base phone settings, proceed to the Find your phone’s configuration settings article, locate your phone, and follow the link to get the details.
Create a physical phone(click on link in the resources)
Genesys, AudioCodes, and Poly/Polycom phones
Prerequisites
Telephony > Plugin > All permission
Once you have created a base settings profile you can create the phone profile. This profile contains a group of settings found on the Phone and Line Keys tabs that define the phone in Genesys Cloud. The majority of the settings on the Phone and Line Keys tabs are inherited from the base settings. However, you can customize the phone by altering any of the settings that it inherited from the base settings configuration-without effecting the original base settings configuration. See Inherited settings.
Configure the phone
Click Admin.
Under Telephony, click Phone Management.
Click the Phones tab.
Click Add Phone.
Phone tab
Configure settings on the Phone tab.
Type a name in the Phone Name box.
From the Base Settings list, select the base setting configuration you created.
From the Site list, select your site.
Note: If you are using BYOC Cloud or Genesys Cloud Voice, do not use the PureCloud Voice – AWS site. Make sure that you select one of the sites that you created.
Type the phone’s MAC address in the Hardware ID box.
Note: When entering the MAC address, just enter the numbers as a single string. Do not separate the numbers with a “:” as it will cause problems during provisioning.
Leave Standalone Features set to Off unless you are configuring settings for a conference room phone. See Enable standalone features.
Choose one of the following steps:
To use the default phone configuration settings, click Save Phone and proceed to the Line Keys tab section of this article.
To customize the phone settings, proceed to the Find Your Phone’s Configuration Settings article, locate your phone make and model, and then follow the link to get the details.
Line Keys tab
Click the Line Keys tab.
Type a name in the Key Label box.
Type a name in the Line Appearance Id box.
If you want this copy this line key appearance to other line keys, select the Span appearance to remaining keys check box.
If you want to specify a call back number to be sent when a call is made to an emergency service, type that number in the Emergency Number field.
Choose one of the following steps:
To use the default line keys settings, click Save Phone.
To customize the line keys configuration settings, proceed to the Find Your Phone’s Configuration Settings article, locate your phone make and model, and follow the link to get the details.
Create a remote phone(click on link in the resources)
Prerequisites
Telephony > Plugin > All permission
Once you created a remote phone base settings profile, you can create the phone profile. This profile contains a few settings found on the Phone tab that define the remote phone in Genesys Cloud. Some settings on the Phone tab are inherited from the base settings. However, you can customize the phone by altering any of the settings that it inherited from the base settings configuration-without effecting the original base settings configuration. See Inherited settings.
Notes:
A call to a cell phone configured as a remote phone in Genesys Cloud may not connect if the number is not assigned to a Genesys Cloud user profile. Some cell carriers do not allow calls to unassigned numbers.
If the remote phone is part of a group ring, keep in mind that Genesys Cloud uses call analysis to verify delivery of calls to remote phones. Therefore, to avoid disconnection, users must answer with a verbal response.
Warning: Do not set up a remote phone with a private phone number if calls to that phone could include sensitive information, such as health records or credit card data. Doing so could violate certain regulations, such as HIPAA.
Configure the phone
Click Admin.
Under Telephony, click Phone Management.
Click the Phones tab.
Click Add.
Phone tab
Configure settings on the Phone tab.
Type a name in the Phone Name box.
From the Base Settings list, select the remote phone base settings configuration you created.
From the Site list, select your site.
In the Remote Address box, enter the phone’s SIP address or remote phone number using E.164 format.
For more information, see Phone addresses or E.164 overview.
Choose one of the following steps:
To use the default phone configuration settings and complete the remote phone configuration, click Save Phone.
To customize the phone configuration settings, proceed to the Customize the Phone section of this article.
Customize the phone
In the Phone Configuration panel, click the arrow to expand the section containing the settings you want to customize.
To use the custom phone configuration settings and complete the remote phone configuration, click Save Phone.
Configure the Genesys Cloud WebRTC phone(click on link in the resources)
Prerequisites
Telephony > Plugin > All permission
The process to configure a Genesys Cloud WebRTC phone is a two-step operation. First, create and configure the base settings. Second, create and configure the phone.
If the base settings for the Genesys Cloud WebRTC phone are already configured, you only need to create and configure the phone.
Notes:
When you configure a Genesys Cloud WebRTC phone to use under Genesys Cloud Voice, keep in mind that the Genesys Cloud Voice configuration enables the external trunk by default. So, you only need to create the base settings and phone settings for your Genesys Cloud WebRTC phones.
You can only create one WebRTC phone per user.
Create the base settings
The base settings configuration contains a group of settings that define how the Genesys Cloud WebRTC phone operates in Genesys Cloud. After you create a base settings configuration, save it with the default settings or customize the settings.
To create the base settings:
Click Admin.
Under Telephony, click Phone Management.
Click the Base Settings tab.
Click Add.
Type a name in the Base Settings Name box.
From the Phone Make and Model list, select Genesys Cloud WebRTC Phone.
Choose one of the following steps:
To use the default base settings, click Save Base Settings and proceed to the Create the phone section of this article.
To customize the base settings, proceed to the Customize the base settings section of this article.
Customize the base settings
In the Phone Configuration section of the Base Phone tab, there are four expandable sections: General, Media, Network, and Custom that allow you to change the base settings for the Genesys Cloud WebRTC phone.
To customize the base settings:
Select the appropriate settings from each expandable section.
Click Save Base Settings.
Proceed to the Create the phone section of this article.
Create the phone
Once you create, configure, and save the base settings for the Genesys Cloud WebRTC phone, create the phone and assign it to a user.
To create the phone, follow these steps:
Select the Phones tab.
Click Add Phone. The Phone tab appears.
In the Phone Name box, type a name.
From the Base Settings list, select the base setting configuration that you created for your Genesys Cloud WebRTC phone.
From the Site list, select your site.
Note: If you use BYOC Cloud or Genesys Cloud Voice, do not use the PureCloud Voice – AWS site. Make sure that you select one of the sites that you created.
From the Person list, select the name of the person to whom you want to assign this Genesys Cloud WebRTC phone.
Choose one of the following steps:
To use the default phone settings, click Save Phone.
To customize the phone settings, proceed to the Customize the phone section of this article.
Customize the phone
In the Phone Configuration section of the Phone tab, four expandable sections appear: General, Media, Network, and Custom. Each expandable section contains controls that customize the settings for the Genesys Cloud WebRTC phone. These settings are inherited from the base settings. However, you can customize a particular phone by altering any setting that it inherits from the base settings configuration without affecting the original base settings configuration. For more information, see Inherited settings.
To customize the phone:
Select the appropriate settings from each expandable section.
Click Save Phone.
Create a WebRTC phone trunk(click on link in the resources)
When creating a WebRTC phone trunk, Genesys recommends that you just choose the appropriate WebRTC phone trunk type and rely on the default settings under the Connection Configuration section.
Note: Confirm that the ports required for WebRTC are not blocked by your firewall. For more information, see About ports and services for your firewall.
Click Admin.
Under Telephony, click Trunks.
Click the Phone Trunks tab.
Click Create New.
In Phone Trunk Name, enter a trunk name.
From the Type list choose one of the following:
Select Cloud WebRTC Phone Connections, if you are using BYOC Cloud.
Select WebRTC, if you are using BYOC Premises.
Click Save Phone Trunk.
Create a trunk under BYOC Cloud(click on link in the resources)
Prerequisites
Telephony > Plugin > All permission
The External Trunks page has two sections. The upper section contains the base settings needed for an External Trunk. The lower section, which consists of a series of collapsible sections, contains other settings that you can use to refine your external trunk configuration.
Genesys Cloud recommends that you rely on the base BYOC Cloud trunk settings described in this article. However, if your carrier has other requirements, you can use the additional settings to refine your external trunk configuration. For more information, see Configure advanced external trunk settings.
There are two types of BYOC trunks that you can select depending on how your telephony system is set up. Each trunk type also has a subtype that is designed to narrow down the settings that are required for that type of trunk. In the case of the BYOC PBX trunk type, there is only one subtype. In the case of the BYOC Carrier trunk type, there are two subtypes: One is a generic subtype that you can use for most carrier configurations. The other is a Verizon-specific subtype that you use if Verizon is your carrier.
If you need more information about any of the settings on the External trunk page, see External trunk settings.
Configure an external trunk
Click Admin.
Under Telephony, click Trunks.
Click the External Trunks tab.
Click Create New.
In External Trunk Name, enter a trunk name.
From the Type lists, select the type and subtype for the BYOC Cloud trunk you want to create.
BYOC Carrier
Under Type:
Select BYOC Carrier from the first list.
Select either Generic BYOC Carrier or Verizon BYOC Carrier from the second list.
BYOC PBX
Under Type:
Select BYOC PBX from the first list.
Select Generic BYOC PBX from the second list
Set Trunk State to In-Service.
Select the appropriate trunk transport protocol from the Protocol list.
For more information, see Choose a trunk transport protocol.
Under Inbound you configure the appropriate settings for your trunk subtype:
Generic BYOC PBX
Enter an identifier in the Inbound SIP Termination Identifier box.
The Inbound SIP Termination Identifier is a static configuration that should be populated with a regionally unique identifier. This identifier will be used to direct traffic from third-party PBXs to the organization.
Enter a header in the Inbound SIP Termination Header box.
The Inbound SIP Termination Header is a custom field that contains the Termination Identifier value for inbound calls to Genesys Cloud.
Generic BYOC Carrier
Enter an identifier in the Inbound SIP Termination Identifier box.
The Inbound SIP Termination Identifier is a static configuration that should be populated with a regionally unique identifier. This identifier will be used to direct traffic from external Carriers to the organization.
Enter a header in the Inbound SIP Termination Header box.
The Inbound SIP Termination Header is a custom field that contains the Termination Identifier value for inbound calls to Genesys Cloud.
Note: The Inbound SIP Termination Header field is optional. This field should only be used when the standard identification methods like FQDN, TRGP and SIP DNIS are unavailable.
Genesys Cloud BYOC Verizon
Enter an identifier in the Inbound SIP Termination Identifier box.
The Inbound SIP Termination Identifier is a static configuration that should be populated with a regionally unique identifier. This identifier will be used to direct traffic from Verizon to the organization.
The Inbound SIP Termination Header box is preconfigured with a Verizon-specific header.
If you cannot use either the FQDN or the TGRP format for the inbound SIP termination identifier, enable DNIS Replacement Routing.
For more information on the Inbound settings, see Configure SIP routing for a BYOC Cloud trunk.
Under Outbound, enter the appropriate identifiers in the Outbound SIP Termination FQDN, Outbound SIP TGRP Attribute, and Outbound SIP DNIS boxes to configure your outbound request URI.
For more information on the Outbound settings, see Configure SIP routing for a BYOC Cloud trunk.
To specify any SIP Servers or Proxies enter a value in the Hostname or IP Address box, a port number in the Port box, and click Plus.
Choose the appropriate Digest Authentication setting.
If you enable Digest Authentication, you need to specify the associated Realm, and the Username, and Password to use as the authentication credentials.
Under Calling, specify the Caller Address and Caller Name for the trunk and then use the Prioritized Caller Selection to specify the location from which and order in which you want to display caller ID information to the call recipient.
For more information, see Use the Prioritized Caller Selection feature to configure caller ID information.
Under SIP Access Control, you can build a list of IP or CIDR addresses to which you want to permit SIP access. To do so, enter an address and click Plus.
If you are configuring a BYOC PBX trunk, you'll see the PBX Passthrough setting.
Enable this setting if you want to allow your PBX to pass calls intended for the PSTN directly through Genesys Cloud.
For more information, see Configure PBX passthrough for a BYOC trunk.
If you are configuring a Verizon BYOC Carrier trunk subtype, you need to configure a few Verizon-specific settings in the Custom SIP headers section.
Verizon-specific settings
Under External Trunk Configuration, expand the Protocol section.
Under Outbound, in the Custom SIP headers section, you'll find three Verizon-specific Headers:
X-VZ-CSP-Domain
X-VZ-CSP-Customer-Identifier
X-VZ-CSP-Leg-Type
You need to work with your Verizon representative to find the correct values to enter into the Value boxes for X-VZ-CSP-Domain and X-VZ-CSP-Customer-Identifier headers.
The Value box for the X-VZ-CSP-Leg-Type header is automatically filled in with the value of "agent" and you should leave this box as is.
For more information, see Configure Custom SIP headers.
Click Save External Trunk.
Create a BYOC Premises Edge group with a phone trunk(click on link in the resources)
A BYOC Premises Edge group is a set of premises-based Edge devices that are directly connected to one another over a high-bandwidth and low-latency network. The purpose of an Edge group is to allow all Edges in the group to access and share trunks connected to other Edges in the Edge group.
Click Admin.
Under Telephony, click Edge Groups.
Select Create New. The Create Edge Group page appears.
In the Edge Group Name box, enter a name.
Under Phone Trunks, click Select Phone Trunk, and select your WebRTC or SIP phone trunk.
Select Save Edge Group.
Note: By default, the Edge is set to inherit the trunks you select for the Edge Group when you add the Edge group to the Edge. To confirm the setting, navigate to the Admin > Telephony > Edges, click the Network Interfaces tab and under the Phone Trunks section, confirm Inherit from Edge Group is selected.
Note: For advanced telephony configuration, you can also add the phone trunk directly to an individual Edge. Navigate to the Admin > Telephony > Edges, click the Network Interfaces tab and under the Phone Trunks section, click Use the following trunks and click in the Select Phone Trunk field to locate the trunk.
Create a site under BYOC Cloud(click on link in the resources)
Prerequisites
Telephony Admin role with the following permissions:
Telephony > Plugin > All
Directory > Organization > Admin
When you configure a site, you must choose a Media Model setting. If you are using the BYOC Cloud or the Genesys Cloud Voice telephony connection option, you select Cloud as your media model. If you are using the BYOC Premises telephony connection option, you select Premises as your media model. For more information, see Telephony connection options overview.
Warning: You cannot change the media model after you create the site.
Note: Not all locations can be used for sites. Locations do not appear unless you configure the location as available for sites. To configure availability and a default ANI for the location, complete the Make a location available for sites procedure.
Create a site
Click Admin.
Under Telephony, click Sites.
Click Create New.
Type a name in the Site Name box.
From the Location list, select a location for your site.
From the Time Zone list, select your time zone.
Under Media Model, select Cloud.
Click Create Site.
Configure a site
After you click Create Site, the Edit Site page appears. You’ll see that it contains four tabs titled General, Number Plans, Outbound Routes, and Simulate Call. You’ll continue the initial site configuration on the General tab. For details on the settings and features on the other tabs, see the Related tasks section of this article.
At the top of the General tab, enter a Description.
If this site is your initial site, then in the site information panel, click Make this Site my default Site.
Note: You can only set one site as the default site. If you are creating more sites, then do not select Make this Site my default Site until you create all the sites you need.
Choose media regions and specify a Relay/TURN Behavior.
If you are using WebRTC, you need to select a set of media regions and specify a Relay/TURN Behavior. For more information, see Configure your site for Global Media Fabric.
Configure Outbound Calling.
In the Caller ID box, enter the telephone number that you want to appear in the caller ID information for outbound calls. Enter this number in E.164 format, which includes the plus sign (+) and the country code.
In the Caller Name box, enter the name that you want to appear in the caller ID information for outbound calls.
Note: While you can enter Caller ID and Caller Name information here, Genesys Cloud uses the Prioritized Caller Selection feature to specify which caller ID information to use for outbound calls.
Click Save Site.
Create a site under BYOC Premises(click on link in the resources)
Prerequisites
Telephony Admin role with the following permissions:
Telephony > Plugin > All
Directory > Organization > Admin
A site is a list of rules for routing calls. Objects such as phones associated with a site share the same rules. When a user makes a call from a phone, the system looks up the site and the call type in order to route the call to the best outbound phone line, or endpoint. Phones that are associated with a site are usually located in the same general area and have the same general purpose.
When you configure a site, you must choose a Media Model setting. If you are using the BYOC Cloud or the Genesys Cloud Voice telephony connection option, you select Cloud as your media model. If you are using the BYOC Premises telephony connection option, you select Premises as your media model. For more information, see Telephony connection options overview.
Warning: You cannot change the media model after you create the site.
Note: Not all locations can be used for sites. Locations do not appear unless you configure the location as available for sites. To configure availability and a default ANI for the location, complete the Make a location available for sites procedure.
Note: When creating sites, each Edge that you add to a site must have a similar call capacity to ensure proper load balancing. For more information, see Concurrent call capacity for Edge models.
Create a site
Click Admin.
Under Telephony, click Sites.
Click Create New.
Type a name in the Site Name box.
From the Location list, select a location for your site.
From the Time Zone list, select your time zone.
Under Media Model, select Premises.
Click Create Site.
Configure a site
After you click Create Site, the Edit Site page appears. You’ll see that it contains four tabs titled General, Number Plans, Outbound Routes, and Simulate Call. You’ll continue the initial site configuration on the General tab. For details on the settings and features on the other tabs, see the Related tasks section of this article.
At the top of the General tab, enter a Description.
If this site is your initial site, then in the site information panel, click Make this Site my default Site.
Note: You can only set one site as the default site. If you are creating more sites, then do not select Make this Site my default Site.
Choose media regions and specify a Relay/TURN Behavior.
If you are using WebRTC, you need to select a set of media regions and specify a Relay/TURN Behavior. For more information, see Configure your site for Global Media Fabric.
Choose Phone Edge Assignments.
Genesys Cloud assigns phones on this site to use the Edges assigned to this site. For BYOC Premises, click Use this Site.
Configure Outbound Calling.
In the Caller ID box, enter the telephone number that you want to appear in the caller ID information for outbound calls. Enter this number in E.164 format, which includes the plus sign (+) and the country code.
In the Caller Name box, enter the name that you want to appear in the caller ID information for outbound calls.
Note: While you can enter Caller ID and Caller Name information here, Genesys Cloud uses the Prioritized Caller Selection feature to specify which caller ID information to use for outbound calls. For more information, see Use the Prioritized Caller Selection feature to configure caller ID information.
Configure NTP Settings.
If you encounter difficulties with the default NTP settings for the Edge (time.nist.gov on port 123), you can specify Alternate NTP servers.
Configure Automatic Updates.
By default, Genesys Cloud automatically updates to the latest version of Edge software every day from 2:00 A.M. to 5:00 A.M. However, you can configure a custom schedule for Edge updates.
Click Save Site.
Create a site under Genesys Cloud Voice(click on link in the resources)
Prerequisites
Telephony Admin role with the following permissions:
Telephony > Plugin > All
Directory > Organization > Admin
When we create a Genesys Cloud Voice installation for our customers, the automated installation procedure creates a default Site as a part of the process. However, this initial default Site is used in the Genesys Cloud Voice backend and cannot function as an operating Site. Therefore, you must create and configure a new Site. As you do, you must mark this new Site as your default Site. If you don’t, Inbound calls will fail.
When you configure a site, you must choose a Media Model setting. If you are using the BYOC Cloud or the Genesys Cloud Voice telephony connection option, you select Cloud as your media model. If you are using the BYOC Premises telephony connection option, you select Premises as your media model. For more information, see Telephony connection options overview.
Warning: You cannot change the media model after you create the site.
Note: Not all locations can be used for sites. Locations do not appear unless you configure the location as available for sites. To configure availability and a default ANI for the location, complete the Make a location available for sites procedure.
Create a site
Click Admin.
Under Telephony, click Sites.
Click Create New.
Type a name into the Site Name box.
From the Location list, select a location for your site.
From the Time Zone list, select your time zone.
Under Media Model, select Cloud.
Click Create Site.
Configure a site
After you click Create Site, the Edit Site page appears. You’ll see that it contains four tabs titled General, Number Plans, Outbound Routes, and Simulate Call. You’ll continue the initial site configuration on the General tab. For details on the settings and features on the other tabs, see the Related tasks section of this article.
At the top of the General tab, enter a Description.
If this site is your initial site, then in the site information panel, click Make this Site my default Site.
Note: You can only set one site as the default site. If you are creating more sites, then do not select Make this Site my default Site until you create all the sites you need.
Choose media regions and specify a Relay/TURN Behavior.
If you are using WebRTC, you need to select a set of media regions and specify a Relay/TURN Behavior. For more information, see Configure your site for Global Media Fabric.
Configure Outbound Calling.
In the Caller ID box, enter the telephone number that you want to appear in the caller ID information for outbound calls. Enter this number in E.164 format, which includes the plus sign (+) and the country code.
In the Caller Name box, enter the name that you want to appear in the caller ID information for outbound calls.
Note: While you can enter Caller ID and Caller Name information here, Genesys Cloud uses the Prioritized Caller Selection feature to specify which caller ID information to use for outbound calls.
Click Save Site.
Set up a Customer Hardware Solution Edge(click on link in the resources)
Prerequisites
Telephony > Plugin > All permission
32GB or larger USB flash drive
After you have acquired your Customer Hardware Solution (Small or Large) hardware and have it assembled, you are ready to set up your Edge. To do so, Genesys recommends that you have your Edge in its permanent location. For more information on the required hardware, see the appropriate Customer Hardware Solution bill of materials: Small or Large.
Note: Setting up a Customer Hardware Solution Edge requires multiple stages and occurs in multiple user interfaces. The entire operation takes time to complete and requires careful attention to detail.
Check your firewall ports
Before you begin, check your firewall ports to make sure that your Edge will be able to communicate with your network. As you do, pay particular attention to DNS ports. For more information, see Ports for core services.
Download the installer
Download the BYOC Premises – Customer Hardware Solution installer image file.
Take note of the download location. You run the installer at a later part of the process.
Begin the provisioning procedure
In the first stage of the procedure, you begin provisioning the Customer Hardware Solution Edge from within the Genesys Cloud user interface. You are provided two key pieces of information that you will need at a later stage of the operation.
From a Genesys Cloud client computer on your network, log in to Genesys Cloud.
Click Admin.
Under Telephony, click Edges.
Click Provision New Edge.
On the Provision New Edge screen, enter a name in the Edge Name box.
Click BYOC Premises – Customer Hardware Solution.
Enter the HPE serial number found on your server chassis in the Serial number and Confirm serial number boxes.
Click Provision Edge.
On the Enter the device pin and region into the installer screen, take note of the values in the Device PIN and Region fields as you need them later.
Prepare your USB flash drive
To prepare your USB flash drive, you download and use an open source tool called Rufus. The Rufus tool reformats your USB flash drive as a bootable device and then copies the Customer Hardware Solution installer to your USB flash drive.
Download the Rufus tool.
Insert your USB flash drive into the USB port on your computer.
Locate and click the Rufus executable file to run the tool.
Select your USB flash drive from the Device list.
Select the Disk or ISO image from the Boot selection list.
Click Select and choose the image file you downloaded. Rufus automatically fills in the required fields.
MBR or GPT for the Partition scheme.
Note: Rufus chooses the value for the Partition scheme based on the current format of your USB flash drive. Either Partition scheme works.
UEFI (non CSM) for the Target system.
Large FAT32 (Default) from the File system list.
32 kilobytes (Default) for the Cluster size.
Click Start and wait while Rufus prepares your bootable Customer Hardware Solution installation USB flash drive.
When Rufus completes its operation, click Close.
Note: Genesys recommends that you dedicate the USB flash drive to the Customer Hardware Solution installation and not use it for any other data until you are done installing your Customer Hardware Solution Edge. You can then reformat your USB flash drive to its full size.
Set up RAID 1 on your Edge
Customer Hardware Solution – Small Edge
On the Customer Hardware Solution – Small Edge, the installer automatically configures the RAID 1 array on two of the three hard drives in the system. The installer configures the third hard drive for support purposes. More specifically, the third drive stores local media used for factory image restoration and provides space for over-the-air operating system upgrades.
Customer Hardware Solution – Large Edge
For the Customer Hardware Solution – Large Edge, you must manually configure the RAID 1 array and controller before you connect your Edge to the network. You use two of the three hard drives for the RAID 1 array. The installer configures the third hard drive for support purposes. More specifically, the third drive stores local media used for factory image restoration and provides space for over-the-air operating system upgrades.
To configure the RAID 1 array and controller, you can use the HPE Smart Storage Administrator or the configuration menus in the UEFI System Utilities. For more information, see the HPE Smart Array SR Gen10 Configuration Guide.
Connect your Edge to the network
Before you can perform the hardware verification, you must first connect your Edge to an internet facing network. This connection must be made to the WAN port on the Edge.
Note: if the WAN port isn’t specifically designated on the chassis, connect the WAN to the network port with the lowest numbered MAC address.
Perform the hardware verification
To perform the hardware verification, you boot up the Edge using the Customer Hardware Solution installation USB flash drive.
Connect your Edge to your network.
Insert the Customer Hardware Solution installation USB flash drive into a USB port in your Edge.
To boot from the USB flash drive, turn on your Edge and press F11 during the post.
When you see the system boot menu, select the USB drive, and wait while the Edge boots up.
When you see the Customer Hardware Solution installer, select your language, and click Next.
The installer checks the hardware.
If the hardware doesn’t match exactly what the Customer Hardware Solution bill of materials specifies, then the process ends and displays a QR code that will take you to the appropriate Customer Hardware Solution bill of materials article.
If the hardware matches the requirements, you see a success screen. To continue, click Next.
Configure the network adapter settings
In this part of the procedure, the Customer Hardware Solution installer prompts you to configure your network adapter settings,
Click the Use DHCP for WAN box, if you are going to use DHCP addresses.
Enter an address in the WAN port IPv4 address box. (You can use CIDR notation.)
Enter an address in the WAN port gateway (default route) box.
Enter up to two addresses in the IPv4 DNS addresses box.
Click the Use DHCP for iLO box, if you are going to use DHCP addresses.
Enter an address in the iLO IPv4 address box. (You can use CIDR notation.)
Select DHCP in the iLO gateway (default route) box.
Click Next.
Enter your NTP server address in the NTP Host box or leave it blank to use the default NTP host.
Click Next.
Note: Using more than two DNS servers may cause problems.
Set AWS region and enter PIN
In this part of the procedure, you use the Device PIN and Region that you recorded when you began the provisioning procedure.
Select your region from the Genesys Cloud home region list.
Enter the PIN in the Device PIN from Telephony Admin box.
Click Next.
Download the image
In this part of the procedure, the installer downloads the actual Edge image. The download may take some time to complete.
After the download completes, the installer writes the image to the hard disk.
When you see the Ready to download and install prompt, click Next.
When the installer completes the imaging procedure, click Next.
Installer process complete
When the installation is complete, the installer prompts you to reboot the Edge.
Remove the USB flash drive.
Manually reboot the Edge by pressing the power button.
Note: When the Edge reboots, you will see a series of error messages on the screen. However, there is nothing to worry about as these messages refer to HP power services that the Edge software doesn’t use.
Finish provisioning and configure your Edge
At this point, your Edge is paired to your Genesys Cloud organization, and you return to the Genesys Cloud user interface to configure your Edge’s telephony connections.
When you see the Ready to Configure prompt, click Configure Edge.
Platform & Platform Configs
SMS Number Inventory
Support Content Profiles
Threading Timeline
Messenger Configurations & Deployments
Configure Messenger(click on link in the resources)
Feature coming soon: Clear conversation
Prerequisites
To view Configure Messenger:
Genesys Cloud CX 1 Digital Add-on II, Genesys Cloud CX 2, Genesys Cloud CX 2 Digital, Genesys Cloud CX 3, or Genesys Cloud CX 3 Digital license
Web Deployments > Configurations > All permission
Web Deployments > Deployments > All permission
An inbound messaging flow
To view Brand Logo and Bot Avatar upload fields: Uploads > Public Asset > Upload permission
To view Knowledge Base selection field: Knowledge > Knowledgebase > View permission
To view Co-browse field: Conversation > Cobrowse > Add permission
To view and update content profile: messaging > supportedContent > Add, Delete, Edit, and View permission
Messaging improves the customer experience when they visit your website. Before you use web messaging, configure it in Genesys Cloud. To configure web or mobile messaging in your organization, follow these steps:
Click Admin.
Under Message, click Messenger Configurations.
Click New Configuration.
Enter a name and description.
Click the Appearance tab and complete the following information:
Under Set your Launcher Visibility, select a visibility option for the button that opens the Messenger window.
Always show (default): The button is always visible.
Always hide: The button is not visible. Use Always hide if you build your own custom Messenger.
Hide until triggered by business logic: The button is not visible initially and becomes visible when business logic triggers the button on your webpage. You can set this button to trigger programmatically through SDK commands or Predictive Engagement Action Maps.
Under User Interface, perform one of these steps:
To deploy with the Messenger native user interface, leave the default On setting unchanged.
To build your own messaging client through the Messenger’s Headless SDK functions, click On to turn off the setting.
Under Messenger Homescreen, select whether you want the Messenger to display the home screen. When you turn on this feature, configure the brand logo, customize predefined Messenger labels, and enable the Knowledge App. For more information, see Messenger Homescreen and knowledge articles overview.
Under Add a logo, select the required image to use as the brand logo. When you enable this option, the image appears in the home screen and throughout the knowledge base. The images must be in .JPG, .PNG, or .GIF formats. Images larger than 200 x 70 pixels will be resized.
Under Humanize your Conversation, select whether to display a participant name and avatar with the messages that route to your customers. When this feature is on, optionally define a bot name and custom avatar. To configure agent profiles, see Add an agent alias and image. Images must be in .JPG, .PNG, or .GIF formats. Minimum recommended size for images is 75 x 75 pixels.
Under Select your Messenger Color, to configure the Messenger color according to your organization’s preference, perform one of the following steps.
Note: The primary color affects the appearance of the Messenger interface (for example, header, background color of the launcher button, and customer’s message bubble).
Manually enter the web color code (in #HEX notation).
Use the color picker to select the primary color that best matches your brand.
Under Select your Messenger Position, select the Messenger alignment and spacing when it appears on your website.
Under Align to, to select how the Messenger appears on your web page, choose one of the following:
Auto (default): Messenger automatically detects the text direction of the web page. If the web page has left-to-right (‘ltr’) direction, then the Messenger appears on the right of the web page. If the web page has right-to-left (‘rtl’) direction, then the Messenger appears on the left of the web page.
Left: Messenger appears on the left of the web page.
Right: Messenger appears on the right of the web page.
Under Side spacing and Bottom spacing, select or enter the offset spacing alignment in pixels from the closest page border.
To return to the default alignment and spacing settings, click Reset.
Under Select your Supported Languages, click the Select language(s) list and choose the languages that you want to support in the Messenger interface.
Under Select Default Language, click the Select language list and choose the default language. Messenger attempts to automatically detect the customer’s languages from the browser preferences. If the detected language matches any supported language, the Messenger applies the corresponding localized labels to the UI elements. If the detected language does not match any supported language, the Messenger shows UI labels in the default language. For more information, see Genesys Cloud supported languages.
Click Edit Labels and optionally customize predefined Messenger labels when you enable Messenger Homescreen. You can customize labels for each supported language in the configuration.
Click the Apps tab and complete these steps:
Under Clear Conversation, select whether to allow participants to clear their current messaging conversation. When you enable this option, the new bin icon appears in Messenger. This option enhances participant privacy from shared devices. Once triggered, it disconnects conversations that are currently in Queue or connected to Agent and thereby optimizes workforce productivity.
Under Conversation Disconnect, select the messaging behavior that informs your customers when the conversation disconnects. To set a conversation disconnect type, choose one of the following:
Do not display conversation status: The disconnect event does not appear to the customer.
Display conversation status: The user receives information about the disconnect event. Existing conversations can still continue.
Display conversation status and disconnect session: The user receives information about the disconnect event and can start a new conversation, if necessary.
Under Rich Text Formatting, select whether to allow rich text formatting. For more information, see Markdown syntax for rich text in Messenger.
Under Automatically Start Conversations, select whether conversations start automatically when the user expands the Messenger window. This setting works best when you configure Architect’s inbound message flow to send automatic greetings. When this feature is off, conversations start when the user sends the first message.
Note: To improve customer experience, Genesys recommends that you configure an initial welcome message with Architect’s Send Response action available from your inbound message flow prior to a Call Bot Flow action.
Under Attachments, select whether to allow JPG, PNG, or GIF image attachments from customers.
Note: To enable image attachments for web messaging, as an admin user, ensure that your default supported content profile also includes at minimum JPG, PNG, and GIF as allowed extensions for both inbound and outbound direction. This default provisioning is necessary in addition to enabling attachment support on Messenger.
Under Typing Indicators, select whether to inform the other party when a reply is being typed. For more information about agent-specific permissions, see Work with message interactions.
Under Predictive Engagement, select whether to enable the Messenger to collect data about customer activity on your website. Predictive Engagement uses this data to track and manage customer activity.
Under Co-browse, select whether to allow agents to request to view a customer’s screen. After you enable this option, you can also enable the agents to request control of the user’s screen. Additional configuration options include masking of sensitive fields and limiting fields or buttons to read-only, even when the agent has control of the sharer’s browser.
Note: Predictive Engagement and co-browse features are not currently available for Mobile Messenger.
To allow only authenticated users to start a web messaging session with agents, under Authentication, perform these steps:
If you do not already have a valid OpenID Connect Messenger Configuration integration, click Set-up an Integration here. From the AppFoundry, search and install OpenID Connect Messenger Configuration. Configure the integration, and then return here to complete your Messenger configuration.
Note: To enable authentication, make sure that you have a valid OpenID Connect Messenger Configuration integration.
ii.Enable the Authentication toggle.
In Select an integration, select your OpenID Connect Messenger Configuration.
Note: For an overview of all the steps needed to enable authenticated web message, see Get started with authenticated web messaging.
Under Knowledge Articles, select whether to enable the knowledge app. When you enable Messenger Homescreen and knowledge articles, users can search for answers to commonly asked questions and topics. Knowledge bases that you publish from the knowledge workbench V2 appear in the list.
Click Save New Version or Save Draft.
To save the draft as a new version, click Save New Version. For example, the initial draft becomes version 1. The next saved version becomes version 2. Make sure that you save a version of a Messenger configuration before you assign it to a Messenger deployment.
To save the configuration as a draft, click Save Draft.
Deploy Messenger(click on link in the resources)
Prerequisites
To view Configure Messenger:
Genesys Cloud CX 2, Genesys Cloud CX 3, Genesys Cloud CX 1 Digital Add-on II, Genesys Cloud CX 2 Digital, or Genesys Cloud CX 3 Digital license
Web Deployments > Configurations > All permission
Web Deployments > Deployments > All permission
An inbound messaging flow
To view Brand Logo upload field:
uploads > publicAsset > upload
To view Knowledge Base selection field:
knowledge > knowledgebase > view
To view Co-browse field:
conversation > cobrowse > add
Messenger enables web messaging by providing a predefined Messenger window that customers use to interact with bots and agents. Before you create a Messenger deployment, configure Messenger and save a version of the configuration.
Messenger also enables mobile messaging via headless Transport SDK. With the Transport SDK, mobile developers can easily build a custom mobile messaging client.
To deploy Messenger to your website:
Create a Messenger deployment.
Deploy the Messenger snippet to your website. You can manually deploy the Messenger snippet or use Google Tag Manager to deploy the Messenger snippet.
To deploy Messenger to your mobile platform (custom mobile messenger):
Configure the deployment domain and ID in the Transport SDK.
To manage your Messenger deployment, you can:
Change the Messenger configuration assigned to a deployment.
Disable a Messenger deployment.
Delete a Messenger deployment.
Create a Messenger deployment
Click Admin.
Under Message, click Messenger Deployments.
Click New Deployment.
Enter a name and description.
Under Status, use the toggle to set the status of the Messenger deployment.
To enable the Messenger deployment on your website or in your mobile application, turn on the toggle. The status shows as Active.
To disable the Messenger deployment on your website or in your mobile application, turn off the toggle. The status shows as Inactive.
Under Select your Configuration, click Select Configuration to select a version of a Messenger configuration to assign to this deployment.
In the Assignment pane, navigate to the Messenger configuration you want to assign to the configuration and click the name of the Messenger configuration.
Select the version you want to assign.
Click Save.
Under Restrict domain access, determine whether to allow all domains or restrict the domains on which you want to deploy the snippet.
To allow all domains, select the Allow all domains option. Use this option for testing and development purposes.
To restrict domains, enter a domain and click Add Domain. You can add multiple domains to the list. Restrict domains to prevent unauthorized usage of your snippet from unknown domains. If you restrict a domain, then Messenger does not run on that website and rejects API requests from that domain.
Under Select your Architect Flow, select a published inbound message flow.
Click Save. The Messenger Deployments page now displays the snippet and deployment key. Next, copy the Messenger snippet and deploy the Messenger snippet to your website. If you are building a custom Messenger, copy the deployment key.
Deploy the Messenger snippet to your website
Collapse All
Manually deploy the Messenger snippet
Click Admin.
Under Message, click Messenger Deployments.
Navigate to the Messenger deployment you want to deploy and click the name in the Deployment Name column.
Under Deploy your snippet, click Copy to Clipboard to copy the snippet.
Paste the snippet to the head tag of all of your webpages.
To use the Deployment Key with your custom messaging client, configure it in your SDK.
Use Google Tag Manager to deploy the Messenger snippet
Click Admin.
Under Message, click Messenger Deployments.
Navigate to the Messenger deployment you want to deploy and click the name in the Deployment Name column.
Under Deploy your snippet, click Copy to Clipboard to copy the snippet.
In Google Tag Manager, create a new Custom HTML tag.
Paste the snippet into the body of the Custom HTML tag.
Enclose the JavaScript code with script tags. Be sure to unescape the snippet code to remove the new line escaped characters.
Save the tag.
Select the All Pages trigger.
Save the tag with a meaningful name, such as Messenger Tag.
Click Submit
Click Publish to publish the tag to all pages on your website.
Note: In order to have proper support in mobile browsers, your website should include ideal viewport settings in meta>tag. For example: meta name="viewport" content="width=device-width, initial-scale=1". For more information on using viewport meta tag to control layout on mobile browsers, see here.
Configure ACD messaging for LINE Messaging(click on link in the resources)
Prerequisites:
Genesys Cloud CX 2, Genesys Cloud CX 2 Digital, Genesys Cloud CX 3, Genesys Cloud CX 3 Digital, or Genesys Cloud CX 1 Digital Add-on II license
Messaging > Integration > All permission
LINE account
Genesys Cloud ACD messaging provides a way for your customers to use LINE Messaging to interact with agents who are using Genesys Cloud. However, before you can get ACD messaging for LINE Messaging up and running, you must have a LINE developer account and a LINE Messaging app. The method you use to create your LINE app and configure ACD messaging for LINE Messaging depends on the type of LINE developer account you have.
LINE has two different types of developer accounts: Standard and Approved. For more information, see the LINE@ account page.
Regardless of which type of account you have, configuring ACD messaging for LINE Messaging requires multiple steps. The process also involves switching back and forth between the LINE Developers console and Genesys Cloud.
Collapse All
LINE Standard account
To configure ACD messaging for LINE Messaging with a Standard account, you must have the following information from your LINE Messaging app:
Channel ID
Channel Secret
For more information about how to obtain the Channel ID and Channel Secret, see the Standard account section of the Create a LINE app for Genesys Cloud article.
After you have the Channel ID and Channel Secret, perform the following steps:
Click Admin.
Under Message, click Platforms.
Click Create New Integration.
Click the LINE Messaging tile. The Line Messaging page appears.
Note: The status text next to the LINE Messaging icon should show New.
In the Name box, type a name that you want to assign to your integration.
Click Generate Webhook URI.
When the Webhook URI box appears, click Copy Link to copy the link to the clipboard.
Note: You need Webhook URI to complete the LINE Messaging app configuration.
In the Channel ID box, type the Channel ID code you set up with your LINE Messaging app.
In the Channel Secret box, type the Channel Secret code that you set up with your LINE Messaging app.
Leave the Switcher Secret box blank.
Note: A Standard account doesn’t support Switcher functionality.
In the Supported Content list, select a supported content profile. If you do not select a supported content profile, the integration uses the default content profile.
Click Save.
When you return to the Platforms page, notice that the status indicator shows Active in the LINE Messaging tile.
At this point, return to your LINE Developers console and add the Webhook URI as described in the Standard account section of the Create a LINE app for Genesys Cloud article.
LINE Approved account
To configure ACD messaging for LINE Messaging with an Approved account, you perform the procedure in two separate sessions.
In the first session:
Click Admin.
Under Messaging, click Platforms.
On the Platforms page, locate the LINE Messaging row. Notice that the status indicator shows Disconnected.
Click Configure in the LINE Messaging row.
In the Name box, type a name that you want to assign to your integration.
Click Generate Webhook URI.
Click Copy Link.
Click Save.
When you return to the Platforms page, notice that the status indicator shows Incomplete in the LINE Messaging tile.
Follow the instructions in the Approved account section of the Create a LINE app for Genesys Cloud article for adding the Webhook URI and submitting your account for approval.
Once you have an approved account, you can complete the procedure.
Click Admin.
Under Messaging, click Platforms.
Click Finish Setup in the LINE Messaging row.
In the Channel ID box, type the Channel ID code you set up with your LINE Messaging app.
In the Channel Secret box, type the Channel Secret code that you set up with your LINE Messaging app.
If you have applied for Switcher enabled Approved account, type the code in the Switcher Secret box.
In the Service Code box, type the Service Code you received from LINE.
In the Supported Content list, select a supported content profile. If you do not select a supported content profile, the integration uses the default content profile.
Click Save.
When you return to the Platforms page, notice that the status indicator shows Active in the LINE Messaging row.
Once you have a working LINE Messaging app and have configured ACD messaging for LINE Messaging, then you can configure message flows in Architect.
Disclaimer: The third-party application configuration information in this article is provided as general instruction and is subject to change by the third party. Best practice recommends that you review the third-party’s official documentation to confirm that you follow the most recent process.
Configure ACD messaging for Twitter Direct Messaging(click on link in the resources)
Prerequisites
Genesys Cloud CX 2, Genesys Cloud CX 3, Genesys Cloud CX 1 Digital Add-on II, Genesys Cloud CX 2 Digital, or Genesys Cloud CX 3 Digital license
Messaging > Integration > All permission
Twitter account
An approved Twitter developer account
A Twitter app
Genesys Cloud ACD messaging provides a way for your customers to use Twitter Direct Message to interact with agents who are using Genesys Cloud.
Before you can configure ACD messaging for Twitter Direct Message, you must have a Twitter app. For more information, see Create a Twitter app for Genesys Cloud.
To configure ACD messaging for Twitter Direct Message, you must have the following information from your Twitter app:
Consumer API key
Consumer API secret key
Access token
Access token secret
Find your Consumer keys and Access tokens
To find your Consumer keys and Access tokens:
Open a browser and access your Twitter developer Apps page.
Click the Keys and tokens tab.
Take note of the codes under the Consumer API keys heading.
Take note of the codes under the Access token & access token secret heading.
To configure ACD messaging, perform the following steps:
Click Admin.
Under Message, click Platforms.
Click Create New Integration.
Click the Twitter Direct Messaging tile. The Twitter Direct Messaging page appears.
Note: The status text next to the Twitter icon should show New.
In the Name box, type a name that you want to assign to your integration.
In the Consumer Key (API Key) box, type the code that you set up with your Twitter app.
In the Consumer Secret (API Secret) box, type the secret code that you set up with your Twitter app.
In the Access Token box, type the code that you set up with your Twitter app.
In the Access Token Secret box, type the code that you set up with your Twitter app.
In the App Tier box, select the type of Twitter developer account you have. Choose “Enterprise” or “Sandbox (free) or Premium.”
If you have a Premium or Sandbox (free) account, enter your Dev Environment Label in the Environment Name box. For more information, see the Twitter Developer documentation.
Click Save.
In the Supported Content list, select a supported content profile. If you do not select a supported content profile, the integration uses the default content profile.
Click Save again.
Notes:
The status text under the Twitter icon shows Active to indicate that you have logged into Twitter through Genesys Cloud.
The Save button changes to a Delete button. You can use this button to remove the integration,
Warning: If you navigate away from this page, click Save, click Delete, or click Cancel. Genesys Cloud automatically logs you out of the current Twitter session.
Once you have a working Twitter app and have configured ACD messaging for Twitter Direct Message, then you can configure message flows in Architect.
Disclaimer: The third-party application configuration information in this article is provided as general instruction and is subject to change by the third party. Best practice recommends that you review the third-party’s official documentation to confirm that you follow the most recent process.
Configure ACD messaging for Facebook Messenger(click on link in the resources)
Prerequisites:
Genesys Cloud CX 2, Genesys Cloud CX 2 Digital, Genesys Cloud CX 3, or Genesys Cloud CX 3 Digital license
Messaging > Integration > All permission
Facebook account
Published Facebook business page
The Genesys Cloud for Facebook Messenger integration provides a way for your customers to go to your Facebook business page. Then these customers can use Facebook Messenger to interact with your agents who are using Genesys Cloud ACD messaging channels. All you have to do is log in to Facebook through Genesys Cloud and configure a few settings to connect the Genesys Cloud for Facebook Messenger integration to your Facebook business page.
To set up your Genesys Cloud for Facebook Messenger integration:
Click Admin.
Under Message, click Platforms.
Click Create New Integration.
Click the Facebook Messenger tile. The Facebook Messenger page appears.
Note: The status text next to the Facebook Messenger icon shows New.
Click Facebook Login.
When you see the Facebook login dialog box, enter your credentials and click Log In.
Note: When you log in to Facebook, Genesys Cloud creates its own session and automatically retrieves any Facebook pages that you own. When creating additional Facebook integrations, you must select all of your Facebook pages integrated with Genesys Cloud, not just the newest addition.
After you log in to Facebook, two boxes appear in the page.
In the Name box, type a name that you want to assign to your Facebook Messenger integration.
In the Page Name box, select the Facebook business page to which you want to connect the Facebook Messenger integration.
Click Save.
In the Supported Content list, select a supported content profile. If you do not select a supported content profile, the integration uses the default content profile.
Click Save again.
Notes:
The status text under the Facebook Messenger icon now shows Active to indicate that you have logged into Facebook through Genesys Cloud.
The Save button changes to a Delete button. You can use this button to remove the integration.
You can only connect one page to a Genesys Cloud for Facebook Messenger integration. If you want to connect more than one page, you have to create an instance of the Genesys Cloud for Facebook Messenger integration for each page.
When you begin using your Genesys Cloud for Facebook Messenger integration, keep in mind that you must respond to messages from Facebook Messenger within seven days. After seven days, any messages you attempt to send in response will result in an error and are not delivered.
Once you have a working Facebook integration and have configured ACD messaging for Facebook Messenger, then you can configure message flows in Architect.
Warnings:
If you navigate away from this page, click Save, click Delete, or click Cancel. Genesys Cloud automatically logs you out of the current Facebook session.
If you create a Facebook integration and then later change your Facebook account password, you sever the connection between your integration and Facebook Messenger. To re-establish the connection, you have to delete and recreate your Facebook integration.
If you delete your Facebook integration, you are unable to respond to messages still on the left side in the queue.
"Genesys Cloud Administrator Training" is a comprehensive online course designed to equip participants with the skills and knowledge necessary to effectively manage and optimize the Genesys Cloud platform for their contact center operations.
Throughout this course, participants will gain a deep understanding of the Genesys Cloud architecture, learn to navigate the Admin Interface, and master the process of managing users, roles, and access control. The course also covers the creation and management of queues and groups, as well as the design and deployment of dynamic call flows using the Architect tool.
Additionally, the course delves into the various Genesys Cloud integrations available, providing hands-on exercises to set up and manage these integrations. Participants will also learn about analytics and reporting features for monitoring queue and agent performance, and how to optimize call flows based on these insights.
The course culminates with modules dedicated to system configuration, troubleshooting, support, and preparation for the Genesys Cloud Administrator Certification.
Whether you're a new administrator looking to hit the ground running, or an experienced professional aiming to update your skills, this course offers a robust and practical learning experience to enhance your contact center operations.
Module 1: Introduction to Genesys Cloud Objective: Understand the overview of Genesys Cloud, the role and responsibilities of an administrator, and the Genesys Cloud architecture.
Module 2: Navigating the Genesys Cloud Admin Interface Objective: Familiarize with the Genesys Cloud Admin Interface, including the dashboard and admin settings.
Module 3: User Management Objective: Learn how to manage user profiles and permissions, and how to set up roles and access control.
Module 4: Queue Management Objective: Understand how to create and configure queues and assign agents to these queues.
Module 5: Group Management Objective: Learn to create and manage groups and assign users to these groups.
Module 6: Call Flow Design in Architect Objective: Get introduced to Architect, learn how to build and deploy call flows.
Module 7: Genesys Cloud Integrations Objective: Understand the available integrations and how to configure and manage them.
Module 8: Quality and Performance Monitoring Objective: Learn about analytics and reporting, and how to monitor queue and agent performance.
Module 9: System Configuration Objective: Understand how to configure system settings and manage telephony and channel settings.
Module 10: Troubleshooting and Support Objective: Learn about common issues, how to troubleshoot them, and how to leverage Genesys Cloud support and resources.
Module 11: Genesys Cloud Administrator Certification Preparation Objective: Review key topics and skills, learn tips for passing the Genesys Cloud Administrator Certification, and take a practice test.
Module 12: Course Summary and Additional Resources Objective: Recap the course, understand key takeaways and next steps, and discover additional resources for further learning.