System variables
System variables are provided with the EngageOne installation. They predefine placeholders in the template instance file and the variable name and data type are displayed in the list as Reserved. Footnoted system variables cannot be used as inclusion conditions in immediate delivery channels.
Note that you cannot change or delete a system reserved variable.
| System Variable | Description | Delivery Channel |
|---|---|---|
| COMPOSITION_DATE* | Date the document was composed. | Batch/Archive/Email/FAX |
| DOCUMENT_OFFSET | Binary offset of the start of the document in the output stream. | Report File (structured journal) |
| DOCUMENT_PAGE_NUMBER | The current page number within the document being processed | Report File (structured journal) |
| FAX_NUMBER | The fax number of the recipient. | FAX |
| INCREMENT* | Sequence number variable to be used in reports, index files, and to ensure unique file naming when partitioning. | Batch/Archive |
| INTERACTIVE_DOCUMENT_SELECTOR | The document selector value triggers the inclusion and exclusion of one or more documents within a template for the given composition. This system variable can only be used with the interactive data model. For more information, see Input files. | EngageOne Deliver |
| INTERACTIVE_RECIPIENT | The value provided at composition time to help trigger logic in the template that varies the content based on the recipient value. This system variable can only be used with the interactive data model. For more information, see Input files. | Batch/Archive/Email/Print/FAX |
| JOB_PAGE_NUMBER | The current page number of the entire production job, starting from 1 | Report File (structured journal) |
| MAIL_BODY | The text content of the e-mail. | |
| MAIL_FROM | The e-mail address of the sender. | |
| MAIL_SUBJECT | What the e-mail refers to. | |
| MAIL_TO | The e-mail address of the recipient. | |
| PAGE_OFFSET | Binary offset of the start of the page in the output stream. | Report File (structured journal) |
| PRINT_FILENAME* | Used to write the name of the generated print file to an archive index file. This may be required to support archive products such as FileNet Panagon or P8. | Batch/Archive/Email/FAX |
| SYSTEM_DATE | Date the batch job was run. | Batch/Archive/Email/FAX |
| SYSTEM_TIME | Retrieves the system time whenever it is needed, for example, job start time and job end time. | Batch/Archive/Email/FAX |
| TEMPLATE_INDEX | The sequence number of a publication within its final destination stream. | Report File (structured journal) |
| TEMPLATE_OFFSET | Binary offset of the start of the template in the output stream. | Report File (structured journal) |
| TEMPLATE_PAGE_NUMBER | The current template page number within the document being processed | Report File (structured journal) |
| TOTAL_PAGES* | Total number of pages counting front and back. | Batch/Archive/Email/FAX |
| TOTAL_PAGES_RECTO* | Total number of pages counting front only (sheet count). | Batch/Archive/Email/FAX |
| * These system variables are not a valid inclusion condition for immediate delivery channels. |