Microsoft/bcquality
1
0
Fork 0
mirror of https://github.com/microsoft/BCQuality.git synced 2026-10-05 14:46:55 +01:00
Code Issues Projects Releases Packages Wiki Activity Actions 4
bcquality/community/knowledge/appsource/keep-web-service-paths-free-of-ui-calls.md
Stefano Demiliani 45ac371e7a
Add AL-focused AppSource validation guidance (#142) 
* knowledge(appsource): add AL validation guidance

* Address Marketplace review feedback

* Address remaining Marketplace review feedback

* Align AppSource review applicability outcome
2026-09-14 12:42:45 +02:00

1.5 KiB
Raw Blame History

bc-version domain keywords technologies countries application-area
all
appsource
web-service
serviceenabled
guiallowed
message
confirm
strmenu
al
w1
all

Keep web-service paths free of UI calls

Description

Pages and codeunits exposed as web services run without an interactive client. Calls that require a UI callback, including Confirm, StrMenu, and modal pages, can terminate the service request instead of completing the operation. Message does not raise the callback error: the message is suppressed and logged, making it ineffective for communicating a service result.

Best Practice

Keep service entry points and every procedure they call free of interactive UI. Return data through the service contract and report validation failures with service-safe error handling. When a procedure is shared with an interactive client, guard UI-only behavior with GuiAllowed while preserving the underlying operation.

See sample: keep-web-service-paths-free-of-ui-calls.good.al.

Anti Pattern

A web-service-exposed page or codeunit calls an interactive UI method directly or indirectly. Detection signals include Message, Confirm, StrMenu, Page.RunModal, and confirmation-dialog pages on a service call path. Treat Message as suppressed and ineffective, not as a callback failure. Do not flag a controlled Error solely because it returns a service fault.

See sample: keep-web-service-paths-free-of-ui-calls.bad.al.