Query definition

Table 1. The query definition is in XML format.
Element Name Child Element Required Description 
id
   Yes Identifies the query definition, and referred to by dataset definitions that map to this query. 
description
   No Human readable description for the query definition 
queryColumns
queryColumn
 
id
 Yes queryColumns is the collection that holds queryColumn elements; each queryColumn representing a column in the returned data from the query execution. This ID needs to match with exact column ID that is returned by the query engine ( It must match with Column ID that is mentioned in online DataAccess API help page, for the query type specified by QueryType element). The match is case insensitive. 
dataType
 Yes Datatype for the query column. It must match with datatype that is mentioned in the DataAccess API help page for the column 
queryParameters
queryParameter
 
id
 Yes queryParameters collection holds queryParameter elements, each representing a query parameter. The ID must match with the query parameters that are defined in the respective query API. These APIs must match with DataAccess API help page for the query type that the query definition specifies. The query definition must define all the mandatory parameters for the QueryType, as defined on the DataAccess API help page. 
dataType
 Yes Data type for the query parameter - this must be same as defined the DataAccess API help page. 
isMandatory
 Yes Boolean flag that indicates if the parameter is mandatory or optional. If mandatory, a value must be present (default or supplied from mapping dataset) for this query parameter, or else the query Engine will fail to run this query. 
value
 No

This is the default value for the query parameter. If there is no Dataset parameter mapped to this query parameter or no value is supplied for the mapped Dataset parameter, this default value will be used.

 
IncludeInResult
 No Optional Boolean flag. If true, this forces the query engine to return a column corresponding to this parameter. The column holds same values as the input value received for this parameter