Skip to Content

Jira Connection Guide

This connection guide will step you through how to connect Vinyl to Jira. Jira is a bug tracking tool used in agile project management, and is part of the Atlassian product suite.

Warning

After establishing a Jira connection to Vinyl, you need to restrict the logic used to display Jira data on the page so that it isn't querying all records. Failure to do so may result in the Vinyl app appearing non-responsive.

Prerequisites

  • You must have Vinyl 3.3+ installed
  • You must have an Atlassian account
  • You must have a valid API Token for the Atlassian account

Configuration in Atlassian

Create an API token from your Atlassian account:

  1. Log in to https://id.atlassian.com/manage-profile/security/api-tokens
  2. Click Create API token
  3. Enter a clear and concise Label for the token and click Create
  4. Click Copy to clipboard, and paste the token to a secure location to save. This information will be needed in the Vinyl configuration steps.

Configuration in Vinyl

Create a Jira Data Server

  1. Navigate to the Vinyl IDE
  2. Click on Data Servers from the Connect menu

  3. Click the + Server button and provide the following information:

    • Server Name: Identifiable name for server connection. For example: Jira
    • Type: Jira
    • Url: Base domain for the Atlassian Cloud instance. For example: https://yourcompany.atlassian.net/

  4. Click Save

  5. Click the Advanced Settings button
  6. Click Edit

  7. Enter the API Token in the Advanced field, using the format APIToken=<yourAPIToken>

    Example API Token value entered in Advanced field

  8. Click Save

Import the Jira Data to Display in Vinyl

  1. Navigate to the Vinyl IDE
  2. Click on Data Servers from the Connect menu
  3. Locate the Jira data source and click the Details button from the right-hand panel
  4. Click the Import button

  5. Determine what schema you wish to import:

    • Import From Pattern: Allows you to import only tables specified in this field. Prefixes can be used to only import a subset of tables, for example MyApp_* will only import tables starting with MyApp_. Leaving the field blank will import all tables.
    • Click Proceed when prompted. Vinyl will run the import as a background task.
    • Tables, Views, and Procedures tabs list all available options along with corresponding Import Schema buttons.

After importing the data you can create Business Logic to use on panels in order to display Jira data on pages in your Vinyl app.

Troubleshooting

  • If you do not see any options available for the Jira data source from the Vinyl Import button, check to ensure you have entered a valid API Token.
  • If Vinyl appears nonresponsive trying to load an app page with Jira data, or Jira displays a "Something went wrong" message, review the logic being used to ensure it is restricting data being returned to more reasonable criteria.