Queries

<< Click to Display Table of Contents >>

Navigation:  Automation Server > Bizagi Work Portal >

Queries

Overview

Bizagi allows the definition and customization of special forms to retrieve information of ongoing and closed cases, as well as information stored in specific entities.

With the search results of these queries you can create useful analysis reports. These special Forms are known as Query Forms.

 

The controls included in Query Forms serve as search criteria. They can be defined to perform powerful searches over created cases or over specific entities (Master and Parameter). Your search criteria can be business data and it can also be general process information (case creation date, creator user, case state, etc). You can customize the search criteria within ranges (for dates or numbers) and to be exact or approximate (for texts), etc.

 

For further information on how to design these Queries please refer to Query Forms.

 

Once defined, Query Forms are used from the Work Portal.  The results of these queries provide useful information and statistics to control your business operation. You can save and share the most common queries and easily access them any time.

 

Results of queries can be viewed and analyzed graphically to provide better understanding of data.  For further information please refer to Graphical Analysis.

 

Perform Queries from the Work Portal

1. In the Work Portal go to the Queries menu.

 

Query1

 

2. Select the Query to be used from the following categories:

 

Application: This option will display all the Process Queries defined search for information for created cases to.

 

Other Entities: This option will display the queries defined for entities.

 

Stored query forms: This option will display the queries that have been saved. This option is shown when there is one or more queries saved.

 

Query2

 

3. Within each category you will find a list of Query forms. Click the desired one to open it.

 

Query23

 

4. The Query Form will display.

Each Query has several controls that serve as search criteria when the end user includes a value (know as filter) in them. Bizagi will look for all cases that contain the values selected.  If fields are left blank, the search will ignore those parameters.

 

Additionally, controls included in Queries can also be used as result criteria. By default Bizagi displays 6 columns with the main information of the cases that meet the search criteria: Case number, process, task, process creation date, task due date and process due date.

Every control in a Query has a check-box in front. If end users select the check-box, the control will display in the search results as a column.  

 

Query3

 

You can also check all fields as result criteria clicking on Check all.

 

Query24

 

If the criteria defined is not the one you wanted, click Clear.

 

Query25

 

note_pin

For Entity Queries select at least one field to be displayed in the results.

 

5. When you have defined your search criteria and your search results columns, click Search.

 

Query26

 

The results of the Query will display.

 

Query27

 

note_pin

The results produced correspond to the information regarding cases or entities that have been saved in the database. Therefore, any information that has been updated, added or deleted WITHIN activities that have not been completed (end users have not clicked on NEXT)  will not be reflected.

The results can be exported to Excel as long as the number of rows is less than 65535.

If a case is stopped in an automatic task as asynchronous, a message or signal event for example, it will be listed in the results of the query forms when it complies with the established filters. It will not be shown in the results of the query forms that are performed for a particular user (the logged-in user), because it will not be on behalf of the user.

 

Example

In a Sales Opportunity Management process we want to consult the Creation date, Lead Source, Estimated Revenue and Stage for all cases created between the following dates: 01/01/2016 and 31/12/2016.

 

A Query From has been defined for this process and it is called General Query.

 

1. In the Queries menu select the General Query within the Sales Opportunity Process.

 

Query5

 

2. In the Query select the time frame for the Creation Date in the From and To fields.

 

Query6

 

3. Check the attributes Creation date, Lead Source, Estimated Revenue and Stage that will be displayed in the results table.

 

Query7

 

4. When Search is clicked the Query will display the results. Notice that the controls marked on the Query Form are shown as columns in the results table.

 

Query9

 

Save a Query

The search criteria and results criteria can be saved to be executed easily in the future.

When the results of a Query are displayed you will find the Save button to save this configuration.

 

Query10

 

When clicked, a new window will display to enter the following information about the Query:

 

Name:  Give your search a name.  It can be up to 25 characters long.

Description: Enter a description as clear as possible.

 

Query11

 

Saved Queries are accessed anytime from the Queries menu. These are stored under the Stored query forms option.

 

In our previous example, the Sales Opportunity cases where searched according to certain criteria specified in the General Query, the  results were saved with the name "Opportunities 2016". This new query can be accessed from the Stored query forms option. Just click on the query to execute it again.

 

Query16

 

Edit a Saved Query

1. Click the Edit button located on the right of the saved Query.

 

Query21

 

2. A new window will display where you can modify the Name, Description, people to share and the search criteria as you desire.

 

Query18

 

3. You can save the modified Query as a new one and keep the original version by clicking Create new, or update the original version by clicking Update.

The Update will only be enabled for the owner of the original query, and not to users who have received a shared query.

 

Query20

 

Delete a Saved Query

1. To delete a saved Query click the Delete button located on the right of the saved Query.

 

Query17

 

2. Confirm the deletion by clicking the Delete option.

 

Query22

 

Share a saved Query

You can share saved queries with other end users, so they can all see the results and perform analysis over them.

If a saved query is not shared, you will be the only user that will be able to see it.

 

If you want to share a saved Query with other end users, move to the Users and groups to share tab.

 

Query12

 

This tab has two options:

 

The Users option allows you to select users by User Name, Domain and Full Name.

 

note_pin

You need to have user administration rights to be able to share your queries with other users.

 

Query13

 

From list of users, choose the ones you want to share with and click the ">>" Button to select them.

Then click the Save button to allow the group to access your Query.

 

Query14

 

The Groups option enables adding a group of users to share the Query with.  In the Group Name list, all the groups that have been created in the application are listed. To add a Group, use the">>" button. Once the desired Groups have been added click Save. To delete a group from the list, select it and click "<<".

 

Query15

 

note_pin

Users who have access to a saved Queries can see the results of the query , and save it as a new saved query. They cannot edit or delete the Query.

 

Transfer saved queries

To transfer the ownership of all queries created by a user to other, keep in mind the following conditions:

 

The user that wants to transfer saved queries must have the access rights to the queries Permission Manager granted in Bizagi Studio.

When you select the Permission Manager button, a pop up window appears for you to transfer permissions. You must match the user that currently has the saved queries  with the target user through search menus.

The Permission Manager option, is always at the top of the Work Portal queries menu.

You can preview the name(s) of each user saved queries listed on a preview window.

You cannot choose specific saved queries to transfer, the whole saved queries of the current user are transferred to the target user.

This action cannot be undone.

 

Suppose that you have the access rights to queries Permission Manager granted and you want to transfer the queries saved by the user Edward Williams to the user Mary Renner. Follow the steps described below:

 

1. In the Work Portal, go to the Queries menu and at the top, select the Permission Manager option.

 

TransferQuery1

 

2. The Permission Manager window appears. It has two search buttons; the left one lets you select the user who currently has the saved queries you want to transfer (Current user) and the right one lets you select the user that you want to transfer the queries to (Target user). It has a preview window that lets you preview the list of the name(s) of the saved queries of the selected Current user. If the Current user that you select has no saved queries, a warning message appears on the preview screen.

 

Select the left Search button to look for the Current user Edward Williams.

 

TransferQuery2

 

A window to search users appears. Type the Current User name, click search. Then, click Select.

 

TransferQuery3

 

On the preview section, find a list containing the name and the description (if it exists) of the Current user saved queries. Select the right search button to look for the Target user.

 

TransferQuery5

 

A window to search users appears. Type the Target User name, click search. Then, click Select.

 

TransferQuery6

 

Verify that both, Current and Target users are correct, and select Transfer permissions at the bottom right of the window.

 

TransferQuery7

 

A warning message appears, click Transfer.

 

TransferQuery8

 

At the bottom right of your screen, a notification regarding the succesful operation appears.

 

TransferQuery9

 

Now Mary Renner, can visualize the transferred queries on her Work Portal. To visualize them, she must select the queries menu, then the folder Stored query forms.

 

TransferQuery11