Page Comparison

Description

This information applies to all 

...

Flow of events

Sorting on Existing fields

Use Planned functions.

There are two events for sorting orders:

1. Using OnAfterSetCurrentKey-events

...

Change sorting key

...

Change sorting direction

• Use .Ascending(true/false)-function. 

...

Sorting on Custom fields

Use.OnAfterSetFrom-events.

Change sorting key 

...

...

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 must consider.

Should the filter be applied across all document types?

• Yes: Use the generic "Any"-event
• No: Use the document-specific event(s)

Sorting on Existing fields ("OnAfterSetCurrentKey"-events)

Example 1

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

[EventSubscriber(ObjectType::Codeunit, Codeunit::"MOB WMS Put Away", 'OnGetPutAwayOrderLines_OnAfterSetCurrentKey', '', true, true)]
procedure OnGetPutAwayOrderLines_OnAfterSetCurrentKey(var _BaseOrderLineElementView: Record "MOB Ns BaseDataModel Element")
begin
     _BaseOrderLineElementView.SetCurrentKey(ItemNumber);
     _BaseOrderLineElementView.Ascending(false);
end;

Example 2

...

1. 
   
   • Set Sorting Direction
   • Set Sorting Key Fields (Standard fields only)
     
     
2. Using OnAfterSetFrom-events
   
   • Set Sorting Key Fields (Custom fields)

1: 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. 
    

    Filter by label (Content by label)
    showLabels false showSpace false cql label = "bc" and label = "onaftersetcurrentkey" and label = "integrationevent" and label = "orders"

    
    
    

2: Sorting on custom fields

Use.OnAfterSetFrom-events.

• Change sorting key 

  • Use Set_Sorting1()-function.
    

    Filter by label (Content by label)
    showLabels false showSpace false cql label = "bc" and label = "orders" and label = "onaftersetfrom" and label = "integrationevent"

    
    
    

• Change sorting direction

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

Affect all sources by using "Any"-events

If you work across locations you might also want to filter across all of them

For example, the sorting for Receive orders list is:

1. Warehouse Receipts
2. Purchase Orders
3. Transfer Orders
4. Sales Return Orders

All four document sources can be in the same list (with each internally ordered by document numbers)

If you filter across all document types, then use the "Any"-event, else use the document-specific event(s)

Sorting on Existing fields ("OnAfterSetCurrentKey"-events)

Example 1

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

[EventSubscriber(ObjectType::Codeunit, Codeunit::"MOB WMS ReceivePut Away", 'OnGetReceiveOrdersOnGetPutAwayOrderLines_OnAfterSetCurrentKey', '', true, true)]
procedure OnGetReceiveOrders OnGetPutAwayOrderLines_OnAfterSetCurrentKey(var _BaseOrderElementViewBaseOrderLineElementView: Record "MOB Ns BaseDataModel Element")
begin
     _BaseOrderElementView.SetCurrentKey(BackendID);
     _BaseOrderElementView.Ascending(true);
end;

Sorting on Custom fields ("OnAfterSetFrom"-events)

Note. For this task: you must both:

...

)
begin
     _BaseOrderLineElementView.SetCurrentKey(ItemNumber);
     _BaseOrderLineElementView.Ascending(false);
end;

Example 2

• Change key to existing field "Order No."

[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;

Sorting on Custom fields ("OnAfterSetFrom"-events)

Note. For this task: you must both:

1. Set the value
2. Enable sorting on it

Example 1: 

Sort all picks by "Assigned User ID"

• Sort on "Assigned User ID'" from the source RecordRef
• For this "AnyEvent" the RecordRef can be "Warehouse Activity Header", "Sales Header", "Purchase Header" or "Transfer Header" depending on what documents are available to pick

    [EventSubscriber(ObjectType::Codeunit, Codeunit::"MOB WMS Pick", 'OnGetPickOrders_OnAfterSetFromAnyHeader', '', true, true)]
    local procedure MySortByCustomTag_OnGetPickOrders_OnAfterSetFromAnyHeader(_RecRef: RecordRef; var _BaseOrderElement: Record "MOB Ns BaseDataModel Element")
    var
        DataTypeManagement: Codeunit "Data Type Management";
        NewFieldRef: FieldRef;
    begin
        if DataTypeManagement.FindFieldByName(_RecRef, NewFieldRef, 'Assigned User ID') then
            _BaseOrderElement.SetValue('AssignedUserID', 'Assigned to: ' + CopyStr(NewFieldRef.Value(), 1, NewFieldRef.Length()));

        _BaseOrderElement.Set_Sorting1(_BaseOrderElement.GetValue('AssignedUserID'));
    end;

Example 2:

Sort only Warehouse Picks by "Assigned User ID"

...

    [EventSubscriber(ObjectType::Codeunit, Codeunit::"MOB WMS Pick", 'OnGetPickOrders_OnAfterSetFromWarehouseActivityHeader', '', true, true)]
    local procedure My02GetPickOrders_OnAfterSetFromWarehouseActivityHeader(_WhseActHeader: Record "Warehouse Activity Header"; var _BaseOrderElement: Record "MOB Ns BaseDataModel Element")
    begin
        _BaseOrderElement.SetValue('AssignedUserID', 'Assigned to: ' + _WhseActHeader."Assigned User ID");
        _BaseOrderElement.Set_Sorting1(_BaseOrderElement.GetValue('AssignedUserID'));
    end;