Codeunit 4310 Agent Task Builder Impl.

System Application, System.Agents

src/System Application/App/Agent/Interaction/Internal/AgentTaskBuilderImpl.Codeunit.al166 lines, Copyright (c) Microsoft Corporation. MIT

// ------------------------------------------------------------------------------------------------// Copyright (c) Microsoft Corporation. All rights reserved.// Licensed under the MIT License. See License.txt in the project root for license information.// ------------------------------------------------------------------------------------------------namespace System.Agents;using System.Environment;using System.Environment.Configuration;codeunit 4310 "Agent Task Builder Impl."{    Access = Internal;    InherentEntitlements = X;    InherentPermissions = X;    var        GlobalAgentTaskMessageBuilder: Codeunit "Agent Task Message Builder";        MessageSet: Boolean;        GlobalAgentUserSecurityId: Guid;        GlobalTaskTitle: Text[150];        GlobalExternalID: Text[2048];        GlobalModelId: Code[30];        GlobalBillingContext: Enum "Agent Task Billing Context";    [Scope('OnPrem')]    procedure Initialize(NewAgentUserSecurityId: Guid; NewTaskTitle: Text[150]): codeunit "Agent Task Builder Impl."    begin        GlobalAgentUserSecurityId := NewAgentUserSecurityId;        GlobalTaskTitle := NewTaskTitle;        GlobalBillingContext := Enum::"Agent Task Billing Context"::Default;        exit(this);    end;    [Scope('OnPrem')]    procedure Create(SetTaskStatusToReady: Boolean; RequiresMessage: Boolean): Record "Agent Task"    var        AgentTaskRecord: Record "Agent Task";        AgentTaskImpl: Codeunit "Agent Task Impl.";    begin        VerifyMandatoryFieldsSet();        VerifyTaskCanBeCreated(RequiresMessage);        AgentTaskImpl.CreateTask(GlobalAgentUserSecurityId, GlobalTaskTitle, GlobalExternalID, GlobalBillingContext, GlobalModelId, AgentTaskRecord);        if MessageSet then begin            GlobalAgentTaskMessageBuilder.SetAgentTask(AgentTaskRecord);            GlobalAgentTaskMessageBuilder.Create(false);        end;        if SetTaskStatusToReady then            AgentTaskImpl.SetTaskStatusToReadyIfPossible(AgentTaskRecord);        exit(AgentTaskRecord);    end;    [Scope('OnPrem')]    procedure GetAgentTaskMessageCreated(): Record "Agent Task Message"    begin        exit(GlobalAgentTaskMessageBuilder.GetAgentTaskMessage());    end;    [Scope('OnPrem')]    procedure SetExternalId(ExternalId: Text[2048]): codeunit "Agent Task Builder Impl."    begin        GlobalExternalID := ExternalId;        exit(this);    end;    [Scope('OnPrem')]    procedure SetModelId(ModelId: Code[30]): codeunit "Agent Task Builder Impl."    begin        GlobalModelId := ModelId;        exit(this);    end;    [Scope('OnPrem')]    procedure SetBillingContext(BillingContext: Enum "Agent Task Billing Context"): codeunit "Agent Task Builder Impl."    begin        GlobalBillingContext := BillingContext;        exit(this);    end;    [Scope('OnPrem')]    procedure AddTaskMessage(From: Text[250]; MessageText: Text): codeunit "Agent Task Builder Impl."    begin        GlobalAgentTaskMessageBuilder.Initialize(From, MessageText);        MessageSet := true;        exit(this);    end;    [Scope('OnPrem')]    procedure AddTaskMessage(var AgentTaskMessageBuilder: Codeunit "Agent Task Message Builder"): codeunit "Agent Task Builder Impl."    begin        GlobalAgentTaskMessageBuilder := AgentTaskMessageBuilder;        MessageSet := true;        exit(this);    end;    [Scope('OnPrem')]    procedure GetTaskMessageBuilder(): Codeunit "Agent Task Message Builder"    begin        exit(GlobalAgentTaskMessageBuilder);    end;    local procedure VerifyMandatoryFieldsSet()    var        Agent: Codeunit Agent;        GlobalTitleMandatoryErr: Label 'Task title is mandatory. Please set the task title before creating task.';        GlobalAgentUserSecurityIdMandatoryErr: Label 'Agent user security ID is mandatory. Please set the agent user security ID before creating task.';        ActiveAgentDoesNotExistErr: Label 'Agent with user security ID %1 does not exist or is not active.', Comment = '%1 - Agent user security ID, value is a guid';        CodingErrorInfo: ErrorInfo;    begin        if GlobalTaskTitle = '' then            CodingErrorInfo.Message(GlobalTitleMandatoryErr);        if IsNullGuid(GlobalAgentUserSecurityId) then            CodingErrorInfo.Message(GlobalAgentUserSecurityIdMandatoryErr)        else            if not Agent.IsActive(GlobalAgentUserSecurityId) then                CodingErrorInfo.Message(StrSubstNo(ActiveAgentDoesNotExistErr, GlobalAgentUserSecurityId));        if CodingErrorInfo.Message = '' then            exit;        CodingErrorInfo.ErrorType := ErrorType::Internal;        Error(CodingErrorInfo);    end;    local procedure VerifyTaskCanBeCreated(RequiresMessage: Boolean)    var        AllowedCompanies: Text;    begin        if RequiresMessage and not MessageSet then            // 1. Tasks without messages cannot be set to ready to enforce a user intervention to approve the message/task.            // This temporary restriction ensures that the user reviews the message/task at least once.            Error(TaskCannotBeSetToReadyWithoutMessagesErr);        // 2. Tasks cannot be set to ready if the agent has no access controls in the current company.        if not CheckCurrentCompanyAccessForAgent(AllowedCompanies) then            Error(TaskCannotBeSetToReadyWithoutAccessControlErr, CompanyName(), AllowedCompanies);    end;    local procedure CheckCurrentCompanyAccessForAgent(var AllowedCompaniesText: Text): Boolean    var        TempCompany: Record Company temporary;        UserSettings: Codeunit "User Settings";    begin        UserSettings.GetAllowedCompaniesForUser(GlobalAgentUserSecurityId, TempCompany);        // Build list of allowed companies        AllowedCompaniesText := '';        if TempCompany.FindSet() then            repeat                if AllowedCompaniesText <> '' then                    AllowedCompaniesText += ', ';                AllowedCompaniesText += TempCompany.Name;            until TempCompany.Next() = 0;        TempCompany.SetRange(Name, CompanyName());        exit(not TempCompany.IsEmpty());    end;    var        TaskCannotBeSetToReadyWithoutMessagesErr: Label 'The task cannot be set to ready because it has no messages. Add at least one message to the task before setting it to ready.';        TaskCannotBeSetToReadyWithoutAccessControlErr: Label 'The task cannot be set to ready because the agent has no access control permissions in the %1 company. The agent has permissions in the following companies: %2. Grant the agent permissions in this company before setting the task to ready.', Comment = '%1 - Company Name, %2 - List of allowed companies';}