Table of Contents

Namespace System.Environment.Configuration

Codeunit

Name Summary
Codeunit System.Environment.Configuration."Advanced Settings" Advanced settings exposes integration events raised at Advance Settings Page open.
Codeunit System.Environment.Configuration."Default Role Center" The codeunit that emits the event that sets the default Role Center. To use another Role Center by default, you must have a profile for it.
Codeunit System.Environment.Configuration."Feature Data Error Handler" Error handler codeunit used by the task scheduler during feature data update.
Codeunit System.Environment.Configuration."Feature Management Facade" This codeunit provides public functions for feature management.
Codeunit System.Environment.Configuration."Update Feature Data" Codeunit that is executed by the task scheduler during the feature data update.
Codeunit System.Environment.Configuration."Navigation Bar Subscribers" Collection of the default subscribers to system events and corresponding overridable integration events.
Codeunit System.Environment.Configuration."Server Setting" Exposes functionality to fetch some application server settings for the server which hosts the current tenant.
Codeunit System.Environment.Configuration."System Initialization" Exposes functionality to check whether the system is initializing as well as an event to subscribed to in order to execute logic right after the system has initialized.
Codeunit System.Environment.Configuration."User Settings" Provides basic functionality for user settings.
Codeunit System.Environment.Configuration."Assisted Setup Installation"
Codeunit System.Environment.Configuration."Assisted Setup Upgrade"
Codeunit System.Environment.Configuration.Checklist Manage the checklist presented to users by inserting and deleting checklist items and controling the visibility of the checklist.
Codeunit System.Environment.Configuration."Checklist Banner" Provides functionality to customize the Checklist Banner
Codeunit System.Environment.Configuration."Guided Experience" Manage the guided experience items that users can access.
Codeunit System.Environment.Configuration."Guided Experience Item Cleanup"
Codeunit System.Environment.Configuration."Guided Experience Upgrade"
Codeunit System.Environment.Configuration."Spotlight Tour" Provides functionality to use spotlight tours

Table

Name Summary
Table System.Environment.Configuration."Feature Data Update Status" Table stores feature data update status per company.
Table System.Environment.Configuration."Feature Dependency" Temporary table stores pairs of the dependent features.
Table System.Environment.Configuration."Feature Key Buffer" This temporary table extends the "Feature Key" virtual table. The fields must be in sync across both tables. New fields are added from id = 100 upwards.
Table System.Environment.Configuration."Signup Context Values" This table stores the signup context and additional values passed at signup.
Table System.Environment.Configuration."Application User Settings" Table that stores user settings the Application defines.
Table System.Environment.Configuration."User Settings" Temporary table that combines the settings defined by platform and application

Page

Name Summary
Page System.Environment.Configuration."Advanced Settings" This page shows all the registered entries in the advanced settings page.
Page System.Environment.Configuration."Blank Role Center" Empty role center to use in case no other role center is present when system is initializing.
Page System.Environment.Configuration."Feature Management" Page that enables a user to pick which new features to use
Page System.Environment.Configuration."Schedule Feature Data Update" Page provide the dialog where user can run or schedule the feature datat update.
Page System.Environment.Configuration."Accessible Companies" List page that contains the allowed companies for the current user.
Page System.Environment.Configuration.Roles List page that contains all available roles.
Page System.Environment.Configuration."User Personalization" Page that shows the settings of a given user.
Page System.Environment.Configuration."User Settings" Page that shows the settings of a given user.
Page System.Environment.Configuration."User Settings FactBox" A Factbox that shows the settings of a given user.
Page System.Environment.Configuration."User Settings List" List page that shows the settings of all users.
Page System.Environment.Configuration."App Setup List" This page shows all registered setups.
Page System.Environment.Configuration."Assisted Setup" This page shows all registered assisted setup guides.
Page System.Environment.Configuration.Checklist Lists all checklist items and provides capabilities to edit and insert new ones based on existing guided experience items.
Page System.Environment.Configuration."Checklist Administration" Provides capabilities to edit and insert new checklist items based on existing guided experience items.
Page System.Environment.Configuration."Checklist Item Roles" Lists the roles that a checklist item should be displayed to.
Page System.Environment.Configuration."Checklist Item Users" Lists the users that a checklist item should be displayed to.
Page System.Environment.Configuration."Checklist Banner" Lists the checklist items that a user should go through to finalize their onboarding experience.
Page System.Environment.Configuration."Checklist Resurfacing"
Page System.Environment.Configuration."Early Access Preview Features"
Page System.Environment.Configuration."Guided Experience Item Cleanup"
Page System.Environment.Configuration."Guided Experience Item List" Lists guided experience items.
Page System.Environment.Configuration."Manual Setup" This page shows all registered manual setups.

ControlAddIn

Name Summary
ControlAddIn System.Environment.Configuration.EarlyAccessPreviewBanner

Enum

Name Summary
Enum System.Environment.Configuration."Feature Status" Enum defines the feature statuses.
Enum System.Environment.Configuration."Feature To Update" The enum lists the features that require some data update. Text value must match the key value in the "Feature Key" table, Int value is the implementation codeunit id.
Enum System.Environment.Configuration."Signup Context" The Signup Context is used to track from where a tenant originated.
Enum System.Environment.Configuration."Assisted Setup Group" 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.
Enum System.Environment.Configuration."Guided Experience Type"
Enum System.Environment.Configuration."Manual Setup Category" The category enum is used to navigate the setup page, which can have many records. It is encouraged to extend this enum and use the newly defined options.
Enum System.Environment.Configuration."Spotlight Tour Text" Specifies the exact step of a spotlight tour that a text belongs to.
Enum System.Environment.Configuration."Spotlight Tour Type" Specifies the type of a spotlight tour.

Profile

Name Summary
Profile System.Environment.Configuration.BLANK Empty profile to use in case no other profile is present when system is initializing.

Interface

Name Summary
Interface System.Environment.Configuration."Feature Data Update" Interface defines methods for feature data update task management.
Interface System.Environment.Configuration."Feature Management" Interface that defines methods for linking tables "Feature Key Buffer" and "Feature Key". The default implementation uses the system table "Feature Key" as a source, but another implementation uses a temporary table "Feature Key" to delink Feature Management UX from the read-only virtual table.

PermissionSet

Name Summary
PermissionSet System.Environment.Configuration."Feature Mgt. - Admin" This permission set is required to turn a feature on or off. It can be assigned to users to give full access to the Feature Management functionality.
PermissionSet System.Environment.Configuration."Guided Experience - Objects"
PermissionSet System.Environment.Configuration."Guided Experience - Read"
PermissionSet System.Environment.Configuration."Guided Experience - View"
PermissionSet System.Environment.Configuration."System Initialization - Exec"
PermissionSet System.Environment.Configuration."User Settings - View"

Events

Name Summary
OnBeforeOpenGeneralSetupExperience Notifies that the Open General Setup Experience has been invoked.
OnBeforeGetDefaultRoleCenter Integration event for setting the default Role Center ID.
OnLogError
OnAfterUpdateData
OnBeforeUpdateData
OnBeforeScheduleTask
OnGetImplementation
OnShowTaskLog
OnInitializeFeatureDataUpdateStatus
OnAfterFeatureEnableConfirmed
OnAfterFeatureDisableConfirmed
OnBeforeSetFeatureStatusForOtherCompanies
OnBeforeOpenFeatureManagement
OnBeforeDefaultOpenCompanySettings Notifies that the Default Open Company Settings has been invoked.
OnBeforeDefaultOpenRoleBasedSetupExperience Notifies that the Default Open Role Based Setup Experience has been invoked.
OnBeforeDefaultOpenGeneralSetupExperience Notifies that the Default Open General Setup Experience has been invoked.
OnAfterLogin Integration event for after the login. Subscribe to this event in order to execute additional initialization steps.
OnSetSignupContext
OnGetDefaultProfile
OnGetSettingsPageID Integration event that allows changing the settings page ID.
OnBeforeOpenSettings Integration event that allows changing the behavior of opening the settings page.
OnAfterGetUserSettings Integration event that allows updating the User Settings record with extra values.
OnUpdateUserSettings Integration event that allows updating the settings on related records.
OnCompanyChange Integration event that fires every time the company is changed.
OnChecklistLoading Event that is triggered when the checklist is being loaded.
OnBeforeUpdateBannerLabels Integration Event to provide the ability to customize Labels on the Checklist Banner
OnOpenChecklistBannerPage Integration Event to provide the ability to skip the welcome state of the checklist banner.
OnRegisterAssistedSetup Notifies that the list of assisted setups is being gathered, and that new items might be added.
OnReRunOfCompletedAssistedSetup Notifies that an assisted setup that was previously completed is being run again.
OnAfterRunAssistedSetup Notifies that the run of the assisted setup has finished.
OnBeforeOpenRoleBasedAssistedSetupExperience Notifies that the Open Role Based Setup Experience has been invoked.
OnRegisterManualSetup The event that is raised so that subscribers can add the new manual setups that can be displayed in the Manual Setup page.
OnRegisterGuidedExperienceItem The event that is raised so that subscribers can add the new guided experience items.
OnOpenFeatureMgtPage