Contents

Scripts present under <fiorano_installation_dir>

  • fiorano_vars.bat: Used to set the Environment Variable which is used throughout Fiorano server scripts. It is also used to set Endorsed libraries.
  • uninstall.bat: Script used to uninstall the FioranoMQ installation.

Scripts present under <fiorano_installation_dir>\fmq\bin

backupDB.bat

This script is used to backup the database of the profile specified by the User. This script moves the existing database from the profile directory to the backup database directory.

Usage

Example: backupDB.bat FioranoMQ\profiles\FioranoMQ\run\profiles\FioranoMQ_backupDB

This moves the existing database from the FioranoMQ\run directory to the directory specified by the User. By default, a backup of the FioranoMQ database is taken and a new directory created inside profiles\FioranoMQ directory using the current date of the system.

ClearDB.bat

This script is used to clear the existing database in the FioranoMQ server.

Usage

By default, this clears the FioranoMQ profile database.

    • -profile <profilename>: Profilename from profiles directory to the profile to be deployed. Defaults to FioranoMQ.
    • –DBDir <FMQ DB path>: Database directory of the profile configured. Defaults to <fiorano_installation_dir>\fmq\profiles\<profile>\run"
    • -profilesDir <Profiles directory>: Directory where profiles are present.Defaults to <fiorano_installation_dir>\fmq\profiles
Icon

Clearing the database removes all user created information, including all Topics/Queues/ConnectionFactories created, as well as User permissions and Groups. If the user wants to clear the database only partially, the option to clear Admin Storage, Data Storage and ACL Storage can be chosen instead the whole database.

compile-client.bat

This script is used to compile Java samples included in the installer.

Usage

create-database.bat

This script is used to create a database. There are two ways by which databases can be created.

a. Using FioranoMQ Configuration:

The database section of the FioranoMQ profile has to be configured. Refer Chapter 6: Configuring Message Store for information on configuring the database section.

Usage

Example: The following command creates a database using message store configuration for MSSQL in the FioranoMQ_SQL profile:

b. From command line arguments:

Database configuration details are provided as an option on the command line.

Usage

Please refer Chapter 6: Configuring Message Store.

Example: The following command creates a database using message store configuration for MSSQL

fmq.bat

Launches the FioranoMQ server. By default, the FioranoMQ profile is launched if no other profile is specified.

Usage
    • -profile <path>: Relative path from profiles directory to the profile to be deployed. Defaults to FioranoMQ.
    • -profilesDir <dir>: Directory where profiles are present.Defaults to <fiorano_installation_dir>\fmq\profiles
    • -configPath <dir>: Conf directory path for the configured profile. Defaults to <fiorano_installation_dir>\fmq\profiles\<profile>\conf
    • -dbPath <dir>: Database path for configured profile. Defaults to <fiorano_installation_dir>\fmq\profiles\<profile>\run"
    • -saveConfigs <boolean>: Persists server configurations on shutdown.Defaults to false
    • –help: Displays all available options.

Example: The command below starts the FioranoMQ HA primary server. fmq.bat –profile FioranoMQ_HA_rpl\HAPrimary

fmq-console.bat

This script is used to setup the class path for the Java samples included within the FioranoMQ installation.

Usage

Once run, it sets the classpath for the samples and moves the command prompt to the %fiorano_installation_dir %\fmq\samples directory.

fstart.bat

This script displays a new console with the command specified as 'command line argument'. If nothing is specified it opens a new command prompt within the same current directory.

Usage

For Example: fstart.bat fmq.bat.

This launches the FioranoMQ server with the default profile, that of FioranoMQ.

recover-database.bat

This script is used to recover the database in the event that the FioranoMQ proprietary File based datastore is corrupt.

On launch, the script recovers the PTP database by default. For more information on the usage of the script refer to the chapter on Fiorano DB Recovery Tool.

Usage
    • –propertiesFile: Configuration file. The default configuration file is located at <fiorano_installation_dir>\fmq\profiles\recovery.properties
    • -fmq.profile <path>: Relative path from the profiles directory to the profile expected to be deployed. Defaults to FioranoMQ.
    • -h: Displays help topics

run-client.bat

This script is used to run Java samples included in the FioranoMQ installation. External jars can be added to classpath in fiorano_installation_dir>\fmq\bin\run-client.conf

Usage

build-all-clients.bat

This script is used to compile all Java samples included in the installer. The script makes use of compile-client.sh to compile each of the samples internally. External jars can be added to classpath in <fiorano_installation_dir>/fmq/bin/complie-client.conf

Usage

migrate. bat and convert-database.bat

migrate.bat script file is used for transferring the FioranoMQ2007 database to the FioranoMQ9 format. This script uses convert-database.bat for converting the database table files and data files to FioranoMQ9 format. It is recommended that the 'readme.txt' file be referred to for instructions on using this utility.

startCluster.bat

startCluster.bat script file is used for running the FioranoMQ Management server using the FioranoMQ_Clustering profile. For more information on FioranoMQ Management Server and its functions refer to Chapter 32: Fiorano Directory Services.

routeUtility.bat

routeUtility.sh script file is used for creating/removing multiple routes between destinations (Queues/Topics) based on the configuration file specified on the route utility. The configuration file (routes.xml) contains the properties of each route to be created.

A sample route configuration file can be found at $FIORANO_HOME/fmq/Utilities/RouteUtility/conf folder.

Usage

where,

  • configFile: XML file that contains configurations of routes. If no configuration file is specified when the route Utility is run, then 'routes.xml' becomes the default configuration file.
  • Operation: The operation that needs to be executed using the route utility.
  • Valid Values: createRoutes OR removeRoutes. If no operation is specified, 'createRoutes' is chosen by default.

shutdown-fmq.bat

This script is used to shutdown the FioranoMQ server. This script creates a JMXConnection based on the arguments passed. If none of the arguments are passed, then default parameters are used. If the arguments passed are invalid, then an exception is displayed on the console.

Usage for Windows

Where options include:

Parameter Name

Description

Legal Values

connectorType

Type of the connector which needs to be created for making a jmx connection with FioranoMQ server.

RMI (Default Value), JMS

host

URL of the machine where the server is running. If the server is running on the machine as the shutdown script, the host name does not need to be specified.

localhost (Default Value), IPAddress

port

The port of the FioranoMQ server that will accept JMS connections. This value should be specified only if the connector 'type' is JMS.

1856 (Default Value)

user

Name of the user trying to shutdown the FioranoMQ server. This user should have permission to create a JMX connection.

admin (Default Value), anonymous, ayrton

passwd

Password of the user trying to shutdown the FioranoMQ Server.

passwd(Default Value for admin), anonymous (for user anonymous), senna (for user ayrton)

transportProtocol

Transport protocol which should be used for making a connection with the FioranoMQ server. This value should be specified only if the connector 'type' is JMS

TCP (Default Value), HTTP, LPC

securityProtocol

Security protocol which needs to be used to make a connection with the FioranoMQ server. By default, there is no security protocol. This value should be specified only if the connector 'type' is JMS.

null (Default Value), SUN_SSL.

securityManager

Security Manager which need to be used for making a connection with FioranoMQ Server. By default there will not be any security Manager. This value should be specified only if the connector type is JMS

null(Default Value), DefaultJSSESecurityManager

rmiPort

RMIConnector port on which the FioranoMQ server JMX connection is to be created. This value should be specified only if the connector type is RMI.

1858(Default value), 2059 is default value for Repeater

Example:

The commands below stop the FioranoMQ server running on a FMQWIN01 machine on default port 1856 by entering user as admin and password as passwd.

No securityManager or securityProtocol is required in this case and both are set as null. This script creates an RMIBasedJMXConnector since theconnector 'type' is not specified.

Icon

If a user has configured the FioranoMQ server to accept JMSBasedJMXConnector connections, shutting down the FioranoMQ server is possible only by using this connector. Otherwise, by default, the RMIBasedJMXConnector will be used.

Scripts present under %fiorano_installation_dir %\fmq\bin\service

install-fmq-service.bat

This script launches the FioranoMQ server as an NT service. This script can be used where the FioranoMQ sever needs to start along with the system services.

Usage: install-fmq-service.bat -profile %PROFILE_NAME%

Example:install-fmq-service.bat -profile FioranoMQ_XA

FioranoMQ, when started as an NT Service, by default, takes on the FioranoMQ profile.

uninstall-fmq-service.bat

This script is used to remove the entry made in the registry of the system after install-fmq-service.bat has installed a serviceto start the FioranoMQ Server.

Usage: uninstall-fmq-service.bat -profile %PROFILE_NAME%

Example: uninstall-fmq-service.bat -profile FioranoMQ_XA

FioranoMQ, when started as an NT Service, by default, takes on the FioranoMQ profile.

Scripts present under <fiorano_installation_dir>\fmq\clients\c\crosscomp\scripts

build_samples.bat

This script is used for compiling all the C Cross Comp samples present under %fiorano_installation_dir %\fmq\clients\c\crosscomp\samples.

Usage: build_samples.bat.

cclientbuild.bat:

This script is used for compiling C Cross Comp samples one at a time.

Usage: cclientbuild.bat ..\samples\<sample_type>\<sampleName>.c

Scripts present under <fiorano_installation_dir>\fmq\clients\c\native\scripts

build_samples.bat

This script is used for compiling all the C Native samples present under %fiorano_installation_dir %\fmq\clients\c\native\samples

Usage: build_samples.bat

cclientbuild.bat

This script is used to compile the C Native samples one at a time.

Usage: cclientbuild.bat ..\samples\<sample_type>\<sampleName>.c

Scripts present under <fiorano_installation_dir>\fmq\clients\cpp\jni\scripts

build_samples.bat

This script is used for compiling all the Cpp JNI samples present under %fiorano_installation_dir %\fmq\clients\cpp\jni\samples.

Usage: build_samples.bat.

cppclientbuild.bat:

This script is used for compiling the Cpp JNI samples, one at a time, using fmq-jni-cpprtl.lib.

Usage: cppclientbuild.bat ..\samples\<sample_type>\<sampleName>.cpp

cppclientbuildcc.bat:

This script is used for compiling the Cpp JNI samples, one at a time, using fmq-crosscomp-cpprtl.lib.

Usage: cppclientbuildcc.bat ..\samples\<sample_type>\<sampleName>.cpp

Scripts present under %fiorano_installation_dir %\fmq\clients\cpp\native\scripts

build_samples.bat

This script is used for compiling all the Cpp Native samples present under %fiorano_installation_dir %\fmq\clients\cpp\native\samples.

Usage: build_samples.bat.

cppclientbuild.bat

This script is used to compile the Cpp Native samples one at a time.

Usage: cppclientbuild.bat ..\samples\<sample_type>\<sampleName>.cpp

Scripts present under %fiorano_installation_dir %\fmq\clients\csharp\scripts

build_samples.bat

This script is used for compiling all the unmanaged C# samples present under %fiorano_installation_dir %\fmq\clients\csharp\samples.

Usage: build_samples.bat

csclientbuild.bat

This script is used to compile the unmanaged C# samples one at a time.

Usage: csclientbuild.bat ..\samples\<sample_type>\<sampleName>.cs

ginstall.bat

This script is used to install the fmq-native-cpprtl.dll, fmq-native-cpprtl-https.dll, fmq-csharprtl.dll and fmq-csharprtl-https.dll dll files into the system assembly using gacutil.exe which is shipped with the DOT NET Installation.

Usage: ginstall.bat

vbclientbuild.bat:

This script is used for compiling the unmanaged VB samples one at a time.

Usage: csclientbuild.bat ..\samples\<sample_type>\<sampleName>.vb

Scripts present under %fiorano_installation_dir %\fmq\clients\nativecsharp\scripts

build_samples.bat

This script is used for compiling all the C# Native samples present under %fiorano_installation_dir %\fmq\clients\csharp\samples.

Usage: build_samples.bat

cppclientbuild.bat

This script is used to compile the C# Native samples one at a time.

Usage: csclientbuild.bat ..\samples\<sample_type>\<sampleName>.cs

Scripts present under <fiorano_installation_dir>\fmq\terminal

fmq-terminal.bat

This script is used for performing admin operations through the Studio. The list of operation supported by fmq-terminal are:

Usage: fmq-terminal.sh. The username and password are queried for logging onto the server.

Icon
  • help command lists all the commands/operations supported by the terminal
  • <command/operation> -help displays usage of the command or operation

The list of operations supported by fmq-terminal follows:

Operation

Description

addMemberToGroup

adds a member to a Group

bye

exits the console

changePwd

changes password for the specified User

clearQueue

clears messages in the Queue specifed

createACF

creates the specified AdminConnectionFactory

createCommonCF

creates the specified CommonConnectionFactory

createGroup

Creates the Group specified

createQCF

creates the specified QueueConnectionFactory

createQueue

creates the Queue specified Queue

createTCF

creates specified TopicConnectionFactory

createTopic

creates the Topic specified

createUser

creates new User and a new Password

createXAQCF

Creates the specified XAQueueConnectionFactory

createXATCF

creates the specified XATopicConnectionFactory

deleteACF

deletes the specified AdminConnectionFactory

deleteCommonCF

deletes the specified CommonConnectionFactory

deleteGroup

deletes the Group specified

deleteQCF

deletes the specified QueueConnectionFactory

deleteQueue

deletes the specified Queue

deleteTCF

deletes the specified TopicConnectionFactory

deleteTopic

deletes the Topic specified

deleteUser

deletes a specified User

deleteXAQCF

deletes the specified XAQueueConnectionFactory

deleteXATCF

deletes the specified XATopicConnectionFactory

exit

exits the console

help

prints the 'help' topic/instructions for all available commands

list

lists all available commands

listACFs

lists names of all available Admin Connection Factories

listClientIDs

lists names of all Client IDs

listCommonCFs

lists names of all available Common Connection Factories

listDomains

Lists all domains

listGroups

lists all server groups

listQCFs

lists names of all available QueueConnectionFactories

listQueues

lists names of all available Queues

listSubscriberIDs

lists SubscribterIDs of specified ClientIDs

listTCFs

lists names of all available TopicConnectionFactories

listTopics

lists names of all available Topics

listUsers

lists all Users of the server

listXAQCFs

lists names of all available XAQueueConnectionFactories

listXATCFs

lists names of all available XATopicConnectionFactories

mbeanCount

prints mbeans count

quit

exits the console

restartFMQ

restarts FioranoMQ server running in the relevant Fiorano Container

run

runs specific commands in the specified file

serverInfo

prints the server information

shutdownFMQ

Shuts down the FioranoMQ server running in the relevant Fiorano Container

shutdownJBoss

Shuts down the FioranoMQ server running on the JBoss Container

Scripts present under <fiorano_installation_dir>\framework\tools\LicenseManager\bin

runLM.bat

This script is used to run the license manager. For more information on the license manager, refer to Fiorano SOAPlatform License Manager Guide available at: <fiorano_installation_dir>\framework\tools\LicenseManager\doc.

Scripts present under <fiorano_installation_dir>\Studio\bin

InputMethodHotKey

This script is used for configuring the InputMethod HotKey that invokes the keyboard panel to insert international characters (Japanese, Chinese, etc.).

Log.bat

This script opens the log file that stores all logs.

Usage: Log.bat

Reset.bat

This script is used to reset all Studio logs and the Studio settings

Usage: Reset.bat

UserDir.bat

This script opens the Windows Explorer at the same location as the Studio log file.

Usage: UserDir.bat

Adaptavist ThemeBuilder EngineAtlassian Confluence