Skip to content

knowledge: improve review precision from BCApps PR 10312 feedback #168

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Draft
Wenjie Fan (gggdttt) wants to merge 1 commit into
base: main
Choose a base branch
from
Draft

knowledge: improve review precision from BCApps PR 10312 feedback #168

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 5 additions & 0 deletions microsoft/knowledge/style/label-locked-for-non-translatable.good.al
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,4 +5,9 @@ codeunit 50204 "Sample Locked Label Good"
ContentTypeJsonTok: Label 'application/json', Locked = true;
ApiBaseUrlTok: Label 'https://api.contoso.com/v1', Locked = true;
TelemetryStartTxt: Label 'Operation started for %1.', Locked = true;
// Seeded VAT Bus. Posting Group default code: intentionally NOT locked.
// Each localization layer ships its own translated code and creates the
// matching master-data record with that same translated code, so
// translating this Label does not break the lookup.
XDomesticTxt: Label 'DOMESTIC';
}
4 changes: 4 additions & 0 deletions microsoft/knowledge/style/label-locked-for-non-translatable.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24,3 +24,7 @@ See sample: `label-locked-for-non-translatable.good.al`.
`HttpsUrl: Label 'https://example.com';` or `ContentTypeTok: Label 'application/json';` declared without `Locked = true`. The translator localizes them, the integration fails in production for the affected tenant, and the failure is invisible in the developer's English-locale tests.

See sample: `label-locked-for-non-translatable.bad.al`.

## Exception: seeded master-data codes (e.g. posting group codes)

Do not flag a Label as needing `Locked = true` just because its value is later written into a `Code` field with a `TableRelation`, such as `Default VAT Bus. Posting Group`, `Gen. Bus. Posting Group`, or a dimension code. Across the codebase (see `DemoTool` install/upgrade codeunits per country layer), seed values like `DOMESTIC` are declared as ordinary translatable Labels on purpose: each localization layer/company ships its own translated code, and the matching master-data record (e.g. the `VAT Business Posting Group`) is created with that same translated code in the same locale. Because creation and lookup happen together in the same tenant language, translating the code does not break referential integrity. Locking such a Label would instead diverge it from the localized master data it is meant to match. Only require `Locked = true` when the string crosses a locale boundary on its own (URLs, HTTP verbs, JSON/XML/API contract literals, GUIDs) — not for domestic seed/default codes that are created and consumed within the same tenant.