AzureWebDocumentViewerContainer.UseAzureEnvironment(String) Method

Enables the Web Document Viewer and Report Designer to use Azure Storage for caching.

Namespace: DevExpress.XtraReports.Web.Azure.WebDocumentViewer

Assembly: DevExpress.XtraReports.v24.1.Web.Azure.dll

NuGet Package: DevExpress.Web.Reporting.Azure

Declaration

C#

public static void UseAzureEnvironment(
    string cloudStorageConnectionString
)

VB.NET

Public Shared Sub UseAzureEnvironment(
    cloudStorageConnectionString As String
)

Parameters

Name	Type	Description
cloudStorageConnectionString	String	A String value, that specifies the connection to the Azure Cloud Storage.

Remarks

This method replaces some internal services of a Document Viewer and Report Designer to services specifically designed for the decentralized environment of Azure.

This method is used in ASP.NET MVC and ASP.NET Web Forms applications. In ASP.NET Core applications, use the following method:

• UseAzureEnvironment

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 UseAzureCachedReportSourceBuilder method is an alternative to these types of document cache storages. This method 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 the 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