Ready to get started?

Learn more about the CData ADO.NET Provider for Magento or download a free trial:

Download Now

Publish Crystal Reports on Magento Data

Use the Report Wizard and standard ADO.NET to design a report based on up-to-date Magento data.

The CData ADO.NET Provider for Magento is fully integrated into the Crystal Reports for Visual Studio development environment. You can use the standard ADO.NET components to create reports just like you would work with SQL Server, but with real-time connectivity to Magento. This article shows how to complete the three steps necessary to add Magento data to a report that refreshes when opened.

Note: You will need to install Crystal Reports, developer version for Visual Studio to follow this tutorial.

Create a Crystal Reports Application

To follow this article, you will also need a Visual Studio Crystal Reports project. This article will add a report to a WPF application. You can create one by clicking File -> New Project and then selecting the Crystal Reports WPF Application template. In the resulting wizard, select the option to create a blank report.

Connect to Magento

Creating an ADO.NET data source for Magento from Server Explorer makes it easy to create a DataSet that can be used in Crystal Reports wizards and the Crystal Reports Designer. You can find a guide to working with Magento data in Server Explorer in the "Getting Started" chapter of the help documentation.

Magento uses the OAuth 1 authentication standard. To connect to the Magento REST API, you will need to obtain values for the OAuthClientId, OAuthClientSecret, and CallbackURL connection properties by registering an app with your Magento system. See the "Getting Started" section in the help documentation for a guide to obtaining the OAuth values and connecting.

You will also need to provide the URL to your Magento system. The URL depends on whether you are using the Magento REST API as a customer or administrator.

  • Customer: To use Magento as a customer, make sure you have created a customer account in the Magento homepage. To do so, click Account -> Register. You can then set the URL connection property to the endpoint of your Magento system.

  • Administrator: To access Magento as an administrator, set CustomAdminPath instead. This value can be obtained in the Advanced settings in the Admin menu, which can be accessed by selecting System -> Configuration -> Advanced -> Admin -> Admin Base URL.

    If the Use Custom Admin Path setting on this page is set to YES, the value is inside the Custom Admin Path text box; otherwise, set the CustomAdminPath connection property to the default value, which is "admin".

Create a DataSet

Follow the steps below to use the Visual Studio ADO.NET DataSet Designer to create an ADO.NET DataSet object. Crystal Reports will bind to the DataSet object, which contains Magento table metadata. Note that this approach also adds a connection string to App.config; you will use this connection string later to load data into the report.

  1. In the Solution Explorer, right-click your project and then click Add -> New Item.
  2. Select DataSet. The DataSet Designer is then displayed.
  3. Drag and drop tables from Server Explorer onto the DataSet Designer. This article uses the Products table.

Add Magento Fields to the Report

Follow the steps below to add columns from the DataSet to the report:

  1. Double-click the .rpt file in the Solution Explorer to open the Crystal Reports Designer.
  2. Right-click the designer and click Database -> Database Expert.
  3. Expand the Project Folder and ADO.NET DataSets nodes and drag the DataSet you created into the Selected Tables box. The fields are now accessible from the Field Explorer.
  4. Drag and drop fields from the Field Explorer to the Details section or another section of your report.

Load Data into the Report

Having created the DataSet, which will only contain the metadata, you will now need to create the DataTable containing the actual data. You can use the MagentoDataAdapter to fill a DataTable with the results of an SQL query.

  1. Add a reference to System.Configuration.dll to your project to be able to use the connection string from App.config.
  2. In App.config, add the following code to the configuration node for compatibility with Crystal Reports when working with .NET 4.0:
    
      <startup useLegacyV2RuntimeActivationPolicy="true">
        <supportedRuntime version="v4.0" sku=".NETFramework,Version=v4.0"/>
      </startup>
    
  3. Add the following references in your Window.xaml.cs file:

    using System.Configuration;
    using CrystalDecisions.CrystalReports.Engine;
    using CrystalDecisions.Shared;
    using System.Data.CData.Magento;
    using System.Data;
    
  4. Add the following Window_Loaded method in your Window.xaml.cs to execute the SQL query that will return the DataTable. Note that your query needs to select at least the same columns used in your report.

    private void Window_Loaded(object sender, RoutedEventArgs e) {
      ReportDocument report = new ReportDocument();
      report.Load("../../CrystalReport1.rpt"); 
     var connectionString = ConfigurationManager.ConnectionStrings["MyAppConfigConnectionStringName"].ConnectionString;
      using (MagentoConnection connection = new MagentoConnection(connectionString)) {
        MagentoDataAdapter dataAdapter = new MagentoDataAdapter(
        "SELECT Name, Price FROM Products", connection);
         DataSet set = new DataSet("_set");
         DataTable table = set.Tables.Add("_table");
         dataAdapter.Fill(table);
         report.SetDataSource(table);
      }
      reportViewer.ViewerCore.ReportSource = report;
    }
    
  5. In the Window.xaml file, add the Loaded event so that your Window tag resembles the following:

    
    <Window x:Class="CrystalReportWpfApplication4.Window1"
            xmlns="http://schemas.microsoft.com/winfx/2006/xaml/presentation"
            xmlns:x="http://schemas.microsoft.com/winfx/2006/xaml"
            xmlns:cr="clr-namespace:SAPBusinessObjects.WPF.Viewer;assembly=SAPBusinessObjects.WPF.Viewer"
            Title="WPF Crystal Report Viewer" Height="600" Width="800" Loaded="Window_Loaded">
            ...
    </Window>
    
  6. Run the report. When the report is loaded, the provider executes the query to retrieve the current data.

Chart Magento Data

You can also use the DataSet with experts like the Chart Expert:

  1. Right-click in the Crystal Reports Designer and click Insert -> Chart.
  2. Select the Report Header or Report Footer section. The Chart Expert is then displayed.
  3. On the Type tab, select the chart type. This article uses a side-by-side bar chart.
  4. On the Data tab, select the column and conditions for the x-axis. For example, drag the Name column in the DataSet node onto the box under the On Change Of menu.
  5. Select the x-axis column and click the TopN and Order buttons to configure sorting and limiting.
  6. Select the columns and summary operations for the y-axis. For example, drag the Price column in the DataSet node into the Show Values box.
  7. Run the report.

Note that Crystal Reports performs the aggregation on the data already loaded into DataTable, instead of, for example, executing a GROUP BY to the Magento API. This will also be true for the report creation wizards.

You could gain more control over the queries executed to Magento by creating another DataSet and populating it with a different query. See the help documentation for more information on the driver's SQL engine.