XPath Source

Last update: Edit

1 Overview

If database is selected as the data source for a widget then the object or objects shown are retrieved directly from the database with a query. As such, the data supplied is limited by the following factors:

  1. The access rules defined in the security section of the project.
  2. The XPath constraint supplied in the widgets settings.
  3. An association, if the widget is nested in another data widget and the data path described runs over an association.

2 Components

For more information, see Search Bar.

2.2 Sort Bar

For more information, see Sort Bar.

3 Properties

3.1 Entity (Path)

The entity (path) property specifies the target of the database query. A top-level data grid is always connected to an entity.

A nested data grid can either be connected to an entity or to an entity path starting in the entity of the containing data view. The entity path follows one association of type reference in the opposite direction in which the association’s arrow is pointing (from * to 1).

This domain model describes a database in which an indeterminate number of users can be linked to a single country:

The data view shown contains a single country. The data grid nested inside will display only those users that are linked to that particular country:

With this property you can influence if and when a search bar is shown.

Value Description
Never No search bar or search button are ever shown. Effectively disables search.
With button (initially open) The user can open and close the search bar using the search button; the search bar is initially open.
With button (initially closed) The user can open and close the search bar using the search button; the search bar is initially closed.
Always The search bar is always visible and cannot be close, nor is there a search button.

Default value: With button (initially closed)

If set to true, the grid will remain empty of contents until a search has been performed. This can be useful if the target entity contains an extremely large set of objects but most mutations only require a subset of the data. Waiting for search will ensure that no database query is performed until the desired subset is specified, thus skipping the initial loading period associated with major data retrievals.

Default value: false

3.4 XPath Constraint

The XPath constraint allows for custom, hard-coded limitations on the data displayed. This constraint will be appended to the constraints (if any) already applied through security and context.