1. Home
  2. FlexRule Server
  3. Installation
  4. Install FlexRule Server On-Premise Windows

Install FlexRule Server On-Premise Windows

◷ Reading Time: 20 minutes

Server Prerequisites

Before beginning the installation, ensure that your installation environment meets the necessary software and hardware requirements.

Download Installation Files

  1. Go to your profile: http://my.flexrule.com/.
  2. Log in with your FlexRule username and password.
  3. Go to the download section and click download and click on Download Now to download the FlexRule Server installation file.
  4. A zip file will be downloaded.
  5. Unzip the downloaded file. There will be four setup files.
    serverexefiles

There are four separate installations.

  • MasterManagement: Manage the authentication and handling services.
  • MasterExecution: Responsible for all execution services.
  • Agent: Executes the services.
  • Workbench: The interface of the server and manage the licenses, users, jobs, events, packages and etc.

Install FlexRule Server MasterManagement

MasterManagement Installation

First, install the MasterManagement server.

FlexRuleServer-MasterManagement-<version>Setup.exe
MM installation 1

Select the installation location for the MasterManagement Server.

MM installation 4
MM installation 5

Next, the Server Configurator will appear.
Also, you can run the configurator file through your location path.

Run the Configurator for MasterManagement

Once the configurator appears, by default, Master will be selected. Click Next to start the configuration process.

MM installation 6

Server IP Address and Port

Each instance of Masters and Agents needs to listen to a specific IP and port to respond to requests. You can either use localhost or the machine’s IP.

Debug and Tracing

FlexRule Server lets you log and monitor events. You will likely find it useful to write these to a log file so you can investigate errors.

You can also choose to Write to the Windows System Event Log if you want to use the Event Viewer available in Windows to monitor the application.

When an error occurs on Master or Agent it is sent as an event to a particular monitoring channel (e.g. local file). The local file for logging should be different for each Master and Execution Agent.

If you’re unsure, just use the default setting.

MM installation 8

Default Accounts

User accounts are used to manage the FlexRule Server.

Application accounts are used for the execution of rules and decisions by third-party applications (e.g. a mobile app that executes a decision).

The Admin user account is created by default to be used for administration purposes in the Workbench. You can use this account to create more accounts with different roles and access permissions using Workbench.

Make a note of these two passwords as you will need them when deploying projects on FlexRule Server.

Admin User Account Password is used to log in to the Workbench and publish services.
Default Application Account Details are used to run services in Workbench.

Security Settings

The communication between the MasterManagement, MasterExecution, Agent, and clients is secured with different mechanisms.

In this section, you need to provide passwords for communication, encryption, and signing security tokens for authentication. In each of the three tabs, you need to enter STRONG passwords for each field. The password cannot be less than 32 characters. You can also generate the password using the provided button.

Keep note of the Master Encryption, the Auth Signing Key, and the Master-Agent Shared Secret, as you need to enter them again for the Master Execution and Agent configuration.

  • Auth Signing Key and Master-Agent Shared Secret must match between Master and Agent nodes.
  • If this is a migration, the Master Encryption Password and Auth Signing Key must match the previous installation.

Database (Microsoft SQL Server)

FlexRule Server 3.0+ requires a Microsoft SQL Server database.

In the database setup section, you need to add the database server information to be used with Master and Agent nodes:

Add the database server address and database name for your database.

Add the username and password with manage access to the database server.

Specify further optional configuration to connect to your database.

If the database does not exist on the database server, the Configurator can create it for you.
Your user credentials need to have access to create the database for this to work successfully.

Database (Azure SQL Database)

FlexRule Server is compatible with Azure SQL Database.

If using Azure SQL, the steps are the same as above except for the Advanced tab where you need to ensure the following:

  • MS SQL AZURE database must be ticked.
  • Trust Server Certificate must be ticked.
  • Timeout must be set (e.g. 30 seconds).
  • Port number must be set to 1433.

Migration of Database

If there is an existing database with the same name, you can choose one of these options:

  1. Don’t change anything in the database.
  2. Delete and Recreate database tables.
  3. Migrate the existing database to the new version.

Save and Create

You should now see the buttons Save and Create.

Click on Save to create a configuration file for MasterManagement.

[Installation Path]FlexRule.Server.Master.Management.dll.config

Click on Create to create a default set of data that allows you to run a Master
The wizard will create an application account, a user account, administrator and application roles, and permission settings for roles.

Install FlexRule Server MasterExecution

MasterExecution Installation

First, install the MasterExecution server.

FlexRuleServer-MasterExecution-<version>Setup.exe

Select the installation location for the MasterExecution Server.

MM installation 4

Run the Configurator for MasterExecution

Once the configurator appears, by default, Master will be selected. Click Next to start the configuration process.

MM installation 6

Server IP Address and Port

Each instance of Masters and Agents needs to listen to a specific IP and port to respond to requests. You can either use localhost or the machine’s IP.

Debug and Tracing

FlexRule Server lets you log and monitor events. You will likely find it useful to write these to a log file so you can investigate errors.

You can also choose to Write to the Windows System Event Log if you want to use the Event Viewer available in Windows to monitor the application.

When an error occurs on Master or Agent it is sent as an event to a particular monitoring channel (e.g. local file). The local file for logging should be different for each Master and Execution Agent.

If you’re unsure, just use the default setting.

MM installation 8

Security Settings

Enter the Master Encryption, Auth Signing Key, and Master-Agent Shared Secret you entered in the MasterManagement configuration. These must match between MasterManagement and MasterExecution.

You can find them in the following file.

[Server Install Path]<version>FlexRule.Server.Master.Management.dll.config

Database (Microsoft SQL Server)

FlexRule Server 3.0+ requires a Microsoft SQL Server database.

In the database setup section, you need to add the database server information to be used with Master and Agent nodes:

Add the database server address and database name that match with the MasterManagement Configuration.

This image has an empty alt attribute; its file name is image-105.png

Add the username and password with managed access to the database server.

This image has an empty alt attribute; its file name is image-106.png

Specify further optional configuration to connect to your database.

This image has an empty alt attribute; its file name is image-107.png

Save ServerExecution Configuration

You should now see the buttons Save and Create.

Click on Save to create a configuration file for the MasterExecution.

[Installation Path]FlexRule.Server.Master.Execution.dll.config

 

Install FlexRule Server Workbench

Workbench Installation

Workbench is a web-based application for the administration and monitoring of FlexRule Server. Workbench enables multiple user accounts with different permissions to administer and run different parts of the system.

First, install the Workbench server.

FlexRuleServer-Workbench-<version>Setup.exe

Select the installation location for the Master Workbench Server.

Run the Configurator for Master Workbench

Once the configurator appears, by default, Workbench will be selected. Click Next to start the configuration process.

Server IP Address and Port

Master Workbench needs to listen to a specific IP and port to respond to requests. You can either use localhost or the machine’s IP.

You need to specify MasterManagement and MasterExecution IPs for Master Workbench. These IPs must be the same as the IP that you already specified for your MasterManagement and MasterExecution.

Install FlexRule Server Agent

Agent Installation

After installing the Masters server successfully, the Agent server can be installed.

FlexRuleServer-ExecAgent-<version>Setup.exe

Select the installation location for the Agent server.

Run the Configurator for Agent

Next, the Server Configurator will appear. By default, the Agent will be selected on the configurator.

Server IP Address and Port

Each instance of Agent needs to listen to a specific IP and port to respond to requests. You can either use localhost or the machine’s IP.

Debug and Tracing

Security Settings

Enter the Auth Signing Key and Master-Agent Shared Secret you entered in the Master configuration. These must match between Master and Agent.

You can also find them in the following file.

[Server Install Path]<version>FlexRule.Server.Master.Management.dll.config

e.g. C:\Program Files (x86)\FlexRule\Server\9.1.516\MasterManagement\ FlexRule.Server.Master.Management.dll.config

Database

Add database settings that match the Master configuration.

Save and Create

You should now see the buttons Save and Create.

Click on Save to create a configuration file for Agent at the following location:

[Server Install Path]ExecAgentFlexRule.Server.ExecAgent.dll.config

Click on Create to create an entry in the database to connect it to the Master.

Browse FlexRule Workbench

In order to run FlexRule server, you can follow these instructions, which are explained step-by-step. In our scenario, we simply ran them using the command line (in Windows Command Prompt).

If you have installed and configured everything correctly, you should now be able to browse to the FlexRule Workbench in your web browser.

  1. Run the all 4 nodes(Management, Execution, Workbench and agent) as administrator.
  2. Open a browser (e.g. Chrome) and browse to your FlexRule Workbench IP address. If you used the default value on this page, you can find FlexRule Workbench running at http://localhost:9010.
  3. Enter admin as the username and your password that you entered during the default account settings in FlexRule Server Master configuration under “Admin User Account Password “.

Copy FlexRule Server License

After successfully running FlexRule Server (MasterManagement, Master Execution, ExecAgent, and Workbench), it’s time to add Flexrule Licenses to the Workbench.

For further full details on adding licenses see our Adding or updating FlexRule Server licenses article.

Download the FlexRule server license from the FlexRule user portal.

The license file for FlexRule Server is called flexrule.server.license.lic. This file content should be copied and pasted into the Workbench at the following location:

Adminstration --> Licenses --> New License --> Server

Copy FlexRule Runtime License

Repeat the same steps for the FlexRule runtime license.

Download the FlexRule runtime license from the FlexRule user portal.

The license file for FlexRule Runtime is called flexrule.license.lic. This file content should be copied and pasted into the Workbench at the following location:

Adminstration --> Licenses --> New License --> Runtime

Create an Agent

Click on the New Agent at the following location:

Adminstration --> Agents --> New Agent

Give a name and description for the Agent. And then specify the host URL for already installed Agent.

Agent

Add New Runtime

After creating an Agent, you can specify a FlexRule Runtime for an Agent. Follow this article to add a new Runtime to the Agent.

Now you should be able to see the FlexRule Workbench home page.

Updated on March 28, 2024

Was this article helpful?

Related Articles