Adding third-party search options to the search control
You can extend the search control in HCL Connections to include options from third-party search engines by configuring settings in the LotusConnections-config.xml file.
Before you begin
About this task
Procedure
To add a third-party option to the HCL Connections search control, complete the
following steps.
- Use the wsadmin client to access and check out the HCL Connections configuration files.
- Navigate to the temporary working directory that you specified in the previous step, and then open the LotusConnections-config.xml file in a text editor.
- Define the additional search option as a child element
of the serviceName="search" element by adding a <sloc:searchScope>
element that contains the details of the third-party service.
For example:
where:<sloc:serviceReference bootstrapHost="" bootstrapPort="" clusterName="cluster" enabled="true" serviceName="search" ssl_enabled="true"> <sloc:href> <sloc:hrefPathPrefix>/search</sloc:hrefPathPrefix> <sloc:static href="http://myserver.example.com:9081" ssl_href="https://myserver.example.com:9444"/> <sloc:interService href="https://myserver:9444"/> </sloc:href> <!-- Add third Party Search Options here --> <sloc:searchScope scopeName="Yahoo" enabled="true" isGlobal="true"> <sloc:searchApplicationURL> <sloc:static href="http://search.yahoo.com/search?q=" ssl_href="http://search.yahoo.com/search?q="/> </sloc:searchApplicationURL> <sloc:searchScopeIconClass>lconnSprite lconnSprite-iconThirdParty16</sloc:searchScopeIconClass> </sloc:searchScope> <!-- Third party Search options added--> </sloc:serviceReference>
- <sloc:searchApplicationURL> defines the URL to the third-party
search application. When a user selects the third-party search engine
from the Search menu and enters a search term, that search query term
is appended to this URL.
Ensure that the URL that you define will use the search query terms that are passed to the URL. Pointing to a base URL, such as www.yahoo.com, does not work. Refer to the external documentation for the third-party search engine to find the correct URL to use. For example, the correct URL for searching using the Yahoo search engine is "http://search.yahoo.com/search?q=".
- <sloc:searchScopeIconClass> specifies the CSS class for an
icon that identifies the third-party search option in the Search drop-down
menu. The value of
<sloc:searchScopeIconClass>
must always be set to lconnSprite lconnSprite-iconThirdParty16.
- To point to a Search option that is locally available on the same
URL as the HCL Connections server,
use the <sloc:hrefPathPrefix> tag instead of the <sloc:href>
tag.For example:
<sloc:searchScope scopeName="myPlaces" enabled="true" isGlobal="false"> <sloc:searchApplicationURL> <sloc:hrefPathPrefix>places?scope=myPlaces&query=</sloc:hrefPathPrefix> </sloc:searchApplicationURL> <sloc:searchScopeIconClass>lconnSprite lconnSprite-iconThirdParty16</sloc:searchScopeIconClass> </sloc:searchScope>
Note: In this case the isGlobal parameter is set to false because the example is for a local search.
- <sloc:searchApplicationURL> defines the URL to the third-party
search application. When a user selects the third-party search engine
from the Search menu and enters a search term, that search query term
is appended to this URL.
- Save your changes and then close the LotusConnections-config.xml file.
- After making changes, you must check the configuration files back in, and you must do so during the same wsadmin session in which you checked them out for the changes to take effect. See Applying common configuration property changes for information about how to apply your changes.