Cleanup
Cleanup Setup in 3PL Dynamics
With every posted document, sent email, or aborted session, your database grows — which is expected. However, not all data has to be kept forever. Posted documents typically only need to be retained for a few years, and aborted scan sessions can be closed and deleted almost immediately. This is where cleanup setups come in.
Cleanup setups let you determine which data can be deleted after a certain period. This prevents your database from growing unnecessarily large, which could degrade application performance. It also helps prevent errors — for example, too many incorrectly closed scan sessions can cause issues when employees resume an old session. Similarly, EDI messages containing print documents in the DI Message table can silently inflate your database, so it is recommended to purge them periodically using the cleanup setup.
How to
- Open the Cleanup Setup page.
- Several predefined entries are available by default. You can activate or modify these (for example, the date filter or an additional table filter), or add new rules — for example, to remove one-time addresses.
- Open Job Queue Entries.
- Create a new job queue entry
WMS Job Queue Task - Task 13to automatically delete records that meet the criteria on a nightly basis. - Set the task to On Hold and schedule it for a day/time with few or no transactions — for example, only during Saturday nights.
Available actions on the setup page:
- Calculate — reports the number of records that would be deleted.
- Cleanup All — executes the cleanup and deletes the matching records.
Tip
- The first execution takes longer than subsequent runs.
- Open the Progress Log page to monitor progress and detect any issues.
Cleanup Setup fields
The following fields define the structure and properties of the 3PL Cleanup Setup table, which is used to configure cleanup operations. Each field has a specific purpose, allowing users to define and manage cleanup settings per table.
| Field Name | Field Type | Description |
|---|---|---|
| Table No. | Integer |
Number of the table. If a table is not available in the Cleanup Setup, create a ticket to have it added. |
| Table Name | Text[100] |
Name of the table. |
| Table Caption | Text[249] |
Caption or description of the table. |
| Extra Table Filter | TableFilter |
Additional filter applied to the table, used to narrow down the records processed during cleanup. |
| Type | Option |
Type of cleanup operation to perform. Possible values: Delete, Archive, Compress. |
| Field Number | Integer |
Number of the field within the table on which the date/time filter will be applied. |
| Filter Field | Text[80] |
Name of the field used as a filter during cleanup operations. |
| Date Formula | DateFormula |
Formula used to calculate a date value during cleanup operations. |
| Inactive | Boolean |
Indicates whether the cleanup setup is inactive. If true, the setup is skipped during cleanup runs. |
| Last Executed | DateTime |
Date and time when the cleanup setup was last executed. |
| Total Records Deleted | Integer |
Total number of records deleted during the last cleanup run. |
| Records within filter | Integer |
Number of records currently matching the specified filter criteria. |
Cleanup types
| Type | Description | Supported tables |
|---|---|---|
Delete |
Records are removed from the table. | All |
Archive |
Moves records from WMS Document Header (including sub-tables) to WMS Posted Document Header. Maximum archive age is 3 months. | WMS Document Header |
Compress |
Removes unused (set) entries. | Report Usage WMS Specification Set Entry WMS Item Ledger Entry WMS Doc. Info Set Entry WMS Carrier Stack Set Entry WMS Carrier Set Entry |
Note
WMS Item Ledger Entry (Compress): deletes historical item ledger entries for any carrier whose net quantity is zero and which has had no activity past the cutoff point — i.e., safe-to-purge, fully closed-out carrier history — while leaving carriers with outstanding/non-zero quantities or later activity untouched. Test thoroughly in a test environment before enabling in production.
Tip
You can create multiple configurations per table. For example, for the DI Message table you can filter by SND-ZPL / SND-PDF and clean daily, while cleaning other message types only once a month.