Rename File/Folder
Renames a file or a folder on an SFTP or FTP server.
Rename File/Folder gives a file or a folder on your SFTP or FTP server a new name, in the same location. Use it to mark a file as processed (order.csv โ order.done.csv) or to give an uploaded file its final name.
Before you start
The action connects through an FTP credential that you create once in the Credential Manager (host, port, protocol FTP or SFTP, an optional Directory path, and a user name with a password or a key file). See FTP Credential.
Add the action
In the Process Designer toolbox, open SFTP and pick Rename File/Folder (or type Rename in the search box).
Inputs and outputs
| Field | Direction | Type | Required | What to put / what you get |
|---|---|---|---|---|
| Select SFTP credentials | Input | FTP credential | Yes | The credential of the server. |
| Folder | Input | Text | No | The folder that holds the file or folder to rename, relative to the credential's Directory path. Leave empty for the root folder. |
| File Current Name | Input | Text | Yes | The current name, for example order.csv or reports. |
| File New Name | Input | Text | Yes | The new name, for example order.done.csv. Include the file extension. |
| Result | Output | Boolean | Yes | true if the item was renamed, false if not. |
Example
Folder inbox, File Current Name order.csv, File New Name order.done.csv โ the server now has inbox/order.done.csv and Result is true.
Good to know
- The item stays in the same folder. To move a file to another folder, use Move File.
- Names are case-sensitive on most SFTP servers.
- If the server returns an error (for example, the item doesn't exist), the step fails with "Error while trying to rename file."