Chat now with support

Get Live Help
Complete Registration

Sign In

Request Pricing

Contact Sales

Foglight 7.1.0 - Web Component Tutorial

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

Removing a Data Object from a Storage Mechanism

An object using Site, User, or Session storage can be removed from those storage mechanisms by calling the remove() method on the object or calling the WCF/Common/Remove Data Object Web Component Framework function.

Saving Contained versus Referenced Properties

Note these points:

•

A contained property is saved along with the parent.

•

A reference property (if it is a reloadable object) is saved as a reference that is retrieved and set when the parent is re-created.

•

A reference property that is not reloadable will be reloaded as its default value or null when the parent is re-created.

•

Simple types (Strings, Numbers, and so on) cannot be references. Enum types are always references.

For more information, see Writable Data Object.

Setting up RSS Feeds

You can set up a syndication feed for Foglight views, using Really Simple Syndication (RSS) to show frequently updated content. For some Foglight views, such as setting up an RSS feed for alarms, this is an out-of-the-box feature.

In the following example, we create an out-of-the-box RSS feed for the Alarms page.

To create an out-of-the box RSS feed for the Alarms page:


	NOTE: To access the Web Component Framework for creating an RSS feed, you need the role of Cartridge Developer or Dashboard Designer assigned to your username.

1

Under Dashboards, click Configuration > Definitions.

2

Set the Feeds purpose for the particular Alarms page.

3

Determine the dashboard name by viewing the dashboard definition in Configuration > Definitions. The dashboard name is the Reference Id property.

Figure 52. Reference Id property

4

To view the feed for the alarms view, type the URL for the feed such as:

http://<fms hostname>:8080/console/feed/system:core_alarms.28

The RSS feed for the alarms view appears.

Theme and Module Resources

Your modules can contain image files, such as icons, logos, and background images, that can be used in views.

Views can reference images defined in the container module. Some of the referenced images never change, such as product logos. For more information, see Module-Specific Images.

For other types of views, such as localized versions of the same view, you need to create modified versions of the same image and display different versions at different times. For more information, see Theme-Specific Images in Module Definitions.

Related Documents

The document was helpful.

Select Rating

I easily found the information I needed.

Select Rating

© ALL RIGHTS RESERVED. Terms of Use Privacy Cookie Preference Center