On line guide/help

You are on page 13 of the online help. Navigate sequentially through the guide pages or search for a topic of interest to you.

Index Prev. Next

Generate output

Create output PDF file

At the end of the process, to generate the output file, you need to use the output section


Output

This element defines where to send the output (the PDF document) and the file name. The file name can be made dynamic using placeholders.

Elements / attributes of the <output> element:

<dest> (or <destination>) Output destination. Possible values:
I Send the file inline to the browser (default). The name is used when the "Save as" option is selected in the browser.
D Send the file to the browser and force a file download with the given name.
F Save the file on the server with the given name (path and file name). Nothing is sent to the browser.
FI Equivalent to F + I
FD Equivalent to F + D
S Return the document as a string: the PDF is returned by the BuildReport() method (the name is ignored).
E Return the document as a base64 mime multi-part email attachment (RFC 2045): it is returned by the BuildReport() method.

<name> (or <filename>) File name. If not set, the default name "document_YYYYMMDD_hhmmss.pdf" is used, where YYYYMMDD is the current date and hhmmss the current time.

<isUTF8> Not used at the moment: it can be omitted.

Basic output section example (shows the PDF in the browser)

Example: get the PDF document as a string (destination S), for example to save it in a database or to send it as an email attachment.

Get the PDF document as a string (version 1.0.11 or later)

The output element is usually placed in the last section of the template, not linked to data, so that the document is generated once, when all the other sections have been processed. Before version 1.0.11 the output element was ignored and the PDF was always sent inline to the browser (as with destination I).