The Templater help site at support.dataclay.com has pages for many common tasks, but it is organized by feature, and you arrive with a task. This guide flips it around. Tell us what you are trying to do, and we point you to the page that answers it, with a note on what each page does and does not cover.
We wrote it for the person who has just been handed a pipeline. You might be a producer who inherited a template, a developer asked to wire a spreadsheet to After Effects, or an agency lead trying to work out what your team needs to read before Monday. You do not need a tour of every page. You need the right five, in the right order.
How the Templater help site is laid out
All of the Templater help pages live on support.dataclay.com, and the addresses tell you more than you might expect. After the Templater folder comes a content folder, and inside it the pages split into a few families. Pages under introduction cover installing, registering, licensing and system requirements. Pages under concepts explain how a part of Templater thinks, such as what a data source is or how layout rules behave. Pages under how_to are step by step instructions for one job, such as setting an output folder or building a custom file name.
That split is the most useful thing to know before you search. When you are confused about why something behaves the way it does, you want a concepts page. When you know what you want and need the clicks, you want a how-to page. A producer hunting for the reason a layer jumps to a different position will not find it on a how-to page for aligning layers. The reason lives on the layout rules concept page, and the how-to page only tells you which parameter to change.
Three other places hold Dataclay documentation, and it helps to know the borders between them. Que, our companion for sending jobs to machines and tracking them, has its own help section, plus a separate API reference. Que’s help pages and its API reference render in the browser, so a plain text fetch of them comes back empty. Open them in a normal browser tab. Projector, which takes a finished render and deploys it to a streaming or hosting provider, has its own help section too. And each of our Autograf products, such as Transformation Station and Dealership Follow-Thru, has a product page on dataclay.com that lists what is inside the template.
One more habit is worth building. Some Templater help pages say right at the top which version they apply to. A note such as “this feature requires Templater 3.7 or later” is the sort of thing that turns an hour of confusion into a one minute answer. If a page mentions a version number, check it against your installed version before you assume a button is missing.
For a gentler introduction than the reference pages, our own overview of what Templater is and the walkthrough on setting up and using Templater inside After Effects are good places to begin. The Learn section collects every article we have written, grouped by topic. The help site is the reference. The articles are the explanations.
Starting out: install, register, license, and choose an edition
This is where a new Templater project starts, and a handful of pages cover it. The best starting point is the page on Templater editions and licenses. It explains the three editions and the three licensing models, and it is where you decide what to buy or what to ask your IT team for.
The editions line up with jobs. Rig lets you prepare an After Effects project for dynamic content, map data to it, and preview how things change as the data changes. Pro adds desktop automation, so you can render or replicate batches of versioned compositions from a data source. Bot is the fully automated edition. It checks for incoming data, renders in the background, and can be driven from the command line, which matters when a web app or another system is feeding it. The help page lists the feature differences in a comparison table, and that table is worth a slow read before you commit a team to one edition.
Edition comparison
Three Templater editions, three jobs
| Edition | What it adds | Key capability |
|---|---|---|
| Rig | Prepare AE project for dynamic content | Map data and preview changes |
| Pro | Desktop automation over Rig | Render or replicate batches from a data source |
| Bot | Fully automated, command-line driven | Checks for incoming data, renders in background |
The same page describes the licensing models. A standard license is node-locked, which means it belongs to one computer at a time. A floating license moves between machines through a license server, and a metered license supports pay as you go output. The page is also clear on a point that trips people up. Standard keys and floating keys are not interchangeable, so a key bought for one type will not activate the other type’s build of Templater. If you suspect you bought the wrong kind, that page tells you to contact us.
If you chose floating, two more pages matter. Floating licenses explains the idea and how to point a machine at the license server. Managing floating licenses with DataclayLM covers the server software itself. The floating page also calls out the case where floating licenses shine, which is virtual machines. A node-locked license has to be deactivated and reactivated by hand when you spin up a new virtual machine, and a floating license avoids that.
For the sequence of events on a single machine, work through these in order:
- System requirements answers whether your operating system and After Effects version are supported, and what network access Templater needs for features like Google Sheets data sources and Que connections.
- Installing Templater is the hub for installation, with separate pages for installing through the aescripts and aeplugins manager app, including a variant for the floating license build.
- Registering and activating explains the first launch registration dialog, trial mode, and how to activate a license key.
- Deactivating Templater is the page you want when a computer is retired or a seat needs to move.
- Upgrading Templater covers moving from older versions, including a warning about not running two generations of the panel at once.
Our companion article, how to activate and deactivate Templater, covers licensing in plainer language. A producer on a deadline will not read all of those. Two are worth reading first: system requirements, because an unsupported combination is a slow way to find out, and registering and activating, because the trial and license steps come up in the first week. If you work on a machine with no After Effects window open, such as a render box that runs a script at startup, there is also a page on activating licensing through the command line interface.
New install order
Work through these pages in order
-
System requirementsAnswers whether your operating system and After Effects version are supported, and what network access Templater needs.
-
Installing TemplaterThe hub for installation, with separate pages for installing through the aescripts and aeplugins manager app.
-
Registering and activatingExplains the first launch registration dialog, trial mode, and how to activate a license key.
-
Deactivating TemplaterThe page you want when a computer is retired or a seat needs to move.
-
Upgrading TemplaterCovers moving from older versions, including a warning about not running two generations of the panel at once.
If you work with the metered option, read creating outputs using a Que Meter account. It spells out that each customized output uses one credit, that spot checks, replicas and renders all count as outputs, and that the Bot stops and disables itself when credits run out. That last detail is worth knowing before you start a large overnight batch. Our Que page covers the companion product.
Building and running a batch: data, layers, time, and output
This is the center of the documentation, and the pages here follow the order a real project follows. Data first, then the template, then the preview, then the output.
Data. Begin with the concepts page on data sources, then mapped data, which explains how a column header or a JSON key meets a layer name. A core how-to is mapping Templater data to layers. Two warnings from these pages deserve a mention here. For Google Sheets, column headers that begin with a number, contain spaces, or contain the _ character are not currently supported. And reserved column names lists the names that Templater keeps for itself, among them id, target, output, aep, render-status, bot, module and render-settings. If you use one of those as a dynamic layer name, you can get an error, and the names are case sensitive.
For data that is not a plain spreadsheet, there is a family of pages. The concepts page on JSON text files and URL feeds introduces the options. Setting up a URL feed as a data source and linking a URL feed to your AE project handle the feed route, and the feed page makes a point of saying that building one takes real experience configuring web servers.
Two small how-to pages pay off on any project that outputs more than a handful of files. Specifying a unique ID for each spreadsheet row explains why you should label every row with an id column, and creating custom output file names shows how an output column controls what each file is called. If your template switches between several project files from one sheet, the page on switching between project files within a single spreadsheet is the one to find.
Layers and layout. The concept page on layout rules is the one to read when text overflows a box or a logo lands in the wrong corner. It explains that the Templater Settings effect carries each layer’s rules, and that those rules are measured relative to the parent composition and sibling layers. The how-to pages then break the advanced pieces apart. Aligning layers, attaching layers and chaining and grouping layers cover the cases where one layer has to follow another when its text grows. A few related pages answer narrower questions. Styling text dynamically lets the data source change some text properties, and the page notes it is supported from Templater 3.4. Using Templater data in expressions shows how to read mapped data from inside an After Effects expression, and it reminds you that Templater data arrives as strings, so numbers need casting.
Nested compositions have their own pair of pages. Dynamic layers covers how pre-compositions take part, and dynamic essential properties explains promoting a property in the primary composition so data can reach it. That page is specific about the details. A property must be promoted in the primary comp, it is applied on the named pre-comp layer instance, and group names are part of the key. If your template has a pre-comp that ignores your data, start there.
Time. If your videos change length from row to row, the concepts pages on time are the ones that matter. Time sculpting is the overview. It sends you to separate pages on cropping, shifting, stretching and trimming. Every one of them carries the same note, which is that you must set a target composition to use these features. Auto-adjusting comp duration with time cropping gives the one worked example.
Footage. Missing media can derail a long batch, so it gets its own set of pages. Handling faulty footage references and missing footage lists your choices when a file cannot be found, from asking you what to do to skipping the row or substituting a placeholder. The page recommends the branded placeholder, because it keeps a batch moving. Setting up a footage folder and setting up remote footage via Google Drive cover where the files live.
Preview, then output. Before a big run, read preview modes. Manual mode steps through rows one at a time and rereads the data source on every preview. Cycle mode runs through a range automatically and reads the data source only once, so rows you add after it starts will not show up. The concepts page on spot checking, batch rendering and replicating is the next stop, since spot checking is the way to see how data merges across many jobs before you spend the time on all of them. Picking the target composition explains the three ways of choosing what Templater processes, and which one wins when they disagree. Output location and assets tells you where files and generated compositions land. The final how-to is rendering versioned video in a batch process. For rendering through Adobe Media Encoder, see rendering a batch of replicas using Adobe Media Encoder.
Automation, the Bot, and what to open when something breaks
When a batch moves from “someone clicks Render” to “the machine does it on its own,” the relevant pages are about the Bot. The Bot for Templater is the concepts overview. How does the Bot work is the page that describes a job moving through the render-status column. The statuses run from ready to queued to processing to done, and failures show up as error codes in the same column. Enabling and disabling the Bot and configuring settings for the Bot handle setup. If a single Bot is not enough, there are two parallel pages: setting up your data source for one Bot and for multiple Bots. The multiple Bot page is where the bot column comes in.
A page worth reading before a long run is optimizing After Effects for the Bot. It explains that a Bot left running for a long stretch can slow down because After Effects keeps caching incoming data, and it tells you how to adjust. If you plan to leave a Bot running overnight, read it first.
Scripts and events are the next family. Templater events lists the moments in the versioning process when Templater broadcasts an event, such as after a job or after a batch. Event scripts explains how to attach your own code to those moments. The how-to pages then go deeper: ExtendScript through the using ExtendScripts page and the ExtendScript API reference, and shell scripts through using shell scripts. Both have a companion page on passing job details into the script. Our guide to event scripts and when you need one is the place to decide whether you need any of this at all.
Now the part you open the documentation for when something goes wrong. Something failed. The index of troubleshooting pages is short, and each one answers a different question:
- A layer did not update, or Templater seems to hang while replicating or rendering: troubleshooting Templater lists the typical failures and shows how to use the log files to find the cause.
- You are running Templater from the command line and something went wrong: troubleshooting the command line interface explains the log, error and standard output files, and shows what an error object looks like.
- An event script did not do what you expected: troubleshooting event scripts.
- A job ended in a status such as ERR::MEDIA or ERR::AFXHOST: the Bot data source setup pages define those codes, and the Bot pages explain where they appear in the render-status column.
- Jobs are not spreading across render machines the way you hoped: our FAQ page notes that Que does not load balance across satellites, and the understanding satellite properties page describes the properties you can set on each one.
For a version of this list in plain language, with stage by stage advice, we wrote common Templater problems and how to fix them. It is a good companion to the reference pages above.
Here is how this plays out. Picture a producer at a regional agency. She inherits a template and a spreadsheet of three hundred rows, and the first batch stops partway through with a few error codes in the render-status column. She does not need all of the documentation. She opens how the Bot works to read what the statuses mean, then the data source page for the code definitions, then the logging page to see which rows and which files failed. If the failures point at missing media, she jumps to the faulty footage page and switches the setting to a branded placeholder. If they point at a name collision, she checks reserved column names. Four pages, in that order, and she is done. Documentation sessions often look like this. A single question rarely needs the whole set. A few pages read in the right order can be enough.
One last point on how to read all of this. Where a help page and a more recent answer from our team disagree, the newer answer wins. A good example is the free trial. Our team has confirmed that the trial includes all features, with a watermark added to dynamic layers, and that the command line interface is available in the trial. If an older page seems to say otherwise, trust the newer statement and ask us if it still looks off.
The bottom line is simple. Use the help site for the exact steps and the settings that matter, and use the concepts pages when behavior surprises you. Start with editions and licenses, then data sources and mapping, then layout rules, then preview and spot check, and only then the Bot and its scripts. Read the troubleshooting pages before you need them, because the log file names and error codes are easier to find when nothing is on fire. If a question has no page, that is our gap and we want to hear about it. Our Templater product page is the front door, and the Learn section is where the plain language explanations live.
We covered a lot of ground above. Here are questions that come up when you are hunting for a specific help page.
Frequently Asked Questions
Where is the official Templater documentation?
It lives on support.dataclay.com, in a Templater section. The pages are grouped into introduction pages for installing, registering and licensing, concepts pages that explain how a part of Templater works, and how-to pages with step by step instructions. Que and Projector have their own help sections, and Que also has a separate API reference. Our Learn section on dataclay.com holds plain language articles that explain the same ground, so use the help site for exact steps and the articles for the reasoning.
Which help page should I read first as a new Templater user?
Read the page on Templater editions and licenses, so you know which edition and license type applies to you. Then read system requirements and registering and activating. After that, move to the concepts page on data sources, the mapped data page, and the how-to on mapping data to layers. Those pages take you from a fresh install to a first preview. Leave the Bot and event script pages until you have previewed a few rows by hand and understand how your data meets your layers.
Which page explains why my text layer overflows or moves to the wrong spot?
Start with the concepts page on layout rules. It explains that each dynamic layer carries its own rules in the Templater Settings effect, measured relative to the parent composition and to sibling layers. For specific fixes, use the how-to pages on aligning, attaching and chaining layers. If a graphic should follow a text layer that grows, the page on making a graphic follow a changing text layer is the closest match to that case.
What do the render-status values and error codes mean, and where are they documented?
The page on how the Bot works describes the render-status column. A job goes from ready to queued to processing to done, and a failure shows up as an error code. ERR::MEDIA points at a problem with an asset, and ERR::AFXHOST points at an After Effects error. The pages on setting up your data source for one Bot define those codes. Our article on Que job states covers the matching statuses on the Que side.
Is there documentation for the command line interface?
Yes. The Templater help site has a page on troubleshooting the command line interface, which describes the log, error and standard output files and shows an example error object. It also has a page on activating licensing through the command line, for machines where After Effects is not open when the license needs to be activated. Our team has confirmed that the command line interface is available in the free trial as well.
Where do I find help on licensing, floating seats and moving a license to another machine?
Begin with the page on editions and licenses, which explains standard, floating and metered licensing. For moving a standard license to a new computer, use the deactivating Templater page, or deactivate from your Dataclay.com profile. For floating licenses, read the floating licenses page and the page on managing them with DataclayLM, the license server software. Keep in mind that standard and floating keys are not interchangeable.
Does Templater have an API, and where is it documented?
There are two separate things people mean by that. Templater has an ExtendScript API, which you use inside event scripts, and it has a reference page on the help site that explains the $D object. Que has a web API for sending jobs and managing campaigns, documented in its own API reference. Check which of the two matches what you are building before you start reading, because the endpoints and the scripting objects do different jobs.
