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/microsoft/knowledge/performance/job-queue-handlers-must-not-require-ui.md
dayland 852a676285
Fix Job Queue sample links (#184) 
Use the required READ-convention Markdown links so knowledge retrieval can associate all new samples with their articles.

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

Co-authored-by: dayland <dayland@microsoft.com>
Copilot-Session: 76eb42c4-2acd-4f9c-a898-f4a44f9d46f7
2026-09-15 09:32:40 +02:00

1.6 KiB
Raw Blame History

bc-version domain keywords technologies countries application-area
all
performance
job-queue
background-session
guiallowed
confirm
runmodal
client-callback
al
w1
all

Job queue handlers must not require user interaction

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

Description

A job queue handler runs in a background session with no client UI. Calls that require a client callback, such as Confirm, Page.RunModal, Report.RunModal, upload, or download, can stop the job with a non-retriable callback error. Message is suppressed and logged by the server, so it cannot communicate a result to the user who scheduled the job.

Best Practice

Make a dedicated job queue entry point non-interactive. Validate parameters and data in AL, persist business-visible status when needed, and let failures propagate to the job queue log. If one procedure genuinely serves both foreground and background callers, isolate optional UI-only behavior behind GuiAllowed; do not use the guard to silently skip a decision that the operation requires.

See sample: job-queue-handlers-must-not-require-ui.good.al.

Anti Pattern

Calling Confirm, Page.Run, Page.RunModal, Report.Run, Report.RunModal, Hyperlink, File.Upload, or File.Download from a codeunit run by the job queue. Another signal is using Message as the only success or failure notification: no user is attached to receive it.

See sample: job-queue-handlers-must-not-require-ui.bad.al.