Defining File Delete Adapters

Defining this object instructs Clarify how to delete files from a local or network file system folder.

If you have not already created this object, see Creating File Adapters.
The following steps take place in the File Delete Adapter editor, which has these sections: Template, Parameters, File Information, Match Date and Time, and Options.
  1. If you wish to use an existing adapter as a template, select it from the Template section's Template File Adapter field. Use of an Adapter Template is tied directly to the number and types of parameters the Adapter uses. For more information, see Using File Adapters - advanced.
  2. If you need to add a parameter, click the Add button in the Parameters section and then define the parameter that appears in the new row. By default, a Delete adapter has one parameter: storageNodes . The storageNodes parameter represents the data in the file.
  3. Under File Information, in the File Path field, specify the folder where the file (or files) to be deleted reside. You can browse for a file or a folder location by using the File Browser. Alternately, you can specify a global or substitution variable by using the Global Variable or Substitution Variable Browsers.
  4. In the File Name or Filter field, direct which file (or files) is to be deleted. You have several options to specify the file name:
    • A specific file name- The name of the file to delete.
    • Global Variable- A global variable that contains the name of the file to delete.
    • Substitution Variable- A variable is place-holder for the file name. The actual file name will be supplied to the adapter by a Business Process. You can type the Variable Name or use the Variable Browser.
    • Filter- A filter is a means of specifying a group of files whose names match a pattern. For example, a common file-system wild card '*' can be used to specify all files in the folder. Additionally, a Regular Expression pattern can be used in more complex scenarios.
    • Blank-If no value is supplied, the Adapter will delete all the files it finds in File Path.
  5. To further filter the files to be deleted, select the Date to Match File Is drop-down and specify a Date . Click the Enabled button to activate this field. You have several options to control the date matching behavior:
    • Equal to - File with a timestamp matching a specific date and time will be deleted.
    • Before - Files with a timestamp before a specific date and time will be deleted.
    • After - Files with a timestamp after a specific date and time will be deleted.
    1. Use the Date to specify the Date and Time to filter the files to be deleted.
  6. To instruct the adapter to navigate down any sub-folders that exist within File Path, click Recurse Directories. As each sub-folder is explored, files matching the File Name or Filter criteria will be deleted.
  7. Use Delete to direct the adapter to switch to a mode where the Adapter is capable of deleting folders as well as files:
    • Files only - Only 'files' are deleted.
    • Folders only - Only 'folders' are deleted. The value supplied for File Name or Filter will apply to folder names, not file names.
    • Files and Folders - Files and folders are moved. The value supplied for File Name or Filter will apply to folder and file names.
  8. Click Save to complete this task.