Page 4333 Agent Consumption Overview, source in 27
Source272829metadata in 27
src/System Application/App/Agent/Monetization/AgentConsumptionOverview.Page.al479 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.Agents.Troubleshooting;
using System.Environment.Consumption;
using System.Security.AccessControl;
/// <summary>
/// This page is showing Copilot credit consumption per agent or per agent task
/// </summary>
page 4333 "Agent Consumption Overview"
{
PageType = Worksheet;
ApplicationArea = All;
SourceTable = "User AI Consumption Data";
Caption = 'Agent consumption overview';
InherentEntitlements = X;
InherentPermissions = X;
SourceTableView = sorting("Consumption DateTime") order(descending);
Permissions = tabledata User = r;
InsertAllowed = false;
ModifyAllowed = false;
DeleteAllowed = false;
layout
{
area(Content)
{
group(Filters)
{
ShowCaption = false;
Visible = ShowFilters;
field(StartDateControl; StartDate)
{
ApplicationArea = All;
Caption = 'Start date';
ToolTip = 'Specifies the start date for filtering the consumption data.';
trigger OnValidate()
begin
UpdateDateRange(StartDate, EndDate);
CurrPage.Update(false);
end;
}
field(EndDateControl; EndDate)
{
ApplicationArea = All;
Caption = 'End date';
ToolTip = 'Specifies the end date for filtering the consumption data.';
trigger OnValidate()
begin
UpdateDateRange(StartDate, EndDate);
CurrPage.Update(false);
end;
}
}
repeater(GroupName)
{
Editable = false;
field(ConsumptionDateTime; Rec."Consumption DateTime")
{
Caption = 'Created at';
ToolTip = 'Specifies the date and time when the consumption was created.';
}
field(Credits; Rec."Copilot Credits")
{
AutoFormatType = 0;
DecimalPlaces = 0 : 2;
Caption = 'Copilot credits';
}
field("Company Name"; Rec."Company Name")
{
Visible = false;
Caption = 'Company name';
}
field(Agent; Rec."Feature Name")
{
Caption = 'Resource name';
ToolTip = 'Specifies the name of the resource that consumed the credits. This is typically the type of the agent that performed the operation.';
}
field(UserName; UserName)
{
Caption = 'User name';
ToolTip = 'Specifies the name of the user who performed the operation.';
}
field(Operation; Rec."Actions")
{
Caption = 'Actions';
}
field(Description; DescriptionTxt)
{
Caption = 'Description';
ToolTip = 'Specifies the description of the operation';
}
field(CopilotStudioFeature; Rec."Copilot Studio Feature Display Name")
{
Caption = 'Copilot Studio feature';
}
field("Agent Task ID"; Rec."Agent Task ID")
{
Caption = 'Agent task ID';
Enabled = not FilteredToTask;
trigger OnDrillDown()
begin
DrillDownToAgentTaskConsumption();
end;
}
}
group(TotalsFooterOuterGroup)
{
Visible = TotalsVisible;
ShowCaption = false;
grid(TotalsFooterGroup)
{
ShowCaption = false;
Editable = false;
GridLayout = columns;
grid(TotalLinesGroup)
{
Caption = 'Entries';
GridLayout = Columns;
group(DescriptionGroup)
{
ShowCaption = false;
field(ConsumptionCaption; ConsumptionCaption)
{
Caption = 'Consumption overview for';
Editable = false;
Style = Strong;
ToolTip = 'Specifies for what the consumption data is displayed.';
}
group(DateRangeGroup)
{
ShowCaption = false;
Visible = not FilteredToTask;
field(DateRange; DateRangeTxt)
{
Caption = 'Date range';
Editable = false;
ToolTip = 'Specifies the date range for the consumption data.';
}
}
group(TotalEntriesTaskGroup)
{
ShowCaption = false;
Visible = FilteredToTask;
field(TotalEntriesTask; TotalEntriesCount)
{
Caption = 'Number of entries';
Editable = false;
ToolTip = 'Specifies the total number of entries.';
}
}
}
group(TotalCopilotCreditsGroup)
{
ShowCaption = false;
Visible = not FilteredToTask;
field(TotalEntries; TotalEntriesCount)
{
Caption = 'Number of entries';
Editable = false;
ToolTip = 'Specifies the total number of entries.';
}
field(TotalCopilotCredits; TotalEntriesCopilotCredits)
{
Caption = 'Total Copilot credits';
AutoFormatType = 0;
DecimalPlaces = 0 : 2;
Editable = false;
ToolTip = 'Specifies the total number of Copilot credits consumed.';
}
}
group(TotalTaskConsumedCreditsGroup)
{
ShowCaption = false;
field(TaskName; TaskNameTxt)
{
Caption = 'Task';
Editable = false;
ToolTip = 'Specifies the title of the agent task.';
trigger OnDrillDown()
begin
DrillDownToAgentTask();
end;
}
group(TaskTotalCredits)
{
ShowCaption = false;
field(TotalTaskCredits; TotalTaskConsumedCredits)
{
AutoFormatType = 0;
DecimalPlaces = 0 : 2;
Caption = 'Total task Copilot credits';
Editable = false;
ToolTip = 'Specifies the total number of Copilot credits consumed by the agent task.';
trigger OnDrillDown()
begin
DrillDownToAgentTaskConsumption();
end;
}
}
}
}
}
}
}
}
actions
{
area(Processing)
{
action(PreviousMonth)
{
Visible = ShowFilters;
ApplicationArea = All;
Caption = 'Previous month';
ToolTip = 'Move the date range filter to the previous month.';
Image = PreviousSet;
trigger OnAction()
begin
StartDate := CalcDate('<-1M-CM>', StartDate);
EndDate := CalcDate('<CM>', StartDate);
UpdateDateRange(StartDate, EndDate);
Clear(TaskNameTxt);
Clear(TotalTaskConsumedCredits);
CurrPage.Update(false);
end;
}
action(NextMonth)
{
Visible = ShowFilters;
ApplicationArea = All;
Caption = 'Next month';
ToolTip = 'Move the date range filter to the next month.';
Image = NextSet;
trigger OnAction()
begin
if EndDate >= CalcDate('<CM>', Today()) then begin
Message(TheEndDateIsTodayMsg);
exit;
end;
StartDate := CalcDate('<+1M-CM>', StartDate);
EndDate := CalcDate('<CM>', StartDate);
if EndDate > Today() then
EndDate := Today();
UpdateDateRange(StartDate, EndDate);
CurrPage.Update(false);
end;
}
action(CurrentMonth)
{
Visible = ShowFilters;
ApplicationArea = All;
Caption = 'Current month';
ToolTip = 'Move the date range filter to the current month.';
Image = Calendar;
trigger OnAction()
begin
SetDateRangeFilters();
CurrPage.Update(false);
end;
}
}
area(Promoted)
{
group(Category_Process)
{
actionref(PreviousMonth_Promoted; PreviousMonth)
{
}
actionref(NextMonth_Promoted; NextMonth)
{
}
actionref(CurrentMonth_Promoted; CurrentMonth)
{
}
}
}
}
trigger OnOpenPage()
var
AgentImpl: Codeunit "Agent Impl.";
begin
if not AgentImpl.CanShowMonetizationData() then
Error(YourNotAuthorizedToViewMonetizationDataErr);
SetDateRangeFilters();
OnGetTotalsVisible(TotalsVisible, FilteredToTask);
end;
trigger OnAfterGetRecord()
begin
UpdateRowValues();
end;
trigger OnAfterGetCurrRecord()
begin
UpdateAgentTaskName();
UpdateTheDescriptionAndTotalsVisibility();
UpdateTotals();
end;
local procedure UpdateRowValues()
var
User: Record User;
DescriptionInStream: InStream;
begin
Rec.CalcFields(Description);
Rec.Description.CreateInStream(DescriptionInStream, TextEncoding::UTF8);
DescriptionInStream.ReadText(DescriptionTxt);
if not UserNameDictionary.ContainsKey(Rec."User Id") then begin
if User.Get(Rec."User Id") then begin
UserName := User."User Name";
UserNameDictionary.Add(Rec."User Id", UserName);
end else
UserName := '';
exit;
end;
UserName := UserNameDictionary.Get(Rec."User Id");
end;
local procedure UpdateAgentTaskName()
var
AgentTask: Record "Agent Task";
begin
if not AgentTaskDictionary.ContainsKey(Rec."Agent Task ID") then begin
if AgentTask.Get(Rec."Agent Task ID") then begin
TaskNameTxt := StrSubstNo(AgentTaskNameTxt, AgentTask.ID, AgentTask.Title);
AgentTaskDictionary.Add(Rec."Agent Task ID", TaskNameTxt);
end else
TaskNameTxt := '';
exit;
end;
TaskNameTxt := AgentTaskDictionary.Get(Rec."Agent Task ID");
end;
local procedure UpdateTotals()
var
UserAIConsumptionData: Record "User AI Consumption Data";
begin
if not TotalsVisible then
exit;
TotalEntriesCount := Rec.Count();
UserAIConsumptionData.Copy(Rec);
UserAIConsumptionData.CalcSums("Copilot Credits");
TotalEntriesCopilotCredits := UserAIConsumptionData."Copilot Credits";
UserAIConsumptionData.Copy(Rec);
UserAIConsumptionData.SetRange("Agent Task Id", Rec."Agent Task ID");
UserAIConsumptionData.CalcSums("Copilot Credits");
TotalTaskConsumedCredits := UserAIConsumptionData."Copilot Credits";
end;
local procedure UpdateTheDescriptionAndTotalsVisibility()
begin
TotalsVisible := true;
FilteredToTask := false;
ShowFilters := true;
if (Rec.GetFilter("User Id") = '') and (Rec.GetFilter("Agent Task Id") = '') then begin
ChangedDateRangeFilters := false;
ConsumptionCaption := EverythingTok;
TotalsVisible := false;
FilteredToTask := false;
exit;
end;
if Rec.GetFilter("Agent Task Id") <> '' then begin
ConsumptionCaption := TaskNameTxt;
FilteredToTask := true;
ShowFilters := false;
ClearDateRangeFilters();
exit;
end;
if Rec.GetFilter("User Id") <> '' then begin
ConsumptionCaption := StrSubstNo(UserName);
FilteredToTask := false;
exit;
end;
end;
local procedure SetDateRangeFilters()
begin
if ChangedDateRangeFilters then
exit;
if Rec.GetFilter("Agent Task Id") = '' then begin
EndDate := Today();
StartDate := CalcDate(StartDateTok, Today());
UpdateDateRange(StartDate, EndDate);
DateRangeTxt := Format(StartDate) + ' - ' + Format(EndDate);
end;
end;
local procedure ClearDateRangeFilters()
begin
Rec.SetRange("Consumption DateTime");
Clear(StartDate);
Clear(EndDate);
end;
local procedure UpdateDateRange(NewStartDate: Date; NewEndDate: Date)
begin
StartDate := NewStartDate;
EndDate := NewEndDate;
Rec.SetRange("Consumption DateTime", CreateDateTime(StartDate, 0T), CreateDateTime(EndDate, 235959.999T));
end;
local procedure DrillDownToAgentTask()
var
AgentTaskLogEntry: Record "Agent Task Log Entry";
begin
AgentTaskLogEntry.SetRange("Task ID", Rec."Agent Task Id");
Page.Run(Page::"Agent Task Log Entry List", AgentTaskLogEntry)
end;
local procedure DrillDownToAgentTaskConsumption()
var
UserAIConsumptionData: Record "User AI Consumption Data";
begin
UserAIConsumptionData.SetRange("Agent Task Id", Rec."Agent Task ID");
Page.Run(Page::"Agent Consumption Overview", UserAIConsumptionData);
end;
[IntegrationEvent(false, false)]
local procedure OnGetTotalsVisible(var TotalsVisible: Boolean; var AgentTaskTotalsVisible: Boolean)
begin
end;
var
AgentTaskDictionary: Dictionary of [BigInteger, Text];
UserNameDictionary: Dictionary of [Guid, Text[80]];
ChangedDateRangeFilters: Boolean;
StartDate: Date;
EndDate: Date;
DescriptionTxt: Text;
UserName: Text[80];
TotalEntriesCount: Integer;
TaskNameTxt: Text;
FilteredToTask: Boolean;
TotalEntriesCopilotCredits: Decimal;
TotalTaskConsumedCredits: Decimal;
ConsumptionCaption: Text;
DateRangeTxt: Text;
ShowFilters: Boolean;
TotalsVisible: Boolean;
EverythingTok: Label 'Everything';
AgentTaskNameTxt: Label 'Task #%1 - %2', Comment = '%1 - ID of the agent task, %2 - Title of the agent task';
YourNotAuthorizedToViewMonetizationDataErr: Label 'You are missing the required permissions to view monetization data.';
TheEndDateIsTodayMsg: Label 'The end date is already set to today. You cannot move the date range filter further.';
StartDateTok: Label '<-CM>', Locked = true;
}