◷ Reading Time: 15 minutes
Server Prerequisites
Before beginning the installation, ensure that your installation environment meets the necessary software and hardware requirements.
Download Installation Files
- Go to your profile: http://my.flexrule.com/.
- Log in with your FlexRule username and password.
- Go to the download section and click download and click on Download Now to download the FlexRule Server installation file.
- A zip file will be downloaded.
- Unzip the downloaded file. There will be two setup files.
There are two separate installations.
- Master: Manages the agents and services.
- Agent: Executes the services.
Install FlexRule Server Master
Master Installation
First, install the Master server.
FlexRuleServer-Master-<version>Setup.exe
Select the installation location for the Master Server.
Next, the Server Configurator will appear.
Before running the configurator, you must copy the server license file to the Master folder location.
Copy FlexRule Server License
Download the FlexRule server license from the FlexRule user portal.
The license file for FlexRule Server is called flexrule.server.license.lic. This file should be copied into the FlexRule Server Master folder at the following location:
[Server Install Path]\FlexRule Server\{version}\Master\flexrule.server.license.lic
e.g. C:\Program Files (x86)\FlexRule\Server\9.0.178\Master
Run the Configurator for Master
Once you close the trial license downloader pop-up window, the configurator will appear and by default Master will be selected. Click Next to start the configuration process.
Provide Runtime License Location
If you want to execute services using the Master server instead of a separate Agent server, you can tick this box and provide the path to a FlexRule Runtime license that allows execution (flexrule.license.lic).
If you want to install a separate Agent (recommended) to execute services, untick this box and click Next.
Server IP Address and Port
Each instance of Master and Agent needs to listen to a specific IP and port to respond to requests. You can either use localhost or the machine’s IP.
Set up the Workbench
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. It’s hosted inside the Master node. You need to provide an address and port to use for the Workbench in the hosting configuration.
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.
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 on 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 Master, 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 Auth Signing Key and the Master-Agent Shared Secret as you need to enter them again for the 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:
- Don’t change anything in the database.
- Delete and Recreate database tables.
- 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 Master.
[Installation Path]\Master\FlexRule.Server.Master.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.
Set Workbench Authentication Address
If you’re connecting to the Workbench application hosted on your machine from another machine, you’ll need to change the Workbench Authentication address in the configuration for FlexRule Server Master. This is necessary because the address must be valid on the client machine.
Open the Master config file.
[Server Install Path]\Master\FlexRule.Server.Master.dll.config
e.g. C:\Program Files (x86)\FlexRule\Server\9.0.178\Master\FlexRule.Server.Master.dll.config
Enter your machine’s public IP address / DNS name to WorkbenchAuth tag.
Install FlexRule Server Agent
Agent Installation
After installing the Master server successfully, the Agent server can be installed.
FlexRuleServer-ExecAgent-<version>Setup.exe
Select the installation location for the Agent server.
Next, the Server Configurator will appear.
Before running the configurator, you must copy the server license file to the ExecAgent folder location.
Copy FlexRule Server License
Download the FlexRule server license from the FlexRule user portal.
The license file for FlexRule Server is called flexrule.server.license.lic. This file should be copied into the FlexRule Server Master folder at the following location:
[Server Install Path]\FlexRule Server\{version}\ExecAgent\flexrule.server.license.lic
e.g. C:\Program Files (x86)\FlexRule\Server\9.0.178\ExecAgent
Run the Configurator for Agent
By default, Agent will be selected on the configurator.
Provide Runtime License Location
Specify the location of your FlexRule Runtime file (flexrule.license.lic).
Server IP Address and Port
Each instance of Master and Agent needs to listen to a specific IP and port to respond to requests. You can either use localhost or the machine’s IP.
Master Instance Address
Enter the IP address and port for the Master you want to connect to this Agent.
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>\Master\FlexRule.Server.Master.dll.config
e.g. C:\Program Files (x86)\FlexRule\Server\9.0.178\Master\FlexRule.Server.Master.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]\ExecAgent\FlexRule.Server.ExecAgent.dll.config
Click on Create to create an entry in the database to connect it to the Master.
Browse FlexRule Workbench
After successfully installing and configuring FlexRule Server (Master, Agent, and Workbench), it’s time to test it out.
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.
- Open a browser (e.g. Chrome) and browse to your FlexRule Workbench. If you used the default value on this page, you can find FlexRule Workbench running at http://localhost:9010.
- Enter admin as the username and your password that you defined during the default account settings in FlexRule Server Master configuration under “Admin User Account Password “.
Now you should be able to see the FlexRule Workbench home page.
