HotDocs Hub Admin Guide Overview

HotDocs Hub is a modular, off-the-shelf suite of commonly-required components for HotDocs integrations.

In this Topic ShowHide

HotDocs Hub

Third-parties who create applications to integrate with HotDocs Web Services typically provide 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

• HotDocs Hub solution overview

Installation Guide

• Installation Overview
• System Requirements
• Security Configuration Options
• HotDocs Hub Installation
• Install HotDocs Hub with user management and Active Directory
• HotDocs Platform Installation
• Install HotDocs Server
• Install HotDocs Web Services
• HotDocs Developer Installation
• Install HotDocs Developer
• Install the Upload Plugin for HotDocs Developer

Getting Started

• Getting Started with the HotDocs Hub

• Set tenancy administrator password – the Tenancy Administrator password must be set on first use of the HotDocs Hub
• Log in to HotDocs Hub

Using the HotDocs Hub

• Using the HotDocs Hub overview
• Manage User Groups – organize users into Groups
• Manage Users – create and edit individual user accounts
• Manage template groups – organize templates into groups and assign user permissions
• Upload templates to the HotDocs Hub
• Manage templates – view and edit individual templates uploaded to the Hub
• Set user permissions – give User Groups access to Template Groups
• Launch an interview – launch an Interview for a template
• Generate a direct interview link – generate a direct link to a Interview for a template

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

HotDocs Hub API

The functionality of each Hub component is accessible through an API. The Hub APIs are most commonly used by developers integrating Hub functionality with their own applications. For more information, see:

• HotDocs Hub API Overview