立即与支持人员聊天

获得即时帮助
完成注册

登录

请求定价

联系销售人员

Foglight 5.9.5 - Web Component Guide

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

Using Functions

Similar to queries, Functions are called as a binding, in this case the Function binding. For more information, see Bindings.

Functions as Converters

A function can be marked as a Converter. A Converter is a function that takes data of one type as input and converts it to data of another type.

A registry is automatically kept of such Converters and components can request a Converter for an input/output type when needed.

Only functions that take a single (non-List) input and that have a single (non-List) output are allowed to be Converters. Only one Converter can be registered for a given pair of input/output types. If there are many Converters that can handle an input/output type pair, only the most recently loaded one will be registered and a warning message will be logged. Converters are loaded upon start up of the system, or when a module is imported/deleted, or when a Function is edited and saved.

Caching results of Functions

If a Function is referred to in Additional Context, the result value of the Function may be calculated many times (due to how View Components are initialized).

If you know that your Function will output the same value given the same Time Range and Function parameters, then you can avoid the redundant calculations by checking the Cache Results checkbox in the Function editor for the Function Definition in question.

Information available from a Script, Script with Map or Java Function

From within a JavaTM, Script or a Script with Map Function, a special FunctionHelper class is available for accessing additional information. See the javadoc for that class for more details on what information is available.

For Java Functions, FunctionHelper objects are passed as a parameter to the specified Java method.

For Script or Script with Map Functions, the FunctionHelper class is accessible through the reserved script parameter, functionHelper. To make things easier, the argument values of function parameters can also be accessed by directly referencing the name of the parameter. The reserved script parameters are also available:

•

resourceBundle: The Java Resource Bundle for the current locale with strings loaded from the module’s file strings.properties (uploaded using the Files tab available under Configuration > Definitions).

•

specificTimeRange: The current SpecificTimeRange. This value should always be passed when you access property values of any time-sensitive data object. For example:

To get property b, instead of writing:

Write the following:

x = a.get("b", specificTimeRange);

Since these parameter names are reserved, they cannot be used as the name for declared Script or Script with Map Function parameters. The reserved script parameters should be referenced using the same notation used for other script parameters.

For Java Functions, these are available via the corresponding getter methods of the FunctionHelper parameter. The table shows the methods in FunctionHelper:

Table 15. FunctionHelper methods
Return Type	Method Name	Description
WritableData Object	createDataObject( String typeName, String storage, String objectId)	Creates a writable data object.
Map<String,?>	getArguments()	Returns a Map containing the argument values for the function's parameters.
Locale	getLocale()	Returns the user locale.
ResourceBundle	getResourceBundle()	Returns the ResourceBundle for the current Locale, loaded from the strings.properties file in the module to which the function belongs.
SpecificTimeRange	getSpecificTime Range()	Returns a SpecificTimeRange whose start/end dates are computed based on the TimeRange when the function was invoked.
Calendar	getTimestamp()	Returns the current timestamp.
String	getUser()	Returns the name of the current user.
String	getUserModule Name()	Returns the name of the user module.
String	getViewId()	Returns the ID of the view for the current view component.
Object	invokeFunction( String fqId, Object... arguments)	Invokes a function. Used for invoking a function within another function.
List<?>	invokeQuery( String fqId, Object... arguments)	Invokes a query.

相关文档

The document was helpful.

选择评级

I easily found the information I needed.

选择评级

© 2024 Quest Software Inc. ALL RIGHTS RESERVED. Feedback 使用条款隐私 Cookie Preference Center