ServiceNow

This topic discusses ingesting the tickets and associated objects from ServiceNow. Aisera’s ServiceNow integration uses the ServiceNow REST API to automatically pull the following records from a ServiceNow database:

  • Incidents

  • Requests

  • Assignment Groups

  • Users

  • Service Catalog

  • Approvals

Schedule Types

The Aisera ServiceNow integration supports multiple record-pulling schedule types.

  • On Demand

    You can specify a time window to pull records from ServiceNow. This schedule type is typically used to pull historical records. It is common to pull historical data ranging from 100,000 to 1,000,000 records.

  • Frequency Based You can specify a frequency to pull data ranging from 5 mins up to 24hr. The Aisera Gen AI platform pulls data based on the interval specified in integration parameters.

Prerequisites

To pull tickets and related objects from ServiceNow, the Service Account User needs read-only permissions to the following tables:

  • Incident (incidents)

  • Request (sc_requests)

  • Request Items (sc_req_item)

  • Close_notes (Task)

  • sys_user (Users, when crawling any type of ticket)

  • sys_user_group (Assignment Groups)

  • sys_journal_field

  • cmdb_ci (Related CMDB/CI info)

  • cmn_location (Location information)

  • sysapproval_approver (Approval list)

  • sc_item_option

  • sc_item_option_mtom

Note: To create/update incidents and/or approvals, the ServiceNow service account needs write permission for the Incident, Request, sys_journal_field, and sysapproval_approver tables. To crawl the service catalog, the service account needs Service Catalog ITIL and Catalog_Admin roles.

Create a ServiceNow Integration

  1. Click on Settings > Integrations > New Integration

  2. Search for ServiceNow as shown below and click Next.

Choose the ServiceNow Integration
  1. Enter the Configuration details:

Add Configuration Details
Field
Description

Name

Enter the name you want to give to the integration

Endpoint

Enter the ServiceNow URL that you want to connect to

Live API Agent

Select the version of the ServiceNow API

Public

Determines whether the integration can be used outside the firewall

Description

Mention the details for the integration you want to configure

  1. Click Next.

  2. Choose an Authentication Type.

Aisera’s ServiceNow connector can be configured to connect to the ServiceNow endpoint in one of two ways:

Each of these methods is described below.

Basic Auth Integration

Reach out to your ServiceNow administrator to get the Username and password.

Basic Authentication Parameters

Endpoint

Enter ServiceNow URL to connect to

Username

Enter the ServiceNow UserName

Password

Enter the ServiceNow Password

OAuth

Enter values for the following fields.

OAuth Authentication Parameters

Where:

Endpoint

Enter ServiceNow URL to connect to

Authorization URL

Note the ServiceNow URL of the ServiceNow Instance

Client Id

Note the Client Id of the ServiceNow Instance

Client Secret

Note the Client Secret of the ServiceNow Instance

Access Token URL

Note the Access token URL of the ServiceNow Instance

OAuth2 To generate credentials to use the OAuth2 authorization flow, follow the steps below in your ServiceNow Instance.

  1. Login to your SNOW instance

  2. Go to Application registry

  3. Click the New button on the upper right and select Create an OAuth API Endpoint for external clients

  4. You must provide a name, and a redirect URL and adjust the access token, and refresh token lifespans as per your needs (values are in seconds). Also, the active flag must be checked.

  5. Ask the Aisera team for the redirect URL.

  6. Click submit and note down the Client ID and Client Secret.

  7. If the Client Secret is hidden, click the lock button on its right to reveal it.

Create a ServiceNow DataSource

  1. Click on Setting > Data Source > New Data Source.

  2. Search for ServiceNow and Select as shown below:

Designate the Data Source
  1. Enter the configuration details.

Data Source Functions

Where:

Field
Description

Name

Enter a name for the Data Source.

Type

Enter the Type such as Downstream or Upstream.

Integration

Select your Integration from the drop-down menu.

Functions

Select Tickets, Incidents, Problems, and other objects to be ingested.

Schedule

Select the schedule of the Data Source you want to run.

Public Domain

Enter the public domain URL. If a data source is marked with a public domain name, any KB articles ingested from the Data Source will come up as a hint to a related question in the bot.

Description

Enter the description that you want to give to the Data Source.

  1. Click Next.

  2. The last configuration parameters are optional. These options are to override the default ingestion process or formats. These options may be slightly different for your configuration, based on the Functions and Parameters you have added on the previous window.

  3. Enter Optional Configuration Details:

Where:

Field
Description

Incident Table

If the customer has Incidents stored in the custom table, mention that table name here.

Topic

This field is deprecated and will be soon removed from the UI.

Custom Headers

This field is used by generic connectors and can be ignored.

Custom Script

This field is used to transform the content while ingesting within the Aisera.

Additional Query Parameters

This is the field used to ingest additional attributes that are not part of the OOTB connector query.

Download Attachments

When checked, if the ingested documents have attachments, they will be ingested too.

Attachment URL (URI)

This field is deprecated and will be removed from UI. This can be ignored for now.

Join Tables

This is a versatile JSON configuration that allows us to associate additional tables with the content types we're ingesting. Depending on the specified relationships, we have the flexibility to join and incorporate data from any desired table into the table we are currently ingesting.

Bypass Test Connection

If checked, the connector will not perform the test connection. In case the entered credentials are wrong, you may not get good error messages. Hence, it is advised to have it unchecked.

Custom Query

The query entered here acts as a filter to the OOTB connector query. This is used when only the KB articles/tickets of certain departments are to be ingested.

Transformation Script

This option is generally used by Webhooks and can be ignored for now. We already have Custom Script above to do the transformation.

  1. Click Next and OK.

  2. Refresh the page and you will see the Data Source running.

View Ingested Tickets

  1. All the ingested tickets are available under the SOR > Tickets tab.

  1. Click on the Tickets tab to view the ingested Tickets.

Last updated