Blue Yonder CSV to XML converter

This tool is intended to convert a .csv file into an .xml file ready to be sent to the Blue Yonder Supply and Demand API. This tool has no schema information and therefore does not perform any validation besides checking for valid UTF8 encoding.

Usage

bash di-csv2xml --category Category --input input.csv --output output.xml

converts this input.csv file

csv A,B,C,D 1,2,3,4 5,6,7,8

into this output.xml:

xml <?xml version="1.0" encoding="UTF-8"?> <Category> <Record> <A>1</A> <B>2</B> <C>3</C> <D>4</D> </Record> <Record> <A>5</A> <B>6</B> <C>7</C> <D>8</D> </Record> </Category>

The shell's pipe functionality can be leveraged to produce the same result:

bash cat input.csv | di-csv2xml --category Category --input - > output.xml

Each line of the input.csv file is transformed into a separate XML-record. These are globally embedded into a root-tag structure specified by the parameter Category.

Customer extensions are supported via the CUEX_ prefix.

csv A,CUEX_B,C,CUEX_D 1,2,3,4

becomes

xml <?xml version="1.0" encoding="UTF-8"?> <Category> <Record> <A>1</A> <C>3</C> <CustomerExtensions> <B>2</B> <D>4</D> </CustomerExtensions> </Record> </Category>

For more information, please use di-csv2xml --help.

As this tool does not provide any schema validation, it is important to note that you get what you typed. Any typo in the parameter category or the header column of the csv-file is directly translated into the dedicated XML-tag, leading to potential errors when attempting to process the XML-file further.

Installation

Binary executable

You can download a binary executable (for 64Bit OS-X or Windows) from the release section.

From source

You can build a binary executable yourself using:

bash git clone https://github.com/blue-yonder/di-csv2xml.git cd di-csv2xml cargo build --release

You will find the executable in the .\target\release\ directory.

You can install cargo from here if it is not installed.

Homebrew

If you are a MacOS user, you can use homebrew to install di-csv2xml:

bash brew install by-stehessel/BlueYonder/di-csv2xml

Benchmarks

This tool uses criterion for benchmarking. You can execute the benchmarks with:

shell cargo bench

from within the folder, where you checked out this repository.

You should find a report with plots in ./target/criterion/report/index.html.

Support

This tool is provided as is under an MIT license without any warranty or SLA. You are free to use it as part for any purpose, but the responsibility for operating it resides with you. We appreciate your feedback though. Contributions on GitHub are welcome.