Jira
Table of Contents
The tap-jira
Meltano extractor pulls data from Jira that can then be sent to a destination using a loader.
Getting Started #
Prerequisites #
If you haven't already, follow the initial steps of the Getting Started guide:
Installation and configuration #
-
Add the
tap-jira
extractor to your project usingmeltano add
:meltano add extractor tap-jira
-
Configure the settings below using
meltano config
.
Next steps #
Follow the remaining steps of the Getting Started guide:
- Select entities and attributes to extract
- Add a loader to send data to a destination
- Run a data integration (EL) pipeline
Capabilities #
Settings #
tap-jira
requires the
configuration
of one of the following groups of settings:
-
username
password
base_url
start_date
user_agent
-
oauth_client_secret
oauth_client_id
access_token
cloud_id
refresh_token
start_date
user_agent
The settings for extractor tap-jira
that are known to Meltano are documented below.
To quickly find the
setting you're looking for, use the Table of Contents at
the top of the page.
Username (username
)
#
-
Environment variable:
TAP_JIRA_USERNAME
Your Jira username.
How to use #
Manage this setting using
meltano config
or an
environment variable:
meltano config tap-jira set username <username>
export TAP_JIRA_USERNAME=<username>
Password (password
)
#
-
Environment variable:
TAP_JIRA_PASSWORD
Your Jira password.
How to use #
Manage this setting using
meltano config
or an
environment variable:
meltano config tap-jira set password <password>
export TAP_JIRA_PASSWORD=<password>
Base URL (base_url
)
#
-
Environment variable:
TAP_JIRA_BASE_URL
The base URL for your Jira instance.
How to use #
Manage this setting using
meltano config
or an
environment variable:
meltano config tap-jira set base_url <base_url>
export TAP_JIRA_BASE_URL=<base_url>
OAuth Client Secret (oauth_client_secret
)
#
-
Environment variable:
TAP_JIRA_OAUTH_CLIENT_SECRET
The client secret value used for OAuth authentication.
How to use #
Manage this setting using
meltano config
or an
environment variable:
meltano config tap-jira set oauth_client_secret <oauth_client_secret>
export TAP_JIRA_OAUTH_CLIENT_SECRET=<oauth_client_secret>
OAuth Client ID (oauth_client_id
)
#
-
Environment variable:
TAP_JIRA_OAUTH_CLIENT_ID
The client ID used for OAuth authentication.
How to use #
Manage this setting using
meltano config
or an
environment variable:
meltano config tap-jira set oauth_client_id <oauth_client_id>
export TAP_JIRA_OAUTH_CLIENT_ID=<oauth_client_id>
Access Token (access_token
)
#
-
Environment variable:
TAP_JIRA_ACCESS_TOKEN
The access token generated for your account.
How to use #
Manage this setting using
meltano config
or an
environment variable:
meltano config tap-jira set access_token <access_token>
export TAP_JIRA_ACCESS_TOKEN=<access_token>
Cloud ID (cloud_id
)
#
-
Environment variable:
TAP_JIRA_CLOUD_ID
The cloud ID of your JIRA instance.
How to use #
Manage this setting using
meltano config
or an
environment variable:
meltano config tap-jira set cloud_id <cloud_id>
export TAP_JIRA_CLOUD_ID=<cloud_id>
Refresh Token (refresh_token
)
#
-
Environment variable:
TAP_JIRA_REFRESH_TOKEN
The refresh token generated for your account.
How to use #
Manage this setting using
meltano config
or an
environment variable:
meltano config tap-jira set refresh_token <refresh_token>
export TAP_JIRA_REFRESH_TOKEN=<refresh_token>
Start Date (start_date
)
#
-
Environment variable:
TAP_JIRA_START_DATE
Specifies the date at which the tap will begin pulling data. This works only for the streams taht suppport it.
How to use #
Manage this setting using
meltano config
or an
environment variable:
meltano config tap-jira set start_date YYYY-MM-DDTHH:MM:SSZ
export TAP_JIRA_START_DATE=YYYY-MM-DDTHH:MM:SSZ
User Agent (user_agent
)
#
-
Environment variable:
TAP_JIRA_USER_AGENT
- Default:
tap-jira via Meltano
The user agent.
How to use #
Manage this setting using
meltano config
or an
environment variable:
meltano config tap-jira set user_agent <user_agent>
export TAP_JIRA_USER_AGENT=<user_agent>
Looking for help? #
If you're having trouble getting the
tap-jira
extractor to work, look for an
existing issue in its repository, file a new issue,
or
join the Meltano Slack community
and ask for help in the #plugins-general
channel.
Found an issue on this page? #
This page is generated from a YAML file that you can contribute changes to. Edit it on GitHub!