Components of a Web Client Search You use the InterAction Windows Client to create and edit Web Client search forms. Note that you must have Manage contact types permission to manage the Web Client searches.
When you create a search, you must specify information in the following fields in the New/Edit Web Client Search Form dialog box.
Components of a Web Client Search
| Field | Description |
|---|---|
| Search Name | The name is used to identify the search in the Web Client. The name appears as a link on the contact search page. |
| Status | Indicates whether the search is active or inactive. Only active searches appear in the Web Client. You might set a search to inactive if you want to temporarily remove it from use without completely deleting it. |
| Show in top search navigation check box |
Indicates whether a link for the search should appear in the set of links that appear across the top of the contact search page. Typically, searches set this way are the most important, frequently-used searches in an organization. These searches are also included in the drop-down list on the main menu. If this option is not selected, the search will appear in the list of “Other Searches.” For details, see Where Do Searches Appear in the Web Client? |
| Display Order |
Indicates the order in which the search will appear when displayed in the list of searches. This is used for both the searches across the top of the page and those displayed in the “Other Searches” section. For details, see Change the Display Order of Web Client Searches. |
| Results Display |
Indicates what information should be displayed in the right-hand side of the preview pane for the search results page. You can choose to display the summary version of a profile, all additional fields from a particular folder, global notes, or nothing. Note that this only controls the right-hand side of the preview pane; the left side always displays standard phone and address information. For details, see Choosing Contents for Search Results Preview. |
| Security |
Indicates which Web Client users will be able to see the search. Sometimes it is useful to limit a search to a specific group of users. For details, see Defining Which Users Can Use a Search. |
| Search Form Items |
Defines the set of fields and formatting elements that appear on the search form. Users can fill these fields in when performing the search. A search form can have several types of criteria, such as name/address fields, additional fields, contact types, and folder inclusion. You can also include display elements such as headings, blank lines, and static text. You can also determine whether or not the form requires search criteria with the Allow users to search with no criteria entered check box. For details, see the following: |
New/Edit Web Client Search Form Dialog Box
Give Users Permission to Manage Web Client Searches
Because Web Client searches are typically created in connection with contact types, a user must have the Manage contact types permission to create or edit searches. You assign this permission using InterAction Administrator.
- Log on to InterAction Administrator.
- From the main window, double-click User Account and Group Configuration.
- Choose the Permissions button to display the Permission Settings dialog box.
-
Under Configuration Permissions, select the user or group that should be allowed to Manage contact types.
Setting Result Everyone Anyone with access to the Windows Client can create and edit contact types, Web Client profiles, and Web Client searches. System Administrator Only Only the System Administrator User can create and edit contact types, Web Client profiles, and Web Client searches. Specific Group Only members of the group can create and edit contact types, Web Client profiles, and Web Client searches. - When finished, choose OK.
Create a New Web Client Search
- Log in to InterAction Windows Client as a user with permission to create contact types.
- The Manage contact types permission is required to create or edit Web Client searches. This is because searches are typically created in conjunction with contact types.
- This permission is granted using InterAction Administrator. For details, see Give Users Permission to Manage Web Client Searches.
-
Choose Tools > Web Client Search Form Manager. InterAction will display a list of existing Web Client Search Forms.
- On the Manage Web Client Search Forms dialog box, choose New.
- Enter the Search Name. This value will be used in several places when displaying the search in the Web Client.
- The name appears as a link when displaying the list of searches on the contact search page.
- It also appears above the form itself on the page. You can see how it will look by noting the first item displayed in the list of Search Form Items.
- It also appears in the title of the page that displays the search results.
- Do not append the word “search” after the name; the Web Client does this automatically.
-
If a link for the search should appear in the set of links across the top of the contact search page, select the Show in top search navigation check box.
- This also includes the search in the drop-down list in the main menu.
- If you don’t select this option, the search appears in the “Other Searches” section.
Including too many searches in the top navigation will clutter the screen and make it more difficult for end users to find the searches they need. Include only the most important, frequently-used searches.
-
Enter the Display Order for the search. This defines the order in which the search will appear in the list of searches.
This is used for both the searches across the top of the page and those displayed in the “Other Searches” section.
-
If you want to change the information that will be displayed in the right-hand side of the preview pane for the search results page, choose the Change button and select the information to use. For details, see Choosing Contents for Search Results Preview.
- Under Security, indicate which users should be allowed to use the search. You can give access to all users or you can select a specific user or group. For details, see Defining Which Users Can Use a Search.
- Under Search Form Items, select whether or not users should be able to run the search without entering any criteria. For details, see Requiring Criteria for a Search.
-
Under Search Form Items, add the criteria items for the search. A search form can include name, address, and additional fields. It can also include display elements such as headings, blank lines, and static text.
To Do This Add an item Choose New, then select the item to add. Change the properties for an item. Select the item from the Search Form Items list and choose Edit. Delete an item. Select the item from the Search Form Items list and choose Delete. Change the order in which the items will be displayed. Select an item and use the Up and Down buttons to move it up or down. Note that you can’t move the Search Name item; this is used as a heading when displaying the form. Items you add to the form appear in the Search Form Items section similar to the way they will appear when Web Client displays the form. Use the Up and Down buttons to re-arrange the items.
For more information, see the following:
- If you need to include any special hidden parameters that will be passed to the search results page, choose Advanced, then use the New button to add the parameters. For details, see Pass Parameters Directly to Search Results Page.
- Choose OK to close the dialog box and save the new search form.
-
Choose Close to close the Manage Web Client Search Forms dialog box.
Your changes become available in InterAction Web Client after the next InterAction Application Server cache refresh. For details about manually refreshing the Application Server cache, see Refreshing the Application Server Cache.
Edit a Web Client Search
- Log in to InterAction Windows Client as a user with permission to create contact types.
- The Manage contact types permission is required to create or edit Web Client searches. This is because searches are typically created in conjunction with contact types.
- This permission is granted using InterAction Administrator. For details, see Give Users Permission to Manage Web Client Searches.
-
Choose Tools > Web Client Search Form Manager. InterAction will display a list of existing Web Client Search Forms.
- Select the search form you want to change and choose Edit.
-
Change the settings for the search as needed. For details about the settings, see Components of a Web Client Search.
You can only edit certain attributes for the out-of-the-box List Searches and Other Searches items. For details, see Can I Edit or Delete All the Out-of-the-Box Searches?
- Choose OK to close the dialog box and save your changes.
-
Choose Close to close the Manage Web Client Search Forms dialog box.
Your changes become available in InterAction Web Client after the next InterAction Application Server cache refresh. For details about manually refreshing the Application Server cache, see Refreshing the Application Server Cache.
Delete a Web Client Search
Deleting a Web Client search permanently removes it from the system. If you think you might need to restore the search later, edit it and change its status to inactive instead. Users won’t be able to see it in the Web Client, but the search will still be in the database and you can restore it by changing the status back to active. See Make a Web Client Search Inactive.
- Log in to InterAction Windows Client as a user with permission to create contact types.
- The Manage contact types permission is required to create or edit Web Client searches. This is because searches are typically created in conjunction with contact types.
- This permission is granted using InterAction Administrator. For details, see Give Users Permission to Manage Web Client Searches.
- Choose Tools > Web Client Search Form Manager. InterAction will display a list of existing Web Client Search Forms.
- Select the search form you want to delete and choose Delete.
-
Choose Close to close the Manage Web Client Search Forms dialog box.
Your changes become available in InterAction Web Client after the next InterAction Application Server cache refresh. For details about manually refreshing the Application Server cache, see Refreshing the Application Server Cache.
Make a Web Client Search Inactive
Changing the status of a search to inactive removes the search from the Web Client without actually deleting it. The search is still in the database and you can restore it by changing the status back to active. This is preferable to completely deleting a search.
If you have created any links to a search form (such as links on the home page), you should remove those links as well when inactivating the form.
- Log in to InterAction Windows Client as a user with permission to create contact types.
- The Manage contact types permission is required to create or edit Web Client searches. This is because searches are typically created in conjunction with contact types.
- This permission is granted using InterAction Administrator. For details, see Give Users Permission to Manage Web Client Searches.
- Choose Tools > Web Client Search Form Manager. InterAction will display a list of existing Web Client Search Forms.
- Select the search form you want to remove and choose Edit.
- Change the Status to Inactive and choose OK.
-
Choose Close to close the Manage Web Client Search Forms dialog box.
Your changes become available in InterAction Web Client after the next InterAction Application Server cache refresh. For details about manually refreshing the Application Server cache, see Refreshing the Application Server Cache.
Can I Edit or Delete All the Out-of-the-Box Searches?
There are some restrictions on deleting and editing the Web Client searches included with InterAction. This is because some of these searches use special settings that cannot be recreated in the Web Client Search Forms Manager in the Windows Client.
You can customize the Web Client searches included with InterAction to suit your organization. However, there are restrictions when editing the following forms:
- List Searches
- Other Searches
For each of these forms, you can edit the following:
- Name
- The status (active or inactive)
- The display order
Note that the List Searches and Other Searches options are not actual search forms. They are placeholders for the List Searches and Other Searches links on the contact search page. Changing the name and display order changes how these links appear on the page. For details, see the following:
- Change the Display Order of Web Client Searches
- Change the Terms Used for List Searches or Other Searches on the Contact Search Page
If your organization has licensed one of the Related Modules (InterAction Matters, Opportunities, or Engagements), you can also edit the External Expertise - Contact Criteria and Internal Expertise - Contact Criteria searches. These searches find matters, opportunities, or engagements based on the contacts involved. Modifying these search forms modifies the contact criteria section.
Change the Display Order of Web Client Searches
You can define the order in which Web Client searches appear on the contact search page. The display order controls the order in which the searches appear on the contact search page, both for the forms that appear across the top navigation and in the Other Searches section. The display order also controls the order of the searches in the main menu drop-down list.
You control the display order by assigning a display order value to each search. The search forms are sorted by this value in ascending order, so forms with smaller numbers appear first.
[A] Display order controls the order of the search form links in the top navigation of the page.
[B] Searches displayed in the Other Searches area section also follow display order.
- Log in to InterAction Windows Client as a user with permission to create contact types.
- The Manage contact types permission is required to create or edit Web Client searches. This is because searches are typically created in conjunction with contact types.
- This permission is granted using InterAction Administrator. For details, see Give Users Permission to Manage Web Client Searches.
- Choose Tools > Web Client Search Form Manager. InterAction will display a list of existing Web Client Search Forms.
-
Note the numbers listed in the Display Order column. You can sort the searches by this column to see the current display order.
If you want to separate the forms that will appear across the top of the contact search page from those that appear in the Other Searches section, click the Top Navigation heading to sort the list of forms.
-
To change the order, edit each search and update the value in the Display Order field. Remember that the forms will sort in ascending order when they are displayed in the Web Client.
To edit a search, select it from the list and choose Edit.
-
Choose Close to close the Manage Web Client Search Forms dialog box.
Your changes become available in InterAction Web Client after the next InterAction Application Server cache refresh. For details about manually refreshing the Application Server cache, see Refreshing the Application Server Cache.
Change the Terms Used for List Searches or Other Searches on the Contact Search Page
The List Searches and Other Searches links appear on the contact search page and in the drop-down list of searches in the main menu. The List Searches link displays automatically generated searches for the user’s contact list and any working lists or marketing lists the user has access to read. The Other Searches link displays searches that do not need to be in the top navigation.
You can change the text used for these links.
Remember that the searches displayed on the List Searches page include all working lists the user can read, and all category-related searches for the user’s contact list. Therefore, the name used for this link should be generic enough to apply to both types of searches.
- Log in to InterAction Windows Client as a user with permission to create contact types.
- The Manage contact types permission is required to create or edit Web Client profiles. This is because profiles are typically created in conjunction with contact types.
- This permission is granted using InterAction Administrator. For details, see Give Users Permission to Manage Web Client Searches.
- Select the item to change. Then, using the right-click menu, choose Edit Folder. Alternatively, once you have selected a folder, choose Folder > Edit Folder.
- Edit the Name field to the text you want to use, then choose OK to save your changes.
-
Choose Close to close the Manage Web Client Search Forms dialog box.
Your changes become available in InterAction Web Client after the next InterAction Application Server cache refresh. For details about manually refreshing the Application Server cache, see Refreshing the Application Server Cache.