Description:

This step retrieves information about a file from the file system.

The Get File Information workflow step examines a specified file and extracts commonly used file properties, including the file name, file extension, file name without the extension, file path, and file size in bytes. Each property can optionally be stored in a FlowWright Variable or Global Variable for use later in the workflow.

This step provides an efficient way to automate file validation, document processing, reporting, conditional workflow routing, and file management without requiring custom code.

The step supports:

• Retrieving file name
• Retrieving file extension
• Retrieving file name without extension
• Retrieving full file path
• Retrieving file size in bytes
• Storing file information in Variables or Global Variables
• Integration with file processing workflows

This step can be used for:

• File validation
• Document processing
• File routing
• Reporting
• File management
• Audit workflows
• Business process automation

Usage:

The Get File Information step is typically placed before document processing, validation, uploading, archival, or conditional routing activities that require file properties.

The workflow examines the specified file, retrieves the requested information, stores the configured values in workflow Variables or Global Variables, and continues processing based on whether the file exists.

A typical workflow might look like this:

Once the file information has been retrieved, later workflow steps can:

• Validate file extensions
• Route files based on size
• Generate document names
• Upload files to the DMS
• Send notifications
• Create audit records
• Continue document processing workflows

The specified file must already exist and be accessible before this step is executed.

Example:

Let’s build and execute the “getFileInfoDef” example.             

• Create a new definition named “getFileInfoDef" and open it in designer mode. 
• Drag the “getFileInfo” step to the canvas.
• Connect the dots between the “Start” and “getFileInfo” steps, as shown above.
• Define a variable or a global to store the file information.
• Click the “getFileInfo” step to configure its “Required” properties. Provide a name for the step and the file path on the application server. 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 “getFileInfo” step to configure its “Optional” properties. Provide a variable or global reference to store the file name, file extension, file path, file size, and the file name without the extension. Click the Save button. 

• 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 Process Instance and execute it. When the workflow reaches the Get File Information step, FlowWright checks whether the specified file exists. If the file is found, FlowWright retrieves the configured file properties, stores them in the specified Variables or Global Variables, and follows the Found return path. If the file cannot be located or accessed, the workflow follows the NotFound return path. Click the process step to view its properties. The step should successfully retrieve the requested file information and populate the configured Variables or Global Variables with the corresponding values.

Tips:

• Verify that the specified file path is valid before executing the workflow.
• Store only the file properties required by subsequent workflow steps.
• Use the retrieved file extension to validate supported file types before processing.
• Use the file size to enforce business rules or upload limits.
• Use workflow variables to dynamically specify file paths during execution.
• Combine this step with the Remove Blank Pages, Create Document, Upload File, PDF Validate Signature, or Conditional Routing workflow steps to automate document processing.
• Use the Found and NotFound return paths to implement appropriate success and error handling.

Notes:

• The specified file must be accessible to the FlowWright server.
• Each file property is optional and is only stored if a corresponding Variable or Global Variable is configured.
• The file size is returned in bytes.
• The file name includes the extension, whereas the Name Only value excludes it.
• Invalid file paths, inaccessible files, or insufficient permissions result in the NotFound return path.
• This step retrieves file metadata only and does not modify the file.
• The workflow should include appropriate handling for both Found and NotFound return paths.
• Retrieved file information can be reused throughout the workflow to simplify downstream processing and decision-making.

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 page.

Note: Verify and complete any missing configuration after importing the sample, including:

• File path
• Variable mappings
• File system permissions
• Workflow variable definitions
• Environment-specific settings

After verifying the configuration, save the Process Definition before execution.

Click here to download the sample file.