ca_pam_convertXMLToJSObject(xmlString, elementTagName)

Forms › The Form Designer › Form Element Functions › Form Elements › XML Parsing › ca_pam_convertXMLToJSObject(xmlString, elementTagName)

ca_pam_convertXMLToJSObject(xmlString, elementTagName)

Creates a JavaScript object from XML.

Note: If the XML element is namespace aware and has a namespace prefix, use quotes notation to access it.

Input Parameters

xmlString (string): Defines the XML string to convert to a JavaScript object.
elementTagName (string): (Optional) Returns the element that has the specified tag name. If you do not provide the elementTagName, the method returns the root element.

Return Value

Returns a value of Object type.

Example

Consider the following XML to convert it to a JavaScript object:

<?xml version="1.0"?>
<catalog>
   <book id="bk101">
      <author>Gambardella, Matthew</author>
      <title>XML Developer”s Guide</title>
      <genre>Computer</genre>
      <price>44.95</price>
      <publish_date>2000-10-01</publish_date>
      <description>An in-depth look at creating applications 
      with XML.</description>
   </book>
</catalog>

This example converts the preceding XML data to a JavaScript object.

The following syntax converts the XML document to a JavaScript object:
```
   var parsedXML = ca_pam_convertXMLToJSObject(xmlString);
```

You can use either of the following lines to access the book element:

   var bookObj = parsedXML . book[0];   
   var bookObj = parsedXML [“book”][0];

You can use either of the following lines to retrieve the id attribute value of the book element:
```
   var idVal = bookObj.id;
   var idVal = bookObj[“id”];
```

You can use either of the following lines to access the description value of the book element:

   var bookDesription = bookObj. description[0]._text;
   var bookDesription = bookObj[“description”][0][“_text”];

Note: If an element has an attribute and an element with the same name, access them as an array. In the array, the first member (index 0) is always the attribute and the elements follow.

Example

Consider the following XML to convert it to a JavaScript object:

<?xml version="1.0"?>
<categories>
    <category name="Weather"> 
        <name part="1">Sunny</name>
        <name part="2">Rainy</name>
    </category>
    <category name="Climate"> 
        <name part="1">Wet</name>
        <name part="2">Dry</name>
    </category>
</categories>

This example converts the preceding XML data to a JavaScript object.

Use the following syntax to retrieve the first category object from categories XML represented as the xmlString:
```
   var parsedXML= ca_pam_convertXMLToJSObject(xmlString);
   var firstCatagory= parsedXML.category[0];
```
Use the following syntax to access the name attribute:
```
   var bookName = firstCatagory.name[0];
```
Use the following syntax to access the value of first name element:
```
   var firstBookName = firstCatagory.name[1]._text;
```

Example

<Envelope xmlns="http://schemas.xmlsoap.org/soap/envelope/" xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/">
	<Header/>
	<Body>
		<getStartRequestFormsResponse xmlns="http://www.ca.com/itpam">
			<startRequests>
				<startRequest name="RahulSrf" refPath="/Folder/">
					<description/>
				</startRequest>
				<startRequest name="Start Request Form" refPath="/RestSupport/">
					<description/>
				</startRequest>
			</startRequests>
		</getStartRequestFormsResponse>
	</Body>
</Envelope>

This example shows the usage of the ca_pam_convertXMLToJSObject(xmlString, elementTagName) method with the elementTagName parameter.

The following script retrieves all the <startRequest> elements from XML:

var srfResult = ca_pam_convertXMLToJavaScriptObject(xmlString,'startRequest');

srfResult is an array of all the startRequest elements.

Example

<?xml version="1.0"?> 
<note _text="abc"> 
    <_text>Tove</_text> 
</note>

This example shows a scenario in which the XML has _text as an element or attribute. In this case, the method creates an array with the name "_text".

The first element of the array returns the text node in the element.
The second element of the array returns the attribute node (with the name "_text") of the element.
Other elements of the array return the child element nodes (with the name "_text") of the element.

The following script accesses the values:

var parsedXML= ca_pam_convertXMLToJavaScriptObject(xmlString); 
var textNode= parsedXML["_text"][0]; 
var attributeValue= parsedXML["_text"][1]; 
var childTextNodeValue= parsedXML["_text"][2]["_text"];

The script has the following result:

textNode="";

(...as there is no scalar value with the node.)

attributeValue="abc"; 
childTextNodeValue="Tove"

You can also find this function in the out-of-the-box content in CA Process Automation.

On the Home page, click Browse Out-of-the-Box Content.
Navigate to the User Interaction Forms folder, then 08 Populate Table SOAP WS: Populate Table SOAP WS.