Using the Broker Command Service with SMH

This document covers the following topics:

Connecting/Disconnecting Persistent Store
Allowing and Forbidding new UOW Messages
Setting a Broker Instance's Trace Level
Flushing a Broker Instance's Trace Buffer
Flushing a Broker Instance's Trace Buffer on Error
Producing Statistics of a Broker Instance
Setting the Persistent Store Trace Level
Setting the Security Trace Level
Deregistering a Server
Deregistering a Service
Purging Unit(s) of Work
Subscribing a User
Unsubscribing a User
Logging Off a Subscriber
Logging Off a Publisher
Enabling/Disabling Cmdlog
Switching Cmdlog
Adding Cmdlog Filter
Enabling/Disabling Cmdlog Filter
Deleting Cmdlog Filter

Connecting/Disconnecting Persistent Store

To connect or disconnect a Persistent Store

Select the EntireX Broker node below the EntireX node in System Management.
Select the broker instance to be administered.
To connect a persistent store, select Connect PStore.
To disconnect a persistent store, select Disconnect PStore.

As a result, a confirmation screen will appear.
Choose OK or Cancel.

Allowing and Forbidding new UOW Messages

To allow or forbid a Broker instance to accept new unit-of-work messages

Select the EntireX Broker node below the EntireX node in System Management.
Select the broker instance to be administered.
To allow new unit-of-work messages, select Allow new UOW MSGs.
To forbid new unit-of-work messages, select Forbid new UOW MSGs.

As a result, a confirmation screen will appear.
Choose OK or Cancel.

Setting a Broker Instance's Trace Level

To set a broker instance's trace level

Select the EntireX Broker node below the EntireX node in System Management.
Select the broker instance to be administered.
Choose Trace Settings.
Select a Trace Level between 1 and 4 or off.
Choose OK.

Flushing a Broker Instance's Trace Buffer

To flush a broker instance's trace buffer

Select the EntireX Broker node below the EntireX node in System Management.
Select the broker instance to be administered.
Choose Trace Settings.
Trace Level must be between 1 and 4. Press Flush to confirm.

Flushing a Broker Instance's Trace Buffer on Error

To flush a broker instance's trace buffer

Select the EntireX Broker node below the EntireX node in System Management.
Select the broker instance to be administered.
Choose Trace Settings.
Trace Level must be between 1 and 4. Enter a number between 1 and 9999 in the Error Number field and press Flush on Error.

Producing Statistics of a Broker Instance

To produce statistics of a broker instance

Select the EntireX Broker node below the EntireX node in System Management.
Select the broker instance to be administered.
Choose Trace Settings.
Trace Level must be between 1 and 4. Press Produce Statistics.

Setting the Persistent Store Trace Level

To set the persistent store trace level

Select the EntireX Broker node below the EntireX node in System Management.
Select the broker instance to be administered.
Select a subnode of Persistent Store (either Persistent Store ADA or Persistent Store CTree).
Choose Set Trace Level.
Select a Trace Level between 1 and 4 or off.
Choose OK.

Setting the Security Trace Level

To set the security trace level

Select the EntireX Broker node below the EntireX node in System Management.
Select the broker instance to be administered.
Select Security.
Set the security trace level by selecting a value between 1 and 4 in the Set the Trace Level box.
Choose OK.

Deregistering a Server

To deregister a server

Select the EntireX Broker node below the EntireX node in System Management.
Select the broker instance on which the server is running.
Select the Server node to display a summary list of servers.
From the column Deregister Server, choose icon Shut Down Server.
Choose the deregistration mode.

For deregister immediately, a server process will only be terminated if the server status is wait.
Confirm the deregistration by choosing OK.

Deregistering a Service

To deregister a service

Select the EntireX Broker node below the EntireX node in System Management.
Select the broker instance on which the server is running.
Select the Service node to display a summary list of servers.
From the column Deregister Service, choose icon Deregister Service.
Choose the deregistration mode.
Confirm the deregistration by choosing OK.

Purging Unit(s) of Work

To purge a unit of work

Select the EntireX Broker node below the EntireX node in System Management.
Select the broker instance on which the unit of work is present.
Select the Persistent Store node to display a summary list of units of work.

Note:
A message box will pop up if the table is larger than 3,000 rows. You may prefer to apply a filter to your UOW table. See the filter command in the command menu. It might take several minutes to display all of the contents if you choose not to use the filter.
Choose Purge.
Choose OK.

To purge all units of work

Select the EntireX Broker node below the EntireX node in System Management.
Select the broker instance on which the units of work are present.
Select the Persistent Store node to display a summary list of units of work.

Note:
A message box will pop up if the table is larger than 3,000 rows. You may prefer to apply a filter to your UOW table. See the filter command in the command menu. It might take several minutes to display all of the contents if you choose not to use the filter.
Choose Purge All UOWs at the bottom of the table. A confirmation message will appear.
Choose OK or Cancel.

All units of work will be purged. The number of purged UOWs is reported in a screen similar to the one below.

graphics/brokerSmh-etbcmd_purgeUow3.png

Subscribing a User

To subscribe a user

Select the EntireX Broker node below the EntireX node in System Management.
Select the Broker instance on which the topic (or subscriber) is present.

Note:
Pub/Sub must be enabled in the Broker attribute file, a license file for Pub/Sub must be installed, and the Broker must be running in order to display the topic (or subscriber).
Select Topic (or Subscriber).
From the context menu, choose Subscribe.
If you are on the Topic node, enter the data for User ID and Token; if you are on the Subscriber node, specify the topic that you would like to subscribe to.
Choose OK.

Unsubscribing a User

To unsubscribe a user

Select the EntireX Broker node below the EntireX node in System Management.
Select the Broker instance on which the topic (or subscriber) is present.

Note:
Pub/Sub must be enabled in the Broker attribute file, a license file for Pub/Sub must be installed, and the Broker must be running in order to display the topic (or subscriber).
Select Topic (or Subscriber).
From the context menu, choose Unsubscribe.
If you are on the Topic node, enter the data for User ID and Token; if you are on the Subscriber node, specify the topic that you would like to unsubscribe from.
Choose OK.

Logging Off a Subscriber

To log off a subscriber

Select the EntireX Broker node below the EntireX node in System Management.
Select the Broker instance on which the subscriber is present.

Note:
Pub/Sub must be enabled in the Broker attribute file, a license file for Pub/Sub must be installed, the Broker must be running, and a user must be subscribed to a topic in order to display the data for the subscriber.
Select Subscriber.
From the context menu, choose Logoff.
Choose the logoff mode.
Choose OK.

Logging Off a Publisher

To log off a publisher

Select the EntireX Broker node below the EntireX node in System Management.
Select the broker instance on which the Publisher is present.

Note:
Pub/Sub must be enabled in the broker attribute file, a license file for Pub/Sub must be installed, the broker must be running, and a user must be published from a topic in order to display the data for the Publisher.
Select Publisher.
Choose Logoff.
Choose the logoff mode.
Choose OK.
After a Publisher is shut down successfully, it will be removed from the list.

Enabling/Disabling Cmdlog

To enable/disable cmdlog

Select the EntireX Broker node below the EntireX node in System Management.
Select the broker instance on which the Cmdlog filter is present. Cmdlog must be enabled in the broker attribute file and the broker must be running.
From the context menu, choose Cmdlog Filter.
Choose Enable Cmdlog or Disable Cmdlog.

Switching Cmdlog

To switch cmdlog

Select the EntireX Broker node below the EntireX node in System Management.
Select the broker instance on which the Cmdlog filter is present. Cmdlog must be enabled in the broker attribute file and the broker must be running.
From the context menu, choose Cmdlog Filter.
Choose Switch Cmdlog.

Adding Cmdlog Filter

To add a cmdlog filter

Select the EntireX Broker node below the EntireX node in System Management.
Select the broker instance on which the Cmdlog filter is present. Cmdlog must be enabled in the broker attribute file and the broker must be running.
From the context menu, choose Cmdlog Filter.
Choose Add Cmdlog Filter.
Enter the data for user ID and Class/Server/Service or Topic you would like to filter.
Choose OK to add a Cmdlog filter to the list.

Enabling/Disabling Cmdlog Filter

To enable/disable a cmdlog filter

Select the EntireX Broker node below the EntireX node in System Management.
Select the broker instance on which the Cmdlog filter is present. Cmdlog must be enabled in the broker attribute file and the broker must be running.
From the context menu, choose Cmdlog Filter.
Choose Enable Cmdlog Filter or Disable Cmdlog Filter.

Deleting Cmdlog Filter

To delete a cmdlog filter

Select the EntireX Broker node below the EntireX node in System Management.
Select the broker instance on which the Cmdlog filter is present. Cmdlog must be enabled in the broker attribute file and the broker must be running.
From the context menu, choose Cmdlog Filter.
Choose Delete Cmdlog Filter to remove a Cmdlog filter from the list.