Page tree

Contents

JSU for Jira Server

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

Description

The 'Copy Value From Other Field' post-function copies the value of one field to another field. Since JSU 2.1.0 you can configure any number of source / destination field pairs.

The copy operation will be performed either within the very same issue or to / from some related issue.

Configuration

You must specify the relation between the source and destination issues for the field to copy. Then you can add any number of field pairs to perform the copy operation.


Precondition

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

  • Ignore precondition (By default every precondition is ignored. It means that post function will be always performed)
  • 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

Issue Relation

Several of JSU's workflow modules provide the option the define the scope of the module on some related issues.
For example instead of copying a field within an issue during a post function, you might choose to copy it to a sub-task.

Types of Issue Relations

Related issue will be found by one of the following JIRA concepts:

  • Issue Link
    You can define the link type to defined which issues exactly will be affected by the operation.
    Since JSU 2.2.0, we introduced the value ANY. The operation will be performed on any linked issues.
  • Parent / Sub-Task
    The related issue is either parent or sub-task of each other.
  • Epic / Issue in Epic
    (info) This is only applicable, if you have JIRA Software installed.
    The other issue is either the epic related by an epic link, or it is part of an epic.

Issue in Transition

We use the term 'Issue in Transition' when we refer to thhe issue for which a workflow condition is checked, for which a workflow validator is examined, or for which a workflow post function is performed.

Or in other words that issue, which triggered a workflow condition / validator / post function to be executed.

Source and Destination

For example the Copy Value From Other Field Post-Function allows you to define the issue in transition as the source or destination of the copy operations, while you define the other end with an issue relation.
The field value will then be read from the source issue and be written to the destination issue.

Other workflow modules do not have source and destination. So you just define the issue relation, which will apply for that workflow module.
For example Create a Linked Issue will just create a new issue and then connect it with some Issue Relation to the issue in transition.

Restrictions

Please use some common sense what can and what cannot work.

Some examples:

  • Copy Value From Other Field Post-Function there should be only 1 source issue. Otherwise it is not clear from which the value will be read. (The current implementation will just pick one of them and ignore the rest. Which one is not defined - sort of random.)
  • If you use Create a Linked Issue to create a new sub-task, you must also configure this post function to create the new issue as an issue type of a sub-task and make sure the target project is the same as the one of the issue in transition.

Some of these restrictions are mentioned as 'must be' within the options to configure the issue relation.

We try to perform whatever is possible. In case of problems, the workflow module will still run through, but write a message into the log file. See Troubleshooting how to turn on the full logging for JSU. It might be a good idea to do this while you test any new workflow configuration to make sure you're not missing any thing.

Copy Fields

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 won't complete.

However be aware, that the version will be created, even the user does not has the 'Administer Projects' permission. (Normally a user needs that permission to be able to create a new version.)

Special 'Sources'

As source you have some additional options:

  • *** default value ***
    The default value of the destination field will be set.
  • *** empty ***
    The destination field will be cleared.
  • *** transition comment ***
    The comment, which the user entered on the transition screen.
  • *** last comment ***
    The last (most recent) comment already existing on the issue before the transition was started.

Special 'Destinations'

As destination you have some additional options:

  • *** new comment ***
    Create a new comment with the value from the source field.

Also see the note about supported field types further down.

Position of the Post Function

It is important to place the post function in the correct order of other post functions.

Create Transition

(info) The 'Create' transition is the very fist transition, which does not yet has a source status (only destination status - usually Open, but could also be another).

If you are using the "Copy Value From Other Field" post function in the Create transition, you must position it BEFORE the "Creates the issue originally." and before the "Re-index an issue to keep indexes in sync with the database." post function.

 Click here to see an example for the Create transition configuration

For certain field types (used as source or destination) "Copy Value From Other Field" has to be positioned AFTER "Creates the issue originally." but before "Re-index an issue to keep indexes in sync with the database."
Affected fields are:

  • Labels
  • Watchers
  • *** new comment ***


Exception for "Copy Value From Other Field" used on create transition to populate value from linked issues

If you are using the "Copy Value From Other Field" post function in the Create transition and you would like to copy values from linked issue (Issue Linking: Issue in Transition = Source, Issue Linking: Issue in Transition = Destination, Parent / Sub-Task, Epic / Issue in Epic)

"Copy Value From Other Field" has to be placed after Creates the issue originally. An issue has to be firstly created, then relation between these linked ticket is established and only then values will be properly copied from/to linked issue.

Any other Transition (not Create)

Put the "Copy Value From Other Field" post function anywhere before the "Update change history for an issue and store the issue in the database." post function.

Example

A workflow is configured so that the 'Resolve' transition has the 'Copy Value From Other Field' post-function. The function is configured to copy the value of the 'Assignee' field to the 'TextField' field. If a user resolves an issue on this workflow, the value of the 'Assignee' field will be copied to the 'TextField' field after the issue is resolved.

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 are supported. Also not in all combinations. We think we cover the most important field types and still are continuously adding and improving which and how different field types are supported. But the one you need, might just not (yet) work. Some custom fields of other third party app might never get supported.

For that reason you should always test anything you do with the JSU app with fields. Before you buy a license for JSU, try it with a free evaluation license, if it works for you.