Chat now with support

Get Live Help
Complete Registration

Sign In

Request Pricing

Contact Sales

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

Parameters in Bindings

Most types of bindings have parameters. These are placeholders nested within the binding that are also evaluated at run time. An example is a String Template binding set to Host: {0}. In this case Host: is a fixed string, while {0} is a reference to a parameter that evaluates to the name of the host server by configuring that association to a particular dynamic context at the time when the String Template binding is being defined. Each description of the binding type explains how to use parameters.

Figure 4. Binding parameters


	CAUTION: Any quotation mark you use in the parameterized string must be escaped. For example, if the text string that you want to use is The host’s name is: {0}, you must escape the apostrophe using the back slash character ‘\’ as follows: The host\’s name is: {0}.If the text string includes a back slash character ‘\’, use double back slashes, “\\” to represent the back slash in the string.

For more information, see Bindings.

On Null Values

Most types of binding have an associated On Null binding. This provides an alternate value that can be used if the main binding evaluates to null (nothing) or an empty list of values.

Renderers

A renderer may be specified on each type of binding. A renderer determines how the evaluated value is displayed. For example, a limit to the length of a string, the number of decimal places, or the date and time format. If no renderer is specified, then a default renderer based on the object’s type is used. Therefore, in most cases, an explicitly set renderer is not required.

Null and error renderers, noted earlier in the list of simple types, are special cases of renderers. They are only used to display no data or error information. Unlike normal renderers, they do not base their behavior on the data being rendered, but instead have fixed outputs. A drop-down menu lists all the available renderers. Generally, you can determine which renderer to select based on its name. If no renderer is specified, renderers are looked up from the type, property and unit of the value. If no renderer is found, a default renderer is used. Therefore, in most cases, a renderer is not required.

For more information, see Renderers.

Default Values

If a property has a default value it is displayed as text beside the edit icon in the Value column of the tree table in the Configuration tab. A property that has been configured to use a specific value can be set back to its default property by clicking the Edit icon, then selecting Clear to default from the drop-down menu.

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