Previous pageData Integration Next page
Query Embed dialog - Records tab 

The Records tab allows the selection of a subset of the record returned by the query.

If nothing is entered in this tab then all records will be returned.

The tab is divided into three sections:

  • Criteria
  • Records to Return
  • Named Parameters

Criteria

This section provides a table in which multiple criteria can be entered.. Each criteria is shown as a column in the table. If there are multiple criteria, then they are all evaluated, each serving to further restrict the records returned (ie logically they are are combined with an 'and' operator rather than an 'or' operator)

To add a new criteria to the table, click Add or click in a blank area of the table (where the cursor shows a green plus symbol)

Each criteria column has the following rows:

  • Restrict
  • Field
  • Operator
  • Value
  • Require value
  • Save in cookie

Restrict

This determines which sources within the query the criteria applies to. The default "All records" is normally suitable, but the alternatives are each of the individual Data Sources in the query, and each of the Joins in the query.

Field

Select a field from the query.

If the Restrict setting is set to "All records" then this provides a choice of the fields selected in the query.

If the Restrict setting is set to a particular Data Source, then this provides a choice of all the fields in that Data Source (regardless of whether they have been selected by the query)

If the Restrict setting is set to a Join between two Data Sources then this provides a choice of all the fields in both Data Sources either side of the join (regardless of whether they have been selected by the query).

Operator

Enter the condition used to compare the value in the query Field with the Value chosen below. The operators available will vary depending on the datatype of the field.

Value

Enter the value that must be matched.

Click to open a sub-dialog with options. The options will vary depending on the datatype of the Field.

Explicit

Enter or select a specific value.

Parameter

Choose the type of parameter:

  • Parent

    The parameter is provided by the surface the query is embedded in. ie if it is embedded in a Custom View on another query, then the fields from that query will be providing the parameters. If the query is embedded directly on a top level page surface, then the Parent parameters are the same as the Root parameters.
     
  • Parent, Cookie

    Uses a Parent parameter if available, but if not present, uses a value saved in a cookie by an earlier query embed.
     
  • Root

    The parameter is provided by the top level querystring parameters used to load the page.
     
  • Root, Cookie

    Uses a Root parameter if available, but if not present, uses a value saved in a cookie by an earlier query embed.

Choose the parameter name, or leave blank to use the default name

Current Domain

Matches against the site's current domain name. Note a site may be bound to multiple domain names, this matches against the one the user is currently browsing to.

Current Theme

The current theme active for the user

Require value

If the Value is specified as a Parameter, then this determines what should happen if that Parameter is not present. Default is unchecked.

Check 'Require value' to return no records when the parameter is not present.

Uncheck to ignore this criteria column when the parameter is not present.

Save in cookie

Check to store the value in the client browser's cookies, so that subsequent query embeds can access this value as a parameter even if the parameter is otherwise not available. Default is unchecked.

 

Records to Return

Once criteria specified elsewhere in the dialog have been evaluated, the query returns a set of records. This section then further restricts which of those records are returned

Return

  • All records (default)

    All records will be returned.
     
  • First n records

    Only the first specified number of records will be returned.

First record

Specify which record in the returned set to start with. Default is 1. Entering a higher number skips the earlier records.

Do not return records if there are

This section prevents the query displaying any records if these criteria are met

Less than specified number of records

More than specified number of records

Allow this embed to recurse

Specified number of times. This prevents infinite recursion which may occur if view is inadvertently embedded on itself and misconfigured. Without a limit this could result in an infinitely-long resultant page. Beyond the specified recursion times, no records are returned.

 

Named Parameters

Expansion

  • Expand

    Named parameters will be expanded to display their values in-line
     
  • Preview

    The name of the Named Parameter will be shown, rather than the value
     
  • Inherit (default)

    The setting for this will be taken from the parent query embed, if there is one.