Template Management Overview
YOU SHOULD JUST UPLOAD THROUGH AUTHOR - The TemplatePackages resource is for internal use and not to be documented.
You can use the Advance APIs to manage the templates in your tenancy. You can use the TemplatePackageVersions resource to make a new version live and get a template's variable data.
Overview
HotDocs Advance generates documents based on templates, built in HotDocs Author. HotDocs uses the template, along with user-supplied answer data, to assemble a document. When uploaded to Advance from Author, the template is stored in Advance as part of a template package. The template package contains the template files and associated metadata files. Subsequent uploads after the first upload of a template to the HotDocs Advance create a new version of the template. Versions are a history of uploaded copies of a template.
The Advance APIs enable you to manage template versions for your organization. For example, you can use the live from date method to activate a new version of a template at a specific date and time.
A template can only have one live version.
Common Tasks
Among others, the TemplatePackageVersions resource enables you to perform the following tasks:
- Make a new version of a template live
- Get the variable data for a template
Workflow
Once a template author has uploaded a template to Advance, the template must be activated before your users can assemble documents. Templates uploaded to HotDocs Advance by default have no live version, unless your site administrator has overridden this setting. You can use the API resources to set the time and date from which you would like the template version to be live. You can also retrieve a list of the variable data a template uses.
Common Reference Topics
Among others, the following reference topics may relate to this conceptual area: