KVSCOREiDataPackage

Procedures

GetDescription() : Text

Summary: The Description of the package

Syntax

procedure GetDescription(): Text

Returns: Text containing the human-readable description of the data package

Example:

procedure GetDescription(): Text
begin
    exit('This is a description of the package');
end;

SetupDataAvailable() : Boolean

Summary: Procedure to check if the Package contains Setup Data

Syntax

procedure SetupDataAvailable(): Boolean

Returns: Boolean indicating whether setup data is available (true) or not (false)

Example:

procedure SetupDataAvailabel(): Boolean
begin
    exit(true);
end;

DemoDataAvailable() : Boolean

Summary: Procedure to check if the Package contains Demo Data

Syntax

procedure DemoDataAvailable(): Boolean

Returns: Boolean indicating whether demo data is available (true) or not (false)

Example:

procedure DemoDataAvailabel(): Boolean
begin
    exit(true);
end;

DemoDataImportOnAutomatedImport() : Boolean

Summary: Procedure to control if the package should be imported on an automated import. If your app provides multiple data packages which are in conflict with each other you should just mark one as automated importable. you should also think about whether it would make sense to trigger an event with an handled pattern to allow an app that has a dependency to yours to replace your default with its own.

Syntax

procedure DemoDataImportOnAutomatedImport(): Boolean

Returns: Boolean indicating whether the demo data should be imported automatically (true) or not (false)

Example:

procedure DemoDataImportOnAutomatedImport(): Boolean
begin
    exit(true);
end;

SetupDataImportOnAutomatedImport() : Boolean

Summary: Procedure to control if the package should be imported on an automated import. If your app provides multiple data packages which are in conflict with each other you should just mark one as automated importable. you should also think about whether it would make sense to trigger an event with an handled pattern to allow an app that has a dependency to yours to replace your default with its own.

Syntax

procedure SetupDataImportOnAutomatedImport(): Boolean

Returns: Boolean indicating whether the setup data should be imported automatically (true) or not (false)

Example:

procedure SetupDataImportOnAutomatedImport(): Boolean
begin
    exit(true);
end;

CreateSetupData() :

Summary: Procedure to Create the Setup Data

Syntax

procedure CreateSetupData(): 

CreateDemoData() :

Summary: Procedure to Create the Demo Data

Syntax

procedure CreateDemoData(): 

RunSetup() :

Summary: Procedure to run an corresponding Setup

Syntax

procedure RunSetup(): 

Example: Default implementation exists:

procedure RunSetup()
var
    DataDefaults: Codeunit KVSCOREDataDefaults;
begin
    DataDefaults.RunSetup();
end;

ProvidingApp() : ModuleInfo

Summary: Procedure to provide information about the providing App

Syntax

procedure ProvidingApp(): ModuleInfo

Returns: ModuleInfo object containing information about the app that provides this data package

Example: Default implementation exists:

procedure ProvidingApp(): ModuleInfo;
var
    DataDefaults: Codeunit KVSCOREDataDefaults;
begin
    exit(DataDefaults.ProvidingApp());
end;