Developer Portal for YouTrack and Hub Help

Action Rules

An action rule lets you extend YouTrack with actions that can be applied as commands or accessed directly from the issue toolbar.

Sample Action Rule

This rule enables a command that automatically assigns issues to the current user. This command can be applied to one or more issues at once.

const entities = require('@jetbrains/youtrack-scripting-api/entities'); exports.rule = entities.Issue.action({ title: 'Take this issue!', command: 'take', guard: (ctx) => { return ctx.issue.isReported; }, action: (ctx) => { ctx.issue.fields.Assignee = ctx.currentUser; }, requirements: { Assignee: { type: entities.User.fieldType } } });

The components that define this action rule are as follows:

  • As usual, the script starts with a require statement that references the entities module in the workflow API.

  • The exports.rule property uses the Issue.action method to export the script that follows the declaration as an action rule.

  • The body of the rule itself contains definitions for the following properties:

    Property

    Description

    title

    A human-readable title.

    The title is used as the label for the item in the list of available actions in the issue toolbar.

    If this property is not set, the list of actions shows the value from the command property.

    command

    The text that is used for the custom command.

    When this command is applied to one or more issues, the actions that are defined in this rule are executed.

    Commands are defined server-wide, which means that you cannot have two action rules with the same command even when these rules are attached to different projects.

    guard

    The condition that determines when the action rule is enabled.

    If the guard condition is not met, the custom command cannot be applied to an issue. The command is not suggested in the Apply Command dialog and its title is not visible in the issue toolbar.

    action

    The changes that should be applied to each of the issues that are selected when the command is applied. This action is executed separately for each issue. The changes are made on behalf of the user who applies the command.

    In this example, we assign all of the selected issues to the current user.

    requirements

    The list of entities that are required for the rule to execute without errors. This property ensures that rules can be attached to projects safely.

    In this example, we only require that there is an Assignee field that stores a user type in the projects to which the rule is attached. If this field is absent, an error is shown in the Workflows list. The rule cannot be enabled until the required field is attached.

Sample Action Rule with User Input

You can require additional data from the user who invokes the action rule. When such an action rule is triggered, a dialog prompts the user to provide their input.

You can distinguish action rules that require user input from other actions on the list by the ellipsis points ... after the title.

Custom action with input on the list
User input for an action rule
Custom action with input on the list
User input for an action rule

This rule enables a command that creates a copy of the selected issue in another project.

var entities = require('v1/entities'); exports.rule = entities.Issue.action({ title: 'Clone issue to another project', command: 'clone to project', action: function (ctx) { const clone = ctx.issue.copy(); clone.project = ctx.userInput; }, userInput: { type: entities.Project, description: 'Select target project' } });

The components that define this action rule are as follows:

  • The script starts with a require statement that references the entities module in the workflow API.

  • The exports.rule property uses the Issue.action method to export the script that follows the declaration as an action rule.

  • The body of the rule itself contains definitions for the following properties:

Property

Description

title

A human-readable title.

This title serves as the label for the item in the list of available actions in the issue toolbar and the title of the dialog that requests user input in YouTrack Lite.

If this property is not set, the list of actions shows the value from the command property.

command

The text that is used for the custom command.

When this command is applied to one or more issues, the actions that are defined in this rule are executed.

Commands are defined server-wide, which means that you cannot have two action rules with the same command even when these rules are attached to different projects.

action

The changes that should be applied to each of the issues that are selected when the command is applied. This action is executed separately for each issue. The changes are made on behalf of the user who applies the command.

In this example, we copy the issue to a target project selected by the user.

userInput

The input that this action rule requires from the user.

In this example, the type of the expected object is Project. For the full list of object types that you can require as user input, see Object Types Available for User Input.

In the sample rule, we also set a custom description for the user input dropdown in YouTrack Lite and for the Apply Command dialog in YouTrack Classic.

User input for an action rule
User input for an action rule

Object Types Available for User Input

Here is the complete list of object types that you can require from the user in an action rule:

  • Field.dateTimeType
  • Field.dateType
  • Field.integerType
  • Field.floatType
  • Field.periodType
  • Field.stringType
  • Build
  • EnumField
  • Issue
  • IssueTag
  • OwnedField
  • Project
  • ProjectVersion
  • User
  • UserGroup
Last modified: 20 January 2023