Skip to main content

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.v24.1.Web.Azure.dll

NuGet Package: DevExpress.Web.Reporting.Azure

Declaration

public static void UseAzureEnvironment(
    string cloudStorageConnectionString,
    string serviceBusConnectionString
)

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.

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

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:

See Also