latest

Export/Import Workspaces

The ability to download and send a workspace to someone else can be extremely useful, and the AutoBlocks export/import features allows you to do just that.

Note: Any AutoBlocks for Jira user can export a workspace, but only a Jira admin can import a workspace into a Jira instance.

When you export a workspace, there are four types of information collected in the .jar file.

  • Workspace Source is the xml file produced by Blockly. It must be included in the export if the workspace is to be viewed or edited post-import.

  • Generated Source is the Java source code created from the workspace and is only required for debugging purposes. Ensure this information is included if you need feedback from Adaptavist Support.

  • Compiled App information allows a workspace to be read as an Atlassian App. It is required for the workspace to be valid for import into a Jira instance via the app manager (UPM).

  • Diagnostics are warnings and errors emitted during workspace generation/compilation. This information is useful if you need feedback from Adaptavist Support and is not required to import a workspace into a Jira instance.

Reasons to Export/Import

There are lots of reasons and use cases to export/import a workspace, including the following:

  • Pre-production work - Build, review, and test your automations in a staging/test Jira instance to reduce the risk of unforeseen issues occurring in a production instance. When your automation is ready to go live, export the workspace, upload it into a production instance, and deploy it to Jira.

  • Improve support - Something unexpected happening with an automation? Export the workspace and send the .jar file to Adaptavist Support. The file holds lots of useful information our experts can use to identify the issue and help you find a solution.

  • Automations as code - Store exported workspaces in a repository, like Bitbucket, and manage them as code.

  • Reuse automations across Jira - If your organization uses multiple instances of Jira, use the export feature to reuse automations without having to rebuild them in each instance.

Exporting a Workspace

Note: Any AutoBlocks for Jira user can export a workspace, but only a Jira admin can import a workspace into a Jira instance.

  1. Click Save on a workspace you want to export.

  2. Click Export.

    The workspace-export dialog appears.

    export workspace dialog
  3. Optional: Customise the name of the file and the export options.

    We recommend that you allow the export to include all of the default options, especially if you plan to send the file to Adaptavist Support for assistance.

  4. Click Download.

    The .jar file downloads to your local machine.

    Note: You may be prompted to accept the file type prior to the download.

Importing a Workspace

Note: Any AutoBlocks for Jira user can export a workspace, but only a Jira admin can import a workspace into a Jira instance.

  1. Click the Cog icon in the upper-right corner of the Jira screen, then click Manage Apps (or Manage Add-ons for older versions).

    The Administration page appears with focus on the Manage Apps tab.

  2. Click Manage Apps in the Atlassian Marketplace section on the left side of the screen.

    Your user-installed apps load.

    manage-apps
  3. Click Upload App.

    The Upload App dialog appears.

  4. Locate the .jar file you want to import.

  5. Click Upload.

    The imported app, which features a blue AutoBlocks logo, appears in the User-Installed Apps section.

    imported jar file