Common System Variables

System variables are variables whose names have been reserved for use by Enrichment. Most often, their values are the result of internal calculations made during processing.

Enrichment automatically sets system variable values during processing, and their values can be set or changed in the rule file. Therefore, the type of information their values can contain is more restricted than for user-defined variables.

There are more than 80 system variables available for your Enrichment applications, but as the following table shows, the list of those most commonly used is quite small.

Table 1. Frequently-Used System Variables
System Variable Value
%%DOCUMENT_NO The overall document number, regardless of which output contains the document.
%%PAGE_NO The logical front page number of the current page in the document.
%%RC The return code from rule function call processing.
%%SEQUENCE_NO The sequence number for each document in the output file.
%%TOTAL_PAGES The total number of logical front pages in the document.