Description:

The Rename Folder workflow step renames a specified folder on an SFTP server.

The step uses a configured SFTP connection, identifies the folder by its relative path, and specifies the new folder name.

The step supports:

• Renaming a folder on an SFTP server.
• Selecting a configured SFTP connection.
• Specifying the relative path of the folder to be renamed.
• Specifying the new folder name.
• Returning a success or failure result.

This step can be used for:

• Renaming folders after processing.
• Moving folders between workflow stages through naming conventions.
• Marking folders as processed or completed.
• Organizing SFTP directories.
• Updating folder names based on workflow status.
• Preparing folders for downstream processing.
• Automating SFTP repository maintenance.
• Integrating SFTP folder management into FlowWright workflows.

Usage:

The Rename Folder step is typically used when a workflow needs to rename an existing folder on an SFTP server.

Renaming can be useful when folder names represent workflow states. For example, a folder can initially be placed in a processing directory and renamed after processing has completed.

The folder path and new name can be supplied as workflow values, allowing the workflow to dynamically determine the target.

Typical uses include:

• Marking folders as processed.
• Renaming folders after successful file transfer.
• Changing folder names based on workflow status.
• Organizing inbound and outbound SFTP content.
• Maintaining processing directories.
• Preparing folders for downstream systems.
• Automating SFTP repository organization.

Typical Workflow Suggestions:

Mark a Folder as Processed

Rename an inbound folder after its files have been successfully processed.

Example:

Receive Files → Process Files → Rename Folder → Complete

For example, a folder named Customer123 could be renamed to Customer123_Processed.

Processing-State Management

Use folder names to represent workflow processing states.

Example:

Inbound → Process Files → Rename Folder → Processed

This provides a simple folder-level indication that processing has occurred.

File Transfer Completion

Rename a folder after its contents have been successfully transferred.

Example:

Validate Files → Upload Files → Rename Folder → Complete

Archive Preparation

Rename a folder before moving it into an archival process.

Example:

Complete Processing → Rename Folder → Archive

The new folder name can indicate that processing has completed.

Customer Folder Management

Rename folders as part of customer-specific file processing.

Example:

Receive Customer Files → Process → Rename Folder → Notify Customer

Partner File Exchange

Use the step to change a folder's name after completing a partner exchange.

Example:

Receive Partner Files → Process → Rename Folder → Record Transfer

Batch Processing

Rename a batch folder after all files in the batch have been processed.

Example:

Identify Batch → Process Files → Validate Results → Rename Folder → Complete

Automated SFTP Organization

Use Rename Folder to maintain a predictable SFTP folder structure.

Example:

Create / Receive Folder → Process → Rename Folder → Continue

Dynamic Folder Naming

Use workflow values to determine the folder path and new folder name.

Example:

Determine Customer → Process Files → Rename Folder → Continue

The XML defines both the existing folder path and new folder name as string properties, allowing workflow values to be supplied to the operation.

Failure Handling

Use the False return path to handle an unsuccessful rename.

Example:

Rename Folder → True → Complete

↳ False → Log Failure / Retry / Notify Administrator

The step explicitly provides True and False return values.

To use this step, configure SFTP in FlowWright's SFTP Connections.

A sample connection configuration is included below for reference.

Example:

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

• Create a new definition called “sftpRenameFolderDef” and open the definition in designer mode. 
• Drag an “sftpRenameFolder” step to the canvas. 
• Connect the dots between the “Start” and “sftpRenameFolder” 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, additional values are available for configuration. 
• Click the “sftpRenameFolder” step to configure its “Required” properties. Provide a name for the step. Select the “SFTP” connection string from the dropdown. Enter the relative file path of the folder to rename. Enter the new folder name. Click the Save button. Note: Click the "AI Predict" button to have the Copilot 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 in the images 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. When the workflow reaches the Rename Folder step, FlowWright uses the selected SFTP connection to identify the folder at the configured relative path and rename it using the specified new name.

Tips:

• Select the correct configured SFTP connection.
• Verify that the selected connection points to the intended SFTP server.
• Ensure that the target folder exists before the step executes.
• Carefully verify the Relative path of the folder to be renamed.
• Use workflow Variables when the folder path needs to be determined dynamically.
• Provide an appropriate value for Rename folder to.
• Confirm that the new folder name follows the naming conventions of the target SFTP repository.
• Verify that the SFTP connection has sufficient permissions to rename the folder.
• Test the operation with representative folders before deploying the workflow.
• Test both the True and False paths.
• Consider adding logging or notification to the False path.
• Consider retry or exception-handling logic when the SFTP server may be temporarily unavailable.
• Avoid hard-coding environment-specific folder paths when deploying workflows across environments.
• Be careful when dynamically constructing folder paths or names.
• Verify the expected behavior of the renameTo value in the target environment, since the XML does not document whether it should contain only a folder name or a path.
• Use consistent naming conventions when folder names are being used to represent processing states.
• Ensure that downstream systems are aware of the new folder name when they depend on a specific directory structure.

Notes:

The Rename Folder step is defined in the SFTP category with the internal name sftprenamefolder, label Rename folder in SFTP server, and display name Rename Folder.

The step is implemented by FlowWright.Workflow.SFTPRenameFolder in FlowWright.Workflow.dll and is a Process step with 2 incoming connections and 2 outgoing connections.

The XML defines three configurable properties, all of which are marked as required.

The Select SFTP property uses the ClsSFTPConnections data type, implemented by FlowWright.DataTypes.ClsSFTPConnections. 

The folderPath and renameTo properties use the standard string data type, implemented by FlowWright.DataTypes.ClsTextBox. 

The step provides two predefined return values: False and True.

Definition Sample:

You may download the sample definition(s) from the link provided and import them into your FlowWright Process Definition.

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

• SFTP connection
• Existing folder relative path
• New folder name
• Environment-specific SFTP settings
• Downstream True and False workflow paths

Because folder naming may be used by downstream systems to identify processing state, carefully verify the new folder name before executing the imported definition.

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

Click here to download the sample file.