Ticomix.TelerikReporting

Purpose Statement

A .NET library that provides comprehensive Telerik Reporting integration for web applications, enabling report design, viewing, and management capabilities with support for both Angular and MVC frameworks. Built on Telerik Reporting 18.1.24.709 with enhanced features for enterprise reporting solutions.

Technical Context

• Built on Telerik Reporting Suite version 18.1.24.709
• Supports .NET 6.0 and .NET 8.0 frameworks
• Integrates with Entity Framework Core for data management
• Includes distributed caching and session management
• Compatible with both Angular SPA and MVC applications
• Uses SQL Server for distributed locking and caching

Key Capabilities

• Report Designer Integration: Web-based report designer with full Telerik functionality
• Report Viewer: Responsive report viewing with export capabilities
• Report Management: Complete lifecycle management including versioning, subscriptions, and scheduling
• Multi-Framework Support: Works with both Angular and MVC web applications
• Database-Driven Reports: Entity Framework Core integration for dynamic report generation
• Subscription System: Automated report delivery and parameter management
• Export Formats: Support for PDF, Excel, Word, CSV, and other formats via OpenXML rendering
• Distributed Architecture: Built-in support for distributed caching and locking mechanisms

Integration Points

• Seamlessly integrates with Ticomix.EFCore for database operations
• Works with Ticomix.AspNetCore.Mvc.Kendo for enhanced MVC functionality
• Compatible with Ticomix.AspNetCore.Web for web application features
• Integrates with SQL Server distributed cache and session management
• Supports custom authentication and authorization workflows

Use Case Scenarios

• Enterprise applications requiring advanced reporting capabilities
• Multi-tenant applications with report isolation and management
• Applications needing scheduled report delivery and subscriptions
• Systems requiring report versioning and audit trails
• Organizations migrating from legacy reporting solutions to modern web-based platforms
• Applications requiring both interactive report design and consumption

Database Models Used

The package requires the following database models to be added to your application:

• ReportFile: Stores report definition files and metadata
• ReportFolder: Hierarchical organization of reports
• ReportHeader: Main report metadata and configuration
• ReportSubscriptionParameter: Parameter definitions for scheduled reports
• ReportSubscriptionTelerik: Telerik-specific subscription settings
• ReportSubscriptionRun: Execution history and status tracking
• ReportVersion: Version control for report definitions
• SysJobStatus: Background job status tracking
• ErrorLog: Comprehensive error logging and monitoring

Additional context files required:

• ApplicationDbContextErrorLog.cs
• ApplicationDbContextTelerikReporting.cs

Classes and Functions

Core Controllers

• TelerikReportDesignerController: Handles report designer web service requests
• TelerikReportViewerController: Manages report viewer functionality
• ReportDesignerController: Custom report designer operations
• ReportViewerController: Custom report viewing operations

Helper Classes

• ReportHelper: Utility functions for report operations and management

ViewModels

• ReportHeaderViewModel: Data transfer object for report metadata

Installation Instructions

Prerequisites

Ensure your application has the following NuGet packages installed:

• Ticomix.TelerikReporting
• Ticomix.AspNetCore.Mvc.Knedo
• Ticomix.AspNetCore.Web
• Ticomix.Common
• Ticomix.EFCore

Database Setup

1. Add the required database models and migrations to your project
2. Include the context files in your \Data folder
3. Run database migrations to create the necessary tables

ASP.NET Core Configuration

Startup.cs / Program.cs Changes

1. Configure Swagger (exclude Telerik controllers):

services.AddSwaggerGen(c =>
{
    c.DocInclusionPredicate((docName, apiDesc) =>
    {
        if (apiDesc.ActionDescriptor is ControllerActionDescriptor desc && 
            desc.ControllerTypeInfo.Assembly.FullName.StartsWith("Telerik"))
        {
            return false;
        }
        return apiDesc.GroupName == null || apiDesc.GroupName == docName;
    });
    c.SchemaFilter<NullableSchemaFilter>();
});

2. Configure Globalization:

Globals.SupportedCultures = CultureInfo.GetCultures(CultureTypes.SpecificCultures);
Globals.DefaultCulture = new CultureInfo("en-US");

3. Add User Roles:

UserRoleHelper.CreateUserRole("Telerik Report View", 
    Description: "Ability to view Telerik Reports");
UserRoleHelper.CreateUserRole("Telerik Report Edit", 
    Description: "Ability to create and edit Telerik Reports through the web report designer.");

4. Configure Services:

// Distributed Cache
services.AddDistributedSqlServerCache(options =>
{
    options.ConnectionString = Configuration.GetConnectionString("DefaultConnection");
    options.SchemaName = "dbo";
    options.TableName = "DistributedCacheTable";
});

// Session Management
services.AddSession();

// Distributed Locking
services.AddSingleton<IDistributedLockProvider>((services) => 
    new SqlDistributedSynchronizationProvider(Configuration.GetConnectionString("DefaultConnection")));

// Logging
services.AddScoped<ILogger, Ticomix.Common.Helpers.Logger<int>>();
services.AddScoped<Microsoft.Extensions.Logging.ILogger>((sp) => sp.GetRequiredService<ILogger>());

// Cancellation Token
services.AddScoped(typeof(CancellationToken), serviceProvider =>
{
    IHttpContextAccessor httpContext = serviceProvider.GetRequiredService<IHttpContextAccessor>();
    return httpContext.HttpContext?.RequestAborted ?? CancellationToken.None;
});

// Telerik Reporting Configuration
services.Configure<Ticomix.TelerikReporting.TelerikReportingOptions>(options =>
{
    Configuration.Bind("TelerikReporting", options);
});
services.AddTelerikReporting<int>();

5. Configure JSON Serialization:

services.AddControllers(c =>
{
    c.Conventions.Add(new ApiExplorerGroupPerVersionConvention());
}).AddJsonOptions(options =>
{
    options.JsonSerializerOptions.PropertyNamingPolicy = null;
}).AddNewtonsoftJson(options =>
{
    options.SerializerSettings.ContractResolver = new DefaultContractResolver();
});

6. Configure Middleware:

app.UseSession();

wwwroot Setup

1. Create a wwwroot folder in your server project root
2. Create a Reports subfolder
3. Copy Blank Report.trdp into the Reports folder for new report creation

Angular Integration

For Angular applications, you'll need the companion NPM package:

NPM Package: @ticomix/telerik-reporting

Angular Files Required

• src/typings.d.ts
• src/app/telerik-reporting/ folder with components
• src/app/standalone.service.ts
• src/app/standalone-routes.ts
• Update app.component.html for standalone page logic

Additional Dependencies

• Copy kendo.all.min.js to public/js folder

URL Rewriting (web.config)

For proper routing when designer/viewer opens in new tabs:

<system.webServer>
    <rewrite>
        <rules>
            <rule name="Angular Routes" stopProcessing="true">
                <match url="^(designer|viewer)(/.*)?$" />
                <conditions logicalGrouping="MatchAll">
                    <add input="{REQUEST_FILENAME}" matchType="IsFile" negate="true" />
                    <add input="{REQUEST_FILENAME}" matchType="IsDirectory" negate="true" />
                </conditions>
                <action type="Rewrite" url="/" />
            </rule>
        </rules>
    </rewrite>
</system.webServer>

MVC Integration

For MVC applications, the same server-side configuration applies. Additional MVC-specific views and controllers can be copied from Demo as needed.

Dependencies

Core Dependencies

• Telerik.Reporting (18.1.24.709)
• Telerik.Reporting.Services.AspNetCore (18.1.24.709)
• Telerik.WebReportDesigner.Services (18.1.24.709)
• Telerik.Reporting.OpenXmlRendering (18.1.24.709)
• Telerik.Reporting.WebServiceDataSource (18.1.24.709)

Utility Dependencies

• CsvHelper (33.0.1)
• Reinforced.Typings (1.6.3.21)
• DistributedLock.SqlServer (1.0.5)

Ticomix Dependencies

• Ticomix.EFCore (via project reference)

Support and Documentation

For Angular UI components and additional documentation, visit:

• Angular Components Documentation

Version Compatibility

• .NET 6.0+
• .NET 8.0+
• Entity Framework Core 6.0+
• SQL Server 2016+
• Angular 12+