{"title":"Codeunit 4300 Agent Task Impl., procedures","url":"https://jonas-paprotka.de/ref/codeunit/4300-agent-task-impl/procedures/","author":"JOP-AL","license":"Metadata from Microsoft's symbol packages. AL source MIT, Copyright (c) Microsoft Corporation. Selection and wording © 2026 JOP-AL. https://jonas-paprotka.de/licenses/","subject":"Microsoft Dynamics 365 Business Central","checked":"2026-11-20","changed":"2026-10-05","object":{"type":"codeunit","id":4300,"name":"Agent Task Impl.","app":"System Application","versions":"25-29","url":"https://jonas-paprotka.de/ref/codeunit/4300-agent-task-impl/","json":"https://jonas-paprotka.de/ref/codeunit/4300-agent-task-impl.json"},"aspect":"procedures","total":45,"rows":[{"name":"SetMessageText","sig":"(var Record Agent Task Message, Text)","named":"(var AgentTaskMessage: Record \"Agent Task Message\"; MessageText: Text)","returns":"","kind":"procedure","access":"public","obsolete":null,"range":"25-27","first":25,"last":27,"obsoleteSince":null,"spans":[{"from":25,"to":27,"named":"(var AgentTaskMessage: Record \"Agent Task Message\"; MessageText: Text)","returns":"","kind":"procedure","access":"public","obsolete":null}]},{"name":"GetStepsDoneCount","sig":"(var Record Agent Task)","named":"(var AgentTask: Record \"Agent Task\")","returns":"Integer","kind":"procedure","access":"public","obsolete":null,"range":"25-29","first":25,"last":29,"obsoleteSince":null,"spans":[{"from":25,"to":29,"named":"(var AgentTask: Record \"Agent Task\")","returns":"Integer","kind":"procedure","access":"public","obsolete":null}]},{"name":"GetDetailsForAgentTaskStep","sig":"(var Record Agent Task Step)","named":"(var AgentTaskStep: Record \"Agent Task Step\")","returns":"Text","kind":"procedure","access":"public","obsolete":null,"range":"25","first":25,"last":25,"obsoleteSince":null,"spans":[{"from":25,"to":25,"named":"(var AgentTaskStep: Record \"Agent Task Step\")","returns":"Text","kind":"procedure","access":"public","obsolete":null}]},{"name":"ShowTaskSteps","sig":"(var Record Agent Task)","named":"(var AgentTask: Record \"Agent Task\")","returns":"","kind":"procedure","access":"public","obsolete":null,"range":"25","first":25,"last":25,"obsoleteSince":null,"spans":[{"from":25,"to":25,"named":"(var AgentTask: Record \"Agent Task\")","returns":"","kind":"procedure","access":"public","obsolete":null}]},{"name":"CreateTaskMessage","sig":"(Text[250], Text, var Record Agent Task)","named":"(From: Text[250]; MessageText: Text; var CurrentAgentTask: Record \"Agent Task\")","returns":"","kind":"procedure","access":"public","obsolete":null,"range":"25","first":25,"last":25,"obsoleteSince":null,"spans":[{"from":25,"to":25,"named":"(From: Text[250]; MessageText: Text; var CurrentAgentTask: Record \"Agent Task\")","returns":"","kind":"procedure","access":"public","obsolete":null}]},{"name":"CreateTaskMessage","sig":"(Text[250], Text, Text[2048], var Record Agent Task)","named":"(From: Text[250]; MessageText: Text; ExternalMessageId: Text[2048]; var CurrentAgentTask: Record \"Agent Task\")","returns":"","kind":"procedure","access":"public","obsolete":null,"range":"25","first":25,"last":25,"obsoleteSince":null,"spans":[{"from":25,"to":25,"named":"(From: Text[250]; MessageText: Text; ExternalMessageId: Text[2048]; var CurrentAgentTask: Record \"Agent Task\")","returns":"","kind":"procedure","access":"public","obsolete":null}]},{"name":"CreateUserInterventionTaskStep","sig":"(Record Agent Task Step)","named":"(UserInterventionRequestStep: Record \"Agent Task Step\")","returns":"","kind":"procedure","access":"public","obsolete":null,"range":"25","first":25,"last":25,"obsoleteSince":null,"spans":[{"from":25,"to":25,"named":"(UserInterventionRequestStep: Record \"Agent Task Step\")","returns":"","kind":"procedure","access":"public","obsolete":null}]},{"name":"CreateUserInterventionTaskStep","sig":"(Record Agent Task Step, Text)","named":"(UserInterventionRequestStep: Record \"Agent Task Step\"; UserInput: Text)","returns":"","kind":"procedure","access":"public","obsolete":null,"range":"25","first":25,"last":25,"obsoleteSince":null,"spans":[{"from":25,"to":25,"named":"(UserInterventionRequestStep: Record \"Agent Task Step\"; UserInput: Text)","returns":"","kind":"procedure","access":"public","obsolete":null}]},{"name":"CreateUserInterventionTaskStep","sig":"(Record Agent Task Step, Integer)","named":"(UserInterventionRequestStep: Record \"Agent Task Step\"; SelectedSuggestionId: Integer)","returns":"","kind":"procedure","access":"public","obsolete":null,"range":"25","first":25,"last":25,"obsoleteSince":null,"spans":[{"from":25,"to":25,"named":"(UserInterventionRequestStep: Record \"Agent Task Step\"; SelectedSuggestionId: Integer)","returns":"","kind":"procedure","access":"public","obsolete":null}]},{"name":"CreateUserInterventionTaskStep","sig":"(Record Agent Task Step, Text, Integer)","named":"(UserInterventionRequestStep: Record \"Agent Task Step\"; UserInput: Text; SelectedSuggestionId: Integer)","returns":"","kind":"procedure","access":"public","obsolete":null,"range":"25","first":25,"last":25,"obsoleteSince":null,"spans":[{"from":25,"to":25,"named":"(UserInterventionRequestStep: Record \"Agent Task Step\"; UserInput: Text; SelectedSuggestionId: Integer)","returns":"","kind":"procedure","access":"public","obsolete":null}]},{"name":"StopTask","sig":"(var Record Agent Task, Enum Agent Task Status, Boolean)","named":"(var AgentTask: Record \"Agent Task\"; AgentTaskStatus: Enum \"Agent Task Status\"; UserConfirm: Boolean)","returns":"","kind":"procedure","access":"public","obsolete":null,"range":"25-29","first":25,"last":29,"obsoleteSince":null,"spans":[{"from":25,"to":29,"named":"(var AgentTask: Record \"Agent Task\"; AgentTaskStatus: Enum \"Agent Task Status\"; UserConfirm: Boolean)","returns":"","kind":"procedure","access":"public","obsolete":null}]},{"name":"RestartTask","sig":"(var Record Agent Task, Boolean)","named":"(var AgentTask: Record \"Agent Task\"; UserConfirm: Boolean)","returns":"","kind":"procedure","access":"public","obsolete":null,"range":"25-29","first":25,"last":29,"obsoleteSince":null,"spans":[{"from":25,"to":29,"named":"(var AgentTask: Record \"Agent Task\"; UserConfirm: Boolean)","returns":"","kind":"procedure","access":"public","obsolete":null}]},{"name":"TaskExists","sig":"(Guid, Text)","named":"(AgentUserSecurityID: Guid; ConversationId: Text)","returns":"Boolean","kind":"procedure","access":"public","obsolete":null,"range":"25-29","first":25,"last":29,"obsoleteSince":null,"spans":[{"from":25,"to":29,"named":"(AgentUserSecurityID: Guid; ConversationId: Text)","returns":"Boolean","kind":"procedure","access":"public","obsolete":null}]},{"name":"GetDefaultEncoding","sig":"()","named":"()","returns":"TextEncoding","kind":"procedure","access":"public","obsolete":null,"range":"25-29","first":25,"last":29,"obsoleteSince":null,"spans":[{"from":25,"to":29,"named":"()","returns":"TextEncoding","kind":"procedure","access":"public","obsolete":null}]},{"name":"GetDetailsForAgentTaskLogEntry","sig":"(var Record Agent Task Log Entry)","named":"(var AgentTaskLogEntry: Record \"Agent Task Log Entry\")","returns":"Text","kind":"procedure","access":"public","obsolete":null,"range":"26-29","first":26,"last":29,"obsoleteSince":null,"spans":[{"from":26,"to":29,"named":"(var AgentTaskLogEntry: Record \"Agent Task Log Entry\")","returns":"Text","kind":"procedure","access":"public","obsolete":null}]},{"name":"ShowTaskLogEntries","sig":"(var Record Agent Task)","named":"(var AgentTask: Record \"Agent Task\")","returns":"","kind":"procedure","access":"public","obsolete":null,"range":"26-29","first":26,"last":29,"obsoleteSince":null,"spans":[{"from":26,"to":29,"named":"(var AgentTask: Record \"Agent Task\")","returns":"","kind":"procedure","access":"public","obsolete":null}]},{"name":"CreateTask","sig":"(Guid, Text[150], Text[2048], var Record Agent Task)","named":"(AgentUserSecurityID: Guid; TaskTitle: Text[150]; ExternalID: Text[2048]; var NewAgentTask: Record \"Agent Task\")","returns":"","kind":"procedure","access":"public","obsolete":null,"range":"26-27","first":26,"last":27,"obsoleteSince":null,"spans":[{"from":26,"to":27,"named":"(AgentUserSecurityID: Guid; TaskTitle: Text[150]; ExternalID: Text[2048]; var NewAgentTask: Record \"Agent Task\")","returns":"","kind":"procedure","access":"public","obsolete":null}]},{"name":"AddMessage","sig":"(Text[250], Text, Text[2048], var Record Agent Task, Boolean)","named":"(From: Text[250]; MessageText: Text; ExternalMessageId: Text[2048]; var CurrentAgentTask: Record \"Agent Task\"; RequiresReview: Boolean)","returns":"Record Agent Task Message","kind":"procedure","access":"public","obsolete":null,"range":"26-29","first":26,"last":29,"obsoleteSince":null,"spans":[{"from":26,"to":29,"named":"(From: Text[250]; MessageText: Text; ExternalMessageId: Text[2048]; var CurrentAgentTask: Record \"Agent Task\"; RequiresReview: Boolean)","returns":"Record Agent Task Message","kind":"procedure","access":"public","obsolete":null}]},{"name":"CreateUserIntervention","sig":"(Record Agent Task Log Entry)","named":"(UserInterventionRequestEntry: Record \"Agent Task Log Entry\")","returns":"","kind":"procedure","access":"public","obsolete":null,"range":"26-27","first":26,"last":27,"obsoleteSince":null,"spans":[{"from":26,"to":27,"named":"(UserInterventionRequestEntry: Record \"Agent Task Log Entry\")","returns":"","kind":"procedure","access":"public","obsolete":null}]},{"name":"CreateUserIntervention","sig":"(Record Agent Task Log Entry, Text)","named":"(UserInterventionRequestEntry: Record \"Agent Task Log Entry\"; UserInput: Text)","returns":"","kind":"procedure","access":"public","obsolete":null,"range":"26-27","first":26,"last":27,"obsoleteSince":null,"spans":[{"from":26,"to":27,"named":"(UserInterventionRequestEntry: Record \"Agent Task Log Entry\"; UserInput: Text)","returns":"","kind":"procedure","access":"public","obsolete":null}]},{"name":"CreateUserIntervention","sig":"(Record Agent Task Log Entry, Integer)","named":"(UserInterventionRequestEntry: Record \"Agent Task Log Entry\"; SelectedSuggestionId: Integer)","returns":"","kind":"procedure","access":"public","obsolete":null,"range":"26-27","first":26,"last":27,"obsoleteSince":null,"spans":[{"from":26,"to":27,"named":"(UserInterventionRequestEntry: Record \"Agent Task Log Entry\"; SelectedSuggestionId: Integer)","returns":"","kind":"procedure","access":"public","obsolete":null}]},{"name":"CreateUserIntervention","sig":"(Record Agent Task Log Entry, Text, Text)","named":"(UserInterventionRequestEntry: Record \"Agent Task Log Entry\"; UserInput: Text; SelectedSuggestionId: Text)","returns":"","kind":"procedure","access":"public","obsolete":null,"range":"26-27","first":26,"last":27,"obsoleteSince":null,"spans":[{"from":26,"to":27,"named":"(UserInterventionRequestEntry: Record \"Agent Task Log Entry\"; UserInput: Text; SelectedSuggestionId: Text)","returns":"","kind":"procedure","access":"public","obsolete":null}]},{"name":"CreateUserIntervention","sig":"(Record Agent Task Log Entry, Text, Integer)","named":"(UserInterventionRequestEntry: Record \"Agent Task Log Entry\"; UserInput: Text; SelectedSuggestionId: Integer)","returns":"","kind":"procedure","access":"public","obsolete":null,"range":"26-27","first":26,"last":27,"obsoleteSince":null,"spans":[{"from":26,"to":27,"named":"(UserInterventionRequestEntry: Record \"Agent Task Log Entry\"; UserInput: Text; SelectedSuggestionId: Integer)","returns":"","kind":"procedure","access":"public","obsolete":null}]},{"name":"GetUserInterventionRequestDetails","sig":"(Record Agent Task Log Entry, var DotNet AgentTaskUserInterventionRequest)","named":"(UserInterventionRequestEntry: Record \"Agent Task Log Entry\"; var UserInterventionRequest: DotNet AgentTaskUserInterventionRequest)","returns":"","kind":"procedure","access":"public","obsolete":null,"range":"26-27","first":26,"last":27,"obsoleteSince":null,"spans":[{"from":26,"to":27,"named":"(UserInterventionRequestEntry: Record \"Agent Task Log Entry\"; var UserInterventionRequest: DotNet AgentTaskUserInterventionRequest)","returns":"","kind":"procedure","access":"public","obsolete":null}]},{"name":"SetTaskStatusToReadyIfPossible","sig":"(var Record Agent Task)","named":"(var AgentTask: Record \"Agent Task\")","returns":"","kind":"procedure","access":"public","obsolete":null,"range":"26-29","first":26,"last":29,"obsoleteSince":null,"spans":[{"from":26,"to":29,"named":"(var AgentTask: Record \"Agent Task\")","returns":"","kind":"procedure","access":"public","obsolete":null}]},{"name":"CanAgentTaskBeSetToReady","sig":"(var Record Agent Task)","named":"(var AgentTask: Record \"Agent Task\")","returns":"Boolean","kind":"procedure","access":"public","obsolete":null,"range":"26-29","first":26,"last":29,"obsoleteSince":null,"spans":[{"from":26,"to":29,"named":"(var AgentTask: Record \"Agent Task\")","returns":"Boolean","kind":"procedure","access":"public","obsolete":null}]},{"name":"GetSessionAgentTaskId","sig":"()","named":"()","returns":"BigInteger","kind":"procedure","access":"public","obsolete":null,"range":"26","first":26,"last":26,"obsoleteSince":null,"spans":[{"from":26,"to":26,"named":"()","returns":"BigInteger","kind":"procedure","access":"public","obsolete":null}]},{"name":"IsTaskRunning","sig":"(var Record Agent Task)","named":"(var AgentTask: Record \"Agent Task\")","returns":"Boolean","kind":"procedure","access":"public","obsolete":null,"range":"27-29","first":27,"last":29,"obsoleteSince":null,"spans":[{"from":27,"to":29,"named":"(var AgentTask: Record \"Agent Task\")","returns":"Boolean","kind":"procedure","access":"public","obsolete":null}]},{"name":"IsTaskCompleted","sig":"(var Record Agent Task)","named":"(var AgentTask: Record \"Agent Task\")","returns":"Boolean","kind":"procedure","access":"public","obsolete":null,"range":"27-29","first":27,"last":29,"obsoleteSince":null,"spans":[{"from":27,"to":29,"named":"(var AgentTask: Record \"Agent Task\")","returns":"Boolean","kind":"procedure","access":"public","obsolete":null}]},{"name":"IsTaskStopped","sig":"(var Record Agent Task)","named":"(var AgentTask: Record \"Agent Task\")","returns":"Boolean","kind":"procedure","access":"public","obsolete":null,"range":"27-29","first":27,"last":29,"obsoleteSince":null,"spans":[{"from":27,"to":29,"named":"(var AgentTask: Record \"Agent Task\")","returns":"Boolean","kind":"procedure","access":"public","obsolete":null}]},{"name":"TryGetAgentRecordFromTaskId","sig":"(Integer, var Record Agent)","named":"(TaskId: Integer; var Agent: Record Agent)","returns":"Boolean","kind":"procedure","access":"internal","obsolete":null,"range":"27-29","first":27,"last":29,"obsoleteSince":null,"spans":[{"from":27,"to":29,"named":"(TaskId: Integer; var Agent: Record Agent)","returns":"Boolean","kind":"procedure","access":"internal","obsolete":null}]},{"name":"CreateTask","sig":"(Guid, Text[150], Text[2048], Enum Agent Task Billing Context, Code[30], var Record Agent Task)","named":"(AgentUserSecurityID: Guid; TaskTitle: Text[150]; ExternalID: Text[2048]; BillingContext: Enum \"Agent Task Billing Context\"; ModelId: Code[30]; var NewAgentTask: Record \"Agent Task\")","returns":"","kind":"procedure","access":"public","obsolete":null,"range":"28-29","first":28,"last":29,"obsoleteSince":null,"spans":[{"from":28,"to":29,"named":"(AgentUserSecurityID: Guid; TaskTitle: Text[150]; ExternalID: Text[2048]; BillingContext: Enum \"Agent Task Billing Context\"; ModelId: Code[30]; var NewAgentTask: Record \"Agent Task\")","returns":"","kind":"procedure","access":"public","obsolete":null}]},{"name":"StopTask","sig":"(BigInteger, Enum Agent Task Status, Boolean)","named":"(AgentTaskID: BigInteger; AgentTaskStatus: Enum \"Agent Task Status\"; UserConfirm: Boolean)","returns":"","kind":"procedure","access":"public","obsolete":null,"range":"28-29","first":28,"last":29,"obsoleteSince":null,"spans":[{"from":28,"to":29,"named":"(AgentTaskID: BigInteger; AgentTaskStatus: Enum \"Agent Task Status\"; UserConfirm: Boolean)","returns":"","kind":"procedure","access":"public","obsolete":null}]},{"name":"RestartTask","sig":"(BigInteger, Boolean)","named":"(AgentTaskID: BigInteger; UserConfirm: Boolean)","returns":"","kind":"procedure","access":"public","obsolete":null,"range":"28-29","first":28,"last":29,"obsoleteSince":null,"spans":[{"from":28,"to":29,"named":"(AgentTaskID: BigInteger; UserConfirm: Boolean)","returns":"","kind":"procedure","access":"public","obsolete":null}]},{"name":"SetTaskStatusToReadyIfPossible","sig":"(BigInteger)","named":"(AgentTaskID: BigInteger)","returns":"","kind":"procedure","access":"public","obsolete":null,"range":"28-29","first":28,"last":29,"obsoleteSince":null,"spans":[{"from":28,"to":29,"named":"(AgentTaskID: BigInteger)","returns":"","kind":"procedure","access":"public","obsolete":null}]},{"name":"CanAgentTaskBeSetToReady","sig":"(BigInteger)","named":"(AgentTaskID: BigInteger)","returns":"Boolean","kind":"procedure","access":"public","obsolete":null,"range":"28-29","first":28,"last":29,"obsoleteSince":null,"spans":[{"from":28,"to":29,"named":"(AgentTaskID: BigInteger)","returns":"Boolean","kind":"procedure","access":"public","obsolete":null}]},{"name":"IsTaskRunning","sig":"(BigInteger)","named":"(AgentTaskID: BigInteger)","returns":"Boolean","kind":"procedure","access":"public","obsolete":null,"range":"28-29","first":28,"last":29,"obsoleteSince":null,"spans":[{"from":28,"to":29,"named":"(AgentTaskID: BigInteger)","returns":"Boolean","kind":"procedure","access":"public","obsolete":null}]},{"name":"IsTaskCompleted","sig":"(BigInteger)","named":"(AgentTaskID: BigInteger)","returns":"Boolean","kind":"procedure","access":"public","obsolete":null,"range":"28-29","first":28,"last":29,"obsoleteSince":null,"spans":[{"from":28,"to":29,"named":"(AgentTaskID: BigInteger)","returns":"Boolean","kind":"procedure","access":"public","obsolete":null}]},{"name":"IsTaskStopped","sig":"(BigInteger)","named":"(AgentTaskID: BigInteger)","returns":"Boolean","kind":"procedure","access":"public","obsolete":null,"range":"28-29","first":28,"last":29,"obsoleteSince":null,"spans":[{"from":28,"to":29,"named":"(AgentTaskID: BigInteger)","returns":"Boolean","kind":"procedure","access":"public","obsolete":null}]},{"name":"GetModelId","sig":"(BigInteger)","named":"(TaskId: BigInteger)","returns":"Code[30]","kind":"procedure","access":"public","obsolete":null,"range":"28-29","first":28,"last":29,"obsoleteSince":null,"spans":[{"from":28,"to":29,"named":"(TaskId: BigInteger)","returns":"Code[30]","kind":"procedure","access":"public","obsolete":null}]},{"name":"GetModelName","sig":"(BigInteger)","named":"(TaskId: BigInteger)","returns":"Text[70]","kind":"procedure","access":"public","obsolete":null,"range":"28-29","first":28,"last":29,"obsoleteSince":null,"spans":[{"from":28,"to":29,"named":"(TaskId: BigInteger)","returns":"Text[70]","kind":"procedure","access":"public","obsolete":null}]},{"name":"GetStepsDoneCount","sig":"(BigInteger)","named":"(AgentTaskID: BigInteger)","returns":"Integer","kind":"procedure","access":"public","obsolete":null,"range":"29","first":29,"last":29,"obsoleteSince":null,"spans":[{"from":29,"to":29,"named":"(AgentTaskID: BigInteger)","returns":"Integer","kind":"procedure","access":"public","obsolete":null}]},{"name":"ShowTaskLogEntries","sig":"(BigInteger)","named":"(AgentTaskID: BigInteger)","returns":"","kind":"procedure","access":"public","obsolete":null,"range":"29","first":29,"last":29,"obsoleteSince":null,"spans":[{"from":29,"to":29,"named":"(AgentTaskID: BigInteger)","returns":"","kind":"procedure","access":"public","obsolete":null}]},{"name":"ShowTask","sig":"(var Record Agent Task)","named":"(var AgentTask: Record \"Agent Task\")","returns":"","kind":"procedure","access":"public","obsolete":null,"range":"29","first":29,"last":29,"obsoleteSince":null,"spans":[{"from":29,"to":29,"named":"(var AgentTask: Record \"Agent Task\")","returns":"","kind":"procedure","access":"public","obsolete":null}]},{"name":"ArchiveTask","sig":"(BigInteger, Boolean)","named":"(AgentTaskID: BigInteger; UserConfirm: Boolean)","returns":"","kind":"procedure","access":"public","obsolete":null,"range":"29","first":29,"last":29,"obsoleteSince":null,"spans":[{"from":29,"to":29,"named":"(AgentTaskID: BigInteger; UserConfirm: Boolean)","returns":"","kind":"procedure","access":"public","obsolete":null}]}]}