advancedsearch Element |
|
Content |
|
advancedsearch Element |
Description |
The advancedsearch Element executes queries to populate a List page. This Element also organizes the presentation of retrieved SDIs.
Options |
Properties provide the capability to search by:
• | Text string | • | Scanned identifier | |
• | SQL query | • | User-defined folders | |
• | Categories | • | Adhoc Queries |
You can also write your own JavaScript function to accept values passed to it by the "Basic", "Query", and "Category" search options (set by the "Search Callback JavaScript" property), and the "GroupBy" option (set by the "GroupBy Callback JavaScript" property).
Example |
Sidebar |
![]() |
|
|
Top Search |
![]() |
About Search by Folder... |
This has two display styles: Toolbar (shown above) or Dropdown (displays options in a dropdown list).
When used with an SDI List Page:
• | Add adds selected SDIs to the chosen Folder. The quantity is displayed
in parentheses.
...to a new Folder creates a new Folder when you click Add, then adds the selected SDIs to it. |
• | Remove removes selected SDIs from the chosen Folder. |
• | Clicking a Folder hyperlink loads the Folder's SDIs into the List Page. |
The Toolbar style provides operational buttons (the Dropdown style offers these choices in the dropdown):
Button | Function |
plus | Adds a new Folder. |
circle | Shows contents of the selected Folder (loads contents into the SDI List Page). |
ellipsis | Renames the selected Folder (prompts for the new name). |
cross | Deletes the selected Folder. |
up-arrow | Moves the selected Folder to the top of the Folder list. |
down-arrow | Moves the selected Folder to the bottom of the Folder List. |
advancedsearch Element Properties |
See the Example for a representative depiction of the advancedsearch Element within a List Page.
Property Name | Description | ||||||||||||||||||||||||||||||||||||||||||||
SDC | Identifier of the SDC for the SDIs retrieved by query. | ||||||||||||||||||||||||||||||||||||||||||||
Enable and Show Search Bar | "Yes" (default) shows the Element in the List Page. | ||||||||||||||||||||||||||||||||||||||||||||
Show Search Bar Initially | "Yes" (default) shows the Element the first time the List Page renders. | ||||||||||||||||||||||||||||||||||||||||||||
Search Types | Specifies the search options to install on the Searchbar. Click Add Search
Type to install one or more of the following:
A Search Type of "Version Filter" renders an additional panel in the Search Bar that lets users choose the specific Version Statuses to be listed in the List page. Access to this panel can be controlled by assigning Roles to the collection item.
The initial state of the checkboxes is derived from the default values defined for the Page Type. Subsequent visits to the page will persist settings made by the last user to access the page. If all checkboxes are unchecked, all statuses are displayed. This panel displays only Versioned SDCs. |
||||||||||||||||||||||||||||||||||||||||||||
Search Type Collapse/Expand | "Yes" expands the Search Type to make it visible when the page loads. | ||||||||||||||||||||||||||||||||||||||||||||
Default Select | Search Type that executes when an SDI List Page opens: Default Query,
Default Category, First Folder, Last Search, or None.
Note the "Last Search" option. If you choose this, the advancedsearch Element remembers the last executed search. Upon returning to the List Page, the last executed search is repeated. |
||||||||||||||||||||||||||||||||||||||||||||
GroupBy Options | The GroupBy Callback JavaScript
property executes grouping of retrieved SDIs. The GroupBy Options determine
when they are grouped:
|
||||||||||||||||||||||||||||||||||||||||||||
Basic Search Options | Generates a basic search engine consisting of an input field accepting
a search string:
|
||||||||||||||||||||||||||||||||||||||||||||
Query Search Options | Generates a search engine consisting of a list of Query SDIs. Choosing
one executes the query.
When constructing your Query SDIs, you can use either Collective or Cascaded Arguments. However, do not use the "Auto Quote Arguments" feature (it will corrupt the query). The following properties configure this search engine:
|
||||||||||||||||||||||||||||||||||||||||||||
Category Search Options | Generates a search engine consisting of a list of Categories (clicking
one shows all SDIs in that Category):
|
||||||||||||||||||||||||||||||||||||||||||||
Scan in Ids | Properties for the bar code scan input box inside the search bar are:
|
||||||||||||||||||||||||||||||||||||||||||||
Folder Search | Folder Search options:
For more information, see About Search by Folder above. |
||||||||||||||||||||||||||||||||||||||||||||
Adhoc Search | AdHoc Query page to use for an Adhoc search:
|
||||||||||||||||||||||||||||||||||||||||||||
GroupBy Callback JavaScript | A JavaScript function executes the GroupBy search option. We supply a
default function. If you want to use it, leave this property blank.
As with the Search Callback JavaScript property below, you can use the GroupBy Callback JavaScript property to specify your own function that will execute the grouping. Your function will then use the parameters passed to it by the Group By property. The default function is groupBy, which uses a fixed list of parameters. If you want to use your own function, enter only the function name (such as groupBy). |
||||||||||||||||||||||||||||||||||||||||||||
Search Callback JavaScript | A single JavaScript function executes the "Basic", "Query",
and "Category" search options above. We supply a default function.
If you want to use it, leave this property blank.
Alternatively, you can use this property to specify your own JavaScript function that will execute the searches. Your function will then use the parameters passed to it by the relevant search engine (Basic, Query, or Category). The default function is: showResult( searchtype, searchid, sdcid, queryfrom, querywhere, argarray ) This function is located in WEB-CORE/pagetypes/list/list.jsp, and called by the search JSP rendered in the browser. If you want to use your own function, enter only the function name (such as showResult). To assist in writing your function, use showResult() as an example. Note the parameter values passed to it by each search engine (see the function for explicit guidance):
Make certain your function is in list.jsp or the file you specify using the Include property of the List Page Type. |
||||||||||||||||||||||||||||||||||||||||||||
Width | Width of the Element in pixels. If you do not specify a value, the Element will be as wide as its content. | ||||||||||||||||||||||||||||||||||||||||||||
Height | Height of the Element in pixels. If you do not specify a value, the Element will be as high as its content. | ||||||||||||||||||||||||||||||||||||||||||||
Left | Distance between the left edge of the Element and the left edge of the screen. | ||||||||||||||||||||||||||||||||||||||||||||
Top | Distance between the top edge of the Element and the top of the screen. | ||||||||||||||||||||||||||||||||||||||||||||
Reference Element for Search Bar Position | The height and top edge of the AdvancesSearch Element will be aligned
with the identifier (ID attribute) of the HTML element you specify here.
The default is contentdiv. |
||||||||||||||||||||||||||||||||||||||||||||
Search Bar Container HTML Element | The identifier (ID attribute) of the HTML element you specify here will enclose the advancedsearch Element. The default is searchtd. |