Negotiation purge

This purge archives data into history tables after it completes its typical lifecycle. This reduces the load on frequently accessed tables. It works from the task queue (YFS_TASK_Q) table.

You can use purge codes pseudo-logic to analyze purges. If the following condition is met, a negotiation is picked up for purge:

  • The last modification performed on the negotiation falls before the lead time (in days) setup.
  • The negotiation is in pickable status.

Any enterprise using the Console must schedule purge transactions.

Attributes

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

Table 1. Negotiation purge attributes
Attribute Value
Base Transaction ID ORD_NEGOTIATION_PURGE
Base Document Type Order
Base Process Type Order Negotiation
Abstract Transaction No
APIs Called None
User Exits Called YFSBeforePurgeUE

Criteria parameters

The following are the criteria parameters for this transaction:

Table 2. Negotiation purge criteria parameters
Parameter Description
Action Required. Triggers the transaction. If left blank, it defaults to Get, the only valid value.
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 Negotiation Purge needs to be run. If not passed, then all enterprises are monitored.
Live Optional. Mode in which to run. Valid values are:
  • Y - Default value. Moves qualifying records from the regular tables listed under Tables Purged to the corresponding history tables.
  • N - Test mode. Determines the rows that are moved to history tables without actually moving them.
PurgeCode Required. Cannot be modified. Used for internal calculations, such as determining retention days. Corresponds with the PurgeCode used in Business Rules Purge Criteria.
Next Task Queue Interval Optional. Specifies in hours how long a failed task should be suspended before it is considered for reprocessing. Defaults to 5 hours.
ColonyID Required in a sharded deployment where a table may exist in multiple schemas. Runs the agent for the colony.
Task Queue Filter Criteria Optional. Determines the jobs to be fetched by the agent. The value assigned to this parameter is matched against the custom value stored in the FILTER_CRITERIA column of YFS_TASK_Q table, while fetching the jobs.
Note: VOID is a valid task queue filter criteria value which is used to match records with NULL value in the FILTER_CRITERIA column of YFS_TASK_Q table.

For more information, see Workload segregation for task queue agents.

Statistics tracked

The following statistics are tracked for this transaction:

Table 3. Negotiation purge statistics
Statistic Name Description
NumOrderNegotiationsPurged Number of order negotiations purged.

Pending job count

For this transaction, the pending job count is the number of records available to be processed by the transaction with the AVAILABLE_DATE value less than or equal to (<=) the current date value in the YFS_Task_Q table.

Events raised

None

Tables purged

YFS_AUDIT

YFS_NEGOTIATION_HDR

YFS_NEGOTIATION_LINE

YFS_RESPONSE

YFS_RESPONSE_HDR

YFS_RESPONSE_LINE

YFS_RESPONSE_LINE_DTL