1. Preparation
Last updated
Was this helpful?
XMPro Platform
Last updated
Was this helpful?
Before attempting any of the supported XMPro deployment options (e.g. Cloud, On-Premise), these are the server prerequisites:
Azure
AWS
On-Prem
The following software must be installed on the web application server per product:
Windows Installers
No
No
Yes
Subscription Manager (SM) Web Application Server
Windows Server 2022
Yes
Yes
Yes
Yes
Yes
Yes
Microsoft Internet Information Services (IIS) 10
Yes
Yes
Yes
Yes
Yes
Yes
Application Designer (AD) Web Application Server
Windows Server 2022
Yes
Yes
Yes
No
No
Yes
Microsoft Internet Information Services (IIS) 10
Yes
Yes
Yes
Yes
Yes
Yes
Data Stream Designer (DS) Web Application Server
Windows Server 2022
Yes
Yes
Yes
No
No
Yes
Microsoft Internet Information Services (IIS) 10
Yes
Yes
Yes
Yes
Yes
Yes
SQL Database Server (Combined SM, AD, DS)
Windows Server 2019 or 2022
Yes
Yes
Yes
Microsoft SQL Server 2019 or 2022
Yes
Yes
Yes
The following software must be installed on the Stream Host server:
No 1
Yes 2
Yes 3
No
No 1
Yes 2
Yes 3
No
Subscription Manager manages Identity and access for the whole XMPro Platform. To do this, it regularly issues authentication tokens to the users as they log into the system. The server must sign these tokens to ensure their validity, hence a signing certificate is required.
A PKCS 12 archived certificate .pfx file is required. The minimum length of the accepted private key is 2048. Follow the instructions below to generate a Signing certificate:
Open a command prompt as administrator and navigate to the OpenSSL install directory. The default location is C:\Program Files\OpenSSL-Win64
Run the following commands
Follow the prompts on the screen and complete the certificate request
Make a note of the Common Name ("/CN='') and Password you choose
Create a file called sign.password.txt and add the password to the file
The XMPro Platform enforces secure communication using HTTPS/SSL. This means the server it is deployed to must have HTTPS configured. Depending on the deployment option you choose, you may have the following options:
Order a certificate from a certificate authority (CA)
Create a certificate in AWS (AWS deployment only)
Create a self-signed certificate (On-Premise only)
If you need to create a self-signed certificate, open Windows PowerShell as administrator and follow the instructions below:
Run the New-SelfSignedCertificate cmdlet as shown below to add a certificate to the local store on your PC, replacing the fully qualified domain name (FQDN).
Create a password as shown below, used for the export in the following step.
Export the self-signed certificate using the Export-PfxCertificate cmdlet as shown below.
Create a txt file with the name cert.password.txt and add the certificate password to this file.
The self-signed certificate can also be generated through IIS, following the instructions below:
Open IIS Manager and click "Server Certificates"
Click "Create Self-Signed Certificate"
Enter "cert" for the Certificate name, select "Personal" for the certificate store, and click OK
Confirm the certificate is generated and listed on 'Server Certificates'
Right click on the certificate and Export, taking note of the location and password entered for later use
XMPro components use emails to notify users of certain events, for instance, a new User signed up, or your account is ready. Please set up an SMTP account and have the necessary server details, as these are required for the notifications to work.
TLS/SSL Security
TLS encryption is required for secure email transmission
Use port 587 (STARTTLS) for modern secure email delivery
Enable SSL must be set to "true" in configuration
Account Configuration You will need the following details from your email provider:
Smtp Server
Your provider's SMTP server address
The fully qualified domain name of your SMTP server (e.g. smtp.office365.com)
User Name
Your SMTP account username
Often the same as your email address (e.g. noreply@mydomain.com)
Password
Your SMTP account password
Secure authentication credentials
Port
587
Required for TLS (STARTTLS) encryption
Enable SSL
true
Must be enabled for secure transmission
App Designer uses SMS, among other means, to notify users of certain events e.g. a recommendation alert was triggered or resolved, etc. An SMS provider is required to send SMS notifications.
For each environment, refer to the guideline to compute resources needed for small, medium, and large deployments:
This section describes the software that must be installed on the server before installing XMPro (refer section), as well as the software required for the post-installation step of installing a Stream Host.
1 Not a prerequisite from v4.4.1+. 2 As per the ARM template for your Azure instance. 3 See the Ubuntu software install commands .
Download and install
Please set up an account at Twilio using these and have the necessary details handy, i.e. Account ID, Authorization Token, and the Phone Number.
