Skip to main content

Testing a Query

2025.1.01+

A query needs to be tested to ensure that it is working based on the given input parameters. The following documentation applies to custom queries.

Preconditions

To test a query before publishing, testing needs to be enabled. This can be done by setting the following properties for Flowable Design:

flowable.design.indexing.enable-query-test=true
flowable.design.remote.idm-url= # URL to Flowable Work, e.g. http://localhost:8090

And since the testing is happening through Flowable Work, the following property for Flowable Work:

flowable.indexing.enable-query-test=true

Also, to see actual result the query must return results in Flowable Work, otherwise it will simply show an empty list.

Testing a query

To test a query model open the query model and go to 'Preview'.

In the 'Preview' the parameters from the 'Parameters' tab can be selected.

The query will be executed based on the parameters once the values are entered. To see the result without providing query values, simply press the 'Reset' button.

Input and search parameters of the query, with preview of the actual query

The request will be executed and the result including the mapping is displayed next:

Result of the execution of the query

In the response tab the following information is available:

  • data The results provided by the Flowable API mapped accordingly.
  • total The total entries available during the search.
  • sort The parameter which was used for sorting
  • order The order used for sorting
  • size The currently displayed entries