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/microsoft/knowledge/events/do-not-change-shipped-event-attribute-flags.md
Jesper Schulz-Wedde 363f08f47e
Add P0 event and interface compatibility knowledge (#98) 
* Add P0 extensibility compatibility knowledge

Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com>

Copilot-Session: 645349fd-1892-48f3-8a84-db77d6abd1c3

* Correct event compatibility guidance

Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com>

Copilot-Session: 645349fd-1892-48f3-8a84-db77d6abd1c3

---------

Co-authored-by: Jesper Schulz-Wedde <jesper.schulzwedde@microsoft.com>
2026-07-14 12:51:59 +02:00

1.6 KiB
Raw Permalink Blame History

bc-version domain keywords technologies countries application-area
all
events
event-attribute
includesender
globalvaraccess
isolated-event
compatibility
integration-event
business-event
appsourcecop
as0021
as0101
al
w1
all

Do not change shipped event attribute flags

Description

IncludeSender and, on Integration events, GlobalVarAccess have been event-contract flags since runtime 1.0. Removing sender or global access breaks subscribers, so AppSourceCop AS0021 prevents changing those flags from true to false. On runtime 9.0 and later (Business Central 2022 release wave 1, BC20), Isolated also controls transaction, error, and rollback behavior; AS0101 prevents adding, removing, or changing that argument.

Best Practice

Keep every available attribute argument exactly as shipped. If new subscribers need different sender/global exposure, publish a new event with the desired flags. Apply the same rule to Isolated only on BC20 or later, where that argument exists. Raise both events while the original contract is supported, and choose preferred flags only when designing a new event.

See sample: do-not-change-shipped-event-attribute-flags.good.al.

Anti Pattern

Changing a shipped event's IncludeSender or GlobalVarAccess to modernize its design, including replacing IncludeSender with an explicit parameter. On BC20 or later, adding, removing, or toggling Isolated is equally contract-significant. Even a change that leaves old subscribers compiling can alter observable execution or exposure; version the event instead.

See sample: do-not-change-shipped-event-attribute-flags.bad.al.