Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

idProductTOC

On this page

P
Table of Contents
maxLevel1
typeflat
separatorpipe

Description

When running a series of actions using one of the run actions (like run, runFromList, runFromSql, runFromCsv, or a client specific run action), it may be necessary to have a variable reference to information that is generated as a result of actions chosen. This page describes how that works. The specific variables that are available depend on the actions run and the release version of the client. Later versions have expanded on the variables available and new requirements will lead to additional variables. Raise an issue if a new variable is needed or there are actions that could set variables that currently do not.

Tip
titleReference parameter

Variable references always refer to the last referenced value. For more complex scripting needs, the reference parameter provides a way to remember a specific value even after it may be updated with an similar actions that followed the original action. For example remembering a Jira issue key needed for issue linking.

Details

Prior to the action being run, certain substitutions are done on the text. The syntax is @<variable>@. A simple example is @entry@ being replaced with the list entry on the runFromList action.

No Format
titleExample: runFromList
jira --action runFromList --list PROJECTA,PROJECTB --common '--action getProject --project @entry@'

Other variables that are available are generally client specific variables. Here is a Jira example:

No Format
titleExample: runFromProjectList
jira --action runFromProjectList --common '--action getProject --project @project@'

In some cases, the running of client specific actions produce variables replacements that can be used in subsequent actions. How to create projects or sets of issues based on a template provides an example of this.

...

Jira

...

Jira Service Desk

...

Jira Agile

...

Jira Tempo

...

Confluence

...

Slack

...

Trello

...

Bitbucket

...

Bitbucket Cloud

...

Bamboo

...

Include Page
SUPPORTS:How to use replacement variables
SUPPORTS:How to use replacement variables