{"title":"Codeunit 4301 Agent Impl., procedures","url":"https://jonas-paprotka.de/ref/codeunit/4301-agent-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":4301,"name":"Agent Impl.","app":"System Application","versions":"25-29","url":"https://jonas-paprotka.de/ref/codeunit/4301-agent-impl/","json":"https://jonas-paprotka.de/ref/codeunit/4301-agent-impl.json"},"aspect":"procedures","total":47,"rows":[{"name":"CreateAgent","sig":"(Enum Agent Metadata Provider, Code[50], Text[80], var Record Agent Access Control)","named":"(AgentMetadataProvider: Enum \"Agent Metadata Provider\"; AgentUserName: Code[50]; AgentUserDisplayName: Text[80]; var TempAgentAccessControl: Record \"Agent Access Control\" temporary)","returns":"Guid","kind":"procedure","access":"internal","obsolete":null,"range":"25-26","first":25,"last":26,"obsoleteSince":null,"spans":[{"from":25,"to":26,"named":"(AgentMetadataProvider: Enum \"Agent Metadata Provider\"; AgentUserName: Code[50]; AgentUserDisplayName: Text[80]; var TempAgentAccessControl: Record \"Agent Access Control\" temporary)","returns":"Guid","kind":"procedure","access":"internal","obsolete":null}]},{"name":"Activate","sig":"(Guid)","named":"(AgentUserSecurityID: Guid)","returns":"","kind":"procedure","access":"public","obsolete":null,"range":"25-29","first":25,"last":29,"obsoleteSince":null,"spans":[{"from":25,"to":26,"named":"(AgentUserSecurityID: Guid)","returns":"","kind":"procedure","access":"internal","obsolete":null},{"from":27,"to":29,"named":"(AgentUserSecurityID: Guid)","returns":"","kind":"procedure","access":"public","obsolete":null}]},{"name":"Deactivate","sig":"(Guid)","named":"(AgentUserSecurityID: Guid)","returns":"","kind":"procedure","access":"public","obsolete":null,"range":"25-29","first":25,"last":29,"obsoleteSince":null,"spans":[{"from":25,"to":26,"named":"(AgentUserSecurityID: Guid)","returns":"","kind":"procedure","access":"internal","obsolete":null},{"from":27,"to":29,"named":"(AgentUserSecurityID: Guid)","returns":"","kind":"procedure","access":"public","obsolete":null}]},{"name":"SetInstructions","sig":"(Guid, SecretText)","named":"(AgentUserSecurityID: Guid; Instructions: SecretText)","returns":"","kind":"procedure","access":"internal","obsolete":null,"range":"25-26","first":25,"last":26,"obsoleteSince":null,"spans":[{"from":25,"to":26,"named":"(AgentUserSecurityID: Guid; Instructions: SecretText)","returns":"","kind":"procedure","access":"internal","obsolete":null}]},{"name":"GetInstructions","sig":"(var Record Agent)","named":"(var Agent: Record Agent)","returns":"Text","kind":"procedure","access":"internal","obsolete":null,"range":"25","first":25,"last":25,"obsoleteSince":null,"spans":[{"from":25,"to":25,"named":"(var Agent: Record Agent)","returns":"Text","kind":"procedure","access":"internal","obsolete":null}]},{"name":"InsertCurrentOwnerIfNoOwnersDefined","sig":"(var Record Agent, var Record Agent Access Control)","named":"(var Agent: Record Agent; var AgentAccessControl: Record \"Agent Access Control\")","returns":"","kind":"procedure","access":"internal","obsolete":null,"range":"25-26","first":25,"last":26,"obsoleteSince":null,"spans":[{"from":25,"to":26,"named":"(var Agent: Record Agent; var AgentAccessControl: Record \"Agent Access Control\")","returns":"","kind":"procedure","access":"internal","obsolete":null}]},{"name":"InsertCurrentOwner","sig":"(Guid, var Record Agent Access Control)","named":"(AgentUserSecurityID: Guid; var AgentAccessControl: Record \"Agent Access Control\")","returns":"","kind":"procedure","access":"internal","obsolete":null,"range":"25-26","first":25,"last":26,"obsoleteSince":null,"spans":[{"from":25,"to":26,"named":"(AgentUserSecurityID: Guid; var AgentAccessControl: Record \"Agent Access Control\")","returns":"","kind":"procedure","access":"internal","obsolete":null}]},{"name":"VerifyOwnerExists","sig":"(Record Agent Access Control)","named":"(AgentAccessControlModified: Record \"Agent Access Control\")","returns":"","kind":"procedure","access":"internal","obsolete":null,"range":"25-26","first":25,"last":26,"obsoleteSince":null,"spans":[{"from":25,"to":26,"named":"(AgentAccessControlModified: Record \"Agent Access Control\")","returns":"","kind":"procedure","access":"internal","obsolete":null}]},{"name":"GetUserAccess","sig":"(Guid, var Record Agent Access Control)","named":"(AgentUserSecurityID: Guid; var TempAgentAccessControl: Record \"Agent Access Control\" temporary)","returns":"","kind":"procedure","access":"public","obsolete":null,"range":"25-29","first":25,"last":29,"obsoleteSince":null,"spans":[{"from":25,"to":26,"named":"(AgentUserSecurityID: Guid; var TempAgentAccessControl: Record \"Agent Access Control\" temporary)","returns":"","kind":"procedure","access":"internal","obsolete":null},{"from":27,"to":29,"named":"(AgentUserSecurityID: Guid; var TempAgentAccessControl: Record \"Agent Access Control\" temporary)","returns":"","kind":"procedure","access":"public","obsolete":null}]},{"name":"SetProfile","sig":"(Guid, var Record All Profile)","named":"(AgentUserSecurityID: Guid; var AllProfile: Record \"All Profile\")","returns":"","kind":"procedure","access":"public","obsolete":null,"range":"25-29","first":25,"last":29,"obsoleteSince":null,"spans":[{"from":25,"to":26,"named":"(AgentUserSecurityID: Guid; var AllProfile: Record \"All Profile\")","returns":"","kind":"procedure","access":"internal","obsolete":null},{"from":27,"to":29,"named":"(AgentUserSecurityID: Guid; var AllProfile: Record \"All Profile\")","returns":"","kind":"procedure","access":"public","obsolete":null}]},{"name":"AssignCompany","sig":"(Guid, Text)","named":"(AgentUserSecurityID: Guid; CompanyName: Text)","returns":"","kind":"procedure","access":"internal","obsolete":null,"range":"25-26","first":25,"last":26,"obsoleteSince":null,"spans":[{"from":25,"to":26,"named":"(AgentUserSecurityID: Guid; CompanyName: Text)","returns":"","kind":"procedure","access":"internal","obsolete":null}]},{"name":"GetUserName","sig":"(Guid)","named":"(AgentUserSecurityID: Guid)","returns":"Code[50]","kind":"procedure","access":"public","obsolete":null,"range":"25-29","first":25,"last":29,"obsoleteSince":null,"spans":[{"from":25,"to":26,"named":"(AgentUserSecurityID: Guid)","returns":"Code[50]","kind":"procedure","access":"internal","obsolete":null},{"from":27,"to":29,"named":"(AgentUserSecurityID: Guid)","returns":"Code[50]","kind":"procedure","access":"public","obsolete":null}]},{"name":"GetDisplayName","sig":"(Guid)","named":"(AgentUserSecurityID: Guid)","returns":"Text[80]","kind":"procedure","access":"public","obsolete":null,"range":"25-29","first":25,"last":29,"obsoleteSince":null,"spans":[{"from":25,"to":26,"named":"(AgentUserSecurityID: Guid)","returns":"Text[80]","kind":"procedure","access":"internal","obsolete":null},{"from":27,"to":29,"named":"(AgentUserSecurityID: Guid)","returns":"Text[80]","kind":"procedure","access":"public","obsolete":null}]},{"name":"SetDisplayName","sig":"(Guid, Text[80])","named":"(AgentUserSecurityID: Guid; DisplayName: Text[80])","returns":"","kind":"procedure","access":"public","obsolete":null,"range":"25-29","first":25,"last":29,"obsoleteSince":null,"spans":[{"from":25,"to":26,"named":"(AgentUserSecurityID: Guid; DisplayName: Text[80])","returns":"","kind":"procedure","access":"internal","obsolete":null},{"from":27,"to":29,"named":"(AgentUserSecurityID: Guid; DisplayName: Text[80])","returns":"","kind":"procedure","access":"public","obsolete":null}]},{"name":"IsActive","sig":"(Guid)","named":"(AgentUserSecurityID: Guid)","returns":"Boolean","kind":"procedure","access":"public","obsolete":null,"range":"25-29","first":25,"last":29,"obsoleteSince":null,"spans":[{"from":25,"to":26,"named":"(AgentUserSecurityID: Guid)","returns":"Boolean","kind":"procedure","access":"internal","obsolete":null},{"from":27,"to":29,"named":"(AgentUserSecurityID: Guid)","returns":"Boolean","kind":"procedure","access":"public","obsolete":null}]},{"name":"UpdateAgentAccessControl","sig":"(Guid, var Record Agent Access Control)","named":"(AgentUserSecurityID: Guid; var TempAgentAccessControl: Record \"Agent Access Control\" temporary)","returns":"","kind":"procedure","access":"public","obsolete":null,"range":"25-29","first":25,"last":29,"obsoleteSince":null,"spans":[{"from":25,"to":26,"named":"(AgentUserSecurityID: Guid; var TempAgentAccessControl: Record \"Agent Access Control\" temporary)","returns":"","kind":"procedure","access":"internal","obsolete":null},{"from":27,"to":29,"named":"(AgentUserSecurityID: Guid; var TempAgentAccessControl: Record \"Agent Access Control\" temporary)","returns":"","kind":"procedure","access":"public","obsolete":null}]},{"name":"UpdateAgentUserSettings","sig":"(Record User Settings)","named":"(NewUserSettings: Record \"User Settings\")","returns":"","kind":"procedure","access":"public","obsolete":null,"range":"25-29","first":25,"last":29,"obsoleteSince":null,"spans":[{"from":25,"to":26,"named":"(NewUserSettings: Record \"User Settings\")","returns":"","kind":"procedure","access":"internal","obsolete":null},{"from":27,"to":29,"named":"(NewUserSettings: Record \"User Settings\")","returns":"","kind":"procedure","access":"public","obsolete":null}]},{"name":"ProfileLookup","sig":"(var Record User Settings)","named":"(var UserSettingsRec: Record \"User Settings\")","returns":"Boolean","kind":"procedure","access":"public","obsolete":null,"range":"25-29","first":25,"last":29,"obsoleteSince":null,"spans":[{"from":25,"to":29,"named":"(var UserSettingsRec: Record \"User Settings\")","returns":"Boolean","kind":"procedure","access":"public","obsolete":null}]},{"name":"UpdateProfile","sig":"(var Record All Profile, var Record User Settings)","named":"(var TempAllProfile: Record \"All Profile\" temporary; var UserSettingsRec: Record \"User Settings\")","returns":"","kind":"procedure","access":"internal","obsolete":null,"range":"25-26","first":25,"last":26,"obsoleteSince":null,"spans":[{"from":25,"to":26,"named":"(var TempAllProfile: Record \"All Profile\" temporary; var UserSettingsRec: Record \"User Settings\")","returns":"","kind":"procedure","access":"internal","obsolete":null}]},{"name":"PopulateProfiles","sig":"(var Record All Profile)","named":"(var TempAllProfile: Record \"All Profile\" temporary)","returns":"","kind":"procedure","access":"public","obsolete":null,"range":"25-26","first":25,"last":26,"obsoleteSince":null,"spans":[{"from":25,"to":26,"named":"(var TempAllProfile: Record \"All Profile\" temporary)","returns":"","kind":"procedure","access":"public","obsolete":null}]},{"name":"GetProfileName","sig":"(Option, Guid, Code[30])","named":"(Scope: Option System,Tenant; AppID: Guid; ProfileID: Code[30])","returns":"Text","kind":"procedure","access":"public","obsolete":null,"range":"25-26","first":25,"last":26,"obsoleteSince":null,"spans":[{"from":25,"to":26,"named":"(Scope: Option System,Tenant; AppID: Guid; ProfileID: Code[30])","returns":"Text","kind":"procedure","access":"public","obsolete":null}]},{"name":"AssignPermissionSets","sig":"(var Guid, Text, var Record Aggregate Permission Set)","named":"(var UserSID: Guid; PermissionCompanyName: Text; var AggregatePermissionSet: Record \"Aggregate Permission Set\")","returns":"","kind":"procedure","access":"internal","obsolete":null,"range":"25-26","first":25,"last":26,"obsoleteSince":null,"spans":[{"from":25,"to":26,"named":"(var UserSID: Guid; PermissionCompanyName: Text; var AggregatePermissionSet: Record \"Aggregate Permission Set\")","returns":"","kind":"procedure","access":"internal","obsolete":null}]},{"name":"SelectAgent","sig":"(var Record Agent)","named":"(var Agent: Record Agent)","returns":"","kind":"procedure","access":"public","obsolete":null,"range":"25-29","first":25,"last":29,"obsoleteSince":null,"spans":[{"from":25,"to":29,"named":"(var Agent: Record Agent)","returns":"","kind":"procedure","access":"public","obsolete":null}]},{"name":"GetInstructions","sig":"(Guid)","named":"(AgentUserSecurityID: Guid)","returns":"SecretText","kind":"procedure","access":"internal","obsolete":null,"range":"26","first":26,"last":26,"obsoleteSince":null,"spans":[{"from":26,"to":26,"named":"(AgentUserSecurityID: Guid)","returns":"SecretText","kind":"procedure","access":"internal","obsolete":null}]},{"name":"ShowNoAgentsAvailableNotification","sig":"()","named":"()","returns":"","kind":"procedure","access":"public","obsolete":null,"range":"26-29","first":26,"last":29,"obsoleteSince":null,"spans":[{"from":26,"to":29,"named":"()","returns":"","kind":"procedure","access":"public","obsolete":null}]},{"name":"OpenNoAgentsLearnMore","sig":"(Notification)","named":"(Notification: Notification)","returns":"","kind":"procedure","access":"public","obsolete":null,"range":"26-29","first":26,"last":29,"obsoleteSince":null,"spans":[{"from":26,"to":29,"named":"(Notification: Notification)","returns":"","kind":"procedure","access":"public","obsolete":null}]},{"name":"CreateAgent","sig":"(Enum Agent Metadata Provider, var Code[50], Text[80], var Record Agent Access Control)","named":"(AgentMetadataProvider: Enum \"Agent Metadata Provider\"; var UserName: Code[50]; AgentUserDisplayName: Text[80]; var TempAgentAccessControl: Record \"Agent Access Control\" temporary)","returns":"Guid","kind":"procedure","access":"public","obsolete":null,"range":"27-29","first":27,"last":29,"obsoleteSince":null,"spans":[{"from":27,"to":29,"named":"(AgentMetadataProvider: Enum \"Agent Metadata Provider\"; var UserName: Code[50]; AgentUserDisplayName: Text[80]; var TempAgentAccessControl: Record \"Agent Access Control\" temporary)","returns":"Guid","kind":"procedure","access":"public","obsolete":null}]},{"name":"PopulateProfileTempRecord","sig":"(Text[30], Guid, var Record All Profile)","named":"(ProfileID: Text[30]; ProfileAppID: Guid; var TempAllProfile: Record \"All Profile\" temporary)","returns":"","kind":"procedure","access":"public","obsolete":null,"range":"27-29","first":27,"last":29,"obsoleteSince":null,"spans":[{"from":27,"to":29,"named":"(ProfileID: Text[30]; ProfileAppID: Guid; var TempAllProfile: Record \"All Profile\" temporary)","returns":"","kind":"procedure","access":"public","obsolete":null}]},{"name":"SetProfile","sig":"(Guid, Text, Guid)","named":"(AgentUserSecurityID: Guid; ProfileID: Text; ProfileAppID: Guid)","returns":"","kind":"procedure","access":"public","obsolete":null,"range":"27-29","first":27,"last":29,"obsoleteSince":null,"spans":[{"from":27,"to":29,"named":"(AgentUserSecurityID: Guid; ProfileID: Text; ProfileAppID: Guid)","returns":"","kind":"procedure","access":"public","obsolete":null}]},{"name":"UpdateLocalizationSettings","sig":"(Guid, Integer, Integer, Text[180])","named":"(AgentUserSecurityID: Guid; LanguageID: Integer; LocaleID: Integer; TimeZone: Text[180])","returns":"","kind":"procedure","access":"public","obsolete":null,"range":"27-29","first":27,"last":29,"obsoleteSince":null,"spans":[{"from":27,"to":29,"named":"(AgentUserSecurityID: Guid; LanguageID: Integer; LocaleID: Integer; TimeZone: Text[180])","returns":"","kind":"procedure","access":"public","obsolete":null}]},{"name":"UpdateLocalizationSettings","sig":"(Guid, var Record User Settings)","named":"(AgentUserSecurityID: Guid; var NewUserSettingsRec: Record \"User Settings\")","returns":"","kind":"procedure","access":"public","obsolete":null,"range":"27-29","first":27,"last":29,"obsoleteSince":null,"spans":[{"from":27,"to":29,"named":"(AgentUserSecurityID: Guid; var NewUserSettingsRec: Record \"User Settings\")","returns":"","kind":"procedure","access":"public","obsolete":null}]},{"name":"GetUserSettings","sig":"(Guid, var Record User Settings)","named":"(AgentUserSecurityID: Guid; var UserSettingsRec: Record \"User Settings\")","returns":"","kind":"procedure","access":"public","obsolete":null,"range":"27-29","first":27,"last":29,"obsoleteSince":null,"spans":[{"from":27,"to":29,"named":"(AgentUserSecurityID: Guid; var UserSettingsRec: Record \"User Settings\")","returns":"","kind":"procedure","access":"public","obsolete":null}]},{"name":"CanShowMonetizationData","sig":"()","named":"()","returns":"Boolean","kind":"procedure","access":"public","obsolete":null,"range":"27","first":27,"last":27,"obsoleteSince":null,"spans":[{"from":27,"to":27,"named":"()","returns":"Boolean","kind":"procedure","access":"public","obsolete":null}]},{"name":"AssignPermissionSets","sig":"(var Guid, var Record Access Control Buffer)","named":"(var UserSecurityID: Guid; var TempAccessControlBuffer: Record \"Access Control Buffer\" temporary)","returns":"","kind":"procedure","access":"public","obsolete":null,"range":"27-29","first":27,"last":29,"obsoleteSince":null,"spans":[{"from":27,"to":29,"named":"(var UserSecurityID: Guid; var TempAccessControlBuffer: Record \"Access Control Buffer\" temporary)","returns":"","kind":"procedure","access":"public","obsolete":null}]},{"name":"GetPermissionSets","sig":"(Guid, var Record Access Control Buffer)","named":"(AgentUserSecurityID: Guid; var TempAccessControlBuffer: Record \"Access Control Buffer\" temporary)","returns":"","kind":"procedure","access":"public","obsolete":null,"range":"27-29","first":27,"last":29,"obsoleteSince":null,"spans":[{"from":27,"to":29,"named":"(AgentUserSecurityID: Guid; var TempAccessControlBuffer: Record \"Access Control Buffer\" temporary)","returns":"","kind":"procedure","access":"public","obsolete":null}]},{"name":"GetAgent","sig":"(var Record Agent, Guid)","named":"(var Agent: Record Agent; UserSecurityID: Guid)","returns":"","kind":"procedure","access":"public","obsolete":null,"range":"27-29","first":27,"last":29,"obsoleteSince":null,"spans":[{"from":27,"to":29,"named":"(var Agent: Record Agent; UserSecurityID: Guid)","returns":"","kind":"procedure","access":"public","obsolete":null}]},{"name":"OpenSetupPageId","sig":"(Enum Agent Metadata Provider, Guid)","named":"(AgentMetadataProvider: Enum \"Agent Metadata Provider\"; AgentUserSecurityID: Guid)","returns":"","kind":"procedure","access":"public","obsolete":null,"range":"27-29","first":27,"last":29,"obsoleteSince":null,"spans":[{"from":27,"to":29,"named":"(AgentMetadataProvider: Enum \"Agent Metadata Provider\"; AgentUserSecurityID: Guid)","returns":"","kind":"procedure","access":"public","obsolete":null}]},{"name":"GetAccessControlForSingleCompany","sig":"(Guid, var Text[30])","named":"(AgentUserSecurityID: Guid; var SingleCompanyName: Text[30])","returns":"Boolean","kind":"procedure","access":"public","obsolete":null,"range":"27-29","first":27,"last":29,"obsoleteSince":null,"spans":[{"from":27,"to":29,"named":"(AgentUserSecurityID: Guid; var SingleCompanyName: Text[30])","returns":"Boolean","kind":"procedure","access":"public","obsolete":null}]},{"name":"GetCopilotAvailabilityDisplayText","sig":"(Record Agent)","named":"(Agent: Record Agent)","returns":"Text","kind":"procedure","access":"public","obsolete":null,"range":"27-29","first":27,"last":29,"obsoleteSince":null,"spans":[{"from":27,"to":29,"named":"(Agent: Record Agent)","returns":"Text","kind":"procedure","access":"public","obsolete":null}]},{"name":"GetModelId","sig":"(Guid)","named":"(AgentUserSecurityID: Guid)","returns":"Code[30]","kind":"procedure","access":"public","obsolete":null,"range":"28-29","first":28,"last":29,"obsoleteSince":null,"spans":[{"from":28,"to":29,"named":"(AgentUserSecurityID: Guid)","returns":"Code[30]","kind":"procedure","access":"public","obsolete":null}]},{"name":"GetModelName","sig":"(Guid)","named":"(AgentUserSecurityID: Guid)","returns":"Text[70]","kind":"procedure","access":"public","obsolete":null,"range":"28-29","first":28,"last":29,"obsoleteSince":null,"spans":[{"from":28,"to":29,"named":"(AgentUserSecurityID: Guid)","returns":"Text[70]","kind":"procedure","access":"public","obsolete":null}]},{"name":"SetModelId","sig":"(Guid, Code[30])","named":"(AgentUserSecurityID: Guid; ModelId: Code[30])","returns":"","kind":"procedure","access":"public","obsolete":null,"range":"28-29","first":28,"last":29,"obsoleteSince":null,"spans":[{"from":28,"to":29,"named":"(AgentUserSecurityID: Guid; ModelId: Code[30])","returns":"","kind":"procedure","access":"public","obsolete":null}]},{"name":"SetModelIdToAuto","sig":"(Guid)","named":"(AgentUserSecurityID: Guid)","returns":"","kind":"procedure","access":"public","obsolete":null,"range":"28-29","first":28,"last":29,"obsoleteSince":null,"spans":[{"from":28,"to":29,"named":"(AgentUserSecurityID: Guid)","returns":"","kind":"procedure","access":"public","obsolete":null}]},{"name":"SelectAgent","sig":"(var Record Agent, Boolean)","named":"(var Agent: Record Agent; AlwaysShowUI: Boolean)","returns":"","kind":"procedure","access":"public","obsolete":null,"range":"28-29","first":28,"last":29,"obsoleteSince":null,"spans":[{"from":28,"to":29,"named":"(var Agent: Record Agent; AlwaysShowUI: Boolean)","returns":"","kind":"procedure","access":"public","obsolete":null}]},{"name":"Archive","sig":"(Guid)","named":"(AgentUserSecurityID: Guid)","returns":"","kind":"procedure","access":"public","obsolete":null,"range":"29","first":29,"last":29,"obsoleteSince":null,"spans":[{"from":29,"to":29,"named":"(AgentUserSecurityID: Guid)","returns":"","kind":"procedure","access":"public","obsolete":null}]},{"name":"IsArchived","sig":"(Guid)","named":"(AgentUserSecurityID: Guid)","returns":"Boolean","kind":"procedure","access":"public","obsolete":null,"range":"29","first":29,"last":29,"obsoleteSince":null,"spans":[{"from":29,"to":29,"named":"(AgentUserSecurityID: Guid)","returns":"Boolean","kind":"procedure","access":"public","obsolete":null}]},{"name":"ShowAgent","sig":"(Guid)","named":"(AgentUserSecurityID: Guid)","returns":"","kind":"procedure","access":"public","obsolete":null,"range":"29","first":29,"last":29,"obsoleteSince":null,"spans":[{"from":29,"to":29,"named":"(AgentUserSecurityID: Guid)","returns":"","kind":"procedure","access":"public","obsolete":null}]}]}