PDF Template Editor

The PDF Template Editor provides a visual workflow for designing dynamic documents. You create a template by placing dynamic placeholders onto an uploaded PDF background.

The Template Editor works exclusively with the PDF Template class. When you create a template, an instance is automatically generated within this class, containing the fillTemplate function required to populate your document with data.

To see the complete process in action, follow our step-by-step guide.

Creating a PDF template

1

Open template mode

Select Template Editing mode from the main toolbar.

2

Define properties

Enter a unique name for your template and choose a standard page size (A4, A5, or Letter).

3

Generate instance

Click Create Template. This automatically generates the corresponding instance in your logic library.

Designing the layout

Once your template is created, you need to set up the visual background and place your dynamic fields.

Managing pages and backgrounds

To use an existing document as a layout, you must first upload the pages as separate PDF files to the Internal File Server.

1

Add blank pages

Add a blank page for each page of your source document using the Add Page icon ().

2

Set background

Drag each page file from the Resources panel onto the corresponding blank page. This sets the file as a static background.

3

Organize

Right-click a page to open the context menu. Here you can move pages up/down or manage the layering (Bring to Front / Send to Back).

Deleting a page (using the Trash icon) is a permanent action that removes the page, its background, and all placeholders on it. It is not currently possible to simply replace the background of an existing page.

Placing and configuring placeholders

Placeholders are the dynamic "slots" where your logic will insert data.

1

Add placeholder

Click the Text or Image Placeholder icon in the toolbar (, ) then click on the page to place it.

2

Assign variable

Select the placeholder and click the gear icon. Provide a variable name (e.g., firstName).

3

Style

Adjust the font, size, or colors for text, or resize the bounding boxes to define the final content area.

Data Matching

The Variable Name you enter (e.g., invoiceNumber) must exactly match the key in the data object you provide in your backend logic later. The editor adds the <> tags automatically.

Populating the template

To bring your PDF to life, use the fillTemplate function within your backend logic. This function is the engine: it takes a data object (like a JSON object from a database), merges the values into your visual placeholders, and outputs the finished PDF document. For detailed input/output specifications, refer to the PDF Templates class documentation.

To see these concepts in action, follow our step-by-step guide on automating PDF reports.

Deleting a template

If you no longer need a PDF template, you can permanently remove it and its associated function:

1. Navigate to the Functions Library.

2. Open the PDF Templates Class.

3. Right-click the specific template instance.

4. Select Remove.

This action is irreversible. Deleting an instance removes it completey. Any logic in your Flow Builder referencing this template will break.