Overview about build and besting status as well as status of compliance of coding principles.

Build:

In order to use the BMEcatConverter you need a python installation. The Python version, for which this Converter was developed is python 3.4.4 due to its availability as an Windows Installer. It should be able to run on higher version as well. Please make sure you added python to the path-Environmentvariable and that you installed the requirements.txt within a commandline shell with administrator permissions using pip install -r requirements.txt.

The BMEcatConverter is a tool to convert BMEcats into a special Excel-Workbook (Mappiong-Master) and vice versa.

• The first case, converting from BMEcat into Excel, which result in a workbook with three sheets:
  • Article Data - all the data belonging to one article is in one row (This is called Mapping-Master-Format.)
  • Article Relations - the relation between two articles is defined in one row
  • Search Words per Article - one row contains all searchwords, for this article
• The second case is converting from an Excel-Workbook (Mapping-Master) The outcome is a BMEcat Version 1.2. The BMEcat contains only one featureset per article.

The BMEcat-Converter has to be used with the following arguments:

• -i "%path_to_inputfile%" this can be a relative or absolute path, it has to be either an Excelfile (*.xlsm or *.xlsx) or a BMEcat-file (*.xml).
• -o "%path_to_outputfile%" this can be a relative or absolute path, it has to be either an Excelfile (*.xlsm or *.xlsx) or a BMEcat-file (*.xml).
• --dateformat="%Y-%m-%d" the dateformat has to be provided, if you convert from XML to Excel (Case one). You can usually derive the dateformat from the generation date of the BMEcat. If you use a cmd-file for running the converter you should escape the percentage sign by double-typing, i.e., "%%Y-%%m-%%d".

Thus with calling python src/main.py -i "%path_to_inputfile%" -o "%path_to_outputfile%" will work if you convert from an Excelfile to a BMEcat.

The following options are set to default values:

• --dateformat=None
• --validation="strict" Default validation dissolves to strict, this means if an validation fails, an exception is raised and the conversion fails.
• --manufacturer=None Default Manufacturer if no manufacturername is provided in the BMEcat.
• --separators=autodetect Default is autodetect, which tries to resolve the thousands- and decimalseparator

The options can be changed as follows:

• --dateformat="%Y-%m-%d" has to be set if the generation date looks like "2018-9-18". %Y is the year with century, i.e., 2018 %y is the year without century, i.e., 98 for 1998, 01 for 2001 %m is the month %d is the day of the month %h is the hour %M is the minute %S is the second
• --validation="strict" In order to loosen the validationrules one could set the validation with the option --validation="nonstrict. strict means if a validation fails, an exception is raised and the conversion fails. anything_else only writes warnings but will create a BMEcat if nothing really bad is inserted.
• --manufacturer
• --separators=autodetect three states are possible
  • autodetect: tries to autodetect thousands- and decimalseparators
  • english: set thousandsseparator to comma and decimalseparator to dot.
  • german: set thousandsseparator to dot and decimalseparator to comma.

The first case, converting from BMEcat into Excel covers the following aspects:

• The first sheet is called 'Artikel'. It contains the following fields:
  • Article/Product
    • suplierArticleID
  • Article/ProductDetails
    • title(descriptionShort)
    • description(descriptionLong)
    • manufacturerArticleID
    • manufactuerName
    • GTIN
    • deliverytime
  • orderDetails
    • OrderUnit
    • ContentUnit
    • No_CU_per_OU
    • quantityMin
    • quantityInterval
    • priceQuantity
  • PriceDetails
    • Prices
      • validFrom
      • validTo
      • priceType
      • priceAmount
      • priceCurrency
      • tax1
      • priceFactor1
      • lowerBound1
  • MimeInfo
    • Mime
      • mimeType1
      • mimeSource1
      • mimeDescription1
      • mimePurpose1
      • mimeOrder1
  • FeatureSets
    • Feature
      • attributeName1
      • attributeValue1 combination of value and unit
• The second sheet is called 'Artikelbeziehungen'. It contains all relations between all articles in the BMEcat. Every row contains one relation. The columns are named as follows:
  • supplierArticleId
  • referencType
  • referencedSupplierArticleId
• The third sheet is called 'Artikelsuchbegriffe'. It contains all searchwords for all articles. One row contains all searchwords for one article. The columns are named as follows:
  • supplierArticleId
  • keywords