Jira Reader programmer's reference

API Token

Password

An API token that enables access to the Atlassian platform. Only used with the API token authentication mode.

Authentication mode

Select list

Used to connect to a Jira account.

Client ID

String

Client ID of an app created in the Atlassian developer console. Only used with the OAuth authentication mode.

Client secret

Password

The client secret for the app specified by the Client ID. Only used with the OAuth authentication mode.

Connection pool size

Integer

20

Specifies the number of connections in use.

Endpoint URL

String

The endpoint URL used to access the Atlassian platform

Excluded tables

String

A list of tables excluded from read operations. Typically used to create a list of exceptions when the Tables property includes wildcards. Misconfiguration of the Tables and Exclude Tables properties can cause "Invalid table names" errors.

Incremental load marker

String

"ID"

The incremental load marker is a unique incremental column in each object used for incremental load.

In some tables, the equivalent to the ID field may not have an increasing ID field, which can lead to data loss if used.

Migrate schema

Boolean

False

Only available in Initial Load mode. Set to True to enable initial schema migration, which propagates the object schema from the source to the target.

Mode

Select list

Controls the basic behavior of the adapter. Use the default value of InitialLoad to read all existing data, then stop. Set the value to IncrementalLoad to read all new data continuously.

Set the value to Automated mode to perform both initial load and incremental load.

Polling interval

String

5m

Specifies an interval as an integer followed by a unit. Supported units are days (d), hours (h), minutes (m), or seconds (s). The Paymo reader polls the Paymo instance at the specified interval.

Refresh Token

Password

A refresh token that generates new refresh tokens and access tokens. Only used with the OAuth authentication mode.

Start position

String

%=-1

Value of the incremental load marker that defines the initial reading position.

Tables

String

A semicolon-delimited (;) list of objects to read from the Jira instance. Supports the % wildcard. Misconfiguration of the Tables and Exclude Tables properties can cause "Invalid table names" errors. Do not modify this property when recovery is enabled for the application.

Thread pool count

Integer

10

This property is standard for all application adapters. Users can configure the thread pool count to optimize the performance of the reader for handling multiple objects.

Username

String

The user name of an account with access to the Atlassian platform. Only used with the API token authentication mode.