Getting Started

After installation, you can quickly verify your MSGMX installation by performing the following tasks.

Environment Settings

Set the KAFKA_HOME environment variable so that it contains the directory in which Apache Kafka was installed.

Linux example: 

export KAFKA_HOME=/opt/tibco/akd/core/<version_number>

Windows example (restart the command prompt after setting): 

set KAFKA_HOME="C:\tibco\akd\core\<version_number>"

Python Virtual Environment

The Python virtual environment (VENV) isolates the Python dependencies of MSGMX from other globally installed Python packages that may exist on the host computer. The Python virtual environment is created (if needed) and used by default when you run MSGMX.

To run MSGMX without creating or using a Python virtual environment, execute the msgmx script with the --no-ve option.

Starting MSGMX

Perform the following steps:

  1. Confirm you have Apache Kafka Distribution installed and are running at least one Apache Kafka Broker and one Apache ZooKeeper.
  2. In a local command window, change directories to the directory containing the MSGMX executable file. For example:
    Default Unix location : 
    cd /opt/tibco/msgmx/1.0/bin
    Default Windows Location: 
    cd C:\tibco\msgmx\1.0\bin
  3. Launch the MSGMX program using the msgmx command.

    When running MSGMX for the first time, MSGMX creates a Python virtual environment in your home directory (.tibco-msgmx/venv-v100) and you see a series of messages starting with: 

    Python Virtual Environment not found.
Creating Virtual Environment...
  4. At the MSGMX prompt, initiate a connection to an Apache Kafka broker using the connect command:. 
    connect bootstrap-server localhost:9092
    Note: 9092 is the default port for Apache Kafka brokers; be sure to specify a host and port that is appropriate for your running Apache Kafka broker.

    When the connection is established, the MSGMX prompt changes to include the host and port of the bootstrap server you just connected to. Verify that the prompt changes, indicating that a connection has been established.

    If MSGMX cannot connect using the information you provided, it displays an error message. Ensure that the target server is running and is accessible at the specified host and port.

  5. As a test command, enter: 
    list topics

    You see a listing of configured topics (or a blank line if no topics are configured). Confirm that no error messages are displayed.

  6. Exit MSGMX by using the exit command.