Chat now with support
Chat mit Support

Foglight 7.3.0 - Web Component Guide

Introducing the Web Component Framework The Web Component Framework Configuring Views and Context Queries Functions Bindings Additional Components

Context Help

Use this field to tell end users about the purpose of this query. To make the help text available to end users the query must be marked as a UI Query.

If you create a Portal Container by choosing Create Dashboard from the General tab of the action pane, the Data tab becomes available in the action pane. All queries appear here. Context help for the query appears as a tooltip when you hover the mouse pointer over the query’s name. Similarly, if you entered text in the Help area of the Create Dashboard dialog box, it appears when you hover the mouse pointer over its entry in My Dashboards in the navigation pane.

Relevant Roles and Allowed Roles

Relevant Roles are used to act as filters, showing the views a user is interested in and not showing the others. If some but not all Relevant Roles are set on a view, then in some situations the browser interface may not show that view to a user who does not have that role. Even though the view does not show in, say, a list of dashboards, the user can still access the view if there is a page accessible to the user that has a link to the unlisted view.

Allowed Roles act as a security mechanism. If some but not all Allowed Roles are set on a view, then only users for whom at least one of their roles is also an Allowed Role on the view can see or in any way interact with that view.

Roles in View Definitions

Each view can be marked as having zero or more Relevant Roles, and zero or more Allowed Roles. Users are assigned roles and these are matched against the Relevant Roles and the Allowed Roles for a view. This restriction does not apply if the user has the appropriate permission or if the view is in the user's personal module.

•
Each user has Allowed Roles (the roles they are allowed to be in) and Preferred Roles (roles for which this component was designed to be useful). Relevant roles and Allowed roles contain the same list of items as choices.
•
If a view has no Relevant Roles marked, it is assumed to be relevant to all roles. If a view has no Allowed Roles marked, it is assumed to be allowed to be used by all roles.
Roles in Query Definitions

Roles are taken into account when filtering Root Queries by role in the Data Browser when using Create dashboard and Create report.

Each query can be marked as having zero or more Relevant Roles, and zero or more Allowed Roles. This is related to user roles. Users are assigned roles and these are matched against the Relevant Roles and the Allowed Roles for a query.

If a query has no Allowed Roles marked, all roles are allowed to use this query. If some but not all Allowed Roles are set on a query, then only users for whom at least one of their roles is also an Allowed Role on the query can see or in any way interact with that query. This restriction does not apply if the user has CHANGE_SYSTEM_MODULES permission (as determined by the AuthorizationService) or if the query is in the user's personal module.

If a query has no Relevant Roles marked, it is assumed to be relevant to all roles. In some situations, the GUI may not show a query as a choice to a user if the user's roles do not match the Relevant Roles of the query. However, there is an option in those situations to see all queries that are allowed, regardless of Relevant Roles.

Module-Level Roles

Roles can be applied globally to all the views and queries in a module by editing its properties.

To edit module-level roles:
1
Select Dashboards > Configuration > Definitions in the navigation panel.
2
Click the triangular button at the right of a module name in the Module List pane.
3
In the drop-down list that appears, click Edit.
4
In the Edit Module dialog box, select the appropriate Relevant Role(s) and Allowed Role(s).

Sequence of Evaluation

In a complex query, the selected data objects are subjected to the different parts of the query in the following order:

1
The data objects are restricted based on Where, if specified.
2
They are then sorted based on Order By, if specified.
3
Some are then selected based on Filter Results Based on Top N, if specified.
4
The remaining data objects are aggregated (if aggregations are specified).
 
* 
NOTE: For more information about Queries, see the Web Component Tutorial.

Creating New Queries

The Add Query dialog box lets you create a new query or a copy of an existing query.

To create a new query:
1
Select Configuration > Definitions in the navigation panel.
2
In the Module List pane, choose the module in which you want to work. If you are creating queries for your own use, select My Definitions.
3
In the Module Contents pane, select the Queries option from the drop-down list.
The Add Query dialog box appears.
4
On the Create a Blank Query tab, select a Data Source Type that specifies the type of object to be returned by the query. You can use the search box to narrow the choices.
Figure 32. Matching object types
5
Click OK.
A New Query tab opens in the Edit mode of the Definitions pane.
For queries, all settings are on this pane. There are no sub-tabs as there are for more complex things, such as Views.
The edit pane fills with the query editor, which contains all the fields that can be used to construct a query. You must fill in only the fields that are marked by an exclamation point icon () on the right.
6
Type the name you have chosen for your query in the Name field.
Now that the query has been named, it can be referenced by that name when you want to use it.
7
By default, the ID field’s value is <auto>. You may want to give it a more descriptive name, which could be useful for troubleshooting.
8
Select UI Query if the query is to appear in the data browser.
9
If it is a UI query and you want to hide the root, check Hide Root.
10
Select Public if you want to share the query.
11
Ensure that Deprecated is cleared. This check box is used to flag outdated queries.
12
Select Relevant and Allowed roles for this query. For more information, see Roles in Query Definitions.
13
Add any Required Parameters needed by the query.
These are values that are supplied at run time, usually from a context input, that the query will need. You need to specify a Key by which the value may be referenced, whether it is a List (True, False, or Unknown), and choose its Data Type from the Select Type dialog box.
14
Select a data source in Root Reference from the choices in the From field. Typically, its value is Monitoring, or if you want to have the search start from a required parameter, choose it from the Parameters node.
15
Select the Object Type by clicking the drop-down arrow at the right of the Path field.
Choose the object from the drop-down list of data objects. If you have chosen the Monitoring data source, this list is a replica of the nodes in the Data browser under Management Server > All Data. For any other data source, it is the list of available entities for that source.
A list of all the objects known to the running Foglight instance appears.
16
Objects are grouped at some level down from the root. Choose the object you want from the drop-down list in the with Path field. You might need to set the Max Search Depth field as well.
17
You can have the query return aggregate values by setting Aggregations.
18
You can filter results by specifying a value for N, either by giving it a specific value or by declaring a parameter that returns a value. You can also choose to include Everything except the top N for the case where you want to show the top N somewhere and the rest somewhere else.
19
You can sort the returned result by choosing a data object’s property, such as its name.
20
You can use a Where clause to use a condition to limit the returned objects to the ones that match the criterion.
21
You can test the query by clicking the Test button at the top of the Edit pane.
The Query Results dialog box appears, showing the name or names of the servers returned by the query and, in this case, the Data Type of the object, which is Host. The Value field is empty because there is no numerical value associated with objects. Simple types have values, objects do not.
 
* 
IMPORTANT: You can see that the query did return a list of objects by clicking the expand icon (+) at the left any host name in the Query Results dialog box. When you do, you’ll see that some properties of the host, such as its topologyObjectId and topologyObjectVersionId, have numerical values, while others, such as agents, which are themselves objects, do not. The Query Results dialog box allows you to see all the properties of the object, which is useful if you want to determine their names for use later on.
 
* 
IMPORTANT: The topologyObjectId and topologyObjectVersionId properties mentioned in the previous note should not be used to select a particular object. If you do need to use a specific object in a custom view during a running session it is better to set an additional context value of type Data, type in a name for the Key, and navigate to the particular runtime object in the Context Entry dialog box This is a much more efficient way of directly accessing the object rather than causing the system to search all objects until an ID match is found.
22
It is recommended that you fill in the Comments and Context Help text boxes.
23
Click Save to save the query.
Verwandte Dokumente

The document was helpful.

Bewertung auswählen

I easily found the information I needed.

Bewertung auswählen