Versions Compared

Key

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

A workflow post function that clears the value of one or more fields of adds to the Worklog for the current issue or issues related to the current issue.

When you add this post function to a transition and trigger it, the add-on clears the selected field(s) of the target issuesadds to the Worklog for the issue using a script to determine the amount to add.

To add the 'Clear fieldsLog Work' post - function to a transition:

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

  2. In the Workflow Designer, select the transition.

  3. Click Post Functions in the properties panel.

  4. Click Add post function.

  5. Select Clear fields Log Work from the list of post functionfunctions.

  6. Click Add to navigate to the Clear fields Log Work post-function screen where you can add configuration details. See below for more information.

  7. Click on  Add to add the post function to the transition. 

Info

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

Issue(s) to operate on

Select the issues on which the selected fields should be cleared. They can be:

  • Target issues

    • Current issue: Select this option to set the assignee of the current issue. This is the default option.

    • Sub-tasks of the current issue: Select this option to set the assignee of sub-tasks of the current issue

    • Parent issue of the current sub-task: Select this option to set the assignee of the parent of the current issue

    • Issues that belong to the current issue (Epic): Select this option to set the assignee of issues that belongs to the current Epic

    • Epic of the current issue: Select this option to set the assignee of the Epic of the current issue

    • Child issues of the current issue in the Portfolio hierarchy: Select this option to set the assignee of child issues of the current issue in the Portfolio hierarchy

    • Parent issue of the current issue in the Portfolio hierarchy: Select this option to set the assignee of the parent issue of the current issue in the Portfolio hierarchy

    • Issues linked to the current issue through any link type: Select this option to set the assignee of the current issues' linked issues

    • Issues linked to the current issue through the following link type: Select this option to set the assignee of issues linked to the current issue through a specific link type. Select the specific link type under “Issue link”

    • Issues returned by the following Nunjucks template: Select this option to set the assignee of the issues returned by the result of a Nunjucks template. Input a Nunjucks template which is a comma-separated list of valid issue keys. For example:

      • "TEST-1"

      • "TEST-1","TEST-2"

      • {{ issue.fields.parent.key }}

      • {{ issue.fields.subtasks | join(",", "key") }}

    • Issues returned by a JQL search: Select this option to set the assignee of the issues returned by a JQL search. Input a JQL search expression. For example:

      • project = TEST returns issues of the project with the key TEST

      • project = {{ issue.fields.project.key }} and assignee = {{currentUser._accountId}} returns issues of a project that belong to the project with key TEST and the assignee is the current user

      • Code Block
        {% if issue.fields.assignee %}
            assignee = {{issue.fields.assignee._accountId}}
        {% else %}
            issuekey=INVALID-1
        {% endif %}

        Note that the {% if %} block is necessary to avoid an invalid JQL query when the issue is unassigned. In that case, the template will return a valid JQL query that returns no issue (issuekey=INVALID-1).

  • Issue Link - Only available when Target issues, above, is set to Issues linked to the current issue through the following link type. Select the required link type between the current issue and the issue to be updated.

  • Nunjucks template - Only available when Target issues, above, is set to Issues returned by the following Nunjucks template. Enter a Groovy script that returns the ID values for the issue or issues to be updated. See Using Nunjucks Templates for more information on Nunjucks.

  • JQL expression - Only available when Target issues, above, is set to Issues returned by the following JQL search. Enter a JQL expression that returns the ID values for the issue or issues to be updated. See Using Jira Expressions for more information on JQL.

Fields to clear

Select the field or fields to be cleared using the Fields pulldown menu; multiple fields can be selected, and all selected fields will be listed in the configuration field. Use the X beside a field name to remove it from the list

Time spent

Enter a Nunjucks script that returns the amount of time to add to the Worklog. The script should return either a number of seconds or a string in the format ‘2w 3d 5h 10m 30s’.

Start date and time

Select the start time for the worklog entry. The available options are:

  • Now

  • Current time minus time spent

  • Custom

Additionally, you can set the following options related to the start date and time:

  • Script - Only available when Start time, above, is set to Custom. Enter a Nunjucks script that returns the date and time that should be used for the worklog.

  • Adjust remaining estimate - This option will apply the logged time to the issue’s estimate and decrease the Remaining Estimate value.

Work description

This configuration is optional. Enter a Nunjucks script that returns the description to add to the worklog entry.

Advanced options

Expand this section to see advanced configurations including which user will run the post function, conditional execution, and delayed execution.

Run As

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

Notifications

Check the box Allow Jira to send notifications for this change if you want to have a notification sent when the post function adds the worklog entry.

You are viewing the documentation for Jira Cloud.

On This Page

Table of Contents
minLevel1
maxLevel2
outlinefalse
typelist
printablefalse
Clear fields post function configuration screenImage RemovedpostFunction-LogWork.pngImage Added