Query

Video tutorial on the query function

The query function is found from the Workbench under the Tools Menu. Use the Sidebar to select a desired Data Type to search for in your Query. The Query function lets you formulate a search query by writing criteria connected through the logical operators AND and OR. This way of writing Queries is easy to overview and to edit since the entire query is visible and editable on one page. To specify a query, first select the initial data type that you are looking for and then fill out a criterion. The AND operator is chosen per default. I’ll come back to the OR operator in a moment.Say that I want my query to find all Associations that are a kind of Business Improvement Initiative. When I set the data type to Association a criterion with the definition is a kind of is automatically added, since an association always require a definition. If you know that your definition doesn’t have any sub classes it’s more efficient to change the criterion to equals so that the system won’t make unnecessary searches. And when you expand and scroll through this combo box, the information will load faster if you narrow it down with a by writing part of the name of the definition that you are looking for. This function uses contains to find definitions, so you can write any part of the name to find it.            

Click any of two Operators AND or OR  to add a criterion. AND is selected by default, which is indicated by the arrow. When adding an OR criterion, the OR operator button needs to be pressed first to create a subquery within which an OR criterion can be added.

When adding a criterion you have five paths to choose from the menu

 

The Algorithm that decides what Attributes to display works in the following way:

Simple Search Query

All attributes (regardless of existing actual instances of the definition) that are defined on given definition(s) and super classes in the search query. Only the class attributes is displayed if no definition or is a kind of is given. Example: Definition = A, Definition = A AND Definition = B (etc), Is a kind of = A, Is a kind of = A AND Is a kind of = B (etc), Definition = A AND Is a kind of = B (etc)

Complex Search Query

Only attributes that are defined on given definition(s) and super classes in the search query that actually have instances. Only the class attributes is displayed if no definition or is a kind of is given.

Example: Definition = A OR Definition = B (etc), Definition = A OR Is a kind of = B (etc)

 

The Algorithm that decides what Relations to display works in the following way:

Simple Search Query

All relations (regardless of existing instances to the relation) that are defined on given definition(s) and super classes in the search query.

Complex Search Query

Only relations that are defined on given definition(s) and super classes in the search query that actually have instances. Only the class attributes is displayed if no definition or is a kind of is given.

Video tutorial on parameters in queries

 

To add a parameter to a criterion, press the parameter button next to the combo box.

This reveals the parameter window.

Name the parameter, select a data type and write an expression. Then press add Parameter to save it to the list.

Select the parameter from the list before closing the window to add it to your criterion. A parameter can be used multiple times in the same query.

More information about available parameters and expressions can be found in the documentation on Expressions.

 

Press Run to return the units that matches the given Query. The table below returns the query results.

You can right click units in a query result to interact with them.

 

 

 

Open	Opens Unit for viewing and editing of the units attributes
Open in new tab	Opens Unit in new browser tab
Open in Model Builder	Opens Unit in Model Builder
Copy ID	Copies the ID of the Unit
Create copy	Opens a Copy of the selected Unit with the given name Copy of [Unit Name]. Notice that the copy is not saved to the database until you press
Bookmark [Unit Type]	Adds the selected Unit to the Library

From the returned Query results you are able to open any unit to edit or view its usages, by double-clicking or right-clicking and choosing open/open in a new tab.

You are able to edit units definitions, relations and attributes (depending on the unit type) by making changes to the available entries for the unit.

Usages

Open Used X times to see where a unit is being used. This functionality allows you to effectively determine where changes made to the unit will apply.

Click any unit to open it in a new tab.

 

Usages analyze the following

Relations,
Subclasses and Implementing definitions,
Value references,
Query constants,
Value Set constants,
Applications constants, used in queries and specification of links between boxes,
Calls in methods (only methods)
Constant in OBJECT primitive ( all types).

Usages DOES NOT analyze
Expressions (Application variables, calculated columns, presentations, etc)
Instances
Constants in methods (only OBJECT primitive as stated above)

 

 

Users are by default prohibited to access the Query function from the Workbench. Consult a System Administrator of your instance if you require access.