XML Search Properties

File Path
Locators
XML Search Elements
XML Locator
Edit XML Locator Dialog

File Path

This field specifies the search path and the XML filename on which the search operation will be executed. This field is of Formatted Type and can be edited using the Smart Edit Control. The name of the XML Search operation will also display this path.

Locators

This field will display in the left pane the XML Search Elements which contain the XML locators based on which the search operations are performed. Multiple XML elements can be defined and under every XML element multiple XML locators can be created. For every XML element the locators can be declared or modified in the XML Locator view in the right pane.

XML Search Elements

In this panel you can create, delete or modify the position in the node hierarchy of the XML elements. The following operations are possible:

New Element

A new XML element can be created by selecting [ New Element ] from the context menu or by pressing the Insert key while the left panel if focused.

Rename an element

To rename an XML element select [ Rename ] from the context menu or press the F2 key while the element is selected.

Move Up

To move the selected node up use [ Move Up ] option from the context menu or press Shift+Up Arrow key keys while the element is selected.

Move Down

To move the selected node down use [ Move Down ] option from the context menu or press Shift+Down Arrow key keys while the element is selected.

Move Left

To move the selected node to the left use [ Move Left ] option from the context menu or press Shift+Left Arrow key keys while the element is selected.

Move Right

To move the selected node to the right use [ Move Right ] option from the context menu or press Shift+Right Arrow key keys while the element is selected.

Delete an element

To delete an element use [ Delete ] from the context menu or press the Delete key while an element is selected.

The hierarchy of the XML elements defined here must be the same with the one from the actual XML file. If the structure is different in the XML file no search operation can be performed.

Once an XML element is created it is possible to assign one or multiple XML locators from the XML Locator panel.

XML Locator

This panel will display the XML locator assigned for the selected XML element from the XML Search Elements panel. Based on this XML locator the XML Search operation will be performed. It is possible to declare multiple XML locators for one XML element.

Create an XML locator

To create a new XML locator press the [ Add... ] button, use "Add..." context menu option or press the Insert key while the list is focused. The Edit XML Locator Dialog will appear.

Modify an XML locator

To modify an existing XML locator press the [ Edit... ] button, use "Edit..." context menu option or press the Space key while an element is selected. The Edit XML Locator Dialog will appear.

Delete an XML locator

To delete an existing XML locator press the [ Remove ] button, use "Remove" context menu option or press the Delete key while an element is selected.

If multiple XML Locators are defined you can modify the order in which the searches are performed. The order in this list is the order in which the search operations are executed.

Move Up an XML locator

To move an XML locator up press the [ Up ] button, use the "Move Up" context menu option or press the PageUp key while an XML locator is selected.

Move Down an XML locator

To move an XML locator down press the [ Down ] button, use the "Move Down" context menu option or press the PageDown key while an XML locator is selected.

If one of the search operations assigned to an XML element fails, all the search operations assigned to that element will fail and no search result property will be set for any of the search operations assigned to that element.

If you want each search to be evaluated individually you can define the same element multiple times, maintaining the same hierarchy, and assign to each instance an XML locator.

Edit XML Locator Dialog

XML Locator

Search

In this field, you can select the search criteria. This field corresponds to the Locator Type field from the XML Locatorpanel. The following search options are available:

Attribute name
The search will be performed using the attribute name of an XML element specified in the below value field.
Attribute value
The search will be performed using the attribute value of an XML element specified in the below value field.
Element text
The search will be performed using the text value of an XML element specified in the below value field.
Element has index in the parent
The search will be performed using the index number of an XML element specified in the below value field. The index is 0 based and represents the order number of an element among the other children of a certain parent.
Element exists
The search will be performed using the element name without specifying the index in the parent.

Value

In this field, you can define the value of the search operation. This field corresponds to the Value field from the XML Locator panel.

If an Element has index in the parent criteria is selected the value field must contain only integer numbers and is a 0 based value. In case a string is supplied the search operation's found value will always return the current element.

Store

If this checkbox is enabled the search operation's found value will be stored inside a property.

This field corresponds with the Result Type field from the XML Locator panel. The type of the search operation's found value can be one of the following:

Attribute name
The name of the element's attribute that meets the search criteria will be returned by the search operation.
Attribute value
The value of the element's attribute that meets the search criteria will be returned by the search operation.
Exists element
The name of the element that meets the search criteria will be returned by the search operation.
Element text
The text contained by the element that meets the search criteria will be returned by the search operation.

in

In this field, you can specify the Advanced Installer property where the resulted value will be stored. You can write the name of the property or use the [ ... ] button to display the Property Picker Dialog and select a property. This field corresponds with the Result Property field from the XML Locator panel.

It is highly advised to use public properties. A public property has its name written in capital letters. If in this field a property is written which is not previously declared, it will be created only if the search proves to be successful; otherwise, it will not exist.

The following combinations for an XML locator are possible:

Search	Result Type
Attribute name	Attribute value
	Exists element
	Element text
Attribute value	Attribute name
	Exists element
	Element text
Element text	Element text
Element has index in the parent	Exists element
Element has index in the parent	Element text