Using Controller Class in Developing SSRS Reports in Microsoft Dynamics AX 2012

Overview

Controller class is used to control the report execution as well as preprocessing of the report data. The SSRS reporting framework uses this class to modify the report dialogs, calling the SQL Server reporting services, as well preprocessing parameters for the report.

Following are the scenarios where Controller class can be used:

  1. Modifying a report query based on the input data
  2. Modifying report contract data based on the input data
  3. Control a report parameters dialog
  4. Open different reports/designs from the same menu item based on the input data
  5. Reports that are opened from a form

To create a controller class, extend it with SrsReportRunController.

Prerequisites

  1. Microsoft Dynamics AX 2012
  2. Reporting services extensions must be installed in Dynamics AX

Sample Controller Class

  1. Create a new class. Open AOT → Classes
  2. Right Click on Classes and select New Class. Name it as SSRSDemoController.
  3. example of creating a new class in Dynamics AX
     

  4. Open the Class declaration by right clicking on it and selecting View code.
  5. example of viewing code in AOT class AX
     

  6. Now write the following code:
  7. Create a new method and write the following code:
  8. Examples of Controller Class Usage

    Based on different scenarios, different methods are overridden as shown in the following examples:

    1. Modifying report query based on the input data

      • Used in those scenarios where a report query needs to be modified based on the caller args parameters or recorded before the report parameter dialog is rendered.
      • Override prePromptModifyContract method to modify the report query as shown below:

      Note: prePromptModifyContract is called by report controller before the parameter dialog is shown to the User.

    2. Modifying report contract data based on the input data

      • Used in those scenarios where report contract parameters need to be modified based on the caller args prior to the execution of the report.
      • Override preRunModifyContract method to modify the report contract as shown below:

      Note: preRunModifyContract is called by report controller before the report is run.

    3. Control report parameters dialog

      • In some scenarios, a report parameter dialog should not be visible to the end user. Controller class is also used to control the visibility of the report parameter UI.
      • Add the following code in the main method of the controller class before startOperation method call to hide/show the report parameter UI:

    4. Open different reports from the same menu item based on the input data

      • It is used in those scenarios where different reports or different designs of a same report need to be opened from a same menu item depending upon the caller args.
      • Write the following code in main method to achieve this scenario:

    5. Reports that are opened from a form

      • Controller class is also used when reports are opened from a form and are needed to show selected record details.
      • Use either prePromptModifyContract method or preRunModifyContract method to achieve this scenario.
    January 30, 2014
  • Zahir Hussain

    Hi,

    In my case, I have two different report designs. Based on purchase type i need to locate the different report designs. For example, if my purchase type is “purchase order” i need to show the report design 1 and if my
    purchase type is “returned order”, i need to show the report design 2 from the same copy/original product receipt button.

    How to do that? any idea? Is that can be done through SSRS controller classes?

    Regards,

    Zahir

    • Hi Zahir,

      Yes, it can be done
      through controller classes. You can use the following code snippet to achieve
      this:

      if(PurchaseType == PurchaseOrder)

      {

      //set the report name and report design to
      run
      ssrsDemoController.parmReportName(ssrsReportStr(ReportName,ReportDesign1));

      }

      else if(PurchaseType == ReturnedOrder)

      {

      //set the report name and report design to
      run ssrsDemoController.parmReportName(ssrsReportStr(ReportName,ReportDesign2));

      }

      Hope this helps.

  • Cody Thimm

    I have a Query-based report, not a DP-based one. When I create a controller class with the main() method as you have it, and connect the Menu Item to that, it works just fine. However, my Query object has one range set on it. So when running the report, the dialog shows and expects the userto enter a value. This is okay, because this is a request by the business to have it function this way when running it directly from the Menu structure. However, there is a case where this report is wanted to be executed from a form and depending on the record that is selected, the report should run using that instead of manually having the user specify it. So, I overrode the prePromptModifyContract to use the args().record() which I set in the code of the form (this part works) however, this.getFirstQuery() results in a null object and I get a stack trace error sayingQueryBuildRange object not initialized when this line in your example is executed. I think this post was written for people already using DP-based reports, but what about people using Query-based reports? How would you suggest I properly intervene the parameters without involving the end-user?