Page 1990 Checklist Banner
src/System Application/App/Guided Experience/src/Checklist Banner/ChecklistBanner.Page.al590 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.Environment.Configuration;using System.Environment;/// <summary>/// Lists the checklist items that a user should go through to finalize their onboarding experience./// </summary>page 1990 "Checklist Banner"{ PageType = CardPart; SourceTable = "Checklist Item Buffer"; SourceTableTemporary = true; RefreshOnActivate = true; Extensible = false; Permissions = tabledata Company = r; // ---------------------IMPORTANT--------------------------- // --------------------------------------------------------- // DO NOT CHANGE THE NAMES OF ANY OF THE FIELDS ON THIS PAGE. // THE CLIENT WILL NOT BE ABLE TO RENDER THE PAGE PROPERLY // OTHERWISE. // --------------------------------------------------------- // ---------------------IMPORTANT--------------------------- layout { area(Content) { field(Title; TitleTxt) { ApplicationArea = All; ToolTip = 'Specifies the title.'; Caption = 'Title'; } field(Header; HeaderTxt) { ApplicationArea = All; ToolTip = 'Specifies the header.'; Caption = 'Header'; } field(Description; DescriptionTxt) { ApplicationArea = All; ToolTip = 'Specifies the description.'; Caption = 'Description'; } field(TitleCollapsed; TitleCollapsedTxt) { ApplicationArea = All; ToolTip = 'Specifies the title.'; Caption = 'Title'; } field(HeaderCollapsed; HeaderCollapsedTxt) { ApplicationArea = All; ToolTip = 'Specifies the description.'; Caption = 'Description'; } field(SetupMarkAsDone; MarkChecklistAsCompleted) { ApplicationArea = All; ToolTip = 'Specifies the task as completed.'; Caption = 'Mark as completed'; trigger OnValidate() var UserChecklistStatus: Enum "Checklist Status"; begin if MarkChecklistAsCompleted then begin SetChecklistStatusAndLabels(false, false, true); ChecklistBannerImpl.UpdateUserChecklistStatus(UserId(), UserChecklistStatus::Completed); end; end; } repeater(Checklist) { Caption = 'Your checklist:'; Visible = IsChecklistInProgress; field(TaskTitle; Rec."Short Title") { ApplicationArea = All; ToolTip = 'Specifies the title.'; } field(TaskHeader; Rec.Title) { ApplicationArea = All; ToolTip = 'Specifies the header.'; } field(TaskDescription; Rec.Description) { ApplicationArea = All; ToolTip = 'Specifies the description.'; } field(TaskStatus; Rec.Status) { ApplicationArea = All; ToolTip = 'Specifies the status.'; } field(TaskStatusText; ChecklistBannerImpl.GetStatusText(Rec)) { ApplicationArea = All; Visible = Rec.Status <> Rec.Status::Started; ToolTip = 'Specifies the status.'; Caption = 'Status'; } field(TaskExclusiveWhenStarted; true) { ApplicationArea = All; ToolTip = 'Specifies the task is exclusive when started.'; Caption = 'Exclusive when started'; } field(TaskMarkAsCompleted; MarkChecklistItemAsCompleted) { ApplicationArea = All; Caption = 'Mark as completed'; ToolTip = 'Specifies the task as completed.'; Visible = IsChecklistItemStarted; trigger OnValidate() begin if MarkChecklistItemAsCompleted then ChecklistBannerImpl.UpdateChecklistItemUserStatus(Rec, UserId(), Rec.Status::Completed); ChecklistCompletionCount += 1; CheckForChecklistCompletion(); UpdateLabelTexts(); IsChecklistItemStarted := Rec.Status = Rec.Status::Started; end; } } } } actions { area(Processing) { action(ShowEarlyAccessPreviewFeatures) { ApplicationArea = All; Caption = 'Show new features and provide feedback'; ToolTip = 'Show a list of new features in the early access preview and provide feedback.'; Visible = IsEarlyAccessPreview; Image = AssessFinanceCharges; trigger OnAction() begin OnShowEarlyAccessPreviewFeatures(); end; } action(StartSetup) { ApplicationArea = All; Caption = 'Get started'; ToolTip = 'Get started'; Visible = not IsEarlyAccessPreview and not IsEvaluationCompany and not IsChecklistInProgress and not IsChecklistDisplayed and not AreAllItemsCompletedOrSkipped; Image = AssessFinanceCharges; trigger OnAction() begin OnChecklistStart(); end; } action(ShowMe) { ApplicationArea = All; Caption = 'Show demo tours'; ToolTip = 'Show demo tours'; Visible = not IsEarlyAccessPreview and IsEvaluationCompany and not IsEarlyAccessPreview and not IsChecklistInProgress and not IsChecklistDisplayed and not AreAllItemsCompletedOrSkipped; Image = AssessFinanceCharges; trigger OnAction() begin OnChecklistStart(); end; } action(CloseSetup) { ApplicationArea = All; Caption = 'Got it'; ToolTip = 'Got it'; Visible = not IsEarlyAccessPreview and not IsEvaluationCompany and AreAllItemsCompletedOrSkipped; Image = AssessFinanceCharges; trigger OnAction() begin ChecklistImplementation.SetChecklistVisibility(UserId(), false); CurrPage.Close(); end; } action(SkipSetup) { ApplicationArea = All; Caption = 'Skip checklist'; ToolTip = 'Skip checklist'; Visible = not IsEarlyAccessPreview and not IsEvaluationCompany and IsChecklistInProgress and not AreAllItemsCompletedOrSkipped; Image = AssessFinanceCharges; trigger OnAction() begin if Confirm(SkipSetupConfirmLbl) then begin ChecklistBannerImpl.UpdateUserChecklistStatus(UserId(), ChecklistStatus::Skipped); ChecklistImplementation.SetChecklistVisibility(UserId(), false); CurrPage.Close(); end; end; } action(BackToChecklist) { ApplicationArea = All; Caption = 'Back to checklist'; ToolTip = 'Back to checklist'; Visible = not IsEarlyAccessPreview and not IsChecklistDisplayed and (IsChecklistInProgress or AreAllItemsCompletedOrSkipped); Image = AssessFinanceCharges; trigger OnAction() begin OnChecklistStart(); end; } action(TaskStart) { ApplicationArea = All; Caption = 'Start'; ToolTip = 'Start'; Scope = Repeater; Visible = not IsEarlyAccessPreview and IsChecklistInProgress and ((Rec.Status = Rec.Status::"Not Started") or (Rec.Status = Rec.Status::Skipped)) and ((Rec."Guided Experience Type" = Rec."Guided Experience Type"::"Assisted Setup") or (Rec."Guided Experience Type" = Rec."Guided Experience Type"::"Manual Setup") or (Rec."Guided Experience Type" = Rec."Guided Experience Type"::"Application Feature") or (Rec."Guided Experience Type" = Rec."Guided Experience Type"::Learn)); Image = AssessFinanceCharges; trigger OnAction() begin ExecuteChecklistItem(); end; } action(TaskStartTour) { ApplicationArea = All; Caption = 'Start tour'; ToolTip = 'Start tour'; Scope = Repeater; Visible = not IsEarlyAccessPreview and IsChecklistInProgress and ((Rec.Status = Rec.Status::"Not Started") or (Rec.Status = Rec.Status::Skipped)) and ((Rec."Guided Experience Type" = Rec."Guided Experience Type"::Tour) or (Rec."Guided Experience Type" = Rec."Guided Experience Type"::"Spotlight Tour")); Image = AssessFinanceCharges; trigger OnAction() begin ExecuteChecklistItem(); end; } action(TaskWatch) { ApplicationArea = All; Caption = 'Play video'; ToolTip = 'Play video'; Scope = Repeater; Image = Start; Visible = not IsEarlyAccessPreview and IsChecklistInProgress and ((Rec.Status = Rec.Status::"Not Started") or (Rec.Status = Rec.Status::Skipped)) and (Rec."Guided Experience Type" = Rec."Guided Experience Type"::Video); trigger OnAction() begin ExecuteChecklistItem(); end; } action(TaskStartOver) { ApplicationArea = All; Caption = 'Revisit'; ToolTip = 'Revisit'; Scope = Repeater; Visible = not IsEarlyAccessPreview and IsChecklistInProgress and ((Rec.Status = Rec.Status::Started) or (Rec.Status = Rec.Status::Completed)); Image = AssessFinanceCharges; trigger OnAction() begin ExecuteChecklistItem(); end; } action(TaskSkip) { ApplicationArea = All; Caption = 'Skip for now'; ToolTip = 'Skip for now'; Scope = Repeater; Visible = not IsEarlyAccessPreview and IsChecklistInProgress and ((Rec.Status = Rec.Status::"Not Started") or (Rec.Status = Rec.Status::Started)); Image = AssessFinanceCharges; trigger OnAction() begin ChecklistBannerImpl.UpdateChecklistItemUserStatus(Rec, UserId(), Rec.Status::Skipped); ChecklistSkipCount += 1; CheckForChecklistCompletion(); UpdateLabelTexts(); end; } } } var TempChecklistItemBuffer: Record "Checklist Item Buffer"; ChecklistBannerImpl: Codeunit "Checklist Banner Impl."; ChecklistImplementation: Codeunit "Checklist Implementation"; ChecklistStatus: Enum "Checklist Status"; [RunOnClient] [WithEvents] Tour: DotNet Tour; IsEvaluationCompany: Boolean; IsEarlyAccessPreview: Boolean; IsChecklistInProgress: Boolean; AreAllItemsCompletedOrSkipped: Boolean; IsChecklistDisplayed: Boolean; IsChecklistItemStarted: Boolean; MarkChecklistItemAsCompleted: Boolean; MarkChecklistAsCompleted: Boolean; SkipWelcomePage: Boolean; TitleTxt: Text; TitleCollapsedTxt: Text; HeaderTxt: Text; HeaderCollapsedTxt: Text; DescriptionTxt: Text; SkipSetupConfirmLbl: Label 'Are you sure that you want to skip the remaining steps of the checklist?'; ChecklistCompletionCount: Integer; ChecklistSkipCount: Integer; ChecklistTotalCount: Integer; trigger OnOpenPage() var ChecklistBanner: Codeunit "Checklist Banner"; begin SetIsEvaluationCompany(); SetIsEarlyAccessPreview(); SkipWelcomePage := false; ChecklistBanner.OnOpenChecklistBannerPage(SkipWelcomePage, IsEvaluationCompany); InitializeTour(); ChecklistBannerImpl.OnChecklistBannerOpen(Rec, IsChecklistInProgress, IsChecklistDisplayed); SetCounts(); AreAllItemsCompletedOrSkipped := AreAllChecklistItemsCompletedOrSkipped(); if SkipWelcomePage and (not IsChecklistInProgress) and (not AreAllItemsCompletedOrSkipped) then OnChecklistStart(); if Rec.Count > 0 then UpdateLabelTexts(); SetChecklistRecord(); TempChecklistItemBuffer.Copy(Rec, true); CurrPage.Update(false); end; trigger OnAfterGetCurrRecord() begin IsChecklistItemStarted := (Rec.Status = Rec.Status::Started) and (not (Rec."Guided Experience Type" in [Rec."Guided Experience Type"::Tour, Rec."Guided Experience Type"::"Spotlight Tour"])); end; trigger OnAfterGetRecord() begin MarkChecklistItemAsCompleted := Rec.Status = Rec.Status::Completed; IsChecklistItemStarted := (Rec.Status = Rec.Status::Started) and (not (Rec."Guided Experience Type" in [Rec."Guided Experience Type"::Tour, Rec."Guided Experience Type"::"Spotlight Tour"])); end; trigger OnClosePage() begin if ChecklistBannerImpl.IsUserChecklistStatusComplete(UserId) then ChecklistImplementation.SetChecklistVisibility(UserId(), false); end; trigger Tour::TourEnded(PageId: Integer; Completed: Boolean; Data: Text) var ChecklistItemCode: Code[300]; begin MarkTourAsDone(Data); ChecklistItemCode := 'dummy value'; // this line is here because of bug 409754 end; trigger Tour::SpotlightTourEnded(PageId: Integer; SpotlightTour: DotNet SpotlightTour; Completed: Boolean; Data: Text) var ChecklistItemCode: Code[300]; begin MarkTourAsDone(Data); ChecklistItemCode := 'dummy value'; // this line is here because of bug 409754 end; local procedure InitializeTour() begin if Tour.IsAvailable() then Tour := Tour.Create(); end; local procedure SetIsEvaluationCompany() var Company: Record Company; begin if Company.Get(CompanyName()) then IsEvaluationCompany := Company."Evaluation Company"; end; local procedure SetIsEarlyAccessPreview() var EnvironmentInformation: Codeunit "Environment Information"; begin IsEarlyAccessPreview := EnvironmentInformation.IsEarlyPreview(); end; local procedure OnChecklistStart() begin ChecklistBannerImpl.UpdateUserChecklistStatus(UserId(), ChecklistStatus::"In progress"); SetChecklistStatusAndLabels(true, true, AreAllChecklistItemsCompletedOrSkipped()); SetChecklistRecord(); CurrPage.Update(false); end; local procedure OnShowEarlyAccessPreviewFeatures() begin Page.Run(Page::"Early Access Preview Features"); end; local procedure SetChecklistRecord() begin Rec.SetRange(Status, Rec.Status::Started); if Rec.FindFirst() then CurrPage.SetRecord(Rec) else begin Rec.SetRange(Status, Rec.Status::"Not Started"); if Rec.FindFirst() then CurrPage.SetRecord(Rec); end; Rec.Reset(); Rec.SetCurrentKey("Order ID"); end; local procedure SetChecklistStatusAndLabels(ChecklistInProgress: Boolean; ChecklistDisplayed: Boolean; AllItemsSkippedOrCompleted: Boolean) begin IsChecklistInProgress := ChecklistInProgress; IsChecklistDisplayed := ChecklistDisplayed; AreAllItemsCompletedOrSkipped := AllItemsSkippedOrCompleted; UpdateLabelTexts(); end; local procedure UpdateLabelTexts() var ChecklistBanner: Codeunit "Checklist Banner"; IsHandled: Boolean; begin IsHandled := false; ChecklistBanner.OnBeforeUpdateBannerLabels(IsHandled, IsEvaluationCompany, TitleTxt, TitleCollapsedTxt, HeaderTxt, HeaderCollapsedTxt, DescriptionTxt, IsChecklistInProgress, AreAllItemsCompletedOrSkipped); if not IsHandled then ChecklistBannerImpl.UpdateBannerLabels(IsEvaluationCompany, Rec, TitleTxt, TitleCollapsedTxt, HeaderTxt, HeaderCollapsedTxt, DescriptionTxt, IsChecklistInProgress, AreAllItemsCompletedOrSkipped); end; local procedure CheckForChecklistCompletion() begin AreAllItemsCompletedOrSkipped := AreAllChecklistItemsCompletedOrSkipped(); if AreAllItemsCompletedOrSkipped and not IsEvaluationCompany then begin ChecklistBannerImpl.UpdateUserChecklistStatus(UserId(), ChecklistStatus::Completed); IsChecklistDisplayed := false; end; end; local procedure AreAllChecklistItemsCompletedOrSkipped(): Boolean begin exit(ChecklistCompletionCount + ChecklistSkipCount = ChecklistTotalCount); end; local procedure SetCounts() begin ChecklistTotalCount := Rec.Count; Rec.SetFilter(Status, '=%1', Rec.Status::Skipped); ChecklistSkipCount := Rec.Count; Rec.SetFilter(Status, '=%1', Rec.Status::Completed); ChecklistCompletionCount := Rec.Count; SetChecklistRecord(); end; local procedure UpdateChecklistCountsAfterStatusUpdate(OldStatus: Enum "Checklist Item Status") begin if OldStatus = OldStatus::Skipped then ChecklistSkipCount -= 1 else if OldStatus = OldStatus::Completed then ChecklistCompletionCount -= 1; end; local procedure ExecuteChecklistItem() var IsLastChecklistItem: Boolean; begin UpdateChecklistCountsAfterStatusUpdate(Rec.Status); if TempChecklistItemBuffer.FindLast() then if TempChecklistItemBuffer.Code = Rec.Code then IsLastChecklistItem := true; if ChecklistBannerImpl.ExecuteChecklistItem(Rec, Tour, IsLastChecklistItem) then ChecklistCompletionCount += 1; CheckForChecklistCompletion(); UpdateLabelTexts(); end; local procedure MarkTourAsDone(Data: Text) var ChecklistItemCode: Code[300]; begin if not Evaluate(ChecklistItemCode, Data) then exit; if Rec.Code <> ChecklistItemCode then begin Rec.SetRange(Code, ChecklistItemCode); if Rec.FindFirst() then; end; ChecklistBannerImpl.UpdateChecklistItemUserStatus(Rec, UserId(), Rec.Status::Completed); ChecklistCompletionCount += 1; CheckForChecklistCompletion(); UpdateLabelTexts(); end;}