Skip Headers

Oracle Workflow API Reference
Release 2.6.3

Part Number B10286-02
Previous Next       Contents Index Glossary
         Previous  Next          Contents  Index  Glossary

Workflow Purge APIs

The following APIs can be called by an application program or workflow function in the runtime phase to purge obsolete runtime data. These APIs are defined in the PL/SQL package called WF_PURGE.

WF_PURGE can be used to purge obsolete runtime data for completed items and processes, and to purge information for obsolete activity versions that are no longer in use. You may want to periodically purge this obsolete data from your system to increase performance.

A PL/SQL variable called "persistence_type"in the WF_PURGE package defines how all the WF_PURGE APIs behave, with the exception of TotalPerm( ). When the variable is set to TEMP, the WF_Purge APIs only purge data associated with Temporary item types, whose persistence, in days, has expired. Persistence_type is set to TEMP by default and should not be changed. If you need to purge runtime data for item types with Permanent persistence, you should use the procedure TotalPerm( ). See: Persistence Type, Oracle Workflow Developer's Guide.

Attention: You cannot run any WF_PURGE API for a future end date. By entering a future end date, you may inadvertently violate the persistence period for Temporary item types. The WF_PURGE APIs will display an error message if you enter a future end date.

The three most commonly used procedures are:

WF_PURGE.ITEMS - purge all runtime data associated with completed items, their processes, and notifications sent by them

WF_PURGE.ACTIVITIES - purge obsolete versions of activities that are no longer in use by any item.

WF_PURGE.TOTAL - purge both item data and activity data

The other auxiliary routines purge only certain tables or classes of data, and can be used in circumstances where a full purge is not desired.

The complete list of purge APIs are as follows:

Note: The AdHocDirectory() API from earlier versions of Oracle Workflow is replaced by the Directory() API. The current version of Oracle Workflow still recognizes the AdHocDirectory() API for backward compatibility, but moving forward, you should only use the new Directory() API where appropriate.
Note: If you are using the version of Oracle Workflow embedded in Oracle Applications, you can also use the "Purge Obsolete Workflow Runtime Data" concurrent program to purge obsolete item type runtime status information. See: Purge Obsolete Workflow Runtime Data.
Note: If you are using the standalone version of Oracle Workflow, you can use the standalone Oracle Workflow Manager component available through Oracle Enterprise Manager to submit and manage Workflow purge database jobs. For more information, please refer to the Oracle Workflow Manager online help.

See Also

Standard API for PL/SQL Procedures Called by Function Activities, Oracle Workflow Developer's Guide

Purging for Performance, Oracle Workflow Administrator's Guide

         Previous  Next          Contents  Index  Glossary

Oracle Logo
Copyright © 2003 Oracle Corporation.

All rights reserved.