Description:
This step is used to populate the Form fields in the PDF document.
Inputs
- pdfFormFile – Choose PDF Form File as a file template
- pdfOutputFileVarGlobal – Variable / Global to hold the output PDF file
- pdfVirtualFileVarGlobal -- Variable / Global to hold the output PDF virtual file path
- outputFileReadOnly -- Set output PDF as Read-Only (for fields that were set)
- pdfFieldMap -- PDF form field mappings with respective values
Returns
- True – step executed successfully
- False – step failed to execute
Usage :
Example:
Let’s build and execute the “setPDFFormFieldsDef” example.
- Create a new definition called “setPDFFormFieldsDef” and open the definition in designer mode.
- Drag a “setPDFFormFields” step to the canvas.
- Connect the dots between the “Start” and “setPDFFormFields” steps, as shown above.
- Click the “setPDFFormFields ” step to configure its “Required” properties. Provide a name for the step. Select the PDF file from the drop-down list. Provide the variable or global reference to hold the PDF output file. Provide the variable or global reference to maintain the virtual path of the PDF output file. Click the button to complete the field mappings. Click the Save button. Note: Click the "AI Predict" button for the Copilot to add new process steps that match your process description.
- Click the "PDF Form file" button. Choose and upload the PDF file from the local folder. Note: This PDF file should have text areas that can be edited.
- Click the Field Mappings button. A pop-up window is displayed for configuration. Click the Add Row button to insert an empty row. Select the PDF field names from the drop-down list. Provide the variable or global reference that holds the value. You may insert multiple field mappings by using the Add Row button. Click the Save button.
- Click the “setPDFFormFields ” step to configure its “Optional” properties. Select “On” to configure the output PDF file as read-only. Click the Save button.
- The “Logging” setting configuration is necessary for documentation and also measures the workflow progress and the percent complete. This is achieved by configuring the step state and percent fields individually, as shown in the images below. Configure the “Logging” using the following properties.
- Save the process definition, create a new instance, and then execute it. Render the process instance. Click the process step to view its properties. The step should get the virtual file URL path.
- The PDF file in this example contains the following field structure (for reference).
Configure:
This workflow step requires manual configuration (along with its data type). As an admin user, navigate to Administration> Data Types > Auto Detect. Select the data types related to this step and configure them for your FlowWright environment, as shown in the graphic below.
As an admin user, navigate to the Administration > Steps > Auto Detect menu option. Select and configure the step for your FlowWright environment, as shown in the graphic below.
Definition Sample:
You may download the sample definition(s) from the link here and later import them (drag-and-drop) to your FlowWright Process Definition (XML file) or Form Definition (HTML file) page.
Note: Please verify and complete the process steps for any missing configurations, such as file path references and database connections, after import. Then, save the definition to confirm the changes.
Click here to download the sample file.