Microsoft/bcquality
1
0
Fork 0
mirror of https://github.com/microsoft/BCQuality.git synced 2026-08-06 17:36:53 +01:00
Code Issues Projects Releases Packages Wiki Activity Actions
bcquality/custom/knowledge/architecture/cmfrt-buffer-table-api-pattern.md
BeytullahCengiz88 afb1fa2883 Add CMFRT naming conventions, object ID ranges, and patterns documentation 
- Introduced guidelines for using the "CMFRT" prefix in object names, fields, and procedures to avoid naming collisions and ensure clarity.
- Established rules for object ID ranges to prevent conflicts with other extensions and maintain historical integrity.
- Documented best practices and anti-patterns for various coding patterns, including case statements, interface injection, label usage, and validation methods.
- Implemented a standards review skill to evaluate AL source changes against CMFRT company standards, ensuring compliance with naming, permissions, and architectural patterns.
2026-07-14 14:09:04 +02:00

1.9 KiB
Raw Blame History

bc-version domain keywords technologies countries application-area
all
architecture
api
buffer
staging
oninsertrecord
api-page
inbound
creator
proc
codeunit-run
al
w1
all

CMFRT inbound API pages write to buffer tables

Description

Inbound CMFRT API pages never source from real application tables. Each API page sources from a dedicated buffer (staging) table owned by the extension. The buffer row records the raw inbound payload plus a status field (Pending/Processing/Processed/Error) and an operation enum where applicable. A Proc codeunit picks up pending buffer rows and owns the Codeunit.Run error boundary; a Creator codeunit transfers buffer values into the real table via Validate calls. The API page's OnInsertRecord trigger contains no manual insert plumbing — the framework performs the default insert; the trigger only performs side effects such as request logging.

Best Practice

For each inbound API: one buffer table (with status and error-message fields), one API page sourced from the buffer, one Proc codeunit that iterates pending rows and calls the Creator inside a Codeunit.Run boundary so one failing row does not abort the batch, and one Creator codeunit that fills and inserts the real record. OnInsertRecord bodies contain only logging or metadata capture and no exit statement, so the framework insert proceeds.

See sample: cmfrt-buffer-table-api-pattern.good.al.

Anti Pattern

An API page sourced directly from a real table (Sales Header, Job, Ship-to Address), or an OnInsertRecord trigger that calls Rec.Insert(true) followed by exit(false) to suppress the framework insert. Direct-to-real-table APIs make inbound failures atomic with the HTTP request (no retry, no error queue), and the manual insert/exit boilerplate duplicates framework behaviour while hiding the insert from other trigger logic.

See sample: cmfrt-buffer-table-api-pattern.bad.al.