BeyondERP.Newsletter
Menu

Job page · Material handling equipment interface

Outbound queue cleanup

A periodic cleanup task that removes outbound queue items that have already been sent.

Business process
Manage warehouse operations
Menu item
WMHEOutboundQueueCleanup
Setup steps
1 on this page
Show what matters for
PAGE GUIDEWhat the page does and how to use it8 sections. Choose a role to highlight what matters to you.
Everyone

1What it is and why

What it isA periodic cleanup task that removes outbound queue items that have already been sent.
What you do hereUse this page to remove sent items so that the outbound queue doesn't keep filling up.
ExampleFor example, you schedule the job weekly on Sunday at 02:30 with The number of days to keep = 30 and Delete all records = No, so outbound events already sent more than 30 days ago are removed and Ready events stay for the material handling system.
Outbound queue cleanup page in Dynamics 365
The page in Dynamics 365. page title tab to open what to set or check
Functional consultant · Solution architect

2Where it fits

Business processManage warehouse operations
Menu pathMaterial handling equipment interface › Periodic tasks › Cleanup › Outbound queue cleanup
Set up firstOutbound queue (check what is still Ready) Microsoft Learn
Used next byOutbound queue (check what is left) Microsoft Learn
Related pagesBatch jobs Microsoft Learn Reset status of outbound queue Microsoft Learn
End user · Functional consultant

3How to do it

About the examples: Examples and screenshots in this guide use BEAT, a demo company in a Dynamics 365 test environment. Use your own company's codes and values instead of copying them.

When to run it

When to run itWhen the outbound queue fills up with items that were already sent to the material handling system.
How oftenRegularly, as a recurring batch job.
Batch settingsRun it in the background as a recurring job outside peak warehouse hours.
What the output showsSent outbound items older than the days you entered are deleted, or all outbound records if Delete all records is Yes. Ready items that the material handling system hadn't read yet disappearing means Delete all records was used.

Source: Microsoft Learn

Setup steps on this page

Clean up the outbound queue

Remove sent outbound queue items on a schedule so the queue doesn't keep filling up.

Steps from Microsoft

  1. Go to Material handling equipment interface > Periodic tasks > Cleanup > Outbound queue cleanup.
  2. In The number of days to keep, enter how many days of sent outbound items to keep.
  3. Set Delete all records to Yes only when every outbound record may go regardless of its age, for example in a test environment.
  4. Run it, then open the Outbound queue page and confirm that only recent items remain.

Source: Microsoft Learn

Fields on the page

FieldWhat it meansExample
The number of days to keepHow many days of sent outbound queue items to keep; older sent items are deleted.Microsoft Learn 30
Delete all recordsWhen Yes, every outbound record is deleted regardless of its age.Microsoft Learn No
Run in the backgroundRuns the cleanup as a batch job, once or on a recurrence.Microsoft Learn

Common errors and fixes

MessageWhat to do
The material handling system can no longer read some eventsDelete all records was Yes, so events were deleted whatever their age or status. Keep it No in production. Microsoft Learn
The queue pages are slow and the queue keeps growingThe cleanup isn't scheduled. Schedule it as a recurring batch job with a retention agreed with the warehouse. Microsoft Learn

Test checklist

  1. No sent outbound item is older than the days to keep.
  2. Items with status Ready are still in the queue.

Source: Microsoft Learn

Functional consultant

4Setup decisions

Setup stepRecommended value and whyDecision, common mistake and test
Clean up the outbound queueRecurring batch job with a retention agreed with the warehouse (for example 30 days) and Delete all records = No.The queues keep every outbound event until they are cleaned up; deleted items can't be restored.How long is outbound queue history kept?Setting Delete all records = Yes in production: every outbound record goes, including events the material handling system hasn't read yet.Test: Cleanup keeps recent and Ready items

Feature management and licence

Licence or add-inThe Material handling equipment interface configuration key (System administration > Setup > License configuration > Trade > Warehouse and Transportation management) must be on; it is turned on in maintenance mode. No Feature management feature is needed. In this system 1 role can open this page, among them Material handling manager.

Microsoft Learn

Solution architect

5Design impact

Shared or per companyPer company: the job cleans the outbound queue of the current company. Checked in Dynamics 365
Can it be undoneNo: Deleted outbound items can't be restored, and the material handling system can't retrieve them any more. Microsoft Learn
If you change it laterDeletes sent outbound queue items, or every outbound record when Delete all records is Yes. Microsoft Learn
Technical architect

6Technical

Menu itemWMHEOutboundQueueCleanup Checked in Dynamics 365
FormSysOperationTemplateForm Checked in Dynamics 365
Roles to set it up and use itTo use itMaterial handling manager WMHEMaterialHandlingManagerGive people one of these roles. On this system, 1 role can run this page.Checked in Dynamics 365
Developer

7Developer

Open it by URLhttps://<your-environment>/?mi=WMHEOutboundQueueCleanup
Data migrationLoad order: The Outbound queue cleanup job has no data entity in Data management, so it can't be loaded from a file or a configuration template. It only deletes outbound queue records; there is nothing to load.Checked in Dynamics 365
Everyone

8Sources