mirror of https://github.com/microsoft/BCQuality.git synced 2026-08-06 09:26:52 +01:00

Michael Dieringer 288f64df16 Add BCApps citations to Tier 1+2 knowledge files; add 2 new rules

- All 7 existing Tier 1/2 knowledge files now include a BCApps Reference
  section with concrete source links and observed patterns
- New: bcpt-scenarios-must-be-app-specific — PerformanceTest apps must
  include app-domain BCPT scenarios, not only Microsoft generic samples
- New: permission-sets-must-follow-least-privilege — View/Edit/Admin
  hierarchy with IncludedPermissionSets, mirroring BCApps BusFound pattern
- api-page-key-fields-must-be-editable-on-insert clarified: SystemId as
  ODataKeyField + Editable=false is valid (auto-generated); rule applies
  to consumer-provided key fields only

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>

2026-06-23 17:48:37 +02:00

1.9 KiB

Raw Blame History

CURABIS MCP: FlowFields on API Pages Rule Summary

The Rule

FlowFields on API pages must be explicitly calculated via CalcFields() in the OnAfterGetRecord trigger, or they return empty values in OData responses.

Key Points

Why it matters: "FlowFields are not stored in the database. Business Central only calculates them on demand." Regular pages auto-calculate during rendering, but API pages don't—external consumers receive raw empty values otherwise.

What to do: Every FlowField exposed in an API page's layout section requires inclusion in a CalcFields() call within OnAfterGetRecord. Multiple fields can be combined in one call.

What doesn't need it: Stored (non-FlowField) fields require no CalcFields processing.

Implementation Pattern

The provided example demonstrates proper implementation:

trigger OnAfterGetRecord()
begin
    Rec.CalcFields("Elapsed time (Chargeable)", "Customer Name");
end;

Verification Approach

Audit API pages by:

Identifying every field bound to FlowField sources in the layout
Confirming each appears in the OnAfterGetRecord CalcFields statement
Flagging any missing FlowField as a defect (silent empty return to consumers)

This rule prevents data gaps in API integrations caused by overlooked calculation requirements.

BCApps Reference

BCApps API pages implement CalcFields() in OnAfterGetRecord for all FlowField-sourced fields. The BCPT Suite API page demonstrates the correct pattern for API pages with computed data.

Source: https://github.com/microsoft/BCApps/blob/main/src/Tools/Performance%20Toolkit/App/src/BCPTSuiteAPI.Page.al
Additional API pages: https://github.com/microsoft/BCApps/tree/main/src/Tools/Performance%20Toolkit/App/src
Pattern: Any FlowField appearing in an API page layout is explicitly calculated before the record is returned. Microsoft does not rely on implicit calculation in API contexts.

1.9 KiB Raw Blame History