Codeunit 4307 "Agent Message"

System Application · System.Agents · BC25-30 · source at ea08af5e · facts from BC29

Procedures

• GetText(TaskID: BigInteger; MessageID: Guid): Text Δ BC27 + BC28: Get the message text for the given agent task message.
• GetText(var AgentTaskMessage: Record "Agent Task Message"): Text Δ BC27 + BC28: Get the message text for the given agent task message. The record is not retrieved again; the caller must ensure the record is up to date.
• UpdateText(TaskID: BigInteger; MessageID: Guid; NewMessageText: Text) Δ BC27 + BC28 Δ BC29: Updates the message text.
• UpdateText(var AgentTaskMessage: Record "Agent Task Message"; NewMessageText: Text) Δ BC27 + BC28 Δ BC29 (obsolete 29.0: Use the overload that takes TaskID and MessageID instead.): Updates the message text.
• IsEditable(TaskID: BigInteger; MessageID: Guid): Boolean Δ BC27 + BC28: Check if it is possible to edit the message.
• IsEditable(var AgentTaskMessage: Record "Agent Task Message"): Boolean Δ BC27 + BC28: Check if it is possible to edit the message. The record is not retrieved again; the caller must ensure the record is up to date.
• SetStatusToSent(TaskID: BigInteger; MessageID: Guid) Δ BC27 + BC28 Δ BC29: Sets the message status to sent.
• SetStatusToSent(var AgentTaskMessage: Record "Agent Task Message") Δ BC27 + BC28 Δ BC29 (obsolete 29.0: Use the overload that takes TaskID and MessageID instead.): Sets the message status to sent.
• SetStatusToFailed(TaskID: BigInteger; MessageID: Guid; StatusReason: Text[250]) + BC29: Sets the message status to failed, to indicate that delivery of the output message failed terminally. Only a reviewed output message, or one that already failed, can be set to failed.
• SetStatusToReviewed(TaskID: BigInteger; MessageID: Guid) + BC29: Sets the message status back to reviewed, so that delivery of a failed output message can be attempted again. The status reason of the previous failure is cleared.
• AddAttachment(var AgentTaskMessage: Record "Agent Task Message"; FileName: Text[250]; FileMIMEType: Text[100]; Attachment: InStream) + BC26: Add an attachment to the task message.
• SetIgnoreAttachment(IgnoreAttachment: Boolean) + BC27: Set whether to ignore attachments for the message. When set to true, attachments will be marked as ignored and will not be processed by the agent. The default value is false.
• DownloadAttachments(var AgentTaskMessage: Record "Agent Task Message") Δ BC27: Downloads the attachments for a specific message.
• ShowAttachment(TaskID: BigInteger; FileID: BigInteger) + BC26 + BC26 Δ BC27 Δ BC27: Shows the attachments for a specific message. If file is not supported to be shown, it will be downloaded.
• ShowAttachment(var AgentTaskFile: Record "Agent Task File") + BC26 + BC26 Δ BC27 Δ BC27: Shows the attachments for a specific message. If file is not supported to be shown, it will be downloaded.
• GetAttachments(TaskID: BigInteger; MessageID: Guid; var TempAgentTaskFile: Record "Agent Task File" temporary) + BC26 Δ BC27: Loads the attachments for a specific message to the temporary buffer.
• GetFileSizeDisplayText(SizeInBytes: Decimal): Text + BC26 Δ BC27: Get the display text for the file size.

Calls

From the extracted call graph of BC29 (graphify-al on the snapshot checkout): calls whose target is known from a declared type or an Object::"Name" argument. Interface dispatch and calls through events are not counted, so the list is not complete.

• Codeunit 4308 “Agent Message Impl.” (12 calls: AddAttachment → AddAttachment, DownloadAttachments → DownloadAttachments, GetAttachments → GetAttachments, …)

Called by

• Page 4308 “Agent Task Message Card” (3 calls: DownloadAttachments → DownloadAttachments, UpdateControls → GetText, UpdateControls → IsEditable)
• Codeunit 4361 “Agent Task Template” (2 calls: RepeatTask → GetAttachments, RepeatTask → GetText)
• Codeunit 4419 “SOA Send Reply” (2 calls: OnRun → GetText, OnRun → SetStatusToSent)
• Page 4358 “Agent Message Attachments” (2 calls: OnAfterGetRecord → GetFileSizeDisplayText, ShowOrDownloadAttachment → ShowAttachment)
• Page 4404 “SOA Email Message” (2 calls: UpdateEmailFields → GetText, UpdateEmailFields → IsEditable)
• Page 4408 “SOA Create Task Attachments” (2 calls: OnAfterGetRecord → GetFileSizeDisplayText, ShowOrDownloadAttachment → ShowAttachment)
• Codeunit 4398 “SOA Task Message” (1 call: GetPreviousMessageText → GetText)
• Codeunit 4408 “SOA Set Reply Failed” (1 call: OnRun → SetStatusToFailed)
• Codeunit 4418 “SOA Reply Retry Mgt.” (1 call: RetrySending → SetStatusToReviewed)
• Page 4318 “Agent Task Message ListPart” (1 call: UpdateControls → GetText)

Recent changes

• 2026-08-26 #10631 Integration/main to releases 29.x 31a860b5 (releases/29.x, BC29, feature)
• 2026-08-21 #10461 [SOA] Uptake Agent Task Message Failed status for outbound replies (main, BC30, feature)

Deprecations

• procedure SetStatusToSent: Pending 29.0 (#if not CLEAN29), “Use the overload that takes TaskID and MessageID instead.”
• procedure UpdateText: Pending 29.0 (#if not CLEAN29), “Use the overload that takes TaskID and MessageID instead.”

Source: AL metadata extracted from the code (names, ids, signatures, properties); no code bodies (D10).

Ask your agent

Procedure bodies are not stored here (D10). The call sections above are our own, per object, from the BC29 call graph. For a procedure body or the calls of one procedure, ask bc-code-atlas (external, by Stefan Maron, MIT; default corpus w1-28), which the bc-observatory plugin connects: bcatlas_resolve_node(object_type: "codeunit", object_name: "Agent Message"), then bcatlas_get_procedure_body or bcatlas_get_neighbors on the returned id.