Chat now with support

Get Live Help
Complete Registration

Sign In

Request Pricing

Contact Sales

Foglight 7.1.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

Enumeration Types

Enumeration values can be specified for Enumeration types.

At least one enum value must be defined. The following attributes may be set:

•

Value: The value that represents the enum value

•

Name: The display name of the enum value. The value specified in the editor is used as the value for the base locale.

•

Description: The description of the enum value. The value specified in the editor is used as the value for the base locale.

Creating a Data Object of your Type

Instances of your type are created in one of the following ways:

•

With the Create Binding mechanism that is available when specifying context or binding to entity properties.

•

In JavaTM or Groovy WCF via the FunctionHelper’s createDataObject() method.

Parameters to the creation mechanism are:

•

Type: The type you want to create. You can only select from Data Object types (not including Enum types) from the Common Data Source or other UI Types.

•

Storage: This is the persistence mechanism to use to “save” this object. The create method will try to load this object from the storage mechanism specified and create a new instance of it if it does not exist.

•

None: This object cannot be stored and is meant to be transitory (used on the page or passed through the context).

•

Site: Enables the object to be stored in a global location that is accessible to all users. If multiple users are changing the object at once from different sessions then the last copy of the object saved will be persisted.

•

User: This object is stored per user so that each user has a different copy of this object. This is useful to remember a user’s particular choices.

•

Session: This object is stored in the user’s http session. Calling save is not necessary to persist changes, since the single live instance is stored in a session-owned cache. The object is released when the user logs out or the object’s remove method is called.

•

Object ID: It should use the form XXXXX-YYYYY, where:

•

XXXXX is your domain identifier. For example, java, oracle, ops, admin

•

YYYYY is the identifier for the object. For example preferences, socFilter, etc.

An object that is created from scratch has all of its properties set to their default values.

Objects created using this mechanism are not time range sensitive.

Objects loaded from the Site and User Storage mechanisms are always loaded from the store and not persisted in any cache other than the Web Component Framework page context if they are used within it. Note that these object are not in Web Component Framework pages in the same way that Topology objects are.

Equality

Data Objects created through this mechanism are considered equal if their uniqueIds are equal.

Saving Data Objects

Changes to an object are persisted when the object is acted upon by calling the object’s save()method or by using the WCF/Common/Save Data Object function to do this for you.

An object that has not been created with a storage mechanism of either Site, User, or Session cannot be saved.

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