Configuring the Cache Management System
The cache settings mentioned in this article are not obligatory, and they do not apply to the HTML5 Report Viewer or its Angular, WebForms, MVC and other wrappers. Details about the Cache Storage of the Reporting REST Service that works with the HTML5 Report Viewer are available in Report Viewer and Reporting REST services and REST Service Storage Settings.
The cache management system can be configured by specifying one or more cache providers in the Telerik Reporting Configuration Section of the application’s configuration file. For example, the following XML snippet configures the cache to store the rendered pages and resources in the file system:
<Telerik.Reporting>
<Cache provider="File" />
</Telerik.Reporting>
The "provider" attribute of the "Cache" element specifies the name of the current cache provider used by the viewers. There are several preconfigured providers that can be used by applications without any additional setup:
| Provider | Description | Parameters |
|---|---|---|
| Auto | The actual provider is chosen automatically according to the characteristics of the stored resource and the permissions granted to the application. This is the default setting if the "Cache" element is omitted from the configuration section. | BasePath - specifies the location in which to store the files when File cache provider has been chosen. |
| Memory | All rendered pages and resources are stored in memory. Use this setting to improve the performance when rendering relatively small reports in desktop applications. However, this could also increase the memory footprint of the application significantly for large reports. | No parameters are defined for this provider. |
| File | All rendered pages and resources are stored as temporary files in the file system. | BasePath - specifies the location in which to store the files. |
| IsolatedStorage | All rendered pages and resources are stored as temporary files in the isolated storage. | No parameters are defined for this provider. |
| Database | Stores all resources in database. Uses Telerik Data Access to access the database. |
|
| ADO.NET | Stores all resources in the database. Uses ADO.NET provider to access the database. |
|
When the Auto cache provider is not explicitly specified in the Cache section it resorts to using only Memory cache if the ASP.NET Session state is configured as out-of-process. When the Auto cache provider is explicitly set, the BasePath parameter should specify a shared folder if using the web application in a web farm.
When using the File cache provider in an ASP.NET application deployed on a web farm, the BasePath parameter should specify a shared folder with the necessary permissions which should be accessible from all servers.
IsolatedStorage cache provider should not be used in web applications configured to use an out-of-process ASP.NET Session state mode.
The individual providers are registered by adding one or more "Provider" elements. The "name" attribute specifies the friendly name of the provider and the "type" attribute specifies the assembly-qualified type name of that provider. It is not necessary to specify the "type" for the preconfigured providers in the table above. If the provider requires additional parameters, these can be specified under the "Parameters" child element of the "Provider" element. The individual parameters are specified by adding one or more "Parameter" elements. The "name" attribute specifies the name of the parameter and the "value" attribute specifies the value of that parameter.
<Telerik.Reporting>
<Cache provider="File">
<Providers>
<Provider name="File">
<Parameters>
<Parameter name="BasePath" value="C:\MyDataCache" />
</Parameters>
</Provider>
</Providers>
</Cache>
</Telerik.Reporting>