Configure Auto Scale (Optional)

v4.3.1

Overview

Data caching is a technique used to improve the performance and responsiveness of applications. It works by storing frequently accessed data in a fast and easily accessible location.

When an application needs the data it can be retrieved quickly without having to go through time-consuming operations like accessing a database.

Distributed caching takes the concept of caching further by caching data in an external service accessible by one or more servers. This approach offers several benefits, including increased capacity to handle larger amounts of data, synchronized data across servers, and better scalability. By distributing the cache, the overall performance of the application can be enhanced, ensuring faster response times and improved efficiency.

In-memory caching: Single Server

The default behavior for all XMPro installations is that this location is on the host server memory, i.e. a single server.

Distributed caching: Multiple Servers

Auto Scale, XMPro's implementation of distributed caching, offers a superior caching approach that is highly recommended, particularly for larger production-ready implementations. XMPro utilizes “Redis” (Remote Dictionary Server), which is a popular open-source data structure store for XMPro’s distributed caching needs.

Configure Auto Scale

The upgrade path to utilize Auto Scale is as follows:

1. Upgrade XMPro to V4.3.1+.

2. Provision Redis. Refer to Redis documentation for a guide on how to provision Redis.

Although Auto Scale has a bigger impact on App Designer performance, it is for all XMPro products that use SignalR, i.e. Data Stream Designer and Subscription Manager too.

Application Designer

1. Enable the AutoScale setting in Application Designer.

   1. Open the Application Designer appsettings.json file.

   2. In the autoscale object, set enabled to true and enter the connectionstring value.

   3. Save the file and restart the Application Designer service.

 {
  "xmpro": {    
    "autoScale": {
      "enabled": true,
      "connectionString": "<redis connection string>"
    }
  }
}

1. Upgrade Data Streams Connector to V2.0+. Refer to Manage Connectors for a guide on adding a Connector and view the versions in use.

2. Upgrade Apps to use Data Streams Connector V2.0+. Refer to Data Integration for a guide on how to upgrade an App's connection.

Upgrading the Connector will clear the cache from the existing connector, and all data for the consuming App will be lost.

You do not have to upgrade all Apps to the new Connector version - their cached data and caching process will continue to work as before.

Data Stream Designer

Repeat step 1 for Data Stream Designer.

Subscription Manager

Repeat step 1 for Subscription Manager but in the web.config file.

It might be encrypted, which will require you to decrypt it first. For instructions, please refer to the How to encrypt and decrypt a web.config file Knowledge Base article.