Configuring ServiceNow Connector Sources

Use ServiceNow Connector to connect to ServiceNow REST-compliant services. ServiceNow Connector is a built-in connector and uses Aggregate and Table REST APIs for data retrieval.

Before you begin

  • Ensure that the web service that you want to connect is up and running.
  • You can retrieve data for Table and Aggregate ServiceNow REST APIs only.
  • Use REST API Explorer that is available in your ServiceNow instance to construct and test your API requests and get URI information for data definitions.

    For more information, see REST API Explorer

  • For the sample request, if you need to provide custom headers, then ensure that you have that information available with you. Custom headers are request headers that are needed to retrieve REST API information from a web service. For example, Authorization request headers or Accept-Charset request headers. Authorization request headers contain authorization information that is required by the REST services. Accept-Charset indicates the acceptable data characters that the response must contain.

Procedure

Complete the following steps to add ServiceNow REST-compliant services by using ServiceNow Connector:

  1. Open Dashboard Designer.
  2. In the navigation pane, go to Connector & Sources > Connector Sources.
  3. On the All Connector Sources page, click Add Source.

    An Add Connector Source window is displayed.

  4. From the Connector Type list, select ServiceNow Connector.
  5. In the Connector Source Name field, enter a name for the ServiceNow source.

    Source name can contain alphanumeric characters and underscores.

  6. In the Endpoint URL field, enter URL details for the ServiceNow web service in the following format:
    • http://server_IP_or_HOSTNAME:port
    • https://server_IP_or_HOSTNAME:port
    Where,
    • server_IP_or_HOSTNAME is the IP address or hostname of the server where the web service is hosted.
    • port is the default port of the web service.
  7. From the Authentication Type list, select None or Basic Authentication based on whether username and password are configured during the installation of the web service.
    If you select Basic Authentication, then you must complete the following steps:
    1. In the User Name field, enter a username that is used during the configuration of the REST-compliant service.
    2. In the Password field, enter a password that is used during the configuration of the REST-compliant service.
  8. Click Next.
  9. From the Method list, select GET method, and in the URI field, enter the uniform resource identified (URI) for ServiceNow Source.
    For example,
    • URI example for Table API:

      /api/now/{api_version}/table/{tableName}

    • URI example for Aggregate API:

      /api/now/{api_version}/stats/{tableName}

    Where:
    • {api_version} is the ServiceNow product version.
    • {tableName} is the table for which you are retrieving data.

    For more information about URL formats, see Aggregate APIs or Table APIs.

  10. Optional: Under Custom Headers, complete the following steps:
    • In the Name field, enter the request header name that is provided by the REST API web service provider.
    • In the Value field, enter the request header value that is provided by the REST API web service provider.

    To add more custom headers, click Add Another, and repeat the earlier steps.

  11. To make sure that the connection to ServiceNow Data Source is successful, click Test Connection.
    If the source details and the sample request are valid and complete, then a message indicating that the connection is successful is displayed. For connection failure messages, you must fix the errors that are mentioned in the messages and test the connection again.
    Note: Even if the source details are valid, a connection failure message might be displayed due to an invalid response received for the sample request.
  12. Click Save.

Results

The All Connector Sources page displays the following details for each connector source:
  • Connector source name
  • Connector type
  • Date and time when the connector source was first created, and the username of the user who first created the source.
  • Date and time when the connector source was last modified, and the username of the user who last modified the connector source. Only the latest record is displayed.
The ServiceNow Web Service is added and can be used to create your custom data definitions.