0% found this document useful (0 votes)
11 views2 pages

CAF Application Search Bar Portlet Guide

Uploaded by

Meghana S
Copyright
© All Rights Reserved
We take content rights seriously. If you suspect this is your content, claim it here.
Available Formats
Download as DOCX, PDF, TXT or read online on Scribd
0% found this document useful (0 votes)
11 views2 pages

CAF Application Search Bar Portlet Guide

Uploaded by

Meghana S
Copyright
© All Rights Reserved
We take content rights seriously. If you suspect this is your content, claim it here.
Available Formats
Download as DOCX, PDF, TXT or read online on Scribd

CAF Application Runtime Configuration—

Search Bar Portlet


Portlet Title Search Bar
Portlet Name wm_caf_app_runtime_config___searchbar
Portlet File
wm_caf_app_runtime_config.war
Name
Top-level
admin
Folder
JSR168
Yes
Portlet?
Alias /portlet/wm_caf_app_runtime_config___searchbar
Default Folders > Administrative Folders > Administration
Instances of Dashboard > Configuration > CAF Application Runtime
the portlet Configuration

Configuration. Administrators use this portlet to search for CAF


applications that are deployed to the current My webMethods
Server instance. After locating a CAF application, the administrator can
configure the run-time settings of the CAF application.

In the My webMethods Server user interface, the CAF Application Runtime


Configuration page contains both the Search Bar and Search
Result portlets. The Search Bar portlet matches the value an
administrator supplies in the search keyword field against CAF application
names to find records to display in the search results. To display the
results in the Search Result portlet, the Search Bar portlet's Last Search
State (lastSearchState) property is wired to the Search Query
(queryString) property of the Search Result portlet.

Properties
Initial Search Tab (initialSearchTab)
Identifies the initial tab to display. Specify one of the following:
 simpleSearch – Default. Display the portlet with
the Keyword tab open.
 savedSearches – Display the portlet with the Saved tab open.
 savedSearches/details – Display the portlet with the Saved tab
open and the saved search details expanded.
Initial Selected Saved Search (initialSelectedSavedSearch)
Identifies the saved search to load when initially displaying the
portlet. Specify the name of any saved search that is associated
with the portlet instance. If the property has no value, the portlet
does not pre-load a saved search.
Run Search On Display (runSearchOnDisplay)
Indicates whether you want the portlet to automatically execute a
saved search when it initially displays. Specify one of the following
values:
 true – Execute the saved search identified by the Initial
Selected Saved Search (initialSelectedSavedSearch) property.
This simulates the user clicking Go in the Search Bar control.
 false – Default. Do not execute the saved search.
No Max Results (noMaxResults)
Indicates whether you want to limit the number of the search results
to display. Specify one of the following values:
 true – Do not limit the search results; that is, display all the
results.
 false – Default. Limit the search results to the number
specified by the Max Results (maxResults) property.
Max Results (maxResults)
Defines the maximum number of search results to display. Specify a
positive whole number. The default is 200.

Common questions

Powered by AI

Allowing unlimited search results through the No Max Results setting can be advantageous for comprehensive data retrieval, ensuring that users access all pertinent information without overlooking potentially relevant results. However, this could also lead to performance issues, such as increased loading times and cluttered user interfaces, especially with large datasets. Balancing user needs and system performance becomes crucial in configuration .

An administrator can control the number of results displayed by configuring the No Max Results (noMaxResults) and Max Results (maxResults) properties. Setting No Max Results to 'true' will allow all results to be displayed without limitation, while setting it to 'false' (the default) will restrict the number of results based on the value specified in Max Results, which defaults to 200 .

The CAF Application Runtime Configuration supports administrative tasks by providing a centralized interface for searching and configuring run-time settings of CAF applications deployed on the My webMethods Server. Administrators can refine their searches using specific keywords, manage search behavior with settings like maxResults and initialSearchTab, and automate search actions with runSearchOnDisplay, optimizing configuration management efficiency .

The configurations available for controlling the initial display of the Search Bar portlet include the Initial Search Tab (initialSearchTab), which determines the default tab to display (simpleSearch, savedSearches, savedSearches/details), and the Initial Selected Saved Search (initialSelectedSavedSearch), which identifies the saved search to load initially if associated. Additionally, the Run Search On Display (runSearchOnDisplay) setting controls whether a saved search executes automatically upon initial display .

The Search Bar portlet in the CAF Application Runtime Configuration interacts with the Search Result portlet by matching the administrator-supplied search keyword against CAF application names to identify records. The Last Search State (lastSearchState) property of the Search Bar portlet is wired to the Search Query (queryString) property of the Search Result portlet, allowing it to display the search results based on the matched criteria .

An administrator might choose to pre-load a saved search using the initialSelectedSavedSearch property in scenarios where repetitive tasks are routine, and consistency in search criteria is critical. This could be beneficial in environments with standardized workflows, where specific data is frequently referenced, or when onboarding new applications, ensuring quick access to critical configurations without manual search initiation each time .

Setting runSearchOnDisplay to 'true' enhances user experience by automatically executing a saved search when the portlet is initially displayed. This simulates the user action of clicking 'Go' in the Search Bar control, thus streamlining the workflow and allowing users to immediately see and interact with search results without extra steps. However, it also assumes that the initial search context is relevant to the user's needs .

The settings maxResults and noMaxResults jointly determine the number of search results displayed. If noMaxResults is set to 'true', all search results are displayed regardless of quantity. If set to 'false', the display is limited by the maxResults value, which specifies the maximum number of results. The default configuration limits results to 200 entries unless manually adjusted .

The configuration settings of a CAF application can be managed through the My webMethods Server interface by using the CAF Application Runtime Configuration page, where administrators can search for deployed CAF applications using the Search Bar portlet and subsequently configure their run-time settings. This process involves using search keywords to locate applications, adjusting settings, and potentially setting initial configurations for predefined searches .

The initialSearchTab property determines which tab is displayed first when the Search Bar portlet is loaded, thereby significantly guiding user interaction by setting the context for searches. A setting of 'simpleSearch' defaults to the Keyword tab, which prompts users to perform direct keyword searches, while 'savedSearches' opens the Saved tab, encouraging the use of previously stored searches. 'savedSearches/details' further guides users by expanding the search details, making it easier to manage and execute detailed searches from the onset .

You might also like