e570d6113f
Adds 55 articles (plus 76 code samples) spanning four new domains and two existing domains, extracted from the internal Business Central review-agent prompt. Content was filtered against BCQuality's remedial-knowledge premise: each article encodes BC-specific behaviour, a CodeCop rule, a platform API semantic, or an anti-false-positive guideline that a capable LLM would otherwise get wrong. New domains: - privacy (11 articles): DataClassification inheritance semantics, the StrSubstNo-defeats-Error-telemetry-classification pitfall, Privacy Notice consent for outgoing requests, anti-false-positives for pages and in-memory data. - upgrade (11 articles): upgrade-codeunit structure, upgrade-tag lifecycle and registration, protected DB reads, DataTransfer for large datasets, InitValue semantics, enum-ordinal preservation, obsolete-workflow, first-install detection. - ui (9 articles): caption capitalization by phrase type, tooltip voice, teaching-tip vs tooltip, tour-tip conventions, character limits, banned terms, ampersand handling, title punctuation. - style (11 articles): label-suffix convention, API page naming, temporary-variable prefix, label properties (Comment/Locked), named invocations, FieldCaption in user messages, OptionCaption pairing, Error-parameter passing, `this` keyword, required parentheses, file naming. Gaps in existing domains: - performance (11 articles): production-scale table catalog (no row counts, per internal-data concern), anti-false-positive for bounded tables, guard-before-Get ordering, redundant-Get-in-OnAfterGetRecord, LockTable in read-only helpers, combined ModifyAll passes, writes in OnAfterGetRecord, SetLoadFields heuristics, temporary-table regressions, FlowField source-table widening, MaintainSQLIndex disabling SIFT. - security (2 articles): environment-specific hardcoded GUIDs, ValidateTableRelation=false on user input. Intentionally excluded: specific production P95 row-count numbers (aggregated internal telemetry); rewritten as categorical guidance on which tables to treat as production-scale without publishing sizes. All articles use `bc-version: [all]` (applies to every BC version, per the new schema sentinel). Validator passes with 0 errors / 0 warnings.
1.7 KiB
| bc-version | domain | keywords | technologies | countries | application-area | |||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
|
style |
|
|
|
|
Pass Error parameters directly to the Label; do not pre-build with StrSubstNo or concatenation
Description
Error accepts a Label and its substitution parameters directly (Error(CustomerNotFoundErr, CustomerNo, DocumentNo)). Pre-building the message via StrSubstNo and passing the resulting Text, or concatenating parts with + and passing the result, compiles but produces two distinct regressions. The localization pipeline can only translate the Label; a pre-built Text is passed through untouched, so non-English users see the English template. Platform telemetry inspects the Label's placeholder arguments for DataClassification; a pre-built Text is opaque, so PII in the arguments is logged verbatim (see strsubstno-prebuild-breaks-error-telemetry-classification in the privacy domain).
Best Practice
Declare the Label with placeholders and pass arguments directly to Error: Error(CustomerNotFoundErr, CustomerNo, DocumentNo). Use Comment on the Label to document each placeholder (see include-comment-on-labels-with-placeholders). Error('') is acceptable when the caller is responsible for the surfaced error.
See sample: pass-parameters-directly-to-error-no-strsubstno.good.al.
Anti Pattern
Error(StrSubstNo(CustomerNotFoundErr, CustomerNo)) — loses translation. Error(CustomerNotFoundErr + ': ' + CustomerNo) — loses translation, concatenates hard-coded delimiters. Error('Customer ' + CustomerNo + ' not found') — uses no Label at all.
See sample: pass-parameters-directly-to-error-no-strsubstno.bad.al.