Friday, June 21, 2024

ErrorInfo Object Variable - Show the action message on error message

Hello Friends,

Developers can now set the Title property on Error dialogs that are presented to the user to enrich issue description. On top of that, using the ErrorInfo object, developers can add up to three custom actions that will be displayed on the Error dialog to provide users with corrective actions. This can be achieved by calling the AddAction method on the ErrorInfo object, which can be passed to AL methods that support ErrorInfo such as Error, TestField, FieldError, and others.

The AddAction method accepts three parameters:

  • Caption: The text string that appears as the caption of the action in the error UI.
  • CodeunitID: The ID of the Codeunit to run when the action is initiated from the error UI. The codeunit should contain at least one global method to be called by the error action. The global method must have an ErrorInfo data type parameter for accepting the ErrorInfo object.
  • Method Name: The name of the method in the Codeunit, which is specified by the CodeunitID parameter, that you want to run for the action.


One more useful ErrorInfo variable we can use for provide ERROR Message with actions

we can have multiple actions on error message itself to open relevant setup or master page

this will very convenient for user to Navigate to correct page for fixing any issue
















in above error there are two action showing Open Gen. Journal Template & Open Source Code Setup
 
this can possible using ErrorInfo variable
 
Sample Code:

codeunit 75030 INT_Sample_ErrorInfo
{


    trigger OnRun()
    var
        GenJournalLine: Record "Gen. Journal Line";
        ErrorInfo: ErrorInfo;
        SameSourceCodeErr: Label 'Journal Source Code %1 is same as Source Code set
for Purcase/Sales documents. This is not allowed when using deferrals.
If you want to use this journal for deferrals, please update Source Codes
on Gen Journal Template and generate line again.', Comment = '%1->Source Code';
        OpenGenJournalTemplateDescTxt: Label 'Open Gen. Journal Template page to
update Source code.';
        OpenSourceCodeSetupDescTxt: Label 'Open Source Code Setup page to check
Source code setup.';
    begin
        ErrorInfo.ErrorType(ErrorType::Client);
        ErrorInfo.Verbosity(Verbosity::Error);
        ErrorInfo.Message(StrSubstNo(SameSourceCodeErr, GenJournalLine."Source Code"));
        ErrorInfo.TableId(GenJournalLine.RecordId.TableNo);
        ErrorInfo.RecordId(GenJournalLine.RecordId);
        ErrorInfo.AddAction('Open Gen. Journal Template', Codeunit::"INT_Sample_ErrorInfo",
'ShowGenJournalTemplate', OpenGenJournalTemplateDescTxt);
        ErrorInfo.AddAction('Open Source Code Setup', Codeunit::"INT_Sample_ErrorInfo",
'ShowSourceCodeSetup', OpenSourceCodeSetupDescTxt);
        Error(ErrorInfo);
    end;

    procedure ShowGenJournalTemplate(ErrorInfo: ErrorInfo)
    var
        GenJournalTemplate: Record "Gen. Journal Template";
        GenJournalLine: Record "Gen. Journal Line";
        GeneralJournalTemplates: Page "General Journal Templates";
        RecordRef: RecordRef;
    begin
        RecordRef := ErrorInfo.RecordId.GetRecord();
        RecordRef.SetTable(GenJournalLine);
        GenJournalTemplate.SetRange(Name, GenJournalLine."Journal Template Name");
        GeneralJournalTemplates.SetTableView(GenJournalTemplate);
        GeneralJournalTemplates.RunModal();
    end;

    procedure ShowSourceCodeSetup(ErrorInfo: ErrorInfo)
    var
        SourceCodeSetup: Page "Source Code Setup";
    begin
        SourceCodeSetup.RunModal();
    end;
}


No comments:

Post a Comment