Administering EntireX Broker using the Command Central Graphical User Interface

This document covers the following topics:

Logging on to Command Central

Open an Internet browser and specify the URL of the Command Central Server as follows: http://<Command_Central_host>:<Command_Central_port>. This takes you to the Command Central Login page.

On Windows you can also get to the Login page from the Command Central Start Menu entry.

Provide your user credentials in the Login page and click Log In. This takes you to the page Home > Instances:

graphics/gui_logon.png

Adding a Broker Instance

Start of instruction setTo add a Broker

  1. In the Command Central Home page, click the Installations tab.

    graphics/gui_addBroker-1.png

  2. Click on the desired installation, for example Local, for which you want to add a Broker instance:

    graphics/gui_addBroker-2.png

  3. Click the Instances tab.

    graphics/gui_addBroker-3.png

  4. Click the graphics/gui_plus.png button in the upper right corner above the list and choose EntireX Broker.

    graphics/gui_addBroker-4.png

  5. Specify the desired properties and press Next.

    graphics/gui_addBroker-5.png

  6. Press Finish.

    graphics/gui_addBroker-6.png

  7. Press Finish.

    graphics/gui_addBroker-7.png

    The new instance MyNewBroker appears in the list.

Deleting a Broker Instance

Start of instruction setTo delete a Broker instance

  1. In the list of EntireX Broker instances for your selected installation (for example Local), select the instance you want to delete and click the graphics/gui_minus.png button in the upper right corner above the list:

    graphics/gui_deleteBroker.png

  2. Click OK to confirm the uninstall of this Broker instance.

  3. In the next window, click Finish. The selected instance is removed from the list.

Viewing the Runtime Status of a Broker Instance

Start of instruction setTo view the runtime status of a Broker instance

  1. In the Command Central Home page, click the Instances tab and select the Broker instance for which you want to see the runtime status:

    graphics/gui_viewStatus-1.png

  2. Click on the link associated with this instance:

    graphics/gui_viewStatus-2.png

  3. The visual key performance indicators (KPIs) and alerts enable you to monitor EntireX Broker's health. The following KPIs help you administer, troubleshoot, and resolve performance issues in EntireX Broker:

    KPI Description
    Clients Number of active clients.
    Servers Number of active servers.
    Conversations Number of active conversations.

Configuring a Broker Instance

Start of instruction setTo configure a Broker instance

  1. In the Command Central Home page, click the Instances tab then click the link associated with the Broker instance you want to configure. This takes you to the following page:

    graphics/gui_common-1.png

  2. If you want to monitor a secure Broker, add user name and password under Authentication.

    graphics/gui_config-auth.png

  3. Click the Configuration tab. EntireX currently supports the following configuration types, which are presented in a drop-down box when you click the down arrow below the Configuration tab label:

    • Application Monitoring

    • Attribute File

    • Autostart

    • Monitoring KPIs

    • Persistent Store

    • Ports

    • Security

    • Trace Level

  4. Select the configuration type for which you want to inspect or change the current values, for example Persistent Store:

    graphics/gui_config-2.png

  5. With this example, the Persistent Store screen is called:

    graphics/gui_config-3.png

  6. Click the respective hyperlink to open the Configuration page, where you can view or edit the parameters associated with the respective configuration type.

    graphics/gui_config-4.png

  7. Click Edit to modify the parameters.

  8. Click Test to check the correctness of your input or Save to save your changes.

    graphics/gui_config-5.png

    Note:
    Configuration of all other entities is similar, but the screens are different depending on the configuration parameters.

Inspecting the Log Files of a Broker Instance

Start of instruction setTo inspect the log files of a Broker instance

  1. In the Command Central Home page, click the Instances tab then click the link associated with the Broker instance for which you want to inspect the log files. This takes you to the following page:

    graphics/gui_common-1.png

  2. Click the Logs tab:

    graphics/gui_log-2.png

  3. In the Alias column, click the link of the log file you want to inspect, for example ETB001.log:

    graphics/gui_log-3.png

    Here you can search for certain text and highlight or filter the matching lines, specify how many first or last lines of the log you would like to see. You can also download the whole file.

Displaying Services Registered with a Broker Instance

Start of instruction setTo display services registered with a Broker instance

  1. In the Command Central Home page, click the Instances tab, then click the link associated with the Broker instance for which you want to see its registered services. This following page appears:

    graphics/gui_common-1.png

  2. Click on the Administration tab:

    graphics/gui_displayService-2.png

Stopping a Service

Start of instruction setTo stop a service

  1. Select the service you want to stop and click the graphics/gui_minus.png button in the upper right corner above the list:

    graphics/gui_stopService.png

  2. Press OK to confirm. The selected service is removed from the list of currently running services.

Displaying Server Instances of a Service

Start of instruction setTo display server instances of a service

  • In the Class/Server/Service column of the Services table, click the link of the service for which you want to see the associated server instances:

    graphics/gui_displayServer.png

    The Start Time is displayed in the time zone of the Broker instance in sortable ISO-format.

Stopping a Server Instance

Start of instruction setTo stop a server instance

  1. Select the server instance you want to stop and click the graphics/gui_minus.png button in the upper right corner above the list:

    graphics/gui_stopServer-1.png

  2. Press OK to confirm. The selected server is removed from the list of server instances.

    graphics/gui_stopServer-2.png