Class
ReportServiceConfiguration

Default implementation of the IReportServiceConfiguration interface.

Definition

Namespace:Telerik.Reporting.Services

Assembly:Telerik.Reporting.dll

Syntax:

cs-api-definition
public class ReportServiceConfiguration : IReportServiceConfiguration

Inheritance: objectReportServiceConfiguration

Derived Classes: ConfigSectionReportServiceConfiguration

Implements: IReportServiceConfiguration

Constructors

ReportServiceConfiguration()

Initializes a new instance of the ReportServiceConfiguration class.

Declaration

cs-api-definition
public ReportServiceConfiguration()

Properties

AIClientFactory

Gets or sets the IClient factory method to be used for GenAI-powered insights in preview.

Declaration

cs-api-definition
public Func<IClient> AIClientFactory { get; set; }

Property Value

Func<IClient>

Implements IReportServiceConfiguration.AIClientFactory

CacheCompressor

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

Declaration

cs-api-definition
public ICompressor CacheCompressor { get; set; }

Property Value

ICompressor

Implements IReportServiceConfiguration.CacheCompressor

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

cs-api-definition
public int ClientSessionTimeout { get; set; }

Property Value

int

Implements IReportServiceConfiguration.ClientSessionTimeout

Remarks

The value must be greater than zero and less than 35792. The default value is 15 minutes

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

cs-api-definition
public string ExceptionsVerbosity { get; set; }

Property Value

string

Implements IReportServiceConfiguration.ExceptionsVerbosity

HostAppId

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

Declaration

cs-api-definition
public string HostAppId { get; set; }

Property Value

string

Implements IReportServiceConfiguration.HostAppId

Remarks

When not set, the Reporting REST 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 Reporting REST 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.

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.

Declaration

cs-api-definition
public IReportDocumentResolver ReportDocumentResolver { get; set; }

Property Value

IReportDocumentResolver

Implements IReportServiceConfiguration.ReportDocumentResolver

ReportResolver

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

Declaration

cs-api-definition
[Obsolete("The Telerik.Reporting.Services.ReportServiceConfiguration.ReportResolver property is now obsolete. Please use Telerik.Reporting.Services.ReportServiceConfiguration.ReportSourceResolver instead.")]
public IReportResolver ReportResolver { get; set; }

Property Value

IReportResolver

Implements IReportServiceConfiguration.ReportResolver

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.

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

cs-api-definition
public int ReportSharingTimeout { get; set; }

Property Value

int

Implements IReportServiceConfiguration.ReportSharingTimeout

Remarks

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

ReportSourceResolver

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

Declaration

cs-api-definition
public IReportSourceResolver ReportSourceResolver { get; set; }

Property Value

IReportSourceResolver

Implements IReportServiceConfiguration.ReportSourceResolver

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.

Storage

Gets or sets an IStorage implementation instance that will be used for internal storage from the Reporting REST service. Use this property setter in order to provide a storage instance. May be one of the built-in storage implementations or a custom implementation.

The built-in storage implementations are: MsSqlServerStorage RedisStorage FileStorage DatabaseStorage

This is a mandatory setting without defaults.

Declaration

cs-api-definition
public IStorage Storage { get; set; }

Property Value

IStorage

Implements IReportServiceConfiguration.Storage

WorkerCount

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

Declaration

cs-api-definition
public int WorkerCount { get; set; }

Property Value

int

Implements IReportServiceConfiguration.WorkerCount

Remarks

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