Defining File Move Adapters
Defining this object instructs Clarify how to move files from one folder to another.
If you have not already created this object, see Creating File Adapters.
The following steps take place in the File Move Adapter editor, which has four sections: Template, Parameters, File Information, and Options.
- 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.
- 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 Move adapter has one parameter: storageNodes . The storageNodes parameter represents the data in the file.
- Under File Information, in the File Path field, specify the folder where the file (or files) to be move 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.
-
To further filter which files are moved, enter a file name or filter in the
File Name or Filter field. You have several options to specify the
file name:
- A specific file name - The name of the file to move.
- Global Variable -A Global Variable that contains the name of the file to move.
- 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 move all the files it finds in File Path to the Destination Directory.
- In the Destination Directory field, specify the folder where the files will be copied to. 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.
-
Under the Options section, direct the adapter to switch to a mode where
the Adapter is capable of moving folders as well as files:
- Files only - Only 'files' are moved.
- Folders only - Only 'folders' are moved. 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.
- Click Save.