Sharing your workflow

The new Workflow Sharing feature allows you to share your team's workflow with other teams in your organization on different JIRA instances, or external parties in other organizations via the Atlassian Marketplace. This feature allows you to easily share and use workflows that other people have published, or to move a workflow from staging to production in your own organization.

Note: For all of the following procedures, you must be logged in as a user with the JIRA Administrators global permission.

On this page:

Exporting your workflow

If you wish to share your JIRA Workflow with another instance of JIRA or upload it to the Atlassian Marketplace, you first need to download it. Follow this procedure.

  1. Choose > Issues
  2. Find the workflow you wish to share by clicking on the Workflows section in the left-hand panel.
  3. Click View or Edit under the Operations column.
  4. Select Export > As Workflow.
  5. Click Next to continue.
  6. In the Add Notes field, add any special configuration notes; for example, information about plugins that should be installed. JIRA auto-populates these notes for you when it discards parts of your workflow (for example, plugins, post functions, conditions, validators).
  7. Click Export and select a download location. Ensure the location is publicly accessible.

Uploading to Atlassian Marketplace

To share your workflow with other JIRA users, upload it to the Atlassian Marketplace.

  1. Create an account on Atlassian Marketplace.
  2. Log in to the Atlassian Marketplace and choose Manage Add-ons. See this page for more details: Step-by-step Paid-via-Atlassian Listing.
  3. Click Create new add-on.
  4. Choose My add-on is not directly installable.
  5. Ensure 'Add-on Type' is listed as 'Not a Plugin.'
  6. You will need to host the workflow on your own servers, and add information about where the workflow export can be accessed in the Binary URL textbox. This should be the location you specified in step 7 of the prior instruction set.
  7. When you fill out the submission form, be sure to note the following:
    1. The Summary field contains the information that will be displayed to users searching the Marketplace. 
    2. The Category for your workflow must be Workflow Bundles. 
      (info) Choosing Workflow Bundles ensures other JIRA users will have visibility to your workflow.
    3. The Add-on Key must be unique.
      (info) This is something that uniquely identifies your application; it will become the application URL.

You don't have to complete the form in one session. You can save your form and come back to it later. Once you accept the Atlassian Marketplace Vendor Agreement, the system submits your add-on for review by Atlassian's Developer Relations team.

Importing from Atlassian Marketplace

  1. Choose > Issues
  2. Click on the Workflows section in the left-hand panel.
  3. Select Import > Import Workflow in the top right of the screen.
  4. The From Atlassian Marketplace option should be selected by default.
  5. Find the workflow you want and click the Select button.
  6. Follow steps 5 through 8 of the 'Importing from a local instance' procedure.

Importing from a local instance

This procedure covers importing a workflow from a local instance. For importing from Marketplace, see the procedure above, Importing from Atlassian Marketplace.(info) You must be logged in as System Administrator to perform this function.

  1. Click on the Workflows section in the left-hand panel.
  2. Select Import > Import Workflow.
  3. Select a workflow from your computer to upload, and then click Next.
  4. JIRA automatically generates a workflow name, but you can change this if you like. Click Next.
  5. Next, you are presented with a screen that details your workflow statuses, as shown below. You can map the steps of the workflow to your existing workflow statuses or create new statuses at this point. When you are finished, click Next to continue.
  6. You will be presented with a screen that presents a summary of the workflow changes, as shown below. Click Import at the bottom of this screen to accept these changes and import the workflow.
  7. Your workflow is imported and you are presented with a screen with additional configuration details. Click Done to exit this process.
    (info) All custom fields will have brand new custom fields created. This is regardless of a custom field of the same name / type already existing. See:  JRA-37358 - Workflow import creates duplicate custom fields Open  for the request to improve this.

Custom fields in workflow imports

If the workflow that you are importing contains custom fields that are disabled, the workflow importer will not create these fields unless they are enabled before importing.

You will receive a warning about this. To fix this, you need to enable the missing custom fields before proceeding with the import.

  1. Click on the highlighted Custom Field Types & Searchers plugin in the displayed warning. This opens the plugin in a new window and scrolls to the right place to make the necessary changes:

  2. Click to expand the list of enabled modules.
  3. Find the modules that are disabled and enable them.

After enabling the corresponding modules of the Custom Field Types & Searchers plugin, return to the summary page and proceed. You may need to refresh the page first.

For information on installing add-ons, see Viewing installed add-ons.

Was this helpful?

Thanks for your feedback!

Why was this unhelpful?

Have a question about this article?

See questions about this article

Powered by Confluence and Scroll Viewport