Navigating the Administration Tool

The Administration Tool consists of a number of pages, organized in the following ways:

The Global Navigation Bar

The global navigation bar at the top of the Administration Tool contains links and information about your current login session.

The Global Navigation Bar

The following information is shown in the global navigation bar:

• The Broker name, which is a random number generated during installation.
• The Hostname of the Manager.
• If the Manager has a Primary, Secondary, or no Director.
• If the Manager has an enabled, failover, or no Broker.

The banner includes icons that open the following links:

• The Information panel, which displays component versions, built date, and applied updates.
• The Help panel, which displays context-sensitive help for this page, and other documentation links.
• The Downloads panel, which contains download links for SDKs and Engine installations.
• A Profile panel, which shows your current user name, security roles, and has links to change your password or log out of the Administration Tool.

The Navigation Bar

The navigation bar contains categories, with each category having a submenu in the left sidebar. Each submenu has links to several pages, which are displayed in the main content area. Some submenus have subcategories at the top, which you can click to show different collections of page links.

The following categories are available:

Administration Tool Categories

Menu

Contents

Dashboard

All of the sub-pages of the Dashboard.

Grid Components

Pages used to manage, view, and configure Drivers, Brokers, and Engines.

Services

Pages used to manage, view, and submit Services and Batches.

Admin

Pages used for configuration, system and user administration, and reinstallation.

Diagnostics

Pages providing logs and information useful when diagnosing issues.

When describing navigation to a page, the following format is used: Category > Submenu > Page. For example, to view the Engine Admin page, click Grid Components > Engines > Engine Admin.

Tables and Table Controls

Most pages have items or information shown in tables. For example, the Grid Components > Engines > Engine Admin page displays a table with a row for each Engine in the grid. The following controls enable you to perform actions on the listed items, or change what items are displayed.

Action Controls
Each table item has an action control (), which opens a list of actions for the selected items in the table. Some of these perform actions on table items, while others open a new page. If no items are selected, this acts as a Global Action control, which opens a list of actions to perform on all items.
Search Control
The Search control is displayed on any page containing a table. There are two types of searches: a simple search, and a query search.

The Search Control

For the simple search, enter a string in the Search box, select a column to search from the list, and click the search icon. A new table appears, containing the matching rows.
Click the icon next to Search and select Query for a query search. This enables you to search properties using regular expressions consisting of, at minimum, a property, operator, and value. Terms can also contain wildcards and regular expressions, as defined by java.util.regex.Pattern. Click Search to run the query.
You can enter your own complex query by selecting Query Builder. If you first define a query in the Query Builder and then select Query, the query is displayed in the Find box.

Columns Control

The Columns control enables you to change which columns are displayed in a table. When you click the Columns control, an overlay appears, listing all columns currently in the table and columns that can be added.

To display a hidden column, click the + symbol next to the column in the Add Columns list. To hide a column, click the X symbol next to the column in the Columns list.

The Columns overlay for the Grid Components > Engines > Engine Admin page

When you add a new column, it is added to the bottom of the list. The table displays the columns from left to right in the order of this list. To change the order of columns, click and drag the column name in the Columns list.

After you have made changes, click Save to apply them. To return to the default visible columns, click Revert.

The displayed table rows are always sorted by a column that has an arrow in it, either facing up or down. You can click this arrow to reverse the sort order of entries in the table, or click another column to change the sort column. Table order is only kept for that page view and is not persisted.

Refresh

Pages in the GridServer Administration Tool are automatically refreshed every ten seconds by default to display the most current information available. Click the Refresh control to view the last time a page was refreshed, or to disable automatic refreshes. You can also customize the refresh rate by setting the AJAX Refresh Interval property on the Admin > System Admin > Manager Configuration page, in the Security section.

Pager Controls

The Pager controls, shown above and below tables, enable you to step through multiple pages of information, or specify how many rows appear on a page. Select a page number from the Page list, or select a range from the items list to display those items. You can select a greater number of items listed per page in a table or display all of the items; type a number in the Results Per Page box and click Go.

Exporting Table Data

Most information shown in Administration Tool tables can also be accessed programmatically using the GridServer Admin API. The Admin API can also be accessed with SOAP Web Services; the WSDLs are available from the Grid Components > Drivers > Web Services page.

For example, to generate a list of information about all logged in Engines as normally presented on the Engine Admin page, you can write a simple client application that connects to the Manager and uses the getAllEngineInfo method of the EngineAdmin Web Service.

For more information about using the Admin API, see the TIBCO GridServer® Developer's Guide.

The Dashboard

The dashboard provides current information about the status of your grid, summarizing statistics into a single at-a-glance overview. The Dashboard > Overview page is automatically updated every ten seconds.

Status tiles on the dashboard display an indicator of that components’ current state, along with an arrow showing the trend of that statistic, and a small graph showing the last ten minutes of changes to that statistic. Click any status tile to open a dialog that shows more detail.

When you click the status tiles in the bottom row for grid components, the dialog also shows a small table with links to recently-active components, and a link to that component’s admin page. For example, if you click the Recently Created Engines status tile, it shows a table of the recently created Engines, and a link to the Engine Admin page.

The Broker and Director Monitors

While the pages like the Service Session Admin page and Engine Admin page can be used to oversee the running of Services on your grid, two graphical tools can be used to provide a simpler overview of status information about your system. Both Directors and Brokers have a graphical monitor available, which can be displayed in its own window.

Display the Broker or Director Monitor by going to Dashboard > Broker Monitor or Dashboard > Director Monitor. Note that the Director Monitor is not available on standalone Brokers, and the Broker monitor is not available on standalone Directors.

Both monitor pages display up-to-date information about your grid. The Director Monitor contains graphs with statistics on Engines, tasks, Services and machine status, including thread and memory information. The Broker Monitor contains similar information about one specific Broker.

The Broker Monitor