Loading...

Data Cube Handler Options

The following options are available for creating or editing a handler for data sources:

Option Description
Name The name of the handler that is displayed in Data Cube.
Default Search Field The name of the default data field that you want use for searching the data. You can also select multiple search fields, or leave Default Search Field blank to include all of the fields in searches.
Default Search Keyword The default query to filter data based on keywords. Only data that matches the query will be included in the response.

You can include wildcard patterns, such as * or ?, in your keyword query.

Column Names The names of the data fields from the data source that will be returned in the response. Unless Override is selected, some system-generated fields are also included in the response, including data_source_type, data_source_name, data_source (id), contented, and score.
Filter Criteria The names of data fields and specific values that must be true for a data row to include the data in the response. Multiple filter criteria can be combined into conditional statements using AND, OR, and NOT.
Sort By The names of the data fields that will be used to sort the data in the response and the sorting method, either ascending or descending. Multiple sorting fields can be separated with a comma, and the fields will be sorted by the order in which they are listed.
Facet A check box that specifies whether faceting will be enable in the response.
Facets Field When Facet is selected, the data fields to use to create facets categories for search results in the response.
Facets Query When Facet is selected, the query to override the default facet count values generated in the response. You can specify a range of values to count for a facet field, instead of the default values generated in the response.

For example, if you have a handler with a facets field named Parking _Spaces that contains various integer values, you can specify a limited set of integer ranges to display in the facet counts, instead of the complete list of unique values in the Parking Spaces data field. Enter the query as: {!key=facet count display name}Facet Field name:facets query. The facets query parameter can be a unique value, such as 0; a range of values, such as [1 TO 50]; or a minimum value, such as [51 TO *].

  • {!key=NoParking}Parking_Spaces:0
  • {!key=1TO50ParkingSpaces}Parking_Spaces:[1 TO 50]
  • {!key=Above50ParkingSpaces}Parking_Spaces:[50 TO *]
Additional Criteria
Count The maximum number of rows from the data source that will be included in the response.
Response Type A list of the format types in which the data in the response can be formatted.
Raw Query The raw parameter-value pairs to include in the response. Raw Query values will override most values for parameters included in the handler form. If the handler form parameter can have multiple entries, such as Filter Criteria, then the Raw Query values will be appended to the parameter in the handler form.
Default When selected, these values will be overridden by the request if the same parameters are found.
Append When selected, these values will be appended to any values specified in the request.
Override When selected, these values will overwrite any values specified in the request.