Widgets

A Monitor "widget" is a web page that generates various reports, but with no interface or visual aids. Widgets are called by other pages that provide these items, as well as details about the content provided by the widget, such as a title and description of the content.

Widgets are useful in the following scenarios:
  • When custom report pages or page formats are desired.
  • When it is desired to have Monitor reports embedded into other websites. The language used by the website doesn't matter, as long as it has the capability of including content from another URL (such as HTML's inline frame). For an example (using PHP) of a page with embedded widgets, see the Widget Application Example.

Using Widgets

Widgets are accessed through a URL via Monitor's read-only port. The URL parameters that are passed to the widget define its behavior.

The root URL for all widgets is:
http://lm-host:lm-readonly-port/cgi/ftlm.cgi?widget=widget-nameĀ¶m1=value1

By supplying a widget name at the end of the URL, along with the required parameters for the widget, a report will be generated with the UI and some visual elements absent. A good way to learn how to use widgets is to experiment with a widget in its own browser page. This can be accomplished by clicking on the popout icon in the top right-hand corner of an existing Monitor report. Most reports in Monitor are driven by widgets. Clicking on the help icon in this area opens this documentation page.

After opening a widget in its own window, change the parameters in the browser's address bar and note how the widget updates when the URL is loaded.

Widget Summary Listing

Here is a quick listing of all widgets available in the Monitor system. Click on the hightlighted name for further details

Output Type Name Description
Tabular checkouts View of current checkouts.
Tabular checkoutstats History checkout statistics.
Tabular checkoutdets Detailed history of checkouts.
Tabular tags Report on current server information.
Tabular tagstats
Tabular features Current feature usage.
Tabular featurestats Feature usage statistics.
Tabular featureeffstats Feature usage efficiency.
Tabular denialstats Report of denial statistics.
Tabular denialdets Detailed view of denials.
Graphical checkouthistogram Distribution of historical checkouts.
Graphical featurestatsplot Visualization of feature usage.
Graphical featureeffhistogram Visualization of feature efficiency.
Graphical featuredetsplot Detailed graph and pie charts.
Graphical denialplot Visualize denials over time.
Graphical heatmap Visualize feature usage over a week cycle.
Graphical piechart Get a pie chart of usage for each user.