Variables created by ACL commands

When certain commands are executed, either by entering information in dialog boxes in ACL or by running scripts, system variables are automatically created by ACL. You can use these variables when processing other ACL commands. The variables, and the values they contain, are retained for the duration of the current ACL session only. The value is replaced with an updated value if you execute the same command again. Table 1 lists the system variables created by ACL and the commands that they are generated for.

For system variable names that include n, n is always 1 if commands are executed individually — for example, TOTAL1. If you use a group to execute multiple commands, any system variables that result are numbered consecutively, starting at 2. The value of n increases by 1 for each command in the group. For example, if the Total command is the third command in a group, the results are contained in the variable TOTAL4. If you use the Total command to total another field, and it is the fifth command in the group, the results are contained in the variable TOTAL6.

You can use any of the following methods to display the current values of all system and user-defined variables in an ACL project:

The second and third methods also display the remaining memory available to store variables.

Table 1. ACL system variables

Variable

Value

ABSn

The absolute value of the field described by the last Statistics command.

ACL_Ver_Major

The major version of ACL that is currently running, provided by the Display Version command. ACL version numbers are in the format major.minor.patch.

ACL_Ver_Minor

The minor version of ACL that is currently running, provided by the Display Version command. ACL version numbers are in the format major.minor.patch.

ACL_Ver_Patch

The patch version of ACL that is currently running, provided by the Display Version command. ACL version numbers are in the format major.minor.patch.

ACL_Ver_Type

The edition of ACL that is currently running, provided by the Display Version command. A value of ‘0’ indicates the non-Unicode edition, and a value of ‘1’ indicates the Unicode edition.

AVERAGEn

The mean value of the field described by the last Statistics command.

COUNTn

The number of records tallied with the last Count or Statistics command.

GAPDUPn

The total number of gaps, duplicates, or fuzzy duplicate groups detected by the last Gaps, Duplicates, or Fuzzy Duplicates command.

HIGHn

The nth highest value in the field described by the last Statistics command, where n is the number specified by the # of High/Low option. The default is the 5th highest value.

LOWn

The nth lowest value in the field described by the last Statistics command, where n is the number specified by the # of High/Low option. The default is the 5th lowest value.

MAXn

The maximum value in the field described by the last Statistics command.

MINn

The minimum value in the field described by the last Statistics command.

MLEn

The total of most likely errors in a sample reported by the Evaluate command.

OUTPUTFOLDER

In the Overview tab of the Navigator, the ACL project folder where ACL outputs command-generated and script-generated files. This a DOS-style path using the format /foldername/subfoldername, in which the initial slash (/) indicates the root level in the Overview tab.

Use the SET FOLDER command to specify a different output folder or to create a new output folder.

RANGEn

The difference between the maximum and minimum values in the field described by the last Statistics command.

RETURN_CODE

The code returned by an external application or process run using the Execute command.

Return codes are numbers generated by the external application or process and sent back to ACL to indicate the outcome of the external process. ACL does not generate the return code.

Typical return codes are integer values that map to specific notifications or error messages. For example, the return code “0” could mean “The operation completed successfully”. The return code “2” could mean “The system cannot find the file specified”.

Specific return codes and their meanings vary depending on the external application or process. Lists of return codes, also called ‘error codes’ or ‘exit codes’, and their meanings, can often be found in the documentation for the associated external application. Lists of return codes can also be found on the Internet.

The RETURN_CODE variable is created when the Execute command is used synchronously, but not when the command is used asynchronously.

SAMPINTn

The sample interval reported by the Size command.

SAMPSIZEn

The sample size reported by the Size command.

STDDEVn

The standard deviation of the fields calculated by the Statistics command.

TOTALn

The sum total of the values encountered by the last Statistics or Total command.

UELn

The upper error limit in a sample reported by the Evaluate command.

WRITEn

Any of the following:

  • The number of records written by any command that outputs a table

  • The number of data validity errors detected by the Verify operation

  • The number of sequence errors detected by the Examine Sequence operation

Related tasks
Displaying variables in ACL projects
Maintaining variables in ACL projects


(C) 2015 ACL Services Ltd. All Rights Reserved.