1.4. A High Level Walk-Through

download PDF
The JBoss ON UI is very rich — there are a lot of small elements that are all layered together to provide a very detailed and flexible interface for interacting with the JBoss ON servers and resources. To maximize its use of space, JBoss ON uses top navigation menus, tabbed browsing with subtabs, active links, and navigation trees to establish relationships between JBoss ON resources and JBoss ON functionality. In a very general view, several types of visual elements that work together to comprise the UI:
  • The top menu
  • The left menu tables
  • The dashboard
  • Resource-based tables, which can be for the resource inventory, a summary report, or the results of a search
  • Configuration pages which both provide details for and access to elements in JBoss ON, including resources, groups, plug-ins, and JBoss ON server settings
All of these elements fit together in a repeated and reliable pattern.

Figure 1.2. UI Elements All Together

UI Elements All Together
Understanding the type of page that you are viewing can make it easier to navigate through the JBoss ON UI and can help you more completely understand what you can accomplish in JBoss ON.

1.4.1. The Top Menu

At the very top of the JBoss ON UI is a menu bar with, with five tabs that go to the major configuration areas of JBoss ON.

Figure 1.3. The Top Menu

The Top Menu
Each menu item relates to a different functional aspect of JBoss ON.
  • The Dashboard contains a global overview of JBoss ON and its resources. Different, configurable snapshot summaries (called portlets) show different aspects of the resources and server, such as the discovery queue, recent alerts, recent operations, and resource counts.
  • The Inventory tab shows both resources and groups.
  • The Reports tab shows pre-defined reports. These are slightly different from the Dashboard, which focuses exclusively on resource information: the reports focus on the current actions of the different subsystem (or major functional areas) of JBoss ON, such as alerts, operations, metric collection, and configuration history.
  • The Bundles tab opens the provisioning and content functional area. This is for uploading and deploying content bundles that are used to provision new applications.
  • Administration goes to all areas related to configuring the JBoss ON server itself. This includes server settings, plug-ins, users and security, and agent settings.

1.4.2. The Left Menu

Rather than using drop-down or tabbed options, much of the configuration for JBoss ON is accessed through the left menu. There are individual tables that contain related areas of configuration, like users and groups, server configuration, server/agent connections, and content for the Administration area in Figure 1.4, “The Left Menu”.

Figure 1.4. The Left Menu

The Left Menu
Clicking the up or down arrows at the left of the menu tables collapses and expands the tables. This can make it easier to navigate the left menu.

Figure 1.5. Collapsing the Left Menu

Collapsing the Left Menu

1.4.3. Dashboard

The Dashboard is an overview of everything in JBoss ON, from recent actions (fired alerts and operations) to availability reports to newly discovered and imported resources. This page, unlike any other area of JBoss ON, is customizable so it can be used to display only the collection of information that you want to see. Each table of information is called a portlet, a mini-portal into a view of the JBoss ON server or resources. There can be multiple Dashboard views configured, with different portlets or different layouts; these are accessed by tabs at the top of the Dashboard page.

Figure 1.6. Dashboard View

Dashboard View
The Dashboard is the landing page for JBoss ON, the first page that comes up after login.

1.4.4. Inventory Browsers and Summaries

Some pages are essentially long tables of information, presented in basically the same way:
  • Tabs for different areas, with subtabs that further break down information
  • A table of results
  • Icons that open a configuration or task option for that specific entity
  • Buttons that perform actions (create, delete, or some other specific action) on the entries; some of these buttons aren't active unless an entry is selected
The inventory interface in Figure 1.7, “Inventory Browser” is rich with functionality. The search bar for resources and groups uses a specialized syntax and flexible dynamic search. Hovering over any resource name gives a small popup message with more information about that resource. Clicking the name of the entry itself opens its default entry configuration page, while clicking the name of its parent opens up that parent resource's configuration page.

Figure 1.7. Inventory Browser

Inventory Browser
In Figure 1.7, “Inventory Browser”, the UNINVENTORY SELECTED button is active because a resource is selected. If no entries are actively selected, activity buttons are grayed out.

1.4.5. Entry Details Pages

Possibly the most functionality-saturated area in JBoss ON is an entry's details page.
The left navigation area shows the hierarchy, both parents and children, of the selected resource. This makes it very easy to navigate among all of the different services and servers that affect a resource.

Figure 1.8. Resource Tree

Resource Tree
Right-clicking any of the resources in the left navigation opens shortcuts to that entry's configuration.
Resources have short names that are automatically assigned based on their type, instance or system name, or IP address. These names are used in the inventory and in the tree navigation.
The configuration area of a resource entry page (and other JBoss ON entities, like plug-ins and templates) has three information layers that provide all of the possible functionality and tasks available for that entry.
The entry's configuration page is tabbed according to each area that can be configured, and frequently has subtabs for additional configuration options and to show the history of that area (like fired alerts, previous content updates, or monitoring data).

Figure 1.9. Tabs for a Resource Entry

Tabs for a Resource Entry
The next section in the entry area shows lists of related configured entries for that task. For example, an Operations area will have a list of available operations in a table below the tabs. For Inventory, there is a list of configured child resources, while Alerts shows all of the configured alerts for that resource. All of those entries are listed in a table similar to the search results available in other parts of the JBoss ON UI.
Many elements are both a details page and an edit page. meaning that many fields are active automatically. This makes it possible to perform management tasks directly, without opening a separate page.

Figure 1.10. Editable Areas for a Resource Entry

Editable Areas for a Resource Entry

1.4.6. Shortcuts in the UI

To the far right of the top menu is a small cluster of icons that provide very quick, targeted insight into JBoss ON.
  • The Message Center shows all notifications that have been sent by the JBoss ON server. This includes alerts, configuration changes, changes to the inventory, or error messages for the server or UI.
  • The Favorites button can be used to navigate to selected resources and groups quickly, while the little blue ribbon on resource pages can be used to add that resource to the favorites list.
  • The resource availability is shown as a green check mark if the resource is available and a red X if the resource is down.

Figure 1.11. Shortcuts


1.4.7. Red Hat Access Menu

With Red Hat Access, customers can search help topics, submit support tickets, and utilize diagnostic services using exclusive Red Hat knowledge, resources, and functionality all from within the JBoss ON UI.
Subscribers can enjoy the following Red Hat Access services:
  • Conveniently access exclusive Red Hat knowledge and solutions.
  • Search error codes, messages, and other information, as well as view related knowledge from the Red Hat Customer Portal.
  • Create new and view existing support cases as well as attach JBoss Diagnostic Reporter (JDR) reports collected from JBoss Enterprise Application Platform 6 instances and other files to those cases Basic Usage

To start using Red Hat Access, on the dropdown menu in the upper right corner of the top menu titled "Red Hat Access". Subscribers must log in using their Red Hat Customer Portal credentials to enable these services. The "Red Hat Access" menu will detect when users are not logged in and present them with a Red Hat Access login dialog when appropriate.
For account/password recovery, visit the Login Assistance page on the Customer Portal. Support

Case management functions are launched from the "Support" sub-menu of the "Red Hat Access" menu. These functions allow subscribers to view and update existing cases in addition to creating new cases directly from the JBoss ON UI. Opening a New Support Case

A new case screen can be launched from "Red Hat Access -> Support -> New Case" sub-menu.
Alternatively, this screen can be opened by clicking on one of the "Open A New Support Case" button from the case list screens. If coming from the search panel, the most recent searched for text will be inserted into the description field as well as the appropreate product and version information. Additionally, Red Hat Access will automatically analyze the "Subject" and "Description" input fields and try to recommend Knowledgebase solutions that are relevant to the case being created.
The user may attach any relevant log files to the case during case creation. Clicking the checkbox next to a file in the Server file(s), then clicking "Update Attachments" will attached and upload the selected files.
In addition to JBoss ON, this process may be used to open a support case against other Red Hat supported products as well. Opening a New Support Case Against a Product on Supported Application Servers

A new case against a product on supported application servers can be started simply by navigating to the instance, right clicking and selecting "Open Support Case".
A case may then be opened against that product with the option of attaching JDR reports where avaiable. View Existing Support Cases

Existing cases can be viewed from the "Red Hat Access -> Support -> My Cases" sub-menu.
The case list can be filtered by using the search box, selecting a case group, or by using the dropdown to control visibility to open and/or closed cases. Editing a Case

Clicking on a case from the case list allows you to modify the case just as you would in the Red Hat Customer Portal. Click the "Update Details" button to make any changes in that section permanent.
In addition to recommending Knowledgebase solutions during case creation, Red Hat Access will also analyze the case's metadata and try to recommend relevant Knowledgebase solutions. The results are based on Red Hat's prior experience with similar issues which may help a customer resolve the issue more quickly. These recommended Knowledgebase solutions are shown when an existing case is being viewed or edited.
Any of the recommended Knowledgebase solutions can also be attached to an existing case by clicking on the pin icon next to the recommendation.
Red Hat logoGithubRedditYoutubeTwitter


Try, buy, & sell


About Red Hat Documentation

We help Red Hat users innovate and achieve their goals with our products and services with content they can trust.

Making open source more inclusive

Red Hat is committed to replacing problematic language in our code, documentation, and web properties. For more details, see the Red Hat Blog.

About Red Hat

We deliver hardened solutions that make it easier for enterprises to work across platforms and environments, from the core datacenter to the network edge.

© 2024 Red Hat, Inc.