| Variable | Replacement | Since |
|---|---|---|
| project | Last created or referenced project key | 4.3 |
| projectName | Last created or referenced project name | 4.3 |
| plan | Last created or referenced plan key (2 part key) | 4.3 |
| planName | Last created or referenced plan name | 4.3 |
| stage | Last added or referenced stage name | 4.3 |
| stageId | Last referenced stage id (numeric) | 4.3 |
| job | Last added or referenced job key (1 part key) | 4.3 |
| jobName | Last added or referenced job name | 4.3 |
| build | Last queued build key | 9.0 |
| artifact | Last added artifact definition name | 4.3 |
| repository | Last added or reference repository name | 4.3 |
| repositoryId | Last added or reference repository id (numeric) | 4.3 |
| agent | Last added or reference agent name | 4.3 |
| agentId | Last referenced agent id | 4.3 |
| assignment | Last referenced agent assignment name | 6.8 |
| assignmentId | Last referenced agent assignment id | 6.8 |
| assignmentKey | Last referenced agent assignment key | 6.8 |
| trigger | Last referenced trigger name | 7.0 |
| triggerId | Last referenced trigger id (numeric) | 7.0 |
| userId | Last referenced user id | 7.4 |
| applicationLink | Last referenced application link name | 8.7 |
| applicationLinkId | Last referenced application link id | 7.7 |
| applicationLinkUrl | Last referenced application link URL | 8.7 |
| capability | Last referenced capability name | 7.9 |
| capabilityKey | Last referenced capability key | 7.9 |
| capabilityGroup | Last referenced capability group | 7.9 |
Common Client Variables
| Variable | Replacement | Since |
|---|---|---|
| entry | Entry being processed from the list parameter of the runFromList action | |
| entry2 | Entry being processed from the list2 parameter of the runFromList action | |
| renderRequest | Last result from the renderRequest action modified by findReplace processing | |
| server | Server URL available for clients accessing a remote server | 9.0 |
| hosting | Available with getServerInfo for clients accessing a remote server with server, cloud, datacenter as values | 9.3 |
| version | Available with getServerInfo for clients accessing a remote server | 9.3 |
| runDate | For run action scripts, it is the client date at the time of the first action referencing the value
| 9.0 |
| file | File path name for last get or get list action that used the file parameter | 9.3 |
| fileSize | File size for the last get or get list action that used the file parameter | 9.3 |
| fileContent | File text content for the last get or get list action that used the file parameter
| 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.
