Defining File Copy Adapters
Defining this object instructs Clarify how to copy 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 Copy 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 Copy adapter has one parameter: storageNodes . The storageNodes parameter represents the data in the file.
- Under the File Information section, in the File Path field, indicate the folder where the file (or files) to be copied reside. Browse for a file or a folder location by using the File Browser, or alternately, specify a global or substitution variable by using the Global Variable or Substitution Variable Browsers.
-
To further filter which files are copied, 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 copy.
- Global Variable -A Global Variable that contains the name of the file to copy.
- 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 copy all the files it finds in File Path to the Destination Directory.
- In the Destination Directory field, indicate the folder where the files will be copied to. Browse for a file or a folder location by using the File Browser, or alternately, specify a global or substitution variable by using the Global Variable or Substitution Variable Browsers.
-
In the Collision Action field, select the action that Clarify will take
should a file collision occur. Options include:
Options include:
- Overwrite : Write over the existing data in the file.
- Append : Open the original file and add the new data after the old data.
- Generate Unique Name : Create a new file to house the data. This file name will have the original file name plus a random letter/number combination appended.
-
Under the Options section, define whether this adapter copies folders,
files, or both by selecting the appropriate radio button.
- Files only: Copies files only.
- Folders only: Copies folders only. The value supplied for File Name or Filter will apply to folder names, but not file names.
- Files and Folders: - Copies files and folders. The value supplied for File Name or Filter will apply to both folder and file names.
- Click Save to complete this task.