HotDocs Template Hub Overview
The HotDocs Template Hub is a web service that provides a central service for the storage and retrieval of HotDocs Templates. Using the service, users can:
- Store HotDocs Template Package Files in a database
- Edit HotDocs Template Package File metadata
- Organise templates into Groups.
- Version control HotDocs Template Package Files
Additionally, the Template Hub exposes an API for use with other web services, allowing you to use its functionality with third-party applications or other HotDocs Services.
Definitions
- HotDocs – HotDocs is an award-winning document automation and generation system which uses HotDocs templates to generate documents.
- HotDocs Developer – HotDocs Developer is a desktop template development program where you can create your HotDocs templates.
- HotDocs Developer Upload Plugin – Install the HotDocs Developer Upload Plugin to upload your templates to the Template Hub from HotDocs Developer..
- HotDocs Template – a HotDocs Template is a software component created in HotDocs Developer. A template is comprised of boilerplate text (the parts of the document which remain the same every time HotDocs generates the document), the variable fields (which are replaced with the new information collected from the interview questions), and any template logic needed.
- HotDocs Template Package – the HotDocs Template Package (.hdpkg) is a file format that acts as a container for HotDocs Templates, component files and any additional files. You must use this format when you upload to the Template Hub.
- HotDocs Template Hub API – HotDocs Template Hub API provides the core functionality of the Template Hub, including reading and writing to the database. The Hub exposes an API for interacting with the Template Packages, Groups and User information stored in the database.
- HotDocs Hub UI – HotDocs Hub UI is a web application used to administer the Template Hub API and manage content. It exposes Template Hub API methods through a user interface.
Getting Started with the Template Hub
To begin using the HotDocs Template Hub, see the articles in the Getting Started section:
Installation
To install the Template Hub as part of an on-premise solution, you should install the following items in order:
- Install and Configure the Microsoft .Net Framework
- Install the Template Hub API (including database)
- Install the Template Hub UI
- Install the Upload Plugin for HotDocs Developer (on your template development machine)
Using the Template Hub UI
After you have installed the HotDocs Template Hub API on a Server, you can install the HotDocs Template Hub UI to manage your templates. You install the Template Hub UI on a Server (you do not have to install the Template Hub UI on the same server as you installed the Template Hub API) and access it through a browser. Users can store, retrieve and organise their templates. They can also edit their template metadata and version control their template packages.
To start using the HotDocs Template Hub UI:
- Launch the Template Hub UI
- Templates
- Template Groups
- Download Configuration File
- Upload a Template to the Template Hub
Template Hub API
The HotDocs Template Hub API is a REST API for uploading/retrieving templates and manipulating associated groups and metadata.