Workflow action: Fill word document

Modified on Tue, 11 Aug at 2:19 PM

The action Fill word document fills an existing Word document with values from the transferred form data and creates a Word document or a PDF document from it again.

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

CONTENTS

Parameters
- Details for Word fill
- Storage options for the created files
Action variables
- Standard action variables
- Action specific action variables
Videos

Configuration interface of the Fill word document action. The source resource is a Word document. The output file is a PDF document or Word document.

Parameters

Details for Word fill

File: Selection of the Word document to be used. It can be form files, client files, files loaded via a URL or task attachments Word file fill. See actions for a list of supported URL protocols.
Resource URL: Enter the URL to be retrieved if External Resource URL is selected as the file.
File name for search: If as file Search process attachments using file name is selected, the file name for search can be selected here.
Type filter: This filter can be used to narrow down the search of the process attachments.

Storage options for the created files

Output file name: The name of the file to be generated. Note that the file extension pdf (output as a PDF document) or docx (output as a Word document) determines the file type, so the name must end in .pdf, .doc, or .docx. Other formats such as HTML or XML can also be created. In principle, any format that a Word document can be saved as can be used.
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.

Action variables

Actions of type Fill word document provide Action variables which can be used in subsequent actions.

Standard action variables

[%$<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 specific action variables

[%$<action name>.RESULT.fileSize%]: Size of the created Word file or PDF file, in bytes.
[%$<action name>.ERROR.message%]: Error message returned if the Word or 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, the file format of the source file is not supported, or an error occurs while generating the Word document.

Videos

Workshop-Video