User guide 9.22


Basic information

The application is an advanced PIM (Product Information Management) software, natively supporting ETIM and BMEcat standards. It allows collecting and processing (cleaning, correcting, completing) various types of product information: identification, description, technical (ETIM), ordering, packaging, pricing, or multimedia. Product information can be handled in multiple languages. The available API programming interface allows integration with other external systems (ERP, webpages, e-commerce).

The application enables the classification of products according to the ETIM standard and supports for BMEcat files. Product information can also be imported/exported from/to Excel files.

It is a SaaS (Software as a Service) application licensed on a subscription basis and centrally hosted. Users can access it via a web browser (latest versions of Chrome, Opera, Firefox, and Microsoft Edge) or through a Programming Interface (API).


Predefined account types

According to customer needs, we offer the following types of accounts with a different starting configuration of available options:

  • e-start – recommended for companies that need the cheapest minimum configuration necessary to launch e-commerce. The account does not support: ETIM classification, additional technical description, product packing, SEO and WWW information, import/export of BMEcat files, supplier’s/buyer’s management, system product cards and completeness masks.
  • standard – the most flexible choice of options that can be customized exactly to the individual needs of the customer.
  • comfort – increased starting package of options, cost-effective choice for customers requiring advanced solutions.

User types

There are the following types of users:

  • user – regular GUI user; a user can only have one active session at a time; logging in to another browser will automatically close the previous session.
  • API user – user of the programming interface; access to applications for this type of user is limited to the declared IP address and has restrictions on the number of processed requests.
  • manager – in addition to the features of a regular GUI user, the manager can manage the permissions of other users.
  • regional manager – this kind of user has the right to set up and manage accounts for regional companies.

Languages

The application is multilingual. This applies to the following independent aspects of the application:

  • user interface – all GUI elements like: menus, options, messages, etc. are displayed in the language selected from those available for the account. The list of available user interface languages: pl; en; de; fr; hu; no; cs; sk; ru; el; nl; it; es; da; fi; sv; uk; lt; lv; et; ro; pt; tr; bg; sl; hr; sr; bs; mk; sq.
  • product description – all language-dependent elements of the product description, such as: name, description, keywords, etc., can be entered in languages configured for the given account. The list of available product description languages: pl; en; de; fr; hu; no; cs; sk; ru; el; nl; it; es; da; fi; sv; uk; lt; lv; et; ro; pt; tr; bg; sl; hr; sr; bs; mk; sq.
  • ETIM classification – class names, features and values can be displayed in language selected from those available for the given account. The list of available ETIM classification languages: pl; en; de; fr; no; ru; nl; it; es; da; fi; sv; lt; pt. You must confirm the right to use the official language versions of the ETIM or provide your own translation of the ETIM. The official ETIM translations in different languages may differ in scope (not all ETIM sectors are used in different languages). If no translation is available in a particular language, the English version is displayed.

The user guide is only available in English (no documentation language versions, even with the user interface language selected).


Import[Files / Import]

In practice, classification is performed most often based on the existing files containing the list of products, such as price lists. Except for prices, these files usually contain values of some basic parameters that must be assigned to the appropriate parameters required by the ETIM standard.

Import of Excel files

To start the classification work, such a list of products should be transformed into an Excel template (see "Excel templates" section) and imported to the classification software. For example, if you know in advance the ETIM description of your products, you can generate the import templates (Excel files) for the corresponding ETIM class or classes. ETIM templates contain the structure of the ETIM classes with all required features and values to be used within this class. In this way, the whole ETIM classification can be prepared in Excel templates and then the template files filled with the product data can be imported into the classification software. It is the easiest and recommended way, under the condition that you know in advance the ETIM description of your products.

In the same way, it is possible to generate an Excel file with product information, such as: general, ordering, packaging, pricing, MIME, LCA, SEO, WWW or related product information and ETIM class codes.

The usage of the template allows also to import all product data used internally in the application, such as additional technical description, labels, attributes, attribute groups, relations by attribute, suppliers, buyers, categories, category trees and user-defined completeness mask.

The identifiers are stored as a text, so it is recommended that they are provided as text when importing (the numerical values should be preceded by an apostrophe). Importing identifiers which are numbers is potentially risky because conversion from numbers to text is done. This can result in modification of the identifier, e.g. insignificant zeros are omitted (leading or ending on fractional decimal positions), comma used in some countries as a decimal separator is converted to dot, thousandth separators are omitted, etc. All incorrect information is omitted during the import process, for example, values with incorrect header names, incorrect codes of ETIM classes, features or values, etc.

To see how to generate Excel template files, go to the "Excel templates" section.

Import of BMEcat files

If you have previously classified product information in the BMEcat format (supported files in BMEcat version 2005), it is possible to import the whole classification automatically.

Selection of imported elements

Before launching the import, it is possible to select the categories of information to be imported. In this case, only selected categories of information will be imported - under the condition that they are present in the imported file. Some categories of information (e.g. labels) are not present in the BMEcat file, so in the case of selecting this type of information while importing the BMEcat file will have no effect.

Import of product descriptions: basic information

In the case of new products (not existing in the database) the following modes are available:

  • add – imported new products are added to the account.
  • skip – imported new products are skipped.

In the case of existing products the following modes are available:

  • replace * – imported elements replace existing elements of a given type.
  • complete – imported values overwrite only empty values, and imported multiple elements are added to the existing elements.
  • skip – imported existing products are skipped.

* import mode "replace" has an additional setting "Empty fields overwrite existing values": yes/no. The default setting of this option to "no" protects against unintentional deletion of existing values by importing empty values. This can be done consciously by setting this option to "yes".

Import of product descriptions: supplementary information for importing existing products in "replace" and "complete" mode

  1. General - single elements
    • replace – all imported field values are saved; field values that are not imported do not change.
    • complete – imported field values overwrite (complete) only empty fields.
  2. General - multiple elements ("Keyword", "Hazard trigger")
    • replace – the values of all elements are deleted and the imported elements are stored.
    • complete – the imported element is added if it is not already in the account.
  3. ETIM
    • replace – each imported feature value replaces the existing value of that feature; feature values that are not imported do not change.
    • complete – if the value of any field is empty or set to "UN" (unknown), it is completed with the imported value.
  4. Order
    • replace – the values of all fields are deleted and the values of imported fields are stored.
    • complete – if the value of any field is empty, it is completed with the imported value.
  5. Packing
    • replace – all packings are deleted and imported packings are stored.
    • complete – if the imported packing exists in the account (match of non-empty values) then the data of the imported packing completes the data of the existing packing; if the packing does not exist in the account, it is added to the product.
  6. Price
    • replace – all prices are deleted and imported prices are stored.
    • complete – if the imported price exists in the account (match of non-empty values) then the data of the imported price completes the data of the existing price; if the price is not in the account, it is added to the product.
  7. MIME
    • replace – all MIMEs of a given MD code are deleted and imported MIMEs of a given MD code are stored.
    • complete – if the imported MIME exists in the account (match of non-empty values) then the data of the imported MIME completes the data of the existing MIME; if the MIME does not exist in the account, it is added to the product.
  8. Attributes
    • replace – each imported attribute value replaces the existing value of that attribute; attribute values that are not imported do not change.
    • complete – an imported attribute value is saved only if the product does not yet have a value for that attribute in the account.
  9. LCA
    • replace – LCA for a product are deleted and imported LCA is stored.
    • complete – the imported LCA is assigned only if the product has no LCA assigned.
  10. Additional technical description
    • replace – each imported technical parameter replaces the existing technical parameter; technical parameters that are not imported do not change.
    • complete – the imported technical parameter is saved only if the product does not yet have this technical parameter key.
  11. SEO
    • replace – the values of all fields are deleted and the values of the imported fields are stored.
    • complete – if the value of any field in the account is empty, it is completed with the imported value.
  12. WWW
    • replace – all WWW sections are deleted and imported WWW sections are stored.
    • complete – if the imported WWW section exists in the account (match of non-empty values) then the data of the imported WWW section completes the data of the existing WWW section; if the WWW section does not exist in the account, it is added to the product.
  13. Related products
    • replace – all related products are deleted and imported related products are stored.
    • complete – if the imported related product exists in the account (match on non-empty values) then the data of the imported related product completes the data of the existing related product; if the related product does not exist in the account, it is added to the product.
  14. Relations by attribute
    • replace – all assignments of relation by attribute are deleted and imported assignments are stored.
    • complete – if a product is not assigned to an imported relation by attribute, then it will be assigned to that relation; other cases are ignored.
  15. Categories
    • replace – each imported category assignment for a category tree replaces the existing assignment for that tree; categories for category trees that are not imported do not change.
    • complete – if a product is not assigned to an imported category, then it will be assigned to that category; other cases are ignored.
  16. Labels
    • replace – all label assigments are deleted and imported assignments are stored.
    • complete – if a product is not assigned to an imported label, then it will be assigned to that label; other cases are ignored.

Import of additional element definitions

Additional elements mean product information structures defined by the user in the menu: "Configuration", such as labels, attributes, attribute groups, relations by attribute, suppliers, buyers, category trees with categories, and user-defined completeness mask.

Import of additional element definitions is done ONLY in "replace" mode. It is recommended to export to an Excel file the current state of these definitions, modify the selected definitions to the desired form, and then import the Excel file with the element definitions into the application.

Restriction of imported products to the identifiers indicated in the csv file

This option allows you to limit imported products to those indicated in the csv auxiliary file or to skip the products indicated in the csv file. The auxiliary file should contain one column with product identifiers to be taken into account (or omitted) during the import.

This option is disabled by default. It can be activated in "Settings / Import" page.

Import of supplier's files

It is possible to import files of an indicated supplier. In the "Files / Import" form a supplier corresponding to the imported file should be selected ("Import as supplier" field). The supplier has to be earlier defined in the "Settings / Suppliers" page.

When importing a BMEcat or Excel file as a supplier:

  • the main product identifier (SUPPLIER_PID in BMEcat file or "Product ID" in Excel file) is stored as "Product ID by supplier",
  • the product name (DESCRIPTION_SHORT in BMEcat file or "Product name" in Excel file) is stored as "Product name" and "Product name by supplier",
  • the alternative product ID (SUPPLIER_ALT_PID in BMEcat file or "Alt. product ID" in Excel file) is stored as "Alt. product ID by supplier".

In the case of duplicate values ​​of the "Product ID by supplier" field, the application merges products. For new products, the value of the "Product ID" field is automatically generated as a concatenation of supplier identifier, "_" (underscore) and "Product ID by supplier" (the application ensures that there are no duplicates of the "Product ID" field).

Import of own (distributor's) files

When importing a BMEcat file without a selected supplier, all products are imported as distributor products and the fields "Supplier", "Product ID by supplier", "Product name by supplier" and "Alt. product ID by supplier" are empty, meaning "no data". In the case of importing Excel files without a selected supplier, all products are imported as distributor products. In comparison to the supplier's Excel file, the distributor’s own Excel file can contain four additional fields: "Supplier" (an existing supplier identifier), "Product ID by supplier", "Product name by supplier" and "Alt. product ID by supplier". Two of these fields: "Supplier" and "Product ID by supplier" constitute a unique product key and must be imported together (importing a file containing only one of these fields will result in the field being omitted).

In the case of duplicate values of the "Product ID" field, the application merges products. The application takes care of the uniqueness of the field pair: ("Supplier", "Product ID by supplier").

Export of BMEcat 2005 ETIM[Files / Export / BMEcat 2005 ETIM]

It is the default format for product data exchange, recommended by ETIM International. The file is exported in a compressed form (zipped).

All products are exported as the distributor's products. It is not possible to execute the export for an indicated product supplier. The distributor becomes a new supplier of the exported product data. The products are exported without any information about the previous supplier (the fields "Supplier", "Product ID by supplier", "Product name by supplier" and "Alt. product ID by supplier" are not exported, because they are not part of the BMEcat structure).

The following export options are available here (the default values can be customized in the "Settings / Export / BMEcat 2005 ETIM" page):

  • Filter – possibility to export only products that satisfy the defined filter condition.
  • Export as a supplier – possibility to export product information "as a supplier", so that the "Product ID by supplier" becomes the "Product ID" (for details see "Export products as a supplier" subsection).
  • Export as a subsidiary – possibility to generate BMEcat files "as a subsidiary", i.e., with subsidiary data in the header of the BMEcat file as the author/sender of the file.
  • Buyer – possibility to export a file for a single predefined buyer.
  • ETIM version – products are exported by default in the current version of the ETIM. You can select previous ETIM versions (only classes, features, and values, which exist also in the current version of ETIM will be exported).
  • Guidelines version – the current version of the guidelines is set by default. For compatibility reasons, you can select a previous version of the guidelines.
  • Languages – only selected at this point language versions of products will be exported (it concerns elements like name, description long, keywords, etc.).
  • Default language – the default language is placed in the header file BMEcat and identifies the main language of the BMEcat file.
  • Exported price territories – the exported file will contain prices that conform to territories given in this field. Eg. if the territories for the specific price of the product is set to EN, DE, FR, while the export option is set to EN, FR, IT, the price will be exported with the territory EN, FR (the common part of price setting and export setting).
  • Prices without territories – the exported file will contain prices without territories (no territory assigned to the price).
  • Default price territories – default territories for prices without territory explicitly set (mandatory field required in the header of the BMEcat file).
  • Default price currency – default currency for prices without currency explicitly set (mandatory field required in the header of the BMEcat file).
  • Catalog – possibility to select a previously defined catalog, which identifier, name and version will be used in the exported BMEcat file.
  • With "Not applicable" values – the possibility to export "not applicable" empty values marked as "-" (dash) or to omit them during export (see the section "Empty values" for more information).
  • Filename – the name of the exported file (the timestamp is always added to the name).

In general, product description fields that have no assigned value are not exported to the BMEcat file. To avoid errors when validating the BMEcat file, we recommend providing values for mandatory product description fields.

Export products as a supplier

It is possible to export products "as a supplier". This mode allows you to retrieve production information as if it was generated from a supplier account, that is, if the main product identifier is "Product ID by supplier".

When exporting a file as a supplier, only the products of the supplier with non-empty "Product ID by supplier" are exported.

To use this export mode you have to select a supplier in the "Export as a supplier" field. The supplier must be previously defined on the "Configuration / Suppliers" page.

As stated above, when exporting product information "as a supplier" the "Product ID by supplier" becomes the main product identifier. This way of accessing data forces also the substitution of some other fields. The following fields of the exported product information are treated differently:

  • "Product ID by supplier" overwrites "Product ID"
  • "Alt. product ID by supplier" overwrites "Alt. product ID"
  • "Product name by supplier" (if any) overwrites "Product name"
  • "Supplier", "Product ID by supplier", "Product name by supplier" and "Alt. product ID by supplier" (if any) are skipped

Export of Excel[Files / Export / Excel]

It is the auxiliary product data exchange format used for the export/import of all product data. The file is exported in a compressed form (zipped).

All products are exported as the distributor's products. It is not possible to execute the export for an indicated product supplier. The distributor becomes a new supplier of the exported product data. The fields "Supplier", "Product ID by supplier", "Product name by supplier" and "Alt. product ID by supplier" are exported in the corresponding columns.

The following export options are available here (the default values can be customized in the "Settings / Export / Excel" page):

  • Filter – possibility to export only products that satisfy the defined filter condition.
  • Export as a supplier – possibility to export product information "as a supplier", so that the "Product ID by supplier" becomes the "Product ID" (for details see "Export products as a supplier" subsection).
  • Exported elements (product description values) – user can select what kind of product data information should be exported to an Excel file:
    • General – general product information (identifiers, descriptions, codes, numbers, groups, etc.).
    • ETIM class code – ETIM class of the product.
    • ETIM – detailed ETIM classification of products. ETIM classification can be exported in the form of ETIM codes or the form of ETIM description.
    • Order – ordering information.
    • Packing – multi-level packaging information.
    • Price – pricing information.
    • MIME – pictures, certificates, declarations, etc.
    • Attributes – user-defined product attributes.
    • Additional technical description – additional and unclassified technical information (beyond ETIM) assigned to products.
    • SEO – product information that can be useful for positioning pages for a particular product.
    • WWW – product description that can be directly used on product-related WWW pages.
    • Related products – products being in a relationship with the source product.
    • Relations by attribute – relations by attribute to which the product belongs.
    • Categories – product categories.
    • Labels – product labels.
    • Measures of the product description completeness – percentage indicators of product information completeness for every mask and category tree. Measures for masks (general and user-defined) consist of: 1 overall indicator ("Total") and 7 indicators for each category of information ("General", "ETIM", "Order", "Packing", "Price", "MIME" and "Attributes"). Measures for category trees consist of 1 indicator based on the required attributes.
    • Data on modification and creation of products – details of the product modification and creation: the date and user making the modification in each category of product information and the date and user who created the product.
  • Optional elements:
    • General – this option is available only if "General" is chosen in "Exported elements (product description values)". It is possible to select multiple fields from the general product information. Only the selected fields will be exported.
    • ETIM codes/descriptions – this option is available only if "ETIM" is chosen in "Exported elements (product description values)". Depending on the user’s choice, either ETIM codes or ETIM descriptions are exported for classes, features, and values.
    • MIME codes – this option is available only if "MIME" is chosen in "Exported elements (product description values)". It is possible to select multiple MIME codes. Only the MIME elements of the selected codes will be exported.
    • Attributes – this option is available only if "Attributes" is chosen in "Exported elements (product description values)". It is possible to select multiple identifiers of attributes. Only the selected attributes will be exported.
    • Relations by attribute – this option is available only if "Relations by attribute" is chosen in "Exported elements (product description values)". It is possible to select multiple identifiers of relations by attribute. Only the selected relations by attribute will be exported.
    • Categories – this option is available only if "Categories" is chosen in "Exported elements (product description values)". It is possible to select multiple identifiers of category trees. Only the categories from selected category trees will be exported.
    • Labels – this option is available only if "Labels" is chosen in "Exported elements (product description values)". It is possible to select multiple identifiers of labels. Only the selected labels will be exported.
  • Exported elements (definitions) – user can select what kind of definitions should be exported to an Excel file:
    • Labels – list/definition of labels currently available on the account.
    • Attributes – list/definition of attributes currently available on the account.
    • Attribute groups – list/definition of attribute groups currently available on the account.
    • Relations by attribute – all relations are listed containing their identifiers, identifier of the attribute and names.
    • Suppliers – list/definition of suppliers currently available on the account.
    • Buyers – list/definition of buyers currently available on the account.
    • Category trees – a full structure of category trees.
    • Completeness mask (user-defined) – settings of required ETIM features and BMEcat/attribute fields taken into the user-defined measure of the completeness.
  • Exported languages – if a multilingual product description is available for your account, you can choose one or more languages to be exported.
  • Field description language – the language of the field descriptions in the grey information headline and in the signification columns.
  • Additional product identification column – option to add an additional column with a selected product identifier (for easier identification of products by a different identifier than the main product ID).
  • With "Not applicable" values – the possibility to export "not applicable" empty values marked as "-" (dash) or to omit them during export (see the section "Empty values" for more information).
  • Filename – the name of the exported file (the timestamp is always added to the name).

Export of system product cards (up to 200 products)[Files / Export / System product cards]

You can export the product description in the form of a PDF file (system product cards). The cards are generated according to the system product card settings (for more information read the section "Settings / System product cards"). The product cards are exported in a compressed form (zipped).

The following export options are available here (the default values can be customized in the "Settings / Export / System product cards" page):

  • Filter – possibility to export only products that satisfy the defined filter condition.
  • Export as a supplier – possibility to export product information "as a supplier", so that the "Product ID by supplier" becomes the "Product ID" (for details see "Export products as a supplier" subsection).
  • Language of the product description – the products are exported only in one selected here language version.
  • Filename – the name of the exported file (the timestamp is always added to the name).

Export of local product cards (up to 200 products)[Files / Export / Local product cards]

You can export the product description in the form of a PDF file (local product cards). The cards are generated according to the local product card settings (for more information read the section "Settings / Local product cards"). The product cards are exported in a compressed form (zipped).

The following export options are available here (the default values can be customized in the "Settings / Export / Local product cards" page):

  • Filter – possibility to export only products that satisfy the defined filter condition.
  • Export as a supplier – possibility to export product information "as a supplier", so that the "Product ID by supplier" becomes the "Product ID" (for details see "Export products as a supplier" subsection).
  • Language of the product description – the products are exported only in one selected here language version.
  • Filename – the name of the exported file (the timestamp is always added to the name).

BMEcat 2005 ETIM file validation[Files / Validation / BMEcat 2005 ETIM]

Before importing BMEcat files into the application, they can first be analyzed for syntactic correctness and validity of the value format. Analysis of a BMEcat file provides information on whether the file is correct and on any existing errors.

The validation of BMEcat files is carried out on three different levels:

  • syntax of the XML file,
  • validity of the XML file against the detected or indicated XSD schema (compliance of the format and range of acceptable values, dependencies between values),
  • observance of additional rules arising under the "ETIM International Guidelines for suppliers to provide product data" (country-specific validation variants are supported).

Errors are aggregated, showing the total number of occurrences and the line number of the first occurrence.

The validation report is returned to the user in text form (text file). The report can be used for evaluation of the file's correctness or its correction.

Excel file validation[Files / Validation / Excel]

In the validation process, the indicated Excel file is checked for recognizable fields to be imported and for their corresponding values. The following aspects of value correctness are checked: conformity of format, consistency, and range of acceptable values.

The user can choose the scope of file validation (selection of Excel file data sheets that are analyzed). The scope of validation can exceed the permissions of a given user (e.g., in the "Products" data sheet, all elements are validated, even if the user does not have permissions, e.g. for MIME; similarly, the user can validate ECxxxxxxxx data sheets without having permissions for ETIM product data).

Files are not imported, only analyzed, without any reference to the current product data in the application database, then based on this analysis, a corresponding report is generated giving the total number of all errors found in the file. The report contains up to 10000 detailed descriptions of the first errors found.

The validation report is returned to the user in text form (text file). The report can be used for evaluation of the file's correctness or its correction.

Excel templates[Files / Excel templates]

Excel templates are Excel files containing the structure for managing the whole information about products and their classification. They allow to prepare any data information in Excel and then to import it into the application. It is possible to choose which type of product information should be included in the template. The Excel templates are structured in sheets containing different types of information:

  • Products – this sheet provides a structure suitable for preparing data imports for the following product information groups: "General", "ETIM" (class code), "Order", "Packing", "Price", "MIME" (by code), "Attribute", "LCA", "Add. technical description", "SEO", "WWW", "Related products", "Relations by attribute", "Categories" and "Labels". This Excel sheet is common for all products, regardless of ETIM classification. The first column should contain identifiers of products (column named "Product ID"). The first row indicates the group of product information. The second row contains the exact name of the information in each group. Other rows should be filled with values corresponding to products.
  • ECxxxxxx – separate Excel sheet for every ETIM class (EC). The generated template file contains a separate Excel sheet for each requested ETIM class. Because each ETIM class can have a different number of features, there is a two-rows header on each sheet, indicating the meaning of every column corresponding to features. The features (EF) required by ETIM for the given class are displayed in the second row of the header (each feature in a separate column) and a list of possible values (EV) that can be used in each column is displayed in the first row.
  • Labels – Excel sheet used to define labels. The allowed values for letter and color (as well as their default values) are given in the first line of the worksheet.
  • Attributes – Excel sheet used to define attributes. Acceptable, as well as default values for columns that have them, are given in the first line of the worksheet.
  • Attribute groups – Excel sheet used to define attribute groups. The purpose of the subsequent columns is as follows: group identifier, group names (language dependent), list of unconditional attributes, conditional logical attribute (question), list of attributes for the answer "yes", list of attributes for the answer "no".
  • Relations by attribute – Excel sheet used to define relations by attribute. Every row represents one relation by attribute and should consist of: an identifier of the relation (in the first column), followed by the identifier of the global attribute (used in relation) and name of the relation (in languages available for the user).
  • Suppliers – Excel sheet used to define suppliers.
  • Buyers – Excel sheet used to define buyers.
  • Category trees – this sheet contains the following columns (defined in the first row): "Category tree identifier", "Parent category identifier" and "Category identifier"; these columns are followed by columns corresponding to names of categories in languages available for the user and then by one column corresponding to identifiers of attributes (separated by commas) that are assigned to the category tree or the categories. In this sheet, it is also possible to provide SEO attributes that can be used for positioning pages for particular product categories, as well as descriptions that can be directly used on WWW pages dedicated to these product categories.
  • User-defined completeness mask – used to import user-defined completeness mask. It is possible to set the weight of ETIM class, mandatory language(s) and BMEcat/attribute/ETIM fields. The weight of ETIM class is counted in the number of ETIM features, for example, "0 EF" means that ETIM class has no value, "2 EF" means that ETIM class is counted as 2 ETIM features. All mandatory fields should be listed in the appropriate column, according to their scope and settings (+/-). To start modifying the user-defined mask, we recommend to export the current mask and modify the default settings.
  • Info – this worksheet is added by default to every generated template and to each Excel product information file. The "Info" worksheet contains the information about the application version, used to generate a file as well as a lists of acceptable values that can be used for the product description.

Important: when importing product information from Excel templates, the names of the Excel sheets must be preserved; sheets with different names will be omitted.

Disk space[Files / Disk space]

Each account is provided with a disk space remaining at the disposal of the users. The size of the disk space can be adjusted to the requirements of the account owner. The application allows the uploading/downloading of files to/from the disk space and its management (creation of subdirectories). The disk space is available in reading mode for non-logged-in users, so it is mostly used as a storage place for MIME files (photos, drawings, certificates, index cards, etc.). File references (access paths) are placed in the MIME_SOURCE field which allows MIME files to be downloaded by contractors or external systems.

Important: The original names of uploaded files may contain "language-specific" or "system-specific" characters. On the other hand, file names are also used as links in the application and as such can be a potential source of threats. Therefore, file names must not contain any characters other than the permitted ones: [a-zA-Z0-9_-]. If files uploaded to disk space contain non-permitted characters in their names, any single or multiple occurrences of a non-permitted character will be replaced by a single underscore character.

Selected files and subdirectories can be deleted individually or in bulk (continuous selection with the Shift key or selective selection with the Ctrl key). Deleting a directory deletes all its contents (files and subdirectories). Note: deleting files does not remove any MIME elements containing links to the deleted files. The remaining MIME paths pointing to deleted files can be removed using a dedicated administrative procedure (for more information read the section "Settings / Procedures").

For accounts with an active "suppliers" option, subdirectories with names corresponding to supplier identifiers are created in the disk space. In the case of using also the "supplier users" option, each supplier user has access to a subfolder corresponding to a given supplier.


All products[Products / All products]

This page contains a list of all the products loaded for classification.

In this view, it is possible to filter products (filter button is in the upper right corner). Defining a filter involves selecting a field/column and entering values, which are the filtering criteria. The filter can be based on multiple columns (even not visible in the view). Most columns use simple text filtering (with the possibility of using wildcards). There are also columns of select type or date/time or multiple choice type (e.g. labels), which require more filtering conditions. It is also possible to select any non-empty value, or an empty value - as filtering criteria.

To quickly filter products by a selected column, simply click the filtering icon in the column header to set up a filter for that column, or complete the current filter with that column.

It is always possible to clear the filtering criteria of a column without changing the filters of other columns (useful for modifying filters based on multiple columns). All filtering criteria must be met together (implicit "AND"). The filter can be saved - this way the list of products "seen" by a given user will be limited to products that meet the criteria defined in the filter. Several filters can be defined, but only one of them can be active. The product view also allows you to sort products by a specific column.

The displayed columns can be arranged according to the user's needs. It is possible to hide/unhide columns as well as change their order. Just select the option "Arrangement of columns" from hamburger menu , then click on the desired column to hide/unhide it or drag and drop the columns in order you want them to be displayed. At least two primary columns in this view ("Product ID" and "Product name") must remain visible and cannot be hidden.

You can also choose the order in which the columns are displayed: just select the option "Arrangement of columns" from hamburger menu , then drag and drop column names in order you want them to be displayed. The first column is locked when scrolling the columns to the right, so it is convenient to put there the selected product identifier.

To delete product(s), select the product(s) to remove and choose the option "Remove products" from hamburger menu .

Group modification for multiple products is possible for certain features. To collectively modify such parameters of selected products, you must:

  • expand the group modification panel (group modification button is in the upper right corner),
  • select the column(s) to be modified in the panel, and then specify a new value(s) for the selected column(s) (headers of the modified columns are highlighted in blue),
  • select the products for which the new value is to be applied (the modified product values are highlighted in blue),
  • click the "Modify" button on the group modification panel to perform the modification.

A quick access icon is available for group modification related to the selected column - just click the group modification icon in the column header to open the modification form of that column.

This screen offers also a possibility to:

  • add a new product manually ("plus" icon ) – you only need to provide its unique identifier; the remaining elements of the description should be completed in the "Edit product" view or by the import.
  • create a new product based on an existing one by cloning it (select the option "Clone product" from hamburger menu ) – it is required to provide only a unique identifier of the new product; the other elements are copied from the original.
  • export product data of selected products – after selecting the products choose one of the export options from the main menu.

There are other functionalities available (from hamburger menu ) for selected products:

  • "Add cards" – you can complete the product description by adding product cards generated by the application to the MIME elements (as MD22).
  • "Link by attribute" – selected products can be related by global attribute; to accomplish the relation by attribute for the selected product the user should select the relation attribute and then indicate an existing relation or create a new relation by attribute, giving its identifier and name in language(s) available for the account.
  • "Add submission" – add a submission related to the selected product.

Products by ETIM[Products / Products by ETIM]

A list of classified products is available on this page. Products are grouped according to the ETIM classification. A list of products classified in a single class helps to check the correctness of filling of individual parameters of every product.

This view allows you to sort, filter, selectively delete products or globally modify parameters of selected products.

To delete product(s), select the product(s) to remove and choose the option "Remove products" from hamburger menu .

To collectively modify parameters of selected products, you must:

  • expand the group modification panel (group modification button is in the upper right corner),
  • select the column(s) to be modified in the panel, and then specify a new value(s) for the selected column(s) (headers of the modified columns are highlighted in blue),
  • select the products for which the new value is to be applied (the modified product values are highlighted in blue),
  • click the "Modify" button on the group modification panel to perform the modification.

A quick access icon is available for group modification related to the selected column - just click the group modification icon in the column header to open the modification form of that column.

By default, all ETIM features are displayed. Anyway, you can modify this view by choosing the ETIM features (columns) to be displayed: just select the option "Arrangement of columns" from hamburger menu , then click on the selected column names to hide them or make them visible again.

Products by categories[Products / Products by categories]

Products can be accessed by the category trees. After selecting a category tree it is possible to navigate in its structure, seeing all subcategories or products assigned to the current category.

The application allows assigning products at all levels of the category-tree structure (not only at the leaves-level).

Products for synchronization[Products / Products for synchronization]

In this view, the user can set the range (scope) of the selected synchronization and trigger it for selected products between the current account (source) and target account (target).

Only products having at least one synchronization label are visible here. If any synchronization is set by the administrator (configuration of source-target relation between accounts), the synchronization label is created and available in the source account. Synchronization labels can be attributed to products that are subject to synchronization.

Migration ETIMv8/ETIMv9[Products / Migration ETIMv8/ETIMv9]

On this page, there is a list of classified products, affected by the migration. They are called "products for confirmation". The following changes in the classification of products are shown:

  • ETIM class change – a remapping of ETIM class is shown in the format: "ETIMv8 class ➤ ETIMv9 class" (for example, class of version 8 is not present in version 9),
  • deleted feature within the class – such features are shown as "dimmed" on the screen,
  • a new feature within the class and an alphanumeric feature with new values – such features are marked in green,
  • a new value of the alphanumeric features – such values are marked in green,
  • deleted value of alphanumeric feature – such values are marked in red.

In the case of non-unique mappings (when a deleted class has multiple successors), the product is migrated to the best-fitting class, and alternative successors are listed after the selected class.

The user can filter products and modify values globally for multiple products (group modification button is in the upper right corner) and confirm its migration (select the option "Confirm the migration" from hamburger menu ). In this way, the modification and the approval of all migrated products can be done in one place.

All the products confirmed by the user are no longer visible on this page. It is recommended to review and confirm all products affected by the migration. Click the "list ul" icon to check the initial number of products for confirmation.

Edit product

Click the "pencil" icon on the left of the product (on each "Products" view) to open its modification view. The view consists of the following tabs:

  • General – possibility to add, modify or remove general information of the product.
  • ETIM – here you can select the class, appropriate to the selected product. Finding the appropriate class is a difficult task, even for a small number of products. Therefore, the software has a mechanism suggesting the possible ETIM classes, appropriate for the selected product on the base of his name and imported information. Displaying classes can be sorted or limited by a filter. When the appropriate class is selected for the product, all the features required by this ETIM class are displayed. The user’s job is to provide appropriate values for each feature. For missing/empty values it is possible to indicate the reason, by choosing either:
    • not applicable (NA) – if the feature doesn’t apply to the current product,
    • unknown (UN) – if the value is not delivered by the supplier/manufacturer.
    Any useful technical information that may be helpful for the ETIM classification can be imported from the Excel file as an additional technical description. This information can be automatically or manually associated with the technical features required by the ETIM class of the product. In this way, the application "learns" by associating additional technical description to the ETIM features, so the next time (for the next product of the same class) the corresponding values can be automatically suggested. The values suggested by the application are indicated by a grey/blue/yellow background (for more information read the section "Settings / ETIM classification"). Suggestions can be turned on/off. All fields which are automatically filled in the classification process must be accepted by the user.
  • Order – possibility to modify ordering information of the product.
  • Packing – possibility to add, modify or remove packing information of the product.
  • Price – possibility to add, modify or remove pricing information of the product.
  • MIME – possibility to add, modify and delete photos, datasheets, and product safety cards. The MIME items are displayed in the order of the MIME codes; in the case of several items with the same code, it is possible to set any of them as the first (click on the "up arrow" icon ).
  • Attributes – possibility to add, modify or delete product attribute values, also within attribute groups (for more information read the section "Configuration / Attributes" and "Configuration / Attribute groups").
  • LCA – possibility to add, modify or remove LCA (Life Cycle Assessment) of the product.
  • Additional technical description – possibility to add, modify or remove entries of product additional technical description.
  • SEO – possibility to enter data to improve the positioning in search engines results.
  • WWW – possibility to enter information to facilitate and enrich the presentation of product information on websites.
  • Related products – displays all related products with their identifier, name, relation type and quantity. Every relation can be modified or deleted. The relation is a part of the ETIM/BMEcat standard.
  • Relations by attribute – displays all existing relations by attribute (group of products related by an indicated global attribute). You can assign the current product to any of these relations or remove it if it is already there. The relation is out of the ETIM/BMEcat standard (for more information read the section "Configuration / Relations by attribute").
  • Categories – possibility to assign the product to the categories (for more information read the section "Configuration / Category trees").
  • Labels – possibility to mark the product with previously defined labels (for more information read the section "Configuration / Labels").
  • Description completeness – displays all elements taken into account for the product description completeness. The measure of product description completeness is related to the default or user-defined completeness mask. However, it can also be related to the category tree. If any category tree has been previously defined, it is possible to change the display of the completeness measure for the selected tree. In this case, the attributes required for the category tree are taken into account.
  • Local product card – displays the selected information about the product in the chosen language (for more information read the section "Settings / Local product cards").
  • System product card – displays the system product card in a new browser tab, according to the current settings of the content and the default language, with the possibility to change the language (if available) and to download the card as a pdf file (for more information read the section "Settings / System product cards").

Not applicable values

The application allows you to mark empty values as "not applicable", which means permanently missing values, to clearly indicate values that cannot be provided (it is useless to ask for them in the future). These values are marked with a dash "-" (see the section "Empty values" for more information).

Description completeness[Products / Description completeness]

This page shows the total average product description completeness.

Since products may differ in the total number of elements of the product description (a number of features depending on ETIM class; a number of attributes; a number of multiple elements), the total completeness of the product description is calculated as a weighted average of the respective product description groups. The following percentage share of product information groups was assumed:

  • General - 15%,
  • ETIM - 20%,
  • Order - 15%,
  • Packing - 15%,
  • Price - 15%,
  • MIME - 15%,
  • Attributes - 5%.

By default, the measure of product description completeness is related to the default or user-defined completeness mask. In each case, the average completeness description is shown also in every information group. The product description completeness can be calculated and displayed also concerning the previously defined category trees.

The product description completeness can be calculated for all products (it is the option by default - no filter selected) or for selected products (a previously defined filter should be used).

Besides the numerical completeness indicators, bar charts are showing the distribution of products in a few groups of the description completeness:

  • 0%,
  • 1%-20%,
  • 21%-40%,
  • 41%-60%,
  • 61%-80%,
  • 81%-99%,
  • 100%.

This product distribution can be helpful to improve and monitor the product description completeness for the selected point of view: completeness mask or category trees, for all or filtered products.

Accounts with suppliers can generate statistics by individual suppliers. In order to generate such a report, in the field "Report type" you should select option "per supplier".


Labels[Configuration / Labels]

User can view, modify or delete labels. Labels can be used for visual indication of products, filtering or grouping. If an existing label is deleted, it is removed from all products marked with it. Some labels can be marked as "favorites" (by clicking on the "hollow star" icon ). The favorite labels always appear first, making them easier to find when you have a large number of labels in use.

Filters[Configuration / Filters]

User can view, rename, delete or activate defined product filters. Some filters can be marked as "favorites" (by clicking on the "hollow star" icon ). The favorite filters always appear first, making them easier to find when you have a large number of filters in use.

Attributes[Configuration / Attributes]

User can define, modify or delete additional product attributes.

The attribute can be defined as:

  • multilingual text,
  • text,
  • number,
  • range,
  • logical value,
  • date,
  • select,
  • reference.

Each attribute can be assigned to:

  • category tree as the attribute required for each product which belongs to at least one category of this tree.
  • category as the attribute required for each product which belongs to this category.

When creating an attribute, it is possible to choose whether it is global or not:

  • a global attribute is visible (in the "Attributes" tab in the "Edit product" view) for all products (additionally, it is possible to indicate whether the global attribute will be synchronized).
  • a non-global attribute is visible (in the "Attributes" tab in the "Edit product" view) only for products that are assigned to the appropriate categories (which have this attribute indicated as required).

It is also possible to set the importance of the attribute (used for example by e-commerce system). The importance can be set as a numerical value within the range: 0-9.

If an attribute is to be exported in a BMEcat file, it must be marked as a product characteristic. Attributes marked this way are exported in the UDX.EDXF.PRODUCT_CHARACTERISTIC element.

Each attribute of type "reference" is a reflection of a selected BMEcat field from the "General" section. Physically, it is the same field, visible under a different name, as a user-defined attribute. Changing the value of one of these attributes alters the value of the indicated BMEcat field.

Attribute groups[Configuration / Attribute groups]

Attribute groups can be used to group user-created attributes. This makes it easier to organize and complete attributes, especially when there are a large number of attributes. In the basic version, an attribute group has an identifier, a (language-dependent) name, and a list of identifiers of the attributes that belong to the group. Attribute groups are not hierarchical, they are all created at the same level. In the product edit view, attributes are displayed according to the definition and order of the groups and attributes within each group, set by the user when defining the groups. Attribute groups with the same name are displayed together under a common name.

In a more advanced version, it is possible to make the list of attributes in a group partially or completely dependent on a logical attribute (question). In this case, lists of attribute identifiers are provided, which are valid for a positive or negative answer to the attribute used in the question. One or both lists can be used simultaneously in the group definition.

Relations by attribute[Configuration / Relations by attribute]

User can view/create/modify the relations by attribute. All existing relations by attribute are listed here with their identifiers, names, grouping attribute and related products. User can add a new relation or modify the existing relation(s). To add a new relation it is necessary to select one of the global attributes as the grouping attribute, add a relation identifier and enter the name(s) of the relation. Once the relation is created it appears on the list of relations. Here, there are two buttons to modify the relations by attribute: one for basic modification (grouping attribute, identifier or name) and the second to assign product(s) to the relation by indicating/searching their identifiers.

It is also possible to add a virtual product to the relation by attribute. A virtual product is a concept used to represent a group of similar products that differ in only one parameter (e.g. color, size). All virtual products have a system label "Virtual" (letter V in the gray circle). An existing virtual product can be added to the relation or a new virtual product can be created and added to the current relation by copying one of the products already present in the relation - in such case all fields of the source product are copied into the new virtual product, except the labels and the grouping attribute (the grouping attribute in the virtual product should be empty; only real products should have it assigned).

Removing a virtual product from a relationship does not remove it from the product database.

Suppliers[Configuration / Suppliers]

Allows users to manage the information concerning the product data suppliers. When a user creates a supplier, a unique alphanumeric identifier must be assigned to the supplier. This identifier is then used for referencing a supplier in the application (for example in import options).

Buyers[Configuration / Buyers]

With this option it is possible to define product information recipients (buyers). This allows to generate dedicated product information for specific buyers.

Catalogs[Configuration / Catalogs]

The word "catalog" refers to files containing product information, transmitted in a standard format (e.g. BMEcat, xChange). The supplier can manage the names and versions of the catalog files in a structured way, often in agreement with the recipient of the product data. For this purpose, it is possible to create catalogs (ID, name, version) in the application and use them throughout the cycle of exchanging product information with the contractor(s).

Category trees[Configuration / Category trees]

This setting option allows us to define or modify category trees to be able to assign a product to categories.

To create a category tree it is necessary to give a unique identifier. Optionally, it is possible also to define a tree name (in every language available for the user). Then, it is possible to define a hierarchy of categories by giving their identifiers and names. Categories can be nested (every category can have one or more subcategories). It is possible to cut (remove) categories or subcategories together with the whole branch or move it into another place in the category tree (important: cutting a category or subcategory removes all the assignments of product for the removed branch).

Every additional product attribute can be assigned to:

  • category tree as required for all products belonging to this tree.
  • category as required for all products belonging to this category.

These attributes are the basis for calculating the measure of product description completeness from the category tree point of view.

Category trees can be also imported and exported via Excel files or API.

API Gateway[Configuration / API Gateway]

An option typically used by wholesalers, or product data centers, to allow commercial access to their own products via APIs for third parties. This option allows you to:

  • provide API access to selected products (visible are only products marked with the system label "API_Gateway" or alternatively specified by a special rule).
  • define different levels of access to product data (specify the fields to be available at each level).
  • manage API Gateway users at each access level.
  • get access to a web page that describes the available access levels and the API Gateway documentation.

Translations[Configuration / Translations]

Designated, trusted users, in agreement with the administrator, may be permitted to modify the translation of phrases used in the application, in one or more languages.


Overview[Administration / Overview]

The regional manager can view here the data of:

  • users (GUI/API) corresponding to the regional companies he has established,
  • regional companies.

Logs[Administration / Logs]

The regional manager can view here the system logs for:

  • product operations,
  • label operations,
  • attribute operations,
  • attribute group operations,
  • relations by attribute operations,
  • supplier operations,
  • buyer operations,
  • category tree operations,
  • user-defined completeness mask operations,
  • synchronization trigger operations.

API[Administration / API]

The regional manager can view here the API request statistics (broken down by the request type: "GET", "PUT", "DELETE") made by API users during the last seven days.

Companies[Administration / Companies]

Here, the regional manager can create/edit/delete companies in his region and create/edit/delete GUI and API users.

Supplier users (GUI)[Administration / Management / Supplier users (GUI)]

Manager can create GUI users for suppliers to allow them to modify their own products (applies to accounts with the supplier management option). GUI supplier users only have access to the products of a particular supplier (they cannot see the products of other suppliers).

The permissions of GUI supplier users are restricted to modification of production information only. The scope of product information available for editing or viewing is defined by the manager ("Permissions" button). The settings for visible and editable fields are common to all GUI supplier users (there are no personalized settings for individual suppliers or individual GUI users).

The manager can define a pop-up visible to supplier users, appearing at login. The defined window can contain a title and content, with no formatting options. It is possible to insert line break characters (enter) and URL links, placed in square brackets, which will be automatically converted into active links (clicking on the link will open a new tab in the browser with this URL).

Supplier users (API)[Administration / Management / Supplier users (API)]

Manager can create API users for suppliers to allow them to access or modify their own products (applies to accounts with the supplier management option). API supplier users only have access to the products of a particular supplier (they cannot see the products of other suppliers).

The permissions of API supplier users are restricted to modification of production information only. The scope of product information available for editing or viewing is defined by the manager ("Permissions" button). The settings for visible and editable fields are common to all API supplier users (there are no personalized settings for individual suppliers or individual API users).

GUI users[Administration / Management / GUI users]

Manager can grant or withdraw permissions to regular users.

API users[Administration / Management / API users]

Manager can manage API user permissions (if only such users have been created in the account).

Procedures[Administration / Procedures]

The concept of adding predefined administrative procedures to the application has been introduced. Such procedures can be executed on all products or selected by a filter.

The first of them is the procedure of deleting MIME paths to non-existent files in disk space. This procedure allows clearing MIME elements from paths pointing to non-existent files in the disk space of a given account. If the MIME element corresponding to the deleted path has no other paths, it will be deleted. This procedure was introduced in conjunction with the ability to delete files from disk space in bulk, which is done without deleting any MIME paths associated with the deleted files. It helps to maintain the consistency of files and MIME paths.

Submissions[Administration / Submissions]

The application allows you to report issues concerning the operation of the application or product description.

Every submission contains user (author), type of report (products/application/other), title, status (open/closed), creation date, closing date, and discussion (entries added by users or administrators).

It is possible to sort/filter submissions by status, submission type, author, submission title, creation date, closing date, last entry date.

For submissions concerning products, it is possible to indicate the products concerned by the submission.

New notifications are indicated to other users by dots placed in the menu. Dots are also visible next to new notifications or notifications to which a new entry has been added (next to the column "Last entry"). After entering/reading such a submission the dot indicative will disappear from this submission. Once you have read all the entries, the dots also disappear from the menu item ("Administration / Submissions").

It is possible to add submissions of "products" type directly from the product list. After selecting the products (up to 5 products can be selected), the "Add submission" option must be selected. This creates a new submission of "products" type with pre-selected products. The remaining fields in the form must be completed manually.


Account[Settings / Account]

User can edit the account settings.

Permissions[Settings / Permissions]

User can see here his permissions to different functionalities, assigned to him by the administrator.

Company[Settings / Company]

User can edit the information concerning his company.

If the account has the user-defined mask option enabled it is also possible here to choose which mask (default or user-defined) is taken to indicate mandatory fields in Excel files downloaded via export links.

User can specify which types of MIME files (which MIME codes) are to be displayed in the application (local and system product cards, product catalog).

It is possible to define subsidiaries assigned to an account in the company data. This enables the generation of BMEcat files with subsidiary data in the BMEcat file header as the author/sender of the file.

ETIM classification[Settings / ETIM / ETIM classification]

User can personalize here the settings corresponding to ETIM classification, such as ETIM classification language (the language in which the ETIM classification is processed and displayed), display settings or settings for automatic suggestion rules. Suggestion rules provide hints at different levels of trust:

  • "similarity" matches coming from the previous classifications (rules and hints are displayed in grey),
  • exact matches (rules and hints are displayed in blue),
  • fuzzy matches (rules and hints are displayed in yellow).

Every suggestion rule can be activated or deactivated, and it is also possible to set the priority of the rules - by setting their order (using the drag-and-drop method).

ETIM override[Settings / ETIM / ETIM override]

An option that allows you to replace the original feature (EF) and value (EV) names of the ETIM standard with your names. It is also possible to override units (EU) of some numeric and range features (within the allowed conversion range).

Override of features and values is done in the context of particular classes: first, the user has to select the class where the overrides are to be done, then the user has to enter new names for selected elements in individual languages. Once saved, such a class is placed in the list of overridden classes with an indication of the number of overridden features, values and units.

The user can select the languages in which the predefined override is to be applied. The overridden names will be used/visible in:

  • the local/system product cards,
  • exported Excel files (with ETIM descriptions)
  • API GET requests (product(s) data in a language-dependent version).

It is also possible to hide selected ETIM features. A user-defined completeness mask is used for this purpose. In this case, only the mandatory features from the completeness mask are displayed.

Import - default options[Settings / Import]

User can edit default values for import options.

Export of BMEcat 2005 ETIM - default options[Settings / Export / BMEcat 2005 ETIM]

The user can edit default values for export options of BMEcat files, such as the filter to be used for exporting products, in which ETIM version, guideline version, and in which languages the file is to be exported; which prices are to be exported, whether the version number of the exported catalog is to be given (provided that a catalog with its name and version has been previously created - section "Configuration / Catalogs"). These settings are set by default and will be pre-selected when exporting the BMEcat file, making it easier and faster to perform regular exports.

One of the available options is the possibility to define dedicated settings of exported BMEcat files for specific buyers (section "Configuration / Buyers"). This allows you to quickly export BMEcat files for specific buyers, using pre-defined settings dedicated to particular recipients (buyers).

Export of Excel - default options[Settings / Export / Excel]

User can edit default values for export options of Excel files.

Export of system product cards - default options[Settings / Export / System product cards]

User can edit default values for export options of system product cards.

Export of local product cards - default options[Settings / Export / Local product cards]

User can edit default values for export options of local product cards.

BMEcat 2005 ETIM file validation - default options[Settings / Validation / BMEcat 2005 ETIM]

User can edit default values for validation options of BMEcat files.

Excel file validation - default options[Settings / Validation / Excel]

User can edit default values for validation options of Excel files.

Synchronizations[Settings / Synchronizations]

User can edit default values for all options of product synchronizations and define the synchronization triggers. For each synchronization trigger, a configuration is defined and saved. Defined synchronization triggers can be started via API or scheduled for an auto-start time.

Completeness mask[Settings / Completeness mask]

User can choose here the mask of product description completeness (default or user-defined) and view/edit the settings of the masks. Mandatory fields determined by the current completeness mask are marked in bold in the application.

The default mask is based on all ETIM features and selected (most frequently used) BMEcat fields. The view of the default completeness mask is "read-only" (user can only see mandatory fields).

The user-defined mask, however, is available in the "read/write" mode. This mask is an alternative to the default completeness mask. It allows us to selectively indicate the required ETIM features and BMEcat/attribute fields. It is also possible to set the weight for the ETIM class, select the languages and indicate the MIME types taken into the measure of the completeness:

  • attribution of the ETIM class for a product can be considered as a part of ETIM description and counted in the number of ETIM features (for example, "0 EF" means that ETIM class has no value, "2 EF" means that ETIM class is counted as 2 ETIM features),
  • if multiple product description languages are enabled for a user account, it is possible to indicate which language(s) should be taken into the measure of the completeness,
  • for MIME files, it is possible to indicate what type of MIME should be counted; a user can choose among following MIME groups:
    • any image of the product (MD01; MD10; MD12; MD18),
    • product card (MD22),
    • product picture (MD01).
    If MIME groups are specified, a MIME with at least one code from each selected MIME group is required.

There is a possibility to copy the default mask settings to the user-defined mask, using the corresponding buttons.

In accounts with a user-defined completeness mask enabled, on the "Settings / Company" page it is possible to choose which mask (default or user-defined) is taken to indicate mandatory fields in Excel files downloaded via export links.

System product card[Settings / Product card / System product card]

Allows to personalize the contents of the system product card by selecting the elements (fields) to be visible on the product card. It is possible to choose a template for the system product cards between default or dedicated for the company (if it was ordered and created). It is also possible to select a range value separator.

System product cards are used to present information about the products to be seen by people downloading information directly from the system. A link to the system product card allows you to download a product card generated on-line, containing current product information. Settings of the system product card are common for the whole company account (changes made by one user are visible for another user of the same company). System product cards can be exported as external links.

Local product card[Settings / Product card / Local product card]

Allows to personalize the contents of the local product card by selecting the elements (fields) to be visible on the product card. It is possible to choose a template for the local product cards between default or dedicated for the company (if it was ordered and created). It is also possible to select a range value separator.

Local product cards allow the user to select and present only product information that is visible to him (only the user can generate a product card according to local settings). The local card settings are individual for each user (changes made by one user are not visible for other users). Local product cards cannot be exported as external links.


Filtering with wildcards

Wildcards are special characters used to represent or match a range of other characters in a search pattern. The following wildcards can be used in filters to be considered as a match for another string:

  • ? (question mark) to match a single character.
  • * (asterisk) to match multiple characters.
  • ^ (caret) for matching the beginning of a string (only if it is the first character in the search string).
  • $ (dollar) for matching the end of a string (only if it is the last character in the search string).

Examples:

  • AB?123 matches ABA123, SABB123, ABC1234, etc.
  • AX*Z matches AX321oiuXYZ, AX_ZR, BAX000ZR, etc.
  • ^ABC matches ABCDE, while ^BC doesn’t match ABCDE.
  • CDE$ matches ABCDE, while CD$ doesn’t match ABCDE.

The backslash (\) can be used as an escape character to indicate that the character following the backslash should be interpreted differently from its default "wildcard" meaning.

Examples:

  • AB\?123 matches AB?123, SAB?123, AB?1234, etc.
  • AX\*Z matches AX*Z, AX*ZR, BAX*ZR, etc.
  • \^ABC matches ^ABCDE, SA^ABCDE, etc. (using ^ inside or at the end of the matching string doesn't require an escape character).
  • CDE\$ matches ABCDE$, ABCDE$AS, etc. (using $ inside or at the beginning of the matching string doesn't require an escape character).

Filtering with special values

In addition to filtering products with specific values (which may involve wildcards), it is also possible to filter products with special values. These include:

  • empty values ("barred circle" icon ).
  • not empty values ("asterisk" icon ).
  • values marked as "not applicable" ("dash" icon ).
  • in addition, when filtering ETIM values, there is the option to select "unknown" values ("question mark" icon ).

There is a fairly significant difference between the special symbol for not empty values ("asterisk" icon ) and the wildcard symbol * (multiple characters). The first one (not empty value) will match all values other than empty values, so also "not applicable" or "unknown" values. In contrast, the second one (wildcard *) will only match values containing at least one arbitrary alphanumeric character; so in this case, there will be no match to special values "not applicable" or "unknown".

Filtering by a chain of values

Filters imposed on text fields have a new option ("chain" icon ) to specify a list/chain of values separated by a semicolon (a maximum of 200 can be specified). The filtering results in products that match at least one of the specified values (logical "OR"). This option can be useful e.g. for filtering products according to the indicated identifiers.

The value chain is also available for selecting values when filtering using "select" type fields.


Input data cleaning

To ensure the correct operation of the application and its scripts, the following characters are cleared in all data imported by the application:

  • ASCII characters with numbers from 0 to 31 and from 128 to 159 are removed (excluding LF and CR characters in fields that are of "textarea" type in the application),
  • the apostrophe ' is replaced by the apostrophe ’,
  • the non-breaking line character (160) is replaced by a space character (32).

Empty values

Empty values of product information fields are commonly present in most products. Blank values in mandatory fields (according to the default or user-defined mask) reduce the completeness of the product description. In contrast, empty fields in optional fields do not affect the completeness rate of the product description.

The application gives you the opportunity to mark empty values as "not applicable", which means permanently missing values, in order to clearly indicate values that cannot be provided (it is useless to ask for them in the future). These values are marked with a dash "-". Not applicable values can be exported/imported (using BMEcat or Excel files, or via the API), depending on the options used. This applies to values other than ETIM values, which already have their own designations: "unknown" and "not applicable".


"Read-only" mode

In exceptional situations, such as urgent maintenance work or hardware failure of the main server, the application can be switched to the "read-only" mode (blocking product modifications for all GUI and API users). Information about the "read-only" mode is displayed in the red bar at the top of the screen.

In such cases, the application is made available in the state of the last available stable state or last stable backup. In the case of switching to the backup server, the last stable backup comes from 3.00 a.m. and may be different from the last state of the products before the failure.

The use of this "read-only" mode is intended, on one hand, to ensure continuous access to product data and, on the other hand, to avoid data inconsistency (between the last product state, data from a stable backup and ongoing changes). At the same time, it will allow to restore full functionality of the application as soon as possible with the last available stable state.


Limits

The size limit for a single file uploaded to the application is 64 MB. This limitation applies equally to files uploaded to disk space and to files used to import product data (Excel, BMEcat). In the case of BMEcat file import, it is recommended to use compressed (zip) files, which allows for importing files of much larger volume.

The size limit for images shown on product cards (web and pdf) is 20 MB. Files of larger size are ignored when generating product cards. This limitation is due to memory and time constraints (scaling of large images is memory-intensive, in addition, with external links it is necessary to download the file which can significantly increase the time of generating product cards).


Maintenance window

Maintenance of the Service requires periodic maintenance work related to software updates, architecture changes, or hardware replacement. This type of work is performed during the so-called "maintenance window" from 23:00-1:00 CET, and during this time the Service may be temporarily unavailable, so any user activities requiring the stability of the Service should not be scheduled during these hours.

Kontakt

Związek ZHI
Tomasz Boruc
+48 510 277 777
tomasz.boruc@zhi.org.pl