Broker 10.5 | webMethods Broker Documentation | Administering webMethods Broker | Managing Clients | Viewing Clients on a Broker
 
Viewing Clients on a Broker
Using My webMethods, you can view a list of the clients on a Broker. You can display all the clients or you can filter the list of clients to see only those that meet specific criteria. For example, you might want to view only those clients belonging to a particular client group.
Use an advanced search to search for specific clients by specifying detailed criteria. You perform the advanced search based on application name, category, client group, connection status, number of documents queued, and/or date of the last document retrieved.
Note:
Clients with lifecycles of destroy on disconnect only appear on the Client List if an active session exists for that client.
*To view clients on a Broker
1. In My webMethods: Administration > Messaging > Broker Server s > Clients.
2. To perform a keyword search, do the following:
a. In the Keywords text box on the Keyword tab, type the keywords contained in the client ID that you want to find. For example, you might specify:
*The complete client ID.
*A portion of the client ID to locate all the client IDs that contain the provided text.
If you leave the text box blank, My webMethods searches for all the clients on the specified Broker.
b. Select the Broker Server and Broker whose clients you want to view by doing the following:
Field
Description
Server Name
Fully-qualified name of the Broker Server: hostname:port
If the Broker Server has the default port of 6849, only the Broker Server hostname will appear.
Broker Name
Name of the Broker as defined on the Broker Server.
3. To perform an advanced search, click the Advanced tab and do the following:
a. Select the Broker Server and Broker whose clients you want to view by doing the following:
Field
Description
Server Name
Fully-qualified name of the Broker Server: hostname:port
Broker Name
Name of the Broker as defined on the Broker Server.
b. In the Filter panel, specify at least one filter. Select the field name, operator, and the value for the filter criteria.
Field Name
Operator
Value
Application Name
*Equal To
Type the application name of the client you would like to search.
Category
*Equal To
*Durable Subscriber
*Queue
*Test Client
Client Group
*Equal To
Select a client group from the list of defined client groups on the Broker.
Connection Status
*Equal To
*Connected
*Not Connected
Number of Documents Queued
*Equal To
*Greater Than
*Less Than
Type a number to specify the document queue length of the client.
Last Document Retrieved
*After
*Before
*Never
Specify the date and time to check when the last document was retrieved from the client queue.
c. To add a new filter click Add. To remove a filter, click Delete corresponding to the filter you want to delete.
4. Select the search condition from the Search Condition list.
5. Click Search. My webMethods displays the search results in the Client List.
The following table describes the contents of the Client List.
Field
Description
Indicates the connection status of the client as follows:
* The client is connected to the Broker Server.
* The client is not connected to the Broker Server.
Displays if the client queue is locked. For information about locking or unlocking a client queue, see Locking a Client Queue and Unlocking a Client Queue.
Client ID
A unique identifier for the client. When creating a client, you can specify a client ID or allow the Broker to generate a unique ID.
Application Name
Name of the application that created the client. The application name can be any string of characters and is specified when the client is created.
Client Group
Name of the client group to which the client belongs. The client group determines client properties such as storage type, lifecycle, and the document types that a client can publish or subscribe to. For more information about client groups, see Managing Client Groups.
SSL Sessions
Indicates the number of sessions using SSL if an SSL connection is established between the client program and the Broker.
Docs Queued
Indicates the number of documents available for delivery in the client queue. For more information about managing the documents in a client queue, see Managing Client Queues.
Last Retrieved
Indicates the date and time when the last document was retrieved from the client queue. Displays Never if no documents were retrieved from the client queue.
Note:
To view an updated list of clients, click Search.