Edit workflow

1. Edit the workflow
2. Find the workflow step
3. Select Validators or Post Functions tab
4. Select Add
5. Find and select CLI action

Parameter input dialog

CLI action validators and post functions share the same parameters.

1. Product - select the product (JIRA, Confluence, Bamboo, Crucible, FishEye) to be accessed
2. Action - provide an action string valid for the product selected - same as what you would do from a command line
3. Data - some CLI actions can input data from standard input or using the file parameter and this allows the input data to be provided directly
   
   1. When using the file parameter, specify to use standard input: file -
4. Find pattern1 - A regex pattern that is used to find data on the result produced by running the CLI action
   
   1. For a validator, if the pattern is not found, the validator will fail
   2. Regex find groups are available as substitution variables using syntax like pattern1_1, pattern1_2, etc ...
5. Find pattern2 - a second find pattern
   
   1. Regex find groups are available as substitution variables using syntax like pattern2_1, pattern2_2, etc ...
6. Message - Validator error message and workflow property value
   
   1. If validator fails (action fails or one of the find patterns do not match), this error message will be shown as a transition error
   2. Use text and substitution variables to construct a reasonable message
   3. For both validators and post functions, this message is passed as a workflow property for access in subsequent CLI actions
7. Notes - This provides administrators an opportunity to better document this workflow function

Variable substitution

A variety of substitution variables are available to use in text parameters.

Image Removed

Image Removed

Image Removed

Workflow functions

There are 2 primary ways to use this add-on.

1. Workflow post function to run CLI actions on a transition - see CLI Post Function and CLI Validator

2. Administrator UI for running CLI actions directly - see Administrator UI to Run CLI Actions

Related documentation

• Action Reference - find product specific actions that you can run as part of the transition

Logging

Setting up advanced logging is highly recommended. See How to add advanced logging.

Security

CLI actions require user credentials to access Atlassian servers.  Those credentials must be provided on the action, there isn't currently any way to avoid that even with Application links. Consider setting up an automation account for CLI automation use.

Limitations

Actions like updateIssue and setFieldValue should not be used to update system fields if they reference the issue being transitioned. Instead, use post functions that are available for those specific functions directly. See JCLIP-19 for more information.