Dock Appointment Purge

This time-triggered transaction purges all dock appointment details for a period greater than the retention days specified in the Dock Appointment Purge criteria, and if the resource pool consumption detail do not exist for the specified dock appointment.

Attributes

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

Table 1. Dock Appointment Purge Attributes
Attribute Value
Base Transaction ID DOCKAPPOINTMENTPRG
Base Document Type None
Base Process Type General
Abstract Transaction No
APIs Called None
User Exits Called YFSBeforePurgeUE

Criteria Parameters

The following are the criteria parameters for this transaction:

Table 2. Dock Appointment 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 - Production mode. Deletes records from regular tables.
  • N - Test mode.
AgentCriteriaGroup Optional. Used to classify nodes. This value can be accepted by WMS time-triggered transactions that only perform their tasks on the nodes with a matching node transactional velocity value.

Valid values are: LOW, HIGH, and any additional values defined by the Hub from Sterling Application Platform > System Administration > Agent Criteria Groups.

ColonyID Required in a multischema deployment where the YFS_DOCK_APPOINTMENT table may exist in multiple schemas. Runs the agent for the colony.

Statistics Tracked

The following statistics are tracked for this transaction:

Table 3. Dock Appointment Purge Statistics
Statistic Name Description
NumDockAppointmentsPurged Number of dock appointments purged.

Events Raised

None.

Tables Purged

YFS_DOCK_APPOINTMENT