Variable replacements

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.