Defining File Write Adapters

Defining this object determines how, when, and where Clarify writes files, and whether it must create them.

If you have not already created this object, see Creating File Adapters.

The following steps take place in the File Write Adapter editor, which has these sections: Template, Parameters and File Information.

  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 AdaptersTemplate-concept.html#concept_h23_sdj_zm.
  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 Write 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 will be written. You have several options to specify the file path:
    • Browse for a Directory : Select the folder containing the files.
    • Global Variable : Select a Global Variable that contains the folder.
    • Substitution Variable : A variable is place-holder for the file path. 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.
  4. To automatically create the directory before writing the file, select the Create directories check box.
  5. To specify the name of the file to be written, in the File Name field either:
    • Type a specific file name or click the Browse button to select one.
    • Click the Global Variable button to select a global variable.
    • Create a substitution variable; Clarify will generate a file name based on the variable.
  6. Specify a Collision Action, which determines how Clarify reacts when a file collision occurs. Options are:
    • 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.
  7. Click Save to complete this task.