Item - Search portlet

From VYRE

(Redirected from Item search portlet)
Jump to: navigation, search
Item - Search portlet
module: Content module
supplier: VYRE Ltd.

The item search portlet allows to perform a search by collection, category and metadata attribute. The portlet follows Lucene Search Syntax. "Item - Search Results Portlet" which takes the incoming query from this portlet and shows the results as configured.

Edit Mode:

Contents

Search results page (leave blank for no redirect)

Type in the full path of the page set to show search results. Please note that the dynamic variables will not be recognized over here. As mentioned, please leave the text area blank if the current page is configured to show search results.

Record searches

Added in Unify 4.6.2

Whether or not you wish to record searches that are requested through this portlet. The default is for this option to be turned off. When turned on, a record of the search is recorded in the database when the results are displayed. This information can then be used later by the Business Intelligence module.

Search Mode

The search mode gives three options to choose from:

Search multiple stores, allow user to choose stores:

Select this option if you want users to choose the stores they want to search in. When selected all the Data Stores and File Stores will be available to the user to select from. If you wish to display certain Data/File Stores, you can select them from the box under "Search single store", that displays all the Data/File Stores available.

Search multiple predefined stores

Select this option if you know exactly what stores user will need to search from an pre-select them. The users will not have an option of selecting the stores out of the one's you selected. The search will be carried out in all the stores you chose.

Search single store

Select this option if users will only be searching in one store. Select the store from the dropdown next to this option.

Fields in the form:

This sections lists out the fields added to the search portlet.

This section underneath "General" allows you to add the search box and the search button along with other fields that you might need to use carrying out search. The default fields are are shown in Figure Media:Fig13.JPG

General inputs

Default search input:

This is the default and most powerful text search input area out of all the rest. Using this field the search is run throughout the Data/File Store that includes name, description, metadata etc. Click on the Image:AddAttribute.jpg symbol next to the field. Select one of three options provided.

Use default label ("Search")

This will display Search on the top of the input text area.

Use localized label:

Write the name of the locale key in the text area next to this and the label text will change depending upon what locale is set for the site.

Use custom label:

Choose this if you wish to write static text that will be displayed for all locales.

Please note that if you don't want label to appear, then select "Use custom label" and leave the text area empty.

Name input:

Using this field the system will only search through the names of the items in the given Data/File Stores. Add it in a same way as "Default search input"

Description input:

Using this field the system will only search through the description of the items in the given Data/File Stores. Add it in a same way as "Default search input"

Keyword input:

Using this field the system will only search through the keywords of the items in the given Data/File Stores. Add it in a same way as "Default search input"

Taxonomy tree:

This can be used if you wish to use taxonomy for filtering out search results. The taxonomy tree can be configured as follows:

  • Click on the Image:AddAttribute.jpg symbol next to the Taxonomy tree and you will see the properties for this field as in the figure above.
  • Use default label ("Taxonomy tree"): This will display Search on the top of the input text area.
  • Use localized label: Write the name of the locale key in the text area next to this and the label text will change depending upon what locale is set for the site.
  • Use custom label: Choose this if you wish to write static text that will be displayed for all locales.
  • User localized labels for taxonomy tree: If this checkbox is selected then the labels in the taxonomy tree will change according to the locale of the site. (Please note that in order for this to work it needs to me made sure that localization keys were set for the categories when they were created)
  • Pre-select categories: If you wish to restrict the search to certain categories, then select the required categories from the tree underneath. Please note that the selected categories will not be shown on the page but search results returned will only be the one's that are taxonomized with the selected categories.
  • User options - "Allow user to refine search by category selection": Checking this box will show further options that can be configured to give flexibility to the users to refine their search on the page.
  • User options - "Filter out empty pre-selected categories": Selecting this will not show the taxonomy categories that are not used for any items. For example if we have a category and no item is tagged to that category, then that category will not be shown on the page.
  • Maximum tree depth (0=unlimited): Enter the number of levels down you want taxonomy to be shown.
  • Ordering: Choose the required alphabetical order to wish taxonomy to be arranged in.
  • Present as: Selecting "tree" will display taxonomy in a tree like structure and selecting dropdown will change the layout to dropdowns in the front end and further options will appear on how you want to display the dropdowns. Please configure them according to the requirements.
  • Per root category - select root categories: Select the categories you wish to be displayed on the page. If you check this box and do not select any categories from the tree underneath, then the whole tree will be displayed.
  • Add label to Root category (Only appears if dropdown is selected for displaying): Select this if you wish to display "taxonomy" label on the top of each dropdown on the page.
  • Add a Reset option: Selecting this will add a reset button on the page to reset the serach.
  • Submit search when category is selected: If you wish the search to be submitted on selecting each category then check this option.
  • Redirect when a category is selected: This option becomes available if you select the search to be submitted each time a category is selected. If you wish the user to be redirected to a different page(set at 2.1 above), select this option.
  • Add a Reset+submit option: Selecting this option will add a submit and a set button next to taxonomy on the page.

Locale selection

  • Click on the [[Image:AddAttribute.jpg] symbol next to this and you will see the properties for this field as in the Figure (add figure number)

Label Type

  • Use default label ("Locale"): This will display Locale on the top of the input text area.
  • Use localized label: Write the name of the locale key in the text area next to this and the label text will change depending upon what locale is set for the site.
  • Use custom label: Choose this if you wish to write static text that will be displayed for all locales.

Selection method

  • Preselect site locale: This option will not display the locales and will search the items in the site locale.
  • Preselect locales below: This option will not display the locales and will search for items having same locale as the one's you selected from the box underneath.
  • Allow user to select from the selection below: Select this option if you want users to be able to select the locale they want to search items in. The locales displayed on the page will be the one's you preselect in the box underneath.

Custom Code:

Click on the Image:AddAttribute.jpg symbol next to this and you will be able to add custom code to the search portlet. This box can be used to include Javascript, HTML etc within the search portlet for any required reason.

Submit Button

This is for adding a submit button to the search portlet for submitting the search.

The Item - Search Portlet can further be customized depending on the metadata added to the Data/File Store you are working on. For example if you have a metadata field "Date" which is set as type Date.

Item links

If you have selected a specific store, then it is possible to add an Item Link attribute if that store has item links associated with it. The item links section will list the possible item links available to you, i.e. it maps the item links that exist between your selected store and others. Clicking on the Image:AddAttribute.jpg icon will add this link to the Fields in the form section. From there you can edit the item link properties to fine-tune your search.

Label Type

See sub-sections of Default search input.

Link type

  • Let user choose items - this will present the items within a drop-down box allowing the user to select manually.
  • Detect item to link to from parameter - this will retrieve the item from the parameters provided.

Select mode

  • Select one - provides a drop-down list that enables the user to select a single item.
  • Select multiple - provides a list of all selectable items and a list of currently selected items. Buttons are provided to allow the user to select multiple items by placing them in the second list.

Filtering

  • Display all items - this will retrieve all of the items that are on the chosen item link.
  • Use a saved search - this allows you to further refine the items that are retrieved on this link definition by applying a saved search. Simply select the desired saved search from the drop down list.

Available display attributes/Selected display attributess

The available display attributes list shows the content/metadata attributes of the store you are linking to. You can select the attributes that you would like to be displayed by placing them into the Selected display attributes list by using the arrow buttons provided.

NOTE: Versions of Unify up to the time of writing (v4.5) are unable to retrieve/display certain item attributes.
There is a bug logged in Jira regarding this.

See also

Personal tools