Description:
This step retrieves all the file attachments for a Form Instance ID.
Inputs
- formInstanceID – Variable that holds the form instance ID
- filefieldMappings -Variable to hold mapping of file Control ID
- formID -Variable to hold form ID
- fileAttachmentsPath - Variable to store the file attachments path
- fileAttachmentsFileName - Variable to store the file names attached
- fileAttachmentsFormat - File list format (XML / JSON)
Returns
- True – True condition
- False – False condition
Usage:
Example:
Let’s build and execute the “getFileAttachmentsDef” example. This example requires a Process and a Form Definition.
- Create a new Form Definition called “getFileAttachmentsDef” and open the definition in designer mode.
- Drag a “bootstrapGrid, Label, TextArea, FileList, and Submit” controls to the canvas and arrange them as shown below.
- Create a new process definition called “getFileAttachmentsDef” and open the definition in designer mode.
- Drag a “RouteForm, and getFileAttachments” steps to the canvas.
- Connect the dots between the “Start” step and other steps, as shown below.
- Click the “RouteForm” step to configure the “Required” properties. Select the above Form Definition from the drop-down list. Provide a variable or global reference to store the Form Instance ID. Select the “Optional” tab and route this Form to a user or an app role. 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 “getFileAttachments” step to configure the “Settings” properties. Provide the variable or global reference that holds the Form Instance ID. Provide a variable or global reference to store the path and file names of the file attachments. 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 “getFileAttachments” step to configure the “Optional” properties. Select the above Form Definition from the drop-down list. Click the button to configure the file control ID. A pop-up window is displayed for configuration. Click the Add Row (+) button to insert an empty row. Select the FileControl from the drop-down list. Click the Save button. To store the result, select the file list formats (blank, XML, or JSON) from the drop-down list. Note: Using the “blank” option provides the list of files.
- 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 below. Configure the “Logging” using the following properties.
- Save the process definition, create a new instance, and then execute it. The workflow assigns the Form Task to the user. Click the task to render the Form.
- The Form in this example is rendered on a new page. You must provide the mandatory user input and submit the Form with the file attachments, as shown below.
- The process is completed. Render the process instance and click the “getFileAttachment” process step to view the properties. The step should get the file path and names as configured.
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.