AzureWebDocumentViewerContainer.UseAzureEnvironment(String, String) Method

Enables the Web Document Viewer and Report Designer to use Azure Storage for caching and specifies the inter-process communication level.

Namespace: DevExpress.XtraReports.Web.Azure.WebDocumentViewer

Assembly: DevExpress.XtraReports.v23.2.Web.Azure.dll

NuGet Package: DevExpress.Web.Reporting.Azure

Declaration

C#

public static void UseAzureEnvironment(
    string cloudStorageConnectionString,
    string serviceBusConnectionString
)

VB.NET

Public Shared Sub UseAzureEnvironment(
    cloudStorageConnectionString As String,
    serviceBusConnectionString As String
)

Parameters

Name	Type	Description
cloudStorageConnectionString	String	A String value, specifying the connection to the Azure Cloud Storage.
serviceBusConnectionString	String	A System.String value, specifying the connection to the Azure Service Bus.

Remarks

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

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 Visual Studio Templates to Create an ASP.NET Core Application with a Document Viewer
• Use .NET CLI Template to Create a Reporting App with Document Viewer

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