skip navigation
  • Product Bundles

    DevCraft

    All Telerik .NET tools and Kendo UI JavaScript components in one package. Now enhanced with:

    • NEW: Design Kits for Figma
    • Online Training
    • Document Processing Library
    • Embedded Reporting for web and desktop

    Web

    Kendo UI UI for jQuery UI for Angular UI for React UI for Vue UI for Blazor UI for ASP.NET Core UI for ASP.NET MVC UI for ASP.NET AJAX

    Mobile

    UI for .NET MAUI

    Document Management

    Telerik Document Processing

    Desktop

    UI for .NET MAUI UI for WinUI UI for WinForms UI for WPF

    Reporting

    Telerik Reporting Telerik Report Server

    Testing & Mocking

    Test Studio Test Studio Dev Edition Telerik JustMock

    CMS

    Sitefinity

    UI/UX Tools

    ThemeBuilder Design System Kit Templates and Building Blocks

    Debugging

    Fiddler Fiddler Everywhere Fiddler Classic Fiddler Everywhere Reporter FiddlerCore

    Free Tools

    VB.NET to C# Converter Testing Framework
    View all products
  • Overview
  • Demos
    • What's New
    • Roadmap
    • Release History
  • Support and Learning

    • Support and Learning Hub
    • First Steps
    • Docs
    • Demos
    • Virtual Classroom
    • Use Reports in Applications
    • System Requirements
    • Forums
    • Videos
    • Blogs
    • Submit a Ticket
    • FAQs
  • Pricing
  • Shopping cart
    • Account Overview
    • Your Licenses
    • Downloads
    • Support Center
    • Forum Profile
    • Payment Methods
    • Edit Profile
    • Log out
  • Login
  • Contact Us
  • Try now
Search all

Interface IReportServiceConfiguration

Represents an object containing all dependencies and setting which the REST report service needs to operate.

Namespace: Telerik.Reporting.Services
Assembly: Telerik.Reporting.dll

Syntax

public interface IReportServiceConfiguration

Properties

CacheCompressor

Gets or sets the ICompressor instance to be used when saving and retrieving particular assets from the IStorage instance.

Declaration
ICompressor CacheCompressor { get; set; }
Property Value
ICompressor

Remarks

By default it will be set to a GZip compressor. Set to a custom one to use different by implementing ICompressor or set to null to turn off the compression completely.

ClientSessionTimeout

Gets or sets a value in minutes indicating how long a client session will be preserved in the service storage after the last interaction from this client.

Declaration
int ClientSessionTimeout { get; set; }
Property Value
System.Int32

Remarks

The value must be greater than zero.

ExceptionsVerbosity

Gets or sets the verbosity level of the exception information returned in the response when an exception occurs. The supported values are "normal" and "detailed". When set to "normal", the response will contain only the exception message. When set to "detailed", the response will contain the exception type and stack TraceHelper. The default value is "normal".

Declaration
string ExceptionsVerbosity { get; set; }
Property Value
System.String

HostAppId

Gets or sets the unique constant name of the application hosting the reports service.

Declaration
string HostAppId { get; set; }
Property Value
System.String

Remarks

When not set the report service utilizes the AppDomainSetup.ApplicationName Property for the current application domain. This however is not sufficient for each application setup. Set a value for this property in order to provide an unique name among all apps implementing the report service that will be deployed in the same environment.

ReportDocumentResolver

Gets or sets an IReportDocumentResolver implementation instance that will be used from the report processing engine to resolve an IReportDocument instance from the ReportSource in order to process it.

Declaration
IReportDocumentResolver ReportDocumentResolver { get; set; }
Property Value
IReportDocumentResolver

Remarks

Use this property setter in order to provide a report document resolver instance. This is an optional setting and leaving it empty will trigger the built-in resolution logic.

See Also
IReportDocument
IReportDocumentResolver

ReportResolver

Gets or sets an IReportResolver implementation instance that will be used for report resolving from the service.

Declaration
[Obsolete("The Telerik.Reporting.Services.IReportServiceConfiguration.ReportResolver property is now obsolete. Please use Telerik.Reporting.Services.IReportServiceConfiguration.ReportSourceResolver instead.")]
IReportResolver ReportResolver { get; set; }
Property Value
IReportResolver

Remarks

Use this property setter in order to provide a report resolver instance. May be one of the built-in report resolvers or a custom implementation resolver. Built-in resolvers may be chained. This is mandatory setting without defaults.

See Also
IReportResolver
ReportFileResolver
ReportTypeResolver

ReportSharingTimeout

Gets or sets a value in minutes indicating how long a rendered report document from a client will be viable for reuse on subsequent document requests from the same or other clients.

Declaration
int ReportSharingTimeout { get; set; }
Property Value
System.Int32

Remarks

The value must be greater or equal to zero. A zero value will prevent rendered report document reuse.

ReportSourceResolver

Gets or sets an IReportSourceResolver implementation instance that will be used from the service to resolve a ReportSource instance from a string identifier of the report.

Declaration
IReportSourceResolver ReportSourceResolver { get; set; }
Property Value
IReportSourceResolver

Remarks

Use this property setter in order to provide a report source resolver instance. May be one of the built-in report resolvers or a custom implementation resolver. Built-in resolvers may be chained. This is mandatory setting without defaults.

See Also
IReportSourceResolver
ReportFileResolver
ReportTypeResolver

Storage

Gets or sets an IStorage implementation instance that will be used for internal storage from the report service.

Declaration
IStorage Storage { get; set; }
Property Value
IStorage

Remarks

Use this property setter in order to provide a storage instance. May be one of the built-in storage implementations or a custom implementation. This is mandatory setting without defaults.

See Also
MsSqlServerStorage
RedisStorage
FileStorage
DatabaseStorage

WorkerCount

Gets or sets a value determining the count of the worker threads that render the report documents.

Declaration
int WorkerCount { get; set; }
Property Value
System.Int32

Remarks

By default the worker threads count is equal to the count of the available logical processors on the machine.

Extension Methods

IReportServiceConfigurationExtensions.Validate(IReportServiceConfiguration)

See Also

ReportServiceConfiguration
Getting Started
  • Install Now
  • Online Demos
Support Resources
  • Documentation
  • Knowledge Base
  • Videos
  • Reporting Samples Repository
  • Reporting Release History
Community
  • Forums
  • Blogs
  • Reporting Feedback Portal

Copyright © 2018 Progress Software Corporation and/or its subsidiaries or affiliates.
All Rights Reserved.

Progress, Telerik, and certain product names used herein are trademarks or registered trademarks of Progress Software Corporation and/or one of its subsidiaries or affiliates in the U.S. and/or other countries. See Trademarks for appropriate markings.