Tab "Migration" (MIG)

Parameter

Type

Description

Default Value

ErrorThreshold

Integer

Defines the number of consecutive errors before Migration4ArchiveLink stops the migration process.

20

SkipCompIDNames

A comma-separated list of CompIDs

Defines a list of CompID names that are being excluded from the migration process.

CompIDs that shall be excluded need to be separated by a "," character.

Empty

HTTPTimeOut

Integer

Defines the timeout in seconds for the source and destination archives.

20

ContentLengthOverride

Checkbox

Defines whether Migration4ArchiveLink shall compare the X-ContentLength to the actual physical length of component in the source archive.

Unchecked: If the X-ContentLength does not match with the physical length it will result in an error.

Checked: Discrepancies in physical length compared to X-ContentLength will be tolerated.

Unchecked

ErrorRetry

Checkbox

Enables or disables retries in case of migration errors.

Checked

CompressSize

Floating point number

Defines whether components with a size greater than the given value shall be compressed in order to save space.

Please note, that this feature is only being supported if the KGS SAPALink implementation of your DMS vendor supports the property DMS_COMP_PROPERTY_COMPRESSIONSTRING

12.5 → files greater than 12.5 MegaByte shall be compressed.

1 → files greater than 1 MegaByte shall be compressed.

0.6835 → files greater than 700 KiloByte shall be compressed.

0.1953 → files greater than 200 KiloByte shall be compressed.

0.0488 → files greater than 50 KiloByte shall be compressed.

0.0009765 → files greater than 1 KiloByte shall be compressed.

0 → no compression will be done.

0

CompressMimeType

String

Defines the mime type for which compression shall be activated (provided compression size is greater than 0).

If not specified compression is not restricted to any mime type (= *).

Multiple mime types are being separated by a ";" character.

To specify a specific mime type for a repository:

CompressMimeType_

Examples:

CompressMimeType_T1=image/tiff

CompressMimeType_T1=apllication/pdf;CompressMimeType_T2=image/tiff

*

OverrideMimeType

List of comma-separated override definitions

If specified, specific mime type(s) will be changed during the migration process in the destination archive.

The document which is being migrated will not be converted, but rather only the mime-type property is being changed.

Example:

OverrideMimeType=application/octet-stream=application/pdf,apllication/x-ascii=text/plain

Please note: Any changes applied to the OverrideMimeType will require a restart of at least the migration-bundle in order to take effect!

*

RemoveEmptyContentType

boolean

If false migration sends content type like received from source content server in document info command.

If the content type there is an empty string and this flag is enabled, migration does not send content type header to destination content server.

In debug log level this case is logged.

available ein versions 3.0.9.2 .. 3.0.9.X and >3.2.3

false

TargetForceDeletion

Checkbox

In connections with Centera / DB this can be used in order to override documents in the destination archive during migrations that are being proctected through retention settings. e. g. for reprocessing.

This functionality is only being supported for destination archives using KGS SAPALink interface and that do not support the KGS SAPALink function "componentUnregister".

Use this parameter with care! If source and destination archive are being mixed up, you could potentially destroy documents or data!

Unchecked

SkipExisting

Checkbox

Defines whether Migration4ArchiveLink shall skip already existing DocIDs that already exist in destination archive.

If being checked Migration4ArchiveLink will skip the already present DocIDs from the migration process and return a message that the document is being skipped as it already exists in the destination archive already.

When the configuration options ‘SkipExisting’, ‘CheckSrcHashValues’ and ‘CheckDstHashValues’ are enabled and the source Document ID exists in the destination archive, then the checksums of both documents are compared and different checksums lead to Errors

Unchecked

HTTPChunked

Integer

Defines how Migration4ArchiveLink handles the file transfer from the source archive to the destination.

0: The whole file will be loaded from the source archive into the RAM of the Migration4ArchiveLink server and will be transferred as soon as the retrieval is completed

1:  Chunks of a specific length will be loaded into the RAM of the Migration4ArchiveLink server and are being transferred chunk by chunk.

2: The whole file will be transferred without loading it into the RAM of the Migration4ArchiveLink server.

0

SetOriginalDateTime

Checkbox

Instead of SAPALink migration (which allows the document to retain it's original creation/modification date /time), it's also possible to migrate the document with its original creation/modification date/time over HTTP.

However, this option is only compatible if Migration4ArchiveLink runs on Tomcat server.

 

CheckSrcHashValues

Checkbox

Document is read from source archive. After received by migration tool a hash value is calculated. The source archive is requested to send the hash value stored there. The two hashes are compared.

This option should be used in case a KGS Store is the source.

Unchecked: No hash values will be retrieved from the source ContentServer.

Checked: Hash values will be retrieved from the source ContentServer.

Unchecked

CheckDstHashValues

Checkbox

before 3.2.0:

Calculates MS5-hash in migration tool, sends document to destination CS and gets the new created document from destination and calculates the MD5 again and compares them.

 

from 3.2.0

calculates md5 has in migration tool, sends document together with MD5 hash in x-header to destination CS. Destination CS, if it is a KGS CS, it calculates the MD5 again and the destination CS compares the checksum with the checksum transfered by x-header. If it is ok it sends 201 (created) or if it failes an 4xx code. If the migration receives an 201 it knows, that the migration was ok.

 

Unchecked: Hash values will not be generated and compared.

Checked: Hash values will be generated and compared.

Unchecked

MigrationComponentOrder

List of semicolon-separated content types

Defines a certain order in which Migration4ArchiveLink migrates the components related to the documents please provide a semicolon-separated list of types.

Empty

CSV Delimiter

String

Defines the delimiter for CSV-Report exports.

;

AlternateDocument

String

In case a component, belonging to a DocID, is not found in the source system a user specified default PDF document can be used.

 

Example:

C:\mbabstract.pdf

/opt/mbastract.pdf

Empty

Charset detector hint

String

add a encoding hint for the charset guesser for component ids. Available from 3.2.7.

Empty

Prevent trim() in CompIDs

Checkbox

Prior to Version 3.2.8, CompIDs received from source where trimmed (remove space/blank from beginning and ending of the compID). As they are valid and should remain intact, we introduced this option. Per Default, it is active.

Checked

Property retention on create

Checkbox

If enabled, it sets the 2 URL parameters COMP-PROPERTY-RETENTION and DOC-PROPERTY-RETENTION while component create on destination. (some destinations doesn’t accept unknown URL parameters.

true