GarbageCollection component functions

The GarbageCollection component provides the following configuration functions.

Function	Description
CleanUpAndAccount	Optional. Performs these actions: For finished requests for which the cleanup delay is passed, it deletes all database entries and files associated with the request or with the correspondences and communications that belong to the request. For finished stacks for which the cleanup delay is passed, it deletes all database entries and files associated with the stack or with the envelopes, processes and jobs that are part of the stack. For abandoned requests, processes, envelopes and stacks, it deletes the entries and files associated with the request itself and with the correspondences and communications that belong to the request. For finished requests that contain abandoned items, it calls the accounting exit points. Document Packs for cover letters composed by CCM_Bundling are not cleaned up from the storage folder with the stack to which they belong, but only removed with the request of the first communication in the envelope.

Function

Description

CleanUpAndAccount

Optional. Performs these actions:

For finished requests for which the cleanup delay is passed, it deletes all database entries and files associated with the request or with the correspondences and communications that belong to the request.
For finished stacks for which the cleanup delay is passed, it deletes all database entries and files associated with the stack or with the envelopes, processes and jobs that are part of the stack.
For abandoned requests, processes, envelopes and stacks, it deletes the entries and files associated with the request itself and with the correspondences and communications that belong to the request.
For finished requests that contain abandoned items, it calls the accounting exit points.

Document Packs for cover letters composed by CCM_Bundling are not cleaned up from the storage folder with the stack to which they belong, but only removed with the request of the first communication in the envelope.

The function does not have any parameters.

Example

The following is an example of a customization of the CCM_DoCleanUp script.

Try
  ; Remove run-time records that belong to finished stacks and finished requests.
  ; Also remove abandoned items and account the completion of requests that contain abandoned items.
  GarbageCollection = ModusProcess.GetComponent("GarbageCollection")
  GarbageCollection.CleanUpAndAccount()
OnError()
  ; Garbage collection errors are never handled. Always bail out.
  Raise("UnrecoverableGarbageCollectionError", Error.Message)
End-Try