Prerequisites
You will need the latest Microsoft Visual Studio for Office Runtime (VSTO 4.0) from Microsoft installed on your PC. It can be downloaded directly from Microsoft here.
Installation
There is not differentiation between Office 32- and 64-bit installation anymore, below installer works on both setups.
Latest released installer: Excel2Jira_Setup_4.6.4.3.msi
Release notes: Excel Addin Latest Updates
Quick Start
The add-in will add a new ribbon tab, "JIRA", to your Excel interface.
If the new ribbon tab is not visible, please follow these steps.
Connection Settings
Before working with your issues, the connection to Jira must be configured first. To do so, select the option Settings and enter your Jira URL, username and password. With Save as... you can setup connections to different Jira servers.
Options:
Jira Personal Access Token: Alternative option to connect to Jira via Personal access token (after Jira 8.14)
Save password/tokens: Stores your password encrypted in a save location
Show changed values as Excel comments: Shows found differences (of Check button) as comment content.
Show Issue Key column as hyperlink: Enables Issue Key to hyperlink into Jira instance
Maximum number of comments per issues: Number of latest comments downloaded from Jira when using the "Comments" field, 0 (zero) retrieves all comments
Afterwards, you can extract issues with the Load Data option and upload them with the Upload Data option.
See the user guide to understand the features.
Security considerations
The communication between our Excel Plugin and Jira on your instance works via REST API communication. This way of communication is end-to-end encrypted when the user enters a HTTPS Jira link in the settings. The used encryption can be defined in your Jira instance, see https://confluence.atlassian.com/jirakb/how-to-modify-the-ssl-tls-version-jira-uses-for-outbound-connections-1064093000.html for more details.
If the user select the “Remember Me” option in settings for the instance, the account´s password is stored encrypted on the local computer in the settings file. You can find the settings.json file at the folder
%appdata%\ease solutions\Office to Jira Integration
Logfile
To easier identify issues in the communication and data quality, the Excel Plugin can create logfile on demand:
Enable "Write Debug Logs" in the instance settings
Get the file "excel-log.txt" from "%appdata%\ease solutions\Office to Jira Integration" folder
"excel-log.txt.*" are older files, up to five files stored.
Prerequisites
The latest Microsoft Visual Studio for Office Runtime from Microsoft must be installed on your PC. It can be downloaded directly from Microsoft here.
Installation
Latest Installer: Excel2Jira_Setup_4.7.0.msi
Release notes: Excel Addin 4.x (latest)
The installer works for both Office 32- and 64-bit installations.
Before installing the add-in, all instances of Excel must be closed.
Configure the Jira connection
After running the installer, a new ribbon tab, "JIRA" should appear in Excel
Select the Settings option under the Jira ribbon. To connect, enter the Jira server URL, login user name, and password. It is possible to connect to different instances of Jira servers. (However, only one instance can be active at a time.)
Select the Test button in the Settings dialog to check if the add-in can successfully connect to the given instance of Jira.
If the new ribbon tab is not visible, please follow these steps.
Connection Settings
Before working with your issues, the connection to your Jira instance must be configured. Select the option Settings and enter the Jira URL and your username and password. With Save as... you can set up connections to different Jira servers.
Jira Server: Enter the URL of your Jira instance
Data Center format:
http(s)://<your server with domain>/
(depending on your setup, it could be also with a port number and further elements. Please check with your IT department))Cloud format:
https://<instance name>.atlassian.net/
Credentials:
Data Center: user name/password or Jira Personal Access Token, see how to use Jira via Personal Access Token.
Cloud: Email address and Jira API Token, see hot use Jira API Token.
Save password/tokens: Stores your credentials in an encrypted format on your Windows client.
Show changed values as Excel comments: Shows differences identified using the Check option as Excel comments.
Show Issue Key column as hyperlink: Displays Issue Keys as hyperlinks to Jira.
Maximum number of comments per issue: Number of latest comments downloaded from Jira when using the "Comments" field. A value “0” (zero) retrieves all comments.
After establishing a connection to a Jira instance, you can download issues with the Load Data option and upload them with the Upload Data option. See Load, Create and Update Issues.
Security Considerations
The communication between our Excel Plugin and Jira on your instance works via REST API communication. This way of communication is end-to-end encrypted when the user enters a HTTPS Jira link in the settings. The used encryption can be defined in your Jira instance, see How to modify the SSL/TLS version Jira uses for outbound connections for more details.
If the user select the “Save password/tokens” option in settings for the instance, the account´s password is stored encrypted on the local computer in the settings file. You can find the settings.json file at the folder
%appdata%\ease solutions\Office to Jira Integration
Logfile
To identify any issues in the communication with the Jira instance as well as data quality, you can check the log file by following the link called “Go to the logging folder” in the settings dialog. Up to 11 logfiles stored in round-robin manner (each up to 10 MB) at
%appdata%\ease solutions\Office to Jira Integration
Latest logfile is always excel-log.txt
Installer log file is excel-installer-log.txt