Profile configuration parameters

The following tables list all parameters that can be set in a server-side FIS profile configuration via the AdminClient.

Common parameters

Parameter

Default Value

config.fis.profile.Name

No default value

config.fis.profile.Version

1

config.fis.profile.Enabled

true

config.fis.profile.Default

false

In case this is set to “true”, the profile will be applied for FIS operation if in the command line the parameter “-profile” is defined

config.fis.profile.Description

No default value

Operation specialized parameters

Operations which are specified in the use case head row apply to all subentries.

Parameter

Description

Operations

Use case import

 

import.documentDirectoryFilter

The directory filter is a regular expression which determines about the directories that will be processed in an import operation. Directory names which do not match the regular expression will be ignored.
For example: [0-9][0-9][0-9][0-9][0-9]

describes a name consisting of exactly 5 digits like 00001, 00002, 98562 etc.

Type: String (default: ‘.*’, i.e. all directories will be processed)

ArchiveDocuments

UpdateDocuments

SmartUpdateDocuments

ArchiveSapDocuments

import.binaryFileFilter

The binary file filter is a regular expression which determines about the binary files that will be processed in an import operation. Files with names that do not match the regular expression will be ignored.

Type: String (default: ‘.*’, i.e. no filtering is activated)

ArchiveDocuments

UpdateDocuments

SmartUpdateDocuments

ArchiveSapDocuments

import.ignoreErrors

This parameter denotes the maximum number of documents which may fail to be imported before the import process is cancelled with an error message.

Type: Integer >= 0 (default= “10”)

ArchiveDocuments

UpdateDocuments

SmartUpdateDocuments

BulkUpdateAttributes

ArchiveSapDocuments

MigrateDocuments

import.digestIsMandatory

If this parameter is set to ‘true’, the values ‘fileHashDigest’ and ‘hashAlgorithm‘ must be set for binaryObjects in the import metadata files (meta.xml), otherwise the import process will be cancelled with an error message.

Type: Boolean (default = false)

ArchiveDocuments

UpdateDocuments

SmartUpdateDocuments

ArchiveSapDocuments

MigrateDocuments

import.digestHashAlgorithm

This parameter designates the hash algorithm to be used for an integrity validation in the transfer process between FIS and the Integration Web service. If  no algorithm is given by the (default) value ‘N/A’, no integrity validation is performed. For a list of valid algorithms see the schema definition for FIS (see appendix Schema definition for FIS).

Type: String (default = ‘N/A’)

ArchiveDocuments

UpdateDocuments

SmartUpdateDocuments

ArchiveSapDocuments

MigrateDocuments

import.deleteBatch

If this parameter is set to ‘true’ the document directory will be deleted after a successful import operation.
If there are unknown files (neither binary files nor meta.xml files) in a  document directory – which may have been created by a plug-in during archiving – and if import.deleteUnknownFiles = ‘false’, the directory will not be deleted and the error count, which is relevant in conjunction with the parameter ‘import.ignoreErrors’, will be increased.

This option is mutually exclusive with import.filePathAbsolute, i.e. with absolute paths this delete option is not allowed and FIS won’t start but generate a corresponding error log message instead.

Type: Boolean (default = false)

ArchiveDocuments

UpdateDocuments

SmartUpdateDocuments

import.deleteBatchErrorAbort

If this parameter is set to ‘true’, the import process will be cancelled if a document directory cannot be deleted by the system.

Type: Boolean (default = false)

ArchiveDocuments

UpdateDocuments

SmartUpdateDocuments

import.deleteUnknownFiles

If this parameter is set to ‘true’, the files which are unknown to FIS, i.e. non binary files or non meta.xml files will also be deleted. This only applies if the parameter import.deleteBatch is set to ‘true’.

Type: Boolean (default = false, i.e. no files will be deleted)

ArchiveDocuments

UpdateDocuments

SmartUpdateDocuments

import.archiveZeroByteFiles

If this parameter is set to ‘true’, files with size 0 bytes are written to the archive. Otherwise, zero-byte files are treated as errors, if they are referenced in the metadata file (meta.xml).

Type: Boolean (default = false)

ArchiveDocuments

UpdateDocuments

SmartUpdateDocuments

import.filePathAbsolute

If this parameter is set to ‘true’, the path of an image file provided in meta.xml as “batchFileName” must be an absolute path.

This option is mutually exclusive with import.deleteBatch, i.e. with absolute paths the delete option is not allowed and FIS won’t start but generate a corresponding error log message instead.

Type: Boolean (default = false)

ArchiveDocuments

UpdateDocuments

SmartUpdateDocuments

ArchiveSapDocuments

Use case update

UpdateDocuments

updateDocuments.notFoundIsNoError

This parameter determines, if it is an error when an object is not found. By default (false) an object that cannot be found is considered as an error. If you want to ignore errors where objects are not found, set this to true.

Type: Boolean (default = false)

 

Use case bulk attribute update

BulkUpdateAttributes

bulkupdateattributes.seachLimit

Maximum number of documents to be updated in one order:
If this limit is exceeded (which corresponds to the number of result items in a RAQL search query that is used in update.xml), the belonging update order is not started at all. This is intended as an option for safety reasons, since a very high number of result items may be caused by an erroneous query.

Type: Integer (default = -1, i.e. no limit is set)

 

bulkupdateattributes.docsmulticount

The number of documents handled as one transaction within one order. The minimum value is 1.

Type: Integer (default = 100)

 

Use case archive

ArchiveDocuments

archiveDocuments.multipleCount

This parameter designates a threshold value which represents the maximum number of documents, which are archived together in one request by the Integration Service Web services request “createMultipleDocuments”.

If ‘archiveDocuments.multipleCount’ is set together with ‘archiveDocuments.multipleSize’ the threshold which is exceeded first will apply.

If neither ‘archiveDocuments.multipleCount’ nor ‘archiveDocuments.multipleSize’ is set (which equals to both values being set to 0), one document will be archived per request.
During processing of transactions, this parameter will be ignored. A transaction will be archived in one request regardless of the number of documents or the size of the content in it.

Type: Integer >= 0 (default= 0, i.e. one document is archived per request)

 

archiveDocuments.multipleSize

This parameter designates a threshold value which represents the maximum size of the files, which are archived together in one request by the Integration Service web services request “createMultipleDocuments”.

The size is to be specified in bytes as integer (>=0), possibly with appended “K” (factor 1024) or “M” (factor 1024*1024).
If ‘archiveDocuments.multipleCount’ is set together with ‘archiveDocuments.multipleSize’, the threshold which is exceeded first will apply.
If neither ‘archiveDocuments.multipleCount’ nor ‘archiveDocuments.multipleSize’ is set (which equals to both values being set to 0), one document will be archived per request.
During processing of transactions, this parameter will be ignored. A transaction will be archived in one request regardless of the number of documents or the size of content in it.

Type: String>= 0 (default=“0”, i.e. one document is archived per request)

 

Use case export

 

exportObjects.defaultCreateFlatBatch

If this parameter is set to ‘true’, revisions will be created in the following directory structure – a flat batch structure:
<batch>/<searchresult>/<section>/<hitNo>.

A flat batch structure, in contrast to the default structure with an additional item level (see beneath), can be used as an archive input batch for re-import into another ImageMaster 9 system.
An export is based on a query. One hit in a search query result may contain several items (e.g. several revisions). However, this is not allowed for flat batch structure and will cause an error if exportObjects.defaultCreateFlatBatch is set to ‘true’.

If the parameter is set to ‘false’, the default batch structure for revisions in query results is used, which contains an additional directory level for items:

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

Type: Boolean (default = false)

ExportObjects

exportObjects.sectionSizeLimit

This parameter determines the maximum number of export items (i.e. hits with revisions), which are exported into one section directory. If this threshold is reached, a new section directory will be generated.

Hits without revision items don’t need a separate directory and will be omitted in the counter.

Type: Integer (default = -1, i.e. all results are in one section)

ExportObjects

ExportSapObjects

exportObjects.defaultPagesize

This parameter may be relevant for fine tuning in specific scenarios. It denotes the default size for a hit list segment or “page” which is an internal tuning parameter. The value 0 indicates that the page size is unlimited, i.e. the complete result will be returned in one page.

Type: Integer >= 0 (default = 100)

ExportObjects

exportObjects.defaultRetrieveBinaryfiles

This parameter indicates, if binary files should be exported from a query. If set to ‘false’ only metadata will be exported without binary content.

Type: Boolean (default = true)

ExportObjects

exportObjects.ignoreErrors

This parameter denotes the maximum number of items, for which export may fail, before the complete batch process is cancelled.

Type: Integer >= 0 (default= “10”)

ExportObjects

ExportSapObjects

exportObjects.resultSectionFormat

This parameter determines the format of the section directory names which are generated in an export operation.

Type: String (default = ‘%05d.sec’)

The format string denotes a 5 digit number with left-padded zeroes and the suffix “.sec”.

ExportObjects

exportObjects.resultHitFormat

This parameter determines the format of the hit directory names which are generated in an export operation.

Type: String (default = ‘%05d.hit’)

The format string denotes a 5 digit number with left-padded zeroes and the suffix “.hit”.

ExportObjects

exportObjects.resultItemFormat

This parameter determines the format of the item directory names which are generated in an export operation.

Type: String (default = ‘%05d.itm’)

The format string denotes a 5 digit number with left-padded zeroes and the suffix “.itm”.

ExportObjects

exportObjects.WriteOriginalFileNames

If this parameter is set to ‘true’ the filenames for binary files will be used, which have been specified during an import or upload operation by the parameter “originalFileName”.

If a revision has filenames, which can’t be written in the current operating system, or if one revision contains duplicate filenames, this causes an error.

If this parameter is set to ‘false’ or if the content object is empty, a unique filename (UUID) is generated.

Besides being generated as a filename in the file system, the filename will also be generated as the value of the attribute ‘batchFileName’ in the meta.xml file which results from the export operation for that revision (which may be used for later re-import).

Type: Boolean (default= false)

ExportObjects

ExportSapObjects

exportObjects.notFoundIsNoError

This parameter determines, if it is an error when an object is not found. By default (false) an object that cannot be found is considered as an error. If you want to ignore errors where objects are not found, set this to true.

Type: Boolean (default = false)

ExportObjects

ExportSapObjects

exportObjects.exportEvidenceRecord

This parameter determines, if FIS should attach evidence record for each document which is exported from ImageMaster or not.

Type: Boolean (default = false)

ExportObjects

ExportSapObjects

Use case delete

DeleteObjects

deleteObjects.defaultIgnoreErrorsObjectNotFound

If this parameter is set (to a value >=  -1), errors of the type “object-not-found” are counted separately, and the given number determines, when the batch process is cancelled due to this type of error. (In parallel another counter is active for other types of errors based on parameter “deleteObjects.ignoreErrors”).

Type: Integer (default = -1, i.e. error type “object-not-found” is treated like a common error, and in this case “deleteObjects.ignoreErrors” decides about the cancellation of the batch process in error cases)

DeleteObjects

deleteObjects.deletionLimitPerSearch

This parameter denotes the maximum number of objects,  which are allowed to be deleted via one search in the search definition file.

Type: Integer, (default = -1, i.e. unlimited)

DeleteObjects

deleteObjects.ignoreErrors

Maximum number of errors which may occur during deletion before the deletion batch process is stopped.

Errors of the type “object-not-found” can also be handled separately (see parameter “deleteObjects.defaultIgnoreErrorsObjectNotFound”).

Type: Integer (default = 10)

DeleteObjects, DeleteSapDocuments, DeleteMigratedDocuments

deleteObjects.notFoundIsNoError

This parameter determines, if it is an error when an object is not found. By default (false) an object that cannot be found is considered as an error. If you want to ignore errors where objects are not found, set this to true.

Type: Boolean (default = false)

DeleteObjects, DeleteSapDocuments