Use this event to
Handle custom Unplanned Functions business logic.
This event is triggered when
- Header has been accepted
- Steps has been collected
The request is provided as input tables and be accessed/iterated.
Including :
- Header Fields values
- Collected Steps values
- Current Registrations
(if your Unplanned is called from a Planned Functions e.g. Picked Order lines)
Supersedes OnPostAdhocRegistrationOnCustomRegistrationTypeAsXml
Template 01 - Subscribe only to mandatory parameters
// [Template] 01 - Subscribe only to mandatory parameters (excluded _CurrentRegistration, _SuccessMessage and _RegistrationTypeTracking)
[EventSubscriber(ObjectType::Codeunit, Codeunit::"MOB WMS Adhoc Registr.", 'OnPostAdhocRegistrationOnCustomRegistrationType', '', true, true)]
local procedure OnPostAdhocRegistrationOnCustomRegistrationType(_RegistrationType: Text; var _RequestValues: Record "MOB NS Request Element"; var _IsHandled: Boolean)
begin
if _RegistrationType = 'MyCustomRegistrationType' then begin // Replace constant 'MyCustomRegistrationType' with your own RegistrationType
if _IsHandled then
exit;
// Handle _RequestValues here
// ....
_IsHandled := true;
end;
end;
Template 02 - Subscribe to all parameters
// [Template] 02 - Subscribe to all parameters
[EventSubscriber(ObjectType::Codeunit, Codeunit::"MOB WMS Adhoc Registr.", 'OnPostAdhocRegistrationOnCustomRegistrationType', '', true, true)]
local procedure T02OnPostAdhocRegistrationOnCustomRegistrationType(_MessageId: Guid; _RegistrationType: Text; var _RequestValues: Record "MOB NS Request Element"; var _CurrentRegistrations: Record "MOB WMS Registration"; var _SuccessMessage: Text; var _RegistrationTypeTracking: Text; var _IsHandled: Boolean)
begin
if _RegistrationType = 'MyCustomRegistrationType' then begin // Replace constant 'MyCustomRegistrationType' with your own RegistrationType
if _IsHandled then
exit;
// Handle _RequestValues here
// ....
_SuccessMessage := 'My custom success message';
_RegistrationTypeTracking := 'My custom description for the document queue (column RegistationType';
_IsHandled := true;
end;
end;
Example (1) - Iteration of _RequestValues and _CurrentRegistrations
// [Example] 01 - Sample iteration of _RequestValues and _Currentegistrations
[EventSubscriber(ObjectType::Codeunit, Codeunit::"MOB WMS Adhoc Registr.", 'OnPostAdhocRegistrationOnCustomRegistrationType', '', true, true)]
local procedure Ex01OnPostAdhocRegistrationOnCustomRegistrationType(_RegistrationType: Text; var _RequestValues: Record "MOB NS Request Element"; var _CurrentRegistrations: Record "MOB WMS Registration"; var _IsHandled: Boolean)
begin
if _RegistrationType = 'MyCustomRegistrationType' then begin // Replace constant 'MyCustomRegistrationType' with your own RegistrationType
if _IsHandled then
exit;
// Sample iteration of requestData (excluding <Order>-element)
if _RequestValues.FindFirst() then
repeat
until _RequestValues.Next() = 0;
// Sample iteration of "current" registrations from <Order>-element (snapshot of unposted Registrations as they look right now when an adhoc registration is triggered)
// CurrentRegistration's is included only if attribute sendRegistrationData="Order"|"OrderLine" was used from application.cfg
if _CurrentRegistrations.FindFirst() then
repeat
until _CurrentRegistrations.Next() = 0;
_IsHandled := true;
end;
end;
Example (2) - Read values from _RequestValues (and, subscribing only to some parameters (excluded _CurrentRegistrations and _SuccessMessage)
// [Example] 02 - Read values from _RequestValues - and: subscribing only to some parameters (excluded _CurrentRegistrations and _SuccessMessage)
[EventSubscriber(ObjectType::Codeunit, Codeunit::"MOB WMS Adhoc Registr.", 'OnPostAdhocRegistrationOnCustomRegistrationType', '', true, true)]
local procedure Ex02OnPostAdhocRegistrationOnCustomRegistrationType(_RegistrationType: Text; var _RequestValues: Record "MOB NS Request Element"; var _RegistrationTypeTracking: Text; var _IsHandled: Boolean)
begin
if (_RegistrationType = 'MyCustomUnplannedProdConsumption') and (not _IsHandled) then begin
_RegistrationTypeTracking := PostUnplannedProdConsumption(_RequestValues);
_IsHandled := true;
// No SuccessMessage is returned -> default message is automatically added to the XmlResponse
end;
end;
local procedure PostUnplannedProdConsumption(var _RequestValues: Record "MOB NS Request Element") _RegistrationTypeTracking: Text
var
MobWmsToolbox: Codeunit "MOB WMS Toolbox";
ProdOrderNo: Code[20];
ProdOrderLineNo: Integer;
ItemNo: Code[20];
VariantCode: Code[20];
UnitOfMeasureCode: Code[10];
Qty: Decimal;
begin
// Parse values from Request
ProdOrderNo := _RequestValues.GetValue('ProdOrder').SubString(1, MaxStrLen(ProdOrderNo));
ProdOrderLineNo := MobWmsToolbox.Text2Int(_RequestValues.GetValue('ProdOrderLineNo'));
ItemNo := _RequestValues.GetValue('Item').Substring(1, MaxStrLen(ItemNo));
VariantCode := _RequestValues.GetValue('Variant', false).Substring(1, MaxStrLen(VariantCode)); // GetValue(.., false) = no error if not exists
UnitOfMeasureCode := _RequestValues.GetValue('UoM', false).Substring(1, MaxStrLen(UnitOfMeasureCode));
Qty := MobWmsToolbox.Text2Int(_RequestValues.GetValue('Qty'));
//
// Find the Prod. Order Line
//
// ... not implemented in this example
//
// Create Item Journal Line and post
//
// ... not implemented in this example
// Return information about this request/response to be displayed at the Mobile Document Queue
_RegistrationTypeTracking := StrSubstNo('%1 - %2 - %3', ProdOrderNo, ProdOrderLineNo, ItemNo);
end;
More examples
-
How-to: Add action to Order Line menu — Add a new Unplanned Function as action on Pick Lines.
-
How-to: Create custom Unplanned function in Main Menu — The most common control for customization
Add a new function to the Main menu. "Header fields" and optional "Steps" to collect
Version History
Version | Changes |
---|---|
MOB5.15 | Introduced |
MOB5.17 | New parameter _MessageId |