Using the Broker Information Service with SMH

This document covers the following topics:


Administering a Broker Instance

Start of instruction setTo administer a broker instance

  1. Select the EntireX Broker node below the EntireX node in System Management.

  2. Select the broker instance to be administered.

  3. If the broker instance is a remote broker instance (running on another node), see Setting the User Credentials for a Broker Instance.

  4. Expand the broker instance node to view and administer the properties for the following objects:

    Object Information Reply Structure Summary View Filter Results
    Broker BROKER-OBJECT    
    Worker WORKER-OBJECT    
    Service SERVICE-OBJECT x x
    Server CLIENT-SERVER-PARTICIPANT-OBJECT x x
    Client CLIENT-SERVER-PARTICIPANT-OBJECT x x
    Participant CLIENT-SERVER-PARTICIPANT-OBJECT x  
    Conversation CONVERSATION-OBJECT x  
    Persistent Store PSF-OBJECT x x
    Persistent Store DIV PSFDIV-OBJECT    
    Persistent Store Adabas PSFADA-OBJECT    
    Persistent Store File PSFFILE-OBJECT    
    Persistent Store c-tree PSFCTREE-OBJECT    
    Topic TOPIC-OBJECT   x
    Subscriber SUBSCRIBER-OBJECT x x
    Publisher PUBLISHER-OBJECT x x
    Publication PUBLICATION-OBJECT   x
    Cmdlog Filter CMDLOG_FILTER-OBJECT    
    Security SECURITY-OBJECT    
    TCP TCP-OBJECT    
    SSL SSL-OBJECT    
    Net-Work NET-OBJECT    
    Pool-Usage POOL-USAGE-OBJECT    
    Resource-Usage RESOURCE-USAGE-OBJECT    
    Statistics STATISTICS-OBJECT    
    User USER-OBJECT x x
    Worker-Usage WORKER-USAGE-OBJECT    

Notes

  • For a summary view, expand the node and select the required object:

    administer broker instance

  • For detailed information, select an item from the summary view:

    graphics/brokerSmh-etbinfo_instance-detailed.png

  • The items can be filtered. For an example, see Filtering Services.

administer broker instance

Filtering Clients

Start of instruction setTo filter clients

  1. Select the EntireX Broker node below the EntireX node in System Management.

  2. Click on the "+" sign of the broker name to be administered.

    Note:
    The broker must be running in order to display the Client subtree.

  3. Select Client.

  4. From the context menu, choose Filter.

  5. Enter the data for UserID or Token that you would like to filter.

  6. Choose OK.

Filtering Conversations

Start of instruction setTo filter conversations

  1. Select the EntireX Broker node below the EntireX node in System Management.

  2. Click on the "+" sign of the broker name to be administered.

    Note:
    The broker must be running in order to display the Client subtree.

  3. Select Conversation.

  4. From the context menu, choose Filter.

  5. Enter the data for UserID or Token that you would like to filter.

  6. Choose OK.

Filtering the User

Start of instruction setTo filter the user

  1. Select the EntireX Broker node below the EntireX node in System Management.

  2. Select the Broker instance on which the user is present.

    Note:
    The broker must be running in order to display the User subtree.

  3. Select the user.

  4. From the context menu, choose Filter.

  5. Enter the data for User ID and Token that you would like to filter.

  6. Choose OK.

graphics/brokerSmh-etbinfo_filterUser.png

Filtering Participants

Start of instruction setTo filter participants

  1. Select the EntireX Broker node below the EntireX node in System Management.

  2. Click on the "+" sign of the broker name to be administered.

    Note:
    The broker must be running in order to display the Client subtree.

  3. Select Participant.

  4. From the context menu, choose Filter.

  5. Enter the data for UserID or Token that you would like to filter.

  6. Choose OK.

Filtering the Persistent Store

Start of instruction setTo filter the persistent store

  1. Select the EntireX Broker node below the EntireX node in System Management.

  2. Select the broker instance on which the unit of work is present. The persistent store attributes (such as PSTORE, PSTORE-TYPE, STORE, DEFERRED, and UWSTATP etc.) must be configured and the broker must be running in order to display the Persistent Store.

  3. 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.

  4. Choose Filter.

  5. Click the check boxes for Received, Accepted, Delivered, Backed Out, Processed, Cancelled, Timed Out or Discarded that you would like to filter.

  6. Choose OK.

    filter persistent store

Filtering the Publication

Start of instruction setTo filter the publication

  1. Select the EntireX Broker node below the EntireX node in System Management.

  2. Select the Broker instance on which the publication 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 for a topic in order to display the data for the publication.

  3. Select Publication.

  4. From the context menu, choose Filter.

  5. Enter the data for Topic, User ID or Token and Publication ID.

  6. Choose OK.

    filter for publication

Filtering the Publisher

Start of instruction setTo filter the publisher

  1. Select the EntireX Broker node below the EntireX node in System Management.

  2. 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 for a topic in order to display the data for the publisher.

  3. Select Publisher.

  4. From the context menu, choose Filter.

  5. Enter the data for User ID and Token that you would like to filter.

  6. Choose OK.

    filter for publisher

Filtering Servers

Start of instruction setTo filter servers

  1. Select the EntireX Broker node below the EntireX node in System Management.

  2. Click on the "+" sign of the broker name to be administered.

    Note:
    The broker must be running in order to display the Server subtree.

  3. Select Server.

  4. From the context menu, choose Filter.

  5. Enter the data for UserID,Token,Server Class,Server Name or Service.

  6. Choose OK.

Filtering Services

Start of instruction setTo filter services

  1. Select the EntireX Broker node below the EntireX node in System Management.

  2. Click on the "+" sign of the broker name to be administered.

    Note:
    The broker must be running in order to display the Service subtree.

  3. Select Service.

  4. From the context menu, choose Filter.

  5. Enter the data for Server Class, Server Name and Service.

  6. Choose OK.

Filtering the Subscriber

Start of instruction setTo filter the subscriber

  1. Select the EntireX Broker node below the EntireX node in System Management.

  2. 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.

  3. Select Subscriber.

  4. From the context menu, choose Filter.

  5. Enter the data for Topic, User ID, Token; select Subscription Type, Active Subscriber and Swapped Out that you would like to filter.

  6. Choose OK.

    filter for subscriber

Filtering the Topic

Start of instruction setTo filter the topic

  1. Select the EntireX Broker node below the EntireX node in System Management.

  2. Select the Broker instance on which the topic 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 topic.

  3. Select Topic.

  4. From the context menu, choose Filter.

  5. Enter the data for the Topic that you would like to filter.

  6. Choose OK.

    filter for topic