How-to: Sorting of Orders

Description

Examples of sorting Order list.

Flow of events

Sorting on Existing fields

Use OnAfterSetCurrentKey-events.

• Change sorting key

  • Use .SetCurrentKey(field)-function with any of the existing fields from the Header table (Record parameter on this event).
    
    
    

• Change sorting direction

  • Use .Ascending(true/false)-function. 
  
  
  
• Use these events:
  
  • Page:
    OnGetPhysInvtRecordingLines_OnAfterSetCurrentKey
  • Page:
    OnGetAssemblyOrderLines_OnAfterSetCurrentKey
  • Page:
    OnGetMoveOrderLines_OnAfterSetCurrentKey
  • Page:
    OnGetShipOrderLines_OnAfterSetCurrentKey
  • Page:
    OnGetCountOrderLines_OnAfterSetCurrentKey
  • Page:
    OnGetPickOrderLines_OnAfterSetCurrentKey
  • Page:
    OnGetPutAwayOrderLines_OnAfterSetCurrentKey
  • Page:
    OnGetReceiveOrderLines_OnAfterSetCurrentKey
  
  
  

Sorting on Custom fields

Use.OnAfterSetFrom-events.

• Change sorting key 

  • Use Set_Sorting1()-function.
    
    • Page:
      OnGetPhysInvtRecordingLines_OnAfterSetFromPhysInvtRecordLine
    • Page:
      OnGetAssemblyOrderLines_OnAfterSetFromAssemblyLine
    • Page:
      OnGetAssemblyOrderLines_OnAfterSetFromAssemblyHeader
    • Page:
      OnGetProdOrderLines_OnAfterSetFromProdOrderLine
    • Page:
      OnGetMoveOrderLines_OnAfterSetFromWarehouseActivityLine
    • Page:
      OnGetShipOrderLines_OnAfterSetFromWarehouseShipmentLine
    • Page:
      OnGetCountOrderLines_OnAfterSetFromItemJournalLine
    • Page:
      OnGetCountOrderLines_OnAfterSetFromAnyLine
    • Page:
      OnGetCountOrderLines_OnAfterSetFromWarehouseJournalLine
    • Page:
      OnGetPickOrderLines_OnAfterSetFromAnyLine
    • Page:
      OnGetPickOrderLines_OnAfterSetFromTransferLine
    • Page:
      OnGetPickOrderLines_OnAfterSetFromSalesLine
    • Page:
      OnGetPickOrderLines_OnAfterSetFromPurchaseReturnLine
    • Page:
      OnGetPickOrderLines_OnAfterSetFromWarehouseActivityLine
    • Page:
      OnGetPutAwayOrderLines_OnAfterSetFromWarehouseActivityLine
    
    
    
    

• Change sorting direction

  • This is done in two steps:
  1. Use OnAfterSetFrom[ and the Set_Sorting1()-function.
  2. Use OnAfterSetCurrentKey and the .Ascending()-function.

Helper Functions

The event parameter "_BaseOrderLineElementView" includes five sorting functions you can use to sort on up to four new custom fields .

Sorting on multiple document sources

All except "Ship" have multiple document sources.

I.e. the default sorting for Receive orders list at the mobile device is:

• First, Warehouse Receipts
• Then Purchase Orders
• Then Transfer Orders
• Then Sales Return Orders

... so essentially "grouping" orders by the four document sources that can all be in the same list (with each "group" being internally ordered by document numbers).

When working with custom sorting, you will need to consider whether orders should still be "grouped" or can now be mixed across the four document sources.

Example: Existing fields

• Change key to existing field "Item no."
• Change sorting direction to "Descending"

For this task, you must use the OnAfterSetCurrentKey event.

[EventSubscriber(ObjectType::Codeunit, Codeunit::"MOB WMS Receive", 'OnGetReceiveOrders_OnAfterSetCurrentKey', '', true, true)]
procedure OnGetReceiveOrders_OnAfterSetCurrentKey(var _BaseOrderElementView: Record "MOB Ns BaseDataModel Element")
begin
     _BaseOrderElementView.SetCurrentKey(BackendID);
     _BaseOrderElementView.Ascending(true);
end;

Example: Custom fields

• Sort lines by you own custom field

For this task you must use the OnAfterSetFrom.

[EventSubscriber(ObjectType::Codeunit, Codeunit::"MOB WMS Receive", 'OnGetReceiveOrderLines_OnAfterSetFromAnyLine', '', true, true)]
procedure OnGetReceiveOrderLines_OnAfterSetFromAnyLine(_RecRef: RecordRef; var _BaseOrderLineElement: Record "MOB Ns BaseDataModel Element")
var
     Item: Record Item;
begin
     with _LineElement do begin
          // New custom tag
          Item.Get(Get_ItemNumber());
          SetValue('SpecialEquimentCode', Item."Special Equipment Code");

          // Sort by custom tag
          Set_Sorting1(GetValue('SpecialEquimentCode'));
     end;
end;