Actions
The Workflow Constructor supports a wide variety of predefined actions. These actions let you specify the changes that should be applied when the prerequisite criteria for running the workflow rule have been satisfied.
Define the actions to be taken by dragging one or more action blocks to the Actions section of the workflow rule.
This action verifies that specific conditions that were not included in the prerequisites block have also been met. If any of these checks fail, all changes are rolled back to the initial state and the specified error message is displayed in the user interface.
Add one or more conditions by dragging them to the body of the action block. When adding multiple conditions, each condition is automatically connected with a logical AND operator. This means that the prerequisite for running the workflow rule is only met when every condition in the Prerequisites section are met.
Use building blocks to combine conditions in different ways. To learn more, see Building Blocks.
Use the following setting to customize this action:
Setting | Description |
---|---|
Error message | Stores the message text that is shown to the user when the conditions defined in this action block are not met. |
This action sets, clears, or changes the current value for the specified field.
Use the following settings to customize this action:
Setting | Description | ||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
Issue | Specifies which issue to update. The following options are available:
| ||||||||||
Field | Specifies which field to update. The available options for this setting are restricted to the set of fields that are used in the projects to which the workflow is attached. | ||||||||||
Action | Determines which action is applied to the selected field. The following options are available:
| ||||||||||
To | Stores the value to which the field should be set. This setting is only shown when the Action is set to set, add, or remove. |
This action displays a message as an alert in the YouTrack web app. Alerts are displayed in the lower-right corner of the application user interface. They are shown for approximately five seconds and are dismissed automatically.
Use the following settings to customize this action:
Setting | Description | ||||||
---|---|---|---|---|---|---|---|
Style | Determines which style is applied to the message. The following options are available:
| ||||||
Message | Stores the alert message text. This setting also supports references to variables that are available in the current context. To browse the list of available fields, click the |
This action checks a specific field to make sure it is assigned a value. If a value for this field is not set, a message is displayed in the user interface.
warning
This action can be used for any field, including fields that are hidden behind conditions or are not configured to be required in the user interface. You should take extra care to avoid field that are hidden by a condition, as it has the potential to block users from applying updates to an issue.
Use the following settings to customize this action:
Setting | Description |
---|---|
Field | Specifies which field is required. The available options for this setting are restricted to the set of fields that are used in the projects to which the workflow is attached. |
Message | Stores the message that is shown to the user when the required field is empty. This setting also supports references to variables that are available in the current context. To browse the list of available fields, click the |
This action makes an issue visible only to a specific user or group.
Use the following settings to customize this action:
Setting | Description | ||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
Issue | Specifies which issue to update. The following options are available:
| ||||||||||
Action | Determines which action is applied to the visibility setting. The following options are available:
| ||||||||||
Visible to | Stores the user or group for which the issue visibility should be set. This setting is only shown when the Action is set to Set, Add, or Remove. The following options are available:
|
This action automatically generates an issue based on the definition that is stores in this action block.
Use the following settings to customize this action:
Setting | Description | ||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
Reporter | Determines which user is set as the reporter for the new issue. The following options are available:
| ||||||||||
Summary | Stores the summary for the new issue. This setting also supports references to variables that are available in the current context. To browse the list of available fields, click the | ||||||||||
Description | Stores the description for the new issue. This setting also supports references to variables that are available in the current context. To browse the list of available fields, click the | ||||||||||
Add field | Adds the selected field to the new issue. When used, you can select the values that are assigned to each field when the issue is created. |
This action modifies an issue description by applying the changes defined in this action block.
Use the following settings to customize this action:
Setting | Description | ||||||||
---|---|---|---|---|---|---|---|---|---|
Issue | Specifies which issue to update. The following options are available:
| ||||||||
Description | Stores the new issue description. This setting also supports references to variables that are available in the current context. To browse the list of available fields, click the To preserve the current description text, insert a reference to the description for the current issue. |
This action modifies an issue summary by applying the changes defined in this action block.
Use the following setting to customize this action:
Setting | Summary | ||||||||
---|---|---|---|---|---|---|---|---|---|
Issue | Specifies which issue to update. The following options are available:
| ||||||||
Summary | Stores the new summary text. This setting also supports references to variables that are available in the current context. To browse the list of available fields, click the To preserve the current summary text, insert a reference to the summary for the current issue. |
This action updates the issue by reassigning it to the specified project.
Use the following settings to customize this action:
Setting | Summary | ||||||||
---|---|---|---|---|---|---|---|---|---|
Issue | Specifies which issue to update. The following options are available:
| ||||||||
Project | Stores the project that the issue moves to. The following options are available:
|
This action adds an issue link from the current issue to a target issue.
Use the following settings to customize this action:
Setting | Summary | ||||||
---|---|---|---|---|---|---|---|
Target issue | Determines which issue the issue link is added to. The following options are available:
| ||||||
Link type | Determines which link type is used to represent the relationship between the linked issues. The list of available options is based on the issue link types that have been configured for your YouTrack site. |
This action adds a work item that records the time a specific user spent working on the issue.
Use the following settings to customize this action:
Setting | Summary | ||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
Issue | Determines which issue the work item is added to. The following options are available:
| ||||||||||
Work author | Determines which user is designated as the author of the work item. The following options are available:
| ||||||||||
Work date | Sets the work date for the new work item. The following options are available:
| ||||||||||
Work type | Assigns the selected work type to the new work item. When Not specified is selected, the work type is left empty. | ||||||||||
Spent time | Determines how much spent time is added to the new work item. Enter a value in standard period format. | ||||||||||
Work item description | Stores the text that is added as a description to the work item. This setting also supports references to variables that are available in the current context. To browse the list of available fields, click the |
This action adds a comment to an issue
Use the following settings to customize this action:
Setting | Summary | ||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
Issue | Determines which issue the comment is added to. The following options are available:
| ||||||||||
Comment text | Stores the text that is added as a comment to the target issue. This setting also supports references to variables that are available in the current context. To browse the list of available fields, click the | ||||||||||
Author | Determines which user is designated as the author of the comment. The following options are available:
|
This action adds a tag to an issue.
YouTrack adds the first matching tag that is visible to the user. If a match is not found, a new private tag is created.
note
Tag OwnersWhen a new tag is added to the system by a workflow, its owner is set to the YouTrack Workflow user account. All users can view the tag by default, but only its owner can use it. If you want other users to be able to remove the tag manually, you'll need to edit the tag to allow other users and groups to use it.
To learn more, see Edit Tag Settings.
Use the following settings to customize this action:
Setting | Summary | ||||||||
---|---|---|---|---|---|---|---|---|---|
Issue | Determines which issue the tag is added to. The following options are available:
| ||||||||
Tag | Stores the name of the tag that is added to the target issue. This setting also supports references to variables that are available in the current context. To browse the list of available fields, click the |
This action applies a command to an issue.
Use the following settings to customize this action:
Setting | Summary | ||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
Issue | Determines which issue the command is applied to. The following options are available:
| ||||||||||
Command | Stores the command that will be applied to the target issue. This setting also supports references to variables that are available in the current context. To browse the list of available fields, click the | ||||||||||
Run as | Determines which user account is selected to apply the command to the target issue. When choosing a user account for this setting, pay attention to the permissions that are available to the selected user. If this user doesn't have sufficient permission to apply the specified command, the updates specified in the command are ignored. The following options are available:
|
This action deletes all of the files that are attached to an issue.
Use the following settings to customize this action:
Setting | Summary | ||||||||
---|---|---|---|---|---|---|---|---|---|
Issue | Determines the issue from which all attachments are deleted. The following options are available:
|
This action creates a copy of an issue.
Use the following settings to customize this action:
Setting | Summary | ||||||||
---|---|---|---|---|---|---|---|---|---|
Issue | Determines which issue to copy. The following options are available:
| ||||||||
Project | Determines the project where the copied issue is created. The following options are available:
|
This action removes a tag from an issue.
YouTrack searches through tags owned by the specified user first, then through all other visible tags. If the specified tag is not attached to the issue, an exception is thrown.
Use the following settings to customize this action:
Setting | Summary | ||||||||
---|---|---|---|---|---|---|---|---|---|
Issue | Determines the issue from which the tag is removed. The following options are available:
| ||||||||
Tag | Stores the name of the tag to be removed from the target issue. This setting also supports references to variables that are available in the current context. To browse the list of available fields, click the |
This action sends an email message to the address that is stored in the user's profile.
Use the following settings to customize this action:
Setting | Summary | ||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
User | Determines which user is sent the email message. The following options are available:
| ||||||||||
Subject | Stores the subject of the email message. This setting also supports references to variables that are available in the current context. To browse the list of available fields, click the | ||||||||||
Message | Stores the message body of the email that is sent to the designated user. This setting also supports references to variables that are available in the current context. To browse the list of available fields, click the |
This action removes a vote from an issue on behalf of the user who added it, if this action is allowed.
Use the following settings to customize this action:
Setting | Summary | ||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
User | Determines which user is selected for removing the vote. The following options are available:
| ||||||||||
Issue | Determines the issue from which the vote is removed. The following options are available:
|
This action removes the star from an issue for a specific user.
Use the following settings to customize this action:
Setting | Summary | ||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
User | Determines which user is selected for removing the Star tag. The following options are available:
| ||||||||||
Issue | Determines the issue from which the Star tag is removed. The following options are available:
|
This action adds a vote to an issue for a specific user.
Use the following settings to customize this action:
Setting | Summary | ||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
User | Determines which user is selected for adding the vote. The following options are available:
| ||||||||||
Issue | Determines the issue to which the vote is added. The following options are available:
|
This action adds the Star tag to an issue for a specific user.
Use the following settings to customize this action:
Setting | Summary | ||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
User | Determines which user is selected for adding the Star tag. The following options are available:
| ||||||||||
Issue | Determines the issue to which the Star tag is added. The following options are available:
|
Thanks for your feedback!