Inventory supply temp purge

The Inventory Supply Temp purge agent cleans up the contents in the temporary inventory tables generated by the process of synchronizing the Sterling Order Management System Software inventory picture with the actual inventory picture at the nodes.

The node inventory picture is stored during the loading process into the YFS_INVENTORY_SUPPLY_TEMP table. Once the synchronization phase is complete and the YFS_INVENTORY_SUPPLY table has been updated, the YFS_INVENTORY_SUPPLY_TEMP table needs to be purged, which is done through this agent.

For more information about configuring the synchronization with node inventory, see the Configuring Sterling Global Inventory Visibility topic.

The Inventory Supply Temp purge agent is used to purge all records in the YFS_INVENTORY_SUPPLY_TEMP table whose modify timestamp is less then current time minus the purge criteria's retention days for a group of YantraMessageGroupID.

The Inventory Supply Temp purge agent also supports the mass deletion of InventorySupplyTemp records that are piling up during inventory load and sync operations. This agent should be called to clean up the InventorySupplyTemp records for each YantraMessageGroupID for which no unprocessed inventory items exist. The YantraMessageGroupID and IgnoreLeadDays criteria attributes are used to allow the mass deletion of InventorySupplyTemp records, ignoring the lead days.

Attributes

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

Table 1. Inventory supply temp purge attributes
Attribute Value
Base Transaction ID SUPPLYTEMPPRG
Base Document Type General
Base Process Type General
Abstract Transaction No
APIs Called None
User Exits Called None

Criteria parameters

The following are the criteria parameters for this transaction:

Table 2. Inventory supply temp 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.
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.
EnterpriseCode Optional. The inventory organization for which the Inventory Supply Temp Purge needs to be run. If not passed, then all enterprises are monitored.
PurgeCode Required. Cannot be modified. Used for internal calculations, such as determining retention days. Corresponds with the PurgeCode used in Business Rules Purge Criteria.
ColonyID Required in a sharded deployment where the YFS_INVENTORY_SUPPLY_TEMP table may exist in multiple schemas. Runs the agent for the colony.
YantraMessageGroupID Optional. An identifier that is used to group the inventory picture during the inventory synchronization process.
IgnoreLeadDays Optional. Valid values are:
  • Y - When set to Y and YantraMessageGroupID is populated, supports batch deletion of InventorySupplyTemp records.
  • N - Default value. When set to N, uses the default lead days to fetch eligible records to purge.

Statistics tracked

The following statistics are tracked for this transaction:

Table 3. Inventory supply temp purge statistics
Statistic Name Description
NumInventorySupplyTempsPurged Number of entries in the YFS_INVENTORY_SUPPLY_TEMP table purged.

Pending job count

Number of unique YantraMessageGroupIDs from YFS_INVENTORY_SUPPLY_TEMP table whose maximum modify timestamp is less than current timestamp minus purge criteria's lead day.

Events raised

None.

Tables purged

YFS_INVENTORY_SUPPLY_TEMP