Servicenow Plus Administrators Guide
Servicenow Plus Administrators Guide
ServiceNow
Administrator’s Guide
February 2024
Five9 and the Five9 logo are registered trademarks of Five9 and its
subsidiaries in the United States and other countries. Other marks and
brands may be claimed as the property of others. The product plans,
specifications, and descriptions herein are provided for information only and
subject to change without notice, and are provided without warranty of any
kind, express or implied. Copyright © 2024 Five9, Inc.
About Five9
Five9 is the leading provider of cloud contact center software, bringing the power of
the cloud to thousands of customers and facilitating more than three billion customer
interactions annually. Since 2001, Five9 has led the cloud revolution in contact
centers, delivering software to help organizations of every size transition from
premise-based software to the cloud. With its extensive expertise, technology, and
ecosystem of partners, Five9 delivers secure, reliable, scalable cloud contact center
software to help businesses create exceptional customer experiences, increase agent
productivity and deliver tangible results. For more information visit www.five9.com.
Trademarks
Five9®
Five9 Logo
Five9® SoCoCare™
Five9® Connect™
Collecting Logs 59
Application Log 59
Browser Logs 60
Chrome and Edge 60
Firefox 61
Softphone Log 61
Jun 2023 Added support for additional ServiceNow Enabling Support for Additional Work-
workspaces. spaces
May 2023 Added content for configuring SAML for Configuring SAML 2.0 for the Five9 Plus
ServiceNow. Adapter for ServiceNow
Apr 2022 Added support for Canadian domain. Configuring the Five9 Integration Solution
Configuring the Browser
Jun 2021 Added Edge browser support. Configuring the Browser
Removing the Integration
Browser Logs
Sep 2020 Moved information about configuring Single Sign-on Administrator’s Guide
single sign-on.
The Plus Adapter for ServiceNow enables you to integrate the Five9 Cloud Contact
Center with ServiceNow. After your agents have installed the adapter, they can use the
Five9 softphone, a call control tool.
For detailed information about the business and technical requirements to use Five9
products, see the Five9 Technical Requirements or contact your Five9 representative.
With Windows, you can use the adapter with Microsoft® Edge®, Mozilla® Firefox®, and
Google™ Chrome™.
Important
Each browser limits the number of parallel connections for each host. Because
all opened tabs and windows share these connections, opening no more than
five tab and browser windows will avoid performance issues associated with
updating the Five9 adapter in multiple windows. This limitation applies
whether the content of the windows (case, opportunity, or other) differs, or
the windows are opened in different browsers (Firefox, Chrome, Edge). For
more information about the connection limits that apply to your browser and
its versions, refer to your browser vendor.
This guide describes for administrators how to download, install, and configure the
Five9 Plus Adapter for ServiceNow and how to configure the required and optional
elements. Administrators must understand these elements:
l ServiceNow configuration.
l Five9 VCC administrator configuration.
l Five9 Configuration Web Services.
l Overall call center integration and configuration.
Important
Agents and supervisors who log into a PSTN station or forward calls between
sessions may incur high long-distance fees. Therefore, be sure to give
permission only to the appropriate users.
1 To access the Five9 download page, log into your Five9 account.
You may need to answer a security question before continuing.
3 Click Openframe.
4 Click Activate/Repair.
5 Click Activate.
3 Click New.
4 For the new configuration, enter the information for your implementation.
The following table describes the fields that you must set.
Field Description
Name Configuration name
Data Center Data center domain:
o COM (if you access five9.com)
o EU (if you access app.eu.five9.com)
o CA (if you access ca.five9.com)
o UK (if you access app.five9.eu)
ServiceNow Your ServiceNow domain, for example
Domain https://prod12345.service-now.com.
Service Your single sign-on service provider login URL in the format
Provider https://app.five9.com/appsvcs/saml/sp/
Configuring SAML 2.0 for the Five9 Plus Adapter for ServiceNow
Field Description
Initiated <Five9 domain ID>/<Five9 IDP alias>/alias/
Login URL servicenow.
Example:
https://app.five9.com/appsvcs/saml/sp/1/defaul
t/
alias/servicenow.
Identity Your single sign-on identity provider login URL that you obtained
Provider earlier.
Initiated
Login URL
5 Click Submit.
You need to enable your agents and your domain in the VCC Administrator application.
Prerequisites
Obtaining the Metadata
Configuring Your Five9 Domain in VCC Admin
Configuring SSO Federation IDs for Users
Next Steps
Troubleshooting
Prerequisites
ServiceNow licenses are required for users in the domain.
Configuring SAML 2.0 for the Five9 Plus Adapter for ServiceNow
You can manually copy and paste the metadata values from the adapter settings into
the VCC Admin configuration, or you can use the values in the metadata file. You can
find the metadata URL in the Sign On settings.
Note
Configuration changes may take up to 10 minutes to take effect.
Configuring SAML 2.0 for the Five9 Plus Adapter for ServiceNow
5 Enter the metadata by copying and pasting from the Sign On settings in the
adapter configuration, or use the values in the metadata file.
Configuring SAML 2.0 for the Five9 Plus Adapter for ServiceNow
Field Description
Alias Enter your Five9 IdP alias.
Issuer URL URL of the identity provider host, starting
with the server name.
Copy the Issuer URL from the Sign On
settings in the adapter, or use the value
located in the entityId attribute of the
EntityDescriptor element in the metadata
file.
SingleSignOnService HTTP-POST The main login address for your domain,
Binding URL starting with the identity provider host name.
Copy the Sign On URL from the Sign On
settings in the adapter, or use the value in the
location attribute of the
SingleSignOnService element in the
metadata file.
SingleSignOnService HTTP- The alternate login address for your domain,
Redirect Binding URL starting with the identity provider host name.
Copy the Sign On URL from the Sign On
settings in the adapter, or use the value in the
location attribute of the
SingleSignOnService element in the
metadata file.
Valid Until Specify the expiration date and time of the
certificate in the specified time zone.
Configuring SAML 2.0 for the Five9 Plus Adapter for ServiceNow
Field Description
Default NameID Format Select the format of the Name ID, for
example:
urn:oasis:names:tc:SAML:1.1:nameid-
format:emailAddress
6 Under Certificates, click Add and locate the certificate you downloaded from the
Sign On settings in the adapter.
3 On the General tab, in the Federation ID field, enter a name for the agent. You
can use the agent's Five9 user name or another name reserved for single sign-
on.
Next Steps
Continue configuring the adapter. For more information about the adapter
configuration, see Configuring the Plus Adapter for ServiceNow. You will use the Sign
On URL from the adapter settings. For more information about specifying the Sign On
URL, see Configuring the Five9 Integration Solution.
Troubleshooting
Contact Five9 Support for assistance with troubleshooting the configuration.
2 Click New.
Width Width for the adapter in pixels, for example, 501. Minimum is
200.
When set to 500 or lower, the adapter has a narrow
appearance.
When set to 501 or higher, the adapter has a wide
appearance.
Height Height for the adapter in pixels, for example, 500. Minimum is
500.
Five9 Select the Five9 configuration that you created in the previous
Configuration section.
4 Click Submit.
1 Log into ServiceNow as a user who has access to the Five9 adapter.
3 Click New.
5 Click Submit.
6 Click sys_user.
You can now edit the other fields.
For data about a person, select Person Record. For data related to a person,
select Related Record.
8 To make the table active in the system, enable the Active option.
9 To show the active records for the table, enable the Show active records option.
10 To set a comma-separated list of email addresses for the table records, specify
the addresses in Email fields.
12 To set the telephone number format, you can select a predefined type or specify
a regular expression in Phone format.
13 To set the record search rules for calls sent to an agent, select the Voice: Default
Search tab.
You can select one of these search options.
Option Description
No Search No search is performed, which is the default option.
Search By Phone Fields Perform a search using a query for telephone numbers. If
the telephone number fields are phone and mobile_
phone, an example query is
phone=8005551234^ORmobile_phone=8005551234.
Search By Query Perform a search using a query that is defined by an
administrator, for example, phone=@number@^first_
nameSTARTSWITHJohn. When the search is run,
@number@ is replaced with the ANI or DNIS number.
14 To set the record search rules for chats or email messages sent to an agent,
select the Text: Default Search tab.
You can select one of these search options.
Option Description
No Search No search is performed, which is the default option.
Search By Email Fields Perform a search using the email addresses specified in
Email fields.
Option Description
15 Click Update.
Ready-made Scripts
Five9 provides these scripts:
l Five9 User On Load, for the User table
l Five9 Task On Load, for the Task table
The scripts are disabled. You can activate a script, or you can use it as an example for
creating your own.
function onLoad() {
var gf = g_form;
var gu = g_user;
ScriptLoader.getScripts('x_f9_adapter_4_
sn.Five9Utilities.jsdbx', function() {
x_f9_adapter_4_sn.Five9Utilities.postOnLoadEvent
(gf, gu);
});
}
3 Click Submit.
2 Add a field decorations attribute to the table field, with the attribute value set to
x_f9_adapter_4_sn_five9_show_phone.
3 Click Submit.
Consider these points:
l After the field decoration is added and the field value contains a telephone
number, a telephone icon appears next to the telephone number.
l When the telephone icon is clicked, the softphone is populated with the
telephone number.
l If an agent cannot choose a campaign, the call is immediately placed.
Name/Related To list.
l The telephone icon only appears when the Phone Number (E164) field type is
used.
To add the click-to-call feature to a reference field on a form, perform these steps in
ServiceNow:
2 Add a reference contributions attribute to the table reference field, with the
attribute value set to x_f9_adapter_4_sn_five9_show_phone_ref.
3 Click Submit.
Consider these points:
l If there are multiple telephone numbers in a reference record, a pop-up window
with the telephone number list is displayed.
l Telephone numbers retrieved from the reference record include those specified
in Phone fields for the corresponding Five9 table configuration.
The information to display to the agent has to be located first. The search is conducted
in this order: Five9 call variables in the ServiceNow group > Five9 CRM Fields > Voice
Default Search.
Searches are also conducted for calls (inbound, outbound, and preview), voicemail, and
queue callbacks.
Call variables apply to phone calls. To search with call variables, create the ServiceNow
variable group in the VCC Administrator application. Name the variables according to
this format: <table name>.<table column name>.
l <table name>: Name of the table, such as sys_user.
l <table column name>: Table column name, such as mobile_phone.
Example
sys_user.mobile_phone
If multiple variables have the same table name, such as sys_user, the search is
performed for all columns of that table. The search results contain all columns that
have the name of the table.
If multiple tables are configured, the search is performed for all columns of that table.
The search results contain all tables that contain the name of the column.
Example
An incoming call has these call variables:
l sys_user.email = [email protected]
l sys_user.last_name = smith
l customer_account.name = TestCompany
Two searches are performed:
l [email protected]^sys_user.last_name=smith
l customer_account.name=TestCompany
The result contains the sys_user records that match the first condition and
customer account records that satisfy the second condition.
l Softphone logs are located in %appdata%\Five9\Logs. They are saved for four
days before being deleted.
l Event logs are located in the softphone under Help > Logging. The process takes
30–60 seconds. When logging stops, the agent downloads and sends the logs to
you. The file name is similar to this one: Five9 - CRM adapter - Mon, Apr 6,
Logging Fields
You may redirect the softphone logs to a custom directory. To do so, set the F9_
SOFTPHONE_LOG_DIR environment variable in the agent’s workstation. For example, you
may redirect the logs to a NAS share mounted in the agent’s workstation.
Logging Fields
The following table shows the fields that are saved in the call log.
Logging Fields
2 Scroll down to Web Service Transform Maps and click Five9 Activity Log ->
Phone Log.
This is a sample Transform Map that Five9 supplies. You can use it as a template
to create your own map.
3 In the resulting Table Transform Map window, click Copy at upper right.
4 In the resulting Edit Web Service window, scroll down to Web Service Transfer
Maps and click your copy.
5 In the resulting Table Transform Map window, click Active, then Update.
The Field Maps tab at the bottom of the page shows the mapping between
Source (Five9) and Target (ServiceNow) fields.
3 Click Call log table name and select the desired table from the menu (the
example shows Phone Log being selected). Doing this adds a Calls today query
box, below Call log table name, displaying the query that filters records from the
selected table. You can edit this query.
You can configure a transform map to use Phone Log to collect data on all
interaction types. You can also set up separate target tables for email and chat.
2 Click the Controls tab and select the Extensible checkbox. This ensures that you
can create a new custom table by extending the Five9 Activity Log table.
3 Create a new table using the Five9 Activity Log table in the Extends table field,
and then click Submit.
4 Add any custom fields to the newly created custom table, using the type String,
which supports 255 characters max. For a higher character limit, use UTF+8.
5 Go to Five9 Configuration > Activity Log and select the custom table you just
extended. By default, it will be mapped to the Five9 Activity Log table.
Note
There are two options for setting the Activity Log table. You can extend
the columns of the Five9 Activity Log table, which is included in the Five9
managed package, or you can create a new custom table by extending
the Five9 Activity Log table and adding new columns there. The latter
method is the preferred approach used above.
Without federated routing and agent presence synchronization, agents must manually
sync presence states between Five9 and ServiceNow. Presence states represent an
agent's availability to accept various types of interactions. Each agent has a presence
state in ServiceNow and one in the Five9 adapter. Federated routing and presence
synchronization maximize agent productivity by sharing presence states and readiness
between ServiceNow and Five9.
Configuration Overview
Federated routing and presence synchronization require configuration of these core
elements:
Prerequisites
Before you can enable presence state synchronization, do the following:
Once you complete the prerequisites, you can configure presence sync using either the
basic configuration or advanced configuration.
Basic Configuration
This option includes steps to configure a presence state sync without importing the Not
ready reason code from Five9 and mapping it to ServiceNow.
2 Configure the default Available presence state and set the following:
o Active: true
o Service channels: list of channels, for example chat, voice, voicemail
o Show channels: true (Note: this enables you to show the channels
associated with your presense states)
Advanced Configuration
This option includes steps to configure presence state sync and map the Five9 Not
ready reason code.
Note
If not configured, the Five9 adapter for ServiceNow maps all Five9 Not
Ready codes to the ServiceNow Away presence state by default. When
the Away presence state is selected in the ServiceNow UI, Five9 changes
the agent to the System Not Ready state in Five9.
Before you can complete the configuration, follow these steps to export the Five9
object resources file to your ServiceNow environment:
5 Attach the resources.json file you exported from the Five9 Administrator
Console.
2 Add more Not Ready presence states, such as break and meal, to align with
Five9 Not Ready states.
3 Create new Five9 presence configuration records for each presence state Not
Ready code mapping.
o Type: Not ready code mapping
o Not Ready Presence State (ServiceNow states): <record> (for example,
break)
o Five9 Not Ready Code (from VCC): <record> (for example, break)
This maps the ServiceNow Not Ready presence states to Five9 Not Ready reason codes.
You are now ready to use agent presence synchronization.
For example, if an agent's ServiceNow status is currently Available for All and they get a
Five9 voice interaction, the ServiceNow presence state automatically updates to Five9
Voice and Voicemail. This ensures that no ServiceNow chat interaction is routed to the
agent.
Call variables are custom fields that store call data, which enables you to display the
most appropriate interaction and record information to agents. Use call variables
directly in voice interactions and in connectors for digital engagement interactions. You
may use system or custom variables.
d Click Add.
e Select Call Attached Variable.
f Select Call.skill_name.
g Click OK.
The variable is displayed in the list of the Layout tab.
h If appropriate, enable Enforce Users to View Call Variables at the
bottom.
Important
Even though the heading for this option is CTI Web Services, the
option applies also to the Plus Application.
4 If appropriate, ensure that your agents enable Show Call Attached Variables in
their adapter.
In their adapter, this feature is located in Settings > General tab; the data
associated with the variable is displayed in the call information section of the
softphone.
This section describes how to configure your agents’ browser. If you want to allow your
agents to prepare their browser, forward to them the instructions for the appropriate
browsers.
Note
Five9 provides browser extensions (Edge, Chrome, FireFox) for Canadian Data
Center usage.
You can use the adapter with Microsoft® Edge®, Mozilla Firefox®, and Google™
Chrome™.
For detailed information about the supported browsers, see the Technical
Requirements Reference Guide.
The Five9 softphone can be installed for all users or for the current user:
l All users: You may prepare the browsers and install the softphone remotely by
using Windows Group Policy or Open Directory for macOS.
l Current user: When agents log into the softphone for the first time, they may
download it and any additional software required for your integration.
Note
For agents using Chromebook or Chromebox, do not install the softphone, and
ensure that they select WebRTC when connecting.
Important
Be sure that your firewall and other security software do not block the
installation of the Five9 softphone.
b Click Next.
Chrome
You need to add exceptions to the browser and install and configure the adapter.
Important
In addition to adding exceptions to the browser, remember to also update your
corresponding Group Policies with the same information. Otherwise, the
current Group Policies will overwrite your browser settings.
If you use Mac OS and Chrome 53, connectors do not open. Be sure to update
the browser.
Adding Exceptions
Installing the Extension
Troubleshooting the Softphone
Adding Exceptions
Add exceptions so that notifications can appear in the adapter.
2 Select Settings.
5 In the Cookies section, ensure that Allow local data to be set is selected.
Note
If your agents have permission to access multiple domains, you need to install
one extension for each domain.
For more details, see Installing the Softphone in the Basic Administrator’s
Guide.
1 To install the extension from the Chrome Web Store, click Five9 Softphone
Extension.
3 Click Add.
After the extension is installed, the button changes from blue to green.
Edge
You need to add exceptions to the browser and install and configure the adapter.
Adding Exceptions
Adding Exceptions
You must configure the browser to allow pop-up notifications from Five9.
2 Click the menu button in the upper-right corner, then click Settings.
4 Scroll down to the Site permissions section, then scroll to All permissions and
click Pop-ups and redirects.
6 Enter the domains you want to allow pop-ups from and click Add:
Firefox
Add exceptions to the browser and install and activate the adapter.
Note
When upgrades to extensions are necessary, agents’ experience differs
according to the browser.
Chrome, Edge, and Firefox: When agents log on, if the system detects that the
required version of the extension is not present, they are prompted to install
the required version. With Chrome and Edge, they are also prompted to
remove the old version.
For more details, see Installing the Softphone in the Basic Administrator’s
Guide.
Adding Exceptions
Enabling the Five9 Softphone Plug-In
Adding Exceptions
Important
In addition to adding exceptions to the browser, remember to also update your
corresponding Group Policies with the same information. Otherwise, the
current Group Policies will overwrite your browser settings.
Add exceptions in the browser settings so that notifications from Five9 can appear in
the adapter, and install and activate the adapter for .
1 Click Tools or the menu button in the top right corner, and select Options.
Depending on the version of your browser, the Options menu opens either in a
Windows menu or in a browser tab. However the features are the same.
6 Depending on your browser version, close the tab or click OK to close the
settings window.
2 Click Plugins.
3 Locate Five9 Softphone Plugin, and select Always Activate if it is not already
selected.
Windows OS
Follow these steps:
1 Click Start > Control Panel > Programs and Features.
2 In the list of programs, select Five9 Softphone Service and click Uninstall.
Mac OS
To remove the softphone, use this script, which is located inside the installation image:
1 Install the softphone either from the customer portal or from the link displayed
in the Plus application if an update is required when you log in.
Chrome
1 Click the Chrome menu in the top-right corner of the browser.
3 Select the amount of data that you want to delete, such as the beginning of
time to delete everything.
4 Check the boxes for the types of information that you want to remove.
Firefox
1 Click Tools > Options > Advanced > Network.
3 Depending on your browser version, close the tab or click OK to close the
settings window.
Edge
1 Click the menu button (three dots) in the upper-right corner, then click Settings.
3 Scroll down to Clear browsing data section, then click Choose what to clear.
4 In the Clear browsing data pop-up, select the time range and the types of data
you want to remove, then click Clear now.
This section describes how to collect logs from the workstation of agents who use the
Five9 Plus applications:
Logs are always displayed in UTC.
Application Log
Browser Logs
Softphone Log
Application Log
All actions performed by agents are saved in logs that can be used to troubleshoot
problems with their station. You or Five9 Customer Support may request application
logs to troubleshoot issues. By default, all agents can collect logs that apply to voice
and text interactions and send a basic report. These logs contain the events that occur
during the agent’s current session because logs are not saved when the agent closes
the browser.
The log window gathers all available information. The process takes 30–60 seconds.
During that time, if you click Stop Logging or close the window, the content that has
been logged so far is not saved, but the rest of the session information is retained
unless the session has timed out. The log is complete when no more information is
added.
Browser Logs
2 To save the content that you need to send to Customer Support, click Download.
The file name is similar to this one: Five9 - CRM adapter - Mon, Apr 6,
2015 4_14 PM.txt. The file is saved in your default download folder.
You may redirect the softphone logs to a custom directory. To do so, set the F9_
SOFTPHONE_LOG_DIR environment variable in the agent’s workstation. For example, you
may redirect the logs to a NAS share mounted in the agent’s workstation.
For more information about logs, see Reporting Problems in the Plus Adapter for
ServiceNow Agent’s Guide.
Browser Logs
Chrome and Edge
Firefox
3 In the browser console, select the Network tab, WebSockets, WS, and Frames.
Softphone Log
5 Click the filter, and select the items that you want, such as errors and warnings.
Firefox
Follow these steps to locate the console logs.
1 Open the console: Ctrl+Shift+J.
Softphone Log
You or Five9 Customer Support may request these files, which contain information
about the adapter. Softphone logs are saved in the agent’s computer for four days
before being deleted. Log files are located in these folders:
Softphone Log
l Windows: %appdata%\Five9\Logs\websoftphone
l MAC: ~/Library/Application Support/Five9/Logs/websoftphone
This section discusses setting up and optimizing the Five9 ServiceNow agent
workspace. ServiceNow customers are encouraged to use the Agent Workspace
interaction management feature to get the best customer engagement. With
the interaction management feature configured, agents see all details related to an
issue in one place. Agents can communicate in real time with customers by agent chat
or phone in the same interface. They can also close cases and incidents faster with
artificial intelligence-assisted recommendations.
Note
When the user interface behavior is the same as in Classic Five9, refer to the
appropriate section in this guide.
To configure the predefined state, go to IMS Settings > Interaction State for
Disposition and select the state.
Note
If an agent selects a state other than the predefined state, ServiceNow
may not support transitioning to that state.
To configure the predefined variables, go to IMS Settings > Default Record Parameters
and add the field variables.
To configure the cursor focus, go to Search and Screenpop > What to do if single
match and select Screen pop and keep focus on details tab.
3 If you are using the Five9 presence sync feature, select the Presence tab and
then select the Enable for all workspaces checkbox.