Maintenance Tab - EIS Workflow Messaging - Foundation 24.1 - Foundation 24.1 - Ready - OnBase - external - OnBase/EIS-Workflow-Messaging/Foundation-24.1/EIS-Workflow-Messaging/Configuration/Message-Item-Types/Editing-a-Message-Item-Type/Maintenance-Tab - 2024-03-25

EIS Workflow Messaging
Platform
OnBase
Product
EIS Workflow Messaging
Release
Foundation 24.1
License

The Maintenance tab allows you to specify when completed message items are archived, deleted, and purged.

Note:

In addition to configuring the settings on the Maintenance tab for each message item type, you must also create Unity Scheduler tasks to perform the actions of archiving, purging, or deleting message items.

By default, message item types are configured to purge message items upon completion; purging permanently removes both message item content and the message item record from the database. The settings on the Maintenance tab allow you to configure OnBase to retain message items after completion, and you can specify how long the message items are retained before they are archived, deleted, and purged.

Note that maintenance activities must occur in the following sequence: first archive, then delete, and then purge. When configuring the Days After Completion settings for these activities, each retention period must be greater than or equal to the previous period. For example, if a message item type is configured to archive message items 5 days after completion, you cannot configure it to delete message items 2 days after completion, because the message items must be archived before they can be deleted.

The following settings are available in the Maintenance tab:

Maintenance Activity

Description

Archive Message Item

The Archive Message Item options control when message items are archived in the database. Archiving message items improves the performance of the database.

  • After Completion: Select this option to immediately archive a message item after the message item is completed.

  • Days After Completion: Select this option to archive message items a specified number of days after the message item is completed. Enter the number of days to wait before archiving the message item.

Note:

This maintenance activity is set to After Completion by default. To configure the Days After Completion option, the delete and purge maintenance activities must also be configured with Days After Completion values.

Delete Message Item

The Delete Message Item options control when to delete the message item. Even if a message item is deleted, a record is maintained in the database that includes basic information about the message item, such as the date and time that the message item was sent.

  • After Completion: Select this option to immediately delete the message item after the message item is completed.

  • Days After Completion: Select this option to delete the message item a specified number of days after the message item is completed. Enter the number of days to wait before deleting the message item.

Note:

This maintenance activity is set to After Completion by default. To configure the Days After Completion option, the purge maintenance activities must also be configured with Days After Completion values.

Purge Message Item

The Purge Record options control when to purge archived message items from the database. Only archived message items can be purged. When a message item is purged, the content of the message item is deleted along with the record of the message item.

  • After Completion: Select this option to immediately purge the message item after the message item is completed.

  • Days After Completion: Select this option to purge the message item a specified number of days after the message item is completed. Enter the number of days to wait before purging the message item.

Note:

This maintenance activity is set to After Completion by default.