Configuring Templater Options, Preferences, and Tasks

Configure the Templater command line interface (CLI) by editing the JSON-formatted templater-options.json file and saving it to the same directory as the After Effects project file you want to version.

Follow these steps to configure the Templater CLI:

  1. Create a JSON-formatted text file named templater-options.json.
  2. Within this JSON file, set specific options for Templater. If you are unfamiliar with JSON format, see json.org to learn how to properly format a JSON object so it can be read by Templater. See Dataclay's GitHub code repository to download a sample options file.
  3. Ensure you have specified a logging location in the templater-options.json file.

NOTE   If you forget to specify a required property key or a property key has an invalid value in your JSON file, Templater will log an error or warning. Some property keys have default values. See Templater CLI Configuration Properties for more information.

NOTE  The URL for Google Sheets documents can be found in the Google Sheets Setup panel by clicking the Google Drive icon to the right of the "Data" field in the Templater panel. Search for and select the Sheet and Worksheet that you want to use. Once you've selected an option in the "Worksheet details" section, you will see a "Feed URL" that you can copy. The "Feed URL" will be in the following format:  https://sheets.googleapis.com/v4/spreadsheets/{{GSheet document key}}/values/'{{worksheet name}}'

Example JSON Options File

Format a plain text file according to the JSON below and save it as templater-options.json.


{
  "log_location"          : "C:\\path\\to\\the\\folder\\for\\your\\log\\files",
  "data_source"           : "http://sheets.googleapis.com/v4/spreadsheets/{{GSheet docuemnt key}}/values/'{{worksheet name}}' or C:\\path\\to\\tabbed\\delimited\\file",
  "aep"                   : "C:\\path\\to\\aep\\for\\versioning.aep",
  "source_footage"        : "C:\\path\\to\\folder\\containing\\referenced\\footage",
  "output_location"       : "C:\\path\\to\\where\\templater\\should\\write\\output",
  "render_settings"       : "Draft Settings",
  "output_module"         : "AVI DV NTSC 48kHz",
  "output_prefix"         : "cli_test",
  "row_start"             : 2,
  "row_end"               : 9,
  "save_on_completion"    : false,
  "quit_on_completion"    : true,
  "quit_on_errors"        : [],
  "prefs"                 : {
                              "default_target"           : "name-of-comp-to-render",
                              "tsv_from_excel"           : true,
                              "replica_comps_to_queue"   : true,
                              "replica_comps_to_ame"     : false,
                              "remove_templater_effects" : false,
                              "fix_layer_exp"            : false,
                              "missing_footage"          : 3,
                              "placeholder_visual"       : "C:\\path\\to\\a\\branded\\placeholder\\file.png",
                              "placeholder_audio"        : "C:\\path\\to\\a\\default\\audio\\file.wav",
                              "unique_downloads"         : false,
                              "suppress_ae_dialogs"      : true,
                              "silence_logging"          : false,
                              "purge_caches"             : false,
                              "import_data_as_json"      : false,
                              "empty_is_faulty"          : true,
                              "bot" : {
                                        "name"                  : "",
                                        "goog_freq"             : 3,
                                        "json_freq"             : 1,
                                        "max_queued"            : 20,
                                        "action_render"         : true,
                                        "action_replicate"      : false,
            
			                 "pre_cmd_data"          : "",
				         "pre_cmd_data_async     : false,
                                        "pre_jsx_data"          : "",
			
                                        "pre_cmd_batch"         : "",
			                 "pre_cmd_batch_async    : false,
                                        "pre_jsx_batch"         : "",
			
                                        "pre_cmd_job"           : "",
			                 "pre_cmd_job_async"     : false,
                                        "pre_jsx_job"           : "",
			
                                        "pre_cmd_update"        : "",
			                 "pre_cmd_update_async"  : false,
                                        "pre_jsx_update"        : "",
			
                                        "pre_cmd_output"        : "",
			                 "pre_cmd_output_async"  : false,
                                        "pre_jsx_output"        : "",
			
                                        "post_cmd_data"         : "",
			                 "post_cmd_data_async"   : false,
                                        "post_jsx_data"         : "",
			
                                        "post_cmd_batch"        : "",
			                 "post_cmd_batch_async"   : false,
                                        "post_jsx_batch"        : "",
			
                                        "post_cmd_job"          : "",
			                 "post_cmd_job_async     : false,
                                        "post_jsx_job"          : "",
			
                                        "post_cmd_update"       : "",
			                 "post_cmd_update_async" : false,
                                        "post_jsx_update"       : "",
			
                                        "post_cmd_output"       : "",
 					 "post_cmd_output_async  : false,
                                        "post_jsx_output"       : "",
			
                                        "enable_cmd"            : "",
			                 "enable_cmd_async"      : false,
                                        "enable_jsx"            : "",

                                        "shutdown_cmd"          : "",
			                 "shutdown_cmd_async"    : false,
                                        "shutdown_jsx"          : ""
                                      },
                              "remote_json" : {
                                                 "username" : "",
                                                 "password" : "",
                                                 "headers"  : {
                                                                 "header1" : "header 1 value",
                                                                 "header2" : "header 2 value"
                                                              }
                                               }
                            },
  "tasks"                 : {
                              "render"         : true,
                              "replicate"      : false,
                              "bot_enable"     : false
                            }
}

NOTE  File paths require a unique syntax for the templater-options.json file.

  • On Windows C:\\enter\\paths\\with\\double\\backslashes
  • On MacOS /enter/path/with/forward/slash