Skip to main content

Programmers reference for Jira Reader

This section provides a reference for the specific objects that the Jira Reader supports and a guide to the Jira Reader's properties.

In TQL, specify Global.JiraReader as the source type and configure its properties as needed.

Jira Reader properties

Property

Type

Default value

Notes

Authentication mode

Select list

  • OAuth

  • API token

Used to connect to a Jira account.

Client ID

String

Client ID of an app created in the Atlassian developer console. Used with OAuth.

Client secret

Password

Client secret for the app specified by Client ID. Used with OAuth.

Refresh token

Password

Refresh token that generates new access tokens. Used with OAuth.

Username

String

User name for the Atlassian account. Used with API token.

API token

Password

API token for the Atlassian account. Used with API token mode.

Endpoint URL

String

Base URL to access Jira Cloud, for example https://your-domain.atlassian.net/.

Tables

String

Semicolon-delimited (;) list of objects to read from Jira. Supports the % wildcard. Do not modify when recovery is enabled.

Excluded tables

String

List of tables to exclude. Useful when Tables uses wildcards.

Mode

Select list

  • Automated mode

  • Initial load

  • Incremental load

Controls adapter behavior. Automated mode performs initial load then incremental polling.

Incremental load marker

String

ID

Unique incremental column used for incremental load. Prefer a timestamp-based marker when available. In some tables, the effective “ID” may not monotonically increase, which can lead to data loss if used.

Start position

String

%=-1

Initial offset for incremental reads. The % wildcard matches all tables.

Polling interval

String

5m

Interval as an integer plus unit (s, m, h, d).

Migrate schema

Boolean

False

Available in Initial Load and Automated mode. Creates initial target schema.

Thread pool count

Integer

10

Parallel threads. Increase with care and align with connection capacity.

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.

Connection pool size

Integer

20

Maximum simultaneous active connections.

Supported objects

The Jira Reader supports the following tables.

  • AdvancedSettings

  • ApplicationRoles

  • Attachments

  • Audit

  • BoardConfiguration

  • BoardIssues

  • Boards

  • BoardSprints

  • Comments

  • Configuration

  • CustomFieldContext

  • Dashboards

  • Epics

  • FavouriteFilters

  • Fields

  • Filters

  • Groups

  • IssueAffectedVersions

  • IssueChangelogs

  • IssueComponents

  • IssueCustomFieldOptions

  • IssueCustomFields

  • IssueFixVersions

  • IssueLinks

  • IssueLinkTypes

  • IssueNavigatorDefaultColumns

  • IssuePriorities

  • IssueResolutions

  • Issues

  • IssueSubtasks

  • IssueTransitions

  • IssueTypes

  • Permissions

  • ProjectCategories

  • ProjectComponents

  • ProjectRoleActors

  • ProjectRoles

  • Projects

  • ProjectsIssueTypes

  • ProjectTypes

  • ProjectVersions

  • RoleActors

  • Roles

  • SecurityLevels

  • SecuritySchemes

  • SprintIssues

  • Sprints

  • Statuses

  • TimeTrackingProviders

  • Users

  • Votes

  • Watchers

  • Workflows

  • WorkflowStatusCategories

  • WorkflowStatuses

  • WorklogDeleted

  • Worklogs

The Sprints table requires the read:sprint:jira-software scope. The RoleActors and Roles tables require either the manage:jira-configuration scope or this set of scopes: read:user:jira, read:group:jira, read:project-role:jira, read:project:jira, read:avatar:jira, read:project-category:jira. All other tables typically require the read:jira-user and read:jira-work scopes.