The Microsoft.Dynamics.Nav.Types.Report assembly contains the following types that you can use to for programmed report layout upgrades in upgrade codeunits.

DeleteAction Enumeration

IReportUpgradeSet Interface

The Microsoft.Dynamics.Nav.DocumentReport assembly contains several types for creating and managing report layouts. With regards to upgrading report layouts, only the ReportUpgradeCollection class is relevant.

ReportUpgradeCollection Class

1. Create a codeunit and set the SubType Property (Codeunit) to Upgrade.

2. Create a new local function called UpgradeReportLayout, and then do the following:

   • Define a parameter that has the name TestMode and datatype Boolean.
     
   • Define the following variables:
     

     Name	DataType	SubType
     ReportUpgradeSet	DotNet	Microsoft.Dynamics.Nav.Types.Report.IReportUpgradeSet.'Microsoft.Dynamics.Nav.Types.Report, Version=8.0.0.0, Culture=neutral, PublicKeyToken=31bf3856ad364e35'
     ReportUpgradeCollection	DotNet	Microsoft.Dynamics.Nav.DocumentReport.ReportUpgradeCollection.'Microsoft.Dynamics.Nav.DocumentReport, Version=8.0.0.0, Culture=neutral, PublicKeyToken=31bf3856ad364e35'
     DeleteAction	DotNet	Microsoft.Dynamics.Nav.Types.Report.ReportChangeOptions+DeleteAction.'Microsoft.Dynamics.Nav.Types.Report, Version=8.0.0.0, Culture=neutral, PublicKeyToken=31bf3856ad364e35'
     DocumentReportMgt	Codeunit	Document Report Mgt.

3. Add the following code to the UpgradeReportLayout function.

   Copy Code

   // Instantiate the ReportUpgradeCollection variable ReportUpgradeCollection := ReportUpgradeCollection.ReportUpgradeCollection; // Calculate the set of changes for all layouts in the current database DocumentReportMgt.CalculateUpgradeChangeSet(ReportUpgradeCollection); // Example code snippet for applying a "breaking" change to a report design. // The example uses report 1306 Mini Sales - Invoice. ReportUpgradeSet := ReportUpgradeCollection.AddReport(1306); IF NOT ISNULL(ReportUpgradeSet) THEN BEGIN // Delete the text content control for the CompanyIBAN column and replace with empty text string) ReportUpgradeSet.DeleteField('CompanyIBAN', '/Header', DeleteAction.DeleteContent, ''); // Delete the text content control for the UnitPrice and replace the control with the text Deleted. ReportUpgradeSet.DeleteField('UnitPrice', '/Header/Line', DeleteAction.ReplaceWithText, 'Deleted'); // Delete the control containing the field. ReportUpgradeSet.DeleteField('Quantity_ShipmentLine', '/Header/Line/ShipmentLine', DeleteAction.DeleteNode, ''); // Rename the VariantCode_AssemblyLine field ReportUpgradeSet.ChangeField('VariantCode_AssemblyLine', 'VariantCode_NewAssemblyLine', '/Header/Line/AssemblyLine', '/Header/Line/AssemblyLine'); END; // Apply the upgrade steps to the report layouts DocumentReportMgt.ApplyUpgradeToReports(ReportUpgradeCollection,TestMode);

   The UpgradeReportLayout function instantiates a report upgrade collection object and calculates the change set based on the current report dataset designs and the XML documents that are stored with the custom report layouts in the application database. Then, it adds additional changes to the custom report layouts for report 1306, including deleting fields and renaming a field.

   Finally, the DocumentReportMgt.ApplyUpgradeToReports method applies all the updates to report layouts in the current database. If the TestMode parameter is True, the layout changes are only tested and will not be committed to the database.

4. Add a function called TestLaypoutUpgrade and set the FunctionType Property (Upgrade Codeunits) to CheckPrecondition. Add the following code:

   	Copy Code
   UpgradeReportLayout(FALSE);

   The defines a CheckPrecondition function type, which is the first function that is executed when the codeunit is run. This function will test the report layout changes before they are applied to the layouts in the database. If an error occurs when this function is run, then the changes are not applied.

5. Add a function called RunLayoutUpgrade and set the FunctionType Property (Upgrade Codeunits) to UpgradePerDatabase. Add the following code:

   	Copy Code
   UpgradeReportLayout(TRUE);

   This function is run after the CheckPrecondition function to perform the upgrade the report layouts.

6. Save and compile the codeunit.

7. Perform a data upgrade to run the upgrade codunit.

   Open development environment as an administrator. On the Tools menu, choose Data Upgrade, and then choose Start and follow the instructions.

   Note
   You can also perform the data upgrade by running the Start-NavDataUpgrade cmdlet from the Microsoft Dynamics NAV 2017 Administration Shell.