Chat now with support
Chat with Support

Foglight 5.9.5 - Web Component Guide

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

Searching for Definitions

The Module Contents pane on the Definitions dashboard shows the dashboards that you can access based on your user permissions. Every dashboard can include one or more preconfigured views, queries, functions, files, icons, associations, renderers, types, type mappings, unit mappings, and tasks. The search feature allows you to search for various dashboard definitions contained in one or more selected modules, such as functions, queries, renderers, tasks, types, and views.

Selecting All Definitions in the Module List pane allows you to search for components across all modules and all definition types. Selecting a specific module limits the component search to that module and any of its child modules, if they exist.

There are two modes for searching: by typing the desired text into the search box (simple mode), or by specifying one or more search rules (advanced mode).

In simple mode, the following definition elements are searched:

•
Definition names and IDs
•
Function return types
•
Query return types
•
Renderer components
•
Task components
•
Super types of a type
•
View components

In advanced mode, you specify one or more search rules, and indicate if you want one or all rules to return a match. The following elements can be searched for in a rule:

•
Definition names and fully-qualified IDs
•
Module names or IDs
•
Definition components (views, renderers and tasks only)
•
Definition type-specific text, including:
•
Function return types
•
Query return types
•
Renderers (value data source type, value data type)
•
Super types of a type
•
View purposes, custom purposes, relevant roles, and allowed roles
•
Comments (excludes file components) and descriptions (types only)
•
Definition’s context help (excludes types and files)
•
Last modified time (excludes types and files)
•
Public fields (excludes types, files, type mappings, and unit mappings)
•
Deprecated fields (excludes types, files, type mappings, and unit mappings)
 
* 
TIP: The User Preferences setting, Show deprecated definitions, indicates if deprecated entities are considered in a search. However, if a rule in an advanced search uses the Deprecated field, the Show deprecated definitions setting is ignored, and the search results include definitions that match the rule with the Deprecated field.
To issue a simple search:
1
From the navigation panel, under Dashboards, click Configuration > Definitions.
2
In the Module List pane, select the module containing the definitions you want to search.
 
* 
TIP: To search through all definitions, select All Definitions.
3
If you selected a specific module, in the Module Contents pane, select the definition type that you want to search. Click Views and select the desired definition type. For example, to look for a specific query, select Queries in the list.
4
Optional—Use a regular expression to issue a search.
a
In the Module Contents pane, in the Search Definitions box, click .
A menu appears.
Figure 11. Search menu
b
Select Use Regular Expressions in the menu.
5
In the Module Contents pane, type the text pattern in the search box.
6
Click .
The Module Contents pane refreshes, showing a list of definitions that match the text pattern.
Figure 12. Definitions matching a specified text pattern
7
To clear the search results, click .
The Module Contents pane refreshes, showing a list of all definitions of the selected type.
To issue an advanced search:
1
From the navigation panel, under Dashboards, click Configuration > Definitions.
2
In the Module List pane, select the module containing the definitions you want to search.
TIP: To search through all definitions, select All Definitions.
3
If you selected a specific module, in the Module Contents pane, select the definition type that you want to search. Click Views and select the desired definition type. For example, to look for a specific query, select Queries in the list.
4
In the Module Contents pane, in the Search Definitions box, click .
A menu appears.
Figure 13. Search menu
5
Click Advanced Search in the menu.
The Advanced Search dialog box appears.
Figure 14. Advanced Search
6
Specify one or more rules to search for definitions.
For example, to search for the definitions that contain the word “alarm” in the Comment field, compose the following rule:
Figure 15. Advanced Search rules
•
To add or remove rules form the search, in the Advanced Search dialog box, use the Delete Rule and Add Rule buttons , as required.
•
If you have multiple rules in the search, indicate if you want one or all rules to return a match by making the appropriate selection.
Figure 16. Advanced Search parameters
7
Click Search.
The Module Contents pane refreshes, showing a list of definitions that match the advanced search.
Figure 17. Matched definitions
 
* 
TIP: The search box shows Advanced Filter On, indicating that the entries in Module Contents pane are retrieved by an advanced search.
8
To clear the search results, click .
The Module Contents pane refreshes, showing a list of all definitions of the selected type.

Definitions Page for a View

View Commands in the Definitions Area

The following commands are available for working with existing views in the Definitions area:

•
Add: Create a new view.(for creating new views only. This option appears in the Module Contents pane).
•
Convert To: Convert the view type. Some view components allow conversion to another component type. For example, Grid Layout, Columns Layout, Rows Layout, and Splitter Layout can be converted to a different layout type. Additional view components may also be enabled for conversion.
 
* 
TIP: To find out which conversion options are available for a particular view component, select it in the Module Contents pane. If a Convert To button appears in the Definitions Pane, the selected component is enabled for conversion. To find out to which view components you can convert the selected component, click Convert To and review the options in the menu that appears.
•
Copy: Make a copy of an existing definition. See Deep Copying Views .
•
Edit: Switch the Definitions pane from view mode to edit mode.
•
Move: Relocate a non-public view to another module with a common ancestry, for the purpose of changing its ID. Public views cannot be moved. The tree of target modules that appear available for selection reflect that restriction. The movement is restricted to modules with a common ancestry because the view may have a reference to another non-public entity, and moving it outside of that tree makes the reference invalid.
•
Relocate views: Only for System modules, and the view must be public to move it outside its current module hierarchy.
•
Remove: The component from the module.
•
Test: Show the completed view in a test container.
•
Validate: Check that the view meets certain consistency requirements.

These commands are available in edit mode:

•
Cancel: In edit mode, cancel editing and do not save changes.
•
Config Wizard: Only for tables, allow column assignment using a wizard.
•
Save: In edit mode, save the definitions for this component.
•
Test: Show the view in a test container while it is under construction.

You can find these functions in the Definitions pane in Configuration > Definitions.

Editing a View

Select the My Definitions node containing your view from the Module List pane, select the view you want to modify, then click Edit () in the Definitions Pane toolbar.

 
* 
NOTE: For more information, see “Definitions Pane Settings Tabs” on page 44.
Saving a View

To save a view, the name field and required properties must be defined. Ensure that the view you want to save is in the Definitions Pane, and then select Save () from the Definitions Pane toolbar.

Removing a View

Ensure that the view you want to delete is in the Definitions Pane, and then select Remove () from the Definitions Pane toolbar. A dialog box is displayed asking you to confirm the deletion. You can only delete views for which you have the proper permissions. You cannot delete a view if there are references to it. A public view cannot be deleted because modules from other cartridges that are not currently loaded might reference it. It is possible to delete a public view by forwarding. The view is deleted, but it remains as a pointer to the newer replacement view.

Deep Copying Views

Ensure that the view you want to copy is in the Definitions Pane, and then select Copy > Deep from the Definitions Pane toolbar.

Figure 18. View Copy menu

Deep copying a view copies the selected view and the related entities, including any localized strings that are referenced using that view to the current module. References to public definitions in the same module as the view being deep copied are copied as well (unless copies of such already exist in the target module). References to public definitions in other modules are not copied.

It takes into account:

•
Context entries (view, flow, window) that are bindings, which may have references to queries, renderers and localized strings.
•
Configuration property values that are set to bindings, which may have references to queries, renderers and localized strings.
•
Configuration property values of type renderer, which when set have references to renderers.
•
Flow, which may have references to tasks and to other views.
•
Derived queries that are based on other queries.
•
Container views that have references to other views.
•
Function scripts that may reference other functions or queries.
Notes:
•
Views containing non-public components are not supposed to be copied, but they can be deep copied. Also, you can perform a normal copy and choose which of the private views you require.
•
The view to be deep copied must not be in the current module.
•
All referenced views to be included in the deep copy must have their allowed roles satisfied by the roles of the current user.
•
User modules do not have their own resource bundle, therefore if you deep copy a view into a user module, references to localized strings are not deep copied. The references are left as is and continue to refer to the original localized string.
Converting a View

The Convert To button allows you to convert one view component to another without the trouble of copy and replace operations.

Figure 19. View Convert To menu

For example, if a Rows Layout component is configured and then you decide a Grid Layout is more appropriate, simply convert the Rows Layout component to a Grid Layout. The types of view components that you can convert to depend on the selected component. For example, a Rows Layout can be converted to a Columns Layout, Splitter Layout, or Grid Layout, while a Grid Layout can only be converted to a Rows Layout or Columns Layout. Additional conversion options may be available.

 
* 
TIP: To find out which conversion options are available for a particular view component, select it in the Module Contents pane, in the Definitions Pane click Convert To, and review the options in the menu that appears.

When the conversion is complete, the converted component should be verified to ensure it displays as expected. For example, when a layout is converted, check if the child views are laid out properly.

View Commands in the Definitions Area

Definitions Page for a View

The following commands are available for working with existing views in the Definitions area:

•
Add: Create a new view.(for creating new views only. This option appears in the Module Contents pane).
•
Convert To: Convert the view type. Some view components allow conversion to another component type. For example, Grid Layout, Columns Layout, Rows Layout, and Splitter Layout can be converted to a different layout type. Additional view components may also be enabled for conversion.
 
* 
TIP: To find out which conversion options are available for a particular view component, select it in the Module Contents pane. If a Convert To button appears in the Definitions Pane, the selected component is enabled for conversion. To find out to which view components you can convert the selected component, click Convert To and review the options in the menu that appears.
•
Copy: Make a copy of an existing definition. See Deep Copying Views .
•
Edit: Switch the Definitions pane from view mode to edit mode.
•
Move: Relocate a non-public view to another module with a common ancestry, for the purpose of changing its ID. Public views cannot be moved. The tree of target modules that appear available for selection reflect that restriction. The movement is restricted to modules with a common ancestry because the view may have a reference to another non-public entity, and moving it outside of that tree makes the reference invalid.
•
Relocate views: Only for System modules, and the view must be public to move it outside its current module hierarchy.
•
Remove: The component from the module.
•
Test: Show the completed view in a test container.
•
Validate: Check that the view meets certain consistency requirements.

These commands are available in edit mode:

•
Cancel: In edit mode, cancel editing and do not save changes.
•
Config Wizard: Only for tables, allow column assignment using a wizard.
•
Save: In edit mode, save the definitions for this component.
•
Test: Show the view in a test container while it is under construction.

You can find these functions in the Definitions pane in Configuration > Definitions.

Editing a View

Select the My Definitions node containing your view from the Module List pane, select the view you want to modify, then click Edit () in the Definitions Pane toolbar.

 
* 
NOTE: For more information, see “Definitions Pane Settings Tabs” on page 44.
Saving a View

To save a view, the name field and required properties must be defined. Ensure that the view you want to save is in the Definitions Pane, and then select Save () from the Definitions Pane toolbar.

Removing a View

Ensure that the view you want to delete is in the Definitions Pane, and then select Remove () from the Definitions Pane toolbar. A dialog box is displayed asking you to confirm the deletion. You can only delete views for which you have the proper permissions. You cannot delete a view if there are references to it. A public view cannot be deleted because modules from other cartridges that are not currently loaded might reference it. It is possible to delete a public view by forwarding. The view is deleted, but it remains as a pointer to the newer replacement view.

Deep Copying Views

Ensure that the view you want to copy is in the Definitions Pane, and then select Copy > Deep from the Definitions Pane toolbar.

Figure 18. View Copy menu

Deep copying a view copies the selected view and the related entities, including any localized strings that are referenced using that view to the current module. References to public definitions in the same module as the view being deep copied are copied as well (unless copies of such already exist in the target module). References to public definitions in other modules are not copied.

It takes into account:

•
Context entries (view, flow, window) that are bindings, which may have references to queries, renderers and localized strings.
•
Configuration property values that are set to bindings, which may have references to queries, renderers and localized strings.
•
Configuration property values of type renderer, which when set have references to renderers.
•
Flow, which may have references to tasks and to other views.
•
Derived queries that are based on other queries.
•
Container views that have references to other views.
•
Function scripts that may reference other functions or queries.
Notes:
•
Views containing non-public components are not supposed to be copied, but they can be deep copied. Also, you can perform a normal copy and choose which of the private views you require.
•
The view to be deep copied must not be in the current module.
•
All referenced views to be included in the deep copy must have their allowed roles satisfied by the roles of the current user.
•
User modules do not have their own resource bundle, therefore if you deep copy a view into a user module, references to localized strings are not deep copied. The references are left as is and continue to refer to the original localized string.
Converting a View

The Convert To button allows you to convert one view component to another without the trouble of copy and replace operations.

Figure 19. View Convert To menu

For example, if a Rows Layout component is configured and then you decide a Grid Layout is more appropriate, simply convert the Rows Layout component to a Grid Layout. The types of view components that you can convert to depend on the selected component. For example, a Rows Layout can be converted to a Columns Layout, Splitter Layout, or Grid Layout, while a Grid Layout can only be converted to a Rows Layout or Columns Layout. Additional conversion options may be available.

 
* 
TIP: To find out which conversion options are available for a particular view component, select it in the Module Contents pane, in the Definitions Pane click Convert To, and review the options in the menu that appears.

When the conversion is complete, the converted component should be verified to ensure it displays as expected. For example, when a layout is converted, check if the child views are laid out properly.

Nested Views in the Add View Dialog of a Container

You have the option when adding views to a container of choosing Select existing view or Create a nested view. Many Nested views are private views that are contained only in the specific container.

When creating a nested view, the Context tab allows the user to define additional context for the nested component. All context inputs of the nested view are read-only.

A context input of a nested view might be converted to an optional, implicit context input. This can happen if the nested view has an action configured that has flow context mapping that is used for input which causes an implicit (optional) context input to be created.

Related Documents

The document was helpful.

Select Rating

I easily found the information I needed.

Select Rating