Skip to main content
Skip table of contents

Configuring and Startup

Configuring FioranoMQTT Server

To allow MQTT Connections at the FioranoMQTT Server default port (1883), please modify the Configs.xml file present in the Conf folder located at $Fiorano_home/fmq/profiles/<Profile-In-Use>(FioranoMQ). The modification required is mentioned below.

Add the parameter-value pair 'Mqtt="true"' under the "CONNECTION_MANAGER" tag.

After adding the parameter value, the default Configs.xml file will have the following "CONNECTION_MANAGER" tag:

CODE
<CONNECTION_MANAGER FMQServer="false" Mqtt="true" ObjectName="Fiorano.socketAcceptors.port-2:ServiceType=ConnectionManager,Name=MqttConnectionManager,type=config" Port="1883"/>

Starting FioranoMQ Server

The FioranoMQ Server can be launched over the default profile using the fmq script. This script can be found in the fmq\bin folder of the installation directory. Alternatively, the same can be done on Windows using Start Menu > Programs > Fiorano > FioranoMQ > FioranoMQ Server

Launching Studio with Default Setup

Fiorano Studio can be launched from the command line using the following steps:

  1. Open Console
  2. Go to %FIORANO_HOME%\Studio\bin (On UNIX, go to $FIORANO_HOME/Studio/bin)
  3. Launch studio using Studio.exe or Studio.sh based on the platform used.
  4. Alternatively, Fiorano Studio can be launched from Start Menu > Programs > Fiorano > FioranoMQ > FioranoMQ Studio > Fiorano Studio

Resetting Studio

The studio remembers various configurable settings. In order to reset Studio and bring it back to its original default settings, use the script reset provided in the studio\bin folder of the installation directory.  

Setting up System Environment

The FioranoMQ Server, tools, and samples require various properties to be set. These properties are FIORANO_HOME, FMQ_DIR, and JAVA_HOME, and are set by fiorano_vars.bat or fiorano_vars.sh. Both of the aforementioned are located at the base FioranoMQ installation directory. The user may also set additional parameters using this script. This script is invoked when launching the server, Studio, or running/compiling samples.

Running and Compiling the Samples

FioranoMQ samples can be run using the FioranoMQ console which can be launched from Start Menu > Programs > Fiorano > FioranoMQ > FioranoMQ Console. Samples can be found in the %FMQ_DIR%\samples directory. The script runClient available in the fmq\bin folder of the installation directory can be used to execute a sample while the script compile-client (available in the same directory) can be used to compile it.

Compiled class files are not shipped along with the installer, the user needs to compile them by following the instructions and prerequisites mentioned in the readme files of each sample.

Running FioranoMQ Server as a Service

The FioranoMQ server can also be run as an NT service. Pre-built configurations for all the shipped profiles can be found in %FMQ_DIR%\bin\service. Please refer to the readme.txt file stored in this folder for detailed instructions regarding running them as NT services.

FioranoMQ Server can also be run as a service in a Unix environment.

Server Startup Parameters

FioranoMQ supports the concept of Container and deployable profiles. A number of arguments can be passed to the container while deploying a profile. These arguments are summarized below.

CODE
fmq.bat -profilesDir <Profiles home directory>
 -profile <Profile name>
 -dbPath <DB path for profile>
 -configPath <Conf path for profile>
 -saveConfigs <Persist server configurations on shutdown>

For UNIX: Use fmq.sh instead of fmq.bat in the above command.

Parameter

Requirement

-profilesDir

Home directory where profiles will be present.
Default = %FMQ_DIR%\profiles

-profile

Profile to be deployed in Fiorano Container.
Default = FioranoMQ

-dbPath

Database path for the configured Profile. Default = %FMQ_DIR%\run

-configPath

Conf directory path for the configured Profile.
Default=%ProfileHomeDir%\conf

-saveConfigs

Inquires whether or not to save server configurations on shutdown.
Default = false

-help

Prints help options.

JavaScript errors detected

Please note, these errors can depend on your browser setup.

If this problem persists, please contact our support.