Interface IAgentMetadata

Namespace: System.Agents

Provides metadata for individual agents, including UI configuration, page context, and runtime annotations. Implementations define how agent-specific details are retrieved and displayed in the system.

Remarks

Implementations provide agent-specific UI configuration including initials, setup pages, and summary views. Handles agent task user intervention suggestions and page context management. Essential for agent runtime operations and user interface customization. Integrates with agent task messaging and page context systems.

Methods

GetInitials

Returns the initials to be displayed on the icon opening the agent's timeline.

procedure GetInitials(AgentUserId: Guid): Text[4]

Parameters

Name Type Description
AgentUserId Guid

The agent user id.

Returns

Type Description
Text[4]

The initials.

GetSetupPageId

Returns the ID of the page that is used to configure the agent.

procedure GetSetupPageId(AgentUserId: Guid): Integer

Parameters

Name Type Description
AgentUserId Guid

The agent user id.

Returns

Type Description
Integer

The setup page ID.

Remarks

The source table of the page must contain a field named "User Security ID" of type Guid. This field is used by the runtime to provide the agent user ID when the page is opened.

GetSummaryPageId

Returns the page to be used to summarize an agent's activity.

procedure GetSummaryPageId(AgentUserId: Guid): Integer

Parameters

Name Type Description
AgentUserId Guid

The agent user id.

Returns

Type Description
Integer

The summary page ID.

Remarks

The source table of the page must contain a field named "User Security ID" of type Guid. This field is used by the runtime to provide the agent user ID when the page is opened.

GetAgentTaskMessagePageId

Returns the ID of the page that is used to display agent task messages for this agent.

procedure GetAgentTaskMessagePageId(AgentUserId: Guid; MessageId: Guid): Integer

Parameters

Name Type Description
AgentUserId Guid

The agent user id.
MessageId Guid

The ID of the message to display.

Returns

Type Description
Integer

The ID of the page that is used to display agent task messages

Remarks

The source table of the page must be the <see cref="Agent Task Message"></see> table.

GetAgentAnnotations

Returns the list of annotations to be displayed for the agents.

procedure GetAgentAnnotations(AgentUserId: Guid; var Annotations: Record "Agent Annotation")

Parameters

Name Type Description
AgentUserId Guid

The agent user id.
Annotations Table System.Agents."Agent Annotation"

The annotations to be added to the agent.

Remarks

These annotations are not persisted on the agent. The server regularly asks for the agent-level annotations.

See also