integration_documentation:checklist
Differences
This shows you the differences between two versions of the page.
|
integration_documentation:checklist [2019/05/22 15:18] florian ↷ Links adapted because of a move operation |
integration_documentation:checklist [2020/06/16 15:45] (current) amil |
||
|---|---|---|---|
| Line 44: | Line 44: | ||
| ===== Search ===== | ===== Search ===== | ||
| - | * Multiple search terms can be entered and passed to FINDOLOGIC. | + | * Multiple search terms can be entered and passed to Findologic. |
| - | * Multiple filters can be selected at the same time and transferred to FINDOLOGIC. | + | * Multiple filters can be selected at the same time and transferred to Findologic. |
| - | * Filters and search queries can be entered with the ''&'', several terms and umlauts character, and passed to FINDOLOGIC. | + | * Filters and search queries can be entered with the ''&'', several terms and umlauts character, and passed to Findologic. |
| * The search string must be UTF-8 and URL encoded. | * The search string must be UTF-8 and URL encoded. | ||
| - | * The shopkey corresponds to the FINDOLOGIC license of the current language. | + | * The shopkey corresponds to the Findologic license of the current language. |
| * If no shopkey is stored for the current language, the search query has to be edited by the conventional shop search. | * If no shopkey is stored for the current language, the search query has to be edited by the conventional shop search. | ||
| * When changing the page size and changing to a different page (pagination), currently selected filters, search words and sortings must be retained. | * When changing the page size and changing to a different page (pagination), currently selected filters, search words and sortings must be retained. | ||
| - | * The ''userip'' field must be transferred to FINDOLOGIC for each search query. | + | * The ''userip'' field must be transferred to Findologic for each search query. |
| ==== Multilingualism / Subshops / Clients ==== | ==== Multilingualism / Subshops / Clients ==== | ||
| - | * The (Smart Suggest) Request URL is passed to the Shopkey parameter of the corresponding FINDOLOGIC service. | + | * The (Smart Suggest) Request URL is passed to the Shopkey parameter of the corresponding Findologic service. |
| * The (Smart Suggest) Request URL is passed to the group parameter of the corresponding client. | * The (Smart Suggest) Request URL is passed to the group parameter of the corresponding client. | ||
| Line 76: | Line 76: | ||
| * If a filter item is passed with ''<weight> 0 </weight>'', this value can only be output if at least one child item has a weight value greater than 0. | * If a filter item is passed with ''<weight> 0 </weight>'', this value can only be output if at least one child item has a weight value greater than 0. | ||
| * In the output of the filter, the value from ''<display />'' is used as the name | * In the output of the filter, the value from ''<display />'' is used as the name | ||
| - | * If FINDOLOGIC customeraccount is activated for filter settings "Show frequency", the element <frequency /> is to be output in brackets behind the filter value. Example: ''Red (23)'' | + | * If Findologic customer account is activated for filter settings "Show frequency", the element <frequency /> is to be output in brackets behind the filter value. Example: ''Red (23)'' |
| Line 110: | Line 110: | ||
| * The following sorting options are offered to the end customer: | * The following sorting options are offered to the end customer: | ||
| - | * German: Beste Treffer((in this case no sorting is given so that the sorting set in the FINDOLOGIC customer account is used)), Günstigste zuerst, A-Z, Topseller zuerst, Neuheiten zuerst | + | * German: Beste Treffer((in this case no sorting is given so that the sorting set in the Findologic customer account is used)), Günstigste zuerst, A-Z, Topseller zuerst, Neuheiten zuerst |
| - | * English: Most relevant((in this case no sorting is given so that the sorting set in the FINDOLOGIC customer account is used)), Lowest price first, A-Z, Top seller first, Latest products first | + | * English: Most relevant((in this case no sorting is given so that the sorting set in the Findologic customer account is used)), Lowest price first, A-Z, Top seller first, Latest products first |
| ===== Fallback mechanism ===== | ===== Fallback mechanism ===== | ||
| - | * Before each query an //Alivetest// is sent to FINDOLOGIC. | + | * Before each query an //Alivetest// is sent to Findologic. |
| - | * When returning ''alive'', the actual search request is sent to the FINDOLOGIC service. | + | * When returning ''alive'', the actual search request is sent to the Findologic service. |
| - | * For any other return than ''alive'', the search will be handled by the traditional search engine.((If the fallback mechanism does not work properly, the FINDOLOGIC search can **not** be used in any productive shop.)) | + | * For any other return than ''alive'', the search will be handled by the traditional search engine.((If the fallback mechanism does not work properly, the Findologic search can **not** be used in any productive shop.)) |
| * When returning an invalid XML, the search query must also be processed by the conventional search engine. | * When returning an invalid XML, the search query must also be processed by the conventional search engine. | ||
| Line 124: | Line 124: | ||
| ===== Smart Suggest ===== | ===== Smart Suggest ===== | ||
| - | * Search queries can be entered with ''&'', blanks and umlauts and passed to FINDOLOGIC. | + | * Search queries can be entered with ''&'', blanks and umlauts and passed to Findologic. |
| * Product pictures and manufacturer pictures can be displayed. | * Product pictures and manufacturer pictures can be displayed. | ||
| * The display of the types (category, manufacturer, product) is grouped by type. | * The display of the types (category, manufacturer, product) is grouped by type. | ||
| Line 130: | Line 130: | ||
| * The selection of a result is possible by clicking as well as by pressing Enter. | * The selection of a result is possible by clicking as well as by pressing Enter. | ||
| * If a category / manufacturer is selected, a link to the filter must be made. | * If a category / manufacturer is selected, a link to the filter must be made. | ||
| - | * If FINDOLOGIC is active, but without Smart Suggest, no search suggestions may be provided. Even a shop-internal smart suggestion may not be active. | + | * If Findologic is active, but without Smart Suggest, no search suggestions may be provided. Even a shop-internal smart suggestion may not be active. |
| - | * The Smart Suggest script tag is generated and output with the corresponding MD5 hash of the //Shopkeys// of the corresponding FINDOLOGIC service. | + | * The Smart Suggest script tag is generated and output with the corresponding MD5 hash of the //Shopkeys// of the corresponding Findologic service. |
| - | * All parameters passed to the Smart Suggest proxy must be passed to FINDOLOGIC. | + | * All parameters passed to the Smart Suggest proxy must be passed to Findologic. |
| ===== Shop backend ===== | ===== Shop backend ===== | ||
| - | * Per language in the shop, a service URL for the FINDOLOGIC search service is possible in the admin area. | + | * Per language in the shop, a service URL for the Findologic search service is possible in the admin area. |
| - | * Per language in the shop, a //Shopkeys// (unique key of a FINDOLOGIC license) is possible in the admin area. | + | * Per language in the shop, a //Shopkeys// (unique key of a Findologic license) is possible in the admin area. |
| * //Shopkey// and Service URL are not allowed to store surrounding spaces ( ''' service.findologic.com ''' -> '''service.findologic.com''') | * //Shopkey// and Service URL are not allowed to store surrounding spaces ( ''' service.findologic.com ''' -> '''service.findologic.com''') | ||
| - | * The shop owner can choose from the following logo variants (to be found under [[:implementing_findologic_branding|implementing the FINDOLOGIC branding]]) via a selection box: | + | * The shop owner can choose from the following logo variants (to be found under [[:implementing_findologic_branding|implementing the Findologic branding]]) via a selection box: |
| * 'Normal' | * 'Normal' | ||
| * 'Red gray' | * 'Red gray' | ||
| Line 148: | Line 148: | ||
| * 'Gray transparent' | * 'Gray transparent' | ||
| * 'English banner' | * 'English banner' | ||
| - | * The shopkeeper can deactivate the logo with a hint: //Only for booking **without** "FINDOLOGIC Branding".// | + | * The shopkeeper can deactivate the logo with a hint: //Only for booking **without** "Findologic Branding".// |
| Line 163: | Line 163: | ||
| ===== Other ===== | ===== Other ===== | ||
| - | * The FINDOLOGIC logo may only be displayed and linked if the results are also from FINDOLOGIC. (The logo can be hidden when booking "FINDOLOGIC without logo and link")) | + | * The Findologic logo may only be displayed and linked if the results are also from Findologic. (The logo can be hidden when booking "Findologic without logo and link")) |
| * If the search is called with the URL parameter ''fallback=1'', the search has to switch to the standard mail search. | * If the search is called with the URL parameter ''fallback=1'', the search has to switch to the standard mail search. | ||
| * Installation of the module must be documented. | * Installation of the module must be documented. | ||