Overview
Variables are used as placeholders of information which can be assigned “outside” of the template. A user selecting tag names for an on-demand report or the schedule setting the batch ID on the start of a batch are examples of setting “outside” of the template.
Five types of variables are provided:
Function
These read-write variables hold numbers, text and timestamps and are saved permanently so that they can be used over time and are retained even if the machine is restarted. Function variables give the highest fidelity but are the slowest to use because they are cached to a file. To configure see Variable Editor below.
Usage:
- Variable connections in a report template
- Naming convention of a report template
User Defined
These read-write Custom variables hold numbers, text and timestamps that are not saved but rather persist only for a report cycle (~30 seconds). To configure see Variable Editor below.
Usage:
- On-Demand reports
Memory Variables
There are 2 types of Memory variables: System and User.
System variables are read only and provide information about the running system like the last error or how many actions are pending in the schedule.
User variables are read-write and can hold numbers or text. These values are saved in system memory and are persistent as long as the system is running. If the system is restarted or the XLReporter Runtime Service is restarted, the values are reset. To configure, see Variable Editor below.
Usage:
- Event condition in the Scheduler
Analytic
These read-write variables hold summary calculations of process readings. The variables can be optionally configured to maintain a history of the calculations. To configure see the Analytics document.
Usage:
- Snapshot of process values
- Statistics from process values over a period of time
Name Type
These read-only variables hold date and time values (see Name Types document).