Page Comparison

Before You Start

To use the ServiceChannel-ServiceNow integration, your company needs to have Service Automation and an instance of ServiceNow where you can install the ServiceChannel Facilities Management app. This app serves as a connector between the ServiceChannel and ServiceNow platforms and can be downloaded from the ServiceNow store.

A ServiceNow administrator from your company with the ServiceNow HI access needs to request and configure the app for installation on the ServiceNow store. Once the app is linked to your instance, the ServiceChannel Facilities Management application is listed in the ServiceNow Application Manager. An administrator can install and upgrade the ServiceChannel Facilities Management app from the Application Manager.

The Application Manager in ServiceNow Image RemovedImage Added

Info

Anchor

	Roles
	Roles

For the ServiceChannel-ServiceNow integration, there are two roles available — user role and admin role.

Expand

title	Click here to find out more about the roles.

Role

Description

Available Sections

User role

[x_serch_scc.user]

ServiceNow users with the application user role. They can create work orders in ServiceNow and view ServiceChannel work orders, but only for locations associated with their connection.

Work Orders
Connection > My Connection

Admin role

[x_serch_scc.admin]

ServiceNow users with the application admin role who have full access to all functionality.

Work Orders
Connection
Data
Administration
Configuration
Support

Setting Up the Integration

There are several steps that you should take to connect the two platforms together:

Anchor
clientIDandsecret
clientIDandsecret
Obtain the Client ID and Client Secret

For the ServiceNow application to talk to Service Automation, you need to provide ServiceNow with a system identifier and password required for security and authentication. These are known as the client ID and client secret.

Panel

bgColor	#F9F9F9
titleColor	#0e3367
titleBGColor	#EAEAEA
borderStyle	none
title	⦿ How to Configure Get the Client ID and Client Secret

In Service Automation, navigate to Admin > Permissions > > API Integration.
Find the required client ID and client secret. If they are not present, click Add new client. Fill out all the required fields in the overlay to receive the client ID and client secret. Navigate to Learn more about registering an API application on the developer portal to find out how to register an API application..

Tip

A ServiceNow-ServiceChannel Connection is required for users to submit work orders in ServiceNow. To allow creating user Connections automatically via the single sign-on service (SSO), do the following:

In Service Automation, specify a Callback URI for your API client. The URI should look like this: https://{host}.service-now.com/api/x_serch_scc/sc_auth/token, where {host} is the host of the ServiceNow instance.
In ServiceNow, configure the below settings in Administration > System Properties:

Enable SSO Support for the current client by selecting Yes.
Enter the Cobrander ID (cid) for the current client. Contact ServiceChannel to get your Cobrander ID.

With this configuration in place, when a user first opens the page for creating a work order, a Connection for the ServiceChannel app is automatically created for them.

Anchor
systemproperties
systemproperties
Configure System Properties

Now it’s time to adjust system properties in ServiceNow.

Panel

bgColor	#F9F9F9
titleColor	#0e3367
titleBGColor	#EAEAEA
borderStyle	none
title	⦿ How to Configure System Properties

In ServiceNow, navigate to Administration > System Properties, and add specify the following:

Enter the Subscriber ID for the current client, which is the identifier of your company in ServiceChannel.
Add the obtained client ID and client secret to the Default Client ID and Default Client Secret fields. These client ID and client secret are used as default values when creating Connections.
In the System URL list, select the ServiceChannel environment you are connecting to: either one of the Sandbox environments or Production.

Configuring system properties in ServiceNow Image Added

Anchor
serviceaccount
serviceaccount
Set Up a Service Account

Once you have provided the client ID and client secretadjusted system properties, you need to add a service account.

A service account is a user account in Service Automation that is used to download all the data and pull work order updates into ServiceNow. It should be able to read all data in Service Automation. Your Your user within the ServiceChannel platform should have the following:

All permissions turned on
Access to all trades
Super Admin secondary role enabled
Be assigned a Dashboard

Learn more about configuring permissions and granting Dashboard access to a ServiceChannel user.

Creating a service account in ServiceNow

Image Removed

Panel

bgColor	#F9F9F9
titleColor	#0e3367
titleBGColor	#EAEAEA
borderStyle	none
title	⦿ How to Create a Service Account

Navigate to Connections Connection > Create New, and provide a user account along with the User name and Password of the ServiceChannel account.
Select the Service account checkbox, and click Connect.

Note
We recommended creating a user account in ServiceNow specifically for the service account. The service account user cannot create work orders in ServiceNow. This account is only used for importing data. It is impossible to have more than one service account.

select the Service account checkbox.
In the User list, select a ServiceNow user for whom you want to create a service account, and then enter their ServiceChannel user ID and password.
Click Connect.

Creating a service account Image Added

Once the user account is connected, you see a notice that the data sync is in progress. After a few seconds, the connection status changes to OK if everything has worked correctly. You may need to refresh the page.

Image Removed

Note
We recommend creating a user account in ServiceNow specifically for the service account. This account is used for importing data. It is impossible to have more than one service account.

Anchor
dataimport
dataimport
Import the Data

Once the system properties and service account are set up, and the service account is connected with the OK status, the data from Service Automation should be imported to ServiceNow.

The data load can take anywhere from several minutes up to a few hours and is best handled by a ServiceNow administrator or with the assistance of a ServiceChannel implementation manager.

Panel

bgColor	#F9F9F9
titleColor	#0e3367
titleBGColor	#EAEAEA
borderStyle	none
title	⦿ How to Start the Import

Navigate to the service accountto Connection > Service Account, and click Import All Data under Related Links.Image Removed

Importing data from ServiceChannel Image Added

The order of imports is as follows:

Locations

A series of scheduled jobs is used to import the following data:

Statuses
Categories
Priorities
Trades

Areas

Problem types

Asset types

Problem codes

Issue choices

Panel

bgColor	#F9F9F9
titleColor	#0e3367
titleBGColor	#EAEAEA
borderStyle	none
title	⦿ How to Clean Up the Imported Data

Navigate to the Scheduled Jobs page, and click New.
Image Removed
Select the Automatically run a script of your choosing option to proceed.
Image Removed

On the page for creating a new job, insert the script provided below, choose to run the job Once, and fill out other required fields. When ready, click Submit.

Code Block

language	java
title	Script That Cleans Up the Imported Data
collapse	true

function deleteAll(table) {
  var ga = new GlideAggregate(table);
  if (!ga.isValid()) {
	gs.debug('Error: table ' + table + ' is not a valid table.');
	return;
  }
  ga.addAggregate('COUNT');
  ga.query();
  ga.next();
  gs.debug('Removing ' + ga.getAggregate('COUNT') + ' records from table ' + table);
 
  var gr = new GlideRecord(table);
  gr.deleteMultiple();
}

deleteAll('x_serch_scc_sc_work_order');
deleteAll('x_serch_scc_area');
deleteAll('x_serch_scc_asset');
deleteAll('x_serch_scc_asset_type');
deleteAll('x_serch_scc_category');
deleteAll('x_serch_scc_http_request');
deleteAll('x_serch_scc_issue_choice');
deleteAll('x_serch_scc_location');
deleteAll('x_serch_scc_note');
deleteAll('x_serch_scc_priority');
deleteAll('x_serch_scc_problem_code');
deleteAll('x_serch_scc_problem_type');
deleteAll('x_serch_scc_provider');
deleteAll('x_serch_scc_qualifier_result');
deleteAll('x_serch_scc_status');
deleteAll('x_serch_scc_trade');
deleteAll('x_serch_scc_user_location');
deleteAll('x_serch_scc_user_trade');

Creating a scheduled job that cleans up the imported data Image Removed

On the Scheduled Jobs page, find the job you created, and click it.
Image Removed
To run the script, click Execute Now on the scheduled job page.
Image Removed

All the data that was imported from Service Automation earlier is deleted. No records should be displayed in ServiceChannel > Data.

Once the ServiceChannel information

A series of scheduled jobs is used to import the data. An administrator can see these requests in the Administration > HTTP Requests module. When no more IssueChoicePoller TradePoller requests are being created, the import is complete.

Note
At this time, you can also see the WorkOrderPoller requests. These requests are importing existing work orders from Service Automation into ServiceNow. If required, click Fetch all work orders to ensure all work orders data is up to date in ServiceNow.

Tip

You may need to delete the data that was previously imported from Service Automation to ServiceNow.

Expand

title	Click the link to find out how to clean up the imported data.

is

cleared, you can start a new import. Be sure to

complete

the connection setup process to be able to create work orders in ServiceNow

.

Anchor
statustypeconfigure
statustypeconfigure
Configure the Status Types

Once the status records have been imported, you should choose which statuses are default, which act as canceled, and which ones should require feedback.

Panel

bgColor	#F9F9F9
titleColor	#0e3367
titleBGColor	#EAEAEA
borderStyle	none
title	⦿ How to Set Up the Status Types

As a system administrator or application administrator, navigate to Data > Status.
Edit the status records that have been created:

Choose the status that should be used when a new work order is created, for example, Open. Open the record, and change the Type to Default.
Choose the status that should be used when a work order has been canceled, for example, Completed/

Cancelled

Canceled. Open the record, and change its Type to Canceled.
Choose the status or statuses that should allow the feedback to be given, for example, Completed / Pending Confirmation. Open the record, and select the Show feedback checkbox.

Anchor

addusers

importusers

addusers

importusers

Add Users

Import Users

Now that the service account is configuredall configurations are in place, you can start setting up users. Refer to Creating an Integrated User for more information.importing users.

Connections required for users to create work orders in ServiceNow are automatically created upon import. A Connection is set up for users who have the same user ID or email in both ServiceChannel and ServiceNow. A user can view their Connection in Connection > My Connection.

Panel

bgColor	#F9F9F9
titleColor	#0e3367
titleBGColor	#EAEAEA
borderStyle	none
title	⦿ How to Import Users

Navigate to Configuration > Pollers, and click the SC - Import Users from SC poller.
On the poller page, click Execute Now.
Image Added
The import process can take some time. You can see UserPoller and LocationPoller requests in the Administration > HTTP Requests module. When no more requests are being created, the user import is complete.
(Recommended) To allow ServiceNow to automatically fetch new users from ServiceChannel and create relevant Connections, activate the user import poller to run at the specified frequency. To do this:
1. On the poller page, select the Active checkbox.
2. In the Run list, select how often the poller should run. The recommended frequency is Daily. It is best practice to have the poller run outside of business hours, such as at midnight — when employees are not actively using the application.
3. Specify the Time when the request should be executed, for example, at midnight.
4. Click Update to save the changes.

You can run the user import poller at any time to retrieve newly created users.

Anchor
importwos
importwos
Import Work Orders

The final step is importing work orders from ServiceChannel.

Panel

bgColor	#F9F9F9
titleColor	#0e3367
titleBGColor	#EAEAEA
borderStyle	none
title	⦿ How to Import Work Orders

Navigate to Configuration > Pollers, and click the SC - Import Work Orders poller.
On the poller page, click Execute Now.
Image AddedThe import process can take some time. You can see WorkOrderPoller and NotePoller requests in the Administration > HTTP Requests module. When no more requests are being created, the work order import is complete.
To allow ServiceNow to automatically fetch new work orders from ServiceChannel, activate the work order import poller. To do this:
1. On the poller page, select the Active checkbox.
2. In the Run list, select Periodically.
3. Set up the poller to run every 3 minutes by specifying the number of minutes next to Repeat Interval. 3 minutes is the recommended frequency, but you can change it to the value you need.
4. Click Update to save the changes.
  Image Added

Live Search

spaceKey	SCU
placeholder	Search our Knowledge Base
type	page
labels	fm

Panel

titleColor	#ffffff
titleBGColor	#5fa7d0
borderStyle	groove
title	In this Article

Table of Contents

maxLevel	3
minLevel	2
indent	20px

Panel

titleColor	white
titleBGColor	#75a346
title	Related Articles

Filter by label (Content by label)

showLabels	false
max	8
showSpace	false
sort	title
cql	label in ( "servicenow" , "servicenowworkorder" ) and space = currentSpace ( )

Versions Compared

Old Version 32

New Version 33

Key

Before You Start

Setting Up the Integration

Anchor
clientIDandsecret
clientIDandsecret
Obtain the Client ID and Client Secret

Anchor
systemproperties
systemproperties
Configure System Properties

Anchor
serviceaccount
serviceaccount
Set Up a Service Account

Anchor
dataimport
dataimport
Import the Data

Anchor
statustypeconfigure
statustypeconfigure
Configure the Status Types

Anchor

importusers

importusers

Import Users

Anchor
importwos
importwos
Import Work Orders

Page Comparison

Versions Compared

Old Version 32

New Version 33

Key

Before You Start

Setting Up the Integration

AnchorclientIDandsecretclientIDandsecretObtain the Client ID and Client Secret

AnchorsystempropertiessystempropertiesConfigure System Properties

AnchorserviceaccountserviceaccountSet Up a Service Account

AnchordataimportdataimportImport the Data

AnchorstatustypeconfigurestatustypeconfigureConfigure the Status Types

Anchor

importusers

importusers

Import Users

AnchorimportwosimportwosImport Work Orders

Anchor
clientIDandsecret
clientIDandsecret
Obtain the Client ID and Client Secret

Anchor
systemproperties
systemproperties
Configure System Properties

Anchor
serviceaccount
serviceaccount
Set Up a Service Account

Anchor
dataimport
dataimport
Import the Data

Anchor
statustypeconfigure
statustypeconfigure
Configure the Status Types

Anchor
importwos
importwos
Import Work Orders