xml_export_documentation:xml_format
Differences
This shows you the differences between two versions of the page.
Both sides previous revision Previous revision Next revision | Previous revision Next revision Both sides next revision | ||
xml_export_documentation:xml_format [2019/10/01 16:37] lukas [usergroups] |
xml_export_documentation:xml_format [2019/11/13 14:34] florian [Overview] |
||
---|---|---|---|
Line 41: | Line 41: | ||
^**''<[[#images]]>''**| URL to the article image, must be absolute. | 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 | Yes | No | No | |
^**''<[[#bonuses]]>''**| Bonus value to rank certain articles higher than others | No | No | No | | ^**''<[[#bonuses]]>''**| Bonus value to rank certain articles higher than others | No | No | No | | ||
^**''<[[#salesfrequencies]]>''**| Amount of sold items of this article | Yes | No | No | | ^**''<[[#salesfrequencies]]>''**| Amount of sold items of this article | Yes | No | No | | ||
Line 74: | Line 74: | ||
* ''<items>'' gives information about the start-pointer (''start''), how many products are exported per step (''count'') and how many products exists in the shop in total (''total''). For more information see [[xml_export_documentation:xml_request_and_response|Export]] | * ''<items>'' gives information about the start-pointer (''start''), how many products are exported per step (''count'') and how many products exists in the shop in total (''total''). For more information see [[xml_export_documentation:xml_request_and_response|Export]] | ||
* ''<items>'' may contain 1+ ''<item>''-tags. | * ''<items>'' may contain 1+ ''<item>''-tags. | ||
+ | |||
+ | <note important>Due to runtime limitations the XML-export has to be paginated.</note> | ||
<note tip>**Using our export toolkit?** | <note tip>**Using our export toolkit?** | ||
Line 304: | Line 306: | ||
* ''<usergroup>'' contains 1+ ''<usergroup>''-tags. | * ''<usergroup>'' contains 1+ ''<usergroup>''-tags. | ||
* ''<usergroup>'' contains a usergroup to which the item is visible. | * ''<usergroup>'' contains a usergroup to which the item is visible. | ||
- | * ''<usergroup>'' the usergroup used as a parameter in the FINDOLOGIC-Snippet has to have the exact same wording as the usergroup that is used in the datafeed (e.g.'<name usergroup="employee"). | + | * ''<usergroup>'' the usergroup used as a parameter in the FINDOLOGIC-Snippet has to have the exact same wording as the usergroup that is used in the datafeed. |
=== Using usergroups to set the visibility of items === | === Using usergroups to set the visibility of items === | ||
Line 332: | Line 334: | ||
=== Recommendation === | === Recommendation === | ||
* In case of more than 128 ''<usergroups>'', please contact [[mailto:support@findologic.com|support@findologic.com]], in order to adjust default settings. | * 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): | + | * To avoid potential misunderstandings, preferably use alphanumeric values for usergroups (e.g. ''18plus'', ''B2B''). |
Line 339: | Line 340: | ||
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> | ||
- | |||
- | |||
- | === Calculating the usergroup-hash === | ||
- | |||
- | The usergroup-hash is composed of two components: | ||
- | |||
- | * the shopkey (e.g. ''A6039131315BE9F868E358D5AC784405'') | ||
- | * The combined usergroups (z.B. 'at_ratedR') | ||
- | |||
- | These components are put together with ''xor'' and base64 and thus can be decoded. | ||
- | |||
- | === Example: === | ||
- | |||
- | <code php> | ||
- | $shopkey = 'A6039131315BE9F868E358D5AC784405'; | ||
- | $usergroup = 'at_ratedR'; | ||
- | $hash = base64_encode($shopkey ^ $usergroup); // = 'IEJvQVhFVlVh' | ||
- | |||
- | $usergroup_decoded = ($shopkey ^ base64_decode($hash)); // = 'at_ratedR'; | ||
- | </code> | ||
- | |||
- | ---- | ||
- | |||
==== bonuses ==== | ==== bonuses ==== | ||