The Search Box is a powerful CygNet-aware tool for searching facilities or other objects in your CygNet environment. Two search modes are available:
Facility Search
This mode will search all facilities in the specified Facility service and return any matching facility names. Three options are supported when a desired search result is selected:
- Facility Sender — the Search Box acts as a facility sender and sends the selected facility to any controls on the screen configured to receive it.
- Navigation — the Search Box navigates by facility and links to the selected facility's associated screen. The navigation mode is determined by the Facility navigation mode setting on the screen displaying the Search Box.
- Script — an action can be scripted to execute when a facility is selected from the search results.
You can limit the Search Box to execute a search against a Facility service associated with a current value service (CVS), against a custom filter rule, and against a list of facility attributes. The facility attribute values displayed in the search results are configurable. The facilities displayed in the search results are designated with configurable icons. Grayscale icons are available for use with the dark or light color theme:
| Icon type | Facility - Diamond |
|---|---|
| Default |
|
| Grayscale dark |
|
| Grayscale light |
|
Grayscale icons are available for use with the dark or light color theme. See themes for more information.
Custom Search
In this mode the Search Box can be scripted to perform a custom search against any object, for example, a SQL database, a .csv file, even a website. Further custom actions can be executed when selecting an item in the search results.
Search Box Example
The following image shows a Search Box and a CygNet Grid.
|
Sample Search Box with the Selection action set to Facility sender. |
Property Inheritance
Property inheritance, or sending and receiving, is a widely used concept in Canvas. The application supports an explicit relationship between screens, objects, and controls, where certain property values, such as facilities and SiteService details, are passed from one element to another via an inheritance framework. Screens, objects, and controls can be configured as property senders or property receivers and provide configuration options where you can explicitly define the source of the facility and SiteService. Depending on how you have your screens, objects, and controls configured, the facility and SiteService may be received from any one of the following sources:
- from itself — indicated by selecting <Self> and then explicitly configuring the property
- received from the screen — indicated by selecting Screen, which is always present as a sender
- received from another control — indicated by selecting the Name of the sending control.
Broadcasting
Screens and objects support an additional notification option to broadcast their facility and SiteService selection changes to other open screens. If configured, a <Broadcast> option is available to source the screen's facility and SiteService properties from another open screen.
For example, a Text Tool can be configured to get its facility from the screen and the screen can be configured to get its facility from a Tag Chooser. Or Screen_A might source its facility from Screen_B, which gets its facility from a Tag Chooser.
Receiver or Sender
The Search Box supports property inheritance as a sender of its facility to the screen and to other controls on the screen:
| Receive from | Send to | ||
|---|---|---|---|
| SiteService | Facility | SiteService | Facility |
| self screen |
none | none | other controls |
