Description:

The BoxDeleteFile step is used to delete an existing file from Box as part of a FlowWright workflow.

The step provides True and False return paths, allowing subsequent workflow processing to respond to the result of the delete operation.

Usage:

The BoxDeleteFile step can be used whenever a workflow needs to remove a file from Box as part of automated processing.

A typical workflow pattern is:

Identify Box File → Delete File → Continue Processing

The workflow specifies the file using its path or File ID and uses the selected OAuth provider to access Box.

For example, a workflow can remove a temporary file after successfully processing its contents.

To use this step, you must first configure Dropbox in FlowWright. Then, go to the Integrate > Connections > OAuth page to create a new OAuth source. 

A sample OAuth configuration is provided for reference. 

Typical Workflow Suggestions:

Delete Temporary Files After Processing

Use BoxDeleteFile after a workflow has finished processing a temporary Box file.

For example:

Retrieve File → Process File → Delete Temporary File → Complete

This can be useful when a file is only required during an intermediate stage of a workflow.

Remove a File After Successful Archiving

Use this step when a workflow copies or archives a file and no longer needs the original Box file.

For example:

Retrieve File → Archive/Copy File → Delete Original → Complete

The True path can continue the workflow after the deletion operation succeeds.

Delete Files After a Business Process Completes

Use BoxDeleteFile when a file is no longer needed after a business process completes.

For example:

Complete Business Process → Identify Temporary File → Delete File → Close Process

The file path or File ID can be supplied dynamically from workflow data.

Clean Up Unneeded Processing Files

Use the step as part of a workflow cleanup process that removes files that are no longer needed.

For example:

Identify Unneeded File → BoxDeleteFile → Continue Cleanup

This makes file cleanup part of an automated workflow rather than requiring manual deletion.

Delete a File After a Replacement Is Created

Use BoxDeleteFile when a workflow generates or uploads a replacement file and the previous file is no longer needed.

For example:

Generate Replacement → Upload New File → Delete Previous File → Complete

You can identify the previous file using its Box path or File ID.

Example:

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

• Create a new definition named “BoxDeleteFileDef” and open it in designer mode. 
• Drag a “BoxDeleteFile” step to the canvas.
• Connect the dots between the “Start” and “BoxDeleteFile” steps as shown above. 
• Select the line between the steps to configure the “Connection Properties”. The default property values are “None, True, False, Error, and Evaluate”. Depending on the step’s purpose, you can configure additional values.
• Define a variable or a global to store the result.
• Click the "BoxDeleteFile" step to configure its "Required" properties. Provide a name for the step. Select the “Box” OAuth connection provider. Specify the path of the file to delete. Provide a variable or global reference to store the result after execution. Click the Save button. Note: Click the "AI Predict" button for 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. When the workflow reaches the BoxDeleteFile step, FlowWright uses the selected OAuth provider to access Box and identifies the target file using the supplied Path/FileID to delete the file. The delete operation result is stored in the Variable/Global specified by Store result in Variable/Global. The workflow then follows the True or False return path based on the result of the operation. Click the process step to view its properties. The step should delete the file in the box.

Tips:

• Select the correct OAuth provider: Ensure that the selected provider has access to the Box file being deleted.
• Verify the target file: Use the correct Box path or File ID to avoid targeting the wrong file.
• Use Variables/Globals for dynamic file identification: This allows the file to be selected based on workflow data.
• Delete only after required processing is complete: If the file is needed by later workflow steps, perform the deletion only after those operations finish.
• Use the True and False paths: Connect both outputs to appropriate workflow handling.
• Store the operation result: The result Variable/Global can be used by subsequent workflow logic.
• Use deletion as part of cleanup: The step can be useful at the end of temporary-file processing workflows.

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: After the import, verify and complete any missing configurations, such as file path references and database connections. Then, save the definition to confirm the changes. 

Click here to download the sample file.