Process queries

<< Click to Display Table of Contents >>

Navigation:  Bizagi Studio > Process wizard > Define Forms > Type of Forms > Query forms  >

Process queries

Process Queries are customized search forms that end user can execute on the Work Portal, to search for ongoing or closed cases, with specific business or process data. The result of these queries is a list of cases that comply with the search criteria,


In Process Queries you can include three types of controls as searching criteria.


Data Model: Controls associated to attributes of the business data model.

Process Filters: Including searching for a specific Application, a specific Process, information related to Tasks and information related to Cases.

Users: Including searching for information about the Creator, Current and Previous users.




How to Create Process Queries  

Process Queries can be created through the Expert View.

Entities module or the Process module can access the Queries creation and edition. We recommend using the Process view.


In the Processes module go to the process where you want to create the Query. Right-click the process name and select Show Related Queries.




A new window will display where you can see all Queries that belong to the Process' Application.


To create a new Query click the New button on the upper right corner.

The Query will be automatically checked for the process where it is created.




The Forms designer will display. In it you will be able to drag and drop all controls required, using the desired layouts, groups and tabs as needed.



Records in entities can be disabled, for example, in parameter entities. If you use the following controls, they are going to show ALL the disabled records of an entity:




Multiselect (with and without filters)


On the other hand, if you use the Combo control, this control DOES NOT show the disabled records.


Note when you create a New Form, that the context entity is the application entity.


Click to learn about special controls: Process Filters and Users.




Go to the Properties of the Query from and give it a name. The display name will be the one shown in the Work Portal to end users.




In the Properties tab define if Bizagi should display the search results for all the existent cases that meet the criteria specified by the end user, or only for those cases in which the logged end user has pending activities. To define this behavior, enable or disable the Search for all Users property.

oSearch for all users (enabled): the Process Query search results will display all cases that meet the criteria, allocated to all users.

oSearch for all users (disabled): the Process Query search results will display only the cases that meet the criteria that are allocated to the logged user.




We recommend using the Process control as a filter to define each Query for a specific process.

To do so, include the Process control. In the Advanced tab select the Default value. This way you are defining a filter to search for that specific process chosen.

Define the control as not editable to avoid users from changing the filter.





You can include date-time controls in a query form. Bear in mind that when setting these controls with time enabled, the query will be able to fetch results correctly if the attribute was formatted as date-time in the original form where end users enter information.

Specific times are not available to fetch results for dates that are not entered by end users nor the default ones (case creation date, expected solution date).


When you are done creating your Query save it and close it.


How to Create Process Queries option 2

Process Queries can be created through the Expert View, in the Entities module.

In the Entities module go to the Application entity where your process belongs to.

Go to the Queries option. In here you will see all the Queries that have been created for all the processes of the Application.




To create a new Query right click Queries and select New Query. The Query form window will display. Follow the same steps described above.




How to edit a Process Query

Access the Entities or Processes module. Select the Query that you want to edit.


In the Entities module double click the Query to open and edit it.

In the Processes module select it and click the edit button on the upper right corner.




How to delete a Process Query form

Go to the Entities module and select the Application Entity where the query was created. Click on the Queries option.


In the corresponding work area, the list of Query forms will be displayed. Right- click on the query to be deleted and select the Remove option.




Select Yes option in the confirmation window displayed. The user can carry out a dependency analysis if he/she would like to. If the query form has no dependency, it can be deleted.


Process Queries for deployment

When you create the Query through the Process module you will be relating it to a Process and ensuring that it will be taken with the next deployment as part of the process.

On the first window, the ones that are checked are the ones related to the process. This check mark is for deployment purposes only, it will not affect your results in any way. This check will guarantee that the Query is taken to the Production environment when a deployment is performed.




You can relate the Query to more than one process (or Sub-Processes) within the same Application using the Deploy with... property.

This is useful when a Query is used for more than one process.





Only users who have permissions established from the security of Bizagi Studio or the Management Console can access and view the queries.