Skip to content

Bulk Attachment Download

The Bulk Attachment Download plugin for Jira Cloud is a powerful tool designed to enhance your productivity by enabling the efficient download of multiple attachments from your issues. This documentation will guide you through the process of installing and using the plugin effectively.

Getting Started

To start using the Bulk Attachment Download plugin, you need to install it in your Jira Cloud instance. Follow these steps:

  1. Visit the Bulk Attachment Download listing on the Atlassian Marketplace.
  2. Click on the ‘Try it free’ button in the upper right corner.
  3. Select the Jira Cloud instance where you want to install the add-on and click ‘Start free trial’.
  4. The add-on will be automatically provisioned to your Jira Cloud instance.

Note: The installation process requires administrator rights for your Jira Cloud instance.

Once installed, the plugin integrates seamlessly into your Jira workflow, and you can access its features directly within the platform.

Searching for Issues

  1. Navigate to the Jira issue navigator by selecting Filters > View all issues.

    View all Issuses
  2. Use Jira’s powerful search functionality to filter and find the issues with the attachments you need.

Downloading Attachments

Once you have your list of issues:

  1. Click Download all attachments to initiate the download process. You find this button within the Apps dropdown menu in Jira’s new issue navigator or directly on the page if you are still on the old issue navigator.

    New issue navigator Old issue navigator
  2. A modal will appear displaying three key statistics: The number of Issues matching your filter criteria, the total number of Attachments within these issues, and the cumulative file Size of all attachments. This information can help validate that your issue search has returned the relevant issues for download.

    Modal
  3. You will be prompted to choose how you would like the attachments to be organized and your preferred download mode.

The downloaded file will be a zip archive containing all attachments of any issues found. This includes not only the issues displayed on the first page of search results but also those on subsequent pages. There is no limit on the number of issues or attachments that can be included in the download.

Organizing Attachments

Choose how to organize your downloaded attachments:

  • Toggle Enabled Per Issue Folders: Each issue’s attachments are placed in a separate folder named with the issue key and summary. Folder names are kept short for compatibility.

    If the issue summary contains characters that are illegal for file names in certain operating systems ( e.g. ", *, :, <, >, ?, /, \, |), they are replaced by _ in the folder name. This ensures that the folder names are valid and compatible across different operating systems.

  • Toggle Dissabled Top-Level Attachments: All attachments are placed directly in the zip file without issue-specific folders.

Per Issue FoldersTop-Level Attachments
Folders Enabled Folders Disabeld

Handling Naming Conflicts

In cases where multiple attachments have the same name, the plugin automatically appends a dash and an incrementing number to the file name to avoid overwriting files. Here’s an example of how naming conflicts are resolved:

Attachment in JiraFile in zip
file-3.txtfile-3.txt
file.txtfile.txt
file.txtfile-1.txt
file.txtfile-2.txt
file.txtfile-4.txt
file-3.txtfile-3-1.txt

This ensures that all attachments are uniquely named within the downloaded zip file, preserving the original file names as much as possible.

Choosing Download Mode

The Bulk Attachment Download plugin offers two distinct modes for downloading attachments: Toggle Enabled Direct Download and Toggle Dissabled Server Download. Select the mode that best suits your needs based on the following information:

Direct Download

Recommended Mode: Opt for Direct Download whenever possible for an efficient and secure process.

  • Eco-friendly and Efficient: By sending attachments directly from Jira to your browser, Direct Download minimizes energy consumption and CO2 emissions, contributing to a greener planet.
  • Enhanced User Interface: A dedicated interface will keep you informed about the download progress and promptly alert you to any issues encountered along the way.
  • Data Privacy: With Direct Download, your attachments remain within your geographical region, ensuring compliance with local data protection regulations.

Server Download

In scenarios where Direct Download is not feasible, the plugin seamlessly switches to Server Download mode.

  • Robust and Reliable: Leveraging Pristine Bytes servers located in West Virginia (USA), this mode ensures a dependable compression and download process, regardless of the browser you use.
  • Browser Flexibility: Unlike Direct Download, Server Download is not limited to Google Chrome and Microsoft Edge, offering wider accessibility.
  • Large File Handling: This mode is capable of compressing and downloading zip files larger than 4GB, accommodating substantial data needs.

Progress Indication and Download

After selecting the download button in the modal:

  • Server Download Mode: The modal will close, and your browser will begin the download immediately. This process is straightforward and similar to downloading any other file from the internet.

  • Direct Download Mode: The app displays a download progress bar within the modal, offering insights into the download progress.

    Download Progress

    Displayed data includes:

    • The relative and absolute progress of the download.
    • The total size of all attachments being downloaded.
    • The names and sizes of the files currently being downloaded.
    • Any issues encountered.

    Note: These indicators only update when an attachment has been completely fetched. The striped pattern within the progress bar represents the sum of all file sizes currently in flight.

Extracting the Downloaded Files

After the download is complete, locate the zip file on your machine and extract it using your preferred file extraction tool to access your attachments. If you encounter issues extracting the zip file with the tools included with your operating system, we recommend using 7zip for Windows and The Unarchiver for Mac.

Troubleshooting and Support

If you encounter any issues or have questions, please contact our support team for assistance.