Codeunit Checklist

ID 1992

Namespace: System.Environment.Configuration

Manage the checklist presented to users by inserting and deleting checklist items and controling the visibility of the checklist.

Properties

Name	Value
Access	Public

Methods

Insert

procedure Insert(GuidedExperienceType: Enum "Guided Experience Type", ObjectTypeToRun: ObjectType, ObjectIDToRun: Integer, OrderID: Integer, TempAllProfile: __MissingTypeSymbol__, ShouldEveryoneComplete: Boolean)

Parameters

Name	Type	Description
GuidedExperienceType	Enum System.Environment.Configuration."Guided Experience Type"
ObjectTypeToRun	ObjectType
ObjectIDToRun	Integer
OrderID	Integer
TempAllProfile	__MissingTypeSymbol__
ShouldEveryoneComplete	Boolean

Insert

procedure Insert(GuidedExperienceType: Enum "Guided Experience Type", ObjectTypeToRun: ObjectType, ObjectIDToRun: Integer, OrderID: Integer, TempUser: __MissingTypeSymbol__)

Parameters

Name	Type	Description
GuidedExperienceType	Enum System.Environment.Configuration."Guided Experience Type"
ObjectTypeToRun	ObjectType
ObjectIDToRun	Integer
OrderID	Integer
TempUser	__MissingTypeSymbol__

Insert

procedure Insert(GuidedExperienceType: Enum "Guided Experience Type", Link: Text[250], OrderID: Integer, TempAllProfile: __MissingTypeSymbol__, ShouldEveryoneComplete: Boolean)

Parameters

Name	Type	Description
GuidedExperienceType	Enum System.Environment.Configuration."Guided Experience Type"
Link	Text[250]
OrderID	Integer
TempAllProfile	__MissingTypeSymbol__
ShouldEveryoneComplete	Boolean

Insert

procedure Insert(GuidedExperienceType: Enum "Guided Experience Type", Link: Text[250], OrderID: Integer, TempUser: __MissingTypeSymbol__)

Parameters

Name	Type	Description
GuidedExperienceType	Enum System.Environment.Configuration."Guided Experience Type"
Link	Text[250]
OrderID	Integer
TempUser	__MissingTypeSymbol__

Insert

procedure Insert(PageID: Integer, SpotlightTourType: Enum "Spotlight Tour Type", OrderID: Integer, TempAllProfile: __MissingTypeSymbol__, ShouldEveryoneComplete: Boolean)

Parameters

Name	Type	Description
PageID	Integer
SpotlightTourType	Enum System.Environment.Configuration."Spotlight Tour Type"
OrderID	Integer
TempAllProfile	__MissingTypeSymbol__
ShouldEveryoneComplete	Boolean

Insert

procedure Insert(PageID: Integer, SpotlightTourType: Enum "Spotlight Tour Type", OrderID: Integer, TempUser: __MissingTypeSymbol__)

Parameters

Name	Type	Description
PageID	Integer
SpotlightTourType	Enum System.Environment.Configuration."Spotlight Tour Type"
OrderID	Integer
TempUser	__MissingTypeSymbol__

Delete

Deletes a checklist item.

procedure Delete(GuidedExperienceType: Enum "Guided Experience Type", ObjectTypeToRun: ObjectType, ObjectID: Integer)

Parameters

Name	Type	Description
GuidedExperienceType	Enum System.Environment.Configuration."Guided Experience Type"	The type of guided experience item that the checklist item references.
ObjectTypeToRun	ObjectType	The object type run by the guided experience item that the checklist item references.
ObjectID	Integer	The type of guided experience item that the checklist item references.

Delete

Deletes a checklist item.

procedure Delete(GuidedExperienceType: Enum "Guided Experience Type", Link: Text[250])

Parameters

Name	Type	Description
GuidedExperienceType	Enum System.Environment.Configuration."Guided Experience Type"	The type of guided experience item that the checklist item references.
Link	Text[250]	The URL that is open by the guided experience item that the checklist item references.

Delete

Deletes a spotlight tour checklist item.

procedure Delete(PageID: Integer, SpotlightTourType: Enum "Spotlight Tour Type")

Parameters

Name	Type	Description
PageID	Integer	The ID of the page that the spotlight tour runs on.
SpotlightTourType	Enum System.Environment.Configuration."Spotlight Tour Type"	The type of spotlight tour.

ShouldInitializeChecklist

Checks whether the checklist should be initialized for the current company.

procedure ShouldInitializeChecklist(ShouldSkipForEvaluationCompany: Boolean): Boolean

Parameters

Name	Type	Description
ShouldSkipForEvaluationCompany	Boolean	If true, then the function will always return false for evaluation companies.

Returns

Type	Description
Boolean	True if the checklist should be initialized and false otherwise.

MarkChecklistSetupInProgress

Marks the checklist setup in progress.

procedure MarkChecklistSetupInProgress()

MarkChecklistSetupAsDone

Marks the checklist setup as done.

procedure MarkChecklistSetupAsDone()

InitializeGuidedExperienceItems

Initializes the guided experience items. Mostly called once in a company's lifecycle from BaseApp, if used in an extension, please see also ShouldInitializeChecklist.

procedure InitializeGuidedExperienceItems()

UpdateUserName

Updates the user name for checklist records that have it as a primary key.

procedure UpdateUserName(var RecordRef: RecordRef, Company: Text[30], UserName: Text[50], TableID: Integer)

Parameters

Name	Type	Description
RecordRef	RecordRef	The recordref that poins to the record that is to be modified.
Company	Text[30]	The company in which the table is to be modified.
UserName	Text[50]	The new user name.
TableID	Integer	The table for which the user name is to be modified.

IsChecklistVisible

Checks whether the checklist is visible for the current user on the profile that the user is currently on.

procedure IsChecklistVisible(): Boolean

Returns

Type	Description
Boolean	True if the checklist is visible and false otherwise.

SetChecklistVisibility

Sets the checklist visibility for the current user and the profile that the user is currently using.

procedure SetChecklistVisibility(Visible: Boolean)

Parameters

Name	Type	Description
Visible	Boolean	True if the checklist should be visible and false otherwise.

Events

OnChecklistLoading

Event that is triggered when the checklist is being loaded.

[IntegrationEvent(False,False)]
internal procedure OnChecklistLoading()

See also

• Codeunit