XML Formatting Guidelines for 5.x Search Input

In version 5.x of Archer, there is a new search engine and two new methods to leverage this engine, search.ExecuteSearch and search.ExecuteStatisticSearch. The search inputs for these methods are constructed with XML.

Important: To facilitate migration to 5.x, version 5.x supports the legacy 4.x format for constructing searches. However, when creating new searches, use the search.ExecuteSearch and search.ExecuteStatisticSearch methods and the XML syntax described in this section.

Important: To reference a field in the search parameters, it is recommended to use the GUID for that field instead of the SQL field ID. The GUID is listed in the Application Detail Report as well as in Application Builder, by opening the Manage Field page for that field. The GUID is displayed on the General tab in the ID field.

Note: Any search that returns a <metadata> section now includes the field ID, name, and GUID for each field.

The following table describes the elements used to form the search inputs.

Element	Description
SearchReport	The SearchReport element is the root of the search XML document for searches that use the search.ExecuteSearch method. It takes no attributes.
SearchStatisticReport	The SearchStatisticReport element is the root of the search XML document for searches that use the search.ExecuteStatisticSearch method. It takes no attributes.

For a description of the sub-elements that you can specify under the SearchReport and SearchStatisticReport elements, see the following topics:

• General Settings
• Result Display
• Search Criteria
• Keywords Search
• Filters
• Statistics Criteria
• Module Definition