Chat now with support

Get Live Help
Complete Registration

Sign In

Request Pricing

Contact Sales

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

Name

This is a required field. You cannot create a new query with the same name as another query in the same module. A warning icon () is displayed if this happens.

ID

Each query is tagged with an ID that is used as an internal identifier. Normally you would leave this field with its default setting, which is (auto).

UI Query

UI queries have the following features:

•

Are marked as UI Query in the definitions pane when editing a query

•

Must not have any required parameters

•

Must have a relevant role set

•

Have IDs that are set automatically, but you can set a more descriptive ID. This can be useful in certain cases. For instance, if the ID appears in a log message it is easier to identify the component if it has been given a descriptive ID.

•

Appear in the Data browser, and in the Data tab when using Create dashboard and Create report as the starting point for exploring contained data.

•

Act as a useful filter by domain to help users find data

•

Act as a weak security mechanism.

Select the UI Query box to mark the query as a UI Query. UI queries (and their execution results) are listed in the Data browser and the Data tab when using Create dashboard and Create report. They provide a way to organize the data presented in those locations.

The Hide Root check box is only enabled if UI Query is selected. If selected, when the results of the UI query are shown in the Data Browser or the Data tab using Create dashboard or Create report, the first item in the results list is hidden. If the query results list does not contain one item, then this option is ignored. This is useful when you know that the results of the query will always return one item and you want to save users having to expand the node corresponding to the one item in order to see its children. For example, if you have a query that returns the root of a data source, hiding that root is useful so that users can more easily get to the data that is really of interest.

If you have a Dashboard Designer or a Cartridge Developer role, you can see the entire data structure in Dashboards > Configuration > Data > Management Server > All Data.

Public

By default, queries are accessible from the module in which they are defined. If a query is marked as Public, it can be accessed from any module. For more information, see Public Entities.

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