One of the goal of AskOmics is to enable re-use and customization of complex queries shared by other users. This functionality is available in two different ways.

Templates¶

Templates are a simple way for yourself or another user to replay your queries. They will access a copy of the query graph, and be able to customize all parameters and relations (this includes linking to additional entities).

Templates will appears on the right-side of the homepage. The description of the template can be customized to include more information regarding the query.

Creating a template¶

To create a template, first create the query you want, and Run & save. Then, in the result page, you can toggle the 'template' attribute to create the template.

Editing the template description¶

You can modify the template description the same way you would edit the result description. Simple click on the value of the 'Description' column, and enter your own description.

Using the template¶

On the AskOmics homepage, simply click on the template of interest to access the query interface. From there, you can simply interact with it as you would with a normal query, including saving the results.

Removing the template¶

To remove the template, you can either toggle the 'template' attribute back to off, or delete the result as a whole.

Forms¶

Whereas templates allow users to completely replay your queries (including modifying the query graphs), forms aim to be a much simpler way to share your queries for users not familiar with the way AskOmics works.

When using a form, other users will only able to change the values for a set of parameters you will have selected beforehand.

For instance, if your query is List all users whose favorite color is red, users will only be able to change the favorite color, before sending the query.

In addition, you will be able to customize the form before sharing it, such as changing the description (much like templates), but also the name of each entity and attribute.

Like templates, forms will appear on the right side of the homepage, with the chosen description.

Creating a form¶

To create a form, you will first to create a form-ifiable query. To do so, start with a regular query, and toggle the template ( ) button on all attributes of interest. Selected attributes will be modifiable in the form.

After saving the query with Run & save, head to the Results page. You will be able to toggle the 'Form' button, creating the form.

Editing the form description¶

You can modify the form description the same way you would edit the result (and template) description. Simple click on the value of the 'Description' column, and enter your own description.

Editing the form display¶

For each entity with a form attribute, the form will display both the entity name, and each attribute label (in addition to the input field). You can customize this display (for instance, changing the display entity name to something more readable, or changing an attribute label to make your query more explicit)

To do so, simply click on Form to access the form editing interface. You can then simply edit entities and attributes labels, and click on Save to save the new display.

Using the form¶

On the AskOmics homepage, simply click on the form of interest to access the interface.

Removing the form¶

To remove the form, you can either toggle the 'form' attribute back to off, or delete the result as a whole.