- Overview
- WMT Views
- 1. Users
- 2. Groups
- 3. Topics
- 4. Queues
- 5. ConnectionFactories
- 6. Policies
- 7. Audit Manager
- 8. Routes
- 9. Dispatcher
- 10. DashBoard
- 11. DurableSubscriptions
- 12. Connections
- 13. Sockets
- 14. Logs
- 15. JMX
- 15. AdvancedProperties
- 16. HighAvailability
- 17. StandAloneBridge
- 18. StandAloneRepeater
- 19. Licenses
- 20. SystemProperties
Overview
Landing page and Tabular data
After logging into WMT Angular, the landing page is the MonitorUsers view.
All the tables present in all the views can be sorted in both ascending and descending order by clicking the corresponding column header.
Figure 1: WMT landing page - MonitorUsers View
Filtering
The Filter by option present on the upper-right part of the screen is used to filter the tabular data based on the filtering column selected in the menu and the following text entered in the filter text box..
Figure 2: Filter Options
Refreshing of data
All data present in the MonitorUsers view is refreshed automatically. The ConfigureUsers view, on the other hand, need to be refreshed manually. For refreshing 'configure' view click on any Configure view and click again on the old configure view. Only the ConfigureFMQServer view present in JMX will be refreshed automatically. There is an image next to it.
Data is fetched from the Server after every refresh interval. All tables get updated with the new values fetched. To stop refreshing this view, click the image and click the image to start refresh.
Server Shutdown notification
During interaction with the Server, if the Server shuts down due to unknown reasons, the WMT will display a warning displaying 'Disconnected from Server'. When this warning is displayed, the logout prompt will be replaced with login prompt.
Figure 3: Server Disconnected status
If the FioranoMQ server is running, click login to go directly to the previously viewed page. If the FioranoMQ server is not running, the page gets redirected to the login page.
If the server is restarted and the WMT did not interact with the server, then clicking on any operation reconnects to the server. To avoid/override this, click the same operation manually.
Common Configurations
Four links at the upper-right side of the page may be viewed:
SaveConfigurations | Saves all the modified properties to the FioranoMQ Server. |
|---|---|
Shutdown | Closes the Server that is running. Do not connect any other application to FioranoMQ server before 'shutdown'. |
Restart | Closes and restarts the Server. Do not connect any other application to FioranoMQ server before 'shutdown'. When the Server restarts, login from the browser window. |
Logout | Logs out the currently logged in user from the WMT application and redirects to the homepage. |
Status Information
The upper-right part of the screen displays information such as the name of the logged in user, the access mode, time and date of FioranoMQ Server startup, FioranoMQ product version number, build number, and the JVM version (indicates whether the server JVM is 32 or 64 bits). .
Figure 4: Status information
WMT Views
The different views present in the WMT are as follows:
- Overview
- WMT Views
- 1. Users
- 2. Groups
- 3. Topics
- 4. Queues
- 5. ConnectionFactories
- 6. Policies
- 7. Audit Manager
- 8. Routes
- 9. Dispatcher
- 10. DashBoard
- 11. DurableSubscriptions
- 12. Connections
- 13. Sockets
- 14. Logs
- 15. JMX
- 15. AdvancedProperties
- 16. HighAvailability
- 17. StandAloneBridge
- 18. StandAloneRepeater
- 19. Licenses
- 20. SystemProperties
1. Users
MonitorUsers
This view contains all existing users and their respective connection status. Users are set as connected if a JMX connection is made or if a JMS client is started. This view also gives information about the maximum connection limit that is set for each user and the current number of connections created by the user.
Figure 5: MonitorUsers view
ConfigureUsers
This view helps to modify users. In the Select Action drop-down menu, there are actions such as Add User, Delete Selected Users, Changing Password, set Maximum Connections per user, Import Users, and Export Users. To use any one of the actions, select the action from the Select Action drop-down menu and click the Go button.
The Import Users and Export Users operations help copying users to another FioranoMQ Server. Export operation allows exporting of all data to a standard file present on any machine (mapping needs to be done if the file is present on a different machine). The data can be imported to any other server that starts with FioranoMQ.
Figure 6: ConfigureUsers view
2. Groups
ConfigureGroups
This view contains information about all groups and its members. Groups can be added using Add Group and deleted using Delete Selected Groups. For modifying members of an existing group, use Edit Members in Group after selecting the required group. The above actions are available in the Select Action drop-down menu. Select the required action and click the Go button.
Figure 7: ConfigureGroups view
Upon clicking the Go button, a dialog box pops up with certain options. If the selected action is Edit Members in Group, select Add Members to see the existing members.
Figure 8: Editing Group Members
3. Topics
MonitorTopics
This view contains the information about existing topics with a summary displayed on the top of the table. The 'Active Topics' mentioned in the summary refers to a topic that contains either a publisher or a subscriber. The Select Action drop-down lists the operations that can be executed on each Topic destination selected. The SendMessage action will send persistent text messages to the Topic(s) selected. The Corrupted Topics check box, present next to the Select Action drop-down, if selected, will display all the corrupted topics in the MonitorTopics view; by default the view displays all the Topics (Corrupted and Non-Corrupted Topics). The corrupted topics can be recovered and replayed using the Recover Selected Topics and Replay Messages from Topics operations respectively..
Figure 9: MonitorTopics View
ConfigureTopics
This allows all actions to be performed on topics such as CreateTopic and DeleteSelectedTopics. The Restart Topics operation restarts a specific Topic destination to apply the changes made to its parameter values. The Shutdown Topics operation shuts down the unwanted Topic destinations.
The Edit Topic Properties operation can be used to edit all properties related to a topic destination, whereas, the Edit Topic Subsystem Properties operation can be used to modify similar properties at the global level for all Topics.
Figure 10: ConfigureTopics View
By selecting the EditTopicProperties options from the Select Action drop-down menu and clicking the Go button, it is possible to view all properties and their corresponding values. Values with a different background color need to be saved. Once saved, the server needs to be restarted to make them take effect, but if the changes are done at destination level, Topic restart alone will get the changes effected. A description of the property that is selected is provided at the bottom of the browser. Hover the mouse over the property text box to view the description of the property as a tool-tip. Export Topics and Import Topics can be used to save topics to a standard file as well as to create all of them in a FioranoMQ server that is running. Import Topics and Export Topics can be used only by the 'admin' User.
Figure 11: Editing Topic Properties
4. Queues
MonitorQueues
This view contains the information about existing queues with a summary displayed on the top of the table. The 'Active Queues' mentioned in the summary refers to the queues which contain either a sender or receiver. DeliverableMessages and UndeletedMessages are not updated at regular intervals. To update these values select all the required queues or invoke Update Selected Queues or Update All Queues present in the Select Action drop-down menu. Deliverable Messages count is the number of messages yet to be delivered from the Queue, and Undeleted Messages count denotes the number of messages yet to be acknowledged by the Consumer and deleted from the data base.
The SendMessage action will send persistent text messages to the Queue(s) selected. The Corrupted Queues check box (present next to the Select Action checkbox), if selected, will display all the corrupted queues in the MonitorQueues view; by default, the view displays all the Queues (Corrupted and Non-Corrupted Queues). The corrupted queues can be recovered and replayed using the Recover Selected Queues and the Replay Messages from Queues operations. The Purge Messages operation deletes all the messages in a selected Queue.
Figure 12: MonitorQueues View
The Browse Messages operation can be handy in browsing messages on a selected Queue and view its properties. When 'Browse Messages' operation is invoked, a new dialogue box is popped up to view the Messages and its properties.
Figure 13: Browse Messages operation
ConfigureQueues
This view allows all operations to be performed on queues such as CreateQueue and DeleteSelectedQueues. One can restart a specific Queue destination to get the parameter changes done on it to get effected using 'Restart Queues' operation. Also, available the 'Shutdown Queues' operation to shut unwanted Queue destinations.
'Edit Queue Properties' can be used to edit all properties related to a queue destination, whereas, 'Edit Queue Subsystem Properties' can be used to modify similar properties at the global level for all Queues.
By using EditQueueProperties option present under the Select Action drop-down menu it is possible to view all properties and their corresponding values. Values with different background colour need to be saved. Once saved the Server needs to be restarted to make them take effect or if the changes are done at destination level Queue restart alone will get the changes effected. Description of each property that is selected is provided at the bottom of the browser. The mouse may be moved over the textbox to view the description of the property. You are notified if any property requires save configuration and server restart was modified. Export Queues and Import Queues can be used to save queues to a standard file as well as to create all of them in a FioranoMQ Server that is running. Import Queues and Export Queues can be used only by the 'admin' User.
5. ConnectionFactories
MonitorConnectionFactory
This view lists all the connection factories along with their important properties (such as ConnectUrl, AutoUpdate, Type, Description). A summary is present at the top of the table.
Figure 14: MonitorConnectionFactory View
ConfigureConnectionFactory
This view allows various operations to be performed such as Create CF, Delete Selected CF, Edit CF Properties on Connection Factories. The Edit CF Properties operation can be used to edit all the properties related to the selected connection factory. The Create CF option present under the Select Action drop-down list can be used to create new Connection Factories and the Delete Selected CF can be used to delete existing Connection Factories.
Figure 15: ConfigureConnectionFactory View
The Export CF operation and Import CF operation can be used to save Connection Factories to a standard file and to create all of them in a FioranoMQ Server that is running. Import CF and Export CF can be used only by the 'admin' User.
6. Policies
ConfigurePolicies
Policies allow users to change permissions on a specific destination for a specific principal.
By default, the view will show No restrictions on Policies if user had not modified any permission. To modify any particular permission, use the Add Permissions option present in the Select Action drop-down menu. A pop-up window will appear with properties such as UserName, Destination Name, Positive Permissions, Negative Permissions, and Type of Permission. After all the required values are selected, click the OK button. The modified permissions will be shown in the table.
Figure 16: Editing policies of a destination
Click any row and view the permissions set on a specific destination.
ConfigureIPAccessList
This view lists down the IP addresses which are allowed to connect to the FioranoMQ Server. By default, all the IP addresses are accepted by FioranoMQ Server, denoted by *.*.*.* representation. The Select Action drop-down has two operations - The Add IPAddress operation, for adding a new IP Address set/range to the allowed list and the Remove IPAddress operation, for removing the IP Address entry from the list already available. While adding a new IP Address set/range, select the IP Type to add it as IPV4 or IPV6 address(es).
Figure 17: ConfigureIPAccessList view
7. Audit Manager
Using the Audit Manager view, it is possible to configure the Audit Storage Policies as well as monitor the audit events recorded in the server.
MonitoringAuditEvents
In this view, the audit events that are recorded in the system can be monitored. To enable this, the 'Audit Filter' set for the current view needs to be changed. Use the Modify Audit Search Filter operation to perform the same.
Figure 18: Modify Audit Search Filter
ConfiguringAuditPolicies
In this view, the various kinds of Storage Policies which are responsible for generating audit events are configured. In order to do this, the Modify Audit Storage Policy action needs to be invoked after selecting one of the storage policies listed in the table inside the view. The storage policy will then need to be configured.
Figure 19: The Modify Audit Storage Policy dialog box
The recording of Audit events can be stopped by configuring the same storage policy that is used for enabling Audit Events. In order to do this, the action 'De-activate Storage Policy' needs to be invoked after selecting the Storage Policy which is to be de-activated. The figure below shows how to deactivate the storage policy:.
Figure 20: De-activate Storage Policy message
For more information on Audit Management, please refer to the Audit Management section of this document.
8. Routes
A Route enables the transport of messages between destinations. A message arriving at one destination can be made available to another provided a route exists between the two destinations.
ConfigureRoutes
This view contains information about the properties of the route manager. These are the properties of the individual routes present on the server.
The table displays various properties of the route manager such as MaxTopicBuffer, NumberOfRoutesExistingInServer, MaxCreateSessionTries.
If there are any routes present on the Server, they will be displayed in the Route GUID box. If no routes are present, the message "No routes available in the Server" is displayed on the page.
Figure 21: Message saying there are no routes available in the server
To Add or Delete a route from the server, the appropriate action must be chosen from the Select Action drop-down menu.
Figure 22: Adding a route
Select a route name from the Route GUID drop-down to display the properties of that route in the table.
Figure 23: Route Added
9. Dispatcher
ConfigureDispatcher
This tab is available in the left navigation panel only when logged into the web console of a dispatcher-enabled server.
A Dispatcher distributes the messages received to different Servers that are connected to it. The Dispatcher performs the load balancing function of a network connected to FioranoMQ Servers.
This view contains information about the properties of the Dispatcher Manager and the properties of the Servers to which it dispatches messages. The Server URL list-box contains the list of server URLs to which the Dispatcher can dispatch messages. On selecting a URL, its properties are displayed on the table as shown in the figure 32.17.
Figure 24: Dispatcher
To Add or Delete a Dispatcher Server, the appropriate action must be chosen from the Select Action drop-down menu.
Figure 25: AddDispatcher Server
10. DashBoard
MonitorPerformanceGraphs
The MonitorPerformanceGraphs view under Dashboard gives a graphical representation of Time vs Connections/Memory/Threads in the x axis and y axis respectively. The entries in the y axis may be selected based on the requirement; selecting more than one of these options displays graphs one after the other.
Figure 26: Displaying a graph of Time Vs Memory
11. DurableSubscriptions
MonitorDurableSubscription
This view contains all existing durable subscribers listed along with its other relevant information such as Subscription state, the Topic destination it is subscribing to, the deliverable number of messages for each durable Subscriber, the ClientId of the connection, and if it is a Shared Subscriber or not and the number of active consumers under each Shared Subscriber.
A summary is present at the top of this window, denoting the total number of Durable Subscriptions for this instance of FioranoMQ Server. The 'Active Topics' counter is updated based on the number of Topics having Active Durable Subscribers running. The 'Passive Topics' counter is updated for Topics having Passive Durable Subscriptions.
Figure 27: MonitorDurableSubscription view
The Select Action drop down has a single operation, 'Browse Messages' on a Durable Subscriber. 
Figure 28: ConfigureDurableSubscription view
ConfigureDurableSubscription
This view contains all durable subscriber names in the form of subscriberID::clientID. Messages can be unsubscribed or purged messages for passive durable subscribers from this view. Any operations involving active durable subscribers throw a warning message.
12. Connections
MonitorConnections
This view lists all types of connections along with their relevant properties, such as the 'ClientID' of the connection, the 'ClientAddress' indicates the IP address from which this connection is created, 'Type' of connection, if it belongs to PTP or PUBSUB model or an MQTT Connection type, the 'Destinations' column gives the list of destinations that this connection is using in the form either creating Producers or Consumers, the 'CreationTime', the 'User' credentials used for creating this connection, and the 'Protocol' used.
A summary is present at the top of this window denoting the total number of connections and the under each category, PTP/PUBSUB/Admin connections.
Figure 29: MonitorConnections view
When clicked on each Connection, it displays the following additional Connection Information:
Build Number: The build number of the client connection
Number of Consumers: The number of Consumers created under this connection
Number of Producers: The number of Producers created under this Connection
Server Port: The server port to which this Connection is created.
Session Count: The number of Sessions created under this Connection
Version Number: The FioranoMQ Version number used by the Client Connection.
Figure 30: ConfigureConnections view
ConfigureConnections
This view allows the disconnection of a connection based on the clientID.
13. Sockets
MonitorSockets
This view contains information about all the sockets currently open within the Server. The sockets are created for each of the connections made to the server by the clients. The table gives information on Server ports, about the client, the transport type, IP address of the Server and whether SSL is enabled.
Figure 31: MonitorSockets view
14. Logs
MonitorLogs
This view allows the user to fetch details of logs, view log details, and clear log details.
Figure 32: MonitorLogs view
ConfigureLogs
This view lists all those logged into the FioranoMQ Server. You can select any particular log and change its level.
Figure 33: Changing log level of a particular logger
15. JMX
ConfigureFMQServer
This view lists all the Mbeans along with their attributes and operations. Mbeans are listed in this hierarchical view with a brown color bullet.
When a particular Mbean is selected, a table containing two tabs is displayed. The Attributes tab lists all the attributes of the Mbeans along with their values, parameter types and whether a restart of the Server is required for changes to take effect.
Figure 34: Attribute View of JMX
The Operations tab lists the operations present in that Mbean enabling the User to invoke these operations.
Figure 35: Operations View of JMX
Clicking on SHOW_OPERATIONS lists the operations present in that MBean enabling the User to invoke the operation.
15. AdvancedProperties
ConfigureAdvancedProperties
This view contains frequently used properties and their values.
For example, the first category, Port Properties contain RMIBasedJMXServerPort and JettyServer port. These are the two ports and the JMS Server listening port which need to be unique for running a server on the same IPAddress. These values can be modified. By default, from FioranoMQ10.2.0 onwards 'ConnectionManager Properties' will have two tabs for MQTT and JMS connection managers, both accepting connections at different ports.
Figure 36: AdvancedProperties View
16. HighAvailability
This view contains properties related to the HA Servers. When using the StandAlone Server this view shows a message with: The Server you logged in is not running in HA Mode.
If the HA server is running this view displays all relevant properties for HA. Please note that the word 'remote server' means backup server, it can be either of HAPrimary or HASecondary Servers.
Figure 37: HA view
17. StandAloneBridge
This tab is available only when logged into the web console of a Server running on the StandAloneBridge profile.
A Bridge transmits a message received on one queue (source queue) to another queue (target queue).
ConfigureBridge view lists all the Bridges currently available on the server. The Select Action drop-down menu contains various options , such as:
- View Bridge Attributes
- Add Link
- Delete Link
- View Link Configuration
- Edit Link Configuration
- Add Channel
- Delete Channels
- View Channel Configuration
Figure 38: StandAloneBridge
AddLink Attributes
To add a link select Action list-box, choose the AddLink action and click the Go button. Following are the parameters present in AddLink window:
LinkName | The name of the link which is to be added. |
|---|---|
SourceServerInitialContextFactory | The class name of the initial context factory which is used to open connection with the source server. |
SourceServerName | The name of the source server. |
SourceServerPassword | The password which the bridge uses to connect to the source server. |
SourceServerProtocol | The transport protocol used for establishing a connection with the source server. |
SourceServerQCF | The connection factory with which the connection is to be established. |
SourceServerSecurityCredentials | The SecurityCredentials (password) used for connecting to the source server. |
SourceServerSecurityManager | ServerSecurityManager of the source server linked by the bridge. |
SourceServerSecurityPrincipal | The SecurityPrincipal (username) used for connecting to the source server. |
SourceServerType | Need to mention the type of the source server. |
SourceServerURL | The URL of the source server should be given here. - The default provider URL of the server. |
SourceServerUserName | The UserName which the bridge uses to connect to the source server. |
TargetServerInitialContextFactory | The class name of the initial context factory which is used to open connection with the target server. |
TargetServerName | The name of the target server. |
TargetServerPassword | The password which the bridge uses to connect to the target server. |
TargetServerProtocol | The transport protocol used for establishing a connection with the target server. |
TargetServerQCF | The connection factory with which the connection is to be established. |
TargetServerSecurityCredentials | The SecurityCredentials (password) used for connecting to the target server. |
TargetServerSecurityManager | ServerSecurityManager of the target server linked by the bridge. |
TargetServerSecurityPrincipal | The SecurityPrincipal (username) used for connecting to the target server. |
TargetServerType | Need to mention the type of the target server. |
TargetServerURL | The URL of the target server should be given here. - The default provider URL of the server. |
TargetServerUserName | The UserName which the bridge uses to connect to the target server. |
To perform any of the actions listed in the Select Action list-box, choose the appropriate action and click the Go button.
Figure 39: AddLink
AddChannel Attributes
To add a channel to a link select Action list-box, choose the AddChannel action and click the Go button. Following are the parameters present in AddChannel window:
AddSourceQueueParams | Specify the source queue parameters. |
|---|---|
AddTargetQueueParams | Specify the target queue parameters. |
ChannelName | The name of the channel which is to be added. |
SourceQueueMessageSel | The message selector of the queue. Allows the user to set message selectors for the |
SourceQueueName | The name of the queue present in source server which is to be linked by the bridge. |
TargetQueueMessageSel | The message selector of the queue. Allows the user to set message selectors for the |
TargetQueueName | The name of the queue present in target server which is to be linked by the bridge. |
18. StandAloneRepeater
This tab is available when logged into the web console of a Server running on the StandAloneRepeater profile.
A Repeater transmits a message received on one topic (source topic) to another topic (target topic).
ConfigureRepeater
This view lists all the Repeaters currently available on the server. The Select Action list-box contains various options such as:
- View Repeater Attributes
- Show Repeater Info
- Add Link
- Delete Link
- View Link Configuration
- Edit Link Configuration
- Add Link Topic
- Show Link Topic Configurations
- Remove Link Topic
- Add Reply Topic
- Show Reply Topic Configurations
- Remove Reply Topic
Figure 40: StandAloneRepeater
To perform any of the actions listed in the Select Action list-box, choose the appropriate action and click the Go button.
Figure 41: View Link Configuration
19. Licenses
MonitorLicense
This view displays information of about all the licenses available. Click the license file name to display the corresponding license information below it.
Figure 42: Licenses
20. SystemProperties
SystemProperties
This view lists the all the relevant properties of the system on which the FioranoMQ Server is hosted. These values cannot be modified through the WMT.
Figure 43: System Properties