XML Support

XML support is available in server automation scripts and libraries, allowing you to create and parse XML.

This is helpful if you want to use data formatted as XML. For example, you might want to use product or other related information you have already stored in XML format, instead of creating new entities and attributes.

Load XML from a String

Method

server.Xml.Load(string xml)

Loads the XML from the specified string.

Parameter

xml string

String containing the XML to load. The string is an XML formatted text.

var xml = '<Order></Order>';
var doc = server.Xml.Load(xml);

Catch an XML Load Error

When loading XML from a string, errors that might occur on XML load from a string are not automatically logged. To log any errors that might occur on XML schema load, use catch(err).

var xml = '<Order />';
try
{
    var doc = server.Xml.Load(xml);
}
catch(err)
{
    log(err);
}            

Run XPath Queries

You can perform XPath queries to navigate through nodes (elements, attributes) in an XML document.

Method

Query( xpath : string ) : Element[]

E.g.:

var xml = '<?xml version="1.0" encoding="utf-8" ?>
<Orders>
     <Order id="O1">
             
            <Product id="1" name="Nexus 5">
                <Price>400.00</Price>
                <Qty>1</Qty>
            </Product>
            <Product id="5" name="Wireless Charger">
                <Price>50.00</Price>
                <Qty>1</Qty>
            </Product>
     </Order>
     <Order id="O2">
            <Product id="2" name="IPhone">
                <Price>800.00</Price>
             <Qty>1</Qty>
            </Product>
            <Product id="5" name="Wireless Charger">
                <Price>50.00</Price>
                <Qty>1</Qty>
            </Product>
            </Order>
</Orders>';
var products = doc.Query("/Orders/Order/Product[@name='Wireless Charger']");
log(products[0]['id']);
log(products[1]['id']);            

Where:

• <Orders> is the root element
• Order is an element node
• <Price> and <Qty> are child elements of <Product>
• Wireless Charger is an attribute node

Run XPath Queries with Namespaces

You can perform XPath queries with namespaces to navigate through nodes (elements, attributes) in an XML document.

Method

Query( xpath : string, namespaces : { key : string, value : string )

E.g.:

var xml = '<?xml version="1.0" encoding="utf-8" ?>
<x:Orders xmlns:x="http://myuri">
        <x:Order x:id="O1">
            <Product id="1" name="Nexus 5">
                <Price>400.00</Price>
                <Qty>1</Qty>
            </Product>
            <Product id="5" name="Wireless Charger">
                <Price>50.00</Price>
                <Qty>1</Qty>
            </Product>
        </x:Order>
        <x:Order x:id="O2">
            <Product id="2" name="IPhone">
               <Price>800.00</Price>
                <Qty>1</Qty>
            </Product>
            <Product id="5" name="Wireless Charger">
                <Price>50.00</Price>
                <Qty>1</Qty>
            </Product>
        </x:Order>
</x:Orders>';
var doc = server.Xml.Load(xml);
var products = doc.Query("/x:Orders/x:Order/Product[@name='Wireless Charger']", {'x' : 'http://myuri' });
log(products[0]['id']);
log(products[1]['id'])

Node API Calls

The table below lists the properties you can access on the nodes within an XML document.