Installation

Installing the dependencies

You need to install 3 separate apps to implement the complete automation mechanism. Each app can be conveniently installed through the Universal Plugin Manager (UPM). The whole procedure requires only some clicks and some minutes of your time.

Because of their dependencies, install the apps in this order:

  1. Install Better PDF Exporter for Jira. This app provides the core file generation and export functionality.
    See the installation guide.
  2. Install Automation Lite for Jira. This app provides the automation framework.
    See the installation guide.
  3. Install Automation for Jira. This app is the paid and advanced version of the previous, therefore install this if the free version does not meet your needs.
    See the installation guide.
  4. Install Better PDF Automation for Jira. This app is the "bridge" between the file generator app and the automation app.
    See the installation guide.

If you faced some "app cannot be initialized" problem during the installation, just continue installing all the 3 apps, then restart Jira and enable the disabled ones of these apps in the above order.

Version compatibility between dependencies

As the automation mechanism is composed of Jira plus 3 apps, each with its own versioning, the following table defines the recommended combinations. Please note that the table shows version ranges (not specific versions). It aims to avoid wasting time with unsupported combinations.

Jira Automation app Better PDF Automation for Jira Better PDF Exporter for Jira
7.0.11 or newerAutomation Lite 3.0.0 or newer
(free)
3.0.0 or newer4.1.0 or newer
7.0.11 or newerAutomation 3.0.0 or newer
(paid)
3.0.0 or newer4.1.0 or newer
6.2 - 7.3.xAutomation Lite 1.1.5 - 2.0.3
(free, previously called "Jira Automation Plugin")
1.0.0 or newer3.1.0 or newer
When installing dependencies directly from Atlassian Marketplace

The golden rule of thumb: install the app version that is offered by the Universal Plugin Manager (UPM)!

When installing dependencies by uploading the app JARs

In case you install an app by uploading it to Jira, then check out its "Version History" page at Atlassian Marketplace. That will show the compatible Jira versions for each app version:

  1. Automation Lite version history
  2. Automation version history
  3. Better PDF Automation for Jira version history
  4. Better PDF Exporter for Jira version history

In this case the golden rule of thumb: install the newest app version that is compatible with your Jira version!

Installing the app

You can easily install the Better PDF Automation for Jira using the Universal Plugin Manager (UPM) that is built into Jira.

You can install it in two different ways. We highly recommend the first approach for your convenience. You should use the second approach only if the server that hosts your Jira instance has no access to the Atlassian Marketplace, i.e. when direct Jira-server-to-Marketplace-server communication is not possible.

Installing directly from Atlassian Marketplace

  1. Login to Jira as administrator, go to Jira AdministrationAdd-onsFind new add-ons and search for the term "pdf automation".
  2. Click Install at the entry of "Better PDF Automation for Jira" in the search results.
  3. Click Manage add-ons in the left and check whether "Better PDF Automation for Jira" is visible in the User-installed add-ons list, and whether it is enabled.

Installing by uploading the app JAR

  1. Download the app JAR from its Atlassian Marketplace page. Make sure that you download the app version correctly matching your Jira version.
  2. Login to Jira as administrator, go to Jira AdministrationAdd-onsManage add-ons and click Upload add-on in the right.
  3. Click Browse, select the better-pdf-automation-for-jira-x.y.z.jar that you just downloaded, and upload it.
  4. Check whether Better PDF Automation for Jira is visible in the User-installed add-ons list, and whether it is enabled.