Skip to main content
Use Template Builder to create a Template visually. The builder converts blocks into .tpl code, so operators can define report structure without writing the Template file manually.

​
Objective

Build a Template from visual blocks and save it for future Report generation. For example, a monthly transaction Template can use fixed text for the header and a Loop for each transaction row. It can also use Variable blocks for fields such as amount and date, and an Aggregation block for the total.

​
When to use

Use Template Builder when:
  • operators need to create a Template without editing .tpl code.
  • the report structure depends on fields, loops, conditions, or totals from a Data Source.
  • the team wants to download the generated .tpl file after building it.
Use .tpl upload instead when a technical team already created and reviewed the Template outside the Console.

​
Before you start

Confirm:
  • at least one relevant Data Source exists if the Template needs database fields. It can be an internal source already configured for the environment or an external source added from Data Sources.
  • you tested the Data Source when connection health is uncertain. The Data Sources sidebar lists its tables and fields.
  • you know the expected output format: XML, HTML, CSV, TXT, or PDF.
  • the operator knows the report structure, such as required header, rows, totals, or conditional sections.
Blocks define the output structure. Filters applied during Report generation define which records enter that structure.

​
Step by step

1

Open the builder

Go to the Templates page and click Template Builder.
2

Name the Template

Edit the Template name in the header. Use a name that operators can identify during report generation. Then enter the Category, the report family, such as cadoc.
3

Choose the output format

Select XML, HTML, CSV, TXT, or PDF.
When you select PDF, the generated template code uses HTML format. The code is converted to PDF during report generation.
4

Add blocks to the canvas

Use the blocks toolbar to add structure. Common blocks are Text, Variable, Loop, Conditional, and Aggregation.
5

Connect fields from Data Sources

Use the Data Sources sidebar to browse schemas, tables, and fields. Click a field to add a Variable block for that field.
6

Review the code or the preview when needed

Switch from Visual to Code to inspect a read-only local approximation of the .tpl code. Switch to Preview to see the Template rendered by Reporter with placeholder values, not real data.
7

Save the Template

Click Save. The builder validates required block fields, generates .tpl code, and saves the Template.

​
Field guide

​
Builder-level fields and controls

​
Block field guide

​
Block types

​
Working with blocks

  • Click a block type in the toolbar to add it to the canvas.
  • Drag blocks to reorder the output.
  • Configure each block inline. For example, a Variable needs a source and field, while a Conditional needs a condition.
  • Use Inline when the block should render without a line break after it.
  • Use Trim whitespace to remove extra spaces around block output.
  • Use Duplicate to copy a configured block.
  • Use Delete to remove a block from the Template.
Container blocks such as Loop, Conditional, Section, and With can hold child blocks. Use them when the output needs repeated or grouped content.

​
Expected result

After you save, the Template appears on the Templates page. You can select it in the Generate Report wizard. You can also download the generated .tpl file from the builder.

​
Common errors and care points

The sidebar only shows configured Data Sources. If the expected internal source does not appear, confirm setup with the Reporter administrator. If the report needs an external database, add and test that Data Source before using database fields in the Template.
The builder validates blocks during save. If a block has no source, field, condition, or expression, fix that block before you save.
Template blocks define the file structure. You select report filters later, during report generation. They decide which records enter the output.
PDF output comes from HTML. Build the Template as HTML-compatible content when the final output format is PDF.

​
Next steps

  • Use Generate a Report to test the Template with real filters.
  • Use Update a Template to change the name, output format, category, or .tpl file later. The builder does not open a saved Template.
  • Use Add a Template if you need to upload a prepared .tpl file instead.

API equivalent

Call Generate template code endpoint, then upload the generated .tpl file with Upload template endpoint.