Skip to main content

xSuite Interface Windows Prism 5.x – Online Help

Post-Processing (Backup)

The following properties are used to finalize a processed batch. In particular, this finalization includes saving the input data.

A batch only receives the final status if all documents contained in the batch have been successfully processed (status "Finished") or if processing has been deliberately canceled via the configuration (status "Canceled").

An instance of the backup worker responsible for this step is only started if an input worker is also active in the scenario. In most cases, the backup refers to the data that was read in by the input system and the connection data defined in the input system is required.

Property

Description

Backup.DestFolder(%)

Target folder used if the input data of a batch should be moved to a backup directory after processing (optional)

If the input data comes from a file system transfer, the original files are always used for this. Otherwise, the copies from the temporary storage are used for the backup. Only the originally transferred files are used. File attachments generated by the program itself (e.g., by a conversion macro) are not used.

Backup.AsZipFile

Boolean value determing whether the backup by batch will be in the form of a compressed ZIP file

In this case, specify the base path of the ZIP file without the file extension as .DestFolder.

Default value: TRUE

Backup.DeleteFromSource

Boolean value determining whether the data of a batch will be deleted from the input system

The input system must support such a functionality for this (e.g., in case of a transfer via file system).

This deletion will be executed only if the input data backup has been activated and successfully performed.

Default value: TRUE

Backup.DeleteFromStorage

Boolean value determining whether the files of a batch will be deleted from the temporary storage system

Default value: TRUE

Alternatively, the files can be deleted downstream using the global DeleteBatches() macro as part of a separate clean-up task. If the files are left in the storage for the time being, this data can be displayed in the Status Monitor if it has already been processed.

Caution

This deletion will take place regardless of whether a backup of the data was previously performed. If xSuite Interface does not have direct access to the original input data because it was transferred via web service, for example, the deletion from temporary storage will remove the only copy of the file attachments. Processing can thus only be restarted by repeatedly sending the data from the external system.

Backup.OnDestFileExists

Mode determining how to proceed if backup files with the same name already exist:

  • Skip: skip file (i.e., keep existing file)

  • Overwrite: overwrite existing file

  • Rename: generate new file name with appended counter (default value)