Workflow properties
Jira’s workflow properties let you set restrictions on certain steps or transitions of a workflow. Thus, the issue view can be modified depending on the issue status in the workflow.
In this document, you’ll learn about:
We don’t recommend using all of the available workflow properties because we can’t guarantee that some data and operations, like bulk operations, won’t be corrupted.
For details on how to set properties in a workflow, see Working with workflows.
Jira workflow properties
The following table lists workflow properties you can use in a transition or step of a workflow. Check the API documentation for more technical details: Jira API Documentation - JiraWorkflow constant values
The names of Jira’s workflow properties start with the prefix jira. If you have third-party apps installed on the instance, they might introduce custom properties. If a property doesn’t start with jira, this is a third-party property. To learn more about it, reference the app’s documentation.
| Name | Description | Related issues | References |
|---|---|---|---|
Value: Resolution | Allows you to add comma-separated resolution IDs to the transition properties where you don’t want to show particular resolutions. | N/A | N/A |
Value: Resolution | Allows you to add comma-separated resolution IDs to the transition properties. | JRA-16443 | N/A |
Value: I18n property key | The transition property that allows you to customize the name of a button on a screen. | JRA-16443 | N/A |
Value: I18n property key | The transition property that allows you to customize the description of a button on a screen. You can see this description when you hover over the button. | JRA-6798 | N/A |
Value: I18n property key | The transition property that allows you to customize the description of a workflow transition. | JRA-6798 | N/A |
Value: | The step property that restricts field editing and sub-tasks creation in issues. | N/A | Working with workflows |
Value:
| The step property that restricts | WorkflowBased PermissionManager class description (API documentation) | |
Value: Integer value greater | Allows transitions on the View Issue page. | N/A | Advanced workflow configuration (Customizing transitions) |
Use cases
Check the use cases of how some of the workflow properties can be applied.
| Property | Use case | Use case value |
|---|---|---|
jira.field. | Disable a particular resolution for a particular status. For example, to make the Duplicate resolution unavailable for a status. | A list of comma-separated IDs of the resolutions to exclude. For example: |
jira.field. | Enable a particular resolution for a particular status. For example, to enable the Duplicate resolution for a status. | A list of comma-separated IDs of the resolutions to include. For example: To add multiple resolutions to the property, check the instruction above. |
jira.issue. | Make an issue editable when it has a particular status. By default, if this property isn’t set, issues are always editable. | true |
| Disable editing when an issue has a particular status. This may be helpful when the issue is at the final stage of the process and has some of the finalizing statuses like Done. | false | |
jira. | Use this property in the following format: |
|
jira. |
| Must be empty |
jira.permission. disables work log when an issue has a particular status. This is helpful to add to statuses of epics. | Must be empty | |
You can set this property for all workflow statuses but allow only particular users to create attachments by giving them the Create attachment permission. This provides protection against anonymous users or attackers attaching large files to the system, which may bring Jira down after the disk space runs out. | Must be empty | |
When comments are disabled completely, they’re not available | Must be empty |
Setting a workflow property
To add a workflow step or transition property:
Go to Administration > Issues.
In the left panel, select Workflows.
For a workflow where you want to set a property, select Edit.
Select a status or transition you want to add a property for.
In the menu, select Properties.
You’ll be brought to a page where you should enter the key and value of a property.
Select Add.