| Info |
|---|
As mentioned on the page Prepare the Product Data page, this part of the documentation describes the requirementsthat your product data feed needs to fulfill in order to build Product Guides entirely yourselvesyourself with the excentos Workbench. If you have more complex feeds (e.g. web services or XML feed), please return to the Prepare the Product Data section or contact excentos support if you have any questions regarding your data - we'll help you getting cover any data feed requirements covered. |
Table of Contents:
| Table of Contents | ||
|---|---|---|
|
...
- The file has to be a CSV (comma-separated values) file. Only this file type is accepted.
- If your product data is written in an Excel sheet (.xls or .xlsx) or in an OpenDocument format (.ods) which are used by LibreOffice or OpenOffice, the file has to be exported to a CSV file (see Export the Product Data File into CSV).
...
If you want to connect your product data directly yourselves to the Workbench, the product data CSV file needs to fulfill the following requirements (as mentioned above, please contact excentos for more complex feeds formats such as XML or JSON):
| Type / Field | Specification | ||
|---|---|---|---|
| File type | CSV file (preferred encoded as is UTF-8) | ||
| Field separator | Needs to be one of the following: ',' (comma), ';' (semi-colon), ':' (colon), '|' (pipe), tab or whitespace character. | ||
| Text separatordelimiter | Text cells have Coherent text has to be surrounded by " " (double quote) or ' ' (single quote). One of them at the beginning of a cell; one at the end of a cell. This is especially important if the text contains a specified field separator. | ||
| Escape character | The escape character that is used within the text separatorscells. Normally this is a '\' (backslash), to escape a single double quote, another single double quote can also be used. | ||
| Decimal separator | Has to be Default is a '.' (dot), e.g. '799.99'. All For comma separated decimals (e.g. '799,99') cannot be converted into numbers at the momentyou need to set the number format in the Workbench. | ||
| Multiple values separator | If some attributes contain cells with more than one value in a cell (e.g. the attribute color with the values black and blue), these values need to be separated by a separator (e.g. with a comma; result: such as "black,blue"). Otherwise these two values are always will be interpreted as one value and cannot be split by using the "Multi valueValue" switch button in the data attribute table (see Upload your Product Data File, Multi Values).
| ||
| Units | Such as kilogram, currencies etc. should be in a separate field if the data field should is required to be interpreted as a number. (we've marked this as this is a suggestion only because the unit is only required if it shall be displayed in the Product Guide . The unit is not technically required, except if prices are displayed in the result list because we then need to know the currency) |
| Info | ||
|---|---|---|
| ||
The field separator and text separatordelimiter as well as the file type encoding and the escape character can be set during the uploading update process of your product data file (local upload). |
| Anchor | ||||
|---|---|---|---|---|
|
...
- The "Required" attributes in the table below are the minimal set of data that every Product Guide needs to work properly.
- The "Recommended" attributesare technically optional, but we recommend you using it is recommended you use them in order to display certain information like the product name or price in the product recommendation card.
...
The required and recommended data attributes and the name conventions for the data fields, which can come from several data sources are:
| Attribute Name | Required | Recommended | Remarks | Visible in Recommendation | ||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| id | X | - | Unique ID provided by the feedfor a single product
| - | ||||||||||||
| name | (X) | X | Name of the product
|  | ||||||||||||
| image | (X) | X | Product image URL, e.g. a URL to the product image on your website
| | ||||||||||||
| price | - | X | Product price (dot-separated decimal number) | | ||||||||||||
| manufacturer | - | X | Manufacturer or brand name | | ||||||||||||
| detailUrl | - | X | URL to the product details page | | purchaseUrl | - | (X)
| Note |
|---|
This feature has to be supported by your website and furthermore implemented for your individual requirements. |
-
| Info | ||
|---|---|---|
| ||
That This means that the name 'price' and 'Price' will be recognized as two different attributes (with small lowercase and capital uppercase 'p'). Please make sure that all attributes are written correctly to match the required/recommended attributes above. Otherwise make sure that your own attribute names are mapped correctly. Else the corresponding information cannot be displayed or executed properly. |
...
For more information on possible data attributes and which data might help to even improve the Product Guide, please also check https://www.excentos.com/en/documentation/data-feed-requirements.
| Anchor | ||||
|---|---|---|---|---|
|
| Info |
|---|
This part of the documentation describes different Product Data sources. The Product Data consists of several data sources and can also be connected by different connector types (HTTP, FTP, SFTP). excentos can help to preprocess these Product Data sources to use them for your Product Guide. Contact excentos support if you have any questions regarding your Product Data sources. |
Possible Product Data sources
| Source | Description | Recommended | Optional |
|---|---|---|---|
PIM | product information like part numbers, variant id, descriptions etc. | x | |
| technical attributes | characteristics of a product; can be contained in master PIM or in another database | x | |
| availability feed | defines product availability per region | x | |
| country-specific product definitions | e.g. different certificates per product; can be contained in master PIM or in other database | x |
Category-specific Product Data
Category-Specific Attributes describe the product itself, such as technical data, possible use-cases and everything that distinguishes one product from the other. For every Product Guide , we need all the category specific attributes are needed, like e.g. the screen resolution of a notebook computer, the shoe size of a mountaineering boot, the range of height adjustment of an office desk etc. The more data we havethere is, the more powerful and detailed the Product Guide can be.
The categorrycategory-specific attributes can have the same data structure (mostly the case with CSV files) or a separate data structure / different attributes per category (mostly the case with XML data structures).
Category-Specific Attributes are not required for the data sourcing option „third-party licensed data“.
...
This is how the CSV file needs to look like if you open it in e.g. Excel if you have correctly set the text delimiters (in the example above we used a comma is used):
Data Feed for international rollouts
...
If prices, product names and descriptions differ, we recommend it is recommended to provide separate data feeds for each market (although it would be technically possible to contain all markets in one feed).
Mime Type Detection
...
During the upload process the Workbench is analyzing the data file type. Only if the file is a valid CSV the file can be uploaded. The corresponding mime type (internal format) for CSV files is 'text/csv'. Unfortunately, there are 600+ words, word phrases or hexadecimal values (mostly at the start of the file) that can affect the mime type. That means that a word like 'Article' at the beginning of a CSV file results in the mime type 'message/news'. With that resulting type, it is not possible to upload the CSV anymore although the file is completely valid. Because of the huge amount of words and word phrases, excentos is not able to prevent these errors during the upload process. Nevertheless, the major part of these words/phrases are not relevant for a CSV file use case, like detecting python or image files.
If you have any problems regarding this issue do not hesitate to contact us. Some "bad words" examples are listed below:
| Bad words | Mime Type |
|---|---|
Article | message/news |
Path: | message/news |
[version] | application/inf |
StartFontMetrics | application/x-font-adobe-metric |
Rar! | application/x-rar-compressed |
Spreadsheet | application/x-sc |
FWS | application/x-shockwave-flash |
CWS | application/x-shockwave-flash |
PSID | audio/prs.sid |
BEGMF | image/cgm |
icns | image/icns |
AGD2 | image/x-freehand |
FreeHand10 | image/x-freehand |
MATLAB | application/x-matlab-data |
#!/bin/perl | text/x-perl |
#!/bin/python | text/x-python |
FLV | video/x-flv |
MOVI | video/x-sgi-movie |
\037\213 | application/gzip |
Read about the Template Data File and Example Data File to get started building your own Data File
...