HotDocs Hub Admin Guide Overview
HotDocs Hub is a modular suite of web applications that provide commonly-required functionality for HotDocs integrations. The functions the Hub applications provide – including template and user management – augment the core HotDocs interview and document generation functions.
In this Topic Hide
Overview
Third-parties who create applications to integrate with HotDocs typically require several additional features:
- Template storage and organization
- Template access permissions for users
- Interview generation services
- User authentication and authorization
HotDocs Hub provides components to perform these tasks, instead of developing them yourself. The core components of Hub are:
- Template Hub – storage, organization, and permissions for HotDocs Templates
- User Hub – authentication and authorisation for accessing HotDocs resources
- Interview Service – Interview generation using templates stored in the Template Hub
By using HotDocs Hub, you save time on development and testing, and gain access to pre-built, robust, and flexible solutions. As HotDocs Hub is designed to be modular, its feature-set can easily be extended.
Definitions
- HotDocs Hub – the HotDocs Hub is a suite of off-the-shelf-components providing commonly-needed features for HotDocs integrations
-
HotDocs Server – HotDocs Server is the server-based version of HotDocs that enables HotDocs interviews (data-gathering sessions) to be displayed by a standard Web browser and documents to be generated (assembled) on the web server, without requiring any special software to be installed on an end-user's computer
-
HotDocs Web Services – the Web Services API is a RESTful web service, hosted in IIS, which exposes fundamental HotDocs Server features to callers
- HotDocs Interview – an interview is a questionnaire displayed to end users; it collects data used to assemble a completed document
- HotDocs Template – a template is a software component created in HotDocs Developer. Templates are used to generate interviews and assemble completed documents. A template is comprised of:
- Boilerplate text – the parts of the document which remain the same every time HotDocs generates the document
- Variable fields – fields which are replaced with new information collected from the interview questions
- Template logic – any HotDocs logic statements (e.g. IF conditions, computations) used in the template
- Tenancy administrator – user with overall control of the HotDocs Hub, including configuration and user account creation
HotDocs Hub Overview
Installation Guide
- Installation Overview
- System Requirements
- Security Configuration Options
- Important Changes to HotDocs Hub
- HotDocs Hub Installation
- HotDocs
Platform Installation
You only need to install HotDocs Server and Web Services if you are not using HotDocs Cloud Services to assemble documents and generate interviews.
-
HotDocs Developer Installation
Getting Started
Using the HotDocs Hub
- Manage user groups – organize users into groups
- Manage users – create and manage individual user accounts
- Manage template groups – organize templates into groups and assign user permissions
- Upload templates to HotDocs Hub
- Manage templates – view and edit individual templates uploaded to Hub
- Set user permissions – give user groups access to template groups
- Create a new work item – create an assembled document, storing the document and it's answers in Hub
Upload Plugin for HotDocs Developer
- Upload Plugin Overview
- Download the Upload Plugin for HotDocs Developer
- Install the Upload Plugin for HotDocs Developer
- Download the Upload Configuration File
- Adding Authorization Credentials to the Upload Plugin
- Uploading a Template from HotDocs Developer