Extend the Batch Tracking Compiler (BTC)
- Last UpdatedApr 24, 2025
- 1 minute read
The Batch Tracking Compiler (BTC) Application Programming Interface (API) allows you to extend the BTC application to compile custom fields. You can use this functionality to create custom plugins and implement your own compiler logic for custom fields in the BT file.
Administrators can use custom fields when configuring a pipeline using the BT file mechanism. Custom fields are defined using the following syntax:
!Key: Value
Where:
-
! = an indicator that this is a custom field.
-
Key = the label assigned to the custom field.
-
Value = the value associated with the custom field for this particular entity.
Example:
!CUSTOMFIELDX: 1234 ;This is a comment
In this case:
Key = CUSTOMFIELDX
Value = 1234 ;This is a comment
When the BTC process runs, the system passes the key-value pair, and the record under which they are defined, to the plugin for processing. It is the responsibility of the plugin to parse and interpret the provided value.