Getting Started Guide +Basic Setup Installing Fiorano Platform Installing on Windows Platform Installing on Linux Platform Installing on Unix Platform Installing on Solaris Sparc Platform Installing on Solaris X86Platform Installing on Mac OS Verifying Installer Integrity Fiorano 10 Editions Enterprise Edition Workstation Edition Setup JAVA Selection Installation Configuration Providing Permissions on Windows Servers Turning Off or Excluding Fiorano Processes from Antivirus Server Memory Configuration Configuration Steps General Recommendations Installing Licenses Starting Servers Starting the Tools Fiorano eStudio ESB Web Console Shutting down the running servers +Advanced Setup Installing servers as NT Services Install/uninstall a Profile as NT Service SBW DB Configuration Prerequisites Configuration from eStudio Manual Configuration HA Setup Setting up Lock files on a Gateway machine Server Naming +Uninstalling Fiorano Platform Uninstallation Instructions for Windows Uninstallation Instructions for Linux Uninstallation Instructions for Unix Uninstallation Instructions for Solaris Sparc Uninstallation Instructions for Solaris X86 Uninstallation Instructions for Mac

Getting Started Guide

Basic Setup

Installing Fiorano Platform

Installing on Windows Platform

To install the Fiorano Platform, perform the following steps:

For more details on how to start and use the Fiorano ESB Servers and Tools, please refer to FIORANO_INSTALLATION_DIR/GettingStartedGuide.htm

Installing on Linux Platform

To install Fiorano Platform, perform the following steps:

For more details on how to start and use the Fiorano ESB Servers and Tools, please refer to Starting Servers, Starting the Tools

Note: The bin installer might fail if openjdk is set as JAVA_HOME in some systems. In case of issues, please use Oracle's Java and set the JAVA_HOME variable appropriately.

Installing on Unix Platform

To install Fiorano Platform, perform the following steps:

Installing on Solaris Sparc Platform

To install Fiorano Platform on Solaris Sparc OS, perform the following steps:

Installing on Solaris X86Platform

To install Fiorano Platform on Solaris X86 platform, perform the following steps:

Installing on Mac OS

To install Fiorano Platform on Mac OS platform, perform the following steps:

Verifying Installer Integrity

It is essential that you verify the integrity of the downloaded installer files to ensure the file you downloaded is not corrupt. Fiorano provides pre-calculated hash values using SHA1 and MD5 Algorithms for each installer. One can use the Fiorano provided checksum utility or other command line programs like md5sum/sha1sum/md5/sha1 to check the integrity.

How to check:

The simple way is download the 'Fiorano checksum utility', provide the values for the properties specified in checksum.properties file and run the 'ant' command. You will directly receive the result of the downloaded installer file's integrity check.

OR

Run the command md5sum/sha1sum or md5/sha1.
Let's say you want to check the file fsoa_***.exe using MD5, type the command below in the terminal.

$ md5sum fsoa_***.exe

After running this command, md5sum prints out the 128-bit hash value. Compare this string you obtained with the hash value provided at the product downloads link. If both are identical, then the download is accurate else the download is corrupt, Please download the installer again. Similarly one can perform the above steps after executing the following command using 'sha1sum', that prints out 160-bit hash value for fsoa_***.tar.gz file.

$ sha1sum fsoa_***.tar.gz

Note: The 'Fiorano checksum' utility uses java 1.6 or above and ANT 1.7.0 or above.


Fiorano 10 Editions

Fiorano 10 is available in two editions:

Enterprise Edition

The Enterprise Edition is a comprehensive suite consisting of all the servers and tools in the Fiorano 10. The servers included with Fiorano 10 are:

The Enterprise Edition also includes a rich set of tools that make the tasks of configuring and administering a Fiorano Network, and developing distributed applications using Fiorano 10 remarkably easy. Some of the widely used tools shipped with the Fiorano 10 are:

Workstation Edition

The Workstation Edition includes all components of the Enterprise Edition except Fiorano ESB Server. Therefore, the Workstation Edition expects the Enterprise Edition to be installed on the network.

Note: For instructions on how to add a Peer Server to an existing ESB network, please refer to section 2.4.4.3 Changing to different ESB Network in the online documentation for the product.


Setup JAVA

The Fiorano Platform needs Java Runtime Environment (JRE) to function properly. A compatible 32 bit JRE is provided as part of Windows installer. For other operating systems and for environments with high activity, the following procedure needs to be followed to setup the JRE.

Selection

A JRE is sufficient in general but Java Development Kit (JDK) is necessary in case there is need to build custom Java components. JDK 1.6 (revision 30 or above) is recommended. JDK7 is supported by Fiorano 10. It is not supported by in earlier versions.

32bit version or the 64bit version can be chosen depending on the architecture of the server machine. A 32-bit JDK can be used with 64 bit architecture but 64 bit JVM is highly recommended in production environments where the servers will need more memory.

Installation

The Java Development Kit can be downloaded from the official Oracle website, under their Oracle JAVA SE Downloads section here: http://www.oracle.com/technetwork/java/javase/downloads/index.html

To install the Java SE Development Kit, simply double-click the JDK installer, and follow the instructions on the installer wizard.

Configuration

After the installation, the following changes have to be done in Fiorano Environment to use the installed JDK.

Servers

eStudio

To use eStudio with 64 bit JVM, a module needs to be installed.

Note: eStudio works well with 32 bit JVM when server's JVM is 32 bit or 64 bit. This patch is needed only when there is a need to use 64 bit JVM for huge memory allocation or if 32 bit JDK is not available.

The instructions are as below.

Installing eStudio 64bit JVM Patch

Before installing the eStudio 64bit JVM patch, make sure you have Apache Ant installed on the machine. Apache Ant can be downloaded from the official Apache website. We recommend Ant version 1.7.0.

Once downloaded, extract the Apache Ant zip file to a desired location. Set a new User Variable with the Variable Name ANT_HOME and the Variable Value pointing to the location of the extracted Apache Ant files. Edit the System Variable Path and append ';%ANT_HOME%/bin' at the end.

By default eStudio is configured to launch using 32-bit JVM. To install 64bit jars:

Components


Providing Permissions on Windows Servers

For Fiorano 10 to work flawlessly and efficiently, the installer directory needs to have Administrator privileges. To grant permissions to specific/all users:


Turning Off or Excluding Fiorano Processes from Antivirus

Fiorano Servers access various files in its installation directory, for all the processes to be able to run properly, we recommend excluding FIORANO_HOME from the antivirus checks.

Note: FIORANO_HOME needs to be excluded from McAfee antivirus checks as its a known issue of calls getting blocked by McAfee.

On the Firewall level Fiorano uses a set of fixed default ports that needs to be allowed on the server firewall for Fiorano Servers to interact with each other. These ports are specified in the server profiles.

The specific ports (default) that needs to be allowed are as mentioned below:

Fiorano Enterprise server: Fiorano Peer Server:

Note: We recommend allowing connections from all ports between the various servers, that is, allowing IP based communications and not making the firewall port specific as far as possible.


Server Memory Configuration

Better server performance is possible with proper configuration of JVM parameters, particularly those related to memory usage. The allocation of memory for the JVM is specified using -X options when starting the server.

JVM option Meaning Default ESB Settings
-Xmx Maximum heap size 512MB
-Xms Initial heap size 256MB
-XX:MaxPermSize Permanent Generation Space 128m

Note: The stack size limits the number of threads that you can run in a given JVM. A large stack size may result in memory running short as each thread is allocated more memory than needed.

Configuration Steps

General Recommendations

JVM Server class Client Class
32 bit JVM -Xmx2048m
-Xms1024m
-XX:MaxPermSize=256m
-Xmx1024m
-Xms512m
-XX:MaxPermSize=128m
64 bit JVM -Xmx4096m
-Xms1024m
-XX:MaxPermSize=256m
-Xmx1024m
-Xms512m
-XX:MaxPermSize=128m

Note: These recommendations are generic, they will differ for Production/Testing environments based on usage.


Installing Licenses

Fiorano 10 is a licensed product. The required licenses can be obtained by sending an email to licensing@fiorano.com.

Important: Once the licenses are obtained, the .lic files have to be placed in the folder FIORANO_HOME/licenses before starting the servers.

Starting Servers

Fiorano Enterprise Server

OR

Note: To run HA Profiles, before executing the above command please make sure that you have configured the HA Profile from Profile Management in eStudio.


Figure 3: A successfully deployed Enterprise Server Console

Fiorano Peer Servers

Note: To run HA Profiles, before executing the above command please make sure that you have configured the HA Profile from Profile Management in eStudio.

OR

Note: To run HA Profiles, before executing the above command please make sure that you have configured the HA Profile from Profile Management in eStudio.


Figure 4: A running Peer Server console window

Starting the Tools

Once you have started Fiorano ESBServer and Fiorano ESBPeer, you can start any of the tools. The following are some of the tools that will be widely used and are provided with both editions of Fiorano 10:

All Fiorano 10 Tools require a JRE that is compliant with JavaSoft JRE version 1.6 or higher. Before launching any Fiorano 10 tool, ensure that the JAVA_HOME variable in the fiorano_vars.bat file which is located in the installation directory of the Fiorano 10, points to the root directory of the desired JRE installation.

Fiorano eStudio

The Fiorano eStudio enables you to compose an Event Process visually, deploy it instantly, monitor it, and debug it. It provides an easy to use GUI, which allows you to develop event processes simply by dragging and dropping components that meets your business or technical requirements. Fiorano eStudio has been developed on eclipse giving you the capability to compose event process without connecting to any server. The EPLCM (Event Process Life Cycle Management) allows a user to move an Event Process in different labeled environments that is, Testing, Staging, QA, and Production at the click of a button.

The Fiorano eStudio also provides various other features in addition to visual process creation, like administration of the servers and configuring the server profiles.

Starting Fiorano eStudio

For Windows:
Click Start > Programs > Fiorano > FioranoXXX> Fiorano Tools > Fiorano eStudio.
For UNIX:
Run the script eclipse located in $FIORANO_HOME/eStudio/eclipse directory.
For Mac:
Run the script eclipse located in $FIORANO_HOME/eStudio/eStudio.app/Contents/Macos directory.
The documentation for eStudio is available at http://www.fiorano.com/devzone/doc_fsoa.php#4

 

To launch nStudio on MAC, type in the following command: 'ksh Studio.sh --jdkhome $JAVA_HOME' (please make sure that $JAVA_HOME points to JDK 1.7.

You can check it using '$JAVA_HOME/bin/java -version' command).

To launch eStudio on MAC, type in the following command: 'chmod +x $FIORANO_HOME/eStudio/eStudio.app/Contents/MacOS/eStudio'.

Now, you should be able to launch eStudio.
Note

ESB Web Console

ESB web console allows user to monitor the Fiorano enterprise network.

Starting ESB Web Console

To start ESB Web Console, start Fiorano Enterprise Server (FES) and open link http://<FES IP>:1980/ESBDashboard.

User can login to the Fiorano Web Console by entering user name and password that is configured for the FES.

Shutting down the running servers

The Servers can be shutdown using the shutdown-server script present in FIORANO_HOME/esb/server/bin folder.

Note: Shutdown scripts cannot be used to shutdown both primary and secondary servers running in a shared HA mode simultaneously, and using the RMI connection. In case, HA profiles from previous versions are migrated to the current version of the product, these profiles need to be re-configured to specify the BackupRMIServerPort property in order to make use of this functionality.

This script can be used to:

Options that can be specified to the script are:

Please refer Section 2.3 and 2.4 of Fiorano 10 User Guide for more details.


Advanced Setup

Installing servers as NT Services

Changes in Configuration Files

The server.conf file is located under FIORANO_HOME/esb/server/bin contains various settings related to the JVM like bootclasspath, classpath, server memory, system properties, and so on. This file is used while creating configuration files required to run the server as a NT service.

The configuration files are generated under the following directories:

Note:

Once the server is installed as a service, further changes to the file 'server.conf' will have no effect on the server as the configuration files will not be regenerated. The server's NT service needs to be uninstalled and then installed again for the changes to be effective.

Important: Before installation of server profiles as services on Windows Server 2003/2008, the following line needs to be added to file FIORANO_HOME/esb/server/bin/server.conf 'java.io.tmpdir=C:/Windows/temp' under the '<java.system.props>' tag.

Install/uninstall a Profile as NT Service

To install a Profile as NT Service, perform the following steps:

To uninstall a StandAlone (Non-High Availability) Profile as NT Service, perform the following steps:


SBW DB Configuration

Note: State Based Workflow (Document tracking) is activated by default and uses H2 Database as its default database which is shipped with Fiorano, no configuration changes are needed if the default H2 database is used.

To use any other RDBMS compliant commercial database, perform the following steps:

Prerequisites

Different parameters corresponding to SBW database can be modified either from eStudio or Manually.

Configuration from eStudio

Manual Configuration

After the above settings are complete, please start the Fiorano Enterprise Server. It should now connect to the database and create the tables required for document tracking.

Note: REPRESENTABLE_DATA_TYPES is set to false by default for backward compatibility. It is recommended to be set as “true” for efficient search of tracked documents.


HA Setup

Setting up Lock files on a Gateway machine

Example:

If the directory containing the lock file on Windows, is shared using the samba protocol, this directory should be mapped to a network drive on the Windows machine hosting the server.

If the shared directory is mapped to a drive 'Z:/' and the lock file is lock.lck, the lock file path will be 'Z:/lock.lck'.


Figure 5: Lock file parameter configuration can be done in eStudio's Profile Management perspective

Server Naming

Within the same HA Profile, both Primary and Secondary Server node names should be same.

Server node name cannot be same for servers in different Peer HA profiles connecting to the same FES.


Uninstalling Fiorano Platform

Uninstallation Instructions for Windows

To uninstall Fiorano Platform, perform the following steps:

Or

After un-installation the following folders will be present in FIORANO_INSTALLATION_DIR

Note: Retain a backup of these folders if the data has to be migrated to a different Fiorano installation.

Uninstallation Instructions for Linux

To uninstall the Fiorano Platform, open terminal at $Fiorano_Home/_uninstall and execute the command ./uninstaller.bin to get the wizard page.

After un-installation the following folders will be present in FIORANO_INSTALLATION_DIR

Note: Retain a backup of these folders if the data has to be migrated to a different Fiorano installation.

Uninstallation Instructions for Unix

To uninstall Fiorano Platform, perform the following steps:

Uninstallation Instructions for Solaris Sparc

To uninstall the Fiorano Platform, open terminal at $Fiorano_Home/_uninstall and execute the command ./uninstaller.bin to get the wizard page.

After un-installation the following folders will be present in FIORANO_INSTALLATION_DIR

Note: Retain a backup of these folders if the data has to migrated to a different Fiorano installation

Uninstallation Instructions for Solaris X86

To uninstall the Fiorano Platform, open terminal at $Fiorano_Home/_uninstall and execute the command ./uninstaller.bin to get the wizard page.

After un-installation the following folders will be present in FIORANO_INSTALLATION_DIR

Note: Retain a backup of this folder if the data has to be migrated to a different Fiorano installation.

Uninstallation Instructions for Mac

To uninstall Fiorano Platform, perform the following steps:

Product APIs

Fiorano 10 includes APIs which can be used for creating custom components, managing and monitoring servers. The API documentation is present at FIORANO_INSTALLATION_DIR/javadoc

Contact Information

If you have any questions and/or comments on Fiorano 10, please feel free to contact us at:

Fiorano Software Technologies Pvt. Ltd.

Our Website - http://www.fiorano.com

Our Support - http://support.fiorano.com

Evaluation Support - presales@fiorano.com

Check out our Developer Zone at http://www.fiorano.com/devzone/dev_zone.php

 

© 2008-2013, Fiorano Software Technologies Pte Ltd. All rights reserved.