integration_documentation:checklist

integration_documentation:checklist
  • The data is exported completely UTF-8 encoded
  • If an error occurs (internal error, CSV can not be created / changed, timeouts, etc.), a corresponding error message must be output.
  • The shop owner can configure whether articles and variants without stock are exported and thus can be found through the search or not.
  • If the export can be protected by a password, the export URL can be specified with a parameter.
  • Specifying the language as an ISO code, the export URL can be passed with a parameter (for example, language = de for German).
  • Attributes and article numbers (EAN, MPN, SKU, ISBN, etc.) of variants are summarized and exported in a master article.
  • Only one price and one currency per product will be exported.
  • If a category hierarchy is to be derived from the shop, categories are exported hierarchically.
  • The format of the exported CSV file is the same as CSV export patterns.
  • The file name is made up of findologic_ <shopid> _ <language> .csv (for example, findologic_1_en.csv)
  • As a path to the export file, the usual export directory is chosen by the shop system, or a field for setting the export path is available in the shop backend.
  • The export is provided sequentially (individual calls for partial quantities of the item level).
  • A startup URL is provided for the sequential export.
  • The desired interval size (number of articles to be exported) can be passed via URL parameters (limit).
  • The desired offset (first article to be exported) can be passed via URL parameters (start).
  • For a call without start and limit parameters, these are set to default values ​​(for example start=0&limit=100).
  • The individual calls are forwarded to the corresponding folder pages by location header (HTTP location) until the export is complete.

Articles, variants and categories have several options depending on the shop system to be excluded from the display in the webshop (= not visible). Typical factors are:

  • in stock
  • over sale
  • active / Inactive
  • show / Do not display

Accordingly, this logic must be replicated during export and:

  • If an item is not visible in the shop, it can not be exported.
  • If a variant is not visible in the shop, it can not be exported.
  • If a category is not visible in the shop, it can not be exported.
  • Multiple search terms can be entered and passed 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.
  • The search string must be UTF-8 and URL encoded.
  • 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.
  • 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.

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 group parameter of the corresponding client.
  • The HTML output must be valid according to the W3C standards (http://validator.w3.org/).
  • The shop owner must be able to configure a selection of the number of articles on the results page. (Default: “12, 24, 48”)

Filter

  • Filters are grouped into corresponding groups in individual filter boxes (category, manufacturer, price range, color, size, etc.).
  • The filter values ​​are embedded in an HTML <ul> tag (unsorted list) for each filter and are given a unique ID (fl_filter_vendor) to allow shop owners to make CSS customizations.
  • The output of filters and search requests with control characters and / or special characters (eg ü or &) is displayed correctly.
  • Selected filters are displayed in a seperate filter box above the selectable filter.
  • Filters can not be output if no further options (attributes attributed to the result set) are available.
  • The “Further filters” link must not be displayed if no further filters are available.
  • 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
  • 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)

Multiple selection

  • If a “multiple selection” filter is used, the filter values ​​are output with a leading checkbox.
  • The checkbox already selected filter values ​​is checked.
  • Selected filter values ​​can be deselected again by clicking on the filter value.

Range slider

  • Filter of type “range slider” will be displayed as slider 1)

Color filter

  • For filters with color values, a color picker can be used to display the filter.
  • The background colors of the filter values ​​Links correspond to the passed HTML colors.
  • The background images of the filter values ​​correspond to the transferred images.
  • If no color is transferred and the background image can not be reached, a question mark is output on a white background.

Filter with pictures (logos)

  • For filters with images, a filter can be used to display the transferred images, including their name and frequency.
  • Image, name and frequency can be addressed by CSS selectors and can be hidden or hidden.
  • The “alt” attribute contains the filter name.

Sorting

  • The following sorting options are offered to the end customer:
    • German: Beste Treffer2), Günstigste zuerst, A-Z, Topseller zuerst, Neuheiten zuerst
    • English: Most relevant3), Lowest price first, A-Z, Top seller first, Latest products first
  • Before each query an Alivetest is sent to FINDOLOGIC.
  • 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.4)
  • When returning an invalid XML, the search query must also be processed by the conventional search engine.
  • Search queries can be entered with &, blanks and umlauts and passed to FINDOLOGIC.
  • Product pictures and manufacturer pictures can be displayed.
  • The display of the types (category, manufacturer, product) is grouped by type.
  • The entered characters are displayed with the highlighting in the results.
  • 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 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.
  • All parameters passed to the Smart Suggest proxy must be passed to FINDOLOGIC.
  • 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.
  • 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 the FINDOLOGIC branding) via a selection box:
    • 'Normal'
    • 'Red gray'
    • 'gray'
    • 'Normal transparent'
    • 'Red gray transparent'
    • 'Gray transparent'
    • 'English banner'
  • The shopkeeper can deactivate the logo with a hint: Only for booking without “FINDOLOGIC Branding”.
  • When returning a query, a landing page is returned, the passed URL is automatically redirected. (For example, for XML output, the landingPage link="http://www.example.com/imprint">.))
  • When returning a search query, a promotion is returned, it is output as a banner with a link, over the search results. (For XML output, for example, the element promotion image="http://www.example.com/special-offer.jpg "link="http://www.example.com/special-offer "/>)
  • 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.
  • Installation of the module must be documented.
  • If clients are supported by the shop system, a correct transfer of the client must take place.
  • No caching of the search results may be used to ensure the quality of the search results.
  • For the request, the revision number of the current module version is sent.
1)
A bar with a drag and drop handle for the minimum and a handle for the maximum) When a handle is moved, a new search request is sent use.
2) , 3)
in this case no sorting is given so that the sorting set in the FINDOLOGIC customer account is used
4)
If the fallback mechanism does not work properly, the FINDOLOGIC search can not be used in any productive shop.