Overview
The Dataset module Module offers powerful configuration options for managing queries efficiently. Users can define queries with custom names, select database configurations, and input SQL statements, including Tag embedding. Mapping options enable data population from query results, and users can specify time references (UTC or Local) for Date Time fields.
In addition, the Dataset module Module allows users to display query results using Data Grids Datagrids in screens and dashboards, simplifying data visualization. Query results can also trigger actions in custom scripts and tags, enhancing automation capabilities for notifications and tag updates. For more advanced functionalities, users can explore Stored Procedures.
Creating Queries
To create and configure a Dataset Query, follow the steps below.:
- Access Datasets → / Queries.
- Click the plus icon.
Enter a Name and Description for the Query
Click Ok.
Define the DB (Database Connection), and click Ok.Go To SQL Query editor to define the Query (you can navigate using the tree or double-click the SqlStatement column)
Info The use of spaces is not allowed in the Name. Instead, use underscores. For example : My_Query
In the list of Dataset Queries, double.
| Tip | ||
|---|---|---|
| ||
By Default, the system will name the create the Dataset.Query with Query1, Query2,... We recommend giving a more meaningful name and using the description field, all in order to properly identify each query. |
| Info | ||
|---|---|---|
| ||
Adding real-time parameters to your queries offers flexibility and adaptability, enabling dynamic data retrieval based on changing conditions. Instead of hardcoding specific values, you can use dynamically populated placeholders at runtime. Instead of using Queries like the following:
Use Queries with real-time parameters:
In this example, {{tag.Test}} serves as a placeholder for a real-time parameter. |
You can modify the Query settings after its creation. Double-click the property you wish to edit on the row corresponding to the
tableQuery you want to modify.
Queries configuration properties in the Dataset module enable users to create and manage data retrieval queries efficiently. The following table lists all possible configuration properties:.
Column | Description | ||
|---|---|---|---|
Name | Enter a name for the queryThe Query's name. The system allows will warn you to know if the name is not validif you choose an invalid name. | ||
DB | Select Defines the database configurationwhere the Query will be executed. | ||
Sql StatementSqlStatement | Enter Specify the query Query using SQL syntax. You can embed tags Tags directly on the SQL statement, embracing the tag with curly brackets. For example, ColumnName = {tag.tagInt}. Alternatively, you can update the SQL Statement with the Script Module module accessing the property property Dataset.Query.QueryName.SqlStatement. When doing so, if If you access that property from multiple tasks using this approach, be aware of potential concurrency issues. For advanced more information on that, refer to the page , access Advanced Dataset Guide. | ||
Mapping | Click the three dots button (...) to select the tags that you want to populate with data from specific columns returned by the queryQuery returns. | ||
MappingDateTime | Specify how the time in Database will be interpreted | Mapping Date Time | Select the time reference (UTC or Local), when mapping to DateTimeOffset .NET variables. |
Description | Enter a description for the table configuration. |
Showing Data Grids Tables On Displays
One of the critical features of the Dataset module is the ability to display query results on screens and dashboards using visualization tools like DataGrids. To use Data Grids to display query results, follow these steps:
- Create a Query in the Dataset module to retrieve the desired data. Refer to the previous section to learn how to create a Query.
- In the Displays Module, add a Data Grid control to the screen or dashboard.
- Configure the Data Grid to display the Query results by selecting the data source and column mappings.
- Save and preview the screen or dashboard to display the Query results on the Data Grid.
Check the Displays and Visualization page for more information on how to configure Displays.
Using Query Results On Scripts And Tags
You can use query results to trigger actions in custom scripts and tags. To do so, follow the steps below:
- Create a Query in the Dataset module to retrieve the desired data. Refer to the previous section to learn how to create a Query.
- In the Scripting Module, create a custom script that references the Query results.
- Use the Query results to trigger specific actions within the script, such as sending notifications or updating tags.
- Save and execute the script to perform the desired actions.
Query's description. |
Editing Queries
The queries are ending using the Built-In SQL Query Editor, which assists doing the hight of the SQL Syntax.
→ Learn more at the Query Editor page.
There is also the tool VisualQueryBuilder which allows to explore databases, and drag-drop tables and visually connect fields to build the Query.
The VisualQueryBuilder is started navigating to Datasets → DBs, and clicking on the Visual Query Builder button.
→ See Visual SQL Query Builder for more information on that tool.
Testing Queries
The best place to test your queries is the DataExplorer SQL Queries tool.
Any query used in the solution, or even new queries you are modifying in that environment can be executed.
The results are presented in a DataGrid object in which you can customize the columns.
→ Learn more at Data Explorer SQL QueriesCheck the Stored Procedures page for additional information.
In this section...
| Page Tree | ||||
|---|---|---|---|---|
|