A Summary of the naming conventions used in previous, dependent posts

Variable Naming Summary

Although minimizing global variables (aka Data Elements) is a best practice, there are situations where this is unavoidable. By using a variable naming convention, you can manage your local and global variables depending upon their data type and purpose. As seen in a previous post, there are four types of global variables – Agent, Project, Default and a required global for variable re-use within various Jitterbit components or functions. (Cloud cached variables are a unique exception so only mentioned earlier) By using a naming convention for different variable types or purpose, the alphabetic sorting, and filtering when examining Jitterbit Data Elements in the Formula Builder allow you to find and manage your appropriate variable names by their type/purpose. I’ve offered some Local and Global variable naming conventions that can help with understanding the variable nature and intention, but you don’t have to follow or use these specific conventions. Here are the few suggestions in other posts, summarized in tables.

Scope vs. Type
CSV Array Dictionary DateTime
Local Lvalues Avalues valuesbykey
Global $Lvalues $Avalues $valuesByKey $:datetime

 

Some contexts where suggested variables used by purpose.

Variable Purpose Context
Script Transform Map Operation I/O
Status $?status $?status $?status
Counter $#counter $#counter
Input _name $_OpIname
Output $%OpOname
Message $`OpMsgName $`OpMsgName $`OpMsgName
$[0-9]MsgName $[0-9]MsgName $[0-9]MsgName
Function Out Param $.funcOname $.funcOname
Transform Scope $@tranVarName

 

Finally, see the Configuration variable examples below.

Proposed Configuration Variable Examples
Project MAIL.notify.to (replace . with _ if the variable is used within JS)
Agent ~FTP-path

On the right is an example screen-shot of the above Global variables within the Data Elements tab of Jitterbit’s Formula Builder. Notice the alphanumeric sort order. (I’ve added capitalized variables simply for louder delineation than the first character) You can use the Filter field to find or identify your relevant variable by purpose. Right-click on each and select View References to see their design location and use.

Also, to see a contextual list of Jitterbit variables that begin with a particular character and bring into a Script, you merely need to start by typing a $ and then the first letters of the variable name. By prefixing names according to a convention, finding an existing variable from a long list is much more comfortable.

You can define your naming conventions and, in the end, hoping to start a conversation here. The goal is to organize the values listed in Formula Builder’s Data Elements for more natural selection as your designs’ Global variable list grows.