mirror of
https://github.com/microsoft/BCQuality.git
synced 2026-08-07 18:06:53 +01:00
Add 12 atomic knowledge articles under microsoft/knowledge/events covering general AL event-design best practices: IsHandled initialization and OnAfter preservation, appending new event parameters, position-based event naming, reusing/extending events, avoiding per-iteration publishing, Temp-prefixing temporary record parameters, unabbreviated parameter names, preferring the this keyword over IncludeSender, avoiding loosely typed parameters, not mutating existing event contracts, and not bypassing critical operations with IsHandled. Each article ships a .good.al and .bad.al demonstration sample (object IDs 50240-50296; not compiled by CI). Extend the al-events-review leaf Worklist with one targeted check per new rule. Additive only; no contract or wiring change (events leaf already wired). Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
30 lines
1.1 KiB
AL
30 lines
1.1 KiB
AL
// Demonstration-only AL. Not compiled by CI; illustrates the article.
|
|
codeunit 50296 "Critical Op Bad Sample"
|
|
{
|
|
procedure PostInvoice(var SalesHeader: Record "Sales Header")
|
|
var
|
|
IsHandled: Boolean;
|
|
begin
|
|
// Anti-pattern: IsHandled wraps the entire posting. A subscriber can set
|
|
// IsHandled := true and silently skip ledger-entry creation and the
|
|
// status update, leaving imbalanced ledgers and orphaned documents.
|
|
IsHandled := false;
|
|
OnBeforePostInvoice(SalesHeader, IsHandled);
|
|
if IsHandled then
|
|
exit;
|
|
|
|
CreateCustomerLedgerEntry(SalesHeader);
|
|
SalesHeader.Status := SalesHeader.Status::Released;
|
|
SalesHeader.Modify(true);
|
|
end;
|
|
|
|
local procedure CreateCustomerLedgerEntry(var SalesHeader: Record "Sales Header")
|
|
begin
|
|
// Posts the customer ledger entry (critical; must never be skipped).
|
|
end;
|
|
|
|
[IntegrationEvent(false, false)]
|
|
local procedure OnBeforePostInvoice(var SalesHeader: Record "Sales Header"; var IsHandled: Boolean)
|
|
begin
|
|
end;
|
|
}
|