Purge Audit Status

The purge operations return a status.

The response to the doPurgeAudit, checkPurgeAudit, and stopPurgeAudit operations may be either of:

  • A status message. This is the response given in previous versions of TIBCO ActiveMatrix BPM, and is given in this version if extended data is not requested.
  • The status message plus a series of fields in the purgeStatus object. This response is given if you specify either of:
    • requireAllExtendedData=true
    • requireExtendedData=<field;field...>

Merged Status Message

The format of the status message included in the response to doPurgeAudit, checkPurgeAudit, and stopPurgeAudit depends on the status returned. The table shows the message formats.

PURGE_IN_PROGRESS 
Purge Operation [purge_name] started at start_time is still in progress! deleted instances of total total deleted!
PURGE_COMPLETED 
Purge Operation [purge_name] started at start_time finished at end_time with success! deleted instances of total total deleted!
PURGE_FAILED 
Purge Operation [purge_name] started at start_time finished at end_time with error! deleted instances of total total deleted!

.                                         failure_stack_trace
PURGE_STOPPED 
Purge operation [purge_name] stopped successfully!

Where:

purge_name = A unique automatically-generated identifier for the purge. For example, [EC-PURGE-1351517760674].
start_time = The start time of the purge.
end_time = The time when the purge completed.
deleted = The number of instances deleted by the purge operation so far.
total = The total number of instances identified as matching the purge criteria, and therefore eligible to be deleted.
failure_stack_trace = The stack trace for the failure, if the purge resulted in a failure.

PurgeStatus Object

You can configure any of the doPurgeAudit, checkPurgeAudit and stopPurgeAudit operations to use the requiredExtendedData item within their options. This causes status data to be returned via fields in the purgeStatus object. Possible values are:

  • requireAllExtendedData: If true, return all the available extended data for this operation. Not all fields will be available to be returned for all circumstances. For example, if a purge operation is currently in progress the END field is not returned.
  • requiredExtendedData: This enables you to specify one or more specific items of extended data. Possible values are:
    Field Meaning
    START The start date of a purge operation.
    END The end date of purge operation.
    DETAILS Any additional details about the operation. (This is currently only used for stack traces when errors occur).
    NAME The automatically-generated unique name for the purge operation.
    CURRENT The number of items purged so far.
    TOTAL The total number of items found that need to be purged.

    For example:

    (SOAP) <requiredExtendedData>START;END;TOTAL</requiredExtendedData>
(REST) requireExtendedData=START;END;TOTAL