<label_value_query>

Abstract

Learn to configure the <label_value_query> element for Pull Reports™ Ad Hoc report and data service software.


Table of Contents

Catalog Configuration Java API reference:  TableQueryLabelValuesProvider, QueryLabelValuesProvider

Configures a SQL query to retrieve a list of labels and values to be used within a <global_label_value_list> or <label_value_list>.

The element body is the SQL query and the groupColumn, valueColumn, and labelColumn attributes map the query results to a label value list.

The query will use the same JNDI DataSource as the enclosing <report>.

<label_value_query>s may contain constructs supported by Groovy's SimpleTemplateEngine such as Groovy or Java math, logic, or String operators and invoke static method calls such as System.getProperty(String). Additionally, the HttpServletRequest associated with the GET Label Value List REST API request is available as the request template attribute.

Usage

See the <label_value_list> documentation for example usage.

Parents

<global_label_value_list>
<label_value_list>

Attributes

groupColumn (Optional)

The name of the column within the SQL query which contains the label/value group. If specified, the query results should be ordered by the groupColumn so as to display within the same HTML <optgroup> within the Pull Reports™ Ad Hoc Report Creator.

labelColumn (Default: label)

The name of the column within the SQL query which contains the label.

valueColumn (Default: value)

The name of the column within the SQL query which contains the value.