Page tree

Contents

JSU for Jira Cloud

This is the documentation of JSU for Jira Cloud. If you are using JSU on Jira Server or on Jira Data Center, you can find the documentation here.

Description

This post function will create a new issue. The new issue will be linked to the origin issue (the one, which triggered the 'Create a Linked Issue' post function).

Any number of fields can be copied to the new issue and within the origin issue.

See the Testing and Fixing Bugs use case for an example how several of our customers are using this post function. The video on that page shows you the following sample configuration in action.

Configuration

Precondition

There are several ways in which preconditions can be evaluated in the context of a post function:

  • True (Precondition must be true to execute a post function)
  • False (Precondition must be false to execute a post function)


You can find more generic description of precondition here


Initial Mandatory Values for the new Issue

Here you must configure some always mandatory fields for an issue. These are some real basic field of Jira. Be aware that your Jira configuration might have additional required fields (you should set them all by Copy Field Section) .

Additionally the summary will always be copied from the origin issue to the new issue. The reporter of the new issue will always be set to the user who triggered the current transition (and thus this post function). However you might overwrite them again later with Copy from the Origin Issue to the New Issue

Target Project

Target Project can be set to:

Inside same project

A new issue will be created in this same project

Selected Project

A new issue will be created in the selected project.

This Issue will be related via

Since JSU Cloud 1.1.0 The Create a Linked Issue post function allows you the create new issues, which are connected not only with an issue link, but instead also in a parent / sub-task, as well as epic / issue in epic relation.

See Releated Issues for more explanations on this topic (especially for creating sub-tasks).

Perform As User

If you don't specify anything here, the transition on the related will be performed with the same user who triggered this post function on the origin issue. Thus, that user must have the necessary permissions on the related issue.

However, in some restrictive setup, that user might not be allowed to do so on the related issue. He might not even see the project of the related issue!

With 'Perform As User', you can specify a different user account who has been granted the necessary permissions. Usually this user account is assumed to be only technical (impersonation), with broad permissions, and not used to log into Jira by any coworkers. 

In combination with the Permission Condition in native Jira, or the User Is In Any Users Condition from JSU, you can hide a transition from all users that do not have the permission to execute it.

Issue Type

A new issue type will have a particular issue type.

Be aware, that the issue type you configure here must be available in the target project.

Copy Field the Origin Issue to the New Issue

You can copy the value form some source field to some destination field. Click the + Button to add additional field pairs to your configuration.

Keep in mind that not all conversions from source to destination field are supported, nor feasible. We can only ensure, that it will work if source and destination fields are of the same field type, or the destination field is a text field. (Still, some additional combinations of different field types might work as well - although not 'officially' supported.)

Overwrite / Append / Prepend

For text fields and some field that can take multiple values (like checkboxes) you can choose to overwrite, append or prepend the new value to any existing value. In the case of text field, you can also choose a separator that will be put between the values (not shown in the screen shot above).

Create version if necessary

Imagine your origin issue has a version, that you want to copy to the linked issue.

If the destination field is 'Fix Version/s', 'Affects Version/s' or some custom field of type 'Version Picker', you can choose that a new version will be created in the target project, if does not yet exist. If you don't choose this option and that version does not yet exist, the user will get an error message and the transition will complete.

However be aware, that a user needs the 'Administer Projects' permission to be able to create a new version.

Create component if necessary

Imagine your origin issue has a component, that you want to copy to the linked issue.

If the destination field is 'Components', you can choose that a new component will be created in the target project, if does not yet exist. If you don't choose this option and that component does not yet exist, the user will get an error message and the transition will complete.

However be aware, that a user needs the 'Administer Projects' permission to be able to create a new component.

Special 'Sources'

As source you have some additional options:

  • *** empty ***
    The destination field will be cleared.
  • *** last comment ***
    The last comment from the source issue will be copied.
    In some cases that might be the comment from the transition screen, which the user just entered while performing the current transition.

Special 'Destinations'

As destination you have also special options:

  • *** new comment ***
    A new comment will be created with the copied value.

Copy Within The Origin Issue 

You can copy the value form some source field to some destination field. Click the + Button to add additional field pairs to your configuration.

Keep in mind that not all conversions from source to destination field are supported, nor feasible. We can only ensure, that it will work if source and destination fields are of the same field type, or the destination field is a text field. (Still, some additional combinations of different field types might work as well - although not 'officially' supported.)

Overwrite / Append / Prepend

For text fields and some field that can take multiple values (like checkboxes) you can choose to overwrite, append or prepend the new value to any existing value. In the case of text field, you can also choose a separator that will be put between the values (not shown in the screen shot above).

Create version if necessary

Imagine your origin issue has a version, that you want to copy to the linked issue.

If the destination field is 'Fix Version/s', 'Affects Version/s' or some custom field of type 'Version Picker', you can choose that a new version will be created in the target project, if does not yet exist. If you don't choose this option and that version does not yet exist, the user will get an error message and the transition will complete.

However be aware, that a user needs the 'Administer Projects' permission to be able to create a new version.

Create component if necessary

Imagine your origin issue has a component, that you want to copy to the linked issue.

If the destination field is 'Components', you can choose that a new component will be created in the target project, if does not yet exist. If you don't choose this option and that component does not yet exist, the user will get an error message and the transition will complete.

However be aware, that a user needs the 'Administer Projects' permission to be able to create a new component.

Special 'Sources'

As source you have some additional options:

  • *** empty ***
    The destination field will be cleared.
  • *** last comment ***
    The last comment from the source issue will be copied.
    In some cases that might be the comment from the transition screen, which the user just entered while performing the current transition.

Special 'Destinations'

As destination you have also special options:

  • *** new comment ***
    A new comment will be created with the copied value.

Asynchronous Execution

There is a fundamental differences between Jira Server/Data Center and Jira Cloud: In Jira Cloud post functions of apps are executed asynchronous as a 'background job'.

  • This means a post function will be executed after the transition has completed on Jira Cloud.
  • There is no guaranteed order in which several post functions are performed. They might be executed in a different order than the one you had set them up in Jira's workflow configuration. So you cannot rely on any result of a 'previous' post function. The order how the post functions are executed might be different every time the transition is performed.
  • When a post function has a problem (due to misconfiguration or the current data of a Jira issue), the transition (and all other post functions) will be performed nevertheless.
  • The result of a post function might not be visible immediately in the browser.
  • There are no error messages displayed to the user.

Example

See the Use Case Testing and Fixing Bugs for a nice example, how several of our customers use it. The video on that page shows you the following sample configuration in action.

Supported Field Types

In its different modules (especially those for workflows), the JSU app supports many different field types. System fields, as well as custom fields.

However you should be aware, that not all field types or all combinations are supported. We think we cover the most important field types and are still continuously adding and improving which, and how different field types are supported. But the one you need might not work (yet). 

We recommend that you test JSU with fields to see if it is compatible with your system. Our evaluation license gives you 30 days free trial.