Workflow action: Fill PDF document

Modified on Tue, 18 Jul, 2023 at 9:09 AM

The action Fill PDF document allows to fill an existing PDF form with the transferred form data.

The PDF must be prepared accordingly for this, see the section Prerequisite of the PDF form to be filled.

Alternatively, the PDF Import Tool provides the ability to upload a PDF document and create the necessary actions automatically.

CONTENTS

Configuration interface of the action Fill PDF document

Parameters

File: Selection of the PDF template to be used. Available are Files, Client Files, files loaded via a URL (external resource) or process attachments. See actions for a list of supported URL protocols.
Resource URL: Enter the URL to be retrieved if External Resource URL is selected as file.
File name for search: If Find process attachments by filename is selected as file, the filename for searching can be selected here.
Type filter: This filter can be used to narrow down the search of the process attachments.
Font for text fields: Selection of the font to be used for filling the PDF fields. Available are the fonts that are available on the server.

Output file name: Name of the output file.
Attach file to form record: If this option is selected, files created in this action will be attached to the form record. Otherwise, they are only available for other actions within the workflow processing in the same processing chain.

Actions of type Move to inbox provide Action variables which can be used in subsequent actions.

[%$<action name>.SUCCESS%]: Return whether action was successfully executed. Returns Boolean (true/false).
[%$<action name>.RESULT%]: Return all results provided by the action in structured form.

[%$<action name>.ERROR_CODE%]: The error code thrown in case of an error in the action. Empty if no error occurred.
[%$<action name>.ERROR_MESSAGE%]: The thrown error message in the action's error case. Empty if no error occurred.

[%$<action name>.RESULT.fileSize%]: Size of the created PDF file, in bytes.
[%$<action name>.ERROR.message%]: Error message returned if the PDF file could not be written to the file system, the specified URL does not match a valid format, no source file could be determined, or the file format of the source file is not supported.