Export directory structure

An export directory structure can either be a default structure or a “flat” batch structure, which is achieved by using the option “-createFlatBatch”.

Default structure

<batch>/<searchresult-SearchID>/<section>/<hitNo>/<itemNo>

Flat batch structure

<batch>/<searchresult-SearchID>/<section>/<hitNo>

The distinction arises from the underlying document model of ImageMaster. Although technically a hit may contain several items, in many everyday use case scenarios a simple structure is likely to be encountered, where each hit only contains at most one item.

The flat batch structure provides the advantage of being suited for a direct re-import via FIS into an ImageMaster system. However, hits with more than one item are not allowed in this case and will cause an error during export.

The default structure, in contrast, allows for the export of hits which can be associated with more than only one item. However, a direct re-import via FIS is impossible. Instead customized pre-processing steps must be devised depending on the corresponding document type in such a scenario.

Generated export objects

In general, three content related files may be generated by an export process:

• An XML result file (for each search ID used in export.xml, see Search definition file for export) is generated within the batch directory (for an example file see chapter Example export files):

  result-<SearchID>.xml 1 The creation of these files is disabled by default. See “Additional Export Information” for related details.

• The following xml metadata file is generated for any item or hit (for an example see chapter Example export files):

  …/<searchresult-SearchID>/<section>/<hitNo>[/<itemNo>]/meta.xml

• Located on the same level as the file “meta.xml” may be a content file in its original MIME type format:

  …/<searchresult-SearchID>/<section>/<hitNo>[/<itemNo>]/export_file_name

The export filename may be an ID or an original filename, which was provided by a former upload or import operation. This depends on the export profile parameter “exportObjects.WriteOriginalFileNames” (see appendix Troubleshooting and FAQ). It can be necessary to rename the file by appending an appropriate file type extension so it can be opened in the usual manner by the associated application.

For further exemplification see the following illustration (Example export output), which presents example output of an export in a default export directory structure: