Custom Search Groups

From Whirlwind eCommerce Wiki
Jump to: navigation, search

Custom search groups provide a management interface to control the options listed in persistent select drop downs, and the page(s) these drop downs link to when selected. Custom search groups can be created on the fly via this management interface, but must be programmed into the page template (using the pageCustomSearchGroup function) by an integrator in order to be visible to site visitors. Once the custom search group is in place in the template, changes to the custom search group (editing/editing drop down options and target pages) can be managed via this interface.

Search groups be used to create any type of select box drop down list that can be used to 'jump' to pages based on a selection. Some examples are:

  • Price list: list price ranges and have each price range set to jump to a page containing recommended products in that price range.
  • By gift recipient: list different words that describe the recipient and set each word to jump to a page containing products that fit the description.
  • Common Keywords: list common keywords used for searches and set each keyword to jump to a page containing products that qualify for the keyword.
  • By Service, Category, Product Type or any other way you can think of to group pages / products so your visitors can more easily find what they are looking for.

Search Groups Listing

Located to the left of the search group form, the search group listing will provide links to view/edit each of the custom search groups in the system. A link is also provided to add a new search group. Each search group listed will display the number of options and the total number of pages linked to all those options. Selecting a search group link from this listing will open the Search Group form in edit mode for the selected search group. Selecting to add a new search group will clear the Search Group Form and set it in add mode to create a new search group.

The Search Group Form

Located to the right of the search groups listing, the search group form provides fields for managing an existing, or creating a new search group. The search group form is broken down into two main areas: Group management (light gray background) and individual option management (dark gray background).

Group management fields

The group management fields set the details about the group and provide a list of the options currently in the group:

  • Group Name: The group name will uniquely identify your group. This name will be accessible via the pageCustomSearchGroup function - therefore, if the integrator has selected to do so, this name could appear in the pages using the template as a title to the drop down. If this is the case, changes to this name via the group management form will result in the title to the drop down changing on the pages using the page templates that contain the custom search group.
  • Group Notes: Notes / details about the group. These notes will be accessible via the pageCustomSearchGroup function - therefore, if the integrator has selected to do so, these notes could appear in the pages using the page templates as a description to the drop down. If this is the case, changes to these notes via the group management form will result in the description to the drop down changing on the pages using the page templates that contain the custom search group.
  • Search Options: This field contains a list of all options that will appear in the search group drop down. These options can be deleted or reordered by selecting the target option and using the 'X' (delete), '^' (promote), or 'V' (demote) buttons next to the list. Double clicking any option will fill the option management fields fields with the selected option's information and set the form to manage that option.

Option management fields

The option management fields are used to edit (or add) a specific option. To edit an option, double click the option from the search options in the group management fields (you will notice the 'edit option' button next to the 'cancel' button, designating that you are changing an existing option and not adding a new one). Clearing the option management fields via the 'cancel' button will designate that you are adding a new option. Clicking the 'add option' or 'edit option' button will post the new option / changes to the search options listing in the group management fields. The option management fields are as follows:

  • Option Name: this is the actual text that will appear in the custom search group drop down for visitors to select.
  • Linked Items: this relationship window provides the means to add, remove and reorder the page(s) that the visitor will be presented if/when the option is selected.

Be sure to select 'add option' or 'edit option' to apply your option changes to the search options field.

After completing all your changes to the option group form, be sure to the 'post search group' button at the bottom of the form to post the search group changes to the database. Your changes will not be saved until you hit the 'post search group' button!

Adding a Search Group

To add a new search group, select the 'Add new search group' link at the bottom of the search groups listing. The search group form will clear, ready to create a new search group. Use the search group form details above for an explanation of how to use the form. Note that new custom search groups will not appear on any pages until an integrator has programmed the search group into a page template using the pageCustomSearchGroup function.

Editing a Search Group

To edit a search group, select the search group name link from the search groups listing. The search group form will fill with the selected search group's data, ready to edit the selected search group. Use the search group form details above for an explanation on how to use the form. Changes to the search group's options will be reflected on the site immediately following posting of the search group changes. The name and notes may also change content related to the search group, if your integrator has elected to make these elements control content on the page.

Deleting a Search Group

To delete a search group, select the 'delete search group' button at the bottom of the search group form. A confirmation will pop up to double check you want to delete the search group. Note that search group deletions are not undoable. If you intend to delete a search group that is currently integrated into a page template, be sure to contact your integrator beforehand so they remove reference to the search group from the page template.

Placing a Search Group in a Template

After creating a new search group, an integrator must program the search group into the desired templates for the search group select drop downs to be visible to web site visitors using the pageCustomSearchGroup function. Contact your integrator for details.