Welcome, Guest Login
Higher Logic User Group Site Higher Logic User Group Site Higher Logic Support Center

Support and Documentation

Legacy Search: Search Parameters

Last Updated: Feb 18, 2016 04:23PM EST

Note: as of February 2016 faceted search is the lead search experience on the Higher Logic platform. The faceted search experience is considered superior to the legacy search experiences provided by basic and advanced search offered by the hlcommon:Search control.  The hlcommon:Search control has not been deprecated, but the configuration options documented here are of limited value.  

HLCommon:Search

Parameter Name Type of Input Required Definition
AdvancedSearchLinkText Text String Changes the text of the link to enable Advanced Search.
CssClass Text String Changes the CSS class governing the basic layout of the content item.
DescriptionLength Number Total number of characters for the description for each search result. The default is 300.
EmailAddressWaterMark Text String Watermarks are the light-grey text that initially appears in a text field to prompt a user. Watermark text disappears when a user clicks to input text in the field.
FirstNameWaterMark Text String Watermarks are the light-grey text that initially appears in a text field to prompt a user. Watermark text disappears when a user clicks to input text in the field.
LastNameWaterMark Text String Watermarks are the light-grey text that initially appears in a text field to prompt a user. Watermark text disappears when a user clicks to input text in the field.
MicrositeKey GUID This returns only results for a particular Microsite, based on the GUID of the Microsite.
NoDataText Text String Changes the message that is shown following a search that has no results.
PageCode Text String Directs searches to render based on a specific page. This parameter is necessary to achieve a unique single-search-results URL.
PageSize Number Instructs as to the total number of search results to display per page (the default is 20).
PostedBeforeWaterMark Text String Watermarks are the light-grey text that initially appears in a text field to prompt a user. Watermark text disappears when a user clicks to input text in the field.
PostedSinceWaterMark Text String Watermarks are the light-grey text that initially appears in a text field to prompt a user. Watermark text disappears when a user clicks to input text in the field.
ResultsOnSeparatePage True or False Use this display to refresh the page completely when a search is performed. This parameter is necessary to achieve a unique single-search-results URL.
ReturnAsRestData True or False When set to true, the search results are returned as XML rather than a web page. This allows external websites or systems with proper authorization to run searches against your Connected Community system.
SearchAnnouncements True or False "Enables or disables Announcements being in included in search results.
SearchBlogs True or False Enables or disables Blogs from being in included in search results.
SearchButtonText Text String Allows the Admin to customize the text of the Search Button.
SearchCalendarEvents True or False Enables or disables Calendar Events from being in included in search results.
SearchCommunities True or False Enables or disables Communities (the names and descriptions of Communities) from being in included in search results.
SearchEgroups True or False Enables or disables eGroup posts from being in included in search results.
SearchGlossary True or False Enables or disables Glossary entries from being in included in search results.
SearchMicrosites True or False Enables or disables HTML Content Item content from being in included in search results.
SearchResourceLibraries True or False Enables or disables Resource Library content from being in included in search results.
SearchTermWaterMark Text String Watermarks are the light-gray text that initially appears in a text field to prompt a user. Watermark text disappears when a user clicks to input text in the field.
SearchText Text String Changes the text that appears next to the Search box.
SearchThisSite True or False Establishes the current site as the only site that will be searched.  Set this Parameter to "false" when all content across Microsites is desired to return in search results.
ShowAdvancedLink True or False Displays the link to the Advanced Search.
ShowAdvancedMode True or False Transforms or does not transform Basic Search into Advanced Search.
ShowBloggerList True or False Shows or does not show the blogger list among the search fields.
ShowCommunityList True or False Shows or does not show the list of Communities among the search fields.
ShowDateContributedInResults True or False Shows or does not show the dates of content creation in search results.
ShowDescriptionInResults True or False Shows or does not show the dates of content creation in search results.
ShowEgroupList True or False Shows the eGroup list, allowing searchers to search specific eGroups.
ShowFileTypes True or False Shows or does not show the list of file types (PDF, XLS, etc) among the search fields.
ShowFoundInInResults True or False Shows or does not show the libraries or other areas where content is stored in search results.
ShowIcon True or False Shows or does not show the standard content-type icons associated with different content types (blogs, documents, etc.)
ShowLibraryList True or False Shows or does not show the list of Libraries among the search fields.
ShowPostedByInResults True or False Shows or does not show the name of the author/contributor of the information.
ShowSearchByPostedBy True or False Shows or does not show four fields (first name, last name, company and email address) allowing users to search by inputting data about the poster of content.
ShowSearchByPostedByCompanyName True or False Shows or does not show the company name field for searching by the poster.
ShowSearchByPostedByEmailAddress True or False Shows or does not show the email field for searching by the poster.
ShowSearchByPostedByFirstName True or False Shows or does not show the first name field for searching by the poster.
ShowSearchByPostedByLastName True or False Shows or does not show the last name field for searching by the poster.
ShowProductList True or False Shows or does not show the list of Higher Logic Products among the search fields.
ShowSearchByTags True or False Shows or does not show the tag list among the search fields.
ShowSearchCriteria True or False Shows or does not show the gray Search Criteria bar above search results.
ShowSearchInputs True or False Shows or does not show all the search fields associates with Search.
ShowSearchOptions True or False Enables or disables the onFocus box allowing modification of search terms.
ShowSiteList True or False Shows the list of all web sites (microsites) associated with the Higher Logic client.
ShowSortBy True or False Three links allowing search results to be resorted by relevance, date, and alphabetical order appear above search results.  This control removes or allows all of these links.
ShowSortByAlphabetical True or False Shows or does not show the link allowing search results to be sorted by alphabetical order.
ShowSortByDate True or False Allows Admins to remove the link that allows search results to be ordered by date.
ShowSortByRelevance True or False Shows or does not show the link allowing search results to be sorted by relevance.  .
ShowTagsList True or False Shows the tags list, allowing users to search by tags.
ShowUserEnteredTags True or False Determines whether the tags generated by users of the site will appear in the search tag list.
SortByDefault Text String How to sort the results. Options are "alpha", "date", or "relevance".
SortOrderDefault Text String Sort in ascending or descending order. Options are "asc" or "desc".
SpecificContentText Text String Allows the Admin to customize the text associated with the content type list in Advanced Search.
SpecifiedBlogsText Text String Allows the Admin to customize the text associated with the content type list in Advanced Search..
SpecifiedCommunitiesText Text String Allows the Admin to customize the text associated with the content type list in Advanced Search.
SpecifiedEgroupsText Text String Allows the Admin to customize the text associated with the content type list in Advanced Search.
SpecifiedFileTypesText Text String Allows the Admin to customize the text associated with the content type list in Advanced Search.
SpecifiedGlossaryStatusText Text String Allows the Admin to customize the text associated with the content type list in Advanced Search.
SpecifiedLibrariesText Text String Allows the Admin to customize the text associated with the content type list in Advanced Search.
SpecifiedMicrositesText Text String Allows the Admin to customize the text associated with the content type list in Advanced Search.
SpecifiedTagsText Text String Allows the Admin to customize the text associated with the content type list in Advanced Search.
Title Text String Allows the Admin to place a header over the Search fields.
Visible True or False Allows the Admin to not display the search content item including its title and header.

 

support@higherlogic.com
http://assets2.desk.com/
false
higherlogic
Loading
seconds ago
a minute ago
minutes ago
an hour ago
hours ago
a day ago
days ago
about
false
Invalid characters found
/customer/en/portal/articles/autocomplete