Purge Messages - System Administration - On-Premises - English - Foundation 22.1 - OnBase - Essential - Premier - Standard - external - Standard - Essential - Premier

On-Premises System Administration

Platform
OnBase
Product
System Administration - On-Premises
Release
Foundation 22.1
License
Standard
Essential
Premier
CAUTION:

Purging the OnBase transaction log is a destructive event and will no longer allow for viewing of transaction log information within the purged date range.

To clear your transaction log and start a new log, you have the ability to purge messages from the Transaction Log window.

  1. To purge a transaction log, select Admin | Transaction Logs | Purge Messages in the Client module. The Purge Messages dialog box is displayed.
  2. Select the type of log(s) you wish to purge from the Log Type drop-down list.
    Note:

    Depending on your system's configuration, you may have some additional transaction log types available in the Log Types to Purge field.

  3. Select Purge Options to define what entries should be purged. The options are explained below.

    Purge Option

    Description

    Purge All

    Select this option to purge all the entries out of the selected transaction log(s).

    Purge Range

    Select this option to purge entries in the selected transaction log(s) according to a user-specified range. Selecting this option enables the Purge by Date and Purge by Tracing Level options.

    Purge by Date: Select this option to specify certain dates by which the log should be purged.

    • Up to last month: Select this option to purge the selected transaction log(s) of all entries up to the previous month.

    • Up to last three months: Select this option to purge the selected transaction log(s) of all entries up to the previous three months.

    • Up to last year: Select this option to purge the selected transaction log(s) of all entries up to the previous year.

    • Use dates specified above: Select this option to configure a specific date range. Use the list to select a range of months, or enter specific dates in the From and To fields. Multiple months can be selected in the list simply by clicking on them. Click the calendar buttons to the right of the From and To fields to choose a specific date.

    Purge by Tracing Level: Select this option to purge selected transaction log(s) entries based on their assigned tracing level. All entries with the selected tracing level will be purged. For more information concerning tracing levels, see “System Wide Settings” help in the System Administration manual.

    Create Purge Report

    Select this option to create a report when purging entries in the selected transaction log(s).

    CAUTION:

    Purging entries in the selected transaction log(s) without creating a report will result in all history for the selected Purge Range to be lost.

    Note:

    This option is only available if the User Controlled Purge Report Creation option has been selected. See dyd1646252496052.html#dyd1646252496052__table_1286550 for more details.

  4. Click Purge. The system displays a warning message box to confirm your request. It is recommended that you review the contents of the selected transaction log(s) before confirming the purge.
  5. Click Yes to permanently delete all information stored in the selected transaction log(s). The purged transaction log(s) will be stored in the Document Type Group System Documents, Document Type SYS - Transaction Log documents.
    Tip:

    To prevent a time-consuming process from purging a transaction log after an extended period of time, purge the transaction log on a regular basis.