File Destination Properties

Use the File destination to write output documents into a file system directory. By default, the system creates subdirectories in the specified base directory based on each batch identifier.

Note:

The File destination includes functionality previously in the FilePlus destination.

Optionally, you can have the system write separate side-car files, which contain some or all of the metadata for each document, to a destination directory you specify. The metadata files are requested by specifying a pattern for their names.

The default output file names and the optional side-car metadata file content can be formatted and controlled using a simple template tag-substitution language. The template tag values are drawn from each document's metadata and the batch identifier (BATCHID).

Note:

See Using templates section for more information.

Once the system writes a document into the destination directory, its new file name is added to the document's metadata as the value of this name: destination.file.generated.file.name

If you specified a side-car metadata file, its name is added using this name:

destination.file.generated.side.file.name

Using this destination as an intermediate stop can be a convenient aide in constructing a bridge to another destination that is not directly supported. Standalone, possibly custom, import programs can pick up the files and process them into an archive system.

Configure the use of the File destination with:

destination.name=oracle.documaker.ecmconnector.filedestination.FileDestination

Table 3-11 File Destination Properties

Property	Description	Default
File Destination Properties Property Name Prefix: destination.file
.base.directory	The root directory where the output document files will be placed. The system creates this directory if it does not exist.	none
.side.base.directory	The root directory where the metadata files will be placed. The system creates this directory if it does not exist.	Same as base.directory
.name.pattern	The pattern for the destination file name. This pattern can use the document metadata items as well as the batch ID. If this property is not provided, the source document name is used.	source document name
.side.name.pattern	(Optional) The metadata file name pattern. If you do not want the metadata file included in the output, leave this property empty. If this property is provided, you must also provide the.template or.template.path.	none
.subdirectory.pattern	The pattern for the destination file subdirectory to be used or created under the.base.directory location.	${BATCHID}
.side.subdirectory.pattern	The pattern for the metadata file subdirectory to be used or created under the.side.base.directory location.	${BATCHID}
.template.path	The path to a template file for the side metadata file to be written with each output document.	none
template	Used if the.template.path property is unspecified. This is the metadata file contents template as a single string.	none