Versions Compared

Old Version 7

changes.mady.by.user Daniel Barrow

Saved on

compared with

New Version Current

changes.mady.by.user Daniel Barrow

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Excerpt

A workflow post-function that creates one or more new issue(s). The specifications of the issue(s) to be created can be customized using the options provided.

To add the 'Create issue' post-function to a transition:

  • Click Edit for the workflow that has the transition you wish to add the post-function on.

  • In the Workflow Designer, select the transition.

  • Click Post Functionsin the properties panel.

  • Click Add post function.

  • Select Create issue(s) from the list of post-functions.

  • Click Add to navigate to the Create issue(s) post-function screen where you can add configuration details to the post-function. See below for configuration details.

    • Click Add
    Info

    Note: When creating issues using this post-function, some consideration is required for specific fields in the new issue(s):

    • Sprint - If you are setting the Sprint field (manually or when copying fields), and you try to assign the new issue to a closed sprint, the value will not copy. If you are adding multiple sprints to the Sprint field and one of those values is a closed sprint, that value will not be copied (but the other sprint values will be copied).

    To add the 'Create issue' post-function to a transition:

    1. Click Edit for the workflow that has the transition you wish to add the post-function to the transitionon.

    After adding, move the post-function to the appropriate position according to Placing post-functions in a transition document.

    Destination

    Specify the target project and issue type.

    Project:Set the project where you want the new issue(s) to be created. Select one of the following to set the project as:

    • Same as the current issue: The same project as the current issue.

    • Calculated: A project whose key is the value returned from the Nunjucks template.

    • Projects: A project selected from the list.

    Issue type: Select the issue type to be assigned to the newly created issue. 
    When the issue type is Sub-task, specify its parent issue in the Parent issue field.

  • Current issue: The current issue will be the parent of the newly created issue.

    • Another issue: An issue

    1. In the Workflow Designer, select the transition.

    2. Click Post Functionsin the properties panel.

    3. Click Add post function.

    4. Select Create issue(s) from the list of post-functions.

    5. Click Add to navigate to the Create issue(s) post-functionscreen where you can add configuration details to the post-function. See below for configuration details.

    6. Click Add to add the post-function to the transition.

    After adding the post-function, move the post-function to the appropriate position according to Placing post-functions in a transition document.

    Destination

    Specify the target project and issue type.

    • Project -Set the project where you want the new issue(s) to be created. Select one of the following to set the project as:

      • Same as the current issue - The same project as the current issue.

      • Calculated - A project whose key is the value returned from the provided Nunjucks template, will be the parent of .

      • Projects - A project selected from the list.

    • Issue type - Select the issue type to be assigned to the newly created issue. Some factors when selecting the issue type:

      • When the issue type is 

    Calculated, you can type the issue type name or ID or a Nunjucks template returning a valid issue type name or ID in the Nunjucks template editor.When the issue type is

      • When the issue type is 

    When the issue type is:

    • Epic - set the  Set the Epic Name field with a value using the Set fields of new issue option (explained below).

    • Story - you might You may want to add the newly created story to an Epic. In this case, you should add the Epic link field with the key of the Epic as the value in the Set fields of new issue option (explained below)

    Note

    When the Project is Same as the current project or Calculated the list of issue types contains all the issue types configured in your Jira instance, even though some of them might not apply to that project.

    Link to new issue

    Select a link type from drop-down to link the newly created issue to the current issue. The default value is "is not linked to", which will not create any link.

    Copy fields to new issue(s)

    Specify the current issue fields to be copied to the new issue(s).

    Mode

  • Only copy or set fields listed below: If you select this option, only fields specified explicitly under the Set specific fields of new issue section will be copied or set on the new issue.

    • Copy all fields that appear on the Create screen of the issue type to create, in the target project

    • .

    • Sub-task, specify its parent issue in the Parent issue field:

      • Current issue - The current issue will be the parent of the newly created issue.

      • Another issue - Enter a Nunjucks expression that returns the key of the parent for the newly created issue.

    • Calculated - Enter the issue type name or ID as a static value, or use a Nunjucks template that returns a valid issue type name or ID.

    Note

    When the Project is Same as the current project or Calculated the list of issue types contains all the issue types configured in your Jira instance, even though some of them might not apply to that project.

    Link to new issue

    Select a link type from drop-down to link the newly created issue to the current issue. The default value is "is not linked to", which will not create any link.

    Copy fields to new issue(s)

    Specify the current issue fields to be copied to the new issue(s).

    Mode

    • Only copy or set fields listed below: If you select this option, all fields only fields specified explicitly under the Set specific fields of new issue section will be copied or set on the new issue.

    • Copy all fields that appear on the Create screen of the issue type to create, in the target project: If you select this option, all fields that appear on the Create screen of the issue being created will automatically be copied from the current issue to the new issue, as if they were being entered by the user on the Create screen.

    • Copy all fields: If you select this option, all fields that have a value on the current issue and that apply to the issue being created will be copied from the current issue to the new issue.

    Regardless of the selected option, if you add a field under the Set specific fields of new issue section, it will always be copied or set accordingly.

    Set specific fields of new issue 

    Set the field values of the newly created issue, regardless of the option selected under Copy fields

    set as configured under those options (see below). This can be useful if, for example, you want to copy the values of all fields of the original issue, but need to override the value of one or more fields; in this instance, set the Mode to Copy all fields and then also configure the specific fields for which you need to override the original value(s).

    Set specific fields of new issue 

    Set the field values of the newly created issue, regardless of the option selected under Copy fields to new issue(s).

    • Summary: This - This sets the Summary field for the new issue. This is added by default since it is required for any issue type.

    • Add field: - Select a field from the drop down and click Add to add the respective field. Set the field using one of the following options: 

      • Copy value from current issue: - Copies the field value(s) from the current issue.

      • Set to other field of current issue: - Sets the field to the value of another field of the current issue. Say, to set the Reporter of the current issue as the Assignee of the newly created issues to the user in the Reporter field from the original issue.

      • Set field value to: - Set the field to a specific value, which can include Nunjucks annotations.
        For example: To set the Fix Version/s to 2.0, you can specify 2.0 in the value box.

    • Click the Remove icon ( remove.pngImage Added ) to remove the respective field.

    Note

    Note that you can copy the issue links of the current issue to the newly created issue by setting the Linked Issues field to copy the values from the current issue.

    • Ignore fields that don't apply to the new issue: - If you add a custom field (s) or fields above that do not apply to the issue being created (because it is configured to apply only to certain issue types or projects), the post-function will fail (so you can pinpoint the problem). Select this option to ignore this error instead, which can be useful if you are creating multiple issues in different projects or of different types.

    Copy comments to new issue(s)

    Use this option to copy the existing comments/newly added comments of the current issue to the newly created issue.

    • Don't copy any comment to the newly created issue(s): - This is the default option. Select this option to not copy comments to the newly created issue

    • Copy the transition comment to the newly created issue(s): - Select this option to copy the comment added on the transition screen to the newly created issue.

    • Copy all comments from the current issue to the newly created issue(s): - Select this option to copy all the comments on the current issue to the newly created issue.

    The restricted comments to which the “Run as user” does not have permissions are not copied to the newly created issue.

    Comment visibility

    This section is only visible when Copy comments to new issue(s), above, is set to ‘Copy the transition comment to the newly created issue(s)’ or ‘Copy all comments from the current issue to the newly created issue(s)’. This option will set the visibility of any comments that are copied from the current issue to the new issue(s).

    • Retain existing comment visibility restrictions: - This will copy the existing restrictions on individual comments to the copied comments on the new issue(s).

    • Use the following comment visibility: - Select specific visibility settings. Note: the selected settings will apply to all comments copied, no matter their visibility settings on the current issue.

      • Restrict to Group: - Select a group to restrict comment visibility to only members of that group. Leave blank for no restrictions based on group.

      • Restrict to Project Role: - Select a Project Role to restrict visibility to only members of that role. Leave blank for no restrictions based on role.

      • Restrict to Internal (Jira Service Management only): - Only valid when using Jira Service Management. Select this option to restrict comments to internal users only.

    Add a comment to current issue

    • Add a comment to the current issue: - Select this option to add a comment to the current issue.

    • Comment (displayed only when the previous option is selected): Add - Only visible when Add a comment to the current issue is selected. Add any simple text, e.g. This is a comment. You can also use Nunjucks Nunjucks annotations in the Comment field to build dynamic text using variables. To find out more about the using variables, see Using Nunjucks Templates.

    Note that the newly created issue's key is available in the Nunjucks context as the newIssueKey variable. 

    For example : Issue {{newIssueKey}} has been created.

    • Comment visibility - Only visible when Add a comment to the current issue is selected.

      • Restrict to Group: - Select a group from the drop-down to restrict the visibility of the comment to the members of the specified group. For no restriction, leave the field blank.

      • Restrict to Project Role: - Select a project role from the drop-down to restrict the visibility of the comment to the users with selected project role. For no restriction, leave the field blank.

      • Restrict to Internal (Jira Service Desk only): - Select this option to restrict the visibility of the comment to the Service Desk Agents and Collaborators.

    • Create comment as - Only visible when Add a comment to the current issue is selected.

      • Create comment as current user: - Select this option to set the current user as the author of the comment created. This is the default value.

      • Create comment as add-on user: - Select this option to set the add-on user as the author of the comment created.

      • Create comment as this user: - Select this option to enable the associated drop-down. Select a user from the drop-down to set the specified user as the author of the comment created.created.

    Subtasks

    • Copy sub-tasks to the new issue(s) - Copy all sub-tasks of the original issue to the new issue(s). This option is disabled if Issue type, above, is set to Sub-task or Calculated.

    Note: the following fields will not be copied to the new sub-tasks:

    • created

    • timetracking

    • aggregatetimeoriginalestimate

    • aggregatetimeestimate

    • aggregateprogress

    • aggregatetimespent

    • issuekey

    • project

    • subtasks

    • thumbnail

    • updated

    • workratio

    • progress

    • worklog

    • lastViewed

    • creator

    • watches

    • votes

    • attachment

    • comment

    • timeestimate

    • timespent

    • issuelinks

    • status

    Multiple issue creation

    Use this section to create multiple issues based on the settings you provide.

    • Create multiple issues: - Select this option to create multiple issues at once. Provide an iterator script to control the number issues to be created. By default, the Create issue post-function creates one new issue.

    • Iterator (displayed only - Only visible when the previous option is selected): . Enter a Nunjucks template that must return a comma-separated list of values to iterate on. This can be either a comma-separated list of Strings, or a JSON array only if you check the "Iterator returns JSON" option. The post-function iterates over the list and creates one new issue per value. If configured, a new comment is also added to the current issue for each new issue created. also added to the current issue for each new issue created. 

    • Iterator returns JSON - Check this box if your Iterator code returns a JSON array. See Template returning a JSON array, below, for more information and examples on how to use this option.

    Template returning a comma-separated list of Strings

    If the iteration template returns: jdoe,tblack then one issue will be created with the it variable it variable containing "jdoe" and then another with the it variable it variable containing "tblack". And ifIf, in the configuration of the post-function, you are setting the "Assignee" field of the newly created issue to the following Nunjucks Template: issues using a Nunjucks Template {{it}}, then the first issue will be assigned to jdoe and the second to tblack. And the second to tblack. 

    Note: If you use the technique above to assign multiple issues, when you test the Nunjucks template the tester will return only jdoe.

    Examples:

    • Bug,Task - This will create two issues - one a Bug and the other a Task.

    • {{issue.fields["Multi-user Picker field"] | join(",","accountId")}}  - This will create one issue per user in the Multi-user Picker field.

    • {{range(1,5)}} - This will create 4 issues, with the it variable it variable containing numbers from 1 to through 4.

    Template returning a JSON array

    If the iteration template returns a JSON array, for example:
     [ {"assignee":"jdoe", "summary":"Issue for John Doe"} , {"assignee":"tblack", "summary":"Issue for Tim Black"} ] 
    and you select the

    "

    Iterator returns JSON

    "

    option, then you'll be able to use {{it.assignee}} as the value for the Assignee field, and {{it.summary}} as the value for the Summary field.

    Examples:

    • {{"jira-administrators" | groupMembers | dump }} with "Iterator returns JSON" option selected will create - Create one issue per user in the 'jira-administrators' group.

    • {{issue.fields["Multi-select field"]  | dump }} with "Iterator returns JSON" option selected will create - Create one issue per selected option in the Multi-select field.

    Post-creation script

    • Run a Nunjucks script after the issue(s) are created: - Select this option to run a Nunjucks script after each new issue is created to make additional changes to the issue, such as adding a remote link or calling an external API. In scenarios where you use this script for setting issue field values, the respective value set during issue creation is overwritten.

    • Script: Enter the - Only visible when Run a Nunjucks script after the issue(s) are created, above, is selected. Enter a Nunjucks script as needed.

    During the execution of the script, the newIssueKey variable points to the newly created issue.

    After issue creation

    Automatically navigate to the newly created issue: - Select this option to automatically navigate the user to the new issue created at the end of the transition. This is applicable only when the transition is triggered from the View Issue page. 

    This requires the "Enable View Issue Screen Actions" option on the JMWE Configuration page to be enabled.

    Note

    After the issue creation, the post-function stores some data:

    • the The key of the issue(s) it creates in an issue property jmwe.last.issue.created of the current issue (the one on which the post-function runs)  . You can retrieve it later this using the issueProperty Nunjucks filter. This can be used in other post-functions to refer to the last issue created by the Create issue post-function. If multiple issues are created, then the issue property refers to the very last issue that was created issue.

    • the The key of the original issue in an issue property jmwe-created-from of the newly created issue(s). You can retrieve it later using the issueProperty Nunjucks filter. This can be used in other post-functions to refer to the issue from which the current issue was created using the Create issue post-function. You can also , use it in the JQL searches using the syntax: issue.property[jmwe-created-from].key = TEST-123 where “TEST-123” was the key of the original issue.

    However, there are caveats about which you need to be aware of:

    • the Any post-function that reads this property needs to run after the Create Issue post-function finishes. You can ensure it by adding the order of post-functions by using a Shared action or by adding a delay; see Delayed execution, below.

    • If two users simultaneously run a transition on the same issue that creates a new issue, only the last issue created will be available in the jmwe.last.issue.created property. So this makes the feature unreliable if you're using the Create Issue post-function on multiple transitions of the same workflow.

    Run As

    Select one of the following to set the creator of the issue:

    Include Page
    [Includes] Post-function - Run As
    [Includes] Post-function - Run As

    Conditional execution

    Include Page
    [Includes] Post-function - Conditional Execution
    [Includes] Post-function - Conditional Execution

    Delayed execution

    Include Page
    [Includes] Delayed Execution
    [Includes] Delayed Execution
    Info

    JMWE shows an error message on the issue view if any error occurs during the execution of the post-function. This message is displayed only if the current user is a Jira administrator. 

    info

    You are viewing the documentation for Jira Cloud.

    On

    This Page

    this page

    Table of Contents
    minLevel1
    maxLevel2
    outlinefalse
    typelist
    printablefalse

    Create Issues Post-function Configuration ScreenImage Added