This activity formats an input string, replacing embedded references to processing sequence variables and/or built-in variables with their current values.
NB: This activity performs a very similar function to the SUBSTITUTE activity but uses a different means of specifying the variable data to be substituted into the string. You can use either activity according to your requirements or preference.
This parameter specifies the string that is to be formatted. The string may contain embedded references to processing sequence variables (eg: &myvar) and/or built-in variables (eg: *tradingpartner) that will be replaced by the current variable values. Support for indexed variable references (eg: &myvar(2) OR &myvar(&myindex) ) is provided.
For example, if you specify the string "&MYCOUNT files processed from &MYFOLDER(&MYINDEX) at *now_local", the variable and built-in variable references &MYCOUNT, &MYFOLDER(&MYINDEX) and *now_local will be replaced by the values of the variables that they represent.
In most cases, a reference to a processing sequence variable or built-in variable must be followed by a space (or certain special characters or the end of the string) in order for the reference to be correctly identified and substituted.
If two ampersands (&&) or two asterisks (**) appear together in the string, they are reduced to a single ampersand or asterisk and not considered for substitution.
Upon completion, this parameter will contain the formatted string.