Codeunit 1990 "Guided Experience"

System Application · System.Environment.Configuration · BC23-30 · source at ea08af5e · facts from BC29

Properties

Events published

• OnRegisterAssistedSetup() (integration): Notifies that the list of assisted setups is being gathered, and that new items might be added.
  • subscribers: Codeunit 1392 “Monitor Sensitive Field” AddMonitorFieldSetupWizard, Codeunit 1681 “Email Logging Management” HandleOnRegisterAssistedSetup, Codeunit 1814 “Assisted Setup Subscribers” Initialize, Codeunit 20117 “AMC Bank Assisted Mgt.” InsertIntoAssistedSetup, Codeunit 2027 “Image Analyzer Ext. Mgt.” InsertIntoAssistedSetup, Codeunit 20366 “Tax Engine Assisted Setup” Initialize, Codeunit 20401 “Qlty. Assisted Setup” HandleOnRegisterAssistedSetup, Codeunit 20502 “Subc. Business Setup Ext.” OnRegisterAssistedSetup, Codeunit 20605 “Assisted Setup BF” SetupInitialize, Codeunit 30201 “Shpfy Guided Experience” OnRegisterAssistedSetup, Codeunit 4001 “Hybrid Cloud Management” AddIntelligentCloudToAssistedSetup, Codeunit 4592 “SOA Events” Initialize, Codeunit 4701 “VAT Group Helper Functions” AddVATReportSetupWizard, Codeunit 4810 “IntrastatReportManagement” InsertIntoAssistedSetup, Codeunit 5012 “Service Declaration Mgt.” InsertIntoAssistedSetup, Codeunit 5579 “Digital Voucher Impl.” InsertIntoAssistedSetup, Codeunit 6613 “FS Assisted Setup Subscriber” RegisterFSAssistedSetup, Codeunit 8850 “Bank Statement File Wizard” RegisterBankStatementFileSetupWizard
• OnReRunOfCompletedAssistedSetup(ExtensionID: Guid; ObjectType: ObjectType; ObjectID: Integer; var Handled: Boolean) (integration): Notifies that an assisted setup that was previously completed is being run again.
  • subscribers: Codeunit 1814 “Assisted Setup Subscribers” OnReRunOfCompletedSetup, Codeunit 20605 “Assisted Setup BF” OnReRunOfCompletedSetup
• OnAfterRunAssistedSetup(ExtensionID: Guid; ObjectType: ObjectType; ObjectID: Integer) (integration): Notifies that the run of the assisted setup has finished.
  • subscribers: Codeunit 1814 “Assisted Setup Subscribers” CompleteEmailAssistedSetup, Codeunit 20117 “AMC Bank Assisted Mgt.” UpdateAssistedSetupStatus
• OnBeforeOpenRoleBasedAssistedSetupExperience(var PageID: Integer; var Handled: Boolean) (integration): Notifies that the Open Role Based Setup Experience has been invoked.
• OnRegisterManualSetup() (integration): The event that is raised so that subscribers can add the new manual setups that can be displayed in the Manual Setup page.
  • subscribers: Codeunit 1070 “MS - PayPal Standard Mgt.” RegisterBusinessSetup, Codeunit 1850 “Sales Forecast Handler” InsertIntoManualSetupOnRegisterManualSetup, Codeunit 1876 “Business Setup Subscribers” InsertSetupOnRegisterManualSetup, Codeunit 1952 “LP Subscribers” InsertIntoManualSetupOnRegisterManualSetup, Codeunit 20400 “Qlty. Manual Setup” InsertQualityManagementManualSetupOnRegisterManualSetup, Codeunit 20502 “Subc. Business Setup Ext.” OnRegisterManualSetup, Codeunit 5466 “Graph Mgt - In. Services Setup” HandleAPISetup
• OnRegisterGuidedExperienceItem() (integration): The event that is raised so that subscribers can add the new guided experience items.
  • subscribers: Codeunit 1878 “Guided Experience Subscribers” OnRegisterGuidedExperienceItem, Codeunit 20356 “Connectivity Apps Guided Exp.” OnRegisterGuidedExperienceItem, Codeunit 20419 “Qlty. Guided Experience” OnRegisterGuidedExperienceItem, Codeunit 30201 “Shpfy Guided Experience” OnRegisterGuidedExperienceItem

Procedures

• InsertManualSetup(Title: Text[2048]; ShortTitle: Text[50]; Description: Text[1024]; ExpectedDuration: Integer; ObjectTypeToRun: ObjectType; ObjectIDToRun: Integer; ManualSetupCategory: Enum "Manual Setup Category"; Keywords: Text[250]): Inserts a manual setup page.
• InsertManualSetup(Title: Text[2048]; ShortTitle: Text[50]; Description: Text[1024]; ExpectedDuration: Integer; ObjectTypeToRun: ObjectType; ObjectIDToRun: Integer; ManualSetupCategory: Enum "Manual Setup Category"; Keywords: Text[250]; IsPrimarySetup: Boolean): Inserts a manual setup page.
• InsertAssistedSetup(Title: Text[2048]; ShortTitle: Text[50]; Description: Text[1024]; ExpectedDuration: Integer; ObjectTypeToRun: ObjectType; ObjectIDToRun: Integer; AssistedSetupGroup: Enum "Assisted Setup Group"; VideoUrl: Text[250]; VideoCategory: Enum "Video Category"; HelpUrl: Text[250]): Inserts an assisted setup page.
• InsertAssistedSetup(Title: Text[2048]; ShortTitle: Text[50]; Description: Text[1024]; ExpectedDuration: Integer; ObjectTypeToRun: ObjectType; ObjectIDToRun: Integer; AssistedSetupGroup: Enum "Assisted Setup Group"; VideoUrl: Text[250]; VideoCategory: Enum "Video Category"; HelpUrl: Text[250]; IsPrimarySetup: Boolean): Inserts an assisted setup page.
• InsertLearnLink(Title: Text[2048]; ShortTitle: Text[50]; Description: Text[1024]; ExpectedDuration: Integer; Link: Text[250]): Inserts a learn link.
• InsertTour(Title: Text[2048]; ShortTitle: Text[50]; Description: Text[1024]; ExpectedDuration: Integer; PageID: Integer): Inserts a tour for a page.
• InsertSpotlightTour(Title: Text[2048]; ShortTitle: Text[50]; Description: Text[1024]; ExpectedDuration: Integer; PageID: Integer; SpotlighTourType: Enum "Spotlight Tour Type"; SpotlightTourTexts: Dictionary of [Enum "Spotlight Tour Text", Text]): Inserts a spotlight tour for a page.
• InsertApplicationFeature(Title: Text[2048]; ShortTitle: Text[50]; Description: Text[1024]; ExpectedDuration: Integer; ObjectTypeToRun: ObjectType; ObjectIDToRun: Integer): Inserts a guided experience item for an application feature.
• InsertVideo(Title: Text[2048]; ShortTitle: Text[50]; Description: Text[1024]; ExpectedDuration: Integer; VideoURL: Text[250]; VideoCategory: Enum "Video Category"): Inserts a guided experience item for a video.
• OpenManualSetupPage(): Opens the Manual Setup page containing the setup guides.
• OpenManualSetupPage(ManualSetupCategory: Enum "Manual Setup Category"): Opens the Manual Setup page with the setup guides filtered on a selected group of guides.
• AddTranslationForSetupObjectTitle(GuidedExperienceType: Enum "Guided Experience Type"; ObjectType: ObjectType; ObjectID: Integer; LanguageID: Integer; Translation: Text): Adds the translation for the title of the setup object.
• AddTranslationForSetupObjectDescription(GuidedExperienceType: Enum "Guided Experience Type"; ObjectType: ObjectType; ObjectID: Integer; LanguageID: Integer; Translation: Text): Adds the translation for the description of the setup object.
• AddTranslationForSetupObjectShortTitle(GuidedExperienceType: Enum "Guided Experience Type"; ObjectType: ObjectType; ObjectID: Integer; LanguageID: Integer; Translation: Text): Adds the translation for the short title of the setup object.
• IsAssistedSetupComplete(ObjectType: ObjectType; ObjectID: Integer): Boolean: Checks whether a user has completed the setup corresponding to the object type and ID.
• Exists(GuidedExperienceType: Enum "Guided Experience Type"; ObjectType: ObjectType; ObjectID: Integer): Boolean: Checks whether a guided experience item exists for the given object type and ID.
• Exists(GuidedExperienceType: Enum "Guided Experience Type"; Link: Text[250]): Boolean: Checks whether a guided experience item exists for the link.
• AssistedSetupExistsAndIsNotComplete(ObjectType: ObjectType; ObjectID: Integer): Boolean: Checks whether a guided experience item exists but has not been completed for the given object type and ID.
• CompleteAssistedSetup(ObjectType: ObjectType; ObjectID: Integer): Sets the status of the guided experience item to complete.
• ResetAssistedSetup(ObjectType: ObjectType; ObjectID: Integer): Resets the status of the guided experience item so that it does not appear to have been completed.
• Run(GuidedExperienceType: Enum "Guided Experience Type"; ObjectType: ObjectType; ObjectID: Integer): Issues the call to start the guided experience item.
• OpenAssistedSetup(): Opens the Assisted Setup page with the setup guides in it.
• OpenAssistedSetup(AssistedSetupGroup: Enum "Assisted Setup Group"): Opens the Assisted Setup page with the setup guides filtered on a selected group of guides.
• Remove(GuidedExperienceType: Enum "Guided Experience Type"; ObjectType: ObjectType; ObjectID: Integer): Removes a guided experience item.
• Remove(GuidedExperienceType: Enum "Guided Experience Type"; Link: Text[250]): Removes a guided experience item.
• Remove(GuidedExperienceType: Enum "Guided Experience Type"; ObjectType: ObjectType; ObjectID: Integer; SpotlightTourType: Enum "Spotlight Tour Type"): Removes a guided experience item.
• RunExtensionSetup(AppId: Guid): Opens the primary setup for an app.
• SetupForExtensionExists(AppId: Guid): Boolean: checks if setup for an extension exist.
• OpenCombinedSetupList(AppId: Guid): Opens a aggregated list of both manual setup and assisted setup pages for an extension.
• CleanupOldGuidedExperienceItems(OnlyFirstParty: Boolean; Threshold: Integer): Clean up old guided experience items with too many old version.

Calls

From the extracted call graph of BC29 (graphify-al on the snapshot checkout): calls whose target is known from a declared type or an Object::"Name" argument. Interface dispatch and calls through events are not counted, so the list is not complete.

• Codeunit 1991 “Guided Experience Impl.” (22 calls: AddTranslationForSetupObjectDescription → AddTranslationForSetupObject, AddTranslationForSetupObjectShortTitle → AddTranslationForSetupObject, AddTranslationForSetupObjectTitle → AddTranslationForSetupObject, …)
• Codeunit 1994 “Guided Experience Item Cleanup” (1 call: CleanupOldGuidedExperienceItems → CleanupOldGuidedExperienceItems)

Called by

• Codeunit 1814 “Assisted Setup Subscribers” (8 calls: CompleteEmailAssistedSetup → CompleteAssistedSetup, Initialize → AddTranslationForSetupObjectTitle, Initialize → InsertAssistedSetup, …)
• Codeunit 1878 “Guided Experience Subscribers” (7 calls: OnRegisterGuidedExperienceItem → AddTranslationForSetupObjectDescription, OnRegisterGuidedExperienceItem → AddTranslationForSetupObjectTitle, OnRegisterGuidedExperienceItem → InsertApplicationFeature, …)
• Codeunit 1991 “Guided Experience Impl.” (5 calls: GetManualSetupPageIDs → OnRegisterManualSetup, OnRegisterVideo → OnRegisterAssistedSetup, OpenRoleBasedSetupExperience → OnBeforeOpenRoleBasedAssistedSetupExperience, …)
• Codeunit 20117 “AMC Bank Assisted Mgt.” (5 calls: InsertIntoAssistedSetup → AddTranslationForSetupObjectDescription, InsertIntoAssistedSetup → AddTranslationForSetupObjectTitle, InsertIntoAssistedSetup → CompleteAssistedSetup, …)
• Codeunit 20366 “Tax Engine Assisted Setup” (5 calls: Initialize → AddTranslationForSetupObjectTitle, Initialize → InsertAssistedSetup, ResetTaxEngineAssistedSetup → IsAssistedSetupComplete, …)
• Codeunit 1681 “Email Logging Management” (4 calls: CheckEmailLoggingEnabled → Run, RegisterAssistedSetup → AddTranslationForSetupObjectTitle, RegisterAssistedSetup → Exists, …)
• Codeunit 1800 “Assisted Company Setup” (4 calls: AddAssistedCompanySetup → AddTranslationForSetupObjectTitle, AddAssistedCompanySetup → InsertAssistedSetup, RunAssistedCompanySetup → IsAssistedSetupComplete, …)
• Codeunit 1993 “Checklist Implementation” (4 calls: InitializeGuidedExperienceItems → InsertLearnLink, InitializeGuidedExperienceItems → OnRegisterAssistedSetup, InitializeGuidedExperienceItems → OnRegisterGuidedExperienceItem, …)
• Codeunit 2027 “Image Analyzer Ext. Mgt.” (3 calls: InsertIntoAssistedSetup → AddTranslationForSetupObjectDescription, InsertIntoAssistedSetup → AddTranslationForSetupObjectTitle, InsertIntoAssistedSetup → InsertAssistedSetup)
• Codeunit 20419 “Qlty. Guided Experience” (3 calls: RegisterGuidedExperienceItems → InsertApplicationFeature, RegisterGuidedExperienceItems → InsertLearnLink, RegisterGuidedExperienceItems → InsertTour)
• Codeunit 2501 “Extension Marketplace” (3 calls: RunSetupForExtension → RunExtensionSetup, RunSetupForExtension → SetupForExtensionExists, SetupForExtensionExists → SetupForExtensionExists)
• Codeunit 4001 “Hybrid Cloud Management” (3 calls: AddCloudMigrationWizardToAssistedSetup → CompleteAssistedSetup, AddCloudMigrationWizardToAssistedSetup → InsertAssistedSetup, FinishCloudMigrationSetup → CompleteAssistedSetup)
• Codeunit 4701 “VAT Group Helper Functions” (3 calls: AddVATReportSetupWizard → AddTranslationForSetupObjectDescription, AddVATReportSetupWizard → AddTranslationForSetupObjectTitle, AddVATReportSetupWizard → InsertAssistedSetup)
• Codeunit 5330 “CRM Integration Management” (3 calls: CheckOrEnableCRMConnection → Run, RegisterAssistedSetup → Exists, RegisterAssistedSetup → InsertAssistedSetup)
• Codeunit 6613 “FS Assisted Setup Subscriber” (3 calls: RegisterAssistedSetup → AddTranslationForSetupObjectTitle, RegisterAssistedSetup → Exists, RegisterAssistedSetup → InsertAssistedSetup)
• Codeunit 7201 “CDS Integration Impl.” (3 calls: RegisterAssistedSetup → AddTranslationForSetupObjectTitle, RegisterAssistedSetup → Exists, RegisterAssistedSetup → InsertAssistedSetup)
• Page 4000 “Hybrid Cloud Setup Wizard” (3 calls: OnOpenPage → Exists, ShowConfirmationDialogAfterSetup → Exists, ShowConfirmationDialogAfterSetup → IsAssistedSetupComplete)
• Codeunit 104000 “Upgrade - BaseApp” (2 calls: UpgradeRemoveSmartListGuidedExperience → Exists, UpgradeRemoveSmartListGuidedExperience → Remove)
• Codeunit 1392 “Monitor Sensitive Field” (2 calls: AddMonitorFieldSetupWizard → AddTranslationForSetupObjectTitle, AddMonitorFieldSetupWizard → InsertAssistedSetup)
• Codeunit 1660 “Payroll Management” (2 calls: SetupPayrollService → AssistedSetupExistsAndIsNotComplete, SetupPayrollService → Run)
• Codeunit 20401 “Qlty. Assisted Setup” (2 calls: HandleOnRegisterAssistedSetup → Exists, HandleOnRegisterAssistedSetup → InsertAssistedSetup)
• Codeunit 7774 “Copilot Capability Impl” (2 calls: UpdateGuidedExperience → CompleteAssistedSetup, UpdateGuidedExperience → ResetAssistedSetup)
• Page 1279 “Service Connections” (2 calls: CallSetup → AssistedSetupExistsAndIsNotComplete, CallSetup → Run)
• Page 1661 “Payroll Import Transactions” (2 calls: FinishAction → CompleteAssistedSetup, OnQueryClosePage → AssistedSetupExistsAndIsNotComplete)
• Page 1818 “Cash Flow Forecast Wizard” (2 calls: FinishAction → CompleteAssistedSetup, OnQueryClosePage → AssistedSetupExistsAndIsNotComplete)
• Page 1877 “VAT Setup Wizard” (2 calls: FinishAction → CompleteAssistedSetup, OnQueryClosePage → AssistedSetupExistsAndIsNotComplete)
• Page 1991 “App Setup List” (2 calls: OnOpenPage → OnRegisterAssistedSetup, OnOpenPage → OnRegisterManualSetup)
• Page 20364 “Tax Engine Setup Wizard” (2 calls: FinishAction → CompleteAssistedSetup, OnQueryClosePage → AssistedSetupExistsAndIsNotComplete)
• Page 20600 “Assisted Setup BF” (2 calls: OnOpenPage → IsAssistedSetupComplete, OnOpenPage → ResetAssistedSetup)
• Codeunit 1070 “MS - PayPal Standard Mgt.” (1 call: RegisterBusinessSetup → InsertManualSetup)
• Codeunit 1850 “Sales Forecast Handler” (1 call: InsertIntoManualSetupOnRegisterManualSetup → InsertManualSetup)
• Codeunit 1876 “Business Setup Subscribers” (1 call: InsertSetupOnRegisterManualSetup → InsertManualSetup)
• Codeunit 1952 “LP Subscribers” (1 call: InsertIntoManualSetupOnRegisterManualSetup → InsertManualSetup)
• Codeunit 20356 “Connectivity Apps Guided Exp.” (1 call: OnRegisterGuidedExperienceItem → InsertApplicationFeature)
• Codeunit 20400 “Qlty. Manual Setup” (1 call: InsertQualityManagementManualSetupOnRegisterManualSetup → InsertManualSetup)
• Codeunit 20605 “Assisted Setup BF” (1 call: SetupInitialize → InsertAssistedSetup)
• Codeunit 2500 “Extension Installation Impl” (1 call: RunExtensionSetup → RunExtensionSetup)
• Codeunit 4592 “SOA Events” (1 call: Initialize → InsertAssistedSetup)
• Codeunit 4810 “IntrastatReportManagement” (1 call: InsertIntoAssistedSetup → InsertAssistedSetup)
• Codeunit 5012 “Service Declaration Mgt.” (1 call: InsertIntoAssistedSetup → InsertAssistedSetup)
• Codeunit 5466 “Graph Mgt - In. Services Setup” (1 call: HandleAPISetup → InsertManualSetup)
• Codeunit 5579 “Digital Voucher Impl.” (1 call: InsertIntoAssistedSetup → InsertAssistedSetup)
• Codeunit 5686 “Run CashFlow Forecast Wizard” (1 call: OnRun → CompleteAssistedSetup)
• Codeunit 6616 “FS Install” (1 call: UpgradeAssistedSetup → Remove)
• Codeunit 6617 “FS Upgrade” (1 call: UpgradeAssistedSetup → Remove)
• Codeunit 9033 “Invite External Accountant” (1 call: UpdateAssistedSetup → CompleteAssistedSetup)
• Page 1368 “Monitor Field Setup Wizard” (1 call: ValidateAndFinishSetup → CompleteAssistedSetup)
• Page 1480 “Excel Centralized Depl. Wizard” (1 call: FinishAction → CompleteAssistedSetup)
• Page 1681 “Email Logging Setup Wizard” (1 call: OnQueryClosePage → AssistedSetupExistsAndIsNotComplete)
• Page 1801 “Assisted Setup” (1 call: OnOpenPage → OnRegisterAssistedSetup)
• and 19 more: data/code/graph/29/calls.json

Ask your agent

Procedure bodies are not stored here (D10). The call sections above are our own, per object, from the BC29 call graph. For a procedure body or the calls of one procedure, ask bc-code-atlas (external, by Stefan Maron, MIT; default corpus w1-28), which the bc-observatory plugin connects: bcatlas_resolve_node(object_type: "codeunit", object_name: "Guided Experience"), then bcatlas_get_procedure_body or bcatlas_get_neighbors on the returned id.