On-Premise
Last updated
Last updated
This document will guide you through how to deploy the XMPro Platform in an on-premise environment.
The following deployment diagram shows an example on-premise architecture and the necessary resources for the XMPro platform in Microsoft Windows.
In order to proceed with the deployment, you are required to:
Complete the steps in the 1. Preparation guide:
Meet the hardware requirements
Install the software requirements
Follow the certificate and communication steps
Enable Active Scripting and Allow Scriptlets (so App Designer and Data Stream installers can authenticate with Subscription Manager)
Open Internet Explorer.
Open Tools.
Open Internet Options.
Switch to the Security tab.
Click the "Custom level..." button.
Find and enable Active Scriptlets under ActiveX controls and plug-ins.
Find and enable Active Scripting under Scripting.
For Windows Server, disable these Internet Explorer settings (so App Designer and Data Stream installers can authenticate with Subscription Manager)
Open Server Manager.
Click on Local Server from the left menu.
Find the IE Enhanced Security Configuration on the right side and click on the "On" value.
On the pop-up, select "Off" for Administrators and apply the changes.
Install IIS Service on a fresh Virtual Machine (VM)
Open Server Manager.
Click on Manage from the top right menu.
Select Add Roles and Features, and click Next until you see Server Roles highlighted on the left.
With Server Roles highlighted on the left, tick the Web Server (IIS) role...
With Features highlighted on the left, tick everything under the .NET Framework features.
Click Next twice.
With Role Services highlighted on the left, tick everything except CGI under the Application Development section.
Click Next and Install.
Go to the Start button and Administrative Tools to confirm IIS Manager was installed.
Please contact your XMPro account manager or XMPro support to request the installers.
Start the installation process by running the Subscription Manager.exe file, received from your Global Administrator.
Click the "I Agree" button and press "Next"
Follow the instructions and when the installation is finished click "Close"
This "Setup" will install the installer you will use to install the database and website
When this initial installation is complete, open the start menu
Search for "XMPro Subscription Manager" and click on Run as Administrator
When the installer launches, choose “Install” and click "Next"
Select the components that you would like to install and click "Next"
If this is the first time you are installing Subscription Manager, it is highly recommended that you select both “Database” and “Web Application”
Select the server instance to which you would like to connect
If you already know the server instance name, it can be entered manually. Otherwise, use the refresh button on the right to load all available servers. Selecting the “Local Servers” check box will limit the search to the local network.
Specify the authentication method that should be used: Windows or SQL
9.1. Windows Authentication: you may leave the options as is
Warning: Configure a service account that can be used for Windows authentication.
9.2. SQL authentication:
Click the "Change" button
Select the “Use SQL Authentication” option
Enter the username and password of the SQL Server instance you’re connecting to
Warning: The SQL user must have permission to create databases on the server.
Database
The Database section allows you to configure if you would like to use an existing database or create a new one. Leaving the options as default will result in a new database being created.
To change the pre-populated name of the new database or to select to use an existing database:
Click the "Change" button
Make the changes needed by selecting the correct option
Specify the name of the new database or select an existing database from the drop-down
DNS Name
Verify if your DNS name is correct, if not, edit the value to contain the correct DNS name
This is your fully qualified domain name (FQDN). Please find some examples below explaining the DNS name.
https://localhost/xmprosubscriptionmanager
https://desktop-f64k32e/xmprosubscriptionmanager
https://demo.azurewebsites.com
| Complete Address | DNS | Virtual Directory |
|---|---|---|
https://localhost/xmprosubscriptionmanager | localhost | xmprosubscriptionmanager |
https://desktop-f64k32e/xmprosubscriptionmanager | desktop-f64k32e | xmprosubscriptionmanager |
https://demo.azurewebsites.com | demo.azurewebsites.com |
Virtual Directory
Select the parent site from the Web Site drop-down
By default, the Virtual Directory name will be "xmprosubscriptionmanager" which will be created within IIS for the Subscription Manager site. If you wish to change the name you can specify it in the "Virtual Directory Name" text box.
Verify if the value in the content directory field is correct. If not, apply any changes needed
By default, the option to create a sub-directory within the content directory is checked and you can specify a name in the “Sub-Directory” text box.
If you wish to change this name or use an existing application pool, click the Change button
By default, a new application pool will be created when installing the site. The new application pool will have the same name as the name specified in the “Application Pool Name” field.
Either select the “Create a new Application Pool” or “Use an existing Application Pool” option
If you choose “Create a new Application Pool”, give it an appropriate name. If you choose “Use an existing Application Pool”, select an existing application pool from the drop-down.
Select a security account that can be used
The default option is “Local System”, which is a built-in security account. You can either change it by selecting a different built-in security account from the drop-down or by specifying your own security account.
Warning: If you selected Windows authentication to connect to the database, you must choose “Specify your own Security Account” and provide the correct credentials. The service account must have batch logon rights enabled. More Information on how to set up a custom application pool in IIS as well as steps on how to enable batch logon rights can be found in this link.
Enter the SMTP details referenced in the 1. Preparation guide. By default, the "Enable Email Notification" is checked.
SMTP can be disabled by unchecking the "Enable Email Notification" checkbox if you don't want to receive email notifications. If at a later stage email notifications are needed, the installer can be run again to add SMTP functionality.
Warning: You are required to set up an SMTP account. Failing to do so will make registering new users very cumbersome.
Check your connection to the email server using the "Test SMTP settings" button.
During the installation process, you will be asked to upload two certificates: a signing certificate and an encryption certificate. You may use the same certificate for both options. The instructions on how to create a certificate can be found in the 1. Preparation guide.
Start by browsing to a suitable .pfx certificate file. Specify the password for the certificate
Use the dropdown to select "Subject Name"
It is recommended that you choose “LocalMachine” as the Location for the signing certificate.
Start by browsing to a suitable .pfx certificate file. Specify the password for the certificate
Use the dropdown to select "Subject Name"
It is recommended that you choose “LocalMachine” as the Location for the encryption certificate.
Warning: Both certificates must contain a private key.
Continue through the wizard, confirm the installation and the components will be installed
Warning: Note the username and password on the last screen of the installer. This user has been created during installation as Subscription Manager itself needs at least one user in the system. Without it, you cannot add other users.
Change the password of the default user to a new, secure password after logging in for the first time.
Access the website by putting the URL into your browser
The format of the URL will be as follows: “https://yourdnsname/virtualdirectoryname/”
To install the Data Stream Designer and App Designer, you will need an Installation Profile.
Navigate to the XMPro Subscription Manager site as above
Go to the Subscription Manager page
Click Products in the menu and click the Installation Profile button
Enter a File Key and press OK to download the file
Warning: Remember the file key as it is needed when installing Data Stream Designer and App Designer.
If you’ve chosen to use a custom service account during installation, you may have to perform an extra step. An error may be shown after logging into Subscription Manager, even after giving the IIS_USRS group permission on the signing certificate private keys. The error would be as follow: “We could not grant you access to the requested subscription. There was an unexpected error“. The logs would also contain the following error: “System.Security.Cryptography.CryptographicException: Keyset does not exist“.
To solve this issue, use this article as a guideline to grant access for the Application Pool Identity (in some cases a domain account) on the signing certificate private keys.
Start the installation process by running the Data Stream Designer.exe that you've received from your Global Administrator.
Click the "I Agree" button and press "Next"
Follow the instructions and when the installation is finished click "Close"
When this initial installation is complete, open the start menu
Search for "Data Stream Designer" and click on Run as Administrator
When the installer launches, choose “Install”
Select the components that you would like to install
If this is the first time you are installing the Data Stream Designer, it is highly recommended that you select both “Database” and “Web Application”.
Select the server instance you would like to connect to.
If you already know the server instance name, it can be entered manually. Otherwise, use the refresh button on the right to load all available servers. Selecting the “Local Servers” check box will limit the search to the local network.
Specify the authentication method that should be used: Windows or SQL
9.1. Windows Authentication: you may leave the options as is
Warning: Configure a service account that can be used for Windows authentication.
9.2. SQL Authentication:
To connect to the database using SQL Server authentication, click the "Change" button
Select the “Use SQL Authentication” option
Enter the username and password of the SQL Server instance you’re connecting to
Warning: The SQL user must have permission to create databases on the server.
Database
The Database section allows you to configure if you would like to use an existing database or create a new one. Leaving the options as default will result in a new database being created.
To change the pre-populated name of the new database or to select to use an existing database:
Click the "Change" button and select the appropriate option
Specify the name of the new database or select an existing database from the drop-down
If you are upgrading from 4.0 to 4.1 or greater, you will be shown the Encryption Upgrade Settings page. This will assist you in migrating existing Server Variables to the new method of encryption.
To upgrade existing Server Variables, the details of the Subscription Manager database are required, not the Data Stream Designer database (provided on the previous page).
Tick to automatically upgrade the Server Variables. It is recommended, but not required. None of the other settings on this page are required if you choose not to upgrade.
Select the server instance you want to connect to
Specify the authentication method that should be used: Windows or SQL
Select the Subscription Manager database and click Next
DNS Name
Verify if your DNS name is correct. If not, edit the value to contain the correct DNS name
This is your fully qualified domain name (FQDN). Please find some examples below explaining the DNS name.
https://localhost/xmprosubscriptionmanager
https://desktop-f64k32e/xmprosubscriptionmanager
https://demo.azurewebsites.com
| Complete Address | DNS | Virtual Directory |
|---|---|---|
https://localhost/xmprosubscriptionmanager | localhost | xmprosubscriptionmanager |
https://desktop-f64k32e/xmprosubscriptionmanager | desktop-f64k32e | xmprosubscriptionmanager |
https://demo.azurewebsites.com | demo.azurewebsites.com |
Virtual Directory
Select the parent site from the Web Site drop-down
By default, the Virtual Directory name will be "DataStreams" which will be created within IIS for the Data Stream site. If you wish to change the name you can specify it in the "Virtual Directory Name" text box.
Verify the value in the content directory field. If incorrect, apply any changes needed
By default, the option to create a sub-directory within the content directory is checked and you can specify a name in the “Sub-Directory” text box.
If you wish to change the name or use an existing application pool, click the Change button
By default, a new application pool will be created when installing the site. The new application pool will have the same name as the name specified in the “Application Pool Name” field.
Either select the “Create a new Application Pool” or “Use an existing Application Pool” option
If you choose “Create a new Application Pool”, give it an appropriate name. If you choose “Use an existing Application Pool”, select an existing application pool from the drop-down.
Select "Local System" as the security account.
The two options available to choose from are using a built-in security account or specifying your own security account.
Warning: If you selected Windows authentication to connect to the database, you must choose “Specify your own Security Account” and provide the correct credentials. The service account must have batch logon rights enabled. More Information on how to set up a custom application pool in IIS as well as steps on how to enable batch logon rights can be found in this link.
Click the Browse button to upload an installation profile for Subscription Manager
Select a file and click "Next"
This file ensures the Data Stream Designer contains the correct details for the Subscription Manager instance you would like to use. The file can be obtained through the steps outlined previously in this tutorial.
After you press "Next", authenticate yourself using Subscription Manager credentials
Warning: If you are unable to sign in at this step, please follow this link to disable Internet Explorer Enhanced Security Configuration.
Continue through the wizard, confirm the installation and the components will be installed
Start the installation process by running the App Designer.exe file that you've received from your Global Administrator.
Click the "I Agree" button and press "Next"
Follow the instructions and click "Close" when the installation is finished
This "Setup" will install the installer you will use to install the database and website
When this initial installation is complete, open the start menu
Search for "App Designer" and click on Run as Administrator
When the installer launches, choose “Install” and click "Next"
Select the components that you would like to install and click "Next"
If this is the first time you are installing Subscription Manager, it is highly recommended that you select both “Database” and “Web Application”.
Select the server instance you would like to connect to
If you already know the server instance name, it can be entered manually. Otherwise, use the refresh button on the right to load all available servers. Selecting the “Local Servers” check box will limit the search to the local network.
Specify the authentication method that should be used: Windows or SQL
9.1. Windows Authentication: you may leave the options as is
Warning: Configure a service account that can be used for Windows authentication
9.2. SQL Authentication:
Click the "Change" button
Select the “Use SQL Authentication” option
Enter the username and password of the SQL Server instance you’re connecting to
Warning: The SQL user must have permission to create databases on the server.
Database
The Database section allows you to configure if you would like to use an existing database or create a new one. Leaving the options as default will result in a new database being created.
To change the pre-populated name of the new database or to select to use an existing database:
Click the "Change" button and select the appropriate option
Specify the name of the new database or select an existing database from the drop-down
If you are upgrading from 4.0 to 4.1 or greater, you will be shown the Encryption Upgrade Settings page. This will assist you in migrating existing Server Variables and Connector settings to the new method of encryption.
To upgrade existing Server Variables, the details of the Subscription Manager database is required, not the Data Stream Designer database (provided on the previous page).
Enter the App Designer Encryption Key
To find the App Designer Encryption Key, inspect the appsettings.json file in the web server files. It will be found under the JSON path "xmpro.appDesigner.encryptionKey".
If that path does not exist, it is stored in a cloud-service key vault. Search for the "xmpro.keyVault" JSON object for the details required to find the encryption key.
Documentation for the Azure and Amazon key vaults have been linked for convenience.
Tick to automatically upgrade the Server Variables. It is recommended, but not required. None of the other settings on this page are required if you choose not to upgrade.
Select the server instance you want to connect to
Specify the authentication method that should be used: Windows or SQL
Select the Subscription Manager database and click Next
DNS Name
Verify if your DNS name is correct, if not, edit the value to contain the correct DNS name
This is your fully qualified domain name (FQDN). Please find some examples below explaining the DNS name.
https://localhost/xmprosubscriptionmanager
https://desktop-f64k32e/xmprosubscriptionmanager
https://demo.azurewebsites.com
https://localhost/xmprosubscriptionmanager | localhost | xmprosubscriptionmanager |
https://desktop-f64k32e/xmprosubscriptionmanager | desktop-f64k32e | xmprosubscriptionmanager |
https://demo.azurewebsites.com | demo.azurewebsites.com |
Virtual Directory
Select the parent site from the Web Site drop-down
By default, the Virtual Directory name will be "AppDesigner" which will be created within IIS for the Data Stream site. If you wish to change the name you can specify it in the "Virtual Directory Name" text box.
Verify if the value in the content directory field is correct. If not, apply any changes needed
By default, the option to create a sub-directory within the content directory is checked and you can specify a name in the “Sub-Directory” text box.
If you wish to change this name or use an existing application pool, click the Change button
By default, a new application pool will be created when installing the site. The new application pool will have the same name as the name specified in the “Application Pool Name” field.
Either select the “Create a new Application Pool” or “Use an existing Application Pool” option
If you choose “Create a new Application Pool”, give it an appropriate name. If you choose “Use an existing Application Pool”, select an existing application pool from the drop-down.
Select "Local System" as the security account
You can either change it by selecting a different built-in security account from the drop-down or by specifying your own security account.
Warning: If you selected Windows authentication to connect to the database, you must choose “Specify your own Security Account” and provide the correct credentials. The service account must have batch logon rights enabled. More Information on how to set up a custom application pool in IIS as well as steps on how to enable batch logon rights can be found in this link.
Type in the URL of Data Stream designer in the text box
Enter the SMTP settings referenced in the 1. Preparation guide. By default, the "Enable Email Notification" is checked.
SMTP can be disabled by unchecking the "Enable Email Notification" checkbox if you don't want to receive email notifications. If at a later stage email notifications are needed, the installer can be run again to add SMTP functionality.
Warning: You are required to set up an SMTP account. Failing to do so will make registering new users very cumbersome.
It is highly recommended to check your connection to the email server using the "Test SMTP settings" button.
Enter the Twilio details referenced in the 1. Preparation guide. If you don't want SMS notifications you can select "None" from the "Select Provider" dropdown.
Click the Browse button to upload an installation profile for Subscription Manager
Select a file and click "Next"
This file ensures the App Designer contains the correct details for the Subscription Manager instance you would like to use. The file used can be obtained through the steps outlined previously in this tutorial.
The Installation Profile generated for Data Stream Installer can be used in this step.
After you press "Next", authenticate yourself using Subscription Manager credentials
Warning: If you are unable to sign in at this step, please follow this link to disable Internet Explorer Enhanced Security Configuration.
Continue through the wizard, confirm the installation and the components will be installed
The installation of the XMPro Platform is now complete, but there are some environment setup steps before you can use the platform. Please click the below link for further instructions:
3. Complete InstallationIt is necessary to first uninstall the installers on the host server before proceeding with the upgrade installers. Once you have removed the installers, the procedure for the upgrade is the same as the original install.
This section aims to provide step-by-step instructions on how to safely uninstall only the XMPro installers and not the on-premises deployed XMPro solution.
The process of uninstalling the XMPro installer must be repeated for each application individually. The steps are the same for each application installer and the sequence is not significant.
Log on to the instance where the XMPro installers are installed.
From the start menu select XMPro Subscription Manager and right-click it.
Click Uninstall.
Select XMPro Subscription Manager from the list of programs displayed.
Click Uninstall.
When prompted to confirm uninstall click Yes.
Click Next.
When prompted to select the install to modify click Cancel. We do not want to remove the installed XMPro site, only the installer.
Click on Yes to cancel the setup.
Log on to the instance where the XMPro installers are installed.
From the start menu select XMPro Data Stream Designer and right-click it.
Click Uninstall.
Select XMPro Data Stream Designer from the list of programs displayed.
Click Uninstall.
When prompted to confirm uninstall click Yes.
Click Next.
When prompted to select the install to modify click Cancel. We do not want to remove the installed XMPro site, only the installer.
Click on Yes to cancel the setup.
Log on to the instance where the XMPro installers are installed.
From the start menu select XMPro Application Designer and right-click it.
Click Uninstall.
Select XMPro Application Designer from the list of programs displayed.
Click Uninstall.
When prompted to confirm uninstall click Yes.
Click Next.
When prompted to select the install to modify click Cancel. We do not want to remove the installed XMPro site, only the installer.
Click on Yes to cancel the setup.
You have now successfully uninstalled the XMPro installers. You can proceed to the instructions at the top of this page to perform an upgrade with the new installers: Install On-Premise.
Expand Web Server and Common HTTP Features, untick WebDAV Publishing, and click Next.
