Event Action Set Extract XML Collection

NOTE: You can access this form only by clicking either the Path button or the Property Map button in the Event Action Extract XML Collection form.

Use this form to:

• Set an extraction path for the data being processed from an XML string  
• Map values from the XML to properties in the result set

This form allows you to set the Path and Property Map fields on the Even Action Extract XML Collection form more easily, without the need to enter that information manually.

Setting an Extraction Path

To set an extraction path for the data to be extracted:

1. In the Tree View, locate a real or example node under which the data resides (or will reside) for the rows to be extracted.
2. Click to select the node.

   Do not select any value under the node.

   WinStudio displays the equivalent XML Path Language (XPath) expression under Current Selected Path.

3. If the data to be extracted:
   • Is a single row comprised of values under this particular node in the XML, click Set Current Path as Extraction Path to Select Single Row.

     You could, for instance, extract data under the third of a repeating series of identically named nodes. The Current Selected Path is copied to the Extraction Path with a number in square brackets at the end. For example, to extract data under the third of a repeating series of nodes, the Extraction Path would end in [3].

   • Is a set of rows comprised of values under this particular node and all the identically named nodes adjacent to it (that is, in series under the same parent node in the XML), click Set Current Path as Extraction Path to Select Collection.

     The Current Selected Path is copied to the Extraction Path without square brackets at the end.

4. Click OK.

For more detailed examples, see Detailed Examples for Setting an Extraction Path.

Mapping Properties

NOTE: Before you can map any properties, you must first set an extraction path.

There are two methods you can use to map properties:

• You can map them manually.
• You can map them using the XML Tree View.

Mapping properties manually

To manually map properties from the XML to properties in the result set:

1. In the Property Maps grid, specify a name for the property to be mapped to in the Property Name field.  
2. In the Value field, specify the path to the node from which the property value is to be taken, relative to the extraction path, as an XPath expression.

Mapping properties using the XML Tree View

To use XML paths from the template to map properties:

1. In the XML Tree View, select the node from which the property value is to be taken.
2. With focus on a new row in the grid, click Set Path.
3. In the Property Name field, specify a name for the property to which the value is to be mapped.

Related Topics

Event Actions form

Event Action Extract XML Collection form

Detailed Examples for Setting an Extraction Path