Corprio.AspNetCore.XtraReportSite 2.0.25.2

Corprio.AspNetCore.XtraReportSite

What is Corprio.AspNetCore.XtraReportSite for?

The Corprio.AspNetCore.XtraReportSite is the base library for develpers to build a web applicaiton working with Corprio using ASP.NET Core and need to execute reports in the web application. If your application does not need to execute reports, then you can use Corprio.AspNetCore.Site instead.

Technology

The application is developed using ASP.NET Core 8, DevExtreme and XtraReports.

To start

Follow the steps below to start building your web applicaiton with Corprio.

Prepare the development environment

Download and install the latest version of Visual Studio from Microsoft. You will need to select components for building ASP.NET Core applications.

Clone Corprio.Internal solution

Your web application needs to work the Corprio API. Instead of directly calling the online API, you can clone the Corprio.Internal repository onto your development machine so that you can have the Corprio API server running in your development machine.

Start new web application

1. Launch Visual Studio
2. Create a new project
3. Select the ASP.NET Core Web App (Model-View-Controller) template using C#
4. Right click on the project and select Manage NuGet Packages
5. Search for Corprio.AspNetCore.XtraReportSite and install the package
6. Create a class to get data for your reports running in this application. For example

/// <summary>
/// Service for getting data for reports
/// </summary>
public class ReportDataService : BaseReportDataService
{
        /// <summary>
        /// Constructor
        /// </summary>
        /// <param name="httpContextAccessor">HttpContextAccessor for getting organization ID from HttpContext</param>
        /// <param name="corprio">Corprio client for getting data from server</param>
        public ReportDataService(IHttpContextAccessor httpContextAccessor, APIClient corprio, IHttpClientFactory httpClientFactory) : base(httpContextAccessor, corprio, httpClientFactory)
        {
        }

        public override IEnumerable<Type> GetAvailableTypes(string context)
        {
            return new Type[] {
                //put the data types of your report data here, e.g. MySalesReportData
                };
        }

        public override System.Collections.IEnumerable GetReportData(Type dataType, Guid organizationID, Dictionary<string, object> parameters)
        {
            //add code to return data for each of your report data type 
            throw new NotSupportedException($"DataType {dataType} is not supported");
        }

        public override IEnumerable<Corprio.DataModel.Report.Parameter> GetParametersOfDataType(Type reportDataType, string[] supportedLanguages)
        {
            //add code to return an array of Parameter for prompting users before executing the report
            return Array.Empty<Corprio.DataModel.Report.Parameter>();
        }
}

7. Edit the Startup.cs and modify ConfigureServices as

public void ConfigureServices(IServiceCollection services)
{
	services.AddCommonAppServices(Configuration);
	services.AddXtraReports<ReportDataService>();
}

8. Edit appsettings.Development.json to include the following sections

  "CorprioApiSetting": {
    "AuthServerUrl": "https://localhost:44334", //replace with the port of your local AuthServer project
    "ApiUrl": "https://localhost:44394", //replace with the port of your local Corprio API project
    "ApiVersion": "1.0"
  },
  "CorprioClientCredential": {
    "ClientID": "your app ID", //replace with the ID of your application which will be used to register your application in Corprio Portal
    "ClientSecret": "xxxxxxxxxxxxxxxxxxx" //replace with the secret of your application
  },