Total (Oracle Workflow API Reference)

Oracle Workflow API Reference
Release 2.6.3.5
Part Number B12163-02


	Previous	Next		Contents	Index	Glossary

Total

Syntax

procedure Total

    (itemtype in varchar2 default null,

     itemkey in varchar2 default null,

     enddate in date default sysdate, 

     docommit in boolean default TRUE,

     runtimeonly in boolean default FALSE.

     transactiontype in varchar2 default null,

     transactionsubtype in varchar2 default null);

Description

Deletes all eligible obsolete runtime item type data that is associated with the specified item type and has an END_DATE less than or equal to the specified end date. In Oracle Applications, this procedure also deletes any Oracle XML Gateway transaction information associated with the items being purged.

If the RUNTIME ONLY parameter is set to TRUE, Total() deletes only runtime data associated with work items. However, if the RUNTIMEONLY parameter is set to FALSE, Total() also deletes these types of data:

All eligible obsolete activity design data that is associated with the specified item type and has an END_DATE less than or equal to the specified end date. See: Activities.

Expired users and roles in the Workflow local tables that are no longer in use. See: Directory.

All eligible notifications that are associated with the specified item type, have an END_DATE less than or equal to the specified end date, and are not referenced by an existing item. See: Notifications.

For Oracle Applications only, Oracle XML Gateway transaction information that is not associated with any existing work item. This information is purged using the ECX_PURGE.Purge_Items API. See: Oracle XML Gateway User's Guide.

Because Total() purges additional design data and runtime data not associated with work items when you set the RUNTIMEONLY parameter to FALSE, it is more costly in performance than Items(). If you want to purge a specific item key, use Items(), or set the RUNTIMEONLY parameter to TRUE when you run Total() to enhance performance. Run Total() with the RUNTIMEONLY parameter set to FALSE as part of your routine maintenance during periods of low activity. See: Items.

Arguments (input)

itemtype Item type associated with the obsolete data you want to delete. Leave this argument null to delete obsolete data for all item types.

itemkey A string generated from the application object's primary key. The string uniquely identifies the item within an item type. If null, the procedure purges all items in the specified itemtype.

enddate Specified date to delete up to.

docommit Specify TRUE or FALSE to indicate whether to commit data while purging. If you want Total() to commit data as it purges to reduce rollback size and improve performance, specify TRUE. If you do not want to perform automatic commits, specify FALSE. Defaults to TRUE.

runtimeonly Specify TRUE to purge only obsolete runtime data associated with work items, or FALSE to purge all obsolete runtime data as well obsolete design data. Defaults to FALSE.

transactiontype The Oracle XML Gateway transaction type to purge. Leave this argument null to purge the runtime data for all transaction types.

transactionsub type The Oracle XML Gateway transaction subtype to purge. The transaction subtype is a code for a particular transaction within the application specified by the transaction type. Leave this argument null to purge the runtime data for all transactions of the specified transaction type.

Contents

Index

Glossary

itemtype	Item type associated with the obsolete data you want to delete. Leave this argument null to delete obsolete data for all item types.
itemkey	A string generated from the application object's primary key. The string uniquely identifies the item within an item type. If null, the procedure purges all items in the specified itemtype.
enddate	Specified date to delete up to.
docommit	Specify TRUE or FALSE to indicate whether to commit data while purging. If you want Total() to commit data as it purges to reduce rollback size and improve performance, specify TRUE. If you do not want to perform automatic commits, specify FALSE. Defaults to TRUE.
runtimeonly	Specify TRUE to purge only obsolete runtime data associated with work items, or FALSE to purge all obsolete runtime data as well obsolete design data. Defaults to FALSE.
transactiontype	The Oracle XML Gateway transaction type to purge. Leave this argument null to purge the runtime data for all transaction types.
transactionsub type	The Oracle XML Gateway transaction subtype to purge. The transaction subtype is a code for a particular transaction within the application specified by the transaction type. Leave this argument null to purge the runtime data for all transactions of the specified transaction type.