Setup a ServiceNow REST Connection Manager

The REST Connection Manager is an SSIS connection manager component that can be used to establish connections with ServiceNow REST service to help facilitate ServiceNow data integration.

See ServiceNow REST Source Component for how to retrieve data from ServiceNow & ServiceNow REST Destination Component for how to write to ServiceNow.

To add a new connection, right-click the Connection Manager area in your Visual Studio project, and choose "New Connection..." from the context menu. You will be prompted the "Add SSIS Connection Manager" window. Select the "REST (KingswaySoft)" item to add a new REST Connection Manager.

New SSIS Connection

Add SSIS REST Connection Manager

The REST Connection Manager contains 2 pages of configuration.

  • General
  • Advanced

General page

The General page allows you to specify connection properties and login credentials for ServiceNow REST service:

SSIS REST ServiceNow Connection Manager

Service Name

The REST service that will be connected to.

Instance Name

The name of the ServiceNow instance to connect to.

API Throttle Rate

The API Throttle Rate will limit the number of requests that can be sent per hour. Set this value to 0 to disable API Throttling

Authentication Mode

The Authentication Mode option allows you to specify how to authenticate with the ServiceNow server. Available options are:

  • Basic
  • OAuth
Username

The Username of the account you wish to use to connect to your ServiceNow instance. This field is only available when the Authentication Mode is set to Basic.

Password

The Password of the account you wish to use to connect to your ServiceNow instance. This field is only available when the Authentication Mode is set to Basic.

Generate Token File (In App)...

The Generate Token File (In App)... button completes the entire OAuth authentication process inside of the toolkit. After you click this button you will be prompted with a dialog asking for a Client Id, Client Secret, and Redirect URI. You will need to create your own app in your ServiceNow instance to get these values. Once you've completed this, click OK and you will be presented with a ServiceNow login screen. Just login and authorize the app you created to generate your token. This button is only available when the Authentication Mode is set to OAuth.

Generate Token File (In Browser)...

The Generate Token File (In Browser)... button completes the OAuth authentication using your default browser. After you click this button you will be prompted with a dialog asking for a Client Id, Client Secret, and Redirect URI. You will need to create your own app in your ServiceNow instance to get these values. Once you've completed this, click OK and a new dialog will appear. Simply follow the steps in the dialog to generate your token. This button is only available when the Authentication Mode is set to OAuth.

Path To Token File

The path to the token file on the file system.

Token File Password

The password to the token file.

Test Connection

After all the connection information has been provided, you may click the "Test Connection" button to test if the user credentials entered can connect to the selected REST service.

Advanced page

REST Connection Manager - Advanced

Proxy Mode

The Proxy Mode option allows you to specify how you want to configure the proxy server setting. There are three options available.

  • No Proxy
  • Auto-detect (Using system configured proxy)
  • Manual
Proxy Server

Using Proxy Server option allows you to specify the name of the proxy server for the connection.

Port

The Port option allows you to specify the port number of the proxy server for the connection.

Username (Proxy Server Authentication)

Username option (under Proxy Server Authentication) allows you to specify the proxy user account.

Password (Proxy Server Authentication)

Password option (under Proxy Server Authentication) allows you to specify the proxy user's password.

Note: The Proxy Password is not included in the connection manager's ConnectionString property by default. This is by design for security reasons. However, you can include it in your ConnectionString if you want to parameterize your connection manager. The format would be ProxyPassword=myProxyPassword; (make sure you have a semicolon as the last character). It can be anywhere in the ConnectionString.

Timeout

The number of seconds requests should wait before timing out.

Retry on Intermittent Errors

The retry on intermittent errors option determines if requests will be retried when there is an error. If this option is checked requests will be retried up to 3 times.