Getting Started

TIBCO® Messaging Manager (MSGMX) 3.0.0 can be used to manage the TIBCO Enterprise Message Service (EMS) release version 10.1.0 or later. Using MSGMX EMS commands, you can manage a live EMS server end to end with advanced autocompletion features at the command line.

Before using MSGMX to manage EMS, review the following information and refer to the Enterprise Message Service documentation, User's Guide.

Requirements

To run MSGMX EMS commands, your systems need to meet the following requirements:

You need EMS 10.1.0 or later installed and accessible from the MSGMX server. See the Enterprise Message Service documentation, Installation Guide.
Java must be 1.8.0_311 or later.

Convert .conf Files to JSON Configuration File

The EMS server stores its configuration either in a set of text-based .conf files or a single JSON configuration file. MSGMX requires that the EMS server uses a JSON configuration file. You must convert classic server configuration files to JSON. For steps, see the Enterprise Message Service documentation, User's Guide, "Conversion of Server Configuration Files to JSON" section.

Important: MSGMX checks to ensure the EMS server uses a JSON-based configuration. If it does not, the connection fails and responds with an error message: The server is not using JSON configuration and cannot be managed by MSGMX.

Set the Environment Settings

You must set the EMS_HOME environment variable before proceeding.

EMS_HOME=ems installation dir;

Linux and macOS example:

export EMS_HOME=/opt/tibco/ems/10.1

Windows example:

set EMS_HOME=C:\tibco\ems\10.1

Starting MSGMX to Manage EMS

Perform the following steps:

Confirm you have EMS installed and running and that can EMS be accessed via MSGMX. This server does not need to be running on the system you installed MSGMX on, but this server must be accessible from the MSGMX server. At a minimum, install the C & .NET Clients and Third Party Libraries components of the EMS installer. See the Enterprise Message Service documentation, Installation Guide for details.
In a local command window, either add the directory containing the MSGMX executable file to your PATH or change into the directory containing the executable. For example:
Unix:
```
export PATH=$PATH:/opt/tibco/msgmx/bin
```
or
```
cd /opt/tibco/msgmx/bin
```
Windows:
You can add the path MSGMX executables using either the system tool to add environment variables or directly on the command line like this:
```
set PATH=%PATH%;c:\tibco\msgmx\bin
```
or
```
cd C:\tibco\msgmx\bin
```
Launch the MSGMX component using the msgmx command.
Linux and macOS example:
```
./msgmx 
```
Windows:
```
msgmx.bat 
```
Use the MSGMX manage command to select the component to manage. For example, to manage EMS:
```
manage ems
```
At the MSGMX prompt, initiate a connection to an EMS server using the connect command from the current host:
```
connect tcp://localhost:7222 username password
```
If MSGMX cannot connect using the information you provided, the following error message displays:
```
Unable to connect to the server.
```
On successful connection, the following message displays:
```
Connected as <username>
```
Ensure that the target EMS server is running and is accessible at the specified host and port.

As a test command, enter the info command:

info

The output displays information similar to the following:

Server:                   EMS-SERVER (version: 10.1.0 V4)
 Hostname:                 MacBook-Pro.local
 Process Id:               41706
 State:                    active
 Runtime Module Path:      /opt/tibco/ems/10.1/bin/lib:/opt/tibco/ems/10.1/lib
 Topics:                   3 (2 dynamic, 0 temporary)
 Queues:                   11 (0 dynamic, 5 temporary)
 Client Connections:       0
 Admin Connections:        5
 Sessions:                 5
 Producers:                5
 Consumers:                5
 Durables:                 7
 Pending Messages:         0
 Pending Message Size:     0.0 Kb
 Message Memory Usage:     58.4 Kb out of 512MB
 Message Memory Pooled:    59.0 Kb
 Synchronous Storage:      2.0 Kb
 Asynchronous Storage:     9.5 Kb
 Fsync for Sync Storage:   disabled
 Inbound Message Rate:     0 msgs/sec,  0.1 Kb per second
 Outbound Message Rate:    0 msgs/sec,  0.8 Kb per second
 Storage Read Rate:        0 reads/sec,  0.0 Kb per second
 Storage Write Rate:       0 writes/sec, 0.0 Kb per second
 Uptime:                   4 days 9 hours 18 minutes

Also see the connect and disconnect commands.

Bottom Status Bar

The bottom status bar provides information about the currently managed server.

1: Server ID, server state, server uptime

2: Server ID, number of client connections, number of admin connections

3: Server ID, pending message size, message memory usage

To cycle through the different status bar displays, press F1.

The status bar display automatically refreshes periodically, but you can refresh the live status display at any time by pressing F5. (The frequency of the status updates can be configured via the msgmx command covered in Messaging Manger, User's Guide.)