Bot Property Keys
Table 3: Property keys in templater-options.json for configuring The Bot characteristics
| Key Name | Type | Default | Description | Notes |
|---|---|---|---|---|
| name | String | empty | Specifies an identifier for the current instance of The Bot. | Use this if you have two or more Bots processing the same data source. Do not include if you are using only one Bot. See Setting up Your Data Source for Multiple Bots to learn more. |
| goog_freq | Float | 0.3
|
Sets the frequency, in minutes, at which The Bot checks for ready rows in the data source. | The minimum value is 0.3 minutes, about 18 seconds, between checks. |
| json_freq | Float | 0.3
|
Sets the frequency, in minutes, at which The Bot checks for ready jobs in a JSON formatted data source or in QUE. | The minimum value is 0.2 minutes, about 12 seconds, between checks. |
| max_queued | Integer | 20
|
Maximum number of rows or jobs that The Bot can retrieve any time it checks its connected data source. | The maximum amount of rows Bot can queue at any given time is 20. |
| action_render | Boolean | false
|
Specifies whether The Bot should output rendered files when it find ready rows or jobs in the data source. | |
| action_replicate | Boolean | false
|
Specifies whether The Bot should output replicas when it finds ready rows or jobs in the data source. | |
| action_spot_check | Boolean | false
|
Specifies whether The Bot should output spot checks when it finds ready rows or jobs in the data source. | Set to true this when you want Bot to exclusively export spot checks. If you set this to true, you must set "action_render" and "action_replicate" to false. If you want to export spot checks when Templater either renders or replicates, set the "on_render" and "on_replicate" properties in the "spot_checking" object to true. |
| pre_cmd_data | String | empty | A shell command, or path to a shell script, to be executed immediately after any of Templater's three main tasks are invoked and before Templater retrieves any data from the data source. | |
| pre_cmd_data_async | Boolean | false
|
Specifies execution method for the script registered to the "Before Data" event. Set to true for asynchronous execution. Set to false for synchronous execution. |
|
| post_cmd_data | String | empty | A shell command, or path to a shell script, to be executed immediately after Templater retrieves any data from any data source types. | |
| post_cmd_data_async | Boolean | false
|
Specifies execution method for the script registered to the "After Data" event. Set to true for asynchronous execution. Set to false for synchronous execution. |
|
| pre_cmd_batch | String | empty | A shell command, or path to a shell script, to be executed immediately before Templater begins its main iteration loop of re-versioning and output tasks. | |
| pre_cmd_batch_async | Boolean | false
|
Specifies execution method for the script registered to the "Before Batch" event. Set to true for asynchronous execution. Set to false for synchronous execution. |
|
| post_cmd_batch | String | empty | A shell command, or path to a shell script, to be executed immediately after Templater completes its main iteration loop of re-versioning and output tasks. | |
| post_cmd_batch_async | Boolean | false
|
Specifies execution method for the script registered to the "After Batch" event. Set to true for asynchronous execution. Set to false for synchronous execution. |
|
| pre_cmd_job | String | empty | A shell command, or path to a shell script, to be executed immediately before Templater begins to process a single job within a batch. | |
| pre_cmd_job_async | Boolean | false
|
Specifies execution method for the script registered to the "Before Job" event. Set to true for asynchronous execution. Set to false for synchronous execution. |
|
| post_cmd_job | String | empty | A shell command, or path to a shell script, to be executed immediately after Templater completes processing a single job within a batch. | |
| post_cmd_job_async | Boolean | false
|
Specifies execution method for the script registered to the "After Job" event. Set to true for asynchronous execution. Set to false for synchronous execution. |
|
| pre_cmd_ftg | String | Empty | A shell command, or path to a shell script, to be executed immediately before a "Footage Processing" event. | Requires Templater Bot Edition, version 3.4 or later |
| pre_cmd_ftg_async | Boolean | [false]
|
Specifies execution method for the script registered to run before a "Footage Processing" event. Set to true for asynchronous execution. Set to false for synchronous execution. |
Requires Templater Bot Edition, version 3.4 or later |
| pre_jsx_ftg | String | Empty | Path to an ExtendScript file to be executed immediately before a "Footage Processing" event. | Requires Templater Bot Edition, version 3.4 or later |
| post_cmd_ftg | String | empty | A shell command, or path to a shell script, to be executed immediately after a "Footage Processing" event | Requires Templater Bot Edition, version 3.4 or later |
| post_cmd_ftg_async | Boolean | [false]
|
Specifies execution method for the script registered to run after a "Footage Processing" event. Set to true for asynchronous execution. Set to false for synchronous execution. |
Requires Templater Bot Edition, version 3.4 or later |
| post_jsx_ftg | String | empty | A path to an ExtendScript file to be executed immediately after a "Footage Processing" event. | Requires Templater Bot Edition, version 3.4 or later |
| pre_cmd_dl | String | Empty | A shell command, or path to a shell script, to be executed immediately before a "Footage Download" event. | Requires Templater Bot Edition, version 3.4 or later |
| pre_cmd_dl_async | Boolean | [false]
|
Specifies execution method for the script registered to run before a "Footage Download" event. Set to true for asynchronous execution. Set to false for synchronous execution. |
Requires Templater Bot Edition, version 3.4 or later |
| pre_jsx_dl | String | empty | A path to an ExtendScript file to be executed immediately before a "Footage Download" event. | Requires Templater Bot Edition, version 3.4 or later |
| post_cmd_dl | String | empty | A shell command, or path to a shell script, to be executed immediately after a "Footage Download" event | Requires Templater Bot Edition, version 3.4 or later |
| post_cmd_dl_async | Boolean | [false]
|
Specifies execution method for the script registered to run after a "Footage Download" event. Set to true for asynchronous execution. Set to false for synchronous execution. |
Requires Templater Bot Edition, version 3.4 or later |
| post_jsx_dl | String | empty | A path to an ExtendScript file to be executed immediately after a "Footage Download" event. | Requires Templater Bot Edition, version 3.4 or later |
| pre_cmd_update | String | empty | A shell command, or path to a shell script, to be executed immediately before any mapped data is injected into layers within the project's compositions. | |
| pre_cmd_update_async | Boolean | false
|
Specifies execution method for the script registered to the "Before Update" event. Set to true for asynchronous execution. Set to false for synchronous execution. |
|
| post_cmd_update | String | empty | A shell command, or path to a shell script, to be executed immediately after any mapped data is injected into layers within the project's compositions. | |
| post_cmd_update_async | Boolean | false
|
Specifies execution method for the script registered to the "After Update" event. Set to true for asynchronous execution. Set to false for synchronous execution. |
|
| pre_cmd_spot | String | empty | A shell command, or path to a shell script, to be executed immediately before any frames are exported for spot checks. | |
| pre_cmd_spot_async | Boolean | false
|
Specifies execution method for the script registered to the "Before Spot Check" event. Set to true for asynchronous execution. Set to false for synchronous execution. |
|
| post_cmd_spot | String | empty | A shell command, or path to a shell script, to be executed immediate after any frames are exported for spot checks. | |
| post_cmd_spot_async | Boolean | false
|
Specifies execution method for the script registered to the "After Spot Check" event. Set to true for asynchronous execution. Set to false for synchronous execution. |
|
| pre_cmd_output | String | empty | A shell command, or path to a shell script, to be executed immediately before any output begins rendering. | |
| pre_cmd_output_async | Boolean | false
|
Specifies execution method for the script registered to the "Before Output" event. Set to true for asynchronous execution. Set to false for synchronous execution. |
|
| post_cmd_output | String | empty | A shell command, or path to a shell script, to be executed immediately after any output finishes rendering. | |
| post_cmd_output_async | Boolean | false
|
Specifies execution method for the script registered to the "After Output" event. Set to true for asynchronous execution. Set to false for synchronous execution. |
|
| enable_cmd | String | empty | A shell command, or path to a shell script, to be executed immediately after The Bot is enabled. | |
| enable_cmd_async | Boolean | false
|
Specifies execution method for the script registered to the "Bot Enable" event. Set to true for asynchronous execution. Set to false for synchronous execution. |
|
| shutdown_cmd | String | empty | A shell command, or path to a shell script, to be executed immediately after The Bot shuts down. | This shell script will not execute if After Effects undergoes a hard crash. It will execute if the user disables The Bot manually. |
| shutdown_cmd_async | Boolean | false
|
Specifies execution method for the script registered to the "Bot Disable" event. Set to true for asynchronous execution. Set to false for synchronous execution. |
|
| pre_jsx_data | String | empty | A path to an ExtendScript file to be executed immediately after any of Templater's three main tasks are invoked and before Templater retrieves any data from the data source. | |
| post_jsx_data | String | empty | A path to an ExtendScript file to be executed immediately after Templater retrieves any data from any data source types. | |
| pre_jsx_batch | String | empty | A path to an ExtendScript file to be executed immediately before Templater begins its main iteration loop of re-versioning and output tasks. | |
| post_jsx_batch | String | empty | A path to an ExtendScript file to be executed immediately after Templater completes its main iteration loop of re-versioning and output tasks. | |
| pre_jsx_job | String | empty | A path to an ExtendScript file to be executed immediately before Templater begins to process a single job within a batch. | |
| post_jsx_job | String | empty | A path to an ExtendScript file to be executed immediately after Templater completes processing a single job within a batch. | |
| pre_jsx_update | String | empty | A path to an ExtendScript file to be executed immediately before any mapped data is injected into layers within the project's compositions. | |
| post_jsx_update | String | empty | A path to an ExtendScript file to be executed immediately after any mapped data is injected into layers within the project's compositions. | |
| pre_jsx_spot | String | empty | A path to an ExtendScript file to be executed immediately before any spot checks are exported. | |
| post_jsx_spot | String | empty | A path to an ExtendScript file to be executed immediately after any mapped data is injected into layers within the project's compositions. | |
| pre_jsx_output | String | empty | A path to an ExtendScript file to be executed immediately before any output begins rendering. | |
| post_jsx_output | String | empty | A path to an ExtendScript file to be executed immediately after any output finishes rendering. | |
| enable_jsx | String | empty | A path to an ExtendScript file to be executed immediately after The Bot is enabled. | |
| shutdown_jsx | String | empty | A path to an ExtendScript file to be executed immediately after The Bot shuts down. | This shell script will not execute if After Effects undergoes a hard crash. It will execute if the use disables The Bot manually. |
| job_detail_args (deprecated) | Boolean | false
|
Specifies whether shell scripts executed by Templater receive all versioning data. | This is deprecated as of Templater version 2.7.0. Please refrain from using this. Use this to make versioning data available to script files registered with an event broadcast by Templater. See Using Job Details in Shell Scripts for more information. |
Related Topics
