mirror of
https://github.com/microsoft/BCQuality.git
synced 2026-10-05 22:56:55 +01:00
Some checks failed
Validate knowledge index / validate-index (push) Has been cancelled
Validate AL review fixtures / validate-review-fixtures (push) Has been cancelled
Validate skill index and report schemas / validate-contract (push) Has been cancelled
Validate frontmatter and structure / validate (push) Has been cancelled
* Add 5 AL/BC patterns: document distribution (Report Selections, Document Sending Profile, Find Entries, TransferFields) Five rules about Business Central's document distribution architecture, verified against BCApps source and Microsoft Learn. - custom-document-dispatch-must-not-bypass-report-selections - document-print-and-email-actions-call-report-selections-directly - extend-find-entries-navigate-for-new-document-types - extend-report-selection-usage-for-new-document-types - transferfields-mirrored-fields-must-match-type-and-length Wired into al-data-modeling-review.md's worklist cues. Added a disambiguation note on the TransferFields article distinguishing it from the existing transferfields-skip-type-mismatch-can-drop-data.md (type-mismatch skipping vs. length mismatch, which SkipFieldsNotMatchingType does not affect). Co-Authored-By: Claude Sonnet 5 <noreply@anthropic.com> * Fix four merge-critical blockers from Jesper's review; add 4 more patterns Addresses microsoft/BCQuality#175 review feedback: - Extend al-data-modeling-review's entry gate/relevance scope and token list to recognize document actions, Navigate subscribers, Report Selection registration, price-calculation/price-source extensibility, TransferFields posting-cascade mirroring, and barcode font-provider usage - previously excluded before any worklist cue could run. - Fix document-print-and-email-actions-call-report-selections-directly: permit the legitimate stateless DocumentSendingProfile.TrySendToPrinter/ TrySendToEMail path; rework the bad fixture to load a configured profile instead of demonstrating a trivial blank-record no-op. - Fix extend-report-selection-usage-for-new-document-types: scope to the applicable single counterparty (ReportSelectionHandlerCZZ partitions strictly; only genuinely two-sided usages like Compensation need both), and add the page-facing usage-enum map/validate events alongside the filter-event subscription for full Document Layouts support. - Fix a stale field-citation in custom-document-dispatch-must-not-bypass- report-selections (Custom Report Layout Code is field 7, not part of the 19-26 email-configuration range). - Add deterministic positive/clean evaluation coverage (review-fixtures.json additionalArticles + Test-ReviewFixtures.ps1 support) so all 9 new good/bad pairs are actually exercised, not just present. - Add 4 new patterns: activate-new-price-calculation-handler-via- onfindsupportedsetup, extend-price-source-type-must-sync-document- subset-enum, new-price-source-must-add-candidate-and-trigger- recalculation, report-barcodes-must-use-barcode-module-and-production- font-name. All claims verified against live microsoft/BCApps source and Microsoft Learn. Validators: frontmatter 0/0, review-fixtures 52 cases/17 domains PASSED, knowledge-index 309 articles PASSED. Co-Authored-By: Claude Sonnet 5 <noreply@anthropic.com> * Fix 5 merge-critical issues from Jesper's 2026-09-24 review round - activate-new-price-calculation-handler-via-onfindsupportedsetup: Default := true is required only for the fallback branch of PriceCalculationMgt's two-stage FindSetup - a handler reachable via a specific Dtld. Price Calculation Setup row needs no Default. Softened the article and its worklist cue accordingly. Also fixed an undefined "Sample Price Calc - Special" codeunit referenced but never declared in the eval fixtures - added a real implementation of interface "Price Calculation" with stub methods. - new-price-source-must-add-candidate-and-trigger-recalculation: the good fixture called UpdateUnitPriceByField directly, which is a silent no-op without a prior PlanPriceCalcByField call (FieldCausedPriceCalculation gating, verified against SalesLine.Table.al). Switched to the public UpdateUnitPrice wrapper, matching real BCApps usage in ItemReferenceManagement.Codeunit.al. - report-barcodes-must-use-barcode-module-and-production-font-name: split the 1D (ValidateInput + EncodeFont) and 2D (EncodeFont only) Barcode Font Provider interfaces, which the article previously conflated. Reframed the Code 39 anti-pattern around demonstrable encoding/checksum mismatch (verified against IDA1DCode39Encoder.Codeunit.al's real '(value)' output) rather than rejecting all manual delimiter use, since '*' is a legitimate Code 39 start/stop character. Also fixed extend-find-entries-navigate- for-new-document-types' eval fixtures, which referenced an undefined "Sample Posted Document Header" table/page - declared both. All claims re-verified against live microsoft/BCApps source. Validators: frontmatter 0/0, review-fixtures 126/20 domains PASSED, knowledge-index 342/575 PASSED, skill-index 19 leaves PASSED. Co-Authored-By: Claude Sonnet 5 <noreply@anthropic.com> * Align price-source and barcode routing cues with corrected articles - Price-source cue now accepts UpdateUnitPrice, or the explicit PlanPriceCalcByField + UpdateUnitPriceByField sequence; bare UpdateUnitPriceByField does not count. Both APIs added to tokens. - Barcode cue no longer flags manual delimiters as a category; routes only demonstrably invalid/provider-font-mismatched hand encoding, and requires ValidateInput + EncodeFont for 1D, EncodeFont only for 2D. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com> * Make barcode bad fixture self-contained: 1D EncodeFont without ValidateInput The previous bad fixture (literal '*' delimiters, no layout/font/provider evidence) no longer matched the narrowed routing cue. It now shows an IDAutomation 1D provider path that calls EncodeFont without ValidateInput, which is visible in AL alone. Article Anti Pattern and Source updated to describe this variant (verified: IDAutomation 1D Provider's EncodeFont does not call IsValidInput). Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com> * Fix three merge-critical items from Jesper's 2026-09-29 review - Barcode: drop the false claim that '*value*' is mismatched with the IDAutomation Code 39 font; '*' is a documented start/stop form and '(' / ')' an accepted alternative. Cue and article now route only independently provable validation/checksum/font-binding defects. - Dispatch good samples (and matching bad samples) now pass a Sales Invoice Header with the S.Invoice usage, matching the record the selected report (1306 "Standard Sales - Invoice") expects. - custom-document-dispatch rule made disjunctive: a hardcoded report or a hand-built email is each a bypass on its own; scoped to customer/vendor-facing documents. Bad fixture shows the hardcoded report alone. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com> * Clarify TrySendToEMail comment in print/email good sample Make explicit that TrySendToEMail is also correct *because* it never reads the customer's assigned profile (local record, E-Mail option set by the helper itself), and name Get/GetDefaultForCustomer + Send as the anti-pattern. Matches the article's Best Practice and BaseApp's own Sales Invoice Header.EmailRecords. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com> --------- Co-authored-by: Claude Sonnet 5 <noreply@anthropic.com>
97 lines
5.3 KiB
Markdown
97 lines
5.3 KiB
Markdown
---
|
|
bc-version: [all]
|
|
domain: data-modeling
|
|
keywords: [price-calculation, price-source, onafteraddsources, recalculation, pricing]
|
|
technologies: [al]
|
|
countries: [w1]
|
|
application-area: [all]
|
|
---
|
|
|
|
# A new price source needs both a calculation candidate and a recalculation trigger
|
|
|
|
## Description
|
|
|
|
Making a custom field usable as a price source on a sales line is two
|
|
separate, independent pieces of wiring, and doing only one produces a
|
|
line that looks like it's using the new source without ever actually
|
|
being priced by it. `codeunit "Sales Line - Price"` publishes
|
|
`OnAfterAddSources(SalesHeader: Record "Sales Header"; SalesLine: Record
|
|
"Sales Line"; PriceType: Enum "Price Type"; var PriceSourceList: Codeunit
|
|
"Price Source List")` — subscribing here and calling
|
|
`PriceSourceList.Add(SourceType, SourceNo)` makes the source a candidate
|
|
the calculation considers. But nothing about that subscription causes
|
|
the price to be *recalculated* when the source field's value changes on
|
|
an existing line. That's the second, separate piece, and it needs to be
|
|
wired correctly: `Sales Line`'s `procedure
|
|
UpdateUnitPriceByField(CalledByFieldNo: Integer)` only recalculates if
|
|
the field was already *planned* — internally it exits immediately unless
|
|
`procedure PlanPriceCalcByField(CurrPriceFieldNo: Integer)` was already
|
|
called for that same field number. Calling `UpdateUnitPriceByField` on
|
|
its own, without a matching `PlanPriceCalcByField` call first, compiles
|
|
fine and looks correct, but silently recalculates nothing. `Sales Line`
|
|
also exposes `procedure UpdateUnitPrice(CalledByFieldNo: Integer)`, a
|
|
convenience wrapper that does both steps in the right order (plan, then
|
|
update) in one call — this is the method the base app itself calls from
|
|
*outside* `Sales Line` to trigger recalculation for a field it just
|
|
changed (see `Inventory/Item/Catalog/ItemReferenceManagement.Codeunit.al`:
|
|
`SalesLine.UpdateUnitPrice(SalesLine.FieldNo("Item Reference No."))`), and
|
|
it's what a custom price source field's own trigger should call too — the
|
|
same way Microsoft's own Location example is wired from a `Sales Line`
|
|
validation event, not from the price source registration itself.
|
|
|
|
Add the source without wiring recalculation, and the failure hides
|
|
easily: a *new* line still prices correctly, because the field already
|
|
holds its value when calculation first runs on insert. The gap only
|
|
shows up when someone *changes* the source field's value on an existing
|
|
line — the price silently keeps its old value until something unrelated
|
|
happens to trigger recalculation.
|
|
|
|
## Best Practice
|
|
|
|
Wire both halves together whenever a field becomes a price source: an
|
|
`OnAfterAddSources` subscriber that adds it via `PriceSourceList.Add`, and
|
|
a trigger on the field itself (its own `OnValidate`, or a matching
|
|
`OnAfterValidate` integration event) that calls
|
|
`SalesLine.UpdateUnitPrice(SalesLine.FieldNo(<TheField>))`. Calling
|
|
`UpdateUnitPriceByField` directly, without first calling
|
|
`PlanPriceCalcByField` for that same field number, is *not* equivalent —
|
|
it exits immediately and recalculates nothing. `UpdateUnitPrice` does
|
|
both calls, in the correct order, in one step.
|
|
|
|
See sample: [`new-price-source-must-add-candidate-and-trigger-recalculation.good.al`](new-price-source-must-add-candidate-and-trigger-recalculation.good.al).
|
|
|
|
## Anti Pattern
|
|
|
|
Subscribing to `OnAfterAddSources` to register a custom field as a price
|
|
source, without also triggering recalculation (via `UpdateUnitPrice`, or
|
|
the `PlanPriceCalcByField` + `UpdateUnitPriceByField` pair) from that
|
|
field's own validation. The field is a genuine, working calculation
|
|
candidate — new lines price correctly — but editing the field on an
|
|
existing line leaves the unit price stale, with nothing to indicate why.
|
|
|
|
See sample: [`new-price-source-must-add-candidate-and-trigger-recalculation.bad.al`](new-price-source-must-add-candidate-and-trigger-recalculation.bad.al).
|
|
|
|
## Source
|
|
|
|
BCApps (`src/Layers/W1/BaseApp/`): `Sales/Pricing/SalesLinePrice.Codeunit.al`
|
|
(`local procedure OnAfterAddSources(SalesHeader: Record "Sales Header";
|
|
SalesLine: Record "Sales Line"; PriceType: Enum "Price Type"; var
|
|
PriceSourceList: Codeunit "Price Source List")`); `Pricing/Source/PriceSourceList.Codeunit.al`
|
|
(`procedure Add(SourceType: Enum "Price Source Type"; SourceNo: Code[20])`);
|
|
`Sales/Document/SalesLine.Table.al` (`procedure
|
|
PlanPriceCalcByField(CurrPriceFieldNo: Integer)`; `procedure
|
|
UpdateUnitPrice(CalledByFieldNo: Integer)`; `procedure
|
|
UpdateUnitPriceByField(CalledByFieldNo: Integer)`, which exits immediately
|
|
unless `FieldCausedPriceCalculation` already equals `CalledByFieldNo` —
|
|
the state `PlanPriceCalcByField` sets). External, idiomatic use of the
|
|
one-call form: `Inventory/Item/Catalog/ItemReferenceManagement.Codeunit.al`
|
|
(`SalesLine.UpdateUnitPrice(SalesLine.FieldNo("Item Reference No."))`).
|
|
|
|
Microsoft Learn, "Extending Price Calculations" (Location example): "To
|
|
recalculate the price, we can subscribe to events that pass the sales
|
|
line by reference... We'll call the UpdateUnitPriceByLocationCode()
|
|
method, which is a simplified version of the UpdateUnitPriceByField()
|
|
method... To add the location in the source list for price calculations,
|
|
we'll subscribe to the OnAfterAddSources event of Codeunit 'Sales Line -
|
|
Price,' and add the Location Code as a source."
|
|
(https://learn.microsoft.com/dynamics365/business-central/dev-itpro/developer/devenv-extending-best-price-calculations)
|