ServiceNow Connection

See the Connector Marketplace topic. Please request your administrator to start a trial or subscribe to the Premium ServiceNow connector.

ServiceNow is a cloud platform that provides IT service management (ITSM) and business process automation for improved workflow and service delivery.

This topic describes how to authenticate to ServiceNow and configure any necessary connection properties in the ServiceNow connection connector.

Connection Configuration

Each connection property available in the ServiceNow connector is explained below.

Connection Name

The name of the connection to be created should be provided. This is the name that will display on the list of available connections.

URL

Set the base URL of your ServiceNow instance site. For example: https://dev47813.service-now.com/.

Auth Scheme

The authorization scheme to be used when server authorization is to be performed.

  • Basic: Set this to use BASIC authentication.

  • OAuth: Set this to perform OAuth authentication.

  • OAuthPassword: Set this to perform OAuth authentication with GrantType Password.

User

The ServiceNow user account used to authenticate.

Password

The password used to authenticate the user.

Client ID

The client Id assigned when you register your application with an OAuth authorization server.

Client Secret

The client secret assigned when you register your application with an OAuth authorization server.

Refresh Token

The OAuth refresh token for the corresponding OAuth access token.

Initiate OAuth

Set this property to initiate the process to obtain or refresh the OAuth access token when you connect.

The following options are available:

  • REFRESH: Indicates that the driver will only handle refreshing the OAuthAccessToken. The user will never be prompted by the driver to authenticate via the browser. The user must handle obtaining the OAuthAccessToken and OAuthRefreshToken initially.

  • OFF: Indicates that the OAuth flow will be handled entirely by the user. An OAuthAccessToken will be required to authenticate.

OAuth Grant Type

The grant type for the OAuth flow.

The following options are available:

  • CODE

  • PASSWORD

Enable SSL

Option for creating the connection with SSL enabled.

Upload Keystore File

Option to upload keystore file.

Advanced Configurations

This section contains advanced configuration parameters.

Get Columns Metadata

Indicates the user preference as to when and how the provider should get the columns metadata.

Available settings are the following:

  • OnStart: The connector will execute the metadata calls to discover and cache all columns for every table, prior to executing the first statement.

  • OnUse: The connector will execute the table specific metadata calls the first time the table is referenced, provided the metadata for the table is not already cached.

Enforce Column Values

Controls whether available values for an element are retrieved and checked when executing INSERT or UPDATE statements.

If the value is not a valid choice, an error will be thrown. Elements (columns) in ServiceNow could be limited to a set of valid values (choices in a list). For example, a ‘Type of Issue’ element could only have valid values like ‘Bug’,‘Enhancement’ or ‘Documentation’.

If creating a record with an invalid value, ServiceNow will discard the value and assign a default value for the record. Setting this property to ’true’ will retrieve the available choices beforehand, and check if any inserted values are part of the list of valid values when possible. Note that display values are case-senstitive. This property honours the DisplayValue connection property.

Based on this value, the additional information provided for reference fields will be suppressed or not.

Include System Tables

Controls whether to expose the system tables or not. Usually only admin-role users have access to these tables. Setting this property to false will make them to not be listed on metadata calls.

Add Configuration: Additional properties can be added using this option as key-value pairs.

After entering all the details, click on the TEST button.

If the connection service identification and authentication details are provided correctly, a success message stating “connection available” is generated.

Click on the CREATE button to save the changes.

If the details are incorrect or the server is down, you will get a message “Connection unavailable”.

If you have any feedback on Gathr documentation, please email us!

← SendGrid ETL Target
ServiceNow Ingestion Source →