1. Scheduled Processes for SCM
  2. Purge Shipping Interface

Purge Shipping Interface

Use the Purge Shipping Interface scheduled process to delete shipping interface records created by the Shipment Request Import file-based data import (FBDI) template, the Perform Shipping Transaction Import FBDI template, the Shipment Line Transaction Requests REST service, the Shipment Transaction Requests REST service, the Shipment Request SOAP service, and the Material Shipment SOAP service.

The shipping interface records are selected based on a range of parameters. The process uses the parameter to query the transactions in the Shipping Transaction history (WSH_TRANSACTIONS_HISTORY) table and delete the interface records associated with the transaction from the following tables:
  • WSH_DEL_DETAILS_INTERFACE
  • WSH_NEW_DEL_INTERFACE
  • WSH_DEL_ASSGN_INTERFACE
  • WSH_DEL_DETAILS_HOLD_INTERFACE
  • WSH_FREIGHT_COSTS_INTERFACE
  • WSH_INTERFACE_ERRORS
  • INV_LPN_INTERFACE
  • INV_SERIAL_NUMBERS_INTERFACE
  • INV_TRANSACTION_LOTS_INTERFACE
  • ZMM_NOTES
  • FND_ATTACHED_DOCUMENTS

When to Use

Use this process when you want to delete shipping interface records in bulk and at predefined times or intervals. Consider running the Purge Shipping Interface process periodically to delete old shipping interface records that aren't required. Keeping the size of the shipping interface tables small will improve the performance of the Receive Shipment Request and Perform Shipping Transactions process. It also improves the performance of Manage Shipment Message Interface and Manage Shipping Transaction Corrections in Spreadsheet ADFdi workbooks.

Privileges Required

  • Purge Shipment Exceptions (WSH_PURGE_SHIPMENT_INTERFACE_PRIV)

Specifications

Review the following before setting up this scheduled process:

Specification

Description

Job Type

Ad hoc job

Scheduled

Frequency

As required, usually depends on shipping interface data volume.

Time of Day

Any time.

Duration

 Runtime of this process varies based on the number of interface records to process.

Compatibility

There should be only one instance of the process running at a time. The process is incompatible with itself, thus preventing multiple instances of the process running at the same time.

Parameters

Parameter

Optional or Required

Description

Parameter Values

Special Combinations Required

Notes

Review Only

Optional

Indicates if the process needs to delete the selected records or only print the number of selected records in the output file of the process.

Yes (If the check box is selected.)

No (If the check box is not selected)

None

By default, the Review Only check box is selected.

From Creation Date

Optional

Starting creation date if you want to use a range of creation dates to select shipping interface records for purge.

Date

None

N/A

To Creation Date

Optional

Ending creation date if you want to use a range of creation dates to select shipping interface records for purge.

Date

None

N/A

Purge Cutoff Days

Optional

Indicates the number of days of shipping interface records to keep. Only records older than the entered number of days will be selected for purge.

Number of days

None

N/A

Transaction Status

Optional

The status of the shipping transaction history associated with the shipping interface records you want to select for purge.
Single value from the list of values which contain the transaction status as below:
  • Awaiting processing
  • Error
  • In process

None

Default value is Error.

Interface Type

Optional

Interface type of the shipping interface records you want to select for purge.
Single value from the list of values which contain the interface type as below:
  • Shipment request
  • Shipment transaction request

None
  • Use the Shipment request to select the shipping interface records created by the Shipment Request Import FBDI template, Shipment Line Transaction Requests REST service and Shipment Request SOAP service.
  • Use the Shipment transaction request to select the shipping interface records created by the Perform Shipping Transaction Import FBDI template, Shipment Transaction Requests REST service and Material Shipment SOAP service.

Document Number

Optional

Document number such as order number or shipment number of the shipping interface records you want to select for purge.

Order number or Shipment number

None
  • Use the order number to select the shipping interface records created by the Shipment Request Import FBDI template, Shipment Line Transaction Requests REST service and Shipment Request SOAP service.
  • Use the shipment number to select the shipping interface records created by the Perform Shipping Transaction Import FBDI template, Shipment Transaction Requests REST service and Material Shipment SOAP service.

Load Request ID

Optional

Specific file-based data import (FBDI) load request of the shipping interface records you want to select for purge.

Number

None

N/A

Troubleshooting Information

  • You can view the status of the process in the Scheduled Processes work area.
  • Once the process is complete, it will have a log file and an output file.
  • The output file will have a summary with the number of shipping interface records selected by the process based on the input parameters.
  • Error and warning messages encountered while running the process will be displayed in the log file.
  • When the process is submitted, you can Resubmit, Put on Hold, Cancel Process, and Release Process as provided by the Scheduled Processes work area.

Related Topics