ServiceNow v2 (Beta) connection
Introduction
A ServiceNow v2 (Beta) connection, created using the ServiceNow v2 (Beta) connector, establishes access to ServiceNow. Once a connection is configured, you can create instances of ServiceNow v2 (Beta) activities associated with that connection to be used either as sources (to provide data in an operation) or as targets (to consume data in an operation).
Note
For beta access and to provide feedback, contact the Jitterbit Product Team.
Important
Before configuring a ServiceNow v2 (Beta) connection, review the ServiceNow v2 (Beta) prerequisites to ensure that the ServiceNow instance has been configured correctly and that you have the necessary credentials for your required authentication type.
This connector also supports the Enable Re-authentication on Change organization policy. If enabled, a change to the Username, Client ID, or ServiceNow instance in this connection requires users to re-enter the Password and Client Secret for the connection.
Create or edit a ServiceNow v2 (Beta) connection
A new ServiceNow v2 (Beta) connection is created using the ServiceNow v2 (Beta) connector from one of these locations:
- The design component palette's Project endpoints and connectors tab (see Design component palette).
- The Global Endpoints page (see Create a global endpoint in Global Endpoints).
An existing ServiceNow v2 (Beta) connection can be edited from these locations:
- The design component palette's Project endpoints and connectors tab (see Design Component Palette).
- The project pane's Components tab (see Component actions menu in Project pane Components tab).
- The Global Endpoints page (see Edit a global endpoint in Global Endpoints).
Configure a ServiceNow v2 (Beta) connection
Each user interface element of the ServiceNow v2 (Beta) connection configuration screen is described below.
Tip
Fields with a variable icon support using global variables, project variables, and Jitterbit variables. Begin either by typing an open square bracket [ into the field or by clicking the variable icon to display a list of the existing variables to choose from.
-
Connection Name: Enter a name to use to identify the connection. The name must be unique for each ServiceNow v2 (Beta) connection and must not contain forward slashes
/or colons:. This name is also used to identify the ServiceNow v2 (Beta) endpoint, which refers to both a specific connection and its activities. -
API version: Select the ServiceNow API version, one of Latest (default), V1, or V2. Latest always routes to the latest API version supported by ServiceNow. Selecting a specific version forces the use of the selected API endpoint version, removing version ambiguity. For example, if V1 is selected, API calls will explicitly reference
/api/now/v1/. -
ServiceNow instance: Enter the ServiceNow instance name. The instance name is used as the subdomain of your instance URL (
instance_name.service-now.com) and is also found in theinstance_namesystem property. For example,dev123is the instance name indev123.service-now.com. -
Authentication: Select the authentication type to use for the ServiceNow instance authenticating user configured in the ServiceNow v2 (Beta) prerequisites, either Basic Auth or OAuth2.0. Selecting OAuth2.0 enables Client ID and Client secret configuration.
-
Basic Auth requires these fields:
-
Username: Enter the username associated with the authenticating user.
-
Password: Enter the password associated with the authenticating user.
-
-
OAuth2.0 requires these fields:
-
Username: Enter the username associated with the authenticating user.
-
Password: Enter the password associated with the authenticating user.
-
Client ID (OAuth2.0): Enter the client ID associated with the authenticating user.
-
Client secret (OAuth2.0): Enter the client secret associated with the authenticating user.
-
-
-
Optional settings: Click to expand additional optional settings:
- Use Proxy Settings (Private Agent Only): When using a private agent, this setting can be selected to use private agent proxy settings.
-
Test: Click to verify the connection using the specified configuration. When the connection is tested, the latest version of the connector is downloaded by the agent(s) in the agent group associated with the current environment. This connector supports suspending the download of the latest connector version by using the Disable Auto Connector Update organization policy.
-
Save Changes: Click to save and close the connection configuration.
-
Discard Changes: After making changes to a new or existing configuration, click to close the configuration without saving. A message asks you to confirm that you want to discard changes.
-
Delete: After opening an existing connection configuration, click to permanently delete the connection from the project and close the configuration (see Component dependencies, deletion, and removal). A message asks you to confirm that you want to delete the connection.
Next steps
After a ServiceNow v2 (Beta) connection has been created, you place an activity type on the design canvas to create activity instances to be used either as sources (to provide data in an operation) or as targets (to consume data in an operation).
Menu actions for a connection and its activity types are accessible from the project pane and design component palette. For details, see Actions menus in Connector Basics.
These activity types are available:
-
Query: Retrieves records from ServiceNow and is intended to be used as a source in an operation.
-
Create: Creates new records in ServiceNow and is intended to be used as a target in an operation.
-
Update: Updates existing records in ServiceNow and is intended to be used as a target in an operation.
-
Delete: Deletes existing records from ServiceNow and is intended to be used as a target in an operation.