Atlassian uses cookies to improve your browsing experience, perform analytics and research, and conduct advertising. Accept all cookies to indicate that you agree to our use of cookies on your device. Atlassian cookies and tracking notice, (opens new window)
Teams
, (opens new window)

Run CLI Actions in Jira
Results will update as you type.
  • User's Guide
    • Get Started
    • CLI Post Function and CLI Validator
    • Administrator UI to Run CLI Actions
    • Substitution variables
    • Terminology
    • Tips
    • How to
    • Example of a CLI Validator
    • Custom Field Types
  • Administrator's Guide
    Calendars
You‘re viewing this with anonymous access, so some content might be blocked.
/
CLI Post Function and CLI Validator

CLI Post Function and CLI Validator

Dec 02, 2022

Workflow functions

  1. CLI action (validator) - check information from a CLI action before allowing a transition
  2. CLI action (post-function) - run a CLI action after the transition has completed

Both share similar parameters and capabilities.

Related documentation

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

Usage

Administrator authority is required to add or update workflow actions. This is required to use Run CLI Actions in Jira. 

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

Parameter input dialog

CLI action validators and post functions share the same parameters.

 


Variable substitution

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

CategoryVariablesWhere UsedDiscussion
Issue special values

%issue_key%

%issue_summary%

%issue_description%

%issue_affected_versions%

%issue_fixed_versions%

%project%

Action, Data, Message


Parent issue special values

%parent_key%

%parent_summary%

%parent_description%

%parent_affected_versions%

%parent_fixed_versions%

Action, Data, MessageOnly available if issue is a subtask
Issue field values%fieldname%Action, Data, Message

Any JIRA defined field name.

Like summary, description, environment, issueType, priority, resolution, versions, fixVersions, components, duedate, reporter, assignee, timetracking, id

Issue custom field values%customfieldname%Action, Data, MessageIssue specific custom field name
CLI values

%base_url%

%validator_message%

%function_message%

Action, Data, Message

URL of this JIRA instance - useful for local JIRA actions

Message field from last run CLI action validator

Message field from last run CLI post function

Action result%cli_message%MessageResult message from running the CLI action
Pattern replacements

%pattern1_n%

%pattern2_n%

Message

Regex group value from evaluating find pattern1 or pattern2.

n represents the regex group number (1, 2, ...) - equivalent of $n substitution in other regex based usage.



, multiple selections available,

Need support? Create a request with our support team.

Copyright © 2005 - 2025 Appfire | All rights reserved.

{"serverDuration": 15, "requestCorrelationId": "a926749aabd64964befec13fb60b2012"}