Skip to content

Template settings

TemplateTo give you a lot of control over your templates. Allowing you to configure many aspects.

General settings

General template settings

In General settings you can change the templates name, Enable Html editing and Enable data logging.

Changing the template name is obvious, however the other two options might be less so, so lets go into more details.

Enable HTML Editing

If you enable this option then your editor will have another option next to the css option where you can change the HTML of the template.

picture 13

Warning

Combining "Advanced" & "Logic" components with direct HTML editing may result in undesirable outcomes.

If you want to work with the HTML directly, you may be better served to work exclusively with the HTML editor.

Enable Data Logging

When you are integrating with a template for the first time it can be hard to understand why your output isnt what you expect, in our experience this is often due to input data not matching your expected format, so to help debug these types of issues we added this option. When this is enabled you will get additional information.

When Enable Data logging is disabled
This is what is logged when the setting is disable, in this case we dont store any of the data sent to use for document generation. The data only lives in memory and is forgotten when the request is complete.

When Enable Data Logging is Enabled
In this example we have enabled the data logging. As you can see we now store the request and data input.

Note

Consumption quantity in these examples is 0 as the generations were triggered via the editors preview function.

Warning

Due to data being saved it is recommended that once you have finished debugging you disable this option.

PDF Settings

Numerous settings you can apply to your PDF.

Paper size

Change the size of your page to suit your needs.

Paper size options

If you want a custom size, select "custom" and you will then be given two fields to enter the custom size you want.

Note

The custom size should be provided in mm (millimeters).

Orientation

As you would expect, this changes the documents orientation, if enabled the document will be landscape.

Enable to print background graphics. This is enabled by default.

Enable if you want to have a header and footer on your documents pages. Enable Headers & footers

You can select a content block for each the header or the footer.

Select header / footer content blocks

PDF Password protection

Enabling Password protection

Once you enable password protection for your pdf, you will get the following options: Password protection options

Other options

Field Description
Password The password field accepts plain text as well as variables from your template, this includes variables created with filters.
Permit Print Permits printing of the document
Permit modify document Permits modifying the contents of the document by operations other than those controlled by PermitAnnotations
Permit extract content Permits copying or extracting text and graphics from the document.
Permit annotations Permits adding or modifying text annotations

Margins

Margins settings

Set the required margins for you documents.

Note

Your headers and footers get rendered in the margins, so ensure to take that into account when setting this up.

Cover page

Cover page options

The cover page options are a repeat of some of the options that you can set on the rest of the template. However these settings are only applied to the first page of you document.