bcquality/community/knowledge/ui/factbox-design.md
Jeremy Vyska 4119417ce4
Some checks failed
Validate knowledge index / validate-index (push) Has been cancelled
Validate frontmatter and structure / validate (push) Has been cancelled
Add 15 community knowledge articles from BC Code Intel ingest (#66)
* Add 15 community knowledge articles from BC Code Intel ingest

Ingests net-new /community knowledge from BC Code Intelligence, surviving
the admission test, gray-zone salvage, and dedup against the full corpus.

Domains: ui (6), error-handling (3), performance (2), upgrade (1),
appsource (1), security (1), telemetry (1). The two BC24 No. Series
migration drafts are merged into one article.

Adds good/bad AL samples for the clean-fit articles (error-handling,
performance, security, telemetry). UI and appsource remain knowledge-only.

Validator and knowledge-index checks pass (207 articles).

Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>

* Correct SetLoadFields JIT-load article to match MS docs

The draft claimed accessing an unlisted field "reloads the entire row"
per record. Microsoft's partial-records docs say otherwise: the platform
does an implicit Get that loads the missing field(s), and in a direct var
loop the first JIT updates the enumerator so later iterations do not
re-load. The genuine per-row penalty is the pass-by-value case, where the
copy's enumerator is not updated.

Rewrite the article around JIT loading and the by-value footgun, rename
the slug from ...full-reload to ...jit-load, and fix the good/bad samples
to demonstrate the by-value repetition accurately.

Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>

---------

Co-authored-by: Jeremy Vyska <jeremy@sparebrained.com>
Co-authored-by: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
2026-07-01 14:31:50 +02:00

2.1 KiB

bc-version domain keywords technologies countries application-area
all
ui
factbox
subpagelink
listpart
cardpart
page-part
related-information
flowfield-sift
al
w1
all

Filter ListPart FactBoxes With SubPageLink To The Parent Record

Contributions welcome — open a PR to refine or extend this article.

Description

A FactBox is a page part that surfaces related data beside the main record so users avoid navigating away. Every FactBox runs a database query as its host page loads, so an unfiltered one is a hidden performance tax paid on every page open. The remedial trap: a ListPart FactBox with no SubPageLink does not show "the related rows" — it loads and pages through the entire source table, because nothing ties it to the host record. This makes correct SubPageLink linkage, not visual layout, the load-bearing design decision.

Best Practice

Give every ListPart FactBox a SubPageLink that maps a field on the part's source table to a field() of the host record (for example SubPageLink = "Document No." = field("No.")), so it returns only rows belonging to the current record. Prefer a CardPart when you only need summary figures (balance, availability, status) — it reads a single record and avoids list overhead entirely. When a FactBox shows FlowFields, ensure the calculated total is backed by a SIFT key (MaintainSIFTIndex) so the sum is read from the index rather than aggregated row-by-row on each load. Keep FactBox count modest and avoid heavy OnAfterGetRecord logic in the part.

Anti Pattern

Adding a ListPart FactBox without a SubPageLink, expecting it to "just show related lines." The consequence is a full-table scan on every page load that grows with the dataset and is felt worst on list pages, where the FactBox re-queries on each row selection. Reviewer signal: any part(...) referencing a list-type page part where the SubPageLink property is absent, or a FactBox FlowField filtered on non-indexed fields. A second smell is duplicating data already on the page or stacking many FactBoxes, which multiplies queries for little context gain.