xml_export_documentation:xml_format

xml_export_documentation:xml_format

Differences

This shows you the differences between two versions of the page.

Link to this comparison view

Both sides previous revision Previous revision
Next revision
Previous revision
xml_export_documentation:xml_format [2019/05/28 14:38]
sarah [Overview]
xml_export_documentation:xml_format [2019/08/22 15:37] (current)
florian [Overview]
Line 31: Line 31:
 ==== Overview ====  ==== Overview ==== 
 ^ Item ^ Short Description ^ Tag required ^ Value required ^ Will be searched ^ ^ Item ^ Short Description ^ Tag required ^ Value required ^ Will be searched ^
 +^**''<?​xml version=“...” encoding=“...”?>''​**| Specifies the encoding ​ | Yes | Yes | No |
 ^**''<​[[#​item]] id="">''​**| Unique identification number ​ | Yes | Yes | No | ^**''<​[[#​item]] id="">''​**| Unique identification number ​ | Yes | Yes | No |
 ^**''<​[[#​ordernumbers]]>''​**| Article number or order number | Yes | No | Yes | ^**''<​[[#​ordernumbers]]>''​**| Article number or order number | Yes | No | Yes |
Line 38: Line 39:
 ^**''<​[[#​prices]]>''​**| Current article price including taxes | Yes | Yes | **filterable only** | ^**''<​[[#​prices]]>''​**| Current article price including taxes | Yes | Yes | **filterable only** |
 ^**''<​[[#​urls]]>''​**| URL to the article page, must be absolute | Yes | No | No | ^**''<​[[#​urls]]>''​**| URL to the article page, must be absolute | Yes | No | No |
-^**''<​[[#​images]]>''​**| URL to the article image, must be absolute. Type "​thumbnail"​ is used in the FINDOLOGIC Smart Suggest. | Yes | No | No |+^**''<​[[#​images]]>''​**| URL to the article image, must be absolute. | Yes | No | No |
 ^**''<​[[#​keywords]]>''​**| Keywords linked to current article | Yes | No | Yes | ^**''<​[[#​keywords]]>''​**| Keywords linked to current article | Yes | No | Yes |
 ^**''<​[[#​usergroups]]>''​**| Visibility of article, i.e. only visible to the exported usergroups. see [[xml_export_documentation:​xml_format#​Calculating the usergroup-hash|how to generate usergrouphashes]] | Yes | No | No | ^**''<​[[#​usergroups]]>''​**| Visibility of article, i.e. only visible to the exported usergroups. see [[xml_export_documentation:​xml_format#​Calculating the usergroup-hash|how to generate usergrouphashes]] | Yes | No | No |
Line 240: Line 241:
   <​images>​   <​images>​
     <​image><​![CDATA[]]></​image>​     <​image><​![CDATA[]]></​image>​
-    <image type="​thumbnail"><​![CDATA[]]></​image>​ 
   </​images>​   </​images>​
   <images usergroup="">​   <images usergroup="">​
     <​image><​![CDATA[]]></​image>​     <​image><​![CDATA[]]></​image>​
-    <image type="​thumbnail"><​![CDATA[]]></​image>​ 
   </​images>​   </​images>​
   [...]   [...]
Line 303: Line 302:
 </​code>​ </​code>​
  
-  * ''<​usergroups>''​ contains 1+ ''<​usergroup>''​-tags. +  * ''<​usergroup>''​ contains 1+ ''<​usergroup>''​-tags. 
-  * ''<​usergroup>''​ contains a usergroup to which the product ​is visible. +  * ''<​usergroup>''​ contains a usergroup to which the item is visible. 
-  * If the ''<​usergroup>''​-tag is set in the search-request, ​only products ​matching the group is returned+ 
-  * By using the ''<​usergroup>''​-tag you can set specific images, keywords, etc. (see in the documentation,​ if specific tags can be used with usergroups) for specified usergroups+=== Using usergroups to set the visibility of items === 
-  * In case of more than 128 usergroups, please contact [[mailto:​support@findologic.com|support@findologic.com]],​ in order to adjust default settings.+ 
 +  * If no ''<​usergroup>'' ​is requested, all items are returned. 
 +  * If a ''<​usergroup>''​ is requested, only items with a matching ''<​usergroup>''​ are returned. 
 +         * **Example:​** If a Usergroup  ​is set by usergrouphash="​employee" ​-> ''<​usergroup><​![CDATA[employee]]>​ </​usergroup>'' ​only products ​for which this usergroup ​is set are visible. 
 +      
 +  * Unknown ''<​usergroups>''​ is ignored, so that when requesting an unknown ''<​usergroup>''​ all items are visible. ​    
 +   
 + 
 +=== Using <​usergroups>​ to set the visibility of single information relevant for a returned item === 
 + 
 +  * By using the ''<​usergroups>''​-tag you can set specific images, keywords, ​price etc. 
 +  * By using the ''<​usergroup>''​ attribute within XML tags, you can set specific item information for given ''<​usergroups>''​. 
 +  * If no ''<​usergroup>''​ is requested the default ​(non-usergroup) value is used for all tags. Therefore default (non-usergroup) tags are required for all elements ​in the data feed. 
 +  * If a ''<​usergroup>''​ is requested the usergroup-specific ​value is used for all tags
 +       * **Example:​** If the usergrouphash="​ employee " is used -> ''<​name usergroup="​employee "><​![CDATA[Internal product title]]></​name>''​ the name set for this usergroup is used. 
 +  * If an item has no usergroup-specific value for a tag then the default (non-usergroupvalue is used. 
 +       * **Example:​** request usergrouphash="​employee"​ -> ''<​names><​name><​![CDATA[Product title]]></​name><​name usergroup="​b2b"><​![CDATA[B2B product title]]></​name></​names>​ -> “Product title"''​ is used, cause this represents the default (non-usergroup) info. 
 + 
 +<​note>​Usergroup-specific ''<​property>''​ tags are defined at ''<​properties>''​ level. Usergroup-specific ''<​property>''​ tags are not merged with default ''<​property>''​ tags, therefore ​for each usergroup all the ''<​property>''​ tags for this usergroup must be exported.</​note>​ 
 + 
 +  * To keep the export small, usergroup-specific tags should only be exported when they are different from the default (non-usergroup) tag. 
 +  * ''<​Attributes>''​ cannot be usergroup-specific and therefore cannot be exported with a ''<​usergroup>''​ attribute. 
 + 
 +=== Recommendation === 
 +  * In case of more than 128 ''<​usergroups>''​, please contact [[mailto:​support@findologic.com|support@findologic.com]],​ in order to adjust default settings.
   * The value in the CDATA-block of the ''<​usergroup>''​-tag will be encoded as described below to prevent a manipulation of the search-requests (e.g. R-rating):   * The value in the CDATA-block of the ''<​usergroup>''​-tag will be encoded as described below to prevent a manipulation of the search-requests (e.g. R-rating):
 +
 +
  
 <note tip>​**Using our export toolkit?** <note tip>​**Using our export toolkit?**
  
-Creating an usergroup element with [[https://​github.com/​findologic/​libflexport/​wiki#​usergroup|libflexport]].</​note>​+Creating an ''<​usergroup>'' ​element with [[https://​github.com/​findologic/​libflexport/​wiki#​usergroup|libflexport]].</​note>​
  
  
Line 507: Line 532:
 </​code>​ </​code>​
  
 +<note warning>''​cat_url'​s''​ have to be exported as relative paths.</​note>​
 <​note>​You have to export both main-''​cat_url'​s''​ and sub-''​cat_url'​s''​ for the main- and sub-categories,​ that an article is assigned to.</​note>​ <​note>​You have to export both main-''​cat_url'​s''​ and sub-''​cat_url'​s''​ for the main- and sub-categories,​ that an article is assigned to.</​note>​
 <​note>​The ''/''​ at the end of the ''​cat_url''​ needs to be included if the category pages of your shop are ending with a ''/''​.</​note>​ <​note>​The ''/''​ at the end of the ''​cat_url''​ needs to be included if the category pages of your shop are ending with a ''/''​.</​note>​
Line 658: Line 684:
  
 <code xml findologic.xml>​ <code xml findologic.xml>​
-<?xml version="​1.0"?>​+<?xml version="​1.0" encoding="​UTF-8"?>
 <​findologic version="​1.0">​ <​findologic version="​1.0">​
   <items start="​10"​ count="​1"​ total="​30">​   <items start="​10"​ count="​1"​ total="​30">​
Line 694: Line 720:
         <​images>​         <​images>​
           <​image>​https://​www.store.com/​images/​277KTL.png</​image>​           <​image>​https://​www.store.com/​images/​277KTL.png</​image>​
-          <image type="​thumbnail">​https://​www.store.com/​images/​thumbnails/​277KTL.png</​image>​ 
         </​images>​         </​images>​
         <images usergroup="​LNrLF7BRVJ0toQ==">​         <images usergroup="​LNrLF7BRVJ0toQ==">​
           <​image>​https://​www.store.com/​images/​277KTL.png</​image>​           <​image>​https://​www.store.com/​images/​277KTL.png</​image>​
-          <image type="​thumbnail">​https://​www.store.com/​images/​thumbnails/​377KTL.png</​image>​ 
         </​images>​         </​images>​
       </​allImages>​       </​allImages>​