Intellicus Enterprise Reporting and Business Insights 19.1

Installation and Configuration

0 views September 22, 2020 0

Before going ahead with installation and configuration of load balancing and clustering, you need to:

Install Intellicus.

Note:
Machine Sharability: This machine needs to be sharable for all machines running server instances.
Repository Database: HSQLDB is not used as repository when Intellicus runs in cluster environment

Decide the machines on which Load Balancers will be installed.

Decide the machines on which Cluster Node (to run Intellicus server instance) will be installed.

Make sure all the machines are on network.

Architecture

A Cluster with Shared Server and Nodes is depicted in the below diagram:

report server cluster
Figure 1: Architecture Diagram

Install Load Balancer

Setup of Load Balancer needs to be installed on each of the machine allocated to run Load Balancer.

A double-click on setup icon will launch the installer.

launch installer
Figure 2: Launching installer

Note: Load Balancer 6.x is compatible with 7.x as well.

Ready to start
Figure 3: Ready to start

license agreement
Figure 4: Accepting license agreement

User Information
Figure 5: User Information

setup type
Figure 6: Decide setup type

installation folder
Figure 7: Custom setup: Specifying destination

Click Next to continue.

select features
Figure 8: Custom setup > Select the components to install

install
Figure 9: Ready to Install

Installation in progress
Figure 10: Installation in progress

Installation complete
Figure 11: Installation complete

Adding Load Balancer Server to Intellicus Service

Adding a load balancer to the Service Manager helps the load balancer to start automatically when a windows machine boots up. Service Manager also helps in automatically re-starting a load balancer if it gets down un-expectedly.

Open Intellicus Service Manager Dialog from the Start menu:

Click Add (add button) button to add a new server:

Service Manager
Figure 12: Service Manager

You need to provide the following information while adding a Load Balancer:

Add new server
Figure 13: Service Manager: Add New Server (Load Balancer)

Load balancer properties for Service Manager Add dialog:
Property Value Comments
Server Type Report Server

Load Balance Server

Load Balance server = To add a Load balancer to this Service Manager
Server Name Type in Name A unique name for Service Manager to identify this Load Balancer
Executable file to run the Load Balancer File path File that the service will execute to startup the Load Balancer.

<installPath>IntellicusLoadBalancer LoadBalancerbinrunLB

Executable file path to stop the Load Balancer File path File that the service will execute to stop (shutdown) the Load Balancer.

<installPath>IntellicusLoadBalancer LoadBalancerbinshutdownLB

Property file path of the Load Balancer File Path Property file to load during start of this load balancer

 

<installPath>IntellicusLoadBalancer LoadBalancerconfig RegistryConfig.properties

Specify the information and click “OK”.

To save the changes, click “Save” button on Service Manager Dialog.

Configure Load Balancer

In multiple Load Balancer setup, one of the Load Balancers will act as the primary load balancer.  All other Load Balancers will act as secondary load balancers.

In the event of failure of the primary load balancer one of the secondary load balancers will take the charge of the primary one.

For all the load balancers, carry out the following configuration tasks:

Specify Cluster Node and Load Balancer related details in RegistryInfo.xml file

Setup port of the Load Balancer in RegistryConfig.properties file

Configure report engine

Configurations in RegistryInfo.xml file

Load Balancer setup places file RegistryInfo.xml in LoadBalancerConfig folder.

RegistryInfo.xml
Figure 14: Snapshot of RegistryInfo.xml file

You need to specify the following information in this file:

  • Specify details of all cluster nodes
  • Specify details of this and other load balancers
Cluster Node related information

You need to specify the following information about all the cluster nodes in the cluster:

  • SERVER IP: The IP address of the cluster node.
  • PORT: The port at which cluster node will listen.
  • TASK PRIORITY: Specify a positive integer between 1 and 6 both inclusive. Priority 1, 2 is for Low; 3, 4 is for Medium and 5, 6 is for High.
  • TASK TYPE: Specify the option ‘All’.
  • WEIGHTAGE: Specify percentage of the load that this cluster node should take.

This information needs to be provided as an entry under SERVER tag.  Example:

<SERVER IP=”192.168.33.115″ PORT=”50003″ TASK_PRIORITY=”0″ TASK_TYPE=”ALL” WEIGHTAGE=”30″/>

Specify this information for all the cluster nodes.

Load Balancer related information

You need to specify IP and port of all the load balancers.

  • REGISTRY IP: IP of the machine where Load Balancer is installed.
  • PORT: Port at which that Load Balancer will listen.

This information needs to be provided as an entry in REGISTRIES tag.  Example:

<REGISTRY IP=”192.168.33.115″ PORT=”60001″/>

Configurations in RegistryConfig.properties file

Load Balancer setup places file RegistryConfig.properties in LoadBalancerConfig folder.

Load Balancer reads value stored in REGISTRY_LISTENER_PORT property in RegistryConfig.properties file to know the listener port.

Example: REGISTRY_LISTENER_PORT=60000

Modify values of following properties
EMAIL_TO_ADDRESS

An alert through e-mail will be automatically be sent in error conditions like the server shuts down, it reaches not responding state, or goes out of memory.  Specify the email ID where the mail should be sent.

EMAIL_FROM_ADDRESS

An alert through e-mail will be automatically be sent in error conditions like the server shuts down, it reaches not responding state, or goes out of memory.  Specify the email ID that should appear as “from” in the mail sent.

SMTP_SERVER

An alert through e-mail will be automatically be sent in error conditions like the server shuts down, it reaches not responding state, or goes out of memory.  Specify the IP of the SMTP server used to send the mail.

Install Shared Report Server setup

Setup of Shared needs to be installed on the machine allocated to run Shared Node (where the folder has read/write permissions).

launch installer
Figure 15: Launching installer

Ready to start
Figure 16: Ready to start

license agreement
Figure 17: Accepting license agreement

User Information
Figure 18: User Information

setup type
Figure 19: Decide setup type

select features
Figure 20: Custom setup > Select the components to install

Destination location
Figure 21: Custom Setup: Click Browse to get Choose Folder dialog

installation folder
Figure 22: Custom setup: Specifying destination on Choose Folder dialog

Ready to Install
Figure 23: Ready to Install

Installation complete
Figure 24: Installation complete

Install Web Portal setup

Launch installer
Figure 25: Launching installer

Ready to start
Figure 26: Ready to start

license agreement
Figure 27: Accepting license agreement

User Information
Figure 28: User Information

setup type
Figure 29: Decide setup type

destination location
Figure 30: Custom Setup: Click Browse to get Choose Folder dialog

installation folder
Figure 31: Custom setup: Specifying destination on Choose Folder dialog

select features
Figure 32: Custom setup > Select the components to install

Ready to Install
Figure 33: Ready to Install

Installation complete
Figure 34: Installation complete

Install Cluster Report Server setup

Setup of Cluster Node needs to be installed on each of the machines allocated to run Cluster Node.

launch installer
Figure 35: Launching installer

Ready to start
Figure 36: Ready to start

license agreement
Figure 37: Accepting license agreement

User Information
Figure 38: User Information

setup type
Figure 39: Decide setup type

destination location
Figure 40: Custom Setup: Click Browse to get Choose Folder dialog

installation folder
Figure 41: Custom setup: Specifying destination on Choose Folder dialog

select features
Figure 42: Custom setup > Select the components to install

Ready to Install
Figure 43: Ready to Install

Installation complete
Figure 44: Installation complete

Upon successful installation, the system prompts you to configure the cluster:

Cluster Report Engine
Figure 45: Configure Cluster Report Engine

After entering “y”, you can then specify the path of shared location for successful configuration.

Successful Configuration
Figure 46: Successful Configuration

Configure Cluster Node

Deploying License on a node

Each node generates its license request file in the path:

<ClusterInstalledPath>ClusterReportEnginebin

A license file must be obtained by submitting this request file to your vendor. The obtained license must be deployed by manually copying to the license file in the path:

<ClusterInstalledPath>ClusterReportEnginebin

Note: Separate licenses should be purchased for each report server node

Restart after license deployment.

Configure each of the Cluster Report Servers

For all the cluster nodes, carry out the following configuration tasks:

  • Set path of report server in cluster.properties file
  • Set the port of the Cluster node in cluster.properties file
  • Set schedule preferences in cluster.properties file
  • Make changes in run.bat file

Path and IP information of Intellicus Report server is set in cluster.properties file. This file is at path IntellicusClusterClusterReportEnginecluster folder.

Configurations in cluster.properties file

Cluster Report Server setup places file cluster.properties in IntellicusClusterClusterReportEnginecluster folder.

Modify values of following properties
REPORT_ENGINE_FOLDER

In REPORT_ENGINE_FOLDER property, specify the location where Shared Intellicus Report Server is installed.

For example:

REPORT_ENGINE_FOLDER=//servers/IntellicusShared/ReportEngine

Here, “servers” is machine name on which Intellicus Report Server is installed.

REPORT_ENGINE_FOLDER= \192.168.33.65IntellicusSharedReportEngine

Here, 193.45.34.24 is IP on which Shared Intellicus Report Server is installed.

Port

In LISTENER_PORT property, specify the port at which this cluster node will listen.

For example:

LISTENER_PORT = 50001.

DEPLOYMENT_TYPE

Specify STANDALONE if Intellicus is running as standalone.  Specify CLUSTERED if Intellicus is running in the form of a cluster.

Default: CLUSTERED

Example: DEPLOYMENT_TYPE=CLUSTERED

Making changes in run.bat

In run.bat file specify the path where Shared Intellicus Report Server is installed.  This is set in line under REPORT_ENGINE_FOLDER.  For example,

REPORT_ENGINE_FOLDER=//servers/ReportEngine

Here, “servers” is machine name on which Shared Intellicus Report Server is installed.

For example, REPORT_ENGINE_FOLDER= 193.45.34.24SharedIntellicusSharedReportEngine

Here, 193.45.34.24 is IP on which Intellicus Report Server is installed.

Making changes in shutdown.bat

In shutdown.bat file specify the path where Shared Intellicus Report Server is installed.  This is set in line under REPORT_ENGINE_FOLDER.  For example,

REPORT_ENGINE_FOLDER=//servers/ReportEngine

Here, “servers” is machine name on which Shared Intellicus Report Server is installed.

For example, REPORT_ENGINE_FOLDER= 193.45.34.24SharedIntellicusSharedReportEngine

Here, 193.45.34.24 is IP on which Intellicus Report Server is installed.

Configure each of the Cluster Web Servers

For all the cluster web server nodes, carry out the following configuration tasks:

  • Set path of report server in ReportClient.properties file
  • Make changes in run.bat file
Configure portal Property file

When clustering and load balancing is installed, portal needs to point to load balancers instead of pointing to report server.

This change is made in ReportClient.properties file available on machine on which Shared Intellicus Client (portal) is installed.

When Intellicus is installed in Jakarta, this file is placed at path:

IntellicusSharedJakartawebappsintellicusclientconfigReportClient.properties .

Change values of following properties:

REGISTRY_ENABLED

Set this property to TRUE.  For example:

REGISTRY_ENABLED=TRUE

REGISTRIES

Specify all IP and port of all the load balancers separated only by semi colon (no space).

Example:

REGISTRIES=201.90.56.23:60000; 201.90.88.95:60002; *

Save the file after making changes.

Configure run.bat file

Modify run.bat file (IntellicusClusterJakartabin) to set the path to read ReportClient.properties

set PROPERTY_FILENAME=”-DIntellicus.propertyfilepath=192.168.33.65SharedIntellicusSharedjakartawebappsintellicusclientconfigReportClient.properties”

How Property values are used

When value of REGISTRY_ENABLED is FALSE, it is assumed that clustering does not exist and client sends request to the IP specified in REPORT_ENGINE_IP property.

When value of REGISTRY_ENABLED is set to TRUE, client sends request to the 1st load balancer IP specified in REGISTRIES property.

If that load balancer is not available, client sends request to next load balancer in the list.

At a time multiple load balancers may be active.  IP needs to be specified only by primary load balancer.

If the load balancer that client communicates with is not the primary load balancer, then it provides IP of the primary load balancer to the client.  (So that from next time all the client requests should go to primary load balancer).

The client then checks if the load balancer IP provided exists in the list specified in REGISTRIES property.

Note: If the IP exists or it does not exist but list also has *, client sends the request to that load balancer.  If it does not exist in the list; and list does not have *, then the client fallsback to the IP specified in REPORT_ENGINE_IP property.

When client sends request to the primary load balancer, It provides IP of the server where the client should send this request.

Now that the client know server IP, it sends the request to that server.

Run sequence

There is no predefined running sequence.  Any of the components can be started or stopped at any time.

To run load balancer

If the machine is re-started after setup and service was also installed during installation, it will automatically start the load balancer.

As one of the results of successful installation, the setup creates a short cut in the start menu:

Start > Programs > Intellicus > Start Load Balancer

Follow this path to click Start Load Balancer to launch the Load Balancer.

Note: The load balancer that boots first, becomes primary load balancer.  If primary load balancer fails, any of the secondary load balancers will become primary load balancer.

To stop load balancer
From Start menu

As one of the results of successful installation, the setup creates a short cut in start menu:

Start > Programs > Intellicus > Stop Load Balancer

Click Stop Load Balancer to stop the Load Balancer.

From Service Icon

This is applicable when Service was also installed during installation, is currently running and Load Balancer was started by Service.

  1. Right-click the Service icon. A context-menu appears.
  2. Click the Stop Load Balancer

Service will stop the Load Balancer.

To run Cluster node

As one of the results of successful installation, the setup creates a short cut in the start menu:

  • Start > Programs > Intellicus > Start Cluster Report Server
  • Follow this path to click Start Cluster Report Server to launch the Load Balancer.
To stop cluster node
From Start menu

As one of the results of successful installation, the setup creates a short cut in the start menu:

  • Start > Programs > Intellicus > Stop Cluster Report Server
  • Click Stop Cluster Report Server to stop the cluster report server.