Record Variable Definition and Value

$var_def varname value

This command defines a variable, either for use on a cover sheet or to hold data for or from a fax or e-mail transmission operation.

For fax-on-demand callbacks, CopiaFacts automatically generates $var_def commands for all the new variables created during the request (for example, by using $set_var in an infobox file).

For fax server operations, and broadcasts, FS file $var_def commands can be created as required, usually from a template file or job properties file. FFMERGE can also generate $var_def commands from the vr= keyword on the action line.

The parameters on this command are used as follows:

varname the name of the variable to be defined.
value the value to be assigned to the variable, enclosed in double quotes if it contains embedded spaces. This value is 'defined', not 'evaluated' (except as described below) and any @ characters it contains are therefore not normally expanded.

This command is therefore unlike the $set_var infobox command which always expands a string containing variables in its  'value' parameter. In order to permit expansion of values assigned to a variable in an FS file, the following exceptions to this rule exist:

Assignments to DATAx variables are always expanded.

Assignments to the system variables PHONE_ACCOUNT, ANSWER_TIME, ANSWER_XFER, TIME_OFFSET, and OB_ANI are always expanded and have the effects described in Appendix D.

When the value starts with an up-arrow (circumflex accent) (^), this character is effectively replaced with an at-sign (or the value defined on the $macro_char command) and the value is then expanded before assignment.  If you happen to need to assign a value which starts with the ^ character, duplicate it. This syntax should not be used on assignments to the variables in the preceding two paragraphs, and the value substituted for ^ is always the regular variable expansion character, not the e-mail variable expansion character.

It is important to note that the three special cases described above expand variables when the FS file is first processed by the CopiaFacts engine. Thus they can only be usefully used to expand variables already defined earlier in the FS file or as system variables.

Variable names are limited to 32 characters and variable values to approximately 8000.


$var_def MEMO1 "This is a cover sheet line"

$var_def fromvar

$email_from `fromvar

$var_def var1 ^BCF3  ; place content of list column three into var1