When a user starts an asset purge operation, the development framework does the following:
The asset purge function selects a set of repository items based on the asset conditions that are set by the administrator who invokes the purge function. All the items are from the same repository and are of the same type. See Selecting Repository Items.
The asset purge function passes each repository item through a pipeline of processor components.
If related conditions or actions are configured for the purge function, the pipeline processors for those conditions handle each item. The processors for related conditions may skip certain items so that they are not deleted. The processors for related actions perform additional operations for each item. See Related Conditions and Actions.
You can add processing steps to the pipeline if required by your specific situation. See Configuring Additional Processing Components.
A final processor in the pipeline removes each item from the repository.
The asset purge feature presents information about the items it processed. See Purge Statistics.
Repository Path and Item Descriptor
Several asset purge components use configuration properties that hold the Nucleus path of a repository component and a repository item type descriptor. A specific repository and item type define the asset for an asset purge function. See information about repositories, repository items, and item type descriptors in Repository API.
PurgeItem Parameters
The asset purge feature includes a set of parameters with each repository item that it selects and passes through the asset purge pipeline processors. Each processor in the pipeline can access the parameters and use the information they contain.
The parameters for the repository items in the asset purge pipeline are determined by the related condition and action components for the asset purge function. If you configure a related condition or action component, you can provide a parameter name and value. Users who invoke the asset purge function can select a related condition or action and include its parameter or deselect the related condition or action and omit the parameter.
The atg.purge.PurgeItem object for each repository item has a java.util.Map of parameters. Processors can access the parameter Objects in this map by their String keys. The following example shows how a processor method that takes the PurgeItem as its pPurgeItem argument can use the PurgeItem.getParameters() method to access an integer parameter.
// Get an integer value from a PurgeItem parameter.
int someint = Integer.parseInt((String)
pPurgeItem.getParameters().get("parameterkey"));See more detailed examples in Overriding the canPurge Method and Adding a Pipeline Processor for Related Actions.
