Search the JIRA 5.0.x Beta and RCs Documentation:

Index
Downloads (PDF, HTML & XML formats)
Other versions

This documentation relates to JIRA 5.0.x Beta and RCs only.
The latest official version is JIRA 4.4.x
If you are using JIRA 4.4.x either view this page in the JIRA 4.4.x documentation or visit the JIRA 4.4.x documentation home page.
Skip to end of metadata
Go to start of metadata

You can use workflow properties to implement restrictions on certain steps or transitions of a workflow.

(info) For details on how to implement workflow properties in your workflow, please refer to Configuring Workflow.

(minus) Please Note: Not everything on this page is recommended!

  • We do not recommend using all of these types of workflow properties as we cannot guarantee that some data and operations (e.g. bulk operations) will not be broken. Hence, use these types of workflow properties your own risk!

Available JIRA Workflow Properties

There are a few workflow properties which you can use in a transition or step of a workflow. Here are some helpful links:

Name

Values

Related Issues

References

Notes

jira.field.resolution.exclude

Resolution id

 

Resolutions per workflow step

Transition

jira.field.resolution.include

Resolution id

JRA-16443

Resolutions per workflow step

Transition

jira.i18n.submit

i18n property key

JRA-6798

 

Transition (usage: action submit button name)

jira.i18n.title

i18n property key

JRA-6798

 

Transition (usage: action name, etc.)

jira.issue.editable

true, false

 

Configuring Workflow

Step

jira.permission.*

user1, user2 / group1, group2 / ...?

JRA-6381

* WorkflowBasedPermissionManager class description (API documentation)
* Forum discussion

Step

opsbar-sequence

Integer value greater than or equal to 0

 

Configuring Workflow (Customising Transitions)

Transitions on the 'View Issue' page

Labels:
  1. Oct 04, 2006

    I just tried adding a comment permission restriction to a workflow state in 3.6.5 jira.permission.comment.user  and it works fine. I then tried doing a builk operation to transfer a couple of issues to another workflow state and didn't get any errors. Does anybody know what areas of bulk operations actually break as per the warning above?

    Has anyone else experienced bulk change errors when implementing these permissions?

    1. Oct 04, 2006

      Hi Ben,

      I have just tested two workflow properties on bulk operation:

      • jira.permission.assignable.user
      • jira.permission.close.user

      And they worked fine. Perhaps this page needs an update.. I'll follow up this anyway.

      Cheers,
      Yuen-Chi

  2. Oct 04, 2006

    Where is the list of possible "values" for each of the properties and a description of what they do?

    E.g. Where does it show that you can set jira.issue.editable = false

    I've seen the constant values API documentation but it only shows the permission name but not what possible values it can hold. There is also no description of what each of the properties does?

  3. Dec 19, 2006

    Your documentation for jira.permission.* give me the following "wrong" information:

    The format is 'jira.permission.[subtasks.]

    Unknown macro: {permission}

    .

    Unknown macro: {type}

    [.suffix]', where:

    is a short name specified in Permissions

    • Unknown macro: {type}
      is a type (group, user, assignee, reporter, lead, userCF) of permission granted, or denied to deny the permission.
    • subtasks., if specified, indicates that the permission applies to the subtasks of issues in this step.

    With "wrong" i mean that

    Unknown macro: {permission}

    is really a short name, but they can not be found in Permissions. For example i looked for the ability to grant the permission to create attachments.

    The correct way is to use jira.permission.attach.user - but following your instruction i tried jira.permission.CREATE_ATTACHMENT.user which won't work. So i had to guess the verb attach  

    1. Dec 20, 2006

      Hello Tobias,

      You can use the getShortName() method to retrieve the correct short name, actually.

      Cheers,
      Yuen-Chi Lian

  4. Jun 16, 2008

    here it says:

    The format is 'jira.permission.[subtasks.]{permission}.{type}[.suffix]', where:

    But it doesn't say what .suffix is for.

    Update: Ahha, I see in the example the suffix is used, e.g. jira.permission.edit.group.2, so I guess it's simply used when you want to specify a value for the same property more than once and the underlying OSWorkflow system requires unique property keys.

  5. Jun 30, 2008

    Hi,

    The WorkflowBasedPermissionManager documentation says:

    group, user, assignee, reporter, lead, userCF

    I took a look at the JIRA 3.11 source code and it is also possible to use projectrole where the value is a JIRA project role ID number. E.g.

    Property Key

    Property Value

    jira.permission.edit.projectrole

    10031

  6. Jul 02, 2008

    I've started using the step property functionality, but encountered a problem. I'm using sub-tasks, and in one particular step I would like to restrict the create permission, so that only the assignee could create a sub-task in this particular step. I've got the edit, assign and more or less all other permissions to work, but not the create permission. Probably the problem is that I'm using the wrong short name for create.. I've tried jira.permission.create.assignee for example, but I'm sick of guessing (wink) Anyone, helt please! ;S

  7. Jan 20, 2009

    I can't find a good list of all possible workflow step and transition properties - I see some references to others not listed above and I know having a complete list will help me come up with better workflows.  Can someone please post a definitive list??

  8. Jul 08, 2010

    See JRA-6381 for examples of restricting workflow steps using the jira.permission.* property.

  9. Sep 29, 2010

    I have used jira.permission.assignable.projectrole many times with the role-id as its value.

  10. Apr 01, 2011

    Anonymous

    Watch out for white spaces!

    Leading or trailing white spaces need to be trimmed in workflow transition properties entry boxes. Currently extra spaces cause enties to be unrecognized.

    "jira.field.resolution.exclude " does not equal "jira.field.resolution.exclude"

  11. Sep 09, 2011

    vr

    I would restrict possibility of Create issue down to a particular project role.

    How can I do this using transition properties on initial Create workflow transition? thanks