Query#

Overview#

The Query widget displays the results of any Query - including Queries with Parameters. An example is shown below, where a Query widget is used in the bottom of the UI Page to show the results of a Query.

General Steps#

To use the Query widget in a UI Page, follow the steps below:

1. In any UI Page in Build mode, select the Query from the widgets list located on the left side of the page; drag and drop to the desired place in the UI Page.
2. Enter the Settings section of the widget through the three vertical dots.
3. In the General tab, provide a name and a description for the widget. Use the toggle buttons to specify whether the widget should be visible, display the header, or allow full screen mode. Additionally, determine if the widget can be opened as an image in a new tab or exported as an image. You can also select the navigation mode behavior: open a new page, replace the current page, or none.

Widget Customization#

1. Optionally, in the Style tab, you can define a Border Width and Color.

   

2. In the Query Setup tab provide the following properties:

   • Query - The Query to display.
   • Selection mode:
     • Multiple - Multiple lines can be selected
     • None - No selection available when interacting with the displayed data
     • Single - A single line can be selected
   • Show Totals When Insufficient Space - Set to trueby default, this option indicated whether to display only the number of items if there's no sufficient space to display all columns.

   

3. Optionally, define the Links between this widget and other elements of the UI Page.

   

4. Select Save and Close to complete the widget configuration.

Real Use Case#

In this example, we will add a Query widget using a parameterized Query and link it to a Form widget that allows you to provide the parameters.

The way the link is built depends on the setup of the Query parameters. Below are some common examples.

Entity Parameter#

This examples uses an entity parameter as an input for your Query.

1. Setup an entity parameter on the Query: For example, a Material entity for a Scheduled Scenario Job Query:

   

2. Configure the UI Page: The query expects the entity ID, which can be based on an entity selection by using the Any To Any Property converter with the parameter set to Id. Create the converter parameter as a property in the UI Page settings.

   

3. Configure a Form widget. For more information, see Form.

   

4. Next, link the Form widget to the Query parameter:

   

5. To conclude this scenario, you will also have to configure a converter for the previous link using the Any To Any Property:

   

Name Parameter, from a single entity selection#

1. Setup an entity parameter on the Query: For example, a Resource name for a Scheduled Scenario Job Query:

   

2. Similarly to what was done above, configure the Form widget.

   

3. And link the Form widget to the Query like it is shown below:

   

4. In this case, the standard converter Get Entity Name can be used that will pass on just the name of the entity as a string:

   

Name Parameter, from a free text field#

1. Configure a Form field as free text input. This input can be passed to any name parameter without using a converter. Same as previous example but the form field is configured as string:

   

2. Such a field can be easily linked like this: