Install a node on Windows


Hardware prerequisites

Make sure you've checked the Hardware prerequisites before starting configuring your server

System prerequisites

A Decision Insight Messsaging Sytem (DIMS) node currently supports the following software prerequisites set up on your machine:

  • 64-bits Windows Operating System :
    • Windows Server: 2008 R2, 20122012 R2
    • Windows (for test environments): 7, 8, 8.1, 10
  • An OpenJDK 11 64-bits JVM or later
    • An OpenJDK 13 JVM is provided by the node itself but this can be changed

Configuration prerequisites

Depending on your configuration, please check the following configurations have been properly applied to your environment:

Accounts

Account Required abilities
<Decision Insight Messaging System administration account>
  • Ability to start/stop a service
  • Permissions

    Directory Permissions
    <install directory> read, write, execute

    <working directory>

    read, write, execute
<Decision Insight Messaging System execution account>
  • Permissions

    Directory Permissions
    <install directory> read, execute
    <working directory> read, write, execute
<System administration account>
  • Register/Unregister a service

<install directory> is the directory where the product will be installed

<working directory> is the directory where the product will write its data (by default, <working directory> is <install directory>/var)

Installation prerequisites

Install a node

Using the graphical mode

Launch  the installer

Using <Decision Insight Messaging System administration account>, launch the installer in graphical mode. For that you can either:

  • Double-click on the installer

  • Launch the installer from command line:

    DecisionInsightMessagingSystem_${release}_Install_win-x86-64.exe

Follow the installation steps

Step 1 : Overall information

Once you have successfully launched the installer on your machine, you will access the installer welcome page. Click next.

Step 2 : License agreement

Accept the software license agreement and click next.

Step 3 : Destination directory

If you install the product in the default installation path (C:\Program Files\DecisionInsightMessagingSystem) the product will not work out of the box  as this directory is not writable by default.

If you install the product in a sub-directory of  C:\Program Files , you must - after the installation complete -  change the location of the working directory , or  change the permissions on the installation directory .

Select an installation path that fullfils the prerequisites:

  • <Decision Insight Messaging System administration account> must have full access
  • <Decision Insight Messaging System execution account> must have read & execute permissions
Step 4 : Orchestrator configuration

From this screen, you can choose to install an orchestrator or not.

If you skip it, you'll need to provide a valid link to an existing orchestrator when installing a messaging server.

Orchestrator port

Port used by various services to connect to the orchestrator.

Orchestrator cluster connection

Configure the connection to a cluster.

You need to provide:

  • a unique id for your orchestrator
    this id will be used to identify your orchestrator in the cluster
  • a connection string
    comma separated list of servers that are part of the cluster, format is : {id1}={host1}:{port1},{id2}={host2}:{port2},...

Then click next.

Step 5 : Install a messaging server

From this screen, you can choose to install the messaging server or not.

Messaging server port

Port used by various services to connect to the messaging server.

Connection string

If you didn't install the orchestrator from the previous screen, you need to provide a connection string to connect to one.

Replication factor / Minimal Synchronized Messaging Servers / Partition Number

These values must be the same on all members of the cluster.

For guidance on how to choose these values, see Sizing prerequisites.

Then click Next.

Step 6: Security configuration

If you chose to install a new messaging server in the previous step, in this screen you will need to provide the means to secure its communication using TLS mutual authentication. Secure communications is mandatory for your production deployment. If you don't need it, just uncheck "Secure communications?"

Key Store Configuration

Configure the JKS keystore to be used to secure communication. You will need to provide:

  • a path to the keystore
  • the keystore password
  • the key password for the key in the keystore

Trust Store Configuration

Configure the JKS truststore to be used to secure communication. You will need to provide:

  • a path to the truststore
  • the truststore password

See more about the information required in this screen in Security prerequisites.

Then click next.

Step 7 : Installation

The installation process is shown as a progress bar and can take several minutes.
When the installation has finished (overall installation progress is over), you can click next to see a summary of the process.

Step 8 : Installation finished

Software is installed and ready to use.

You can check create a response file, if you want to relaunch the same installation later without having to go through all the installer screens. The response file will be generated in the node installation directory. (see Using the automated mode for more information)

Then, click done to close the window.

Using the console mode

Using <Decision Insight Messaging System administration account>, launch the installer from command line:

start /wait DecisionInsightMessagingSystem_${release}_Install_win-x86-64.exe -c

Steps are the same as those in the graphical mode.

Using the automated mode

You can also install a node in an unattended mode from a configuration file.

You should have a previously generated response file that should look like:

response.varfile
# Destination directory
sys.installationDir=d:/opt/DecisionInsightMessagingSystem
 
# Orchestrator configuration
isNewOrchestrator$Boolean=true
orchestratorClusterConnectionString=2\=myserver-2.network.int\:2181,3\=myserver-3.network.int\:2183
orchestratorId$Long=1
orchestratorPort$Long=2181
 
# Messaging server configuration
isNewServer$Boolean=true
isSecured$Boolean=true
serverPort$Long=9092
defaultReplicationFactor$Long=3
minInsyncMessagingServers$Long=2
numberOfPartitions$Long=3


#Security configuration
keyPassword.encoded=jJCS=/gtvmq+/jIyIkI2b
keyStorePassword.encoded=ct56ubSmq+/jgiyufb
keyStoreResource=d:/opt/security/server.keystore.jks
trustStorePassword.encoded=juy7=/uyver4GIH7f
trustStoreResource=d:/opt/security/server.truststore.jks
 
# Installer settings
shouldCreateResponseFile$Boolean=true
sys.adminRights$Boolean=true
sys.languageId=en

Launch the installer from the terminal using the following command:

start /wait DecisionInsightMessagingSystem_${release}_Install_win-x86-64.exe -q -varfile response.varfile

Configure TLS on the installation

You are advised to configure TLS on the messaging system to secure your deployment and use it in Decision Insight, see TLS Configuration

Change the working directory (optional)

To specify the directory where the node can perform read/write operations and where your data will be stored, you can change the <working directory>.

To specify the <working directory> , perform the following steps :

  1. Copy the content of <install directory>/var to  <working directory>
  2. Edit the following files:
<install directory>/conf/messaging-server/path.conf
WORKING_DIR=<working directory>
<install directory>/conf/orchestrator/path.conf
WORKING_DIR=<working directory>

Install as a service (optional)


Multi platform configuration

If you want more than one instance of Decision Insight Messaging Service installed as services on the same environment, you should edit the property com.axway.platform.name= in <install directory>/conf/(orchestrator|messaging-server)/platform.properties.

This value will be used as the service name. (Default names are DecisionInsightMessagingSystemOrchestrator and DecisionInsightMessagingSystemServer)

To install the service:

  • Once your DIMS node is installed and configured, execute the provided configuration script located in <install directory>/bin under the user <Decision Insight Messaging Service administration account>

    <install directory>\bin\(orchestrator|messaging-server)-service-configure.bat
    Using this command generates a  (DecisionInsightMessagingSystemOrchestrator|DecisionInsightMessagingSystemServer).ini file used in order to launch the node as a service. Manually altering this file is prohibited. If configuration files ( jvm.confpath.confplatform.properties) are modified after installation as service, re-execute this script. No specific user is needed to perform this operation.
  • Then execute the provided installation script located in <install directory>/bin under the user <System administration account>

    <install directory>\bin\(orchestrator|messaging-server)-service-register.bat

    This will install the service as an operating system service named <product-name> and configure it for manual start. This command checks no other service is already registered under the same name before proceeding.

  • Once the service is installed, change the service user via the provided Windows services management GUI (default user is local system):
    • In Start menu -> find programs type "Services"
    • In the list of available services, locate ( DecisionInsightMessagingSystemOrchestrator | DecisionInsightMessagingSystemServer )

    • Select "Properties" from right click contextual menu.
    • In the service properties window, under "Connexion" or "Log on" tab, set the user account <Decision Insight execution account>  (./DecisionInsightMessagingSystem in the example below) to start the service.

    • Validate and close services management GUI

Secure your installation (optional)

In order to restrict what files the node can access or modify, you can apply the following rights:

Directory

<Decision Insight Messaging System administration account> rights

<Decision Insight Messaging System execution account> rights

<install directory>/bin/

read / write / execute

read / execute

<install directory>/conf/

read / write / execute

read / execute

<install directory>/product/

read / write / execute

read / execute

<working directory>

read / write / execute

read / write / execute

Related Links