Retrieve Information from ServiceNow (OAuth Authentication)

To retrieve information from Service Now using OAuth authentication, set up a fetch task using the following procedure. The connector runs fetch tasks automatically, based on the schedule that is configured in the configuration file.

NOTE: Before configuring a fetch task that uses OAuth authentication, you must create an application to represent the connector and configure OAuth authentication. Unless you have already completed these steps, for example when the connector was installed, see Create a ServiceNow Application and Configure OAuth Authentication.

To create a new Fetch Task

  1. Stop the connector.
  2. Open the configuration file in a text editor.
  3. In the [FetchTasks] section of the configuration file, specify the number of fetch tasks using the Number parameter. If you are configuring the first fetch task, type Number=1. If one or more fetch tasks have already been configured, increase the value of the Number parameter by one (1). Below the Number parameter, specify the names of the fetch tasks, starting from zero (0). For example:

    [FetchTasks]
    Number=1
    0=MyTask
  4. Below the [FetchTasks] section, create a new TaskName section. The name of the section must match the name of the new fetch task. For example:

    [FetchTasks]
    Number=1
    0=MyTask
    
    [MyTask]
  1. In the new section, ensure that you have set the parameters required to authenticate with ServiceNow. The OAuth configuration tool (described in Configure OAuth Authentication) creates a file named oauth.cfg that contains these parameters, and you can include them in the connector's configuration file using the following syntax:

    [MyTask] < "oauth.cfg" [OAUTH]

    For more information about including parameters from another file, see Include an External Configuration File

  2. Set the following configuration parameters:

    UseOAuth A Boolean value that specifies whether to authenticate using OAuth. Set this parameter to TRUE.
    ServiceNowInstance The ServiceNow instance to retrieve information from. The instance name is usually the first part of the URL, for example my-instance for my-instance.servicenow.com.
    TableNames A comma-separated list of tables to retrieve information from. You can find table names in the administration interface for your ServiceNow instance.
    ProxyHost (Optional) If you have installed the connector behind a proxy server, specify the host name or IP address of the proxy server to use to access ServiceNow.
    ProxyPort (Optional) The port of the proxy server to use to access ServiceNow.
    SSLMethod (Optional) The SSL version to use when communicating with ServiceNow.

    For example:

    [MyTask] < "oauth.cfg" [OAUTH]
    UseOAuth=TRUE
    ServiceNowInstance=my-instance
    TableNames=KB_KNOWLEDGE_BASE
    ProxyHost=proxy.domain.com
    ProxyPort=8080
    SSLMethod=NEGOTIATE
    

    For more information about the configuration parameters that you can use to configure the connector, refer to the ServiceNow Connector Reference.

  3. Save and close the configuration file.