Open topic with navigation

TIBCO iProcess® Engine 11.10.0

# Purge a Case

To purge one or more cases of a specific (locally hosted) procedure, use the following command:

## Syntax

    PURGE [-P priority] [-d] <node|-> procname <caselist|ALL_CASES|dd_mm_yyyy>

where:

| • | `-P` `priority` specifies the internal message queue priorities. For more information about message priorities, see "Message Prioritizing" in the appropriate TIBCO iProcess Engine (Database) Administrator’s Guide.

| • | `-d` purges cases without triggering events that are set for the `OnBeforePurge` event. The events are triggered before purging the case if running the `PURGE` command without the `-d` option. For more information about the `OnBeforePurge` event, see TIBCO iProcess Modeler Procedure Management.

| • | `node` is the name of the remote host node. Enter a hyphen (`–`) if the procedure is hosted locally.

| • | `procname` is the name of the procedure, including sub-procedures.

| • | `caselist` purges all cases in a given range, whether they are open or closed. Use:

| — | `ALL_CASES` to specify all cases of the procedure.

| — | a comma (`,`) to separate case numbers, and a hyphen (`–`) to specify a range. The caselist must not exceed 255 characters.

For example, the entry `2,5-10` means case `2` and cases `5` to `10` inclusive.

Note | It is more efficient to purge a number of cases using a list rather than running multiple purge commands.

| • | `dd_mm_yyyy` purges all cases terminated up to and including the specified date. The date is specified as the day, month and year numbers (in that order) separated by underscores.

## Notes

If you use a syntactically incorrect `PURGE` command, the utility may not return an error message (in verbose mode) indicating that it could not process the command.

Purging many cases can be made more efficient by setting the `USE_NEXT_MESSAGE_TO_DEQUEUE` process attribute to `1`. This is only of benefit when there is a large build up of messages in the Oracle AQs. See "Message and Mbox Processing Configuration" in TIBCO iProcess Engine Administrator’s Guide for more information.

## Example

This example purges all cases of procedure `HIRING` on the local node.

    PURGE - hiring ALL_CASES

This example purges case `2` and cases `5-10` inclusive of procedure `HIRING` on the local node:

    PURGE - hiring 2,5-10

Did you find this helpful?

Yes No
Great!
Thanks for taking the time to give us some feedback.
Sorry about that

Why wasn't this helpful? (check all that apply)

Could not find what I was looking for
Instructions confusing or unclear
Instructions did not work

Want to tell us more?

Please select at least one option or provide details about the issue!!

Error occurred while submitting feedback.

Error2 occurred while submitting feedback.

TIBCO iProcess® Engine

Copyright © 1994-2025. Cloud Software Group, Inc. All Rights Reserved.