Autoblocks for Jira Server and DC

Get Started

The Get Started section contains important, must-know information about AutoBlocks for Jira, including installation and configuration/user-setup procedures.

Installing the App

Note: You must be an admin to install AutoBlocks for Jira.

There are two ways to install AutoBlocks for Jira:

  • From your Jira instance (recommended)

  • Via file from the Atlassian Marketplace

AutoBlocks for Jira Server supports the standard Jira installation requirements.

In addition, AutoBlocks requires the installation of a Java Development Kit (JDK) in order for automations to be created.

When you access AutoBlocks for Jira, the app will check if a JDK exists. If a JDK is not found, you are prompted to install the Adaptavist Java Tools app. If you approve, the app installs a JDK onto your Jira server as well as an app that can be managed via the Manage Apps page in your Jira instance.

  1. Log in to your Jira instance as an admin.

  2. Select Add-ons (or Manage Apps for Jira 8 users) from the admin drop-down list.

    install-add-on

    The Find New Add-ons page opens.

  3. Search for AutoBlocks for Jira.

    install-add-on-search
  4. Click Try it free to begin a trial or Buy it now to purchase a license, then select your hosting preference.

  5. Enter your log-in information to MyAtlassian to receive and install your new license.

Once you’re confirmed, you’re ready to go!

Installing AutoBlocks from the Atlassian Marketplace

  1. Navigate to the Atlassian Marketplace, and search for AutoBlocks for Jira.

  2. Click the AutoBlocks for Jira tile.

    installation

    The product’s marketplace listing opens.

  3. Click the Versions tab.

  4. Click See All Versions.

    versions tab
  5. Expand or hover over the current version, then click Download.

    marketplace install
  6. Navigate to your Jira instance → Settings (Cog Icon) → Manage Add-ons (or Manage Apps), and click Upload Add-on (Upload App).

    file upload

    The Upload Add-on screen appears.

  7. Click Choose File, and locate the .obr file you downloaded from the Atlassian Marketplace in Step 5.

  8. Click Upload.

    upload button
  9. Enter your log-in information to MyAtlassian to receive and install your new license.

Once you’re confirmed, you’re ready to go!

Java Compiler for AutoBlocks

AutoBlocks requires a Java compiler to create automations. For a lot of Jira installations, there’s already one available, since Atlassian recommend installing the Java Development Kit (JDK). However, it’s not uncommon for Jira installations to run on the Java Runtime Environment (JRE), which doesn’t include a compiler.

To address that, Adaptavist has created an add-on called Adaptavist Java Tools (AJT). AJT provides a Java compiler to Atlassian applications that are running on the JRE instead of the JDK.

If the handy button to automatically install it doesn’t work for you, you can download the Adaptavist Java Tools jar and manually install it.

Here are a few popular questions and answers:

  • What does Adaptavist Java Tools (AJT) do?

    AJT makes a Java compiler available to other Atlassian apps. If your Atlassian app is running on a Java Development Kit, you won’t need it.

  • Will exported workspaces work without AJT installed?

    Yes, they will! The Java compiler is only required to build the automation. Once it’s built, it can be exported and run on any Jira instance.

Anonymous Analytics

AutoBlocks for Jira collects anonymous usage data to better understand how you use the app. Collected data includes install and uninstall timestamps, platform version, plugin version, and SEN. Admins can opt out of anonymous data collection at any time.

All of the data we collect is for internal use only. See our EULA for more details.

AutoBlocks data is collected via the Anonymous Analytics app setting, which is enabled by default if your Atlassian Analytics setting is enabled. AutoBlocks analytics are automatically disabled if your Atlassian Analytics setting is disabled.

Enabling/Disabling Anonymous Analytics

Note: You must be an admin to enable/disable the Anonymous Analytics setting.

  1. In AutoBlocks, click the Gear icon in the upper-right corner of the screen. The administration settings page opens.

  2. Click the Applications tab.

  3. Scroll to the AutoBlocks section in the left panel, then click Settings. The Anonymous Analytics setting appears.

  4. Toggle the Anonymous Analytics setting on or off.

    anonymous analytics

Note: If your Atlassian Analytics setting is disabled, the AutoBlocks toggle is greyed out. To view your Atlassian Analytics setting, click the System tab, scroll to the Advanced section in the left panel, then click Analytics.

Setting User Permissions

Note: You must be a Jira server administrator to set permissions for AutoBlocks.

After you install AutoBlocks for Jira, only Jira system admins have access.

Follow this process to grant others permission to use AutoBlocks for Jira, either as admins or as editors.

  1. Navigate to Global Permissions in Jira.

  2. Scroll to the AutoBlocks permissions.

    There are currently two AutoBlocks permissions:

    • AutoBlocks Editor - This permission grants users the ability to view, create, and edit any workspace. Editors can also delete workspaces they create that are not approved.

    • AutoBlocks Admin - This permission grants users the ability to view, edit, create, and delete workspaces. It also grants the authority to review (approve/reject) proposed workspaces for editors and other admins and deploy workspaces.

  3. Make permission updates in the Permission and Group fields.

  4. Click Add.

    New permissions appear on the page.

    global permissions

Check out Atlassian’s documentation on managing global permissions if you’d like to learn more.

Terms and Definitions

Useful terms and definitions for AutoBlocks for Jira are provided in this topic.

Essentials

  • Block - A graphical representation of a chunk of code used to build and configure automations. Blocks in a workspace are inactive until connected to a trigger command.

  • Events - This tab shows you a log of events that have triggered in workspaces, including save history, errors, warnings, and other important messages. You can use filters to view events that occurred in the last few minutes, hours, days, weeks, months, and even years.

  • Toolbox - The collection of blocks you can use to configure your automations. Simply drag blocks from the toolbox onto the workspace and snap them together. Click and drag a block downward to break blocks apart. Unneeded blocks on the workspace can be dragged into the trash or back into the toolbox.

  • Shadow Block - A placeholder block attached to a larger block. Shadow blocks, which are grayed out and cannot be deleted, act as defaults you need to assign values to before you run an automation.

  • Timeline - A historical timeline appears in each workspace and tracks versions of the automation, which aids in reviews for deployment. For example, one can use the timeline to view only what was changed since a workspace was last approved/deployed. You can also use the timeline to revert and branch a workspace to a previous version.

  • Trash - A place you can drag a block or a set of blocks to delete it from the workspace.

  • Workspace - The white canvas where you put together blocks that tell Jira what to do and when to do it. At the bottom of the workspace is a trashcan where you can drag and dispose of unnecessary blocks. Zoom-in, zoom-out, and recenter viewing options are also available. Workspace may also refer to the entire automation (set of blocks), especially in discussions of exporting/importing and the review-for-deployment process.

Triggers

Triggers are a block type that can be used to activate and run your automation. Triggers added to the workspace remain inactive until a workspace is saved and deployed.

Triggers only run if the workspace owner has permission to view the issue from the event.

  • Manual - A trigger block that activates only when you physically click on it. When you click a manual trigger, the Events tab opens to show you the automation progress.

  • When this workplace is deployed - A listener trigger that runs your automation only when your workspace transitions from undeployed to deployed.

  • When this workplace is undeployed - A listener trigger that runs your automation only when your workspace transitions from deployed to undeployed.

  • When an issue is [created] as [variable] - A listener trigger that runs your automation only when an issue is changed, based on the values you choose.

Projects

  • Create Project - A block that can be used to create a project within your Jira instance.

  • Delete Project - A block that can be used to delete a project within your Jira instance.

  • Create Component - A block that can be used to create a component for a specific Jira project in your instance.

  • Create Version - A block that can be used to create a version for a specific Jira project in your instance.

Issues

  • Create Issue - A block that can be used to create a new issue in a specific project within your Jira instance.

  • Update Issue - A block that can be used to update an issue in a specific project within your Jira instance.

  • Create Subtask - A block that can be used to create a sub-task for a specific issue within your Jira instance.

  • Link Issues - A block that can be used to link specific issues together within your Jira instance.

  • get issues linked [from/to] with link type - A block that can be used to gather issues linked to or from an issue, specified by link type.

  • workflow action - A block that can be used to move an issue through its workflow by applying a specific operation, e.g. In Progress, Reopen, or Close.

  • link type [action] - A block that defines a link’s relationship to another issue. Options are based on link types established in your Jira project.

  • Add Comment - A block that can be used to add a comment to an issue.

Fields

  • get from - A block that can be used to get specific information from something else, e.g. the Key of an issue or the Lead of a project.

  • set to - A block that can be used set a specific field’s value on an issue, e.g. setting or changing the Summary field value.

  • add to - A block that can be used to add items to specific issue fields, e.g. adding a component to an issue’s Components field.

  • remove from - A block that can be used to remove items from specific issue fields, e.g. removing a component from an issue’s Components field.

  • issue type - A block that specifies issue type, e.g. Bug or Story.

  • status - A block that specifies issue status, e.g. In Progress or Resolved.

  • resolution - A block that specifies issue resolution, e.g. Fixed or Done.

  • priority - A block that specifies issue priority, e.g. Low or High.

JQL

  • Issue Search - A block that can be used to perform a JQL (Jira Query Language) search for specific issues that match your criteria.

Text & Numbers

  • text block - This block can be used to create text.

  • number block - This block can be used to create a number.

  • create text with - Create a piece of text by joining together any number of items.

  • print - This block writes the specified text, number, or other value to the events log.

Logic

  • if…​ do - A block which can do a series of subsequent actions if the input condition is true.

  • comparison block - A block that compares two inputs. You can select from all ranges of comparisons, such as =, <, >, =/=, etc.

  • logic operations - If and, return if both inputs are true. If or, return if at least one of the inputs is true.

  • not - A negator block that finds an input’s opposite boolean value. Returns true if the input is false and returns false if the input is true.

  • true or false - A block used to represent boolean values true or false.

  • null - A block that represents a null (no assigned value).

Lists

  • create empty list - Create an empty list with any number of items.

  • create list with - A block that can be used to create a singular list using the combined input from many different lists.

  • for each [variable] in - This block allows you to iterate over a collection of items and perform an operation associated with each item. For example, you could use this block to change the priority of each issue returned from an issue search.

  • filter list retaining [variable] where expression - This block allows you to remove (filter out) items from a collection that don’t match a specific criteria.

  • transform [variable] in list using expression - This block allows you to modify an item in a collection using a specific expression/block.

  • [any] [variable] in list matches expression - This block allows you to check to see whether a specific item that matches your criteria is within a specific collection.

  • list [contains] item - This block allows you to check to see whether a collection of items contains a specific item.

  • list is empty - A block that can be used to check if a list is empty or not. Returns a boolean value of true if the list is empty and returns false if the list is not empty.

  • length of list - A block that can be used to determine how many items are in a list. Returns a number representing how many items the list contains.

Utilities

  • Send Email - This block sends an email with all of the input specifications.