Output variables
Output variables are reserved keywords provided either by the system, or user defined and are resolved at run time.
Output variables are used in:
- print file paths and names
- report file paths and names
- archive file paths and names
- inclusion conditions
- sorting
- report file contents
- index file contents
Be aware that if you duplicate a variable definition within the same template, when batch processes the channel the last defined variable XPATH value will take precedence.
Note that the XPath field is editable. However, do not attempt to enter the XPath value for a non-interactive template. Instead, use Browse to select the XPath value. For more information, see Using non-interactive templates.
Structured XML journal variables are automatically imported along with your template into EngageOne™ for use with batch reporting. These are listed as Reserved/Journal and consist of any variables defined in a Structured XML Journal object in EngageOne™ Designer.
You can select the default system variables or use the displayed user defined variables instead.
It is important to note that documents created from EngageOne™ Communicate imported templates are generated directly in EngageOne™ Communicate. If you use these templates with JSON formatted data, you must define a separate set of variables because JSON data is automatically converted to our internal data format before output variables are calculated. Refer to User defined variables for further information on defining variables.
If you intend to use a template imported from EngageOne™ Communicate with both JSON data and data in other supported formats, e.g., XML, together with Output Variables when generating a document, e.g., at the channel level or BATCH configuration level, you should:
- duplicate the elements using an Output Variable and in one copy use only variables for JSON data and in the other copy use only variables for the other data formats.
- duplicate elements that use the above mechanisms, such as Delivery Option, and split them into those that use only variables for JSON data in one copy and only variables for other data formats in the other.
-
use only elements with Output Variables definitions that match the format of the data used (JSON, XML, etc.) to generate documents.