Node-RED and XML to JSON

I’m trying to catch up with a whole load of stuff I did before I started this blog; as much as anything, so I can remember what I did for when I need to do it again!

Following on from installing Monit, I wanted to use Node-RED to monitor Monit so that ultimately I can have a dashboard for all sorts of things to be monitored and possibly alerts (rather than Monit doing that directly).

As previously mentioned, Monit communicates via an http interface so extracting the data was remarkably simple. All you need is a websocket flow and a URL like http://x.x.x.x:2812/_status?format=xml . It seemed that the obvious way to use this data was to convert the XML to JSON.

However, when I tried the built-in XML parser it did not work. Some digging brought up the fact that this built-in node has a limited depth. Not very useful. Further research led me to the xml2json node on npm. I’d never really understood the relationship between npm and Node-RED. What I think I understand is that Node-RED uses some command line nodes from npm which in itself is a Javascript package manager.

So in order to use this command line node (rather than a Node-RED flow) I needed to install it then ‘require’ it. The whole Javascript ecosystem is rather alien to me at the moment so getting it installed took a fair bit of experimenting although it is actually very simple to do.

It comprises of 3 steps:

1. Install the node from npm. As you want to use it from Node-RED, you need to *not* install it globally – counter-intuitive right? So simply go into your node red folder (usually ~/.node-red) and then npm install xml2json (reference).
2. Next, you need to edit your settings.js file to ‘require’ the node (reference). This file is also usually found in the ~/.node-red directory.
   Look for the functionGlobalContext and add in a line for the xml2json node.
   
   functionGlobalContext: { xml2json:require('xml2json')}

   1 2	functionGlobalContext: {      xml2json:require('xml2json')}

   
   Save and restart Node-RED sudo service nodered restart .
3. Add the code into a function such as:
   
   JavaScript

   /* Version: 1.0 Date: 17 Mar 2017 Author: BP Orpin To use this node install xml2json. sudo npm install xml2json Do not install it globally Edit settings.js to 'require' the module */ // get an instance of the module var parser = context.global.get('xml2json'); // set the options var options = { object: true, //returns a JSON object reversible: false, coerce: false, sanitize: true, trim: true, arrayNotation: false, alternateTextNode: false }; // xml to json var json = parser.toJson(msg.payload, options); msg.payload = json; return msg;

   1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29

   /* Version: 1.0 Date: 17 Mar 2017 Author: BP Orpin To use this node install xml2json. sudo npm install xml2json Do not install it globally Edit settings.js to 'require' the module */   // get an instance of the module var parser = context.global.get('xml2json'); // set the options var options = {     object: true, //returns a JSON object     reversible: false,     coerce: false,     sanitize: true,     trim: true,     arrayNotation: false,     alternateTextNode: false };   // xml to json var json = parser.toJson(msg.payload, options);   msg.payload = json;   return msg;

This will now enable you to take an XML flow and break it down into its constituent parts

The complete Node-RED flow:

by