Command line commands and parameters

The following commands and parameters are available in the FIS console mode.

Parameter

Description

Optional

Operations

-command 

The name of the desired operation:

  • ArchiveDocuments

  • UpdateDocuments

  • SmartUpdateDocuments

  • ExportObjects

  • DeleteObjects

  • DeleteSapDocuments

  • BulkUpdateAttributes

  • ArchiveSapDocuments

  • ExportSapObjects

  • RegisterBlobs

  • UnregisterBlobs

  • MigrateDocuments

  • DeleteMigratedDocuments

No

N/A

-batch_directory

 

A batch directory name or a name of a file containing a list of batch directory names:

  • <batchdirectory>

    the name of a single batch directory

  • @<batchdirectories_file>

    a filename including the full path (absolute, or relative starting from the current working directory) of a preconfigured file that contains a list of batch directory names separated by line breaks, e.g.: “@C:\ourBatchDirFile.txt”
    (absolute path/filename combination in Windows)
    or
    “@ourSubDir/myBatchDirFile.txt”
    (relative path/filename combination in UNIX)

No

All

-group

A group from the underlying customized ImageMaster model, which grants permissions

Yes

All

-pid

A unique task / job id

No

All

-profile

The name of the batch profile with the desired configuration

If not set, a default will be used

Yes

All

-role

A role from the underlying customized ImageMaster model, which grants permissions

If this parameter is omitted, FIS attempts to read the configuration from the file “FIS.cfg” which must be located in the current working directory.

*required if basic authentication is disabled

No*

All

-tenant

A tenant which is only mandatory* in systems where multiple tenants are installed. In a simple environment this parameter may be omitted for all operations and the system will internally work with a default tenant.

No*

All

-parallel

This option activates the parallel mode of processing. You must specify the number of threads to be used.

Yes

All, excluding RegisterBlobs and UnregisterBlobs:

-replaceRevisions

If this option is set, revisions are replaced. By default (i.e. if this option is not set), a new revision is created and the old one stays in the archive (like an “old document version”).

Yes

UpdateDocuments,

SmartUpdateDocuments

-l

A log directory which may be used for client side error analysis. This may include an absolute or a relative directory path starting from the current working directory.

If this parameter is omitted, FIS writes log files to the current working directory.

An initial log level can be set with the environment variable “ima_loglevel” (see “Setting the initial log level”).

Yes

All

-loc_profile

A configuration file to selectively override server-side FIS profile settings (see chapter Overriding server-side profile settings locally).

Yes

All, excluding RegisterBlobs and UnregisterBlobs:

-c

A configuration file providing access details for the Integration Service, i.e. host, port, and URL.

If this parameter is omitted, FIS attempts to read the configuration from the file “FIS.cfg” which must be located in the current working directory.

Yes

All

-p

An additional protocol directory, which receives copies of all original protocol files. (The original protocol files are located in the batch directory and should never be tampered with because FIS depends on them for resuming aborted processes, whereas these copies can be used for any other purpose).

Yes

All

-eraseDocuments

If this option is set, the operation will delete all documents irrevocably. If it is not given, deletion depends on the recycle bin configuration.

If the recycle bin is disabled, this FIS operation also deletes the documents irrevocably.

If the recycle bin is enabled (default), the documents are moved to the recycle bin. A final deletion has to be taken care of by other means, and FIS does not provide the possibility to erase SAP documents from the recycle bin.

Yes

DeleteSapDocuments

DeleteMigratedDocuments

Parameters for Export

-pagesize

Yes

exportObjects

This parameter can be used for system tuning. In an export operation files will be retrieved in single portions, called pages. Each page is transferred within one request. The page size thus denotes the number of files transferred per request.

As a command line parameter, this overrides the configuration parameter “ExportObjects.defaultPagesize”.

-createFlatBatch

Yes

exportObjects

With this option the structure of the resulting export directory will be suited as input for an archive operation with a simple import batch structure:

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

In this scenario all query hits can only have one query item. In contrast, a default batch contains an additional level of items, which allows for multiple items per hit:

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

If a query has more than one item in its hits, the option “createFlatBatch” will cause an error.

As a command line parameter this option overrides the parameter “ExportObjects.defaultCreateFlatBatch”.

-retrieveBinaryfiles

Yes

exportObjects

This option must be used to actually export files from the repository. Without this option only metadata will be retrieved by generating the corresponding xml files.

As a command line parameter, this overrides the parameter “ExportObjects.defaultRetrieveBinaryfiles”.

-createResultFile

Depends

exportObjects

exportSapObjects

Creates an extended file structure with exported metadata. If a query is used in the export, which returns any item other than an ImageMaster revision, this option must be used. See section “Additional export information / metadata export”.

-noRevFilterExt

Yes

exportObjects

exportSapObjects

Disables a customized revision filter extension that usually imposes some modification on exported content. A typical use case for such an extension is to stamp exported PDF documents with some label, which can be deactivated by this option then. This option is only useful if such an extension is installed.

-exportEvidenceRecord

Yes

exportObjects

exportSapObjects

This option can be used to export an evidence record for each exported from the repository document.

Further Parameters

-ignoreErrorsObjectNotFound

Yes

deleteObjects

Maximum number of "Object not found" errors which is accepted during a batch run before FIS aborts.

As a command line parameter this parameter overrides the configuration parameter “deleteObjects.defaultIgnoreErrorsObjectNotFound”.