Articles in this section
Category / Section

How to add a WebAPI Data Processing Extension for Report Designer


This articles explains the Data Processing Extensions providing the additional data source supports, which is not available in built-in Report Designer. You can find the following steps to add the WebAPI Data Processing Extension for Report Designer.

  1. You need to refer the below attached and queryinputdialog.js script files in your application. Extension scripts

            <script src="~/Scripts/extension/"></script>
            <script src="~/Scripts/extension/queryinputdialog.js"></script>
  2. Provide the extension details for ReportDesigner with ReportDataExtensions property as shown in following code example.


        <div style="width:100%; height:100%; position:absolute;">
            @{Html.Bold().ReportDesigner("designer").ServiceUrl("/api/DesignerAPI").   ReportDataExtensions    (ext => { ext.ClassName("WebAPIDataSource").Name("WebAPI".    ImageClass    ("e-reportdesigner-datasource-webapi").DisplayName("WebAPI").Add(; }).    Render();}
  3. Add the following codes in script tag to get a WebAPI dialog when using the WebAPI Extension.

        <script type="text/javascript">
            var qryOptions = null;
            var webApiQueryDialog = null;
            if (ej.isNullOrUndefined(webApiQueryDialog)) {
                webApiQueryDialog = new QueryInputDialog($('#designer'));
            if (!ej.isNullOrUndefined(webApiQueryDialog)) {
                qryOptions = {
                    toolbarRendering: $.proxy(webApiQueryDialog.renderToolbarItems, webApiQueryDialog),
                    datasetLoaded: $.proxy(webApiQueryDialog.enableButton, webApiQueryDialog),
                    dataModeChanged: $.proxy(webApiQueryDialog.enableButton, webApiQueryDialog)
            function controlInitialized(args) {
            var designer = $("#designer").data('boldReportDesigner');
                designer.setModel({queryDesignerOptions: qryOptions });
  4. Attach the WebAPI Data Processing Extension in your application as shown in following help documentation.

WebAPI Data Processing Extension

You can download the following sample for Bold Report Designer with the WebAPI Data Processing Extension.

MVC Report Designer with WebAPI Data Processing Extension

Was this article useful?
Help us improve this page
Please provide feedback or comments
Comments (0)
Please  to leave a comment
Access denied
Access denied