Neostella add-in Document generator - Overview

  • Updated

The Neostella Add-In lets users create reusable document Templates directly in Microsoft Word. These Templates can then be used in Neostella to quickly generate documents filled with the right data just by clicking a button.

When creating a Template, users choose a Tenant and a primary Object as the main data source. From there, users insert Field Tags, which act as placeholders for data. Field Tags can come from:

  • The selected (main) Object.
  • Related Objects connected through configured Relationships (For example, a Project Object related to a Client Object).

When a document is generated in Neostella from a Template, Field Tags are replaced with the corresponding data value from the selected Object and any related Objects included in the Template. 

Templates can also include:

  • Field Tags that will be replaced for the corresponding value.
  • Lists to display multiple values from array-type Fields.
  • Tables to dynamically generate rows and columns from object-type Fields.
  • Conditionals (WHEN / WHEN-OTHERWISE) to show or hide content based on data conditions.

This feature is ideal for documents that follow a consistent structure but require different data per case, such as engagement letters, demand letters, intake forms, invoices, reports, and legal notices, while preserving Word formatting, improving consistency, and reducing manual work.

Key Terms

  • Field Tag: A placeholder inserted into a Microsoft Word Template using the Neostella Add-In. Each Field Tag represents a data Field from the Neostella platform and is replaced with real data when a document is generated.
  • Neostella Document Generator Add-In: A Microsoft Word Add-In that enables users to build dynamic document Templates using Field Tags, Conditional logic, Lists, and tables based on Neostella data.
  • Object: An Object is the primary data source used when building a Template. It defines the available Fields and data structure configured in the Neostella platform. Once an Object is selected, users can insert Field Tags from that Object and from related Objects through defined relationships.
  • Template: A Word document created using the Neostella Add-In that includes Field Tags, Conditionals, Lists, and tables for dynamic document generation.
  • Reserved Word: A special keyword used by the Neostella Add-In to perform specific functions. Reserved words cannot be used as variables or identifiers. Reserved words are:
    • List: A dynamic element that displays multiple values from an array-type Field Tag as a bulleted or numbered List.
    • Table: A dynamic table that pulls data from array-based Fields. Each row represents a record, and each column maps to Field Tags.
    • When Conditional: A rule that determines whether content is included in the generated document based on a condition. If the condition is true, the content is included; if false, it’s skipped.
    • When-Otherwise Conditional: A Conditional structure that evaluates multiple conditions in order and displays content for the first condition that evaluates as true.

How it Works

To create Word Templates by using the Neostella Add-In feature and generate documents based on these Templates in Neostella platform:

In Microsoft Word:

  1. Install the Add-In: Go to Insert > My Add-ins and install the Neostella Add-In.
  2. Log In: Open the Add-In and log in using your Neostella credentials.
  3. Select an Object: Choose the main Object that contains the data you want to use to build the Template.
  4. Create the Template: Design your document by using Microsoft word features and styles and additionally, insert Field Tags, Lists, Tables, and Conditionals using the Neostella Add-In.
  5. Save the Template Locally: Save the Word file on your device.
  6. Publish the Template: Publish the Template using the Neostella Add-In. Once published, documents can be generated.

In Neostella:

  1. Generate Documents: Users can navigate to Cases > Projects, open a project, locate the section with the configured Document Generation button, select a Template, and generate the document. 

  2. The document is generated according to the Template structure including the corresponding data, and is included in the Documents section within the project.


 

Outlined steps are detailed in the following articles.

Prerequisites & Configuration

Before generating documents, certain configurations in Neostella platform are required to ensure Templates work correctly and data is pulled accurately. Ensure that your admin configured all the following elements:

Objects Setup

  • Ensure required Objects, Fields, and relationships are configured.
  • Enable Allow for: Document Generation on the Object.
  • Objects, fields and relationships can be configured in Control Center > Schema > Data as explained in Schema - Data.

Button Setup

  • Ensure a Component built as Type: Button and Subtype: Document generation is properly configured and included in a Form interface.
  • Forms can be configured in Control Center > Schema > Forms as explained in Schema - Forms. 
  • The Document Generation Button can be configured in Control Center > Schema > Views > Components.
  • Add the Document Generation button to the Object Form.

User Permissions

  • Users need an active Neostella account with valid credentials and permissions.
  • Grant necessary permissions to users in Neostella platform. Users must have access to the Document Generator Add-In feature.
  • Ensure that an admin user provides the correct permissions to the corresponding users.

System Requirements