FTP - Remove Folder
Declaration
<AMFTP ACTIVITY="remove_folder" FOLDER="text" SESSION="text" />
Description: Deletes the folder(s) specified from the FTP server. To specify more than one folder, use wildcards (Example: * or ?). To specify multiple folders or wildcard masks, separate them with a vertical bar (Example: *Folder1|*Folder2).
If any files are contained in the folder(s) to be deleted, those files will be deleted as well.
Practical Usage
Used to delete one or more folders residing in the FTP server that are no longer necessary or no longer needed.
Folder Properties
|
Property |
Type |
Required |
Default |
Markup |
Description |
|---|---|---|---|---|---|
|
Remote Folder |
Text |
Yes |
(Empty) |
FOLDER="/home/ftpfolder" |
Specifies a fully qualified UNIX style path to the FTP folder(s) to remove. |
|
Match Case |
Indicates whether the properties set within this activity should be case sensitive in relation to the FTP server. The default value is NO. This is a visual mode parameter used only during design time, therefore, contains no markup. |
||||
Session Properties
|
Property |
Type |
Required |
Default |
Markup |
Description |
|---|---|---|---|---|---|
|
Session |
Text |
Yes |
FTPSession |
SESSION="SessionName" |
Specifies the session name (created in a previous FTP Log On 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. |
Description tab - A custom description can be provided on the Description tab to convey additional information or share special notes about a task step.
Error Causes tab - Specify how this step should behave upon the occurrence of an error. (Refer to Task Builder > Error Causes Tab for details.)
On Error tab - Specify what AWE should do if this step encounters an error as defined on the Error Causes tab. (Refer to Task Builder > On Error Tab for details.)
Example
The sample AML code below can be copied and pasted directly into the Steps panel of the Task Builder.
Description: This sample step deletes folder "/home/ftp/" via FTP, session name "FTPSession2".
<AMFTP ACTIVITY="remove_folder" FOLDER="/home/ftp/" SESSION="FTPSession2" />