ComponentOne Studio Web API Edition
Using ComponentOne Web API Edition Template

If you have installed Web API Edition from C1Studio installer, then it is easy to create a project pre-configured with FlexReport Web API. Use the C1 Web API Template to create a new project named FlexreportWebAPI and follow the steps below:

Step1: Create a new WebAPI application

  1. In Visual Studio, select File | New | Project to create a new Web API Service Project.
  2. Under installed templates, select Visual C# | Web | C1 Web API Application to create a new C1 Web API Service application.
  3. Set a Name and Location for your application, and then Click OK.
  4. In the ComponentOne ASP.NET Web API Application Wizard, select Report services option.

  5. Once you have selected the Services from the wizard, click OK to create a new C1 Web API Service application.

Step 2: Add Report files to Web API Application

Complete the following steps to add report files to your application.

  1. Add a folder named Files to your application.
  2. Add the FlexReport's report definition file to it.
    If the report is using any local database (such as an MDB or an MDF file), then add the database to the App_Data folder of your application. However, make sure that the connection string of the reports are pointing to the App_Data folder accordingly.

    Note: Make sure you add Microsoft.Owin.Cors Nuget package in your application, for app.UseCors();

Back to Top

Step 3: Set Report's Root Location

  1. In the Startup.cs file, add the following code inside Configuration method of the Startup class.
    Copy Code
    .AddFlexReportDiskStorage("ReportsRoot", GetFullRoot("Files"))

    This code registers the folder/location where the Report files will be stored, in this case it is the "Files" folder.

  2. Add the GetFullRoot function inside 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;

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.

Back to Top



Copyright © GrapeCity, inc. All rights reserved.

Product Support Forum |  Documentation Feedback