Skip to end of banner
Go to start of banner

Variable replacements

Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 8 Next »

VariableReplacementSince
branchLast created or referenced branch10.0
commitLast referenced commit id10.0
commitMessageLast referenced commit message10.0
deploymentLast referenced deployment key10.0
deploymentNameLast referenced deployment name10.0
deploymentUuidLast referenced deployment UUID10.0
pullRequestLast referenced pull request id10.0
pullRequestNameLast referenced pull request name (title)10.0
projectLast created or referenced project key9.3
projectUuidLast created or referenced project UUID9.3
projectNameLast created or referenced project name9.3
pipelineLast started or referenced pipeline number10.0
pipelineStateLast referenced pipeline state10.0
pipelineResultLast referenced pipeline result10.0
pipelineUuidLast referenced pipeline UUID10.2
repositoryLast referenced repository key10.0
repositoryFullKeyLast referenced repository full key10.0
repositoryNameLast referenced repository name10.0
repositoryUuidLast referenced repository UUID10.0
userIdLast referenced user name10.0
userKeyLast referenced user key10.0
userDisplayNameLast referenced user display name10.0
userUuidLast referenced user UUID10.0
workspaceLast referenced workspace key10.0
workspaceNameLast referenced workspace name10.0
workspaceUuidLast referenced workspace UUID10.0


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.  

  • No labels