Neostella add-in Document generator - how to manage Neostella Add In templates

  • Updated

How to Create a Template

Users can create their own Word Template and customize it according to your preferences: fonts, colors, tables, Lists, and so on. 

The key feature is the option to add:

  • Field Tags and Concatenated Field Tags that can be inserted anywhere in the Template.

Think of a Field Tag as a “fill-in-the-blank” linked to data (like a name, date, or address) from your chosen Tenant, Object and Object Type. 

  • Lists to display the options from a List based Field Tag.
  • Tables to build a table with dynamic data from an array based Field Tag.
  • Conditionals to determine whether a block of content in the Template should be included and displayed in the generated documents. 

To insert these dynamic elements into a Template, follow these steps:

  1. In a Word file, after accessing the Neostella Add-In, and selecting the Object and Object Type, go to the Editor interface.
  2. The user can Insert Field Tags from the main Object, use Relationships to insert Field Tags from other related Objects, use Saved Field Tags, create When Otherwise Conditionals, create Lists and Tables.

See the following articles for detailed instructions.

How to Insert a Field Tag

To insert one or more Field Tags in a specific part of the document’s body, follow these steps:

  1. Place the cursor in the document where the user wants to insert the Field Tags(s).
  2. In the Editor tab, located in the Neostella Add-In, type {{. 

The Object-name (Main) from the selected source is displayed.

  1. Select the displayed Object-name (Main). 

      All related Fields and Relationships are listed. 

  1. In the displayed dropdown: 
  • Select a Field or
  • Select a Relationship to locate and select the desired Field. If a Relationship is selected, the user can choose one of its associated Fields or continue navigating through its Relationships until reaching the Field to insert.
  • When a Relationship is selected, its associated Fields and nested Relationships are displayed.
  • Relationships are Listed by name and labeled as (Relationship) →.
  1. Click INSERT to add the Field Tag in the template body.
  • If required, repeat steps 2–6 to add and concatenate Field Tags before inserting them into the document. The Field Tags labels will appear in the editor, separated by the & symbol.
  • It is highly recommended to save the Field Tags as a Variable and assign a custom name before inserting it, as this will make it easier to reuse throughout the entire document Template. For more information on saving variables, read How to Save a Variable.
  • If one Field Tags is inserted, an element with a syntax similar to this appears in the document: 
{{ object.type.Fieldname }}
  • If 2 or more Field Tags are inserted, the corresponding elements with a syntax similar to this appear in the document: 
{{ object.type.Fieldname 1 }} {{ object.type.Fieldname 2 }} {{ object.type.Fieldname 3 }}
  • If the user clicks a Field Tag in the Word Template, the corresponding Field Tag label is displayed in the Add-In Editor. 

15 STEPS

1. To insert one or more Field Tags in a specific part of the document’s body, place the cursor in the document where the user wants to insert the Field Tags(s).

2. In the Editor tab, located in the Neostella Add-In, type {{.

3. Type {{.

4. The Object-name (Main) from the selected source is displayed.

5. Select the displayed Select the displayed Object-name (Main).

6. All related Fields and Relationships are listed.
In the displayed dropdown select a Field.

7. Click INSERT to add the Field Tag in the template body.

8. The field tag is inserted.

9. Now let-s insert a Relationship Field Tag. Place the cursor in the document where the user wants to insert the Field Tags.

10. In the Editor tab, located in the Neostella Add-In, type {{.

11. The Object-name (Main) from the selected source is displayed. Select the displayed Object-name (Main).

12. Now select a Relationship to locate and select the desired Field. If a Relationship is selected, the user can choose one of its associated Fields or continue navigating through its Relationships until reaching the Field to insert.

13. Next, select the Field.

14. And then click INSERT to add the Field Tag in the template body.

15. That's it. You're done.

https://www.iorad.com/player/2687390/Doc-Gen---How-to-Insert-a-Field-Tag?iframeHash=watchsteps-1&lang=en

How to Insert a List

To insert a List that pulls the different options from a collection Field Tag, follow these steps:

  1. Place the cursor where the user wants the List to be included in the document.
  2. Apply the bullet or numbering style for the List.
  3. In the Editor tab, located in the Neostella Add-In, type the reserved word List.

A Field is displayed.

NOTE: Reserved words are not case-sensitive.

  1. In the displayed field, type {{. 

The Object-name (Main) from the selected source is displayed.

  1. Select the displayed Object-name (Main). 

      All related Fields and Relationships are listed. 

  1. In the displayed dropdown: 
  • Select a Field or
  • Select a Relationship to locate and select the desired Field. If a Relationship is selected, the user can choose one of its associated Fields or continue navigating through its Relationships until reaching the Field to insert.
  • When a Relationship is selected, its associated Fields and nested Relationships are displayed.
  • Relationships are listed by name and labeled as (Relationship) →.
  • It is highly recommended to save the Field Tags as a Variable and assign a custom name before inserting it, as this will make it easier to reuse throughout the entire document Template. For more information on saving variables, read How to Save a Variable.
  1. Click INSERT to add the List in the Template body.
  • Selectable Field Tags should be array-type Field Tags that store multiple values, such as a list of items or options.
  • After publishing a Template that includes an inserted List, any generated documents will contain the data from the configured Field Tag. 

14 STEPS

1. To insert a List that pulls the different options from a Field Tag, follow these steps.
Place the cursor where you want the List to be included in the document.

2. Apply the bullet or numbering style for the List. In this case, click bullets.

3. In the Editor tab, located in the Neostella Add-In, type the reserved word List. Remember, reserved words are not case-sensitive.

4. Next, in the displayed field, type {{.

5. The Object-name (Main) from the selected source is displayed. Now select the displayed Object-name(Main).

6. All related Fields and Relationships are listed. In the displayed dropdown. Select a Field or Select a Relationship to locate and select the desired Field. In this case click the Attendees relationship.

7. Next, select a Field.

8. Save the List as a Variable and assign a custom name before inserting it; this will make it easier to reuse throughout the entire document Template.
Now Set the Variables Name.

9. For example you can type the Attendees in Set the Variable Name field.

10. And then click the Save icon.

11. The variable is saved successfully.

12. Then, click INSERT to add the List in the Template body.

13. The Field Tags that compose your List are inserted within your document.

14. That's it. You're done.

https://www.iorad.com/player/2687402/Doc-Gen---How-to-Insert-a-List?iframeHash=watchsteps-1&lang=en

 

For example: The Field Tag Country stores the following List of items: Spain, Argentina, Canada, and the United States.

Country = ["Spain", “Argentina”, “Canada”, “United States”]

Country
Spain
Argentina
Canada
United States

If the Field Tag Country is included in the Template, as a List, once the document is generated in Neostella platform, the output should be:

  • Spain
  • Argentina
  • Canada
  • United States

How to Insert a Table

Users can insert tables into the Template that dynamically pulls data from an existing Object in the tenant. Each Object can contain Relationships and those related Objects include multiple Fields. These Fields can be mapped to the table’s columns, allowing the cells to be auto-populated with the data from the specified Fields.

When configuring a table, only the Object’s Relationships can be selected as the data source. Once a Relationship is selected, only the Fields within that related Object will be available to map to the table columns.

To insert a Table that pulls the data from Field Tags, follow these steps:

  1. Place the cursor where the user wants the table to be included in the document.
  2. In the Editor tab, type the reserved word TABLE.  

Reserved words are not case-sensitive.

  1. (Optional) Mark the Set row 1 as headers checkbox to insert the first row of the Field Tag’s data as a header. 
  2. In the Select a Field dropdown, choose the Relationship that contains the Fields the user wants to insert in the table. 

The Column 1 section with the Select Value dropdown and the icon is displayed, along with the + Add Column button.

  1. In the displayed dropdown, click the Select Value (s) that will be included in Column 1.
  • The Select Value dropdown displays the list of existing Fields in the selected Object.
  • The user can select one or more Fields within a single column. These selected Fields will be concatenated into a single cell in the respective column.
  1. To add a new column, click the + Add Column button. The Column N section is displayed. Repeat steps 4-5 to configure additional columns.
  • To delete a column, click the icon.
  1. Click INSERT to add the configured table in the Template body.

After publishing a Template that includes inserted tables, any generated documents will contain the data for the configured columns.

20 STEPS

1. Place the cursor where you want the table to be included in the document.

2. In the Editor tab, type the reserved word TABLE.
Remember, reserved words are not case-sensitive.

3. Optionally you can mark the Set row 1 as headers checkbox to insert the first row of the Field Tag’s data as a header.

4. In the Select a Field dropdown, choose the Relationship that contains the Fields you want to insert.

5. In this case, select projects.

6. And now, in the displayed dropdown, select Attendees. Remember, here are listed the object relationships.

7. In the displayed dropdown, click the Select Value and select the field that will be defined as Column 1.

8. In this case, select Name.

9. To add a new column, click the + Add Column button.

10. The Column 2 section is displayed. Repeat previous steps to configure additional columns.
In this case click Select Value.

11. And then select Last Name.

12. Lets configure a third column. For that, again, click +Add Column.

13. And then, click Select Value.

14. Now, select the Address field.
Remember, to remove a column, you can click the delete icon next to the column.

15. Now, save this setup as a variable. For that, enter the table name in the Set Variable Name field.

16. And now, click the Save icon.

17. The Variable was saved successfully! message appears. Remember, you can find your saved variables in the Variables tab.

18. Now click INSERT to add the Table in the template body.

19. The table structure with the corresponding Field Tags is displayed in your template.

20. That's it. You're done.

https://www.iorad.com/player/2689084/Doc-Gen---How-to-Insert-a-Table?iframeHash=watchsteps-1&lang=en

For example: The Object Client contains the following Fields: 

Client = [First Name, Last Name, Date of Birth, Country].

And the Object Client has the following instances or arrays of data for different clients:

  • Client 1: [“John”, “Smith”, “09/09/1980”, “Spain”]
  • Client 2: [“Louis”, “Thomas”, “03/01/1992”, “Argentina”]
  • Client 3: [“Chad”, “Lee”, “01/01/2000”, “Canada”]

If the user insert a table into the Template, and its columns were configured as follows:

  • Column 1: First Name Last Name (There are two concatenated Field Tags)
  • Column 2: Date of Birth
  • Column 3: Country

The generated document will display the data in the corresponding table’s columns, using the Word style defined for that table in the Template.

Generated Document Table Output Example: 

John Smith 09/09/1980 Spain
Louis Thomas 03/01/1992 Argentina
Chad Lee 01/01/2000 Canada

Conditionals Overview

Conditionals lets users control which parts of a document appear when it’s generated. Think of them as simple rules: if something is true, show the content; if it’s not, hide it.

When a document is generated from a Template, the system automatically checks the data against the rules in the template and includes only the content blocks that meet those conditions.

WHEN Conditional

How it Works

A WHEN Conditional checks one rule. (It can be compared with a traffic light for a content block) 

  • WHEN the condition is TRUE → the content block within the Conditional appears or is executed in the generated document.
  • WHEN the condition is FALSE → the content block within the Conditional is skipped (not shown or executed).
  • WHEN Conditional Structure

A WHEN condition is structured as follows: 

WHEN Field Tags Conditional OPERATOR Value 

Content block

Each element in a WHEN Conditional is described below:

  • WHEN: The reserved word that starts the condition.
  • Field Tags: A Field from the selected source. The data contained in this Field Tags will be compared with a specific value.
  • Conditional OPERATOR: A logical operator that defines the condition. 
  • Value: The value to be compared with the data in the selected Field Tags.

NOTE: Operators that do not require a comparison value: Is empty, Is not empty, Is true, Is false.

  • Content block: This content within the WHEN statement will be displayed/executed if the condition is TRUE.

Read the WHEN Conditionals Example for a working example.

WHEN-OTHERWISE Conditional

How It Works

A WHEN-OTHERWISE Conditional checks multiple rules in sequence. (It can be compared with a series of traffic lights for different content blocks.)

The WHEN-OTHERWISE Conditional evaluates each condition in order, starting with the first WHEN.

  • WHEN the first condition is TRUE → its content block is displayed and no further conditions are checked.
  • WHEN the first condition is FALSE → the next OTHERWISE WHEN condition is evaluated.

This process continues until one condition is TRUE, or all conditions have been checked.

  •  WHEN Conditional Structure

A WHEN-OTHERWISE condition is structured as follows: 

WHEN Field Tags Conditional OPERATOR Value
Content block in the first condition.

OTHERWISE WHEN Field Tags  Conditional OPERATOR Value 

Content block in the second condition.

OTHERWISE WHEN Field Tags  Conditional OPERATOR Value 

Content block in the third condition.

OTHERWISE WHEN Field Tags N Conditional OPERATOR Value N

Content block in the N condition.

Read the WHEN-OTHERWISE Conditionals Example for a working example.

How to Build and Insert a WHEN Conditional

To build a WHEN Conditional, follow these steps:

  1. Place the cursor where the user wants the Conditional statement to be shown in the document.
  2. In the Editor tab, type the reserved word WHEN. 

Reserved words are not case-sensitive.

  1. In the displayed Field type {{. 

The Object-name (Main) from the selected source is displayed.

  1. Select the displayed Object-name (Main). 

      All related Fields and Relationships are listed. 

  1. In the displayed dropdown: 
  • Select a Field or
  • Select a Relationship to locate and select the desired Field. If a Relationship is selected, the user can choose one of its associated Fields or continue navigating through its Relationships until reaching the Field to insert.
  • When a Relationship is selected, its associated Fields and nested Relationships are displayed.
  • Relationships are Listed by name and labeled as (Relationship) →.
  1. Once the desired Field is selected, select the desired Conditional Operator.
  • Available Operators by Field Type are:
Field Type Available Operators

Number

Currency

 Equals, Not equal to, Greater than, Less than, Greater than or equal to, Less than or equal to, Is empty, Is not empty

Text

Email

 Equals, Not equal to, Contains, Does not contain, Starts with, Ends with, Is empty, Is not empty
Date On, Not on, Before, After, Between, Is empty, Is not empty
  • Operators that do not require a comparison value: Is empty, Is not empty, Is true, Is false.
  1. In the enabled Field, type the value to complete the condition, and press Enter to confirm.
  • Conditional comparisons are case-sensitive, so make sure uppercase and lowercase letters match exactly.
  • Ensure the entered information matches the selected data type Field Tags format to guarantee an accurate comparison.
  • It is highly recommended to save it and assign a custom name before inserting it, as this will make it easier to reuse throughout the entire document Template. For more information on saving variables, read How to Save a Variable.

For example: In a Date Field with YYYY-MM-DD format, a valid value is 2025-08-14.

  1. Click INSERT. 

A syntax similar to this appears in the document: 

{{ WHEN Condition 1 }}
Add Your Result Here...
{{ End Conditional }}
  1. Go to the Template body and in Add Your Result Here… (between the initial and final Condition Tags), include the content that will be displayed in generated documents when the condition is true.

For more information, please read Conditionals Overview.

How to Build and Insert a WHEN OTHERWISE Conditional

To build a When OTHERWISE Conditional, follow these steps:

  1. Follow steps 1 to 7 from: How to Build and Insert a WHEN Conditional.
  2. Once the first Conditional is built, click +OTHERWISE, and configure the condition similar to steps 3-7 from:  How to Build and Insert a WHEN Conditional.
  • Add as many OTHERWISE blocks as required.
  • It is highly recommended to save it and assign a custom name before inserting it, as this will make it easier to reuse throughout the entire document Template. For more information on saving variables, read How to Save a Variable.
  1. Click INSERT to add the configured Conditional in the Template body.

A syntax similar to this appears in the document: 

{{ When otherwise Conditional Condition 1 }}
Add Your Result Here...
{{ When otherwise Conditional Condition 2 }}
Add Your Result Here...
{{ When otherwise Conditional Condition 3 }}
Add Your Result Here...
{{ End Conditional }}
  1. In Add Your Result Here… (between the initial and final Conditional tags), include the content that will be displayed in generated documents when the corresponding condition is true.

For more information, please read Conditionals Overview.

How to Save a Variable

Users can create a custom-named Variables by:

  • Saving existing Field Tags under a new name.
  • Combining (concatenating) existing Field Tags, or 
  • Saving WHEN Conditionals, Lists, or TABLES setups.
     

This makes it easier to reuse variables throughout the entire document Template.

All saved Variables are Listed in the Variables tab, where the user can quickly find and add them when building your Template.

To save a Variable, follow these steps:

  1. In the Editor tab, after adding the Field Tag(s) or configuring When Conditionals, Tables, or Lists, enter a new variable name in Set Variable Name.
  2. Click the chevron icon to select the variable’s data type.
  3. Click the Save icon.
  4. Then click the save icon. The Variable was saved successfully! message appears.
  • Available Data Types are:
    • Text (Default)
    • Number 
    • Date
  • You can find your saved variables in the Variables tab.
  • Saved variables will only be available in the current Template.
  • Click the Edit icon to modify a saved variable: the user can change its assigned name and modify used Field Tags(s), When Conditionals, Tables, or Lists.
  • Click the Delete icon to remove saved Variables. 

9 STEPS

1. Users can create a custom-named Variables by saving Field Tags, combined Field Tags, or When, Lists or Tables setups.

2. To save a Variable in the Editor tab, after adding the Field Tag(s) or configuring When Conditionals, Tables, or Lists, click Save As Variable.

3. Then, enter a new variable name in Set Variable Name.

4. For example, type Full data in Set Variable Name.

5. And then click the save icon.

6. The Variable was saved successfully! message appears.

7. You can find your saved variables in the Variables tab. Click the Variables tab.

8. Here is your new variable.

9. That's it. You're done.

https://www.iorad.com/player/2689407/Doc-Gen---How-to-Save-a-Variable?iframeHash=watchsteps-1&lang=en

How to Insert Saved Variables

To insert one or more saved Variables in a specific part of the document’s body, follow these steps:

  1. Place the cursor in the document section where the user wants to insert the Variable(s).
  2. Go to the Variables tab, where the user can see the list of saved Variables.
  3. Select the checkbox next to one or more Variables the user wants to insert.
  4. Once the desired Variable(s) is (are) selected, click INSERT. 
  • When the saved Variable is inserted, an element with a syntax similar to this appears in the document: 
{{ saved variable name 1 }} {{ saved variable name 2 }} …
  • If the user clicks one element, the corresponding Field Tags are displayed in the editor.

6 STEPS

1. To insert one or more saved Variables in a specific part of the document’s body, place the cursor in the document section where you want to insert the Variable or Variables.

2. Go to the Variables tab, where you can see the list of saved Variables.

3. Select the checkbox next to the Variables you want to insert.

4. Once the desired Variable(s) is (are) selected, click INSERT.

5. When the saved Variable is inserted, an element with a syntax similar to this appears in the document: {{ saved variable name 1 }} {{ saved variable name 2 }} …

6. That's it. You're done.

https://www.iorad.com/player/2689411/Doc-Gen----How-to-Insert-Saved-Variables?iframeHash=watchsteps-1&lang=en

How to Edit Saved Variables

To edit a saved Variable, follow these steps:

  1. Click the Variables tab, where the user can see the list of saved Variables.
  2. Locate the Variable to edit and click the Edit icon to change it. The user can change the variable assigned name and modify the configured Field Tags(s), When Conditionals, Tables, or Lists accordingly.
  3. After applying the changes, click the save icon. The Variable was saved successfully! message appears.

6 STEPS

1. To edit a saved Variable, click the Variables tab, here you can see the list of saved Variables.

2. Locate the Variable to edit and click the Edit icon to change it.

3. Here you can change the variable name and modify the configured Field Tags(s), When Conditionals, Tables, or Lists accordingly.

4. After applying the changes, click the save icon.

5. The Variable was saved successfully! message appears and the changes are applied.

6. That's it. You're done.

https://www.iorad.com/player/2689436/Doc-Gen---How-to-Edit-Saved-Variables?iframeHash=watchsteps-1&lang=en

How to Delete Saved Variables

To delete a saved Variables, follow these steps:

  1. Go to the Variables tab, where the user can see the list of available Variables.
  2. Locate the Variable to delete, and click the Delete icon. A confirmation window is displayed.
  3. Click DELETE to confirm the action. The Variable Deleted Successfully message appears.

5 STEPS

1. To delete a saved Variable, click the Variables tab, where you can see the list of saved Variables.

2. Locate the Variable to delete, and click the Delete icon.

3. Click DELETE to confirm the action.

4. The Variable Deleted Successfully message appears and the variable is removed from the list.

5. That's it. You're done.

https://www.iorad.com/player/2689444/Doc-Gen---How-to-Delete-Saved-Variables?iframeHash=watchsteps-1&lang=en

Additional Options

To access additional options, follow these steps:

  1. Place your cursor in the top-right corner of the Neostella Add-In panel.
  2. Click the chevron icon that appears.
  3. From the dropdown menu, select the desired option.

Available options are:

  • Get Support: the user will be directed to Neostella Support Center. 
  • Reload: Reload the Neostella Add-In panel; the user can select the tenant and main Object to start using the Add-In.
  • Attach Debugger: Opens the DevTools window.
  • Security Info: Displays security info as URL, SSL, Source, Runtime, and Version. 

How to Reload the Neostella Add-In Panel

To reload the Neostella Add-In Panel, follow these steps: 

  1. Place your cursor in the top-right corner of the Neostella Add-In panel.
  2. Click the chevron icon that appears.
  3. From the dropdown menu, select Reload.

5 STEPS

1. To reload the Neostella Add-In, place your cursor in the top-right corner of the Neostella Add-In panel.

2. Then click the chevron icon that appears.

3. From the dropdown menu, select Reload.

4. The panel is refreshed automatically once you select Reload.

5. That's it. You're done.

https://www.iorad.com/player/2689470/Doc-Gen----How-to-Reload-the-Neostella-Add-In-Panel?iframeHash=watchsteps-1&lang=en

How to Save a Template

Once your Template is ready, locally save the Word file to your device. The user then can Publish the Template to begin generating documents.

 

How to Publish a Template

After saving your Word Template locally, the user can publish it. 

To publish a Template document, follow these steps:

  1. In the saved Word Template, open the Document Generator Add-In and click Publish Template. The Create Template pop-up window is displayed.
  2. Enter the Template Name, select the Template Type, and click CREATE. The File uploaded successfully message appears.
  • The Template Name the user enters is assigned to the published Template in Neostella’s AWS S3 bucket. This is not the same name as the file name the user used to save it locally.
  • The available options in the Template Type dropdown include: Header/Footer and Content. 
    • Header/Footer: Select this option when the Template type corresponds to a header or footer.
    • Content: Select this option when the Template type includes the main content.
  • Once a Template is published, the Save button is enabled. When editing a published Template, the user can apply changes by clicking Save.
  • Once a template is published, users can generate a document by accessing the Cases workspace, navigating to Projects, opening a project, and going to the section that contains the document generation button. From there, they select the template and the document is generated including the project’s data.

7 STEPS

1. In the Word Template, open the Document Generator Add-In and click PUBLISH TEMPLATE.

2. The Create Template pop-up window is displayed. Now, enter the Template Name.

3. And then select the Template Type.
Select the Header/Footer option when the template corresponds to a header or footer.
Or select the Contentoption when the template contains content.

4. In this case, select Content.

5. And now click CREATE.

6. The File uploaded successfully message appears.

7. That's it. You're done.

https://www.iorad.com/player/2689507/Doc-Gen---How-to-Publish-a-Template?iframeHash=watchsteps-1&lang=en