Study guide

10.3 Assisted Setup, Guided Experience & Onboarding Checklists

Microsoft Dynamics 365 Business Central Developer MB-820

Track your progress as you read

Finished sections get a check mark.

1 Chapter 1: Business Central Architecture & Platform Foundation

1.1 Business Central Architecture & Extensions Model 1.2 Customization Lifecycle: Cloud (SaaS) vs. On-Premises 1.3 Base Application, System Application & AppSource

2 Chapter 2: Development Environment & Configuration

2.1: Development Environment Setup: VS Code, AL: Go! Projects & Sandboxes 2.2: AL Configuration Files: app.json & launch.json Parameters 2.3: Multi-Root Workspaces & Project Dependencies

3 Chapter 3: Extension Lifecycle: Debugging, Deployment, Multilanguage & Maintenance

3.1 Debugging & Snapshot Debugging in Visual Studio Code 3.2 Extension Deployment & Schema Synchronization Modes 3.3 Multilanguage Development with XLIFF & Translation Files 3.4 Extension Maintenance, Deprecation & Breaking Changes

4 Chapter 4: Tables, Table Extensions & Data Modeling

4.1: Building Tables, Fields, Keys & Data Types 4.2: Table Extensions & Table Modifications 4.3: FlowFields, FlowFilters & Table Relations 4.4: Enums, Enum Extensions & Extensible Types

5 Chapter 5: Pages, Page Extensions & Role Centers

5.1: Page Types, Anatomy & Control Structure 5.2: Building Card, List & Document Pages 5.3: Page Extensions & Page Customizations 5.4: Role Centers, Headlines & Cue Data Modeling

6 Chapter 6: Reports & Document Generation

6.1 Report Architecture, DataItems & Dataset Design 6.2 Report Layouts: RDLC, Word, Excel & Multilanguage 6.3 Document Reports & Request Page Programming 6.4 Processing-Only Reports & Report Substitutions

7 Chapter 7: XMLports & Data Exchange

7.1 XMLport Architecture, Formats & Properties 7.2 XMLport Node Hierarchy, Triggers & Stream Manipulation

8 Chapter 8: Codeunits, Events, Triggers & Interfaces

8.1 Codeunit Types, Execution & SingleInstance Codeunits 8.2 Events, Publishers, Subscribers & Event Isolation 8.3 Interfaces, Polymorphism & Dynamic Codeunit Invocation 8.4 Installation & Upgrade Codeunits, Data Transfer & Archive

9 Chapter 9: Entitlements, Permissions & Queries

9.1 Permission Sets & Permission Set Extensions 9.2 Inherent Permissions, Inherent Entitlements & Security Scoping 9.3 Query Objects: Joins, Aggregation & Query as Report Data Source

10 Chapter 10: UI Customization, User Assistance & Onboarding

10.1 Profile Objects & Custom Page Views in AL 10.2 User Assistance: ToolTips, Teaching Tips & In-App Tours 10.3 Assisted Setup, Guided Experience & Onboarding Checklists

11 Chapter 11: Business Central Design Patterns & Data Process Model

11.1 Functional Table Types: Master Data, Supplemental & Setup Patterns 11.2 Document Standards: Header, Line, History & Journal Architectures 11.3 Data Process Model & Posting Routine Architecture

12 Chapter 12: AL Language Fundamentals, Data Types & Variables

12.1 AL Syntax, Variable Scope, Primitive & Complex Data Types 12.2 Expressions, Control Flow Statements & Built-in Functions 12.3 Access Modifiers (Public, Internal, Local) & Code Scoping

13 Chapter 13: Data Manipulation, Streams & Error Handling

13.1 Record Operations: Get, FindSet, ModifyAll & Filter Functions 13.2 Streams, File Management & TempBlob 13.3 Error Handling: ErrorInfo, TryFunctions & Collectible Errors

14 Chapter 14: Testing, Test Toolkit & Automation

14.1 Testing Architecture & the Test Toolkit 14.2 Authoring Test Codeunits & UI Handler Functions

15 Chapter 15: Telemetry, Performance Optimization & Analyzers

15.1 Telemetry Configuration & Azure Application Insights 15.2 Custom Telemetry Signals with Session.LogMessage & KQL 15.3 Performance Profiler, SetLoadFields & Query Optimization 15.4 AL Analyzers: CodeCop, AppSourceCop, UICop & PTECop

16 Chapter 16: REST Web Services & JSON in AL

16.1 HttpClient, HttpRequestMessage & REST API Consumption 16.2 JSON Processing: JsonObject, JsonArray, JsonValue & JsonToken

17 Chapter 17: API Pages, OData, Read Scale-Out & OAuth

17.1 API Pages (PageType=API), OData Web Services & REST Endpoints 17.2 Bound and Unbound OData Actions with [ServiceEnabled] 17.3 Read Scale-Out Architecture & DataAccessIntent Configuration 17.4 Microsoft Entra ID App Registrations & OAuth 2.0 Integration

10.3 Assisted Setup, Guided Experience & Onboarding Checklists

Key Takeaways Explain This Topic AI

The Guided Experience framework in the System Application centralizes registration of Assisted Setup wizards, manual setup pages, videos, tours, and tutorials.

Assisted Setup wizards are registered by subscribing to the OnRegisterAssistedSetup event on Codeunit 'Guided Experience' and invoking GuidedExperience.InsertAssistedSetup().

The Guided Experience Type and Manual Setup Category enums categorize onboarding experiences and organize them logically within the Assisted Setup page.

Multi-step wizards are built using PageType = NavigatePage, with navigation actions marked with InFooterBar = true and completion state recorded via GuidedExperience.CompleteAssistedSetup().

Role Center Onboarding Checklists display curated getting-started tasks for specific user profiles, with tenant administrators able to customize, reorder, and assign items in the Web Client.

Last updated: August 2026

10.3 Assisted Setup, Guided Experience & Onboarding Checklists

When a customer provisions a new Microsoft Dynamics 365 Business Central environment or installs a third-party AppSource extension, configuring initial settings correctly is critical to achieving fast time-to-value. Rather than forcing administrators to search through complex menus to locate setup tables, Business Central provides the Guided Experience framework in the System Application. This architecture powers the standard Assisted Setup page and dynamic Onboarding Checklists on Role Centers.

1. The Guided Experience Framework Architecture

The Guided Experience module (part of the Microsoft System Application) provides a centralized, extensible registry for all onboarding and configuration workflows across Business Central.

Core Enums in the Guided Experience Framework

"Guided Experience Type" : Categorizes the type of onboarding experience:

"Assisted Setup" : A multi-step configuration wizard (typically an AL page with PageType = NavigatePage ).

"Manual Setup" : A standard setup card or worksheet page where users configure settings manually.

"Learn" : A hyperlink to external conceptual documentation or Microsoft Learn training.

"Tour" : An interactive In-App teaching tip tour.

"Video" : An instructional video link.

"Application Feature" : A direct shortcut to a core functional feature area.

"Manual Setup Category" : Specifies the functional grouping in the Assisted Setup page ( General , Finance , Sales , Purchasing , Inventory , Fixed Assets , HR , System , etc.). ┌───────────────────────────────────────────────────────────────────────┐

  • │ System App: Guided Experience │
  • └───────────────────────────────────────────────────────────────────────┘
  • │ │
  • ▼ ▼
  • ┌───────────────────────────────┐ ┌───────────────────────┐
  • │ Assisted Setup Page │ │ Role Center Checklist │
  • │ (All Registered System Wizards│ │ (Curated Onboarding │
  • │ & Manual Configuration Links)│ │ Tasks for User Role) │
  • └───────────────────────────────┘ └───────────────────────┘

Loading diagram... Assisted Setup Wizard Registration and Completion Lifecycle

2. Registering Assisted Setup Wizards in AL

To add an extension's configuration wizard into the standard Assisted Setup page, developers subscribe to the OnRegisterAssistedSetup event published by the Guided Experience codeunit.

  • Assisted Setup Registration Pattern codeunit 50135 "Loyalty Guided Exp Subscriber"
  • {

[EventSubscriber(ObjectType::Codeunit, Codeunit::"Guided Experience", 'OnRegisterAssistedSetup', '', false, false)]

  • local procedure RegisterLoyaltyAssistedSetup()
  • var
  • GuidedExperience: Codeunit "Guided Experience";
  • Language: Codeunit Language;
  • CurrentGlobalLanguage: Integer;
  • begin
  • // Ensure registration strings use application language context
  • CurrentGlobalLanguage := GlobalLanguage();
  • GuidedExperience.InsertAssistedSetup(
  • 'Set up Customer Loyalty Management', // Title (Mandatory)
  • 'Loyalty Program Setup', // Short Title

'Configure loyalty reward tiers, point calculation formulas, and general ledger redemption accounts.', // Description

  • 10, // Expected Duration (minutes)
  • ObjectType::Page, // Object Type
  • Page::"Loyalty Setup Wizard", // Object ID (NavigatePage)
  • "Guided Experience Type"::"Assisted Setup", // Experience Type
  • 'https://www.youtube.com/embed/loyalty_setup_tutorial', // Video URL
  • 3, // Video Duration (minutes)
  • 'https://learn.microsoft.com/dynamics365/business-central/', // Help / Documentation URL
  • "Manual Setup Category"::Sales // Setup Category
  • );
  • end;
  • }
  • GuidedExperience.InsertAssistedSetup Method Parameters Breakdown

Parameter Type Description & Purpose

Title Text[2048] The primary descriptive name of the setup displayed in the Assisted Setup list and checklist banner.

ShortTitle Text[50] A concise title used when space is constrained (e.g., inside compact checklist tiles).

Description Text[1024] Detailed explanation of what settings and business capabilities this wizard configures.

ExpectedDuration Integer Estimated completion time in minutes displayed to users (e.g., 5 or 10 ).

ObjectType ObjectType The object type to execute (typically ObjectType::Page ).

ObjectID Integer The Page ID of the setup wizard (usually a page with PageType = NavigatePage ).

GuidedExperienceType Enum Identifies the experience category ( "Guided Experience Type"::"Assisted Setup" ).

VideoUrl Text[250] Optional URL to an instructional video stream.

VideoDuration Integer Optional duration of the tutorial video in minutes.

HelpUrl Text[250] URL pointing to online documentation for in-depth setup guidelines.

ManualSetupCategory Enum Functional category grouping under which the wizard appears on the Assisted Setup page.

3. Developing Multi-Step Setup Wizards ( PageType = NavigatePage )

In Business Central, wizards are built using pages with PageType = NavigatePage . A NavigatePage presents a modal dialog with custom banner graphics, step containers shown/hidden based on state, and bottom navigation buttons ( Back , Next , Finish ). page 50140 "Loyalty Setup Wizard"

  • {
  • PageType = NavigatePage;
  • Caption = 'Customer Loyalty Setup Wizard';
  • SourceTable = "Loyalty Setup";
  • layout
  • {
  • area(Content)
  • {
  • // Step 1: Welcome & Introduction
  • group(Step1Intro)
  • {
  • Visible = (CurrentStep = 1);
  • group(WelcomeText)
  • {
  • Caption = 'Welcome to Loyalty Setup';
  • InstructionalText = 'This wizard guides you through configuring point calculation rates and reward tiers.';
  • }
  • }
  • // Step 2: G/L Posting & Calculation Parameters
  • group(Step2Settings)
  • {
  • Visible = (CurrentStep = 2);
  • field("Points Per Dollar"; Rec."Points Per Dollar")
  • {
  • ApplicationArea = All;
  • ToolTip = 'Specifies points awarded per currency unit spent.';
  • }
  • field("Redemption Account No."; Rec."Redemption Account No.")
  • {
  • ApplicationArea = All;
  • ToolTip = 'Specifies the G/L expense account for point redemptions.';
  • }
  • }
  • // Step 3: Confirmation & Completion
  • group(Step3Finish)
  • {
  • Visible = (CurrentStep = 3);
  • group(FinishText)
  • {
  • Caption = 'Almost Done';
  • InstructionalText = 'Choose Finish to save your settings and activate the loyalty module.';
  • }
  • }
  • }
  • }
  • actions
  • {
  • area(Processing)
  • {
  • action(ActionBack)
  • {
  • Caption = 'Back';
  • Image = PreviousRecord;
  • InFooterBar = true;
  • Enabled = (CurrentStep > 1);
  • trigger OnAction()
  • begin
  • CurrentStep -= 1;
  • end;
  • }
  • action(ActionNext)
  • {
  • Caption = 'Next';
  • Image = NextRecord;
  • InFooterBar = true;
  • Visible = (CurrentStep < TotalSteps);
  • trigger OnAction()
  • begin
  • CurrentStep += 1;
  • end;
  • }
  • action(ActionFinish)
  • {
  • Caption = 'Finish';
  • Image = Approve;
  • InFooterBar = true;
  • Visible = (CurrentStep = TotalSteps);
  • trigger OnAction()
  • var
  • GuidedExperience: Codeunit "Guided Experience";
  • begin
  • // 1. Commit and validate configuration settings
  • Rec.Validate("Setup Completed", true);
  • Rec.Modify(true);
  • // 2. Notify Guided Experience framework of successful completion
  • GuidedExperience.CompleteAssistedSetup(ObjectType::Page, Page::"Loyalty Setup Wizard");
  • // 3. Close the wizard
  • CurrPage.Close();
  • end;
  • }
  • }
  • }
  • trigger OnInit()
  • begin
  • CurrentStep := 1;
  • TotalSteps := 3;
  • end;
  • var
  • CurrentStep: Integer;
  • TotalSteps: Integer;
  • }
  • Wizard Design Rules for MB-820

InFooterBar = true : Navigation actions ( Back , Next , Finish ) must have the InFooterBar = true property set so they render in the bottom action bar of the NavigatePage .

Modal Experience : NavigatePage objects cannot have submenus or standard ribbon action bars; all interactions flow through the footer actions.

Step State Control : Step groups are shown conditionally using Visible = (CurrentStep = N) .

4. Wizard Lifecycle & Role Center Onboarding Checklists

When a user steps through an assisted setup wizard, the extension must manage the lifecycle state within the Guided Experience framework so that the setup status indicator turns green (Completed) across both the Assisted Setup page and Onboarding Checklists .

Guided Experience Lifecycle Methods

GuidedExperience.CompleteAssistedSetup(ObjectType, ObjectID) : Marks the specified setup item as completed in the tenant database.

GuidedExperience.IsAssistedSetupComplete(ObjectType, ObjectID) : Returns a Boolean indicating whether the user or administrator has already completed the wizard.

GuidedExperience.ResetAssistedSetup(ObjectType, ObjectID) : Resets the item status back to Not Completed , allowing the wizard to be rerun from scratch.

Role Center Onboarding Checklists

Onboarding Checklists provide a curated list of getting-started tasks rendered in a prominent banner at the top of Role Centers for new users and evaluation companies. Checklists transform passive software exploration into active, structured onboarding journeys.

Checklist Characteristics & Administration

Role-Centric Delivery : Checklists can be tailored to specific user profiles (e.g., an accountant sees financial setup steps, while a warehouse manager sees inventory location setup).

Checklist Item Types : Tasks can link directly to an Assisted Setup wizard, a manual page, a Microsoft Learn URL, or an interactive In-App Tour.

Progress Tracking : As users complete tasks, the checklist banner tracks completion percentage (e.g., 2 of 5 tasks completed ), celebrating completion with visual feedback.

Administrative Control : Tenant administrators can customize, reorder, add, or disable checklist items through the Checklist Administration page in the Web Client without modifying AL source code.