Document Templates

The TIVITY platform enables you to generate documents and emails using templates the easy way.

Introduction

The Template Designer allows users to create standardized documents like letters or reports and fill them dynamically with information. So, repeatedly reports or personalized letters to a variety of receivers can be created with ease.

In this article we will introduce you to the versatile features of the Template Designer.

Manage Templates

You can edit, delete, and clone templates, or export your template definition as well as texts for use in another app. Head to your Workspace > Apps and click on the gear icon to activate the configuration mode of your apps. Next, navigate to the app you want to configure and click on the gear icon. In the Views section you click on Templates to access the list of existing templates.

Access the Template Designer in your apps

Create a Template

Click on New Template to create a new template definition to use in your application. Get Started with Template Designer describes the process of creating a document template in detail.

Edit a Template

Click on the template name from the list to open the template designer. The remaining functionality is identical to creating a new template, as described in Get Started with Template Designer.

Edit a template and validate before saving

Modify your existing template as needed, optionally Validate the current definition, and click Save to store your changes.

Delete a Template

Either you open the drop-down menu on the right-hand side to the template name and choose Delete or you click on the template name from the list and click on Delete to remove the template.

Delete a template from your application

Confirm to delete the selected template with a click on Yes, delete it.

Clone a Template

In scenarios where you need the same template with minimal variations you don't have to create each template from scratch but you can duplicate an existing one. Open the drop-down menu on the right-hand side to the template name from the list and choose Clone.

Duplicate an existing template to speed up multiple configurations

After a short while a new template with a - Copy suffix will be added to the list of templates. You can create multiple copies of the same template.

Prior to be able to clone a template it has to be validated successfully. If the copying process fails, open the template for review and validate it.

Used By

Apart from being able to create and manage templates it is interesting to know whether and how a particular template is used in an application. Open the drop-down menu on the right-hand side to the template name in the list and choose Used By.

The Template Designer shows you in which Layouts, Classes, Functions, Selections, Templates, and Workflows the selected template is used.

Used By provides you information where a template has been used

Click on Close to return back to the list of templates.

Export Templates

To save your templates for backup or to transfer templates between applications and workspaces you would export them. Open the drop-down menu on the right-hand side to the template name in the list and choose Export.

Export your templates for backup or for use in other applications

The platform is going to assemble a ZIP archive and will offer you to download it to your system. The default file name is templates.zip.

The generated ZIP archive is potentially password-protected.

Import Templates

ToDo: Import fails due to invalid format of previously exported templates file.

Navigate to your Workspace > Apps and click on the gear icon to activate the configuration mode of your apps. Next, click on the gear icon of the app you want to configure. In the Views section you click on Templates to access the Template Designer. Click Import Templates.

Next, either drop an exported file from your system into the designated area or click on one of the available options to import your templates. Click Execute after the file has been uploaded completely.

Import of templates to transfer definitions between apps

After successful import the templates either have been created as new entries based on their original name or the suffix - Copy has been added to any existing template to avoid name conflicts.

Export Texts

Functionality is broken at the moment.

...

Import Texts

Functionality is broken at the moment.

...

Return to the Workspace

After you completed your changes in the Template Designer you scroll down to the bottom of the Config Mode in the left-hand side Workspace pane and click on Leave Config Mode. Then you click on the tick next to the Apps caption to return to your Workspace.

More on Template Designer

Working with document templates...