Foglight 5.9.1 - Web Component Guide

Comments

Creators of view components use this field to communicate information that might be helpful to other developers in creating similar components.

Context Help

Use this field for context sensitive help text. If the component is a top-level view, whatever you type here appears in the right action pane under the Help tab.

If the view is within a container and its border is showing, context sensitive help is available by clicking on the help icon in the view’s title bar.

For a dashboard, the help text appears as a tooltip when the mouse pointer hovers over its entry in the navigation panel. It also appears when a user chooses this component from the drop down list in the Help tab in the action panel.

Context tab

Context packages the values that the page or view requires to present its data. For more information, see Context Types.

Pages and views are similar to forms waiting to be completed. Their definitions can specify the type of data that they display, just as a form can require a name or an address, which are filled in when the form is used. They do not set specific values for the item(s) that specify the subject of the form. For views, this is provided by the context data during run time, which is declared in the Context tab and is set in the Additional Context group for the current view or page. If a context has been set by some view, it can be used in other views by declaring it in that view’s context.

Context Inputs

If the context of a page has been set, then a view can use that value by specifying the named value of the context. (For more information, see Context Tab.) For example, a Host page sets its current host into the context using the key host. A flow to another view uses that context by setting its context input (the expected context value) to use host as its key.

Similarly, if a page has a given named value in its context, and a link takes it to another page, then that new page can get access to that value by specifying its key as a context input.

Context can be passed when moving from one page to another. For example, click on a link in the Hosts view, and the Host Monitor page is displayed with data for the same host. In this case, the Host Monitor page expects that:

The host is set in the Context Inputs section and hosts is set in Additional Context.

If a view is not passed the required context input, it uses the persisted value, if there is one. For example, if a child view is a table and selectedRow is passed on an Update flow to its container, the container must have selectedRow defined as an Internal key. For a discussion of the types of context, see Context Types .