Home → Client Onboarding → Management/Operations → Configuring a Search
2.10. Configuring a Search
You can view an existing search's configuration options, as well as create and configure new searches, using the Search dialog box. Once configured, you can use these searches to locate generated documents in your SQL repository.
Proceed to one of the following sections below for more information:
- Selecting an Existing Search
- Creating a New Search
- Viewing the Search Configuration Options
- Specifying the Configuration Options
- Saving Your Updated Search
- Deleting a Search
Selecting an Existing Search
You can select a previously defined search using the search drop-down list in the top left corner of the Search dialog box.
Once selected, access the search configuration options and edit them, as desired.
Creating a New Search
You can create a new search using the search drop-down list in the top left corner of the Search dialog box.
- In the search drop-down list, type the name of the new search.
In the following example, a search called "New Search" is being created. - Click any white space to the right of the search drop-down list (as shown by the mouse cursor below).
The Save New Search dialog box appears. - Specify one of the following save options:
- everybody. The new search will be available to all users in the current client ID.
- only me. The new search will only be available to you. Other users will not see it and will not be able to use it.
The new search is saved.
- Access the search configuration options and edit them, as desired.
Viewing the Search Configuration Options
By default, the search configuration options are hidden on the Search dialog box.
You can access them using one of the following methods:
- Click the thin line near the top of the Search dialog box.
- Click the triangle icon in the top right corner of the Search dialog box.
Note: You may need to resize the Search dialog box (click and drag to the right) to see this triangle icon.
The configuration options are displayed on several tabs immediately below the thin line/triangle icon (and above the search results table).
Proceed to Specifying the Configuration Options below.
Specifying the Configuration Options
Once you access a search's configuration options, you can adjust the options, as desired, to verify that the search locates the correct generated documents in your repository. These configuration options are displayed in several tabs on the Search dialog box.
Proceed to one of the following sections below for more information on each individual tab:
- Specifying Search Options
- Specifying Search Filter Settings
- Specifying Search Column Settings
- Specifying Search Queue Settings
Specifying Search Options
The options tab allows you to specify a description for the search, which can be helpful for allowing other users to easily understand how to use the search.
This description will appear immediately below the search's name in the search drop-down list.
Specifying Search Filter Settings
The filter tab allows you to specify exactly what is searched for when the search is executed.
Using at least one condition, determine what the search will attempt to locate in your repository.
In the following example, all documents whose med_plan field contains the text gold will be returned by the search.
Tip: Use the + and - buttons to add or remove conditions, as necessary to define your search filters.
Specifying Search Column Settings
The columns tab allows you to control the information that appears in the search results table (in the lower half of the Search dialog box). This table displays the documents that match your search criteria, after a search is executed.
The columns tab is divided into the following three lists:
- The available list shows any columns that are not currently being used in the search results table. If you want a column to appear in the table, you can drag it to the selected column or click the + button (to the right of the column's name).
- The selected list shows all columns that are currently being used to create the search results table. If you do not want a column included in the table, you can drag it to the available list or click the - button (to the right of the column's name).
- The sort columns list allows you to specify the order in which the search results appear (the sort order) in the search results table. You can select a single column or multiple columns using the column's corresponding check boxes. The order the columns appear in the list determines the sort order, with the initial sort being based on the column at the top of the list, followed by the next selected column, and so forth. You can also control the sort order (ascending or descending) using the icon that appears to the right of each selected column. The upward pointing arrow means ascending order is used, while the downward pointing arrow means descending order is used. If desired, you can click the current setting (arrow) to change it to the other setting (arrow).
Specifying Search Queue Settings
The queue tab allows to you specify if the configured search will be automatically executed when certain users log into EOS.
To use this option, you need to activate it by selecting the corresponding check box (it is not active by default) and then specify a user type that will use the option.
In the following example, the option has been activated and the search will automatically be performed for all users assigned the user-admin role.
When a user with this role next logs into EOS, a Queue dialog box similar to the following example will appear, showing the automatically executed search results.
Tip: You can click the button adjacent to the wrench button (highlighted below) to change from the Queue dialog box to the standard Search dialog box.
In addition, if this option is enabled for multiple searches, tabs appear at the top of the Queue dialog box. One tab appears for each search that uses the option. In the following example, two searches appear.
Saving Your Updated Search
Once you have completely configured your search, you need to save your changes.
- In the upper portion of the Search dialog box, click the save button to the right of the search drop-down list.
A message appears confirming the save. - Click OK.
Your search changes have now been saved.
Deleting a Search
You can delete any search if it is no longer useful or necessary.
- Using the search drop-down list at the top of the Search dialog box, select the search you want to delete.
- Click the delete button.
A confirmation message appears. - Click Yes.
The search is deleted.