Chat now with support
Chat with Support

Foglight 5.9.2 - Web Component Guide

Introducing the Web Component Framework The Web Component Framework Configuring Views and Context Queries Functions Bindings Additional Components

General Tab

As you are creating a new view, you need to configure its properties by specifying the following items and fields.

 
Table 10. General settings
Item or Field
Description
Module

The module in which this component resides. The module is set by selecting a module in the Module List pane before clicking the Add button in the Module Contents pane.

Component

The specific type of the view component, such as a Tree Table. The component is set in the Add View dialog box after you click the Add button in the Module Contents pane.

Name

The view name. You can choose any name you wish.

Public

Determines how this component can be referenced by other components. If true, the component can be used in any module. If false, the component can only be used in its own module or sub-modules of that module.

Deprecated

Marks a view that cannot be used in any new definitions, but that should not be deleted because some other module might be using it. The component is removed from any drop-down list that allows components to be selected. For instance, it becomes unavailable for inclusion in a grid’s layout.

Preferred Width

The width of the view in pixels. It is used as the default setting in various places, such as charts and reports.

Preferred Height

The height of the view in pixels. It is used as the default setting in various places, such as charts and reports.

Refresh Interval

The time interval after which the page refreshes itself by requesting new data from the server. This overrides the default refresh interval set in User Preferences.

Priority

The Priority setting is used to control which views are presented in the view pane of the Data tab when a node in the list pane is selected. The Data tab presents another way to browse Foglight data. A running Foglight system instantiates as many objects as it can from the data models defined in its agents and in its core system. These data objects are presented in the list pane.

When one of these data objects is selected, the Foglight™ system searches for any dashboard or monitor views that have as their sole context input a data object of this type. If a priority has been set for the view, it is displayed in the view pane. High priority views are shown first, and then those of lesser priority. If a priority has not been set, the view does not appear even though it has the proper input.

Choices for the Priority setting are: None, 1 - 9, (Low=8, Medium=5, and High=2)

Purpose(s)

See Purpose of Views .

Custom Purpose(s)

See Purpose of Views .

Relevant Role(s)

See Roles .

Allowed Role(s)

See Roles .

Comments

A brief description about the view.

Context Help

A detailed description about the view. The description that you provide here becomes the online help for the component. When a user chooses this component from the drop down list on the Help tab in the action panel, the text is displayed. For this reason the text you provide here should fully describe the component from the user’s point of view.

After the component has been saved the editor pane reverts to the definition pane. The following additional properties are presented:

 
Table 11. Additional settings
Field
Description
Context Inputs

A table of context settings for the view.

Reference Id

The internal name for the component by which is referenced. Useful for exporting and importing custom views.

Last Modified Time

The time at which this view was last edited.

Purpose of Views

Each view can be marked as having one or more purposes. The standard shipped purposes are:

•
Dashboard: A dashboard is a page that cannot have required context inputs. The filtered list of views that you can add to a dashboard can contain any view that is purposed as a Pagelet as long as the dashboard contains the appropriate context to make the view useful. Any view marked as a dashboard can be accessed byselecting it in the navigation panel.
•
Data View: A data view is a view that is presented in the list of view choices in the data browser (accessible by choosing Dashboards > Configuration > Data from the navigation panel) when an object compatible with the single required input of this view is selected from the data tree. Note that a priority (other than none) must also be set.
•
Diagnostic: Useful for identifying views that are meant to be the beginning of a diagnostic work flow. This is the opposite of Monitor. If it is used as a drill-down page, it freezes its time range so that even if the page is updated the time range does not update.
•
Dialog: A view that is designed to not update automatically. Useful for identifying views that are designed (in shape, size, and interactivity) to be Dialogs, either temporary or full.
•
Feed: This view is useful as a syndication feed (for example, Really Simple Syndication (RSS) or Atom) used to frequently update content. Only a view based on Feed View Component should be purposed as a feed. A component purposed as a Feed can be used as a way to query data from Foglight because it provides a well-defined XML stream that you can parsed to extract the information you want. For more information, see Setting up RSS Feeds.
•
Global Action: When set, a link to this view is shown in the right panel (page/action panel) under Other Actions as long as the user is permitted to see the view. A Global Action view cannot have required inputs.
•
Home Page: Useful for identifying views that are designed to be home pages. It cannot have required context inputs. A link to a view with this designation appears in the Homes list in the navigation panel.
•
Menu: Useful for identifying views that are designed to be menus.
•
Monitor: A view marked as a monitor is meant to reload itself periodically, since it is meant to monitor the data it is presenting. By default, the refresh interval is obtained from the user preferences but can be specified using the refresh interval property of the monitor view. The policy for refreshing views is as follows:
•
Child views that are not marked as monitors refresh at the rate of their ancestor.
•
Child views that are marked as monitors but are set to refresh at less than the rate of their ancestor still refresh at the rate of their ancestor.
•
Child views that are marked as monitors whose refresh rate is more frequent than their ancestors refresh at their own rate.
•
Child views marked as monitors but whose input timeRange do not have an idea of now (the current time) do not get refreshed. For a child page’s timeRange to have a notion of now it must be passed a timeRange.
 
* 
IMPORTANT: Monitor purpose affects the type of label that you see in the center of the page header as shown in the following policy code:
IF (there is a timeRange menu (topview has timeRange as a context input))
IF (topview is a monitor and none of its children have a smaller update
interval.) OR (topview is not a monitor and all other children also are
not monitors)
Show TimeRange
ELSE
show no label
ELSE Show just time stamp
•
Page: A page is a view that is designed to be used as a page – one that is drilled down to from another page or dashboard or portlet. It can have required context inputs.
•
Pagelet: A pagelet is a view that is designed to be added to a page or dashboard.
•
Portal: The result of using Create Dashboards in the action panel. A portal is page that a user can customize by dragging views onto it. The filtered list of views that you can add to a portal can contain any view that is purposed as a portlet as long as the portal contains the appropriate context to make the view useful. If used in a remote interface, for example, in a WebLogic, a drill-down to a portlet takes place in the remote window. A drill-down to a page with any other purpose directs the browser to the Foglight™ browser interface.
•
Portlet: A portlet is a view that is designed to be added to a portal.
•
Report: A report does not require any input. The filtered list of views that you can add to a report can contain any view that is purposed as a reportlet as long as the Report contains the appropriate context to make the view useful. Scheduled reports that have been generated appear in the Reports view.
•
Reportlet: A reportlet is a view that is designed to be added to a report.
•
Summary: Useful for identifying views that are designed to be small read-only summaries of data. Often useful for dwell actions.

Custom Purposes

You can enter custom purposes, using whatever names you want. Enter the custom purposes as a comma-separated list in a single text field.

No actions are associated with custom purposes in this release. In future releases, custom purposes will be used in various places in the GUI for restricting the list of views that can be seen to those who have been assigned the same custom purpose.

Roles

For more information, see Relevant Roles and Allowed Roles.

Related Documents

The document was helpful.

Select Rating

I easily found the information I needed.

Select Rating