Worklist Import Export Tool
for Agilent MassHunter software
 |
 Demo Video: Worklist Import Export Tool demo video |
Synopsis
The Worklist Import Export Tool is an application for the conversion of comma separated files (“.csv” files) to Masshunter compatible worklist files (“.wkl” files).
The conversion can be completely automated, which can be especially useful if the “csv” input files are automatically generated themselves, i.e. by LIMS systems etc.. The generated “wkl” files are in XML format, so it is necessary for the user to provide the tool with a worklist template file that contains an XML template. The user can thereby influence the matching rules, meaning the correct mapping of the distinct csv-columns to the corresponding XML-tags.
Watch the video demonstration above, to get a brief overview of the application's basic usage and functionality.
Detailed explanation
The “Worklist Import Export Tool” consists of two applications: The “Configuration WorklistImExPortApp” and the “WorklistImExPortApp”.
While the “WorklistImExPortApp” can only be used for the actual conversion task, the “Configuration WorklistImExPortApp” offers administration functionality.
Its administration capabilities can be accessed inside the two tabs named “Config” for configuration, and “Matching” for the mapping of csv-columns to xml-tags.
With the exception of those two tabs, both applications share an identical UI, which is why the following examples will solely cover the “Configuration WorklistImExPortApp”.
1.) The “Worklist Creation” tab
Click the “Load CSV File” button, and select the csv-file you want to convert. After opening the designated file, you will be able to see the csv-file’s content inside the main window:
The table displays the CSV data set, in which each cell is expected to be separated by a comma (",").
Clicking the “Export Worklist” button starts the export process of the currently loaded data set. On success, the resulting wkl-file can be found in the directory specified in the “Config”-tab.
Instead of loading and exporting the data set in two steps, you can also choose to do loading the data set and exporting it at once. To do so, enter the name of the .csv file in the input field next at the top, and click the “Export” button next to it. The mentioned input field can also be filled using a barcode reader.
2.) The “Config” tab
This tab provides all necessary settings for the export process.
Inside the groupbox “Masshunter Configuration” both the path of your csv source-files, and the path of the wkl-file destination folder, can be specified.
In the groupbox “Miscellaneous Configuration” the checkbox “Logging” you can enable logging. If logging is enabled, the software gives will provide you with textual detail about the export process and potential processing errors.
In the groupbox “Worklist File Configuration” you can specify the XML tags, import the wkl-file with the XML template, or specify a csv template file (which is optional).
Use the “Save Config” button to save your settings, after you're done.
3.) The “Matching” tab
In this table you can map the names of the csv-columns to their corresponding XML tags. During conversion, the CSV cell data will then be copied to their matched XML fields. In addition to just copying the data, it can also be manipulated by specifying customized filter rules inside the "etc." column. These filters allow for simple string manipulation, like for example adding a custom pre- or suffix.
Automated conversion
To use the “Worklist Import Export Tool” inside an automated conversion progress, it must first be configured using the “Configuration WorklistImExPortApp” as described above. After configuring the application, the whole conversion progress can be done silently. To do so, call the application's main executable with the .cvs file name to convert as command line argument. The application will then look for the given file inside the input directory, specified while configuring the application, and write the converted file to the output directory.