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 named “getFileAttachmentsDef” and open it in designer mode.
- Drag the “bootstrapGrid, Label, TextArea, FileList, and Submit” controls to the canvas and arrange them as shown below.
- Create a new process definition named “getFileAttachmentsDef” and open it 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 Form Definition from the drop-down list above. Provide a variable or global reference to store the Form Instance ID. Select the “Optional” tab, then route this Form to a user or an app role. Click the Save button. Note: Click the "AI Predict" button to have the Copilot add new process steps that match your process description.
- Click the “getFileAttachments” step to configure the “Settings” properties. Provide a variable or global reference that holds the Form Instance ID. Provide a variable or global reference to store the paths 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 Form Definition from the drop-down list. Click the button to configure the file control ID. A pop-up window appears for configuration. Click the Add Row (+) button to insert an empty row. Select FileControl from the drop-down list. Click the Save button. To store the result, select the file list format (blank, XML, or JSON) from the drop-down list. Note: Using the “blank” option returns the list of files.
- The “Logging” configuration is necessary for documentation and also measures workflow progress and 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 execute it. The workflow assigns the Form Task to the user. Click the task to render the Form.
- In this example, the Form is rendered on a new page. You must provide the required user input and submit the Form with the file attachments, as shown below.
- The process is complete. Render the process instance and click the “getFileAttachment” process step to view the properties. The step should retrieve the file path and names as configured.
Definition Sample:
You may download the sample definition(s) from the link provided and later import them (drag-and-drop) into 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 the import. Then, save the definition to confirm the changes.