Opportunity history purge

This transaction deletes tasks previously archived by the Opportunity Purge. See Opportunity purge.

You can use purge codes pseudo-logic to analyze purges. If the following conditions are met, an opportunity that is previously purged by the opportunity purge agent is picked up for history purge:

  • The last modified date of the opportunity should exceed the retention day period.
  • The quote history is purged.

Attributes

The following are the attributes for this time-triggered transaction:

Table 1. Opportunity history purge attributes
Attribute Value
Base Transaction ID OPPORTUNITYHISTPRG
Base Document Type Opportunity
Base Process Type Opportunity Fulfillment
Abstract Transaction No
APIs Called None
User Exits Called None

Criteria parameters

The following are the criteria parameters for this transaction:

Table 2. Opportunity history purge criteria parameters
Parameter Description
Action Required. Triggers the transaction. If left blank, it defaults to Get, the only valid value.
PurgeCode Required. Cannot be modified. Used for internal calculations, such as determining retention days. Corresponds with the PurgeCode used in Business Rules Purge Criteria.
Live Optional. Mode in which to run. Defaults to N.
  • Y - Default value. Removes qualifying records from the history tables listed under Tables Purged.
  • N- Test mode. Determines the rows that are removed without actually removing them.
Number of Records To Buffer Optional. Number of records to retrieve and process at one time. If left blank or specified as 0 (zero), it defaults to 5000.
EnterpriseCode Optional. Enterprise for which the Opportunity History Purge needs to be run. If not passed, then all enterprises are monitored.

When the EnterpriseCode is blank, the purge criteria configured for the DEFAULT enterprise is used; not the purge criteria configured for the opportunity's enterprise.
CollectPendingJobs If this parameter is set to "N", the agent does not collect information on the pending jobs for this monitor. This pending job information is used for monitoring the monitor in the System Management Console.
ColonyID Required in a multi schema deployment where a table may exist in multiple schemas. Runs the agent for the colony.

Statistics tracked

The following statistics are tracked for this transaction:

Table 3. Opportunity history purge statistics
Statistic Name Description
NumOpportunityHistory
Purged
 Number of opportunity histories purged.

Pending job count

For this transaction, the pending job count is the number of records that can be purged from the YFS_OPPORTUNITY_H table.

Events raised

None.

Tables purged

YFS_OPPORTUNITY_H

YFS_OPPORTUNITY_H_EXTENSION