Customizing the Check Report via Extensions in Dynamics 365 for Operations

By Tim Pypa | October 11, 2017

Customizing the check report via extensions in dynamics 365 for operations

Recently I was asked to customize the Cheque_US report in Dynamics 365 for Operations. Based on this guidance from Microsoft I expected it to be a relatively easy and straightforward process. Here’s what I did to customize the check report via extensions:

  1. Duplicate the Cheque_US SSRS report to a model that extends the Application Suite model.

I called my new report MyCheque_US and added some text to indicate that it was the custom report—that way I could tell at a glance if I was looking at the stock report or my custom report.

  1. Create a new class MyChequeController that extends the ChequeController class in the same custom model.

Copy the main() method from ChequeController, and update it to use the report name for MyCheque_US:

 

class MyChequeController extends ChequeController
{
    public static MyChequeController construct()
    {
        return new MyChequeController();
    }

    
    public static void main(Args _args)
    {
        MyChequeController controller = new MyChequeController();
        controller.parmArgs(_args);
        controller.deleteTempData();
        //controller.parmReportName(controller.getChequeReport());
        controller.parmReportName(ssrsReportStr(MyCheque_US, Report));
        controller.parmShowDialog(false);
        controller.parmDialogCaption("@SYS24090");
        controller.startOperation();
    }

}
  1. Extend the Cheque_US output menu item in the same custom model.

Set the Object property to refer to MyChequeController rather than ChequeController

The Object property is changed to MyChequeController rather than ChequeController.

I then compiled my solution and deployed the MyCheque_US report, and when I generated a payment everything worked! Well, almost everything: the custom report displayed as a blank page. I verified that if I switched back to the stock controller code controller.parmReportName(controller.getChequeReport()) then everything printed fine, but if I ran the same data through the MyCheque_US report it would fail every time.

After some digging I came to a startling conclusion. Based on its name and signature, I was trusting getChequeReport() to be a true accessor method:

getChequeReport() was trusted to be a true accessor method.

When I inspected the method itself, though, it quickly became apparent that it was something very different:

 

    /// <summary>
    /// Calls the initialize method and returns a cheque report type.
    /// </summary>
    /// <returns>
    /// A cheque report type.
    /// </returns>
    public SrsCatalogItemName getChequeReport()
    {
        this.init();
        return chequeReport;
    }

 

ChequeController.getChequeReport() violates two method writing best practices: a method should do only one thing, and method names should reveal intention.

The giveaway that getChequeReport() does more than one thing is the “and” in the documentation summary. If you need to use the word “and” when describing what a method does, the method does too many things!

Admittedly, the method name getChequeReport does communicate what the method returns. The problem is that it doesn’t communicate everything that the method does. Had it instead been named initAndGetChequeReport then the intent of the method would be clear (and would clearly indicate that the method does too many things.)

In hindsight it would have been better to split getChequeReport() up into two methods, one to initialize the report and the other to retrieve the report name. In the end I decided that the least risky way to solve my problem was to keep the stock call to parmReportName() in place, and follow it up with another call to parmReportName() to direct execution to my custom report:

 

    public static void main(Args _args)
    {
        MyChequeController controller = new MyChequeController();
        controller.parmArgs(_args);
        controller.deleteTempData();
        controller.parmReportName(controller.getChequeReport());
        controller.parmReportName(ssrsReportStr(MyCheque_US, Report));
        controller.parmShowDialog(false);
        controller.parmDialogCaption("@SYS24090");
        controller.startOperation();
    }

 

Now the report gets properly initialized, and my custom report design is used to generate the check.

Related Posts

Recommended Reading:

5.25.22 Financials

Rounding Numbers in Power Automate

  If you’ve ever tried to round numbers in Power Automate, you have probably already run into the issue there […]

Read the Article

Manage U.S. Use Tax on Purchase Orders in Dynamics 365 Finance and Operations

  Managing sales tax requirements on your business purchase can be complicated, but Dynamics 365 Finance and Operations can help […]

Read the Article
5.19.22 Dynamics CRM

How to Write a Great Support Ticket in the Stoneridge Support Portal

Submitting a support ticket through the Stoneridge Support Portal is a quick and effective way to get assistance for any […]

Read the Article

Managing Your Business Through Uncertain Times Using Dynamics 365 Finance and Operations

  Dynamics 365 Finance and Operations (F&O) can help you make informed decisions on how to move your business forward. […]

Read the Article
5.13.22 Power Platform

Using Power BI Object Level Security

  The following article will demonstrate how to use Power BI Object Level Security to disable column data based on […]

Read the Article
5.12.22 Dynamics CRM

How to Use the Stoneridge Support Portal

Stoneridge Software’s support portal is an intuitive and useful function that makes it easy for you to access resources to […]

Read the Article
5.6.22 Dynamics GP

Dynamics GP Transaction Removal: Purchase Orders

  Are you having performance issues with Purchase Orders?  Do you find that there are old Purchase Orders on your […]

Read the Article
5.5.22 Dynamics GP

The Real Story about the Long-Term Future of Dynamics GP Support

I’ve seen a number of people put forward comment that Dynamics GP is going away and you have to get […]

Read the Article

New Features in Dynamics 365 Business Central 2022 Wave 1 Release – Financial Enhancements

The Dynamics 365 Businses Central 2022 Wave 1 Release has a lot of new and exciting features to help your […]

Read the Article

Start the Conversation

It’s our mission to help clients win. We’d love to talk to you about the right business solutions to help you achieve your goals.

Subscribe To Our Blog

Sign up to get periodic updates on the latest posts.

Thank you for subscribing!

X