Although Cumulus remembers your search set-ups if you leave them open when you quit Cumulus, you can also save search set-ups, called queries. This prevents you from having to rebuild them each time you need them. It also ensures that your searches are consistent from session to session, which is important for some purposes.
With saved queries, you can use placeholder in the search value field, thus allowing the users to specify the query further during its execution.
Cumulus query files can be used on any supported platform. You can store and load queries for quick retrieval if you have the appropriate permissions.
NOTE: A saved query can be used with any catalog you have access to. However, there is something to take account of: If a query uses a field with the operator “has no value”, and you run that query in a catalog that does not contain that specific field, the query will find all records in that catalog. Although this may not be what you expect, it is the proper behavior.
Saving and Loading Search Queries
To save the current query:
1. Click the button and select Save.
A dialog appears in which you can name the query.
2. Type a name for the query in the Query Name field.
3. Enter a description for the query. Make the description meaningful especially for queries that contain placeholders, because the description text will be displayed in the dialog window.
4. To make the query available for other users, activate the Share Query option.
5. Click Save.
The query is stored in one of the two special query files Cumulus provides – one for the individual queries of a user and the other one for shared queries. With Workgroup or Enterprise these files are centrally stored at the Cumulus Server.
To load a query:
1. Click the button. A menu containing entries for all queries that are available to you is displayed. These include those that you set up as well as those set up by other users for sharing.
2. Select the entry for the desired query file.
Using Placeholders
Placeholders enable you to set up complex search queries which appear for the executing user as easy search forms. With placeholders included in a query, Cumulus displays a dialog each time the query is invoked, forcing the user to enter appropriate values before the query is finally executed.
Placeholder can be used with most field types except UserUID, Binary and Picture fields.
To include a placeholder with a query:
1. Enter ${} as an identifier into the search value field of a search option.
In a compound query, you can use as many placeholders as you need. However, when using several placeholders in one single query, each placeholder must have a unique identifier, e.g. ${p1}, ${p2}, ${abc}, ...
TIP: Query Description is Displayed
When saving a query with placeholders use the description to inform the user what to do.
Exporting and Importing Search Queries
If you want to store a query as a separate file anywhere in the file system, you have to export it:
1. Click the button.
2. Select Export. A dialog appears from which you can save the current query anywhere in the file system.
3. Select a location.
4. Click the button Save.
To load such an exported query file you have to import it:
1. Click the button.
2. Select Import. A dialog appears from which you can select a query.