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

Editing a Query

Follow this procedure to edit a query. Depending on your permissions, you may not be able to edit a System query or a query created by another user.

To edit a query:

1

In the Module Contents pane, click the Queries tab.

2

Select the User query from the Modules Contents pane.

3

Select Edit from the Definitions pane.

The query definition is displayed.

Deleting a Query

Follow this procedure to delete a query. You can only delete your own User queries. You cannot delete a System query or a query created by another user.

To delete a query:

1

In the Module Contents pane, click the Queries tab.

2

Select the User query from the List frame.

3

Select Delete from the Definitions pane.

A dialog box appears, asking you to confirm the deletion.

Legacy Custom Query

Use Functions instead of Legacy Custom Queries.

In past releases, a Legacy Custom Query was used to return data that may or may not be bound to a specific data source.

Correctly formed Groovy scripts automatically appear as Legacy Custom Queries.

Web Component Framework examples:

•

Time Range chunking

•

Remove duplicates

Foglight examples:

•

Check User Permissions

Functions

Function definitions let you return data of a declared output type given an expected input. They allow users to easily generate possible return values in a way that can be easier than using queries.

The four types of functions are , Map, Script, and Script with Map. They are created in the Functions tab of the Definitions editor. Similar to other type of definitions, Functions can be added, edited, removed, or copied. They also support the common entity attributes. For more information, see Definitions and Entities on page 14.


	NOTE: It is recommended that you obtain the assistance of Sales Engineers or the Professional Services team before beginning to work with Functions.


	NOTE: A handy way to access the API for Foglight is through the browser interface. Under Dashboards in the navigation panel, choose Administration > Tooling > Script Console. In the Query and Scripting Service Tool, click the icon for Script Help, which is at the top right of the Script box. Alternatively, you can type help(server) and click the Run button below the Script box. In the Result area, click Topology Service to see the methods.


	NOTE: When using Functions it is recommended that you write unit tests to ensure correct ongoing behavior. For more information, see Unit Testing Entities on page 15.

Related Documents

The document was helpful.

Select Rating

I easily found the information I needed.

Select Rating

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