ComponentOne Studio Web API Edition
Using Standard Visual Studio Web API Template

Complete the following steps to configure FlexReport Web API using standard Visual Studio Template for Web API:

Step 1: Configure Web API Project

Complete the following steps to configure Web API project:

  1. Create a new ASP.NET Web API Project.
  2. Add the FlexReport Web API package from GrapeCity NuGet.

    If you have installed MVC Edition, the GrapeCity NuGet source path gets already set inside Visual Studio.

    Alternatively, you can manually add the source path from NuGet Package Manager | Package Sources option available in Options dialog box, which appears on selecting Tool | NuGet Package Manager | Package Manager Settings, as discussed in Configuring NuGet Package Sources topic.
    In the NuGet package manager the Report Service is listed as shown in the following image:

    FlexReport Web API adds the following references to the project:

  3. License your Web API application. Create a licenses.licx file within Properties folder of your application and add the following code in it:
    Copy Code
    C1.Web.Api.LicenseDetector, C1.Web.Api
    C1.Web.Api.Report.LicenseDetector, C1.Web.Api.Report

Back to Top

Step 2: Add Report files to the Project

  1. Create a folder named Files in your application.
  2. Add the FlexReport Definition file to it.

    If the report is using any local database (such as MDB or MDF files), then add the database file to the App_Data folder of your project. However, make sure that the connection string of the reports are pointing to the App_Data folder accordingly.

Back to Top

Step 3: Set Report's Root Location and Use C1 Web APIs

  1. Open the Startup.cs file and add the following code to Configuration method:
    Copy Code
    public void Configuration(IAppBuilder app)
        var folder = GetFullRoot("Files");
        app.AddDiskStorage("root", folder);

    Note: Make sure you add Microsoft.Owin.Cors Nuget package in your application, for app.UseCors();
  2. Add the following GetFullRoot function in the startup class.
    Copy Code
    private static string GetFullRoot(string root) {
    var applicationBase = AppDomain.CurrentDomain.SetupInformation.ApplicationBase;
    var fullRoot = Path.GetFullPath(Path.Combine(applicationBase, root));
    if (!fullRoot.EndsWith(Path.DirectorySeparatorChar.ToString(), StringComparison.Ordinal)) {
        fullRoot += Path.DirectorySeparatorChar;
      return fullRoot;
  3. Open Web.Config and add the following entry under handlers inside system.webServer Node.
    Copy Code
    <add name="ExtensionlessUrlHandler-Integrated-4.0" path="api/*" verb="*" type="System.Web.Handlers.TransferRequestHandler" preCondition="integratedMode,runtimeVersionv4.0" />
  4. In the Web.config file, ensure that the WebDAVModule and the WebDAV handler are removed from <system.webServer> as shown below:
    Copy Code
          <remove name="WebDAVModule" />
          <remove name="WebDAV" />

Back to Top

Step 4: Deploy Report Web API Service

  1. Compile the project.
  2. Deploy the project to IIS.

The Web API URL, for service hosted on local IIS, will be http://localhost/FlexReportwebAPI/api/report.

Note: Once you have successfully created Web API URL for Report Services, you can access and view reports stored in the service using FlexViewer for MVC and Wijmo Viewer. For more information on how to view reports, see Viewing Reports in FlexViewer.



Copyright © GrapeCity, inc. All rights reserved.

Product Support Forum |  Documentation Feedback