Chat now with support

Get Live Help
Complete Registration

Sign In

Request Pricing

Contact Sales

Foglight 5.9.1 - 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

Icon

Table 20. Theme properties
Property	Description
Color	A chooser allows you to accept colors from a palette.
Custom	Allows you to input component, style and value strings.

Icon selection is how you specify an Icon binding. The Icon selection allows a user to select a specific icon (as defined in the Icons tab of one of the modules), and attach an Icon Renderer. The Icon Renderer controls the size of icon that is drawn.

An Icon has the following properties:

Table 21. Icon properties
Property	Description
	A drop-down list allows you to choose an icon from the existing group of System icons, or ones that have been added to user modules. For more information, see Type Mappings.
Renderer	A drop-down list allows you to choose a renderer from the existing group of System renderers, or ones that have been added to user modules. See Renderers .

String Template

A String Template binding evaluates to a string or list of strings. Unlike a simple string, this binding accepts parameters that can partly determine its value.

A String Template has the following properties:

Table 22. String Template properties
Property	Description
Value	A text box allows you to type a value for the string. Parameters are permitted.
Renderer	A drop-down list allows you to choose a renderer the existing group of System renderers, or ones that have been added to user modules. See Renderers .
Parameter block	Allows you to choose a binding for On Null, or any other parameter that has been declared in the Value box.

Parameters are added to the String Template through standard 0-based arguments common in programming. The first parameter is substituted for the text {0}, the second for {1}, continuing for each sequential number. For example, the String Name Machine{0}, Application{1} with parameters that evaluate to One and Two, returns the value Name, MachineOne, ApplicationTwo.

If the parameter evaluates to a list, then the String also evaluates to a list, repeating the string for each value in the list.

For example, suppose the String Name: {0} has a parameter that evaluates to a list of server names:

•

•

•

Then the String binding evaluates to the following list:

•

Name: MachineOne

•

Name: MachineTwo

•

Name: MachineThree

A renderer can also be specified for a String binding.

Rich Text and Rich Text Template

The Rich Text data value is the same String Template, but permits some XHTML in its content. There are no block-level constructors. For more information see String Template. A renderer cannot be chosen. Any formatting must be controlled by the use of XHTML tags.

The Rich Text Template allows parameters to be set as well. A Rich Text Template has the following properties:

Table 23. Rich Text Template properties
Property	Description
Value	A text box allows you to type a value for the string. Parameters are permitted as well as XHTML.
Parameter block	Allows you to choose a binding for On Null, or any other parameter that has been declared in the Value box.


	CAUTION: Any unexpected interactions between custom HTML used in Rich Text and the Web Component Framework are the responsibility of the Rich Text creator. They must be tested in all supported browsers and may need changing from release to release.

Image Reference

A reference to an image that is specified by its URL.

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