Documents - Templates - Overview

  • Updated

Overview

Templates allow users to create, configure, and manage reusable document templates in Neostella. 

Using Variables, Reserved Words, or both together, templates can automatically insert relevant platform data when a document is generated.

Templates are designed in Microsoft Word and users can customize their different formatting elements such as fonts, colors, tables, lists, among others.

 

Key Components

*Reference image of Microsoft Word text editor (1) with the Neostella Add-In, showing the Context Selection (2).

Text Editor - Microsoft Word:

Microsoft Word is used to design and configure the documents that will be generated from a template. The Neostella Word Add-In connects Microsoft Word with the platform, allowing users to add and configure fields directly within the document.

After selecting a Tenant, users must select a Context and an Object Type. These settings define the template’s data source and help categorize the documents generated from it.

NOTE: Learn more about how to configure the Add-In here: Neostella add-in Document generator - Overview

 

Add-In Editor:

The editor allows users to determine the fields that will be added to the template. To do it, users must:

  1. Start by typing: {{  This will display all the objects related to the Context and Object Type. Select one Object. This will display the related Fields that can be selected.
  2. Add the Field, System will close the field configuration with: }}
  3. To add conditionals, type WHEN. Users could either display or hide specific content based on the defined rules.
  4. Reserved words can also be used to add dynamic Lists and Tables.
  5. When the field configuration is complete, click INSERT to add the fields into the template.
  6. Once a template is created and published, it becomes available for document generation and is listed in the dashboard, where it can be managed.
GIF - Add-In use.gif

*Reference GIF of the Add-In Editor being used to insert fields for the template.

NOTE: 

 

Documents Generation Button:

Generate a document in Neostella by creating a Button Component, to do this user must:

  1. Navigate to Schema -> Views.
  2. Select the COMPONENTS  tab.
  3. Click on + New Component.
  4. Add all the required fields: 
    1. Enter a Name.
    2. Add an API Name.
  5. Select the Type: Button.
  6. Click on the Sub type and select: Document Creation.
  7. In Context, select Project.*
    1. Users can select a Document relation object.
    2. Users can select one or more of the created templates to generate the document.
  8. Click SAVE to finish the button component configuration.
  9. Now, the user must add the button to a Form or View.
  10. Once it is added, go to Cases, open the Form or View 
  11. Click the button to generate a Document, this will allow you to select the template.
  12. This will open the Source Review Modal.

NOTE: 

  • Users can create buttons for any Context, including Leads, Projects, Persons and Organizations.
  • Learn more about Views in this article: schema - views - overview

 

Review Data Sources (Cherry Pick):

This modal displays all the fields added to the template and allows users to select which fields will be included in the document when it is generated.

  • Single fields can be edited.
  • Lists/Tables will allow to toggle the fields that will be added.

Once all the fields are selected, click on GENERATE DOCUMENT.

*Reference image of the Review Data Sources modal, showing fields and a list.

*Reference image of the Review Data Sources modal, showing fields and a table.

 

Technical Considerations

  • Only Objects which allow document generation will be displayed on the Add-in.
  • Single Objects will not be selected for lists or tables.
  • Multi Objects will not display data in the single fields.

Troubleshooting

  • Fields do not show any content on the generated document: Check the object record to see if there is information. If other fields are loading information, the record is blank.
  • The button does not work: Make sure it is configured properly on the form.