create a workflow programatically?

I want to create a workflow, a workflowscheme and associate it to a project programatically.

Any code examples to help get me started?

2 answers

JIRA saves a workflow as XML. If you already have your workflow in the correct XML format, then creating the workflow is quite easy:

WorkflowDescriptor myWorkflowDescriptor = WorkflowUtil.convertXMLtoWorkflowDescriptor(myWorkflowAsXml));
JiraWorkflow myWorkflow = new ConfigurableJiraWorkflow(myWorkflowName, myWorkflowDescriptor, workflowManager);
workflowManager.createWorkflow(anAdminUser, myWorkflow);

Otherwise, creating the Workflow could be cumbersome. It depends how complex you Workflow is.

Creating a WorkflowScheme:

Scheme scheme = workflowSchemeManager.createSchemeObject(myWorkflowSchemeName, myWorkflowSchemeDescription);
AssignableWorkflowScheme myWorkflowScheme = workflowSchemeManager.getWorkflowSchemeObj(scheme.getName()); // necessary intermediate step
AssignableWorkflowScheme.Builder myWorkflowSchemeBuilder = myWorkflowScheme.builder();

Assigning Workflows to the Scheme:

// default (all IssueTypes)
// ... or only for a specific IssueType
myWorkflowSchemeBuilder.setMapping(issueType.getId(), myWorkflow.getName());


Associate Scheme to Project:

workflowSchemeManager.addSchemeToProject(project, workflowSchemeManager.getSchemeObject(myWorkflowScheme.getId()));

Does this help?

I got it working but having some minor issues:

1. I create the workflow scheme

2. for every custom issue type of mine:

2a. i create the workflow for that issue type

2b. using myWorkflowSchemeBuilder.setMapping I associate the issuetype with the workflow

2c. I update the scheme: workflowSchemeManager.updateWorkflowScheme

3. outside of my for loop - I associate it to the project

workflowSchemeManager.addSchemeToProject(project, workflowSchemeManager.getSchemeObject(myWorkflowScheme.getId()));

The issue is that on the workflow page, my newly created workflows are listed as INACTIVE; however my workflow scheme is listed as ACTIVE and the association between the issue type and the newly created workflow looks right. What am i missing?

hello John , could you please share your code? 


Will you be able to share the code of what you achieved?

I'm looking for creating custom workflow along with screen transistions.

Thanks in advance

Suggest an answer

Log in or Join to answer
Community showcase
Maarten Cautreels
Posted Thursday in Off-topic

Friday Fun: What's your favourite beer/drink

As a Belgian, beer-lover and home brewer, beer is one of my great passions. I love the fact that with just a few ingredients (usually just water, hop and malt) you can create so many different tastes...

285 views 38 9
Join discussion

Atlassian User Groups

Connect with like-minded Atlassian users at free events near you!

Find a group

Connect with like-minded Atlassian users at free events near you!

Find my local user group

Unfortunately there are no AUG chapters near you at the moment.

Start an AUG

You're one step closer to meeting fellow Atlassian users at your local meet up. Learn more about AUGs

Groups near you
Atlassian Team Tour

Join us on the Team Tour

We're bringing product updates and pro tips on teamwork to ten cities around the world.

Save your spot