run26kimo / jira-tools

Google Spreadsheet Add-on for Jira Integration

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

Jira Sheet Tools

Jira is a powerful and well established project management tool amoung small to enterprise businesses. Still we often end up using Google Sheets for some overview roadmaps, project dashboards and other purposes.

With this Google Sheet Add-on the, called "Jira Sheet Tools" available in the Google Add-On store from within Google Sheet, you can now take your sheets with Jira information to the next level.

Jira Sheet Tools allows you to visualize the status of any Jira ticket you mention in a sheet. You can directly import entire issue lists with your Jira filters just from within Google sheet. NEW! You can create time reports for any of your users based on the Jira worklogs.

Enter your Jira server domain and user details once, and be able to use the Jira features in any sheet at any time. No manual status update copy&paste anymore.

Tested with latest Jira Cloud (OnDemand) - compatibility with Jira Server not yet fully tested! Please provide feedback.

Install / Get started

  • Open up your chrome browser
  • Find & Install the Add-on "Jira Sheet Tools"
  • Authorize the Add-On when asked for
Authorizations

View and manage your spreadsheets in Google Drive

Required to change and add Jira issue information within the active sheet.

View and manage data associated with the application

The Add-on will store your Jira settings within the protected google sheet storage.

Allow this application to run when you are not present

Fault. This permission is actually not used at all, but triggered by yet unknown word within the code. Will hopefully be not necessary in a sonner release.

Connect to an external service

Required for establishing connection to the Jira RESTful API to fetch your Jira issue details when requested.

Setup Connection to JIRA

Once installed: Simply provide your individual Jira server settings before you use all features.

In any Google sheet, go in the menu to “Add-ons" > "Jira Sheet Tools" > "Settings”. Enter your "Jira Domain", "Username" and "Password".

It is recommended to use this Add-on only with an Jira Cloud/Server instance which runs via SSL (https). This Add-on is using simple Basic Auth mechanism to authenticate with Jira, which means, user credentials are transmitted unsecure when using without SSL.

You're all set and ready to go

Features

Refresh Ticket Data

Any Jira ticket Id in the form of "KEY-123" will be updated on the current active google sheet and extended with the current status of matching Jira ticket.

Sample Data:

| Before  | After
| KEY-123 | KEY-123 [Done]
| KEY-456 | KEY-456 [In Progress]
| KEY-789 | KEY-789 [Closed]

Even when used within text it will search for keys and add the status. If Jira issue key used in a single cell, the value will be linked automatically to the Jira issue page.

List Issues From Filter

“Add-ons" > “Jira Sheet Tools” > "List Issues from Filter"

Allows you to add a table/list of all found Jira issues based on a Jira Filter. The dialog will let you choose from all your Jira filters and then insert all results into the active Google sheet. You can even decide which information to be shown in the resulting table. Most common Jira fields / columns are available to select from.

Note: This feature is currently limited to list a maximum of 1000 jira issues.

Time Sheet

“Add-ons" > “Jira Sheet Tools” > "Time Sheet"

Lets you pick a user from Jira and a date period to filter for and generates a nice Time sheet report based on all worklogs for the filtered user and date period. Supports two different time report formats; "1d 7h 59m" for better readibility or "7.5" (work hours as decimal number) for better calculations in the sheet.

Careful when selecting to big date periods, can be slow and become a wide table. Start with 1 week and scale up.

Configure Custom Fields

“Add-ons" > “Jira Sheet Tools” > "Configure Custom Fields"

If you wish to list issues in your sheet with the function "List Issues From Filter" you can specify which columns to insert. By default only most common Jira default Fields (Columns) are available to choose from. In case you use custom Jira fields you can now go to the Settings section and select some of these customs fields as your favorites.

Note all custom field formats are supported, these are indicated in the list of fields.

Once you configured your custom fields, these fields are available to create column of in the "List Issues From Filter" panel.

Support custom fields are of type: string, number, date and datetime

Limitations

With the features of this Add-On are some hard limits implemented purposly. Specifically related to the amount of records you can fetch from your Jira API due to Atlassians REST API policy. It is described here on Atlassian.com that the limit of records per call can be changed without notice. Therefore i do use already pagination where ever possible.

Current existing limitations by this Add-On:

  • "List Issues from Filter" is limited to a total amount of 10.000 issues to be listed per request
    • To comply with Atlassians policy, it does internally fetch only 50 records per page which can result in quite some delay when dealing with too many issues.
  • Listing of Jira users and groups (within dialogs) is limited to 100 user/group records
  • "Time Sheet" is limited to report max 1.000 worklogs per Jira issue (max 1.000 issues) per Time sheet

Known Issues

Could not connect to Jira Server![401]

In case someone comes across here with a same or similar issue, i could actually reproduce that error and identify one use case where this would happen.

Solution

This applies to JIRA Cloud using G-Suite synced account. It might not apply to self hosted Jira instances.

Note that if you are logging in via a synced Google account, it is NOT the google password you are supposed to use. Instead you should go to your user profile and look up your username and set a password.

For site admin functions, RSS feeds, REST API access, or WebDAV uploads you'll need to have an Atlassian Cloud password (separate to your Google Apps password.) Which applies to this Add-On as well.

Instructions

Log out from your Jira portal. Go to https://id.atlassian.com and click on "Can't log in?" - just below the log on form. On the next page enter your email address (which would be your Google Email) and press "Send recovery link".

Your will get an email from Atlassian where you please click the provided link at "Reset your password". Now on the Atlassian page where you can set/change your Atlassian (and not Google) password, enter a new password for your Atlassian account, not to mix up with your Google account.

Of course it makes no sense that this information is not available on the REST API documentation page, since it is quite crucial to get it working.

About

Google Spreadsheet Add-on for Jira Integration

License:GNU General Public License v3.0


Languages

Language:JavaScript 55.5%Language:HTML 44.5%