Overview: Best practice in Active Documents spans three areas: setting up the module correctly, building and maintaining templates, and managing documents day-to-day. This guide covers the recommended approach for each area, with links to detailed instructions where relevant.
Please refer to the Glossary for definitions of key terms used in this article.
Setting up Active Documents
Note: This section applies to admin users and document authors.
Getting the foundations right before users start generating documents saves significant rework later. The following set up steps should be completed in order, each depends on the one before it.
Initial set up required in firm
Active Documents has dependencies between its components. Attempting to configure them out of order means going back to fix the gaps later. The recommended order is:
Letterheads
Set up the firm's branded letterhead designs first. Letterheads must exist before they can be assigned to a master template.
Cabinets and document types
Configure these before creating templates, creating or generating documents from templates at scale as these are required for filing documents and templates.
Master templates
Once letterheads are in place, create master templates to define the visual layout (letterhead, margins, page numbers) applied to generated documents.
Content templates
Build content templates after master templates are available for selection. Content templates define what the document says; master templates define what it looks like.
Set up e-signature integrations
If your firm has an e-signature solution that integrates with Active Documents, it is best to set up this integration as part of the initialisation. E-signature integrations require admin set up before any user can send documents for signature. This is a one-time configuration per firm.
Building and maintaining templates
Note: This section applies to document authors.
Templates are the foundation of document generation in Active Documents. Well-maintained templates reduce generation errors, keep the template library manageable, and make it easier for all users to find and use the right template.
Use consistent, descriptive template names
Template names appear in the template selection step during document generation, this is what users see when choosing what to generate. Avoid version numbers in names (e.g. "Engagement Letter v3").
Use names that describe the document type and context clearly, such as "Annual Tax Return: Company" or "Engagement Letter: Individual". Publish the updated version instead of creating a new template with a version suffix.
Ensure client information are complete
System fields in content templates, such as client name, ABN, contact details, and entity type, are resolved automatically from client data stored in the Active Platform at the point of document generation. If this information is missing or outdated, the corresponding fields in the generated document will return empty without flagging an error.
When building templates that rely on system fields, design with the assumption that client data is complete. For fields where gaps are likely, such as contact email, ABN, or entity type, consider using conditional merge fields to handle the empty case gracefully, or add a custom prompt field as a fallback so users are prompted to enter the value manually at generation.
For users generating documents: before generating, confirm the relevant client's information is up to date in the Active Platform. This is especially important for fields that are easy to miss in a document review, such as ABN, entity type, or contact details.
Note: Client information is managed from the client's page in the Active Platform. Any updates made there will be reflected automatically in documents generated from the update.
Understand republishing before making changes to a template
Republishing a template does not affect documents that have already been generated from it, changes are applied only to new documents generated from that point forward. This means it is safe to update and republish templates without disrupting documents already in use.
Note: If a document was generated before a template update and still needs to reflect the change, it will need to be regenerated from the updated template.
Keep templates published when ready for use
Draft templates are not available for document generation. If users report that a template is not appearing in the template selection step, check whether it is still in Draft status.
Only publish a template once it has been reviewed and is ready for use. Avoid leaving templates in Draft indefinitely.
Use conditinal merge fields to consolidate template variations
Rather than creating separate templates for different entity types (for example, a company version and an individual version of the same engagement letter), use conditional merge fields to handle variations within a single template. A single template with Show/Hide or If/Else conditions is easier to maintain than multiple near-identical templates. Fewer templates means less to update when firm details or services change.
Set document profile defaults on content template
Content templates support default values for cabinet, document type, status, financial year, and tags. Populating these on the template means they are pre-filled at generation time, reducing manual entry and filing inconsistencies. Set defaults that apply to the majority of documents generated from that template, users can override them at generation if needed.
Day-to-day document management
Note: This section applies to All Active Documents users.
The following practices apply to all users who add, generate, or manage documents in Active Documents on a regular basis.
File documents from the client screen
The recommended way to add or file a document is from the Clients page.
Navigate to the relevant client, go to the Documents tab, and select the Client Documents sub-tab. Filing from here ensures the document is correctly associated with the right client from the start.
Generate from templates where one exists
If a content template has been set up for a document type, generate from the template rather than uploading a manually edited file. Generated documents benefit from automatic field population (client name, ABN, dates, and more), consistent formatting from the master template, and version tracking in Active Documents.
Use document statuses consistently across the firm
Active Documents supports document statuses to indicate where a document is in the workflow. Using statuses consistently makes it easier to track progress, filter documents, and ensure only finalised documents are sent to clients.
As a general guide:
Draft means the document has been generated or uploaded and is being worked on, and/or is awaiting internal review.
Final means the document has been reviewed and approved. Ready to send to the client or publish as PDF.
Exact status names may vary depending on how your firm has configured Active Documents. Follow your firm's established conventions where these exist.
Publish a PDF before sharing a document with a client
Documents generated from templates are saved as Word files by default to support further editing. Before sharing a document with a client, use the Finalise & Publish PDF button to create a PDF copy. This ensures the client receives a finalised, non-editable version, and the PDF is stored alongside the original document or original copy in Active Documents for your records.
If there are multiple documents that need to be sent to a client as a single file, use the Merge PDF feature to combine them into one PDF before sharing. This keeps the client's view clean and reduces the number of attachments to manage. Active Documents will still store the original PDF copies; it will be automatically linked to the merged PDF file for easy access.
Additional resources
For detailed instructions on any of the areas covered in this guide, refer to the Active Documents support article collection:
Article | Covers |
Template types, merge fields, and how templates work together | |
Creating and managing letterheads for use in master templates | |
Building master templates including letterhead, page margins, and page numbers | |
Creating content templates with merge fields and custom prompt fields | |
Configuring Show/Hide, If/Else, and Match Value conditions in templates | |
Merging multiple documents into one PDF | |
Generating merge documents from published templates | |
Sending documents for e-signature via Annature |
