AzureReportingConfigurator.UseAzureCachedReportSourceBuilder(WebDocumentViewerConfigurationBuilder, String, StorageSynchronizationMode) Method
Implements Azure storage document cache and allows you to specify inter-process cache synchronization.
Namespace: DevExpress.AspNetCore.Reporting.Azure
Assembly: DevExpress.AspNetCore.Reporting.v24.2.Azure.dll
NuGet Package: DevExpress.AspNetCore.Reporting.Azure
#Declaration
public static WebDocumentViewerConfigurationBuilder UseAzureCachedReportSourceBuilder(
this WebDocumentViewerConfigurationBuilder viewerConfigurator,
string cloudStorageConnectionString,
StorageSynchronizationMode storageSynchronizationMode
)
#Parameters
Name | Type | Description |
---|---|---|
viewer |
Web |
A Web |
cloud |
String | A connection string for the Azure storage where tables to store documents, reports, and exported documents are created. |
storage |
Storage |
Specifies the process communication level. |
#Returns
Type | Description |
---|---|
Web |
A Web |
#Remarks
The Web Document Viewer is stateful and employs two levels of server-side caching to prevent redundant report creation.
Reports are cached in memory for a specified duration, even after closing the browser, but scaling with multiple servers can lead to issues if a server without the cached data handles a new request.
The issues are more about shared state and inter-server communication than specifically about Azure. When you create a new DevExpress Reporting ASP.NET Core application using templates, you have the option to specify document cache storage type and adjust the implementation as needed. For more information, review the following help topics:
- Use DevExpress Visual Studio Templates to Create an ASP.NET Core Reporting App with a Document Viewer
- Use DevExpress .NET CLI Templates to Create an ASP.NET Core Reporting App with a Report Designer
The UseAzureCachedReportSourceBuilder
method is an alternative to these types of document cache storage. It uses Azure services to implement document caching.
The UseAzureCachedReportSourceBuilder
method creates the following tables in the storage account:
- dxxrcommonstorage
- dxxrdocumentmetadata
- dxxrdocumentstructure
- dxxrexporteddocuments
- dxxrreports
- dxxrvsearch
You can allocate separate storage for reporting cache and configure expiration times for cached records in the Azure portal.
The goals of the UseAzureCachedReportSourceBuilder
method and the UseAzureEnvironment
method are the same. However, the UseAzureEnvironment
method allows you to process events for a generated document object, while the UseAzureCachedReportSourceBuilder
method works with serialized objects.
For more information review the following help topics:
- Web Document Viewer Cache Management
- Microsoft Azure Integration Specifics
- Web Farm and Web Garden Support