Chat now with support

Get Live Help
Complete Registration

Sign In

Request Pricing

Contact Sales

Foglight 5.9.5 - Web Component Guide

Table of Contents

Introducing the Web Component Framework

Configuring Views Browser Interface Views The Browser Interface

Anatomy of a Typical Dashboard The Web Component Framework (WCF)

View Components The Module List Pane

The Web Component Framework

The Edit Module popups Validating Modules Definitions and Entities

Time Range Related to Observations Metric Observations Enum Observations

Context Parameters in Bindings On Null Values Renderers Default Values Data Sources, Data Types, and Data Objects Paths Properties

Using the Web Component Framework

The Web Component Framework Editor An Example Page

Managing Dashboards

Definitions Panes

System and User Dashboards Dashboard Page Navigation

Data and Data Sources Pages Definitions Pane Customizing the UI Quickly Finding Pages: Bookmarks Additional Documentation

Configuring Views and Context

Configuring Views

Creating a New Container View

Creating a New View Based on a Copy of a View

Stamping Views Searching for Definitions Definitions Page for a View

View Commands in the Definitions Area Nested Views in the Add View Dialog of a Container Replacing Views Testing a View

Definitions Pane Settings Tabs

Configuring Properties in the Definitions Pane

Purpose of Views Custom Purposes

Comments Context Help

Context Inputs Additional Context Outputs (Flow Context Mappings)

Configuration Tab

Cooperative Layout Common Properties in the Configuration Tab

Configuring Flows for Views

Layout Tab Views Tab

Context Tab Context Types

Required Context Optional Context Internal Context

Additional Context

Additional Context for a View Additional Context for an Instance Additional Context for a Flow

Dynamic Context Flow Context Mappings

Validation of Context in the Editors On-null TimeRange

Overview of Query Definitions Creating a Query in Foglight

Query Definition Settings

Name ID UI Query Public Deprecated Relevant Roles and Allowed Roles Object Type Required Parameters Object Type Root Reference Aggregations Identifying Values Filter Results Based on Top N Order By Where

Conditional Types

Comparison Is Set Sub Type is And Or Not Combining And, Or, and Not Conditions Comments Context Help Relevant Roles and Allowed Roles

Sequence of Evaluation

Creating New Queries

Parameters in Queries

Summary of Creating a Query

Copying a Query Deriving a Query from Another Query Editing a Query Deleting a Query Legacy Custom Query

Java Functions Map Functions Script Functions Script with Map Functions Using Functions

Functions as Converters Caching results of Functions Information available from a Script, Script with Map or Java Function Invoking a Function from a Function Invoking a Query from a Function Time Range used for testing a function

Simple Types Binding Types Details of each Binding

Context Writable Data Object

Creating a Data Type in a Module Creating a Data Object based on the New Type Saving a Data Object Removing a Data Object from Storage

Configuring the Query Dialog Box

Theme Icon String Template Rich Text and Rich Text Template Image Reference Function Localized String Data Data Object Property Data Object Property (and Property) Date List Return Types

Localized Value Value CountPerItem Count All Unit Units Localized Property Name Localized Property Names Localized Type Name Localized Type Names

Additional Components

Files Icons Associations

Tab Associations Question Associations Category Associations Domain Associations Message Associations Customizable Associations Hierarchy Associations Alarm Associations Activity Associations Action Associations Node Associations Edge Associations Creating Associations Creating Alarm Associations: Example

Configuration details Configuration example

Default Renderer can be Overridden

Binding a property that takes a color or an image to data

Input Value Determining the Appropriate Renderer for a Binding

Types Tab in the Module List Pane

Unit Mappings Tasks Types

Creating a Data Type in a Web Component Framework Module Data Object Types

Properties Annotations Enumeration Types

Creating a Data Object of your Type

Equality

Saving Data Objects

Removing a Data Object from a Storage Mechanism Saving Contained versus Referenced Properties

Setting up RSS Feeds

Theme and Module Resources

Module-Specific Images Theme-Specific Images in Module Definitions

PDF Generation Reports

Report Layout Scheduling Reports

Remote Access to Views

Deploy and Run Configuration

SharePoint Web Part with Windows Single Sign-On

Performance Improvements

Optimizing Data Access with the Batch API

Views Tab

The Views tab is used in the Iterator (where it is called an Iterator View), PDF Layout, Switch, Tab Container, Topology, and Type containers. The tab incorporates an editor for setting views for the container.

Context Tab

Context is the term used for the information available at a given point in time to the various components used by the Web Component Framework. Context in the Web Component Framework is similar to a collection of variables that are used in programming languages or an operating system’s environment variables.

Context Inputs are defined in the Context tab when editing the definition of a component.

Figure 27. Context Inputs

Every element of the context has a key (name), a corresponding type, and a run time value in an active Foglight instance.

Figure 28. Context parameters
Context consists of:
Key	The key used to reference the object in other dialog boxes or scripts. Note that the timeRange key should be kept in the list of defined keys even if the page is not dependent on the time range.
Name	A more descriptive name for the key.
Usage	Choices are Required, Optional, or Internal.
List	True if the key is associated with a list, False if it is associated with a single item, and Unknown if it might be either.
Data Type and Data Source Type	The data type of the object and the source of the data object referenced by the key. The choices are in the Select Type dialog box.
Fallback Value	A fallback value must be set if the Usage is Optional or Internal. The value is set using the binding editor.

For example, a view that is configured to display alarm data for any one host must be provided with a specific host to give it context. Similarly, a Memory Usage page, which displays memory data for a specific host given a time range, must be provided with two context inputs. In the first example, the host is the context. In the second example the host and the time range together comprise the context.

Pages and views can be compared to forms whose fields are filled in at run time. The context definitions determine the actual data that is specified by the Context, which is set in the following ways:

•

A time range, which is available to all components. For more information, see TimeRange.

•

The Context tab in the View editor: You declare context inputs to the component here. You can define additional context entries here as well.

•

The Configuration tab in the View editor: For example, by setting row/cell properties and choosing an available built-in context such as <currentRow>.

•

The Configuration tab in the View editor: By setting a parameter’s value in the Edit - Value dialog box or a component.

•

In the Flow tab of the View editor: You can set additional context here, or map from internal component sources into the context.

•

In the Flow Type editor for Page Options > Actions: You can define Additional Context items here.

For example, a page is designed to display information for a selected host. When you click a link, the host object is passed to a detail page. The detail page uses that information as its initial context settings. The Context tab is where you set up the list of required context data. Using a required Context setting means that the page or view is dependent for its data on that context value being available.

Context Tab

Context allows you to define the list of information that is required for a particular view to display the data that the page is designed to show. When a context element is defined it is given a name key and it is assigned a data type.

In any application there is global or application level context, which is the information that is available throughout the application. An example of this type of context is timeRange. Each application can decide to make arbitrary information available to all views.

Dashboard Context

Context is implemented so that changes to one context element affect other elements in a hierarchy. If a context element changes in a nested level, the change traverses up the hierarchy to the parent level, assuming that an uninterrupted chain of key definitions exists.

When a user interacts with views the interaction can cause changes to the context. For example, when selecting a particular item in a drop down list, by default the Web Component Framework saves the last known values so that when you return to the page, it displays with that same item selected.


	NOTE: You can disable this behavior in User Preferences.

Context Types

See also Context tab .

There are three types of context entries:

•

Required Context

•

Optional Context

•

Internal Context

If a view has only one context input other than timeRange or only one required context input (and zero or more optional inputs), it becomes its primary context input. The primary context input and its priority controls whether it appears in data browsers when a node of that type is selected.

Related Documents

The document was helpful.

Select Rating

I easily found the information I needed.

Select Rating

© 2024 Quest Software Inc. ALL RIGHTS RESERVED. Feedback Terms of Use Privacy Cookie Preference Center