Description:

The Create Folder workflow step creates a folder on an SFTP server.

The step uses a configured SFTP connection and accepts a relative path identifying the folder to create. It provides True and False return paths, allowing the workflow to follow different processing paths based on the operation's result.

The step supports:

• Creating a folder on an SFTP server.
• Selecting a configured SFTP connection.
• Specifying the relative path of the folder to create.
• Dynamically supplying the folder path as a string value.
• Handling successful and unsuccessful folder-creation results.

This step can be used for:

• Creating temporary processing folders.
• Preparing directories for incoming or outgoing files.
• Creating customer- or project-specific folders.
• Organizing files transferred through SFTP.
• Preparing batch-processing directories.
• Creating folders as part of an automated file-exchange process.
• Establishing directory structures before subsequent SFTP operations.

Usage:

The Create Folder step is typically used when a workflow needs to establish a directory on an SFTP server before performing subsequent file operations.

For example, a workflow can create a customer-specific folder and then transfer files into it.

Typical uses include:

• Preparing an SFTP destination for file transfer.
• Creating temporary processing directories.
• Creating customer-specific directories.
• Creating project-specific directories.
• Preparing directories for batch processing.
• Establishing an organized SFTP folder structure.
• Creating directories before sending files through SFTP.
• Supporting automated file-exchange workflows.

The folder path can be supplied dynamically as a string, enabling workflows to construct paths based on process data.

Typical Workflow Suggestions:

Prepare a File Transfer Destination

Create a destination folder before transferring files to an SFTP server.

Example:

Determine Destination → Create Folder → Send File → Complete

This pattern is useful when the destination directory must exist before an SFTP file transfer operation.

Customer-Specific Folder

Create a separate folder for each customer.

Example:

Identify Customer → Create Folder → Send Customer Files → Complete

A dynamically constructed path could follow a pattern such as:

/customers/{CustomerID}

Project Folder Creation

Create an SFTP folder for a project before processing project-related files.

Example:

Create Project → Create Folder → Upload Files → Process Files

Batch Processing

Create a folder for each incoming or outgoing batch.

Example:

Receive Batch → Determine Batch Path → Create Folder → Transfer Files → Complete

Temporary Processing Folder

Create a temporary folder for intermediate file processing.

Example:

Start Processing → Create Folder → Get Files → Process Files → Cleanup

A separate cleanup operation can subsequently remove the temporary folder when processing is complete.

Organize Outgoing Files

Create a structured destination for files before sending them to an external system.

Example:

Generate Documents → Create Folder → Send Files → Confirm Transfer

Organize Incoming Files

Create a dedicated directory for files associated with a particular processing cycle.

Example:

Start Import → Create Folder → Receive Files → Process Files

Dynamic Folder Paths

Use workflow values to dynamically determine the destination folder.

Example:

Get Customer ID → Build Folder Path → Create Folder → Transfer Files

The XML defines destinationFolder as a string property, allowing the folder path to be supplied as a string value.

Multi-Level Processing Structure

Create a folder within a larger directory structure.

Example:

Determine Customer → Determine Project → Create Folder → Transfer Files

When using multiple folder-creation operations, verify the behavior of the SFTP server and FlowWright implementation when parent directories do not already exist. The XML does not document whether parent directories are automatically created.

Success and Failure Handling

Use the two return paths to separate successful and unsuccessful folder creation.

Example:

Create Folder → True → Continue Processing

↳ 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 “sftpCreateFolderDef” example.          

• Create a new definition called “sftpCreateFolderDef” and open the definition in designer mode. 
• Drag an “sftpCreateFolder” step to the canvas. 
• Connect the dots between the “Start” and “sftpCreateFolder” 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 “sftpCreateFolder” step to configure its “Required” properties. Provide a name for the step. Select the “SFTP” connection string from the drop-down list. Then click the Save button. Note: Click the "AI Predict" button to have the Copilot add new process steps that match your process description. 

• Click the “sftpCreateFolder” step to configure its “Optional” properties. Enter a relative path to create the folder. Then 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 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 Create Folder step, FlowWright uses the selected SFTP connection and configured destination folder path for the folder-creation operation. The workflow then follows the True or False return path according to the result.

Tips:

• Select the correct configured SFTP connection.
• Verify that the connection points to the intended SFTP server.
• Carefully verify the Relative path to create the folder before executing the workflow.
• Use Variables or Global variables when the destination folder is determined dynamically.
• Use consistent folder-naming conventions across workflow instances.
• Verify that the SFTP account has permission to create folders in the target location.
• Test folder creation with representative paths before deploying the workflow.
• Confirm the expected behavior when the target folder already exists.
• Confirm whether parent directories must already exist.
• Do not assume that an empty destination path has a meaningful default behavior simply because the property is optional.
• 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 SFTP paths when workflows are deployed across environments.
• Validate dynamically constructed paths before using them.
• Use the True path to ensure that dependent SFTP operations occur only after the folder is successfully created.
• If subsequent steps depend on the folder being available, connect them to the True return path.
• Verify folder permissions and naming conventions in the target SFTP environment before production deployment.

Notes:

• The Create Folder step is defined in the SFTP category with the internal name sftpcreatefolder, label Create folder in SFTP server, and display name Create Folder.
• The step is implemented by FlowWright.Workflow.SFTPCreateFolder in FlowWright.Workflow.dll and is a Process step with 2 incoming connections and 2 outgoing connections.
• The XML defines two configurable properties. Select SFTP is required, while Relative path to create the folder is not required.
• The Select SFTP property uses the ClsSFTPConnections data type, implemented by FlowWright.DataTypes.ClsSFTPConnections. 
• The destinationFolder property uses the standard string data type, implemented by FlowWright.DataTypes.ClsTextBox. 
• The step provides two predefined return values: False and True.
• The XML describes destinationFolder as a relative path to create the folder.

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
• Relative destination folder path
• Environment-specific SFTP settings
• Variable or Global values used to construct dynamic paths
• Downstream True and False workflow paths

Verify that the selected SFTP account has permission to create the target folder.

Also verify the behavior of the target SFTP server when the folder already exists or when parent directories are missing, as these behaviors are not specified in the XML.

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

Click here to download the sample file.