Skip to main content

Programmers reference for ServiceNow Reader

In TQL, specify Global.ServiceNowReader when creating a source. Configure the reader using the properties below.

ServiceNow Reader properties

Property

Type

Default value

Notes

Connection and authentication

Authentication type

Enum

Supported: OAuth, Manual OAuth.

Connection URL

String

Base URL of the ServiceNow instance (for example, https://your-instance.service-now.com).

Client ID

Password (encrypted)

Client ID from the ServiceNow OAuth application. Ignored when using a connection profile.

Client secret

Password (encrypted)

Client secret from the ServiceNow OAuth application. Ignored when using a connection profile.

Access token

Password

Used with Manual OAuth.

Refresh token

Password

Used with Manual OAuth to obtain new access tokens.

Username

String

User ID of a ServiceNow account (supply if required by your OAuth flow or profile).

Password

Password

Password for the specified user (if required).

Use connection profile

Boolean

False

Set to True to reference a saved connection profile.

Connection profile name

String

Name of the ServiceNow connection profile to use when Use connection profile is True.

Connection retries

Integer

3

Maximum number of connection attempts before halting.

Connection timeout

Integer

60

Socket timeout in seconds (cannot exceed 300 seconds).

Data selection and mode

Tables

String

Semicolon-delimited list of tables or views to read. Supports % wildcard. Do not modify when recovery is enabled.

Excluded tables

String

Optional list of tables to exclude. Wildcards are not supported.

Mode

Select list

  • Automated

  • Initial load

  • Incremental load

Initial load

Controls whether to run a one-time historical sync, a continuous incremental sync, or both (Automated).

Start timestamp

String

Optional starting point for reads. Format: YYYY-MMM-DD HH:MM:SS (UTC). If not specified for incremental mode, the reader begins near the current time.

Polling interval

String

120s

How often to poll for new/updated data. Format: integer + d/h/m/s.

Performance and schema

Fetch size

Integer

10000

Maximum records per paginated API call for a table.

Max connections

Integer

20

Maximum connections in the HTTP client pool.

Thread pool count

Integer

10

Parallel reader threads. A practical guideline is roughly one thread per ~40 tables.

The ThreadPoolCount value must be less than the number of available processors. For example, if the system has eight processors, set ThreadPoolCount to 7 or lower.

Batch API

Boolean

True

When True, groups requests for different tables into a single batch API call (subject to ServiceNow’s size limits).

Migrate schema

Boolean

When enabled in initial load, propagates table schema to the target.

Datatype support

The ServiceNow Reader emits WAEvents. Field types are mapped from ServiceNow JSON responses to Striim types (for example, textual fields to String, numeric fields to Long/Double, boolean to boolean, and date/time fields to org.joda.time.DateTime). Complex objects may be represented as java.lang.Object.