autoVars Statement

Purpose

Specifies if and where automatic variables should be created for the FileWrapper. Automatic variables are useful diagnostic variables that are automatically created for a FileWrapper.

Applicability

The autoVars statement is a stand-alone line in the FileWrapper file, usually specified immediately following the header information.

Additional Information

The variables that are created include:

exitStatus - This gives the exit status of the last run statement from the RunCommands section. This variable is useful for diagnosing why a wrapper has failed.
state - This shows the current state of the wrapper, i.e. "generating input file," "running command" etc.
lastError - This variable provides the last error generated by the wrapper.
stdout - Gives information printed to standard out by the last command executed with a run statement.
stderr - Gives information printed to standard error by the last command executed with a run statement.
runCommands - This is a group of two arrays containing the standard output and standard error information for all commands executed with a run statement.
<inputFile> - This group of variables is created for each RowFieldInputFile. The group contains variables for the templateFile, initializationFile, and fileToGenerate files. This group is useful for viewing the raw contents of files.
<outputFile> - This group of variables is created for each RowFieldOutputFile. The group contains variables for the initializationFile and fileToParse files.

Syntax

autoVars: <value=true|false> [group=name]

Arguments

NameDescription

value

If true, indicates that automatic variables should be created. Default is false.

Options

NameDescription

group

The group in which the automatic variables should be stored. The default it to store the variables at the root level. If value = false, this value is ignored.

Example

The user would like to use automatic variables, but would like them stored in a group named "system"

autoVars: true group=system

The user does not want automatic variables to be created:

autoVars: false