Install a node on Windows


Hardware prerequisites

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

Mandatory prerequisites

Here is the list of the mandatory prerequisites; if they're not met the node will refuse to start:

  • at least 2 CPU cores on the server
  • a 64-bits operating system
  • an Oracle Java 8 64-bits JVM — provided by the node itself but can be changed
  • at least as much physical memory than the memory configured for the JVM — the JVM cannot use more memory than available RAM

System prerequisites

A node currently supports the following software prerequisites set up on your machine:

  • 64-bit Windows Operating System:
    • Windows Server: 2008 R2, 20122012 R2, 2016 running on premise or in Microsoft Azure cloud.
    • Windows (for test environments): 7, 8, 8.1, 10

Configuration prerequisites

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

Accounts

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

    Directory Permissions
    <install directory> read, write, execute

    <working directory>

    read, write, execute

    <logging directory>

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

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

<install directory> is the directory where the node will be installed.

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

<logging directory> is the directory where the node logs will be stored (by default, <logging directory> is <working directory>/log).

Installation prerequisites

  • A valid license file provided by Axway

Install a node

Using the graphical mode

Launch  the installer

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

  • Double-click on the installer

  • Launch the installer from the command line interface:

    DecisionInsight_2.0.0_Install_win-x86-64_BNXXXXXXXXXX.exe

Follow the installation steps

Step 1: Overall information

Once you have successfully launched the installer on your machine, the installer welcome page is displayed. Click Next.

Step 2: License agreement

Accept the software license agreement and click Next.

Step 3: Destination directory

If you install the node in the default installation path – C:\Program Files\DecisionInsight  – the node will not work out of the box  as this directory is not writable by default.

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

Select an installation path that fulfills the prerequisites:

  • <Decision Insight administration account> must have full access.
  • <Decision Insight execution account> must have read & execute permissions.

Step 4: Node settings

Time zone

It represents a time zone offset.
It can be filled either by using an ID or the GMT format.

  • For a list of time zone IDs, you can consult List_of_tz_database_time_zones (wikipedia). For instance, the time zone ID for the U.S. Pacific Time zone is "America/Los_Angeles". 
  • The GMT must follow this pattern GMT[+-]00:00. For instance, GMT+01:10 means one hour ten minutes ahead of GMT. This is not the recommended way to specify a time zone with DST.

Storage starting date — YYYY-MM-DD format, by default 1 month ago.

For a better performance of the platform, this value should be as close as possible to the date of the oldest data expected in the platform

Click Next.

Step 5: Security

Default administrator password

Enter the password that will be used to access the admin account.

Encryption

Enter the encryption master password. It will be used to generate the encryption key file.
Key storage: you can choose where to store the encryption key file. (avertissement) It should be a secure location. For more information, see Database encryption.

Step 6: Network settings

HTTP port /  Web context root

Here are some examples of node URLs given an HTTP port and a Web context root.

HTTP port Web context root URL to access the node
8080 / http://localhost:8080/
8080 /adi http://localhost:8080/adi/
80 /adi http://localhost/adi/

To use HTTPS instead of HTTP, you must modify some configuration files after the installation complete. For more information, see HTTP Settings.

Note: If you are installing a node that will belong to a node cluster, each node may have their own specific URL. In a primary/replica cluster, you can configure a primary URL that the end user will use to access dashboards and so on. For more information, see Install a Primary/Replica cluster.

Proxy URL

Optional application entry point through HTTP.

If must be filled if the application will be accessed through a proxy.

Enable JMX

This option enables/disables the JMX feature and the JMX port below.

JMX port

Port that will be used to access the node using the JMX protocol.

When you're done with the settings, click Next.

Step 7: Installation

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

Step 8: Installation finished

The software is installed and ready to use.

Check the Create a response file option to relaunch the same installation configuration later without having to go through all the installer screens. The response file is generated in the node installation directory. For more information, see Using the automated mode.

Click Done to close the window.

Using the console mode

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

start /wait DecisionInsight_2.0.0_Install_win-x86-64_BNXXXXXXXXXX.exe -c

Steps are the same as for the graphical installation mode.

Using the automated mode

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

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

response.varfile
# Destination directory
sys.installationDir=C\:\\Program Files\\DecisionInsightNode
  
# Platform settings
timezone=Europe/Paris
initialVTperiod=2017-08-01

# Admin password
hashPassword=4095\:e24f5a84b1b65eddca66a3c4cabdfd22c51bdc2003c2a6e8\:86009c512687a791435ece701cd7de55f167b549bbf090b6
  
# Network settings
httpPort$Long=8080
contextRoot=/myApp
proxyUrl=
jmxEnabled$Boolean=true
jmxPort$Long=1099
  
# Installer settings
sys.adminRights$Boolean=false
sys.languageId=en

# Encryption (only if encryption was not already defined)
encryptionKeyPath=C\:\\Program Files\\DecisionInsightNode\\conf
encryptionSaltPath=C\:\\Program Files\\DecisionInsightNode\\var\\data\\titanium-temporal

When upgrading an old node with no encryption support, you cannot do it fully automatically as you must first generate a key using a tool from an up-to-date node.

  1. Generate the key and salt file manually using the script from an up-to-date node (see: How to generate a new encryption.key file? ).
  2. Manually add the two encryptionKeyPath and encryptionSaltPath in the response file to match the directories where you just generated the files.


Launch the installer from the terminal using the following command:

start /wait DecisionInsight_2.0.0_Install_win-x86-64_BNXXXXXXXXXX.exe -q -varfile response.varfile

Install the license

A valid license is required to start the node. The license is a file having a .jar or .licence extension.

You should copy this file in the <install dir>/lib/licences directory.

Adjust your persistence parameter

It is recommended to check the settings of the embedded database for better performances.

Update the field com.systar.titanium.initialPeriodValidTimeEnd in <install dir>/conf/platform.properties (Value is a date).

conf/platform.properties
com.systar.titanium.initialPeriodValidTimeEnd=2014-01-01T00:00:00.000

Example 1: if the node is set-up on 2014-04-20 simply put this date

Example 2: the node is set-up on 2014-04-20, but past data up to 2014-09-20 is injected, then configure the date 2014-09-20 for optimal performances

(avertissement) Once the node has started at least once (and so has some saved data), you can no longer modify this parameter.

(info) The value for this parameter is also used to define before which date it will not be possible to create an application.

Example: If the node is set up on 2014-04-20, but you wish to create a dashboard valid from 2014-04-10 then set the date to 2014-04-10.

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 contents of <node directory>/var to <working directory>.
  2. Edit the following file:
<installation directory>/conf/path.conf
WORKING_DIR=<working directory>


Change the logging directory (optional)

To specify the directory where the node will write the logging files, you can change the <logging directory>.

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

  1. Copy the content of <working directory>/log to <logging directory>
  2. Edit the following files:

    <installation directory>/conf/platform.properties
    com.systar.platform.log.dir=<logging directory>

Install as a service (optional)

Multi instance configuration

If you want more than one instance of Decision Insight installed as a service, edit the com.systar.platform.name= property in <installation dir>/conf/platform.properties.

This value will be used as the service name. (Default name is DecisionInsight)

To install the service:

  1. Once the node is installed and configured, execute the provided configuration script located in <installation directory>/bin using the specific user <Decision Insight administration account>

    <installation directory>\bin\tnd-service-configure.bat
    This command generates a  DecisionInsight.ini file used to launch the node as a service.Do not manually modify this file. If configuration files ( jvm.confpath.conf, platform.properties) are modified after installation as service, re-execute this script. No specific user is needed to do this operation.
  2. Execute the provided installation script located in <installation directory>/bin using the specific user <System administration account>.




<installation directory>\bin\tnd-service-register.bat


This will install the service as an operating system service named <product-name> and set 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 from the Windows services management GUI (default user is local system):


  1. From the Start menu, in the Find programs search bar, type Services.  
  2. In the list of available services, locate DecisionInsight.

  3. Right-click the service and select Properties
  4. In the service properties window, under the Connexion tab, set the user account <Decision Insight execution account>  (./DecisionInsight in the example below) to start the node from a service.

  5. Apply your changes and close the services management window. 

Secure your installation (optional)

To restrict what files the node can access or modify, you can apply the following rights:

Directory

<Decision Insight administration account> rights

<Decision Insight execution account> rights

<installation directory>/bin/

read / write / execute

read / execute

<installation directory>/conf/

read / write / execute

read / execute

<installation directory>/lib/

read / write / execute

read / execute

<installation directory>/product/

read / write / execute

read / execute

<working directory>

read / write / execute

read / write / execute

<logging directory> read / write / execute read / write / execute

Related Links