Description:
This step removes the file attachments from a form instance.
Inputs
- formInstanceID – a variable that holds the form instance ID
- filefieldMappings -Variable to hold a 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 “removeFormFileAttachmentsDef” example.
- Create a new definition called “removeFormFileAttachmentsDef”
- Select the definition and click the “design” button
- Drag a “removeFormFileAttachments” step from the toolbox
- Connect the dots between the Start and “removeFormFileAttachments” step
- Click the “getFileAttachments” step to configure its “Required” properties. Provide a step name. Provide a variable/global reference to store form instance ID. Click the Save button.
- Select the form definition from the drop-down list. Click the button to map the form files to be removed.
- A popup window is displayed for configuration. Click the Add Row button to insert an empty row. Provide the file ID and the file name to be removed. Select the RemoveAllFiles checkbox to remove all attached files. Click the Save button. You may insert multiple mappings by using the Add Row 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.
- Submit a form with a few attached files as below. Take note of the form instance ID.
- Save the process definition, create a new instance, and execute. Provide the form instance ID (previously created with some file attachments) to the variable as shown here. Click the Create and Execute button.
- Render the process instance to verify the completion status.
- Render the form instance to view the file attachments. The files have been removed from the form instance as below.
Definition Sample:
You may download the ZIP file and extract the sample definition(s) from the link here and later import it (drag-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.