Microsoft Business Central - Substituting Reports

Hello Friends,

Microsoft Business Central Provide new Substituting Report event to replace the standard system report with custom report.

It is possible to substitute reports from the base application with custom reports. This can be done by subscribing to the OnAfterSubstituteReport event published by Codeunit 44 – ReportManagement.

The following code illustrates how to subscribe a method to the OnAfterSubstituteReport event. This method replaces the report specified by the ReportId with the one given by the NewReportId parameter. In this example the "Customer - List" report will be substituted for "My New Customer - List".

codeunit 50100 "Substitute Report" { [EventSubscriber(ObjectType::Codeunit, Codeunit::ReportManagement, 'OnAfterSubstituteReport',
'', false, false)] local procedure OnAfterSubstituteReport(ReportId: Integer; var NewReportId: Integer) begin if ReportId = Report::"Customer - List" then NewReportId := Report::"My New Customer - List"; end; }

When the OnAfterSubstituteReport event is raised, the event subscriber method is called and the replacement takes place.

 Note

The event is called OnAfterSubstituteReport to match the pattern followed by other events in the ReportManagement codeunit, but the subscriber will be invoked before the substitution takes place.

The OnAfterSubstituteReport event is raised when:

1. The user activates a page action that runs the report to be substituted, that is, an action that has the RunObject Property set to the report.
2. The report is invoked from the Tell Me window.
3. The report is called by one of the following static methods:
   • Run Method
   • RunModal Method
   • SaveAsHtml Method
   • SaveAsXml Method
   • SaveAsPdf Method
   • SaveAsExcel Method
   • SaveAsWord Method
   • RunRequestPage Method
   • Execute Method
   • Print Method
   • SaveAs Method

For more information about raising events, see Raising Events.

Good practices

• Consider using the same caption for both reports, given by the Caption Property. Consequently, any links and action captions that lead to the report will match the report itself. This is also relevant for bookmarks linked to a report, since they maintain the caption of the original report, even if it has been substituted for one with another caption.
• Consider hiding the original report from the TellMe window if it is no longer valuable to all users. You can do this by setting the original report to UsageCategory Property to None.
• Consider enhancing the code of the subscriber method to check if the report has already been replaced with another extension. This is done by comparing the ReportId and NewReportId parameters before making the change, such that if the value of the NewReportId parameter is different from the value of the ReportId parameter and different from -1, it means that the report has already been substituted for another subscriber of the OnAfterSubstituteReport event.

 Important

Make sure that if a report is called on code, you use a compatible report to replace it to avoid run time errors.

Source of Link-

https://docs.microsoft.com/en-us/dynamics365/business-central/dev-itpro/developer/devenv-substituting-reports