@BATCHID

Description

Returns the value of the id attribute for the current batch. The batch ID can be useful to save as metadata with a batch for history and tracking. It can also be used for other things such as naming of data files.

Example

In this example, the batch ID and page ID are used to name the export file.

Action and result
Actions:
SetExportDirectory("@APPPATH(export)")
SetExportFileName("Export_+@BATCHID+_+@ID+.txt")
Result: When this is called on a page node, the action uses the batch ID and the current page ID to name the export file. The export file name is similar to: "Export_20240046.001_TM000001.txt"