28 Working with the Search Service
This chapter describes how to use the features provided through the Search service.
This chapter includes the following sections:
This chapter is intended for WebCenter Spaces users interested in using and managing search. Much of this information also applies to custom WebCenter applications, though it is written with WebCenter Spaces users in mind. (For information about custom WebCenter applications, see "Integrating the Search Service" in Oracle Fusion Middleware Developer's Guide for Oracle WebCenter.)
Your application administrator has the authority to expose or hide task flows from a particular service. Tasks discussed in this chapter are not available to you if the relevant service is hidden.
28.1 What You Should Know About the Search Service
The Search service enables the discovery of information and people through an intuitive user interface, returning only the results you are authorized to view. With all relevant information easily navigable, you do not have to switch between applications performing multiple searches.
Use the Search service to run, refine, and save custom searches. By default, WebCenter Search looks for your search terms in every searchable service available to the application (a global search). You can configure the services to which a search has access with your personal preferences (see Section 3.9, "Setting Preferences for WebCenter Spaces Search Results").
Information in WebCenter services is searched by name and content. In WebCenter Spaces, you can also search an individual group space.
In addition to WebCenter Search, the Documents service provides its own search engine for file and folder searches. This saves time and increases the relevancy of results by narrowing the scope of a search to files. The Documents service searches within a specific group or personal space's document library. For more information, see Section 18.4.8, "Running Document Searches in the Document Manager Task Flow."
In all cases, searches return only the results you are authorized to view. For example, if you are not a member of the Finance group space, then any search results from that group space do not display.
Search results return content and tag matches. Tag matches display on the Search Results page and in the Search Results window. For more information about tagging, see Chapter 29, "Working with the Tags Service."
28.1.1 Setting Search Preferences
The WebCenter Search service uses search adapters to find content inside WebCenter applications. However, your WebCenter Spaces administrator can override the default search adapters and use Oracle Secure Enterprise Search (SES) to get unified ranking results for the following resources:
-
Documents
-
Group Spaces
-
Group Space Announcements
-
Group Space Discussions
-
Lists
-
Pages
-
People
-
Wikis and blogs
The results are listed together, instead of being clustered into separate sections for Documents, Discussions, and so on. The most relevant items appear first. For example, when you run a search for a user name, most likely, you are looking for that persons's contact information (that is, the exact user name in the People Connections service), not necessarily documents that the user wrote. The unified ranking results in Oracle SES allow you to see the most relevant results, across all different types of searches, without configuring Search Preferences.
Additionally, with Oracle SES as the WebCenter search engine, you can use the wildcard character [*] in the middle or end of a term for wildcard matching. For example, if you search for keywords like wiki or page, Oracle SES does not return the wiki page MyWikiPage in search results. However, My* or My*Page does return MyWikiPage.
If your administrator did not configure Oracle SES as the search engine, then you can set your personal search preferences to specify which services to search and the order of services in your search results. For example, you may find that search results from the Documents service prove more useful that search results from other services. By default, all services are selected. You can disable any service from which you do not want to see search results. For more information about setting search preferences, see Section 28.1.1, "Setting Search Preferences."
28.2 Working with Search Service Task Flows
WebCenter provides search services for the application and beyond.
This section includes the following subsections:
28.2.1 Adding a Search Service Task Flow to a Page
For the steps to add a Search service task flow to a page, see Section 10.1.4, "Adding Task Flows to a Page."
Each group space has a default Search page where users can perform group space-wide searches. If, however, members of the group space need to perform a search from within a different page in the group space, then add the Search task flow to that page. Bear in mind though, that when search results are displayed in the Search task flow, they may be difficult to read if the task flow is on a page with other content.
In WebCenter Spaces, you can add a saved search to a particular page. The results of the search are displayed directly on the page. You can add global saved searches to personal space pages and group space saved searches (both your own and shared ones) to group space pages.
In WebCenter Spaces, you also can provide a quick and easy way of seeing all saved searches by adding the All Saved Searches task flow. In a group space, the All Saved Searches task flow lists your saved searches for the group space and all shared saved searches for the group space. It does not list your global saved searches or saved searches made against other group spaces. In a personal space, the All Saved Searches task flow lists all your global saved searches.
28.2.2 Searching in a WebCenter Application
This section describes how to run a global (that is, application-wide) search, and how to run a search within a specific group space.
This section includes the following subsections:
28.2.2.1 Performing a Global Search
Global search provides an application-wide search. All services offer components to be searched. Provided you have permission to access those components, global search covers all of them.
In WebCenter Spaces, by default, you can perform a global search from the search field at the top-right of the application.
Note:
If a group space is configured to display in full screen mode, then the search field at the top-right becomes a group space search field and the search is specific to the current group space.To perform a global search:
-
Log in and locate the global search field and enter a search term.
For example, the search field at the top right of the WebCenter Spaces application is a global search field (Figure 28-1).
-
Press Enter or click the Search icon next to the global search field (Figure 28-2).
Results display in the Search Results popup window (Figure 28-3).
Note:
Figure 28-3 shows results using the default Oracle search adapters. Notice that search results are segregated into groups. The first group shows the results from the Documents service (2). The second group shows the results from the Discussions service (1). The third group shows the results from the Tags service (1). -
Click a link to open a result.
Results open differently according to the service that provides them. For example, results from the Documents service open in a new browser tab or window. Results from services that provide resource viewers, such as Discussions, Lists, or Announcements, open in their resource viewer.
-
Optionally, in the Search Results window click the More button. In WebCenter Spaces, this displays search results on a separate Search page.
From here, you can also further refine the search by contributor or last modified date using the Refine Search section. For more information, see Section 28.2.3, "Refining the Display of Search Results." You can also save the search so that you can access the results later. For more information, see Section 28.2.4, "Saving Searches."
You can configure how search results are displayed. Specifically, you can control which services are included in the search, the order in which those services are listed in the results, and what information is included, such as the type, size, or owner of the object returned. Set this in the Search Preferences panel of the Preferences dialog (for information see Section 3.9, "Setting Preferences for WebCenter Spaces Search Results").
28.2.2.2 Performing a Group Space Search
In WebCenter Spaces, each group space has its own Search page. Use this page to restrict your search to that specific group space.
To perform a group space search:
-
Log in and go to the group space where you want to run a search.
-
Click the Search tab to bring the Search page forward.
If the Search tab is not available, then open the Manage Pages dialog and select the Search page for display. When the tab opens, click it to bring the page forward. For more information, see Section 2.5, "Hiding, Showing, Opening, and Closing Pages."
-
In the Search task flow, enter a search term in the Search field, and click the Search button, or press Enter.
Note:
If the group space is configured to display in full screen mode, then the search field at the top-right becomes a group space search field and you can perform a group space search by entering your search term in this field.Search results display within the group space's Search page (Figure 28-5).
You can further refine the search by contributor or last modified date using the Refine Search section that also appears on the Search page. For more information, see Section 28.2.3, "Refining the Display of Search Results."
Notice that the Save button in the Search task flow is no longer greyed out, and you can save this search so that you can access the results later. For more information, see Section 28.2.4, "Saving Searches."
You can configure how the search results are displayed. Specifically, you can control which services are included in the search, the order in which those services are listed in the results, and what information is included, such as the type, size, or owner of the object returned. For information about setting display options for group space search results, see Section 3.9, "Setting Preferences for WebCenter Spaces Search Results."
28.2.3 Refining the Display of Search Results
The Search service provides a means of narrowing down your searches using refiners, which you can add to the current search to produce a smaller set of results. You can refine your search results by specifying a time range within which the result was last modified and by limiting results to those associated with a particular user.
Note:
Results from the Tags service, People Connections service, and Favorites, which do not supply refiners to the Search service, do not appear in refined searches.To refine the display of search results:
-
Perform a global search as described in Section 28.2.2.1, "Performing a Global Search," and then click the More button in the results popup window.
Or perform a group space search as described in Section 28.2.2.2, "Performing a Group Space Search."
The search results display on the Search page or in the Search window.
-
In the Refine Search section, to refine the display of search results by date, select a time-range limitation from the Last Modified Date box (Figure 28-6).
Figure 28-6 The Last Modified Date Box on the Search Results Page
Description of "Figure 28-6 The Last Modified Date Box on the Search Results Page"
For example, click Since Yesterday to view all results that originated since yesterday. Click 2006 to view all results that originated in 2006.
The number next to each time range indicates the search's best guess at how many search results fall within the specified range.
Some date selections, such as years or months, provide additional refinement options when you select them. For example, when you refine a search by all results occurring within 2007, your refined results display and additional refinements appear in the Last Modified Date box. For example, see Figure 28-7.
Alternatively, enter a date in the field provided, or click the Select Date icon and select a date from a date picker (Figure 28-8).
-
You can also refine the display of search results by contributor (that is, by the user name of the person who created, uploaded, or originated the result) by selecting a contributor from the Contributor box (Figure 28-9).
Figure 28-9 The Contributor Box on the Search Results Page
Description of "Figure 28-9 The Contributor Box on the Search Results Page"
For example, click sysadmin to view all results contributed by the user
sysadmin.The number next to each user name indicates the search's best guess at how many search results are associated with the specified user.
Alternatively, enter a user name in the field provided and click the Search icon (Figure 28-10).
Results created by the selected contributor and provided within the selected time-range display.
When a refinement is selected, it appears in the relevant box with a Remove link next to it, enabling you to remove the refinements you have applied to search results (Figure 28-11).
Figure 28-11 Remove Links on the Search Results Page
Description of "Figure 28-11 Remove Links on the Search Results Page"
Click the Remove link to remove that particular search results refinement and broaden the list of displayed results.
28.2.4 Saving Searches
After you have performed a search, you can save it so that you can run it again later without having to reenter the search terms. You can also add the saved search to other pages to make them easily available to run.
Note:
You can save searches only if you are logged in to the application.Saved searches retain their association with the context where you created them. For example, when you save a search from a particular group space, the next time you run it, the results appear on a dynamically generated Search Results subpage of that group space. When you run a global saved search in WebCenter Spaces, the results appear on a dynamically generated top-level Search Results page.
This section includes the following subsections:
28.2.4.1 Saving a Search
Saved searches are useful for the searches you run frequently. They assist in keeping you current as new information is added to the search pool.
To save a search:
-
Perform a global search as described in Section 28.2.2.1, "Performing a Global Search," and then click the More button in the results popup window.
Or perform a group space search as described in Section 28.2.2.2, "Performing a Group Space Search."
The search results display on the Search page or in the Search window.
-
Click the Save button below the search field (Figure 28-12).
The Create New Saved Search dialog opens (Figure 28-13).
-
In the Name field, enter a meaningful name for the search.
The value you enter in the Name field is the value that appears on the dropdown list of saved searches.
The search that was in the Search field is saved, no matter what name you give it. For example, if the search term was admin, but you enter jcr in the Name field. The saved search searches for the term admin and not jcr.
-
Optionally, in the Description field, enter a description of the search.
The description is rendered as a tooltip when you move your cursor over the saved search on the Saved Search dropdown list.
-
For group space searches in WebCenter Spaces, select the Share this Saved Search checkbox to enable other members of the group space to see this search on the dropdown list of saved searches.
If you want this search to be private, then clear the Share this Saved Search checkbox.
-
Click OK to save the search.
The name appears on the dropdown list of saved searches (Figure 28-14).
28.2.4.2 Running a Saved Search
You can run a saved search from several locations. The saved searches to which you have access depends on the location.
-
Go to any page containing the Search task flow (Figure 28-15).
If the Search task flow is on a group space page (including the group space's Search page), then it lists your saved searches for the group space and shared saved searches for the group space. If the Search task flow is on the global Search page, then it lists your global saved searches.
-
Click the Manage button in the Search task flow to access the Manage Saved Searches dialog (Figure 28-16).
The Manage Saved Searches dialog lists the same saved searches as listed in the Search task flow from which it was launched.
-
Go to any page containing the All Saved Searches task flow (Figure 28-17).
In a group space, the All Saved Searches task flow lists all your saved searches for the group space and all shared saved searches for the group space (made both by yourself and other users). It does not list your global saved searches or saved searches made against other group spaces. In a personal space, the All Saved Searches task flow lists all your global saved searches.
-
Go to any page where the saved search was placed (Figure 28-18).
The Saved Search task flow shows the results of the particular search.
-
Locate the Saved Searches panel in the Sidebar (Figure 28-19).
The Sidebar lists saved searches personal to you. That is, global and group space searches that you, personally, have saved. It does not list searches saved by other users and shared with you.
To run a saved search:
-
Log in and find the saved search:
-
Locate the page containing the Search task flow, for example, the group space's Search page.
-
Locate the page containing the All Saved Searches task flow.
-
Locate the page containing the saved search. In this case, the search results are immediately visible.
-
Expand the Saved Search panel in the WebCenter Spaces Sidebar.
-
-
If you are using the Search task flow, then select the search from the Saved Search drop down list.
If you are using the Manage Saved Searches dialog, the All Saved Searches task flow, or the Saved Search panel in the Sidebar, click the link for the saved search you want to run.
Tip:
The description is rendered as a tooltip when you move your cursor over the name of the saved search. -
View the results on the dynamically-generated Search Results page.
28.2.4.3 Sharing a Saved Search in WebCenter Spaces
In WebCenter Spaces, you can share a saved group space search if you think the results of a search might be useful for other group space members.
To share a saved search:
-
Log in and go to the group space where the search was performed and saved.
-
Open the Search page.
If the Search page does not display, open the Manage Pages dialog and select the Search page for display. For more information, see Section 2.5.3, "Showing Hidden Pages."
-
In the Search box, click the Manage button (Figure 28-24).
The Manage Saved Searches window opens (Figure 28-25).
-
Click the Share icon next to the saved search you want to share.
The icon changes to indicate that the saved search is now shared. The saved search is now available for other members of the group space to run. The search is listed in the Search task flow Saved Searches list for all group space members and in the All Saved Searches task flow, if one exists.
-
When you no longer want to share a saved search, click the Stop Sharing icon.
-
Click Close.
28.2.4.4 Customizing a Saved Search
After you have added a saved search to a page, you can customize it to change the search terms, add refiners, or select the services to search. The changes you make are visible to everyone. In the task flow header, click the Edit icon (Figure 28-22).
The changes you make here affect only this particular instance of the saved search. If you add the same saved search to the page or to a different page, then the original search settings still apply.
You can also personalize the saved search when you are viewing the page (rather than editing it by clicking the Personalize icon (Figure 28-23) and making your changes. The changes you make are visible only to you.
28.2.4.5 Deleting a Saved Search
When a saved search has outlived its usefulness, WebCenter provides a way to remove it.
To delete a saved search:
-
Log in and, to delete a global saved search, run the search and then click the More button in the Search Results popup window. For information about how to run a saved search, see Section 28.2.4.2, "Running a Saved Search."
To delete a group space saved search, go to Search page of the group space where the search was performed and saved.
-
In the Search task flow, click the Manage button (Figure 28-24).
The Manage Saved Searches window opens (Figure 28-25).
-
Click the Delete icon next to the saved search you want to delete.
-
Click the Close button.
28.3 Setting Search Service Task Flow Properties
The Search service task flows have associated properties, which users with sufficient privileges can access from the Component Properties dialog in Oracle Composer (Figure 28-26). Many properties are common to all task flows, and the method for accessing task flow properties is the same from task flow to task flow. Common task flow properties and how to access them are discussed in Section 10.4, "Setting Properties on Page Content."
The properties on the Parameters tab of the Component Properties dialog control the default task flow content and facilitate the wiring of the task flow to page parameters and page definition variables. These properties are unique to the task flow type. For more information, see Section 10.4.3, "Working with Component Parameters." For information about wiring pages and components, see Chapter 11, "Wiring Pages, Task Flows, Portlets, and UI Components."
Changes to the properties on the Display Options, Style, and Content Style tabs affect the appearance and behavior of the task flow for all users. These properties are common to all task flows. For more information, see Section 10.4.4, "Working with Component Display Options" and Section 10.4.7, "Working with Style and Content Style Properties."
The content of the Events tab depends on the events supported by the task flow. For more information, see Section 10.4.8, "Working with Component Contextual Events."
The Child Components tab displays all of the components contained within the current component. It provides controls for rearranging, showing, and hiding child components. Not all components contain children. So you may find this tab devoid of content. For more information, see Section 10.4.6, "Working with Child Components."
All properties on the Parameters and Display Options tabs provide access to an Expression Language (EL) editor, which you can use to select or specify a variable value instead of a constant value. Click the Edit icon next to a property field to open the editor. For more information about using the editor and for descriptions of common EL expressions, see Section 10.4.5, "Using Expression Language (EL) Expressions with Component Properties."
Table 28-1 describes the properties that are unique to the Search task flows.
Note:
The All Saved Searches task flow does not have any unique properties, and therefore no Parameters tab in the Component Properties dialog.Table 28-1 Search Service Task Flow Properties: Parameters Tab
| Property | Description | Task Flow |
|---|---|---|
|
A system-generated ID for a particular instance of the saved search on the page. This value is intended for internal use only. Do not change this value. |
Saved Search |
|
|
Either search keywords or the saved search GUID. This parameter is intended for internal use only. Do not change this value unless you want coded search main views. If you do change this value, then you must also specify |
Search |
|
|
A marker specifying whether the This value is set automatically and is for internal use only. Do not change it unless you want coded search main views. |
Search |
|
|
A system-generated ID for the saved search. This value is intended for internal use only. Do not change this value. |
Saved Search |
|
|
The keywords in the saved search are fixed. This parameter is intended for internal use only. |
Saved Search |
|
|
An object of type This parameter is intended for internal use only. |
Saved Search |
|
|
A list of IDs of services or executors to omit when displaying search results. This value is intended for internal use only. Do not change this value. |
Search |