Description:

The Get Virtual URL for a File step enables a FlowWright workflow to generate a virtual URL from an existing physical file path.

Many workflow scenarios require files to be referenced through URLs rather than physical file system locations. For example, a workflow may need to include a downloadable document in an email, provide a hyperlink within a form, expose generated reports to end users, or pass a file reference to another application.

This step accepts the physical path of a file, converts it into its corresponding virtual URL, and stores the generated virtual path in a workflow variable or global variable. Subsequent workflow activities can then use the generated URL without needing to know the physical storage location.

Typical uses include:

• Generating download links for workflow documents
• Creating hyperlinks for email notifications
• Providing document URLs in workflow forms
• Passing file URLs to REST APIs
• Publishing generated reports
• Sharing exported files with users
• Creating links for document management systems
• Referencing files from external applications

This step provides a convenient way to abstract physical storage locations while allowing workflows to work with web-accessible file references.

Usage:

The Get Virtual URL for a File step is typically used after a file has been created, uploaded, or located and before the workflow needs to expose that file through a web-accessible link.

During execution:

1. Read the configured physical file path.
2. Validate that the file path is available.
3. Generate the corresponding virtual URL.
4. Store the generated URL in the configured workflow variable or global variable.
5. Continue workflow execution through either the True or False return path.

A typical workflow might look like this:

Typical workflow scenarios include:

• Sending document download links by email
• Displaying report links in workflow forms
• Publishing generated invoices
• Providing document URLs to REST services
• Creating hyperlinks for customer portals
• Sharing exported workflow files
• Referencing documents stored by FlowWright

Example:

Let’s build and execute the "getFileURLDef" example.

• Create a new process definition named "getFileURLDef" and open it in Designer mode. 
• Drag the “GetFileURL” step to the canvas.
• Connect the “Start” and “GetFileURL” steps, as shown above. 
• Click the “clsGetFileURL” step to configure its “Required” properties. Provide the file path on the FlowWright server for any file. Provide a variable or global to store the virtual file path. Click the Save button. Note: Click the "AI Predict" button for the Copilot to add new process steps that match your process description. 

• 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. Render the process instance. Click the process step to view its properties. The step should retrieve the virtual file URL path.  

Tips:

• Verify that the input file path references an existing file before executing this step.
• Store the generated virtual URL in a reusable workflow variable for later activities.
• Use this step after generating reports, exporting documents, or creating files that need to be shared.
• Route the False path to logging and notification activities for easier troubleshooting.
• Keep physical file paths internal and expose only virtual URLs to end users.
• Combine this step with Create PDF, Write TXT File, Send Email, REST Call, Upload Document, or document management steps to automate complete document publishing workflows.

Notes:

• Both configuration properties are required.
• The step converts a physical file path into a virtual URL.
• The generated virtual URL is stored in the configured workflow variable or global variable.
• The physical file itself is not modified.
• Both the True and False return paths should be implemented to provide complete workflow handling.
• Ensure that the referenced file is available and that the application's virtual path configuration is correctly configured.
• Execution details are recorded in the FlowWright workflow execution log.

Get Virtual URL for a File vs. GetFileInfo:

Although both steps operate on files, they serve different purposes.

As a general guideline:

• Use Get Virtual URL for a File when a workflow needs a web-accessible link that users or external systems can use to access a file.
• Use GetFileInfo when a workflow needs to inspect or retrieve information about a file, such as its metadata, before making workflow decisions or performing additional processing.

Definition Sample:

You may download the sample workflow definition from the link provided and import it into your FlowWright environment.

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

• Input file path
• Workflow variable or global variable for the virtual URL
• Success and failure workflow branches
• Validation that the referenced file exists
• Virtual directory or application configuration required to resolve generated URLs

After verifying the configuration, save and publish the workflow before execution.

Click here to download the sample file.