Skip to content
Branch: master
Find file History
Latest commit 15f2cca Nov 19, 2019
Permalink
Type Name Latest commit message Commit time
..
Failed to load latest commit information.
src Update 2019-11-19 Nov 19, 2019
README.md Update 2019-10-27 Oct 7, 2019
app.json Update 2019-11-19 Nov 19, 2019

README.md

Introduction

This module contains all pages that are used by assisted setup guides in Business Central. Assisted setup guides provide step-by-step guidance that helps simplify the process of setting up complex features.

What has been done

We have combined the assisted setup capabilities that already existed in Business Central in this module. If your extension provides setup assistance through a guide, you can add that guide to Assisted Setup for easy discoverability.

The Assisted Setup module provides capabilities for:

  • Adding an assisted setup guide for a given extension, page ID, an optional video link that explains the feature, and a help link where the user can read more about it.
  • Adding a translation for the name of the setup record. This is helpful when the extension is available in multiple languages.
  • Checking whether a user has already completed the steps in an assisted setup guide.
  • Completing an assisted setup guide, typically from the guide itself when the user clicks Finish.
  • Running an assisted setup guide page that takes the user through the various steps to set up an extension.

Usage example

The Base Application adds quite a few assisted setup guides by subscribing to the OnRegister event. In the following example, the Data Migration Wizard is being added to the Assisted Setup through the API exposed for the module. See the details for codeunit 1814 "Assisted Setup Subscribers", which shows that the Data Migration Wizard, is added along with a video and a link to more information. Also, the English (United States) translation for the name is added.

        CurrentGlobalLanguage := GLOBALLANGUAGE; 
        // Getting Started 
        AssistedSetup.Add(GetAppId(), PAGE::"Data Migration Wizard", DataMigrationTxt, AssistedSetupGroup::GettingStarted, VideoImportbusinessdataTxt, HelpImportbusinessdataTxt); 
        GLOBALLANGUAGE(1033); 
        AssistedSetup.AddTranslation(GetAppId(), PAGE::"Data Migration Wizard", 1033, DataMigrationTxt); 
        GLOBALLANGUAGE(CurrentGlobalLanguage); 

Public Objects

Assisted Setup (Codeunit 3725)

Manage setup wizards by allowing adding to the list and updating the status of each.

Add (Method)

Adds an assisted setup record from a given extension so that it can be shown in the list.

Syntax

procedure Add(ExtensionID: Guid; PageID: Integer; AssistantName: Text; GroupName: Enum "Assisted Setup Group")

Parameters

ExtensionID (Guid)

The app ID of the extension to which the setup belongs.

PageID (Integer)

The ID of the page to open when the user clicks the setup.

AssistantName (Text)

The name as shown for the setup.

GroupName (Enum "Assisted Setup Group")

The assisted setup group enum that this belongs to.

Add (Method)

Adds an assisted setup record from a given extension so that it can be shown in the list.

Syntax

procedure Add(ExtensionID: Guid; PageID: Integer; AssistantName: Text; GroupName: Enum "Assisted Setup Group"; VideoLink: Text[250]; HelpLink: Text[250])

Parameters

ExtensionID (Guid)

The app ID of the extension to which the setup belongs.

PageID (Integer)

The ID of the page to open when the user clicks the setup.

AssistantName (Text)

The name as shown for the setup.

GroupName (Enum "Assisted Setup Group")

The assisted setup group enum that this belongs to.

VideoLink (Text[250])

The URL of the video that explains the purpose and use of this setup.

HelpLink (Text[250])

The help url that explains the purpose and usage of this setup.

Add (Method)

Adds an assisted setup record from a given extension so that it can be shown in the list.

Syntax

procedure Add(ExtensionID: Guid; PageID: Integer; AssistantName: Text; GroupName: Enum "Assisted Setup Group"; VideoLink: Text[250]; VideoCategory: Enum "Video Category"; HelpLink: Text[250])

Parameters

ExtensionID (Guid)

The app ID of the extension to which the setup belongs.

PageID (Integer)

The ID of the page to open when the user clicks the setup.

AssistantName (Text)

The name as shown for the setup.

GroupName (Enum "Assisted Setup Group")

The assisted setup group enum that this belongs to.

VideoLink (Text[250])

The URL of the video that explains the purpose and use of this setup.

VideoCategory (Enum "Video Category")

The category of the video for this setup.

HelpLink (Text[250])

The help url that explains the purpose and usage of this setup.

AddTranslation (Method)

Adds the translation for the name of the setup.

Syntax

procedure AddTranslation(ExtensionID: Guid; PageID: Integer; LanguageID: Integer; TranslatedName: Text)

Parameters

ExtensionID (Guid)

The app ID of the extension to which the setup belongs.

PageID (Integer)

The ID of the page to open when the user clicks the setup.

LanguageID (Integer)

The language ID for which the translation is made.

TranslatedName (Text)

The translated text of the name.

IsComplete (Method)

Checks whether a user has already completed the setup.

Syntax

procedure IsComplete(ExtensionID: Guid; PageID: Integer): Boolean

Parameters

ExtensionID (Guid)

The app ID of the extension to which the setup belongs.

PageID (Integer)

The ID of the page to open when the user clicks the setup.

Return Value

Boolean

Returns true if the given setup guide has been completed by the user, otherwise false.

Exists (Method)

Checks whether an assisted setup guide exists.

Syntax

procedure Exists(ExtensionID: Guid; PageID: Integer): Boolean

Parameters

ExtensionID (Guid)

The app ID of the extension to which the setup belongs.

PageID (Integer)

The ID of the page to open when the user clicks the setup.

Return Value

Boolean

True if an assisted setup guide for provided extension and page IDs exists; false otherwise.

ExistsAndIsNotComplete (Method)

Checks whether as assisted setup guide exists but has not been completed.

Syntax

procedure ExistsAndIsNotComplete(ExtensionID: Guid; PageID: Integer): Boolean

Parameters

ExtensionID (Guid)

The app ID of the extension to which the setup belongs.

PageID (Integer)

The ID of the page to open when the user clicks the setup.

Return Value

Boolean

True if it exists and is incomplete, false otherwise.

Complete (Method)

Sets the status of the assisted setup to Complete.

This is typically called from inside the assisted setup guide when the setup is finished.

Syntax

procedure Complete(ExtensionID: Guid; PageID: Integer)

Parameters

ExtensionID (Guid)

The app ID of the extension to which the setup belongs.

PageID (Integer)

The ID of the page to open when the user clicks the setup.

Run (Method)

Issues the call to execute the setup.

Syntax

procedure Run(ExtensionID: Guid; PageID: Integer)

Parameters

ExtensionID (Guid)

The app ID of the extension to which the setup belongs.

PageID (Integer)

The ID of the page to open when the user clicks the setup.

Open (Method)

Opens the Assisted Setup page with the setup guides in it.

Syntax

procedure Open()

Open (Method)

Opens the Assisted Setup page with the setup guides filtered on a selected group of guides.

Syntax

procedure Open(AssistedSetupGroup: Enum "Assisted Setup Group")

Parameters

AssistedSetupGroup (Enum "Assisted Setup Group")

The group of guides to display on the Assisted Setup page.

OnRegister (Event)

Notifies the user that the list of assisted setup guides is being gathered, and that new guides might be added.

Syntax

[IntegrationEvent(false, false)]
internal procedure OnRegister()

OnReRunOfCompletedSetup (Event)

Notifies the user that a setup that was previously completed is being run again.

Syntax

[IntegrationEvent(false, false)]
internal procedure OnReRunOfCompletedSetup(ExtensionID: Guid; PageID: Integer; var Handled: Boolean)

Parameters

ExtensionID (Guid)

The app ID of the extension to which the setup belongs.

PageID (Integer)

The ID of the page to open when the user clicks the setup.

Handled (Boolean)

The flag which if set, would stop executing the run of the assisted setup guide.

OnAfterRun (Event)

Notifies that the run of the assisted setup has finished.

Syntax

[IntegrationEvent(false, false)]
internal procedure OnAfterRun(ExtensionID: Guid; PageID: Integer)

Parameters

ExtensionID (Guid)

The app ID of the extension to which the setup belongs.

PageID (Integer)

The ID of the page to open when the user clicks the setup.

Assisted Setup (Page 1801)

This page shows all registered assisted setup guides.

Assisted Setup Group (Enum 1815)

The group to which the setup belongs. Please extend this enum to add your own group to classify the setups being added by your extension.

Uncategorized (value: 0)

You can’t perform that action at this time.