Variables created by Analytics commands

When you execute certain commands, either by entering information in dialog boxes in Analytics or by running scripts, system variables are automatically created by Analytics. You can use these variables, and the values they contain, when processing subsequent Analytics commands.

The value in a system variable is replaced with an updated value if you execute the same command again.

Analytics system variables lists the system variables created by Analytics.

Note

System variables, and the values they contain, are retained for the duration of the current Analytics session only.

For comprehensive information about variables, see Working with variables in ACLScript (opens in the most recent version of the Help).

Displaying the current value of variables

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

  • Select the Variables tab in the Navigator
  • Enter DISPLAY VARIABLES in the command line
  • Click Display Variables on the toolbar (requires that you first add the button to the toolbar)

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

Incrementally numbered system variables

For system variable names that include n in Analytics system variables, n is always 1 if commands are executed outside a group – for example, TOTAL1.

If you use a group to execute multiple commands, any system variables that result are numbered based on the line number of the command that creates the variable. The first command in a group is considered to be on line number 2.

For example:

  • If the Total command is the third command in a group, the results are contained in the variable TOTAL4.
  • If a second Total command is the fifth command in the group, the results are contained in the variable TOTAL6.

Analytics system variables

The following table lists the system variables created by Analytics, the commands that generate them, and the values the variables contain.

Note

If you run the Statistics command on more than one field simultaneously, the system variables contain values for the first field you specify.

System variable Command Value
WRITEn
  • Any command that outputs a table
  • Verify
  • Sequence
  • The number of records in the output table
  • The number of data validity errors (Verify)
  • The number of sequence errors (Sequence)
OUTPUTFOLDER
  • Any command that outputs an Analytics table
 The path to the Analytics project folder in the Navigator that contains the output table.

This a DOS-style path that uses the format /foldername/subfoldername, in which the initial slash (/) indicates the root level in the Overview tab.

Tip

Use the SET FOLDER command to specify a different output folder or to create a new output folder.
COUNTn
  • Count
  • Statistics
The number of records tallied.
ACL_Ver_Major
  • Display Version

    (Analytics version numbers are in the format major.minor.patch)

 The major version of Analytics that is currently running.
ACL_Ver_Minor The minor version of Analytics that is currently running.
ACL_Ver_Patch The patch version of Analytics that is currently running.
ACL_Ver_Type The edition of Analytics that is currently running:
  • A value of '0' indicates the non-Unicode edition
  • A value of '1' indicates the Unicode edition
MLEn
  • Evaluate
 Monetary unit sampling

Most Likely Error amount (projected misstatement)

Record sampling

Upper error limit frequency rate (computed upper deviation rate)
UELn Monetary unit sampling

Upper Error Limit amount (upper misstatement limit)
RETURN_CODE
  • Execute
 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 Analytics to indicate the outcome of the external process. Analytics 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.
GAPDUPn
  • Gaps
  • Duplicates
  • Fuzzy Duplicates
The total number of gaps, duplicates, or fuzzy duplicate groups.
SAMPINTn
  • Size
 The required sample interval.
SAMPSIZEn The required sample size.
ABSn
  • Statistics
 The absolute value of the first specified field.
AVERAGEn The mean value of the first specified field.
HIGHn

The 5th highest value in the first specified field.

The 5th highest is the default setting. The setting can be changed using the # of High/Low option in the Statistics dialog box.

Note

When Analytics identifies the highest value, duplicate values are not factored out. For example, if values in descending order are 100, 100, 99, 98, the 3rd highest value is 99, not 98.
LOWn

The 5th lowest value in the first specified field.

The 5th lowest is the default setting. The setting can be changed using the # of High/Low option in the Statistics dialog box.

Note

When Analytics identifies the lowest value, duplicate values are not factored out. For example, if values in ascending order are 1, 1, 2, 3, the 3rd lowest value is 2, not 3.
MAXn The maximum value in the first specified field.
MEDIANn The median value in the first specified field.
MINn The minimum value in the first specified field.
MODEn The most frequently occurring value in the first specified field.
Q25n The first quartile value (lower quartile value) in the first specified field.
Q75n The third quartile value (upper quartile value) in the first specified field.
RANGEn The difference between the maximum and minimum values in the first specified field.
STDDEVn The standard deviation of the first specified field.
TOTALn
  • Total
  • Statistics
The sum total of the values in the first specified field.

Other system variables

The following variables are system-generated but not created by commands:

  • AXRunByUser available in scripts running on AX Server, this variable stores the username of the user running the analytic in the format "domain\username"
  • OUTPUTFOLDER the current Analytics project output folder