Jira

tap-jira (meltanolabs variant)🥈

Issue and Project Tracking Software

The tap-jira extractor pulls data from Jira that can then be sent to a destination using a loader.

Alternate Implementations

Getting Started

Prerequisites

If you haven't already, follow the initial steps of the Getting Started guide:

  1. Install Meltano
  2. Create your Meltano project

Installation and configuration

  1. Add the tap-jira extractor to your project using 
    meltano add
     : 
    2. meltano add tap-jira
  2. Configure the tap-jira settings using 
    meltano config
     : 
    3. meltano config tap-jira set --interactive
  3. Test that extractor settings are valid using 
    meltano config
     : 
    4. meltano config tap-jira test

Next steps

If you run into any issues, learn how to get help.

Capabilities

The current capabilities for tap-jira may have been automatically set when originally added to the Hub. Please review the capabilities when using this extractor. If you find they are out of date, please consider updating them by making a pull request to the YAML file that defines the capabilities for this extractor.

This plugin has the following capabilities:

  • about
  • activate-version
  • batch
  • catalog
  • discover
  • schema-flattening
  • state
  • stream-maps

You can override these capabilities or specify additional ones in your meltano.yml by adding the capabilities key.

Settings

The tap-jira settings that are known to Meltano are documented below. To quickly find the setting you're looking for, click on any setting name from the list:

You can also list these settings using 

meltano config
with the list subcommand: 

meltano config tap-jira list

You can override these settings or specify additional ones in your meltano.yml by adding the settings key.

Please consider adding any settings you have defined locally to this definition on MeltanoHub by making a pull request to the YAML file that defines the settings for this plugin.

API Token (api_token)

  • Environment variable: TAP_JIRA_API_TOKEN

Jira API Token.


Configure this setting directly using the following Meltano command:

meltano config tap-jira set api_token [value]

Domain (domain)

  • Environment variable: TAP_JIRA_DOMAIN

The Domain for your Jira account, e.g. meltano. Atlassian. Net


Configure this setting directly using the following Meltano command:

meltano config tap-jira set domain [value]

Email (email)

  • Environment variable: TAP_JIRA_EMAIL

The user email for your Jira account.


Configure this setting directly using the following Meltano command:

meltano config tap-jira set email [value]

End Date (end_date)

  • Environment variable: TAP_JIRA_END_DATE

Latest record date to sync


Configure this setting directly using the following Meltano command:

meltano config tap-jira set end_date [value]

Include Audit Logs (include_audit_logs)

  • Environment variable: TAP_JIRA_INCLUDE_AUDIT_LOGS
  • Default Value: false

Include the audit logs stream


Configure this setting directly using the following Meltano command:

meltano config tap-jira set include_audit_logs [value]

Page Size Issues (page_size.issues)

  • Environment variable: TAP_JIRA_PAGE_SIZE_ISSUES
  • Default Value: 100

Page size for issues stream


Configure this setting directly using the following Meltano command:

meltano config tap-jira set page_size issues [value]

Start Date (start_date)

  • Environment variable: TAP_JIRA_START_DATE

Earliest record date to sync


Configure this setting directly using the following Meltano command:

meltano config tap-jira set start_date [value]

JQL Query (stream_options.issues.jql)

  • Environment variable: TAP_JIRA_STREAM_OPTIONS_ISSUES_JQL

A JQL query to filter issues


Configure this setting directly using the following Meltano command:

meltano config tap-jira set stream_options issues.jql [value]
Expand To Show SDK Settings

Batch Compression Format (batch_config.encoding.compression)

  • Environment variable: TAP_JIRA_BATCH_CONFIG_ENCODING_COMPRESSION

Compression format to use for batch files.


Configure this setting directly using the following Meltano command:

meltano config tap-jira set batch_config encoding.compression [value]

Batch Encoding Format (batch_config.encoding.format)

  • Environment variable: TAP_JIRA_BATCH_CONFIG_ENCODING_FORMAT

Format to use for batch files.


Configure this setting directly using the following Meltano command:

meltano config tap-jira set batch_config encoding.format [value]

Batch Storage Prefix (batch_config.storage.prefix)

  • Environment variable: TAP_JIRA_BATCH_CONFIG_STORAGE_PREFIX

Prefix to use when writing batch files.


Configure this setting directly using the following Meltano command:

meltano config tap-jira set batch_config storage.prefix [value]

Batch Storage Root (batch_config.storage.root)

  • Environment variable: TAP_JIRA_BATCH_CONFIG_STORAGE_ROOT

Root path to use when writing batch files.


Configure this setting directly using the following Meltano command:

meltano config tap-jira set batch_config storage.root [value]

Faker Locale (faker_config.locale)

  • Environment variable: TAP_JIRA_FAKER_CONFIG_LOCALE

One or more LCID locale strings to produce localized output for: https://faker.readthedocs.io/en/master/#localization


Configure this setting directly using the following Meltano command:

meltano config tap-jira set faker_config locale [value]

Faker Seed (faker_config.seed)

  • Environment variable: TAP_JIRA_FAKER_CONFIG_SEED

Value to seed the Faker generator for deterministic output: https://faker.readthedocs.io/en/master/#seeding-the-generator


Configure this setting directly using the following Meltano command:

meltano config tap-jira set faker_config seed [value]

Enable Schema Flattening (flattening_enabled)

  • Environment variable: TAP_JIRA_FLATTENING_ENABLED

'True' to enable schema flattening and automatically expand nested properties.


Configure this setting directly using the following Meltano command:

meltano config tap-jira set flattening_enabled [value]

Max Flattening Depth (flattening_max_depth)

  • Environment variable: TAP_JIRA_FLATTENING_MAX_DEPTH

The max depth to flatten schemas.


Configure this setting directly using the following Meltano command:

meltano config tap-jira set flattening_max_depth [value]

User Stream Map Configuration (stream_map_config)

  • Environment variable: TAP_JIRA_STREAM_MAP_CONFIG

User-defined config values to be used within map expressions.


Configure this setting directly using the following Meltano command:

meltano config tap-jira set stream_map_config [value]

Stream Maps (stream_maps)

  • Environment variable: TAP_JIRA_STREAM_MAPS

Config object for stream maps capability. For more information check out Stream Maps.


Configure this setting directly using the following Meltano command:

meltano config tap-jira set stream_maps [value]

Something missing?

This page is generated from a YAML file that you can contribute changes to.

Edit it on GitHub!

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.

Install

meltano add tap-jira

Maintenance Status

  • Maintenance Status
  • Built with the Meltano SDK

Repo

https://github.com/MeltanoLabs/tap-jira
  • Stars
  • Forks
  • Last Commit Date
  • Open Issues
  • Open PRs
  • Contributors
  • License

Maintainer

  • Meltano

Meltano Stats

  • Total Executions (Last 3 Months)
  • Projects (Last 3 Months)

Keywords

  • meltano_sdk