EngageCX Installation Guide

Getting Started

Overview

This guide provides step by step instructions for installing the EngageCX Engage solution, in various deployments to meet your organization needs.

See Pre-Installation Checklist for reference information about system requirements, including operating systems, hardware, and additional software and tools requirements.

This guide provides installation instructions for single or distributed deployments, along with additional post installation settings.

Once the Engage solution has been installed, get acquainted with the Sysadmin Website or find more about EngageCX Engage modules and functionalities from Enterprise Website.

As always, if you have questions or issues, please submit them in here or send an email to engagecxsupport@mhcautomation.com.

Installation

This section provides step by step instructions for installing the EngageCX solution. To continue, please select the deployment type you intend to proceed with:

Single Instance

This section provides step by step instructions for installing all EngageCX Platform components on the same machine (with the exception of the database).

Installer Description

The installation files are named according to the version of the product. Generally, the setup name has the following structure: Product Name - Architecture - Build Version - Build Number.

In the example below, you can identify the details mentioned as follows:

Screenshot


Starting the Installation

To open the installation wizard, double-click on the .exe file and wait for the Setup to initialize:

Screenshot

When the setup finished preparing the install, the Welcome Screen will appear. Follow the steps described below to complete the installation.

Step - Welcome Screen

The welcome screen provides details on what product is about to be installed on your machine, as well as two options, to revert changes or to proceed with the installation of the EngageCX software.

Screenshot

If you wish to cancel the installation, then press the Cancel button.

You will be prompted to confirm your decision, in order to prevent accidental canceling:

Screenshot

To proceed with the installation, select the Next button, located in the bottom region of the window.

Step - End-User License Agreement

In order to continue with the installation of the EngageCX Platform, you will need to carefully read the terms and conditions for this software.

Screenshot

Afterwards, check the I accept the terms in the License Agreement checkbox and click Next.

Note

The Next button is greyed out until the above checkbox is selected.

Step - Destination Folder

This step in the Setup Wizard offers the possibility of setting the location where the EngageCX software will be installed. By default, the EngageCX software will be installed at: C:\Program Files\Ecrion\EngageCX_Product.

To change the default path, select the Change button on the middle-left side of the window and provide a new destination folder for the EngageCX installation.

Screenshot

Once you have the folder set, select the Next button to continue with the installation.

Step - Product Features Selection

EngageCX provides a series of features which can be chosen during this step of the installation. Each component is provided with a short description of its functionality.

By default, all features are selected. You can decline the installation of a component by de-selecting the associated check-box. If no component is selected, you will be unable to finish the installation.

Screenshot

Once you select the needed features, select Next to proceed with the required settings configuration for each feature.

Step - Configure Publishing Engine

The Publishing engine is a native server component that performs XML/JSON conversions to various output formats. It is the successor of the XF Rendering Server embedded in the new EngageCX line of products.

Warning

This component is a vital service, so you will need to ensure that it is installed and available (either on the current machine or another) when using the EngageCX software.

This step allows the user to choose several backwards-compatibility options:

Additionally, users can enable firewall rules to allow incoming remote requests. Notice that this option should remain un-checked for Single Instance installation. Enable this option only if the Publishing Engine component is deployed on a separate machine. For more details on this, please view the Double or Complex Instances installation available in this guide.

Screenshot

Once you select the needed features, select Next to proceed to the next step.

Step - Configure Data Engine

The Data engine is a native server component that performs data aggregation from multiple data sources (XML, CSV, Relational databases, etc.). It is used in conjunction with the Publishing engine in order to create various communications from different sources. It is the successor of the Data Aggregation Server product and it is embedded in the new EngageCX line of products.

Warning

This component is a vital service, so you will need to ensure that it is installed and available (either on the current machine or another) when using the EngageCX software.

This step also provides the user to choose several backward-compatibility options:

Additionally, users can enable firewall rules to allow incoming remote requests. Notice that this option should remain un-checked for Single Instance installation. Enable this option only if the Data Engine component is deployed on a separate machine. For more details on this, please view the Double or Complex Instances installation available in this guide.

Screenshot

Once you select the needed features, select Next to proceed to the next step.

Step - Configure Analytics Engine

The Analytics engine is a native server component that performs analytic computations for EngageCX systems. Installing this component is mandatory only if you want to use the Analytics module within EngageCX Platform.

Additionally, users can enable firewall rules to allow incoming remote requests. Notice that this option should remain un-checked for Single Instance installation. Enable this option only if the Analytics Engine component is deployed on a separate machine. For more details on this, please view the Double or Complex Instances installation available in this guide.

Screenshot

Once you select the needed features, select Next to proceed to the next step.

Step - Database Settings

In this window, you will need to select a database provider. To proceed, you have two options: either use a previous configuration (only if EngageCX was installed before on the current machine), or create a new SQL Connection.


Using Existing SQL Database

To use the settings made in a previous install of EngageCX software, check the Use previous configuration option, then click Next.

Screenshot


Using a New SQL Database

If you un-check the option Use previous configuration, then you must choose the Provider Type out of two options:

Microsoft SQL Server Express Microsoft SQL Server

Screenshot


Using Microsoft SQL Server Express (local)

Choosing the Microsoft SQL Server Express (local) requires the following information:

Screenshot

Once you provide all the necessary data, you can test the connection to ensure that all fields have been set up properly, by clicking the Test Connection button.


Using Microsoft SQL Server

Choosing the Microsoft SQL Server requires the following information:

Note

As best practice, use Windows Authentication in case you have the possibility of giving owner permissions (to EngageCX Database), to a windows user. Otherwise, SQL authentification with username and password can be used.

Screenshot

Once you provide all the necessary data, you can test the connection to ensure that all fields have been set up properly, by clicking the Test Connection button.

The next step allows you to configure search, more specifically the search database. To proceed, you have two options:

The Enable full text search option should be checked only if you want to search inside your documents. Note that this option is available only if Microsoft SQL Server has the Full Text feature installed.

Additionally, users can enable firewall rules to allow incoming remote requests. Enable this option only if the SQL Server storing the EngageCX Search database is located on another machine.

Screenshot

Once you have provided all the necessary data, you can test the connection to ensure that all fields have been set up properly, by clicking the Test Connection button.

Step - Storage Service Settings

After you finish configuring the database(s), you must proceed to set up EngageCX Storage. For this scenario, the EngageCX Storage will be a local folder on the server. By default, it will be created at C:\ProgramData\Ecrion\, and the folder will be called EOSStorage. In case your EngageCX storage is remote, make sure to use UNC Paths to point the storage.

Optional storage tools are included with the installation setup. Users can choose to deploy them by checking the Storage Checker Utility, Maintenance Utility and Logs Migration Utility option.

Additionally, users can enable firewall rules to allow incoming remote requests. Notice that this option should remain un-checked for Single Instance installation. Enable this option only if the Storage is located on a separate server.

Screenshot

Step - Backend Services Settings

The Backend Services component is a Windows Service that automates various communication productions with jobs, schedules, triggers, etc. It also contains other important EngageCX services such as Health Check, Billing, Analytics, etc.

Warning

This component is a vital service, so you will need to ensure that it is installed and available when using the software.

During this phase of the Installation Wizard, you can choose the additional components that come with the Backend Services component:

Additionally, users can enable firewall rules to allow incoming remote requests. Notice that this option should remain un-checked for Single Instance installation. Enable this option only if the Backend Services component is deployed on a separate machine. For more details on this, please view the Double or Complex Instances installation available in this guide.

Screenshot

Once you select the needed features, select Next to proceed to the next step.

Step - Configure Lock Service

The Lock Service is a centralized service that provides distributed synchronization.

Additionally, users can enable firewall rules to allow incoming remote requests. Notice that this option should remain un-checked for Single Instance installation. Enable this option only if the Lock Service component is deployed on a separate/multiple machine(s). For more details on this, please view the Double or Complex Instances installation available in this guide.

Screenshot

Step - Enterprise Website

The Enterprise Website is the Main User Interface component, which allows the user to create and manage all customer communications. The website will be installed on the IIS server.

If you choose the Enterprise Website component, you will be prompted to enter the following:

Screenshot

Optionally, you also have two options that can be checked/un-checked:

If you enable the Web Site SSL option, two additional fields will appear:

Screenshot

Step - Administration Website

The Administration Website performs various administrative tasks over EngageCX environments (configuring worker servers and administration users, configuring environment capabilities, etc.). The website will be installed on the IIS server.

If you choose to install the Administration Website component on this machine, you will be prompted to choose a Website Name, a Port and a Host Name. By default, the Website Name is ADMINEOS4, and the port number is 8095.

Like the Enterprise Website component, the Administration Website component needs to be configured by providing the Administration website name, port and host name.

Screenshot

You can also enable HTTPS traffic on this website and add firewall rules for incoming requests, in a similar fashion as the Enterprise Website.

Step - Portal Website

The Portal Website allow customers to view their communications created with EngageCX software. This website will be installed on the IIS server.

If you choose to install the Portal Website component on this machine, you will be prompted to choose a Website Name, a Port and a Host Name. By default, the Website Name is PORTALEOS4, and the port number is 8096.

For this component, you must also specify the Portal website name, port and host name. Both firewall rules and Web Site SSL are available settings to enable and configure.

Screenshot

You can also enable HTTPS traffic on this website and add firewall rules for incoming requests, in a similar fashion as the Enterprise Website.

Step - Configure Licensing Server

The Licensing Server allows system administrators to install and manage all the EngageCX Product keys that enables various features and functions.

For single instance scenarios, the Peer Licensing Server option should be Disabled. To enable the Licensing Peer options and learn more, please see the Double Instance installation scenario.

Screenshot

Step - Dependent Services Settings

This step allows customers to manage the addresses of the machines where you installed the EngageCX components.

Screenshot

Once you finish configuring the components, you can click the Install button, located in the bottom region of the Setup Wizard window, and the setup will proceed to install the EngageCX software.

Step – Installing EngageCX Platform and Completed Screen

The final steps of the Installation Wizard allow you to see the progress of the installation and, once completed, you can view the Readme file of the EngageCX Software.

Screenshot

Complete the installation by selecting the Finish button.

Double Instance

This section describes how to set up HA using two servers, each with a full instance of EngageCX deployment (except the database). The instances in this topology are configured to synchronize both storage and their background activity (triggers, schedules, health check, search data crawling, etc.).

Screenshot

Conventions

For the example below, we will use the following conventions:


Configuring HA

Please follow the steps below to configure a double instance deployment.

EngageCX Server 1 (IP Address: X.X.X.X)
ClusterNodeName=EngageCXServer1
ClusterServiceEnabled=true
Enable HA Clustering and set up a unique name for the server.
StorageFolder={Path_To_EngageCXServer1_Storage_Folder}
StorageEncrypted=true
Enable Storage encryption and configure the path to the storage location.
ESSPeerAddress=Y.Y.Y.Y
TriggerPeerAddress=Y.Y.Y.Y
SchedulerPeerAddress=Y.Y.Y.Y
BackgroundPeerAddress=Y.Y.Y.Y
BackupPeerAddress=Y.Y.Y.Y
Set up the IP Addresses for the HA Peer services.
StorageClustered=true
ClusterSynchronizationEnabled=true
Enable the licensing synchronization between the two licensing servers.
LicensingPeerServerAddress=Y.Y.Y.Y Set the IP Address for the corresponding Licensing Peer.

Note

To specify how much time a peer should wait for a response from another peer until the connection will fail through the parameter below, add in the Licensing.config file: ClusteredPeerConnectionTimeout=<Number>.

Screenshot

Information on how to enable logging can be found here.

EngageCX Server 2 (IP Address: Y.Y.Y.Y)
ClusterNodeName=EngageCXServer2
ClusterServiceEnabled=true
Enable HA Clustering and set up a unique name for the server.
StorageFolder={Path_To_EngageCXServer2_Storage_Folder}
StorageEncrypted=true
Enable Storage encryption and configure path to the storage location.
ESSPeerAddress=X.X.X.X
TriggerPeerAddress= X.X.X.X
SchedulerPeerAddress= X.X.X.X
BackgroundPeerServerAddress= X.X.X.X
BackupPeerServerAddress=X.X.X.X
Set up the IP Addresses for the HA Peer services.
StorageClustered=true
ClusterSynchronizationEnabled=true
Enable the licensing synchronization between the two licensing servers.
LicensingPeerServerAddress=X.X.X.X Set the IP Address for the corresponding Licensing Peer.

Complex Deployments

EngageCX Platform provides a scalable architecture that can accommodate various scenarios. This section describes how to install EngageCX Platform across multiple servers.

Briefly, when installing EngageCX components across multiple servers, you need to consider some of the following:

Example: Below we will describe a scenario in which we will install the EngageCX websites on a server (e.g. FrontEnd Server), the EngageCX Database is placed on a separate server (e.g. SQL Server) and the other components (Publishing Engine, Data Engine, Analytics Engine, Licensing Engine, Backend Engine, Storage Engine, Lock Engine) are installed on a separate server (e.g. BackEnd Server).

SQL Server

When configuring the EngageCX Database on the SQL Server, you will have to ensure the following:

EngageCX Back End Server

Run the EngageCX executable on the Back-End Server to start the installation. The steps below highlight the changes that you need to perform within the Installation Wizard, for this scenario. For more details regarding the installation process, please see the Single Instance chapter of this guide.

EngageCX Front End Server

Run the EngageCX executable on the Front-End Server to start the installation. The steps below highlight the changes that you need to perform within the Installation Wizard, for this scenario. For more details regarding the installation process, please see the Single Instance Installation chapter of this guide.

When the installation is done on both servers, sign in to the Sysadmin Website and install all the necessary product keys. For more details, please visit Licensing. Ultimately, access the System Status page from the Sysadmin Website and verify if the services are working properly.

Post-Installation

After a successful installation using the EngageCX Engage installer, you will need to follow these additional steps to ensure your machine is configured properly. Please select the area you are interested in from the table below.

Update Initial Configuration
Update IIS Configuration

Changing Initial Configuration

Some settings like database, storage, ports or SSL are configured during installation. To modify these settings, we recommend running the installer again.

The installer will automatically detect previous database/storage configurations and offer to use them. We recommend using this option if you want to review and modify the settings for your database and storage.

If you need to specify database and storage explicitly, read below. Note that this is NOT recommended when there is a previous configuration available.

Note

The database and storage are deeply linked with each other and cannot function properly if they are out of sync. It is critical that the selected database and storage have been used by EngageCX Platform in the same configuration before and these have not been altered since the last time they were used.

IIS Manager Configuration

Updating Bindings for Website Remote Access

If you want to access one of the EngageCX Platform Websites remotely, you will need to follow these steps for each EngageCX Website.

Note

If you do this, the website will be accessible from the intranet if the firewall allows it. Make sure that this is the intended functionality and that website access (especially for System Administration) is properly secured before making the change.

Enabling Secure Connections

Enabling HTTPS can be done in two ways:

Note that both these methods require that a valid and appropriate SSL certificate is installed on the server hosting the website(s) that you wish to enable HTTPS for.

Note

In a multi-server setup, regardless which of the methods described below (automatic or manual) is used, the steps must be performed on all servers in the multi-server setup. This includes HA scenarios.


Enabling HTTPS Automatically

To enable HTTPS automatically, simply re-run the installer and choose Enable Web Site SSL for each of the websites that you wish to make accessible through HTTPS. When ticking the box, make sure to select the correct certificate from the list that appears.


Enabling HTTPS Manually

Please follow the steps below to learn how to enable the HTTPS manually, after the installation.

Usually, this only means changing http to https in the configuration file, with the hostname and port (if present) left the same.

Note

This procedure can also be applied in reverse, to change from HTTPS to HTTP.

Uninstallation

Below you can find details on how to remove EngageCX from your computer.

Uninstall Procedure

Please follow the steps below to learn how to uninstall the EngageCX product from the computer.

Screenshot

Upgrading

For instructions on upgrading an existing installation, please see the Upgrade Manual.

Getting Help

As the success of your business relies on your customers, EngageCX helps you increase your client’s engagement by offering a solid foundation for creating and delivering successful communication between them. This document provides a good start for understanding how EngageCX should be installed on your machine and/or configured depending on different types of deployment. If you want to discuss the best deployment or integration options around your company's individual needs, please contact our EngageCX Professional Services Team today. We'd love to hear from you!