Variable replacements

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
filefile name for the last shared file added or referenced10.4
fileId file id for the last shared file added or referenced10.4
userCurrent user available from getServerInfo10.4
userIdCurrent userId available from getServerInfo 10.4
teamCurrent team available from getServerInfo10.4
teamIdCurrent teamId available from getServerInfo 10.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.  

Log a request with our support team.

Confluence®, Jira®, Atlassian Bamboo®, Bitbucket®, Fisheye®, and Atlassian Crucible® are registered trademarks of Atlassian®
Copyright © 2005 - 2024 Appfire | All rights reserved. Appfire™, the 'Apps for makers™' slogan and Bob Swift Atlassian Apps™ are all trademarks of Appfire Technologies, LLC.