To add catalog search to your site, you must add the CatalogSearch databean to each page from which you want to make search available.
Once the data bean has been added to the page, you must set a number of variables. The table below details the variables that you must set.
Name | Data Type | Description |
---|---|---|
beginIndex | String | Used to page the result set. The value is the index of the first result row in a page. |
categoryId | String | Used in searches on both category names and descriptions. |
categoryTerm | String | Used in searches on both category names and descriptions. |
categoryTermCaseSensitive | String | A customer chooses either a case sensitive or a case insensitive search. The value for this variable identifies if a search is case sensitive or not. The value must be either 'yes'(case sensitive search) or 'no'(case insensitive search). |
categoryTermOperator | String | A customer chooses either 'like' or 'equal' as search operators. The value for this variable stores the customer's choice. The value must be either 'LIKE'(for like operator) or 'EQUAL'(for equal operator). |
categoryTermScope | Integer | A customer restricts the scope (of both 'search term' and 'filter term' searches) to one of name; name and short description; or name, short description and long description. The value in this variable stores a customer's choice. The value must be 1 (for name and short description), 2 (for name only), or 3 (for name, short description and long description). |
categoryType | String | A customer specifies up to three types of search criteria All, Any, or Exact Phrase. The value for this variable stores a customer's search criteria. The value must be one of 'ALL'(for All search criteria), 'ANY'(for Any search criteria) or 'EXACT'(for Exact phrase criteria). |
catgrpSchemaType | String | The WebSphere Commerce schema is flexible, and data can be populated in multiple ways. For example, you can populate the CATGPENREL table with products or both products and items. The queries generated by the bean at run time depend on the type of data in the CATGPENREL table. The value in this variable stores the data population type. The value must be either 1 (if the CATGPENREL contains only products) or 2 (if the CATGPENREL contains both items and products). |
currency | String | The value of this variable is used in searches according to currency. |
currencyCaseSensitive | String | A customer chooses either a case-sensitive or a case-insensitive search. The value in this variable identifies if a search is case-sensitive or not. The value must be either 'yes'(case-sensitive search) or 'no'(case-insensitive search). |
currencyOperator | String | A customer chooses either 'like' or 'equal' as search operators. The value in this variable stores a customer's choice. The value must be either 'LIKE'(for like operator) or 'EQUAL'(for equal operator). |
filterTerm | String | The value in this variable is used to filter a search on a specified value. |
filterTermCaseSensitive | String | A customer chooses either a case-sensitive or a case-insensitive search. The value in this variable identifies if a search is case-sensitive or not. The value must be either 'yes'(case sensitive search) or 'no'(case insensitive search). |
filterTermOperator | String | A customer chooses either 'like' or 'equal' as search operators. The value in this variable store a customer's choice. The value must be either 'LIKE'(for like operator) or 'EQUAL'(for equal operator). |
filterType | String | A customer can specify three types of search criteria All, Any, or Exact Phrase. The value in this variable stores a customers's search criteria. The value must be 'ALL'(for All search criteria), 'ANY'(for Any search criteria) or 'EXACT'(for Exact phrase criteria). |
manufacturer | String | The value of this variable is used in searches on a manufacturer's name. |
manufacturerCaseSensitive | String | A customer chooses case-sensitive or case-insensitive search. The value in this variable identifies if a search is case-sensitive or not. The value must be either 'yes'(case sensitive search) or 'no'(case insensitive search). |
manufacturerOperator | String | A customer chooses either 'like' or 'equal' as search operators. The value in this variable stores a customer's choice. The value must be either 'LIKE'(for like operator) or 'EQUAL'(for equal operator). |
manufacturerPartNum | String | The value of this variable is used in searches on a manufacturer's part number. |
manufacturerPartNumCaseSensitive | String | A customer chooses either a case-sensitive or case-insensitive search. The value in this variable identifies if a search is case-sensitive or not. The value must be either 'yes'(case sensitive search) or 'no'(case insensitive search). |
manufacturerPartNumOperator | String | A customer chooses either 'like' or 'equal' as search operators. The value in this variable stores a customer's choice. The value must be either 'LIKE'(for like operator) or 'EQUAL'(for equal operator). |
maxPrice | String | The values of this variable is used in searches on price range. |
minPrice | String | The values of this variable is used in searches on price range. |
pageSize | String | The value of this variable specifies the number of search result rows to display per page. |
price | String | The value of this variable is used in searches on price. |
priceOperator | String | A customer chooses one of the following operators as search operators: =, <, >, !=, <=, >=. The value in this variable stores a customer's choice. The value must be any one of the following: 'EQUAL,' 'NOTEQUAL,' 'GREATER,' 'LESS,' 'GREATER_EQUAL,' or 'LESS_EQUAL.' |
qtyAvailable | String | The value of this variable is used in searches on inventory of a product or item |
qtyAvailableOperator | String | A customer chooses one of the following operators as search operators: =, <, >,!=, <=, >=. The value in this variable store a customers's choice. The value must be any one of the following: 'EQUAL,' 'NOTEQUAL,' 'GREATER,' 'LESS,' 'GREATER_EQUAL,' or 'LESS_EQUAL.' |
qtyMeasure | String | The value of this variable is used in search on quantity measure. |
qtyMeasureCaseSensitive | String | A customer chooses either a case-sensitive or a case-insensitive search. The value in this variable identifies if a search is case-sensitive or not. The value must be either 'yes'(case-sensitive search) or 'no'(case-insensitive search). |
qtyMeasureOperator | String | A customer chooses either 'like' or 'equal' as search operators. The value in this variable stores a customer's choice. The value must be either 'LIKE'(for like operator) or 'EQUAL'(for equal operator). |
RASchemaType | String | For future use. |
resultCount | String | This variable accepts a number which represents the total number of results returned for a search. |
resultType | String | The merchant specifies if they want to show Products or Items or both Products and Items in a search result. The value in this variable stores this value. The value must be 1 (Products only), 2 (Items only), or 3 (both products and items). |
searchTerm | String | The value of this variable is used in searches on a word |
searchTermCaseSensitive | String | A customer chooses either a case-sensitive or a case-insensitive search. The value in this variable identifies if a search is case-sensitive or not. The value must be either 'yes'(case-sensitive search) or 'no'(case-insensitive search). |
searchTermOperator | String | A customer chooses either 'like' or 'equal' as search operators. The value in this variable stores a user's choice. The value must be either 'LIKE'(for like operator) or 'EQUAL'(for equal operator). |
searchTermScope | Integer | A customer restricts the scope (of 'search term' and 'filter term' searches) to one of name; name and short description; or name, short description and long description; or keyword. The value in this variable stores a customer's choice. The value must be 1 (for name and short description), or 2 (for name only), or 3 (for name, short description and long description), or 4 (for keyword). |
searchType | String | A customer specifies one of three types of search criteria: All, Any, or Exact Phrase. The value in this variable stores a customer's search criteria. The value must be one of 'ALL'(for All search criteria), 'ANY'(for Any search criteria) or 'EXACT'(for Exact phrase criteria). |
sku | String | The value of this variable is used in searches on SKU. |
skuCaseSensitive | String | A customer chooses either a case-sensitive or case-insensitive search. The value in this variable identifies if a search is case-sensitive or not. The value must be either 'yes'(case-sensitive search) or 'no'(case-insensitive search). |
skuOperator | String | A customer chooses either 'like' or 'equal' as search operators. The value in this variable stores a customer's choice. The value must be either 'LIKE'(for like operator) or 'EQUAL'(for equal operator). |
For implementation guidelines, refer to the search pages which are part of the sample store.