Neostella add-in Document generator - Installation and Navigation

  • Updated

Install the Neostella Add-In


The Neostella Document Generator feature enables users to create reusable documents.

To install the Document Generator Add-In, follow these steps:

  1. Open Microsoft Word, and in the Home tab, click Add-Ins.
  • Search the Neostella Add-In. 
  • Locate the Add-In and click Add,

or 

  • Go to +More Add-Ins to explore. 
  • Search the Neostella Add-In.
  • Select it and click Add.

5 STEPS

1. The Neostella Document Generator feature enables users to create reusable documents.
To install the Document Generator Add-In, follow these steps:
Open Microsoft Word, and in the Home tab, click Add-Ins.

2. Search the Neostella Add-In.

3. Locate the Neostella Add-In and click Add.

4. The Neostella Add-In is displayed.

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

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

The Neostella Add-In is displayed.


Access to the Neostella Add-In


To  access to the Neostella Add-In, follow these steps:

  1. Open Microsoft Word, then access to the Neostella Add-In.
  2. Enter your Neostella platform Email address*, Password*, and click Log In

You only need to log in to the Add-In once. After that first time, when the user opens a new Word document and accesses the Add-In, the user will only need to select the Object and Object Type (If apply).

Tenant Selection

  1. In the Tenant Selection page, select the tenant to work with.
  • The available tenant(s) are displayed based on the user’s access and according to the existing tenants in Neostella and which ones the user have allowed access.
  • The Template will be associated with the selected tenant.

Object Selection

  1. In the Object Selection page, choose one of the available Objects within the selected Tenant
  • The listed Objects in the Object Selection page are those with the Allow for: Document Generation option enabled, in the Object’s settings in Neostella, under Control Center > Schema > Data.
  • If the selected Object has no associated Types, the Editor interface will appear in the side panel.
  • When the selected Object does have associated Types, the user is directed to the Object Type Selection view, where the main Object and its Types are listed.

Object Type Selection

  1. In the Object Type Selection view, choose the main Object or one of the available Types within the main Object. The Editor interface will appear in the side panel.
  2. Once the Editor interface appears, the user can format the Word document freely (fonts, colors, tables, etc.) and insert dynamic elements using the Add-In: Field Tags, Lists, Tables and Conditionals.

11 STEPS

1. Open Microsoft Word, then access to the Neostella Add-In.

2. Enter your Neostella Email address*.

3. Then enter your Password*.

4. And click Log In. You only need to log in to the Add-In once. After that first time, when the user opens a new Word document and accesses the Add-In, the user will be directed to the Tenant Selection view.

5. In the Tenant Selection page, select the tenant to work with.

6. Click on the Neostella tenant. Remember, available tenants are limited to those that exist in Neostella and that the user has permission to access.The Template is associated with the tenant selected by the user.

7. In the Object Selection page, choose one of the available Objects within the selected Tenant. The listed Objects are those with the Allow for: Document Generation option enabled.

8. If the selected Object has no associated Types, the Editor interface will appear in the side panel. When it does have associated Types, the user is directed to the Object Type Selection view, where the main Object and its Types are listed.

9. In the Object Type Selection view, choose the main Object or one of the available Types within the main Object.

10. The Neostella Add-In Editor interface appears. Here the user can format the Word document freely (fonts, colors, tables, etc.) and insert dynamic elements by using the Add-In: Field Tags, Lists, Tables and Conditionals.

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

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


Navigation Logic, Objects, Field Tags and Relationships

To understand the objects logic and their relationships, it is useful to review the following structure for accessing Fields from main objects and related objects.

Case 1:

  • Based on the diagram, when, in the Object Selection page, the Object Z is selected as the main object, the user is directed to the creation interface where they can insert Field Tags corresponding to the Fields 13, 14 and 15.
  • Also can access the Object Y and insert Field Tags corresponding to the Fields 10, 11 and 12 throughout the existing Relationship from Object Z to Object Y.
  • Also can access the Object X  (Types and Fields) throughout the existing Relationship from Object Y to Object X.

Case 2:

  • Based in the diagram, when, in the Object Selection page, the Object Y is chosen as main, the user is directed to the creation interface where he can insert Field Tags corresponding to the Fields 10, 11 and 12 
  • Also can access the Object X elements (Types and Fields) throughout the existing Relationship from Object Y to Object X.

Case 3:

Based in the diagram, when, in the Object Selection view, the Object X is chosen as main, the Object Type Selection view is displayed with the following options:

  • Object X (Main)
  • Type 1
  • Type 2
  • Type 3

The Object Y elements cannot be accessed due the relationship is built from Object Y to Object X and not from Object X to Object Y.

  • If Object X is selected: The user can insert Field Tags corresponding to the Fields 1, 2 and 3.
  • If Type 1 is selected: The user is directed to the Template creation interface where he can insert Field Tags corresponding to the Fields from the Nested Sub Types.
  • If Type 3 is selected: The user is directed to the Template creation interface where he can insert Field Tags corresponding to the Fields 4, 5 and 6.