This document will guide you through how to set up the Azure infrastructure and deploy the XMPro Platform.


The following deployment diagram shows an example architecture and the necessary resources for the XMPro platform in Microsoft Azure.

Set up of Cloud Stream Host, Master Data, Azure Cache, or Twilio is optional and is dependent on client requirements. As a result, these resources will be excluded from this deployment.


In order to proceed with the deployment, you are required to complete the steps in the 1. Preparation guide:

  1. Select Azure resources that meet the hardware requirements and software requirements.

  2. Follow the certificate and communication steps for an SMTP Account (Recommended).

As well as having:

  • Azure portal administrative access

  • Access to Subscription and Resource group


This section provides information about installing the XMPro platform from scratch in Azure.

  1. Log on to the Azure Portal (with Company Administrator access)

  2. In the search bar type “Deploy” and select “Deploy a custom template”

3. Click "Build your own template in the editor"

4. Download the file from the link provided below:

5. Select "Load File" and then Open the downloaded "mainTemplate_[Version].json"

6. Once loaded, click Save - do not change the template.

7. Complete the form.

  • Enter the username in the correct format i.e.

  • The following special characters are not supported in the passwords: ` ' \ $ @

  • Take note of the passwords used as this will not be displayed again and they are required later.

8. Verify the information is correct and click Create.

After successful deployment, the following items have been installed:

  • Subscription Manager

  • Data Stream Designer

  • App Designer

  • Stream Host

Proceed to Restart the App Services after they are all deployed.

Restarting App Services

This step explains how to restart your app services in the Azure Portal.

  1. Type “Resource groups” in the search bar and select “Resource groups”.

2. Search for the Resource Group created during installation and select it.

3. Select Subscription Manager, Data Stream Designer, and App Designer and restart the applications.

4. The below GIF shows how to restart your app service.



Super Admin

as entered during setup


as entered during setup

Request a License

A new company is created as part of the installation process but needs a valid license to work.

Login using the Super Admin account

1. Click Company in the left menu to open the Companies page. 2. Click on the Company. 3. Click on the Subscriptions gauge to open the Subscriptions page. 4. Click on a Subscription. 5. Click the Update License button in the command bar. 6. Click Generate a license request, enter the number of days, and submit. 7. When you have received the license from XMPro support, upload it. 8. Click Save.

This sends a request to XMPro for an App Designer license for this Company.

The Generate a license request link will only work if SMTP was set up during installation.

9. Change the Product to Data Stream Designer from the list and request another license

Licenses are given on an individual basis by the XMPro support team.

When you have received a license for each product through an email sent to the email address given during installation, follow the steps below to upload the license for both App Designer and Data Stream Designer.

Next Step: Complete Installation

The installation of the XMPro Platform is now complete but before you can use the platform, some steps are needed to set up the environment. Further instructions about the configuration can be found below:

Install Agents & Connectors


Before beginning the upgrade, back up databases using this guide.

Follow the same steps as a new Install to upgrade your XMPro platform**.** Make sure to:

  • Download and use the latest "mainTemplate_[Version].json".

  • Use the same Resource Group and credentials used during the original Install when completing the Custom deployment form.


This section provides information about uninstalling the XMPro platform from Azure.

  1. Open the resource group where XMPro is installed

  2. Click Delete resource group

3. Enter the name of the resource group and click Delete

Last updated