User's manual

1. General presentation
2. Save simple and advanced queries
   1. First recording
   2. Save an existing query
   3. Save as query (valid for all query types)
   4. Save a query Solr
3. Save a script
4. Save a formatting query (valid for all query types)
   1. First recording
   2. Save an existing formatting request
   3. Save as a formatting query (valid for all query types)
5. Query directory tool
   1. Tree
   2. Filter
   3. Button filters
6. Actions
   1. For versions prior to 2.9.0
7. For versions 2.9.0 and higher
8. Actions on queries
9. Actions on directories
10. Rights management (prior to version 2.9.0)
    1. Actions on query sharing
    2. Rights on request
       1. Tool
       2. Actions
11. Rights management (from version 2.9.0)

General presentation

Access to this tool is associated with the "Query directory tool" right, available in the "Query directory" category. 

The Query Directory tool is available in the Home menu ,

and allows you to save and classify different types of requests by directory: 

• simple and advanced 
• Solr
• Script
• Formatting

This tool displays and manages : 

• saved requests (modify, delete)
• directories (create, modify, delete)
• set query visibility (public, shared, private). 

Save simple and advanced queries

Open the search tool  (available in the Home/Search menu). 

For more information on the search tool, please visit this page. 

The search opens in a "Search" tab;

the "Search" ribbon appears, with a "Queries" category and the following buttons:

The button saves the current simple query in the query directory. 

First recording

A window opens, allowing you to fill in the following information: 

• A title (mandatory)
• A description (optional)
• A directory (optional - if no directory is selected, the query will be saved to the root of the query directory) 

By clicking on the You can select an existing folder or sub-folder, or create a new one: 

Once saved, the query will be displayed in the query directory with : 

The Query Directory tool and its display are described below.

• an icon (indicating a search query) 

• the node name corresponds to the title
• under the chosen directory (or at root if no directory is chosen)
• visibility will be private by default

Save an existing query

If the query has already been saved, the following window opens, allowing you to select the query to be modified (pre-filled with the name of the open query). 

Save as query (valid for all query types)

It is also possible to save a query as a new query, via this entry 

Save a query Solr

Open the search tool Solr   (available in the Home/New request menu Solr). 

For more information on the Solr search tool, please visit this page .

The Solr search opens in a "Query Solr" tab,

and the "Search" ribbon appears, featuring a "Queries" category with the following buttons:

Registration is performed in the same way as for simple and advanced queries, as described above. 

The icon displayed in the query directory tool will be . 

Save a script

Open tool script(available in the Home/New script menu). 

For more information on the script tool, please visit this page. 

The script tool opens in a "Script" tab,

and the "Search" ribbon appears, featuring a "Queries" category with the following buttons:

Registration is performed in the same way as for simple and advanced queries, as described above. 

The icon displayed in the query directory tool will be . 

Save a formatting query (valid for all query types)

Query formatting involves sorting, active columns and facets.

This formatting can be saved and applied to another query. 

It is available for all types of queries (simple and advanced, script and Solr).

First recording

In the "Search" ribbon, the  saves the formatting in the query directory. 

To do this, the following window opens and allows you to fill in the following information: 

• A title (mandatory)
• A description (optional)
• A directory (optional - if no directory is selected, the query will be saved to the root of the query directory) 

By clicking on the You can select an existing folder or sub-folder, or create a new one. 

Once saved, the formatting query will be displayed in the query directory with : 

• An icon (indicating that this is a formatting query)
• the node name corresponds to the title
• under the chosen directory (or at root if no directory is chosen)
• visibility will be private by default

Save an existing formatting request

If the formatting query has already been saved, the following window opens, allowing you to choose the query to be modified (pre-filled with the name of the open query). 

Save as a formatting query (valid for all query types)

It is also possible to save the existing formatting query as a new query, via this entry 

Query directory tool

This tool is available in the Home menu, by clicking on the  . 

It is presented as follows: 

Tree

The query tree displays : 

• folders and subfolders 
• node queries. 

The following columns are present: 

• Title 
  
  • for folders and subfolders
  • for simple and advanced queries
  • for a Solr
  •  for a script
  • for a formatting query

• Visibility : 

Visibility only available for versions prior to 2.9.0 

• • for a private request
  • for a shared request
  • for a public request
• Type : 
  • Simple
  • Script
  • Solr
  • Formatting
• Author: the request's author

Filter

The filter displays only those queries in the tree whose title matches the filter. 

The button deletes the filter.

Button filters

The following actions are available: 

• : clicking on this button only displays queries created by the current user
• Click on this button to display "simple and advanced" queries only.
• Click on this button to display only queries of type Solr
• Click on this button to display only queries of type Script
• : Clicking on this button only displays formatting queries. 

Actions

For versions prior to 2.9.0

For versions 2.9.0 and higher

Actions on queries

Access to these actions is subject to the "Administer queries" right in the "Query directory" category. 

Actions on queries are available under "Actions",

and are accessible when a query node (of any type) is selected. 

• to execute the request

Access to this button depends on query visibility rights (see explanations below).

Double-clicking on a query node also executes it. 

• opens the query for viewing, without executing it
• allows you to modify the title and description of a query
• deletes the request (after confirmation)

Actions on directories

Actions on directories are available under "Directories",

and are accessible when a folder node (or subfolder) is selected. 

Access to these actions is subject to the "Manage directories" right in the "Query directory" category. 

•  creates a new folder under the selected node
• Actions and are also available.

Rights management (prior to version 2.9.0)

Actions on query sharing

Actions on query sharing are available in the "Sharing" section,

and are accessible when a query node (of any type) is selected. 

• The Visibility button lets you modify the visibility of a query: 

• Public: the query is readable and writable by all users

• Shared: the query can be read and written by selected users via the "Query rights" button.shown below. 

• Private: the request can only be read and written by the current user, and not by any other user. 

Rights on request

This button is only available if the selected query has shared visibility, and opens the "Query rights" tool.

Tool

This tool lists users or groups with read and read/write access to the selected query. 

Users or groups with read access will only be able to view the query, without being able to modify it. 

Users or groups with read/write access can view the query, and also modify it. 

Actions

The actions of the "Query rights" tool are available in a "Sharing" tab. 

• This button is available as soon as at least one category (read or read/write) is selected. 

It allows you to add one or more users to the selected category(ies), and thus add the corresponding right. 

A window opens, allowing you to select the users to whom the corresponding right should be assigned.  

•  This button is available as soon as at least one category (read or read/write) is selected. 

It allows you to add one or more groups to the selected category(ies), and thus add the corresponding right. 

A window opens, allowing you to select the groups to which to assign the corresponding right. 

• This button is available as soon as at least one user or group is selected. 

Removes this user or group from the selected category. 

A pop-up window opens to ask for confirmation. 

Rights management (from version 2.9.0)

The "Restrict access" button is available on a directory or a query. 

This button opens the following management tool:  

This same tool can be found by clicking on the "Users, Groups & Rights"/"Assign profiles" button, then selecting the "Query directory" context. 

This tool lets you assign rights to directories or queries, according to the following principles: 

• I see a folder if :
  • I have the right to write or read on it
  • I have read/write access to a subfolder
  • I have read/write access to a sub-query
  • I have a sub-query that I created myself

• I can rename a folder if :
  • I have the right to write on it and the direct relative

• I can delete a folder if :
  • I have the right to write on them, on all the children and on the direct parent.

• I can move a file if :
  • I have write access on all children, on the direct parent and on the target folder.

• I can create a folder if :
  • I have write access on all children, on the direct parent and on the target folder.

• I can add a query if :
  • I have the right to write on the direct relative

• I can delete/modify a request if :
  • This is my request
  • If I have the right to write on this request and on its direct relative

• I can move a request if :
  • This is my request, and I have write access to the target folder.
  • If I have write access to this request, its direct parent and the target folder

Summary table

ID*: internal identifier used by bus message and buttons