Previous Next
Opalis Integration Pack for FTP > Objects > Rename File

Rename File
The FTP Rename Files object renames files on your FTP server.
How it is used
The Rename File object can be used to rename a batch of files after they are moved to an archive to include the date that they were archived.
Configuration
To configure the Rename File object, you need to know the server name, port, username, password, and security settings of the FTP server that you are connecting to. You will also need to know the path of the files that will be renamed and what they will be renamed to.
Details tab
 
Old name
Type the name of the file you want to rename.
New name
Type the new name of the file.
Add button
Once you have specified Old name and New name, click the Add button to commit the condition to the list.
Remove button
Click to remove the selected condition from the list.
Edit button
Click to edit the selected condition. After you have edited the condition, you must click Add to put it back in the list.
Destination tab
 
Server name or IP
Type the URL or IP address of the FTP server.
Port
Type the port for the FTP server. (Default 21)
Username
Type the username that will be used to log in to the FTP server.
Password
Type the password that is associated with the FTP user you specified.
Confirm
Re-type the password specified in the Password field.
Server Type
Select the type of server that you are connecting to. Only change this option if you are experiencing problems communication with an IBM or a DEC VMS FTP server.
Security
Select the security mode for the FTP transfer. The security method you choose will depend on the configuration of the FTP server. Select FTP to transfer without any security. Select ALTFTP if you are having trouble transferring to your FTP server.
Key authentication
Select to use the SSH private key that you specified in the FTP Options dialog.
Passive mode (firewall friendly)
Select to use Passive mode (PASV) when connecting to the FTP server. Use this option if you are having trouble transferring files through a firewall.
Path
Type the path where the file you are renaming resides. If supported by your FTP server, paths that begin with '/' are relative to the root FTP folder and paths that begin with './' are relative to the user's home folder.
Advanced tab
 
Timeout
Type the timeout period in seconds to wait for the server to come back online after a transfer has been interrupted. Once the time has expired, if there is no communication with the server, the Rename File object fails.
Available
 
Name
Description
Number of files
The number of files that matched the pattern that you specified. This is also the number of files that were attempted to be renamed.
Number successfully renamed
The number of files that successfully renamed.
Number failed to rename
The number of files that failed to be renamed.
FTP Server name
The name of the FTP server.
FTP Server port
The port used to communicate with the FTP Server.
Protocol
The security protocol that was selected.
For each file renamed:
Filename
The name of the file.
File rename to
The current name of the file
File path
The path of the folder containing the file.
Status
The result of the rename as either “success” or “failure”.
Common

Previous Next