Export

With the FIS export functionality large quantities of content from an ImageMaster repository can be exported into a file system. In terms of the ImageMaster document model the export objects may be based on:

• revisions (which typically represent content such as a binary file or a text file)

• literals (which represent any kind of metadata, such as attributes and properties, within an XML file)

• document types (data which may be used to recreate document types in an ImageMaster system).

An export process generally consists of two processing steps:

• identifying a set of objects from the system via a query

• exporting the hits from the query result into the file system

Specific operations for SAP documents are supported as well, where the export includes additional metadata such as SAP document IDs (see Import, export, and deletion of SAP documents). Since similar principles apply in a FIS export of SAP documents, it is recommended familiarizing oneself with the normal export process first as described below.

Prerequisites

The following preconditions apply for an export operation:

• One or several batch directories must exist.

• One search definition file “export.xml” (see chapter Search definition file for export) must be provided in each batch directory.

Starting the process

The process can be started from the console by a corresponding command. The following parameters must be supplied at least (also see Command line commands and parameters):

• value for the parameter “batch_directory”

  This is either a directory name or the name of a file containing a list of directory names.

• value for the parameter “pid” (a unique process ID)

  This ID is used for controlling the process, e.g. for stopping the process prematurely or for retrieving status information during runtime.

For details on the command line syntax see chapter Export with the command line interface.

Behavior of the export process

The process generates export files in the subdirectories of the batch directory.

The detailed behavior can be configured in a profile, see:

• Profiles and configuration

• Profile configuration parameters

A profile can be configured in the AdminClient, see FIS profiles management in [UM AdminClient].

Error situations are signaled by corresponding error codes (see appendix Return codes). The process may terminate in any of the states:

• Finished (return code 0 or 5)

• Aborted (return code 9)

An internal service request, which is processed within FIS, complies with the corresponding schema definition (see appendix Schema definition for FIS).

Additional export information / metadata export

The following function is disabled by default. It is recommended using it for large exports due to out of memory issues. 

In a usual document export which is based on a RAQL query, this query returns revisions. One revision represents one content file that is exported such as a PDF file.

In contrast, RAQL can also be used to export metadata instead, such as document attributes or document type definitions. To achieve this, if a query does not return revisions, the command line option “-createResultFile” must be used. In this case the naming pattern of each file generated by the export contains a search ID from the search definition file (“export.xml”): result-<SearchID>.xml

The search definition can contain several search requests with multiple IDs, which will result in multiple output files. The content of revisions is exported to files in the batch subdirectories with the matching ID: searchresult-<SearchID>