Documentation

Workflow actions

Validator
Post functions

Usage

Administrator authority is required to add or update workflow actions. This is required to use the CLI plugin.

Create a draft workflow
Edit the workflow
Find the workflow step
Select Validators or Post Functions tab
Select Add
Find and select CLI action

Parameter input dialog

CLI action validators and post functions share the same parameters.

Product - select the product (JIRA, Confluence, Bamboo, Crucible, FishEye) to be accessed
Action - provide an action string valid for the product selected - same as what you would do from a command line
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 -
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 ...
Find pattern2 - a second find pattern
1. Regex find groups are available as substitution variables using syntax like pattern2_1, pattern2_2, etc ...
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
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.

Category	Variables	Where Used	Discussion
Issue special values	%issue_key% %issue_summary% %issue_description% %issue_affected_versions% %issue_fixed_versions%	Action, Data, Message
Parent issue special values	%parent_key% %parent_summary% %parent_description% %parent_affected_versions% %parent_fixed_versions%	Action, Data, Message	Only available if issue is a subtask
Issue field values	%fieldname%	Action, Data, Message	Any JIRA defined field name. Like components, resolution, dueDate, id
Issue custom field values	%customfieldname%	Action, Data, Message	Issue 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%	Message	Result message from running the CLI action

Logging

Advanced logging is available to provide an audit trail and help with problem determination. It is highly recommended that logging be enabled. To enable, add the following section or similar to your log4j.properties

Add logging section to log4j.properties

# CLI action logging
log4j.appender.cliplugin=com.atlassian.jira.logging.MultiTenantJiraHomeAppender
log4j.appender.cliplugin.File=cli-plugin.log
log4j.appender.cliplugin.Threshold=INFO
log4j.appender.cliplugin.MaxFileSize=20480KB
log4j.appender.cliplugin.MaxBackupIndex=10
log4j.appender.cliplugin.layout=org.apache.log4j.PatternLayout
log4j.appender.cliplugin.layout.ConversionPattern=%d %p: %m%n

log4j.logger.org.swift.jira.acli.utilities.CliRunnerHelper.action=INFO, cliplugin
# set the following to true if you also want actions logged to the main jira log
log4j.additivity.org.swift.jira.acli.utilities.CliRunnerHelper.action=false

Example logging data

2012-07-18 07:46:24,404 INFO: 
Issue:     ZJCLIP-3
User:      admin
Context:   validator
Product:   JIRA
Action:    --action getFieldValue --issue ZJCLIP-3 --field priority --server http://imac2.local:8215 --user automation --password ***
Pattern:   value:\s+(\S+)
Pattern:   value:\s+((?:Critical)|(?:Blocker))
Result:    SUCCESS
           Issue ZJCLIP-3 has field 'priority' with value: 
Major (3)

Message:   This transition is only allowed for issues with Critical or Blocker priorities. The priority for this item is Major.