Template Queries

There are several processes run after the data loading is completed, one of which the objectstore summarisation. This step counts the number of objects of particular classes, identifies any empty references/collections and collects values to be appear in dropdowns in the query builder and templates. The summarisation process also constructs the indexes needed for “type-ahead” autocompletion, this is configured by adding entries to the ObjectStore Summary file.


Fields in template queries and the QueryBuilder can have type-ahead autocompletion to assist in selecting valid terms. As you start to type, possible matches are fetched from the database; the text you have typed can match anywhere within the terms and multiple words can be matched. This is particularly useful for ontology terms or protein domain names.

You can set up autocompletion by completing these steps:

  1. Add the postprocess to your MINE_NAME/project.xml file.
  <post-process name="create-autocomplete-index"/>
  1. Then run this command:
# run postprocess
~/git/flymine $ ./gradlew postprocess -Pprocess=create-autocomplete-index --stacktrace

This process will add all fields set in this properties file to the autocompletion index.

Now, when you release your webapp, fields you’ve configured will suggest similar terms as users are typing in the QueryBuilder or the template form.

Optional constraints

To make a template constraint optional:

  1. edit the template in the query builder
  2. click on the padlock next to the constraint
  3. select optional:
Required - the user must supply a value
Optional: ON - optional and ON by default
Optional: OFF - optional and OFF by defaul

Templates page

To have templates appear on the templates page, create a template as a SuperUser and tag the template with the “im:public” tag.

The templates are sorted by most popular first. If the user is logged in the user’s most popular templates are shown first.