ErrorInfo.SystemId([Guid]) Method

Article
02/26/2024

Version: Available or changed with runtime version 8.0.

Specifies the system ID of the record that the error relates to.

Syntax

[SystemId := ]  ErrorInfo.SystemId([SystemId: Guid])

Note

This method can be invoked using property access syntax.

Parameters

ErrorInfo
Type: ErrorInfo
An instance of the ErrorInfo data type.

[Optional] SystemId
Type: Guid
The system ID of the ErrorInfo

Return Value

[Optional] SystemId
Type: Guid
The current system ID of the ErrorInfo.

Remark

You can use the SystemId property to transfer data from the code where an error message is shown to the user to the codeunit and method(s) executed by fix-it/show-it actions or where you handle collected errors.

For more information about how to develop actionable errors, see Actionable errors.

For more information about how to handle multiple collected errors, see Collecting errors.

Example (get the SystemId property)

procedure myErrorHandlerProc(MyErrorInfo: ErrorInfo)
var 
    TheSystemId: Guid;
begin
    TheSystemId := MyErrorInfo.SystemId();

    // do something with the data (now we now the system ID for the row)
end

Example (set the SystemId property)


var 
    MyErrorInfo: ErrorInfo;
    MyTableRec: Record "MyTable";
begin
    // setup the error info object: Define Message, DetailedMessage etc.

    // set identifiers for the fix-it action codeunit (or for the AL runtime in case of a show-it action)
    MyErrorInfo.RecordId := MyTableRec.RecordId;
    MyErrorInfo.SystemId := MyTableRec.SystemId;
    MyErrorInfo.TableId := Database::"MyTable";

    // setup fix-it or show-it action(s) for the error info object

    Error(MyErrorInfo);
end