FTP - Remove folder(s)

Declaration

<AMFTP ACTIVITY="remove_folder FOLDER=text SESSION=text />

Related Topics

Description

Deletes the folders specified from the FTP server, as well as any files stored within the folders. To specify more than one folder, use wildcards (for example, * or ?). To specify multiple folders or wildcard masks, separate them with a pipe character (|) (for example, *Folder1|*Folder2). See File Masks & Wildcards for more details. 

NOTE: An FTP session is required to run this activity. Use the FTP - Logon activity to create a session.

Practical Usage

Used to delete one or more folders residing in the FTP server that are no longer necessary or no longer needed.

Parameters

Connection

Property Type Required Default Markup Description
Session Text Yes FTPSession1 SESSION="SessionName" Specifies the session name (created by a previous FTP - Logon step) that this activity should originate from. This permits several FTP activities to be linked to a specific session, thus, allowing multiple simultaneous FTP transfers to take place within a single task.  

Folder

Property Type Required Default Markup Description
Remote folder Text Yes (Empty) FOLDER="/home/ftpfolder Specifies a fully qualified UNIX style path to the FTP folders to remove. Enter a fully qualified UNIX style path manually in the provided text box or click the folder icon to open the FTP Browser which allows connection to the server in order to browse available files and folders. To specify more than one folder, use wildcards (for example, * or ?). To specify multiple folders or wildcard masks, separate them with a pipe character (|) (for example, *Folder1|*Folder2). See File Masks & Wildcards for more details.
NOTE: Files with invalid paths are ignored at runtime.
Match case Yes/No No No MATCHCASE="yes" If selected, indicates that this activity should be case sensitive in relation to the folders being removed. Disabled by default.

Description

Error Causes

On Error

Example

NOTE:
  • The sample AML code below can be copied and pasted directly into the Steps Panel of the Task Builder.
  • Parameters containing user credentials, files, file paths, and/or other information specific to the task must be customized before the sample code can run successfully.

Description

This sample task removes a folder.

Copy 
<AMFTP ACTIVITY="remove_folder" FOLDER="/home/ftp/ " SESSION="FtpSession2" />