Variable Replacements


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.

Reference 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 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.

Example: 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:

Example: 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


VariableReplacementSince
projectLast created, found, or referenced project key
projectIdLast created, found, or referenced project id (numeric)
projectUrlLast created, found, or referenced project URL 8.4
projectTypeLast created, found, or referenced project type (software, business, service_desk)9.5
projectStyleLast created, found, or referenced project style (classic, next-gen)9.5
issueLast created or referenced issue key (not a subtask)
issueIdLast created or referenced issue id (numeric)
issueUrlLast created or referenced issue URL8.4
subtaskLast created subtask key
subtaskIdLast created subtask id (numeric)
subtaskUrlLast created subtask URL8.4
parentLast referenced parent issue key
parentIdLast referenced parent issue id (numeric)
parentUrlLast referenced parent issue URL 8.4
cloneLast created clone issue key
cloneIdLast created clone issue id (numeric)
cloneUrlLast created clone issue URL8.4
attachmentLast created or referenced attachment name8.4
attachmentIdLast created or referenced attachment id (numeric)8.4
attachmentUrlLast created or referenced attachment URL8.4
attachmentThumbnailUrlLast created or referenced attachment thumbnail URL8.4
versionLast created or referenced version name4.5
versionIdLast created or referenced version id (numeric)4.5
componentLast created or referenced component name4.5
componentIdLast created or referenced component id (numeric)4.5
workflowLast referenced workflow name
groupLast referenced group name4.5
commentIdLast referenced comment id (numeric)5.2
commentBodyLast referenced comment body9.3
commentVisibilityTypeLast referenced comment visibility type9.3
commentVisibilityNameLast referenced comment visibility Name9.3
schemeLast created or referenced scheme name6.0 
schemeIdLast created or referenced scheme id (numeric)5.1
permissionLast added or referenced permission9.3
permissionIdLast added or referenced permissionId9.3
permissionHolderTypeLast added or referenced permission holder type9.3
permissionHolderValueLast added or referenced permission holder value9.3
permissionHolderNameLast added or referenced permission holder name9.3
screenLast referenced screen name6.0
screenIdLast referenced screen id (numeric)5.1
linkTypeLast referenced link type (runFromLinkList)6.3
linkTypeIdLast referenced link type id (runFromLinkList)6.3
linkDescriptionLast referenced link description (runFromLinkList)6.3
linkIdLast referenced link id (runFromLinkList)6.3
fromIssueLast referenced from issue from an issue link (runFromLinkList)6.3
toIssueLast referenced to issue from an issue link (runFromLinkList)6.3
categoryLast added or referenced project category name6.8
categoryIdLast added or referenced project category id (numeric)6.8
roleLast added or referenced project role name6.8
roleIdLast added or referenced project role id6.8
userIdLast created or referenced user id5.7, 9.0
userKeyLast created or referenced user key9.0
userDisplayNameLast created or referenced user display name9.0
applicationLinkLast referenced application link name8.7
applicationLinkIdLast referenced application link id (numeric)7.7
applicationLinkUrlLast referenced application link URL8.7
remoteLinkLast referenced remote link name9.3
remoteLinkIdLast referenced remote link id (numeric)9.3
remoteLinkUrlLast referenced remote link URL9.3
fieldLast added (custom field) or referenced field id 9.3
fieldNameLast referenced field name9.3
customFieldIdLast added (custom field) or referenced custom field id (numeric)9.3
customFieldTypeLast referenced custom field type9.3
<user_defined>
  1. Issue key created in one of the create actions using the reference parameter
  2. Field value in getFieldValue action using the reference parameter

Common Client Variables

VariableReplacementSince
entryEntry being processed from the list parameter of the runFromList action
entry2Entry being processed from the list2 parameter of the  runFromList action
renderRequestLast result from the renderRequest action modified by findReplace processing 
serverServer URL available for clients accessing a remote server9.0
hostingAvailable with getServerInfo for clients accessing a remote server with server, cloud, datacenter as values9.3
versionAvailable with getServerInfo for clients accessing a remote server9.3
runDate

For run action scripts, it is the client date at the time of the first action referencing the value

  • The replacement date will be exactly the same for all subsequent references for consistency across actions
  • Formatted according to current dateFormat parameter or default as usual for date fields
9.0
fileFile path name for last get or get list action that used the file parameter9.3
fileSizeFile size for the last get or get list action that used the file parameter9.3
fileContent

File text content for the last get or get list action that used the file parameter

  • limited to a file with size < 10MB
9.3

More information

  • The syntax is @<variable>@. See How to use replacement variables for more details.
  • Variable names are case-sensitive! 
  • Action help and document lists variables set by specific actions.
  • Variable replacements are different than substitution variables. Don't confuse them or their unique syntax.
  • Last created means the variable is set from the last create or add action.
  • Referenced means the variable is set from one of the runFrom or get actions.
  • Within a run script, the getReplacementVariableList action will list currently defined variables except for pre-defined variables (server, runDate).
  • Within a run script, the setReplacementVariableList action can be used to set custom variables.
  • Some actions support a reference parameter that provides an opportunity to set a custom variable based on specific information from running the action.
  • Variables are available within the scope of run action that contains the action that sets the variable or a parent run action. Sibling (runFromList scripts) variable sets are independent of each other.  


Jira Service Desk


VariableReplacementSince
projectLast created, found, or referenced project key8.8
projectIdLast created, found, or referenced project id
serviceDeskLast created or referenced service desk name
serviceDeskIdLast created or referenced service desk id
organizationLast created or referenced organization name
organizationIdLast created or referenced organization id
requestLast created or referenced request key
requestIdLast created or referenced request id


Common Client Variables

VariableReplacementSince
entryEntry being processed from the list parameter of the runFromList action
entry2Entry being processed from the list2 parameter of the  runFromList action
renderRequestLast result from the renderRequest action modified by findReplace processing 
serverServer URL available for clients accessing a remote server9.0
hostingAvailable with getServerInfo for clients accessing a remote server with server, cloud, datacenter as values9.3
versionAvailable with getServerInfo for clients accessing a remote server9.3
runDate

For run action scripts, it is the client date at the time of the first action referencing the value

  • The replacement date will be exactly the same for all subsequent references for consistency across actions
  • Formatted according to current dateFormat parameter or default as usual for date fields
9.0
fileFile path name for last get or get list action that used the file parameter9.3
fileSizeFile size for the last get or get list action that used the file parameter9.3
fileContent

File text content for the last get or get list action that used the file parameter

  • limited to a file with size < 10MB
9.3

More information

  • The syntax is @<variable>@. See How to use replacement variables for more details.
  • Variable names are case-sensitive! 
  • Action help and document lists variables set by specific actions.
  • Variable replacements are different than substitution variables. Don't confuse them or their unique syntax.
  • Last created means the variable is set from the last create or add action.
  • Referenced means the variable is set from one of the runFrom or get actions.
  • Within a run script, the getReplacementVariableList action will list currently defined variables except for pre-defined variables (server, runDate).
  • Within a run script, the setReplacementVariableList action can be used to set custom variables.
  • Some actions support a reference parameter that provides an opportunity to set a custom variable based on specific information from running the action.
  • Variables are available within the scope of run action that contains the action that sets the variable or a parent run action. Sibling (runFromList scripts) variable sets are independent of each other.  


Jira Agile


VariableReplacementSince
boardLast created, found, or referenced board name7.8
boardIdLast created, found, or referenced board id (numeric)7.8


Common Client Variables

VariableReplacementSince
entryEntry being processed from the list parameter of the runFromList action
entry2Entry being processed from the list2 parameter of the  runFromList action
renderRequestLast result from the renderRequest action modified by findReplace processing 
serverServer URL available for clients accessing a remote server9.0
hostingAvailable with getServerInfo for clients accessing a remote server with server, cloud, datacenter as values9.3
versionAvailable with getServerInfo for clients accessing a remote server9.3
runDate

For run action scripts, it is the client date at the time of the first action referencing the value

  • The replacement date will be exactly the same for all subsequent references for consistency across actions
  • Formatted according to current dateFormat parameter or default as usual for date fields
9.0
fileFile path name for last get or get list action that used the file parameter9.3
fileSizeFile size for the last get or get list action that used the file parameter9.3
fileContent

File text content for the last get or get list action that used the file parameter

  • limited to a file with size < 10MB
9.3

More information

  • The syntax is @<variable>@. See How to use replacement variables for more details.
  • Variable names are case-sensitive! 
  • Action help and document lists variables set by specific actions.
  • Variable replacements are different than substitution variables. Don't confuse them or their unique syntax.
  • Last created means the variable is set from the last create or add action.
  • Referenced means the variable is set from one of the runFrom or get actions.
  • Within a run script, the getReplacementVariableList action will list currently defined variables except for pre-defined variables (server, runDate).
  • Within a run script, the setReplacementVariableList action can be used to set custom variables.
  • Some actions support a reference parameter that provides an opportunity to set a custom variable based on specific information from running the action.
  • Variables are available within the scope of run action that contains the action that sets the variable or a parent run action. Sibling (runFromList scripts) variable sets are independent of each other.  


Jira Tempo


VariableReplacementSince
accountLast referenced account key7.3
accountIdLast referenced account id (numeric)7.3
accountNameLast referenced account name7.3
accountLinkIdLast reference account link id7.3
categoryLast reference category key7.2
categoryIdLast referenced category id (numeric)7.3
categoryNameLast referenced category name7.2
customerLast referenced customer key7.2
customerIdLast referenced customer id (numeric)7.2
customerNameLast referenced custom name 7.2
memberLast referenced member name7.2
teamLast referenced team name7.2
teamIdLast referenced team id (numeric)7.2
worklogIdLast referenced worklog id7.3


Common Client Variables

VariableReplacementSince
entryEntry being processed from the list parameter of the runFromList action
entry2Entry being processed from the list2 parameter of the  runFromList action
renderRequestLast result from the renderRequest action modified by findReplace processing 
serverServer URL available for clients accessing a remote server9.0
hostingAvailable with getServerInfo for clients accessing a remote server with server, cloud, datacenter as values9.3
versionAvailable with getServerInfo for clients accessing a remote server9.3
runDate

For run action scripts, it is the client date at the time of the first action referencing the value

  • The replacement date will be exactly the same for all subsequent references for consistency across actions
  • Formatted according to current dateFormat parameter or default as usual for date fields
9.0
fileFile path name for last get or get list action that used the file parameter9.3
fileSizeFile size for the last get or get list action that used the file parameter9.3
fileContent

File text content for the last get or get list action that used the file parameter

  • limited to a file with size < 10MB
9.3

More information

  • The syntax is @<variable>@. See How to use replacement variables for more details.
  • Variable names are case-sensitive! 
  • Action help and document lists variables set by specific actions.
  • Variable replacements are different than substitution variables. Don't confuse them or their unique syntax.
  • Last created means the variable is set from the last create or add action.
  • Referenced means the variable is set from one of the runFrom or get actions.
  • Within a run script, the getReplacementVariableList action will list currently defined variables except for pre-defined variables (server, runDate).
  • Within a run script, the setReplacementVariableList action can be used to set custom variables.
  • Some actions support a reference parameter that provides an opportunity to set a custom variable based on specific information from running the action.
  • Variables are available within the scope of run action that contains the action that sets the variable or a parent run action. Sibling (runFromList scripts) variable sets are independent of each other.  


Confluence


VariableReplacementSince
pageIdLast created or referenced page id (numeric)
pageUrlLast created or referenced page url
blogIdLast created blog id (numeric)
blogUrlLast created or referenced blog url
contentIdLast referenced content id (numeric)5.3
contentUrlLast referenced content URL
containerIdLast referenced container id (numeric)9.2
spaceLast created or referenced space key
spaceNameLast created or reference space name5.2
spaceUrlLast created or referenced space URL8.4
titleLast created referenced title
attachmentLast created or referenced attachment name
attachmentIdLast created or referenced attachment id (numeric)
attachmentUrlLast created or referenced attachment URL8.4
userIdLast created or referenced user id5.7, 9.0
userKeyLast created or referenced user key8.6, 9.0
userDisplayNameLast created or referenced user display name9.0
questionLast created or referenced question
questionIdLast created or reference question id (numeric)
topicLast created or referenced topic
topicIdLast created or referenced topic id (numeric)
storageFormatConverted data from last convertToStorageFormat
contentContent source from last getPageSource6.3
commentIdLast referenced comment id on runFromCommentList6.6
groupLast referenced group name6.9
shortcutLast created or referenced shortcut name7.0
shortcutIdLast created or referenced shortcut id (numeric)7.0
shortcutUrlLast referenced shortcut URL8.4
applicationLinkLast referenced application link name8.7
applicationLinkIdLast referenced application link id7.7
applicationLinkUrlLast referenced application link URL8.7


Common Client Variables

VariableReplacementSince
entryEntry being processed from the list parameter of the runFromList action
entry2Entry being processed from the list2 parameter of the  runFromList action
renderRequestLast result from the renderRequest action modified by findReplace processing 
serverServer URL available for clients accessing a remote server9.0
hostingAvailable with getServerInfo for clients accessing a remote server with server, cloud, datacenter as values9.3
versionAvailable with getServerInfo for clients accessing a remote server9.3
runDate

For run action scripts, it is the client date at the time of the first action referencing the value

  • The replacement date will be exactly the same for all subsequent references for consistency across actions
  • Formatted according to current dateFormat parameter or default as usual for date fields
9.0
fileFile path name for last get or get list action that used the file parameter9.3
fileSizeFile size for the last get or get list action that used the file parameter9.3
fileContent

File text content for the last get or get list action that used the file parameter

  • limited to a file with size < 10MB
9.3

More information

  • The syntax is @<variable>@. See How to use replacement variables for more details.
  • Variable names are case-sensitive! 
  • Action help and document lists variables set by specific actions.
  • Variable replacements are different than substitution variables. Don't confuse them or their unique syntax.
  • Last created means the variable is set from the last create or add action.
  • Referenced means the variable is set from one of the runFrom or get actions.
  • Within a run script, the getReplacementVariableList action will list currently defined variables except for pre-defined variables (server, runDate).
  • Within a run script, the setReplacementVariableList action can be used to set custom variables.
  • Some actions support a reference parameter that provides an opportunity to set a custom variable based on specific information from running the action.
  • Variables are available within the scope of run action that contains the action that sets the variable or a parent run action. Sibling (runFromList scripts) variable sets are independent of each other.  


Slack


VariableReplacementSince
channelChannel name added or referenced
channelIdChannel id added or referenced
messageIdMessage id for last sendMessage action or referenced message9.5
messageIdListComma separated list of message ids for last sendMessage action. Only differs from messageId when autoSplit is used and multiple messages needed to be sent to complete the request. 9.5


Common Client Variables

VariableReplacementSince
entryEntry being processed from the list parameter of the runFromList action
entry2Entry being processed from the list2 parameter of the  runFromList action
renderRequestLast result from the renderRequest action modified by findReplace processing 
serverServer URL available for clients accessing a remote server9.0
hostingAvailable with getServerInfo for clients accessing a remote server with server, cloud, datacenter as values9.3
versionAvailable with getServerInfo for clients accessing a remote server9.3
runDate

For run action scripts, it is the client date at the time of the first action referencing the value

  • The replacement date will be exactly the same for all subsequent references for consistency across actions
  • Formatted according to current dateFormat parameter or default as usual for date fields
9.0
fileFile path name for last get or get list action that used the file parameter9.3
fileSizeFile size for the last get or get list action that used the file parameter9.3
fileContent

File text content for the last get or get list action that used the file parameter

  • limited to a file with size < 10MB
9.3

More information

  • The syntax is @<variable>@. See How to use replacement variables for more details.
  • Variable names are case-sensitive! 
  • Action help and document lists variables set by specific actions.
  • Variable replacements are different than substitution variables. Don't confuse them or their unique syntax.
  • Last created means the variable is set from the last create or add action.
  • Referenced means the variable is set from one of the runFrom or get actions.
  • Within a run script, the getReplacementVariableList action will list currently defined variables except for pre-defined variables (server, runDate).
  • Within a run script, the setReplacementVariableList action can be used to set custom variables.
  • Some actions support a reference parameter that provides an opportunity to set a custom variable based on specific information from running the action.
  • Variables are available within the scope of run action that contains the action that sets the variable or a parent run action. Sibling (runFromList scripts) variable sets are independent of each other.  


Trello


VariableReplacementSince
boardLast added or referenced board
boardIdLast added or referenced board id
boardUrlLast added or referenced board URL8.4
teamLast added or referenced team 
teamIdLast added or referenced team id
teamUrlLast added or referenced team URL8.4
memberLast referenced team member 
memberIdLast referenced team member id
memberUrlLast referenced team member URL8.4


Common Client Variables

VariableReplacementSince
entryEntry being processed from the list parameter of the runFromList action
entry2Entry being processed from the list2 parameter of the  runFromList action
renderRequestLast result from the renderRequest action modified by findReplace processing 
serverServer URL available for clients accessing a remote server9.0
hostingAvailable with getServerInfo for clients accessing a remote server with server, cloud, datacenter as values9.3
versionAvailable with getServerInfo for clients accessing a remote server9.3
runDate

For run action scripts, it is the client date at the time of the first action referencing the value

  • The replacement date will be exactly the same for all subsequent references for consistency across actions
  • Formatted according to current dateFormat parameter or default as usual for date fields
9.0
fileFile path name for last get or get list action that used the file parameter9.3
fileSizeFile size for the last get or get list action that used the file parameter9.3
fileContent

File text content for the last get or get list action that used the file parameter

  • limited to a file with size < 10MB
9.3

More information

  • The syntax is @<variable>@. See How to use replacement variables for more details.
  • Variable names are case-sensitive! 
  • Action help and document lists variables set by specific actions.
  • Variable replacements are different than substitution variables. Don't confuse them or their unique syntax.
  • Last created means the variable is set from the last create or add action.
  • Referenced means the variable is set from one of the runFrom or get actions.
  • Within a run script, the getReplacementVariableList action will list currently defined variables except for pre-defined variables (server, runDate).
  • Within a run script, the setReplacementVariableList action can be used to set custom variables.
  • Some actions support a reference parameter that provides an opportunity to set a custom variable based on specific information from running the action.
  • Variables are available within the scope of run action that contains the action that sets the variable or a parent run action. Sibling (runFromList scripts) variable sets are independent of each other.  


Bitbucket


VariableReplacementSince
projectLast created or referenced project key
projectIdLast created or referenced project id (numeric)
projectUrlLast created or referenced project URL8.4
repositoryLast created or referenced repository slug
repositoryIdLast created or referenced repository id (numeric)
repositoryUrlLast created or reference repository URL8.4
repositoryNameLast created or referenced repository name8.4
repositoryUrlLast created or referenced repository URL8.4
pullRequestLast created or referenced pull request name
pullRequestIdLast created or referenced pull request id (numeric)
pullRequestUrlLast created or referenced pull request URL8.4
branchLast created or referenced branch name
branchIdLast created or referenced branch id (numeric)
restrictionLast reference branch restriction type
restrictionIdLast created or referenced branch restriction id
matchingTypeLast referenced branch restriction matching type
matchingIdLast referenced branch restriction matching id
commitIdLast referenced commit id
commitAuthorIdLast reference commit author id
sshKeyIdLast created SSH key id (numeric)
groupLast reference group name
userIdLast referenced user id9.3
userKeyLast referenced user key (numeric id)9.3
userDisplayNameLast referenced user display name9.3
applicationLinkLast referenced application link name8.7
applicationLinkIdLast referenced application link id7.7
applicationLinkUrlLast referenced application link URL8.7
pathLast referenced path9.8
pathIdLast referenced path id9.8
revisionLast referenced revision9.8
typeLast referenced file type (FILE or DIRECTORY)9.8
downloadUrlLast referenced download url 9.8


Common Client Variables

VariableReplacementSince
entryEntry being processed from the list parameter of the runFromList action
entry2Entry being processed from the list2 parameter of the  runFromList action
renderRequestLast result from the renderRequest action modified by findReplace processing 
serverServer URL available for clients accessing a remote server9.0
hostingAvailable with getServerInfo for clients accessing a remote server with server, cloud, datacenter as values9.3
versionAvailable with getServerInfo for clients accessing a remote server9.3
runDate

For run action scripts, it is the client date at the time of the first action referencing the value

  • The replacement date will be exactly the same for all subsequent references for consistency across actions
  • Formatted according to current dateFormat parameter or default as usual for date fields
9.0
fileFile path name for last get or get list action that used the file parameter9.3
fileSizeFile size for the last get or get list action that used the file parameter9.3
fileContent

File text content for the last get or get list action that used the file parameter

  • limited to a file with size < 10MB
9.3

More information

  • The syntax is @<variable>@. See How to use replacement variables for more details.
  • Variable names are case-sensitive! 
  • Action help and document lists variables set by specific actions.
  • Variable replacements are different than substitution variables. Don't confuse them or their unique syntax.
  • Last created means the variable is set from the last create or add action.
  • Referenced means the variable is set from one of the runFrom or get actions.
  • Within a run script, the getReplacementVariableList action will list currently defined variables except for pre-defined variables (server, runDate).
  • Within a run script, the setReplacementVariableList action can be used to set custom variables.
  • Some actions support a reference parameter that provides an opportunity to set a custom variable based on specific information from running the action.
  • Variables are available within the scope of run action that contains the action that sets the variable or a parent run action. Sibling (runFromList scripts) variable sets are independent of each other.  


Bitbucket Cloud


VariableReplacementSince
projectLast created or referenced project key9.3
projectUuidLast created or referenced project UUID9.3
projectNameLast created or referenced project name9.3


Common Client Variables

VariableReplacementSince
entryEntry being processed from the list parameter of the runFromList action
entry2Entry being processed from the list2 parameter of the  runFromList action
renderRequestLast result from the renderRequest action modified by findReplace processing 
serverServer URL available for clients accessing a remote server9.0
hostingAvailable with getServerInfo for clients accessing a remote server with server, cloud, datacenter as values9.3
versionAvailable with getServerInfo for clients accessing a remote server9.3
runDate

For run action scripts, it is the client date at the time of the first action referencing the value

  • The replacement date will be exactly the same for all subsequent references for consistency across actions
  • Formatted according to current dateFormat parameter or default as usual for date fields
9.0
fileFile path name for last get or get list action that used the file parameter9.3
fileSizeFile size for the last get or get list action that used the file parameter9.3
fileContent

File text content for the last get or get list action that used the file parameter

  • limited to a file with size < 10MB
9.3

More information

  • The syntax is @<variable>@. See How to use replacement variables for more details.
  • Variable names are case-sensitive! 
  • Action help and document lists variables set by specific actions.
  • Variable replacements are different than substitution variables. Don't confuse them or their unique syntax.
  • Last created means the variable is set from the last create or add action.
  • Referenced means the variable is set from one of the runFrom or get actions.
  • Within a run script, the getReplacementVariableList action will list currently defined variables except for pre-defined variables (server, runDate).
  • Within a run script, the setReplacementVariableList action can be used to set custom variables.
  • Some actions support a reference parameter that provides an opportunity to set a custom variable based on specific information from running the action.
  • Variables are available within the scope of run action that contains the action that sets the variable or a parent run action. Sibling (runFromList scripts) variable sets are independent of each other.  


Bamboo


VariableReplacementSince
projectLast created or referenced project key4.3
projectNameLast created or referenced project name4.3 
planLast created or referenced plan key (2 part key)4.3 
planShortKeyLast created or reference plan short key (1 part key)9.8
planNameLast created or referenced plan name4.3 
stageLast added or referenced stage name4.3 
stageIdLast referenced stage id (numeric)4.3 
jobLast added or referenced job key (1 part key)4.3 
jobNameLast added or referenced job name4.3 
buildLast referenced or queued build key9.0
buildNumberLast referenced or queued build number9.3
buildStateLast referenced or queued (with wait) build state9.3
artifactLast added artifact definition name4.3 
repositoryLast added or reference repository name4.3 
repositoryIdLast added or reference repository id (numeric)4.3 
agentLast added or reference agent name4.3 
agentIdLast referenced agent id4.3 
assignmentLast referenced agent assignment name6.8
assignmentIdLast referenced agent assignment id6.8
assignmentKeyLast referenced agent assignment key6.8
triggerLast referenced trigger name7.0
triggerIdLast referenced trigger id (numeric)7.0
userIdLast referenced user id7.4
applicationLinkLast referenced application link name8.7
applicationLinkIdLast referenced application link id7.7
applicationLinkUrlLast referenced application link URL8.7
capabilityLast referenced capability name7.9
capabilityKeyLast referenced capability key7.9
capabilityGroupLast referenced capability group7.9


Common Client Variables

VariableReplacementSince
entryEntry being processed from the list parameter of the runFromList action
entry2Entry being processed from the list2 parameter of the  runFromList action
renderRequestLast result from the renderRequest action modified by findReplace processing 
serverServer URL available for clients accessing a remote server9.0
hostingAvailable with getServerInfo for clients accessing a remote server with server, cloud, datacenter as values9.3
versionAvailable with getServerInfo for clients accessing a remote server9.3
runDate

For run action scripts, it is the client date at the time of the first action referencing the value

  • The replacement date will be exactly the same for all subsequent references for consistency across actions
  • Formatted according to current dateFormat parameter or default as usual for date fields
9.0
fileFile path name for last get or get list action that used the file parameter9.3
fileSizeFile size for the last get or get list action that used the file parameter9.3
fileContent

File text content for the last get or get list action that used the file parameter

  • limited to a file with size < 10MB
9.3

More information

  • The syntax is @<variable>@. See How to use replacement variables for more details.
  • Variable names are case-sensitive! 
  • Action help and document lists variables set by specific actions.
  • Variable replacements are different than substitution variables. Don't confuse them or their unique syntax.
  • Last created means the variable is set from the last create or add action.
  • Referenced means the variable is set from one of the runFrom or get actions.
  • Within a run script, the getReplacementVariableList action will list currently defined variables except for pre-defined variables (server, runDate).
  • Within a run script, the setReplacementVariableList action can be used to set custom variables.
  • Some actions support a reference parameter that provides an opportunity to set a custom variable based on specific information from running the action.
  • Variables are available within the scope of run action that contains the action that sets the variable or a parent run action. Sibling (runFromList scripts) variable sets are independent of each other.