App Extensions - Visual Queries
Extensions can include custom Visual Queries which are either used by the extension itself (e.g. an input-type) or can be used by the App as a whole.
Tip
This allows you to create small libraries of Visual Queries which solve a specific problem, and then share them across multiple Apps by installing the extension in each App.
Location and Naming
While developing Visual Query extensions, just create normal queries in your App and when exporting the extension, ensure that the queries are included in the package.
We highly recommend that you give the queries a clear and unique name,
such as {ExtensionName}.{QueryName} to avoid conflicts with other queries in the App.
We also recommend that you don't use spaces or special characters in the query names, to ensure easy use in REST API calls.
Instructions
Visual Queries in App Extensions are created and maintained exactly like normal Visual Queries.
There is no special folder, file, or code required.
Key points to be aware of:
- Visual Queries are stored as Entities, not files
- They must exist in the App before exporting the extension
- Only queries explicitly marked as used will be included in the package
- Naming should be unique to avoid collisions across Apps
Include in the Package Definition
Tip
Visual Queries are configuration which is stored as Entities. To include them in the extension, you must ensure that it's part of the package export.
The package export system only exports parts which have been declared to be in use. So make sure to tick the "Has Query" checkbox in the extension's package definition UI.
History
- Beta in v20.09, to be released in v21.00