After coding your crawler as explained on the previous pages, you must deploy your code and configure the necessary objects in the portal.
The deployment process is different for Java and .NET. The deployment process is different for Java and .NET. This page summarizes the deployment process for search services. For detailed information on deployment, see Deploying Web Services.
Follow the instructions below to deploy Java crawlers.
Compile the class that implements the EDK interface and copy the entire package structure to the appropriate location in your Web application (usually the \WEB-INF\classes directory).
Update the web.xml file in the WEB-INF directory by adding the class to the appropriate *Impl keys. For example, for a crawler, add your class to SearchImpl as shown below.
...
<env-entry>
<env-entry-name>SearchImpl</env-entry-name>
<env-entry-value>com.plumtree.remote.search.helloworld.Search</env-entry-value>
<env-entry-type>java.lang.String</env-entry-type>
</env-entry>
...
Note:The *Impl key in the web.xml file must reference the fully-qualified name of the class. If the service uses SCI, you must also enter the fully-qualified name of the appropriate implementation of the IAdminEditor interface.
Start your application server. (In most cases, you must restart your application server after copying a file.)
Test the directory by
opening the following page in a Web browser: http://<hostname:port>/edk/services/<servicetype>ProviderSoapBinding
(e.g.,
http://localhost:8080/edk/SearchSoapBinding. The browser should display
the following message: "Hi there, this is an AXIS service! Perhaps
there will be a form for invoking the service here..."
Configure the new service in the portal:
Open the portal in a browser and navigate to the Administration folder where you want the new service to be stored.
Click Create Object... and choose the appropriate Web Service type from the menu.
On the Main Page of the Web Service Editor, enter the service provider URL from Step 4. For SCI pages, enter the Service Configuration page URL(s) on the Advanced URLs page of the Web Service Editor. (URLs are relative to the Remote Server.)
Add a line to the deployment file (web.config) that specifies the fully qualified name of the class used to implement the search service (see Creating Custom Search Services). For search service, you must enter values for these parameters, as shown in the code that follows:
SearchImpl
SearchAssembly
|
|
In addition, you must deploy SCI if it is used by your search service.
To register a search service in the portal, you must create the following administrative objects:
Remote Server (optional): Multiple services can share a single Remote Server object.Search services can use a Remote Server object or hard-coded URLs. If you will be using a Remote Server object, you must register it before registering any related Web Service objects.
Web Service - Search: All remote search services require an associated Search Web Service. The Search Web Service editor allows you to specify basic configuration settings, including the search URL and Preference page URLs. (For details on key settings, see Settings and Preferences below.) Incoming searches and Snapshot Queries are not covered in this guide; for more information, see the Portal Administrator’s Guide or the portal online help.
Federated Search - Outgoing: All Search Web Service objects must have one or more associated Federated Search objects. The Federated Search editor can include Service Configuration pages created for the search service (entered on the Advanced URLs page of the Search Web Service editor). Multiple Federated Search objects can use the same Search Web Service object. The Federated Search editor also includes portal-to-portal settings on the main page. Portal-to-portal search is not addressed in this guide; for more information, see the Portal Administrator’s Guide or the portal online help.
For more details on portal objects, see the Portal Administrator's Guide and the portal online help.
As noted earlier, User Preferences and User Information can be used to authenticate with the back-end system or limit access to specific users. The User Preferences that should be sent to the crawler or DocFetch servlet must be configured on the Preferences page in the Search Web Service editor. List the unique names of all User Preferences (User settings) that should be sent.
The User Information settings that should be sent to DocFetch must be configured on the User Information page in the Search Web Service editor. Choose all User Information settings that should be sent to the search service. Standard settings are displayed in the top pane; add any additional User Information settings by typing them in the textbox or clicking Add Existing User Info.
If there are administrative settings to be configured that apply to all instances of the search service, add a Service Configuration page (see Advanced URLs below).
The following settings are configured on the Advanced Settings page of the Search Web Service editor.
Send Locale: The user’s locale can be used to localize search results.
Send Timezone: The user’s timezone is used to localize the search interface.
Send Login Token: Select this option to send a login token to the remote server. A login token is required to access to portal functionality via the Plumtree Remote Client (PRC). Configure the Login Token duration or leave the default of 5 minutes.
SOAP Encoding Style: Specify how information from the service is encoded. Choose RPC/Encoded if the service is written in Java. Choose Document/Literal if the service is written in .NET.
If there are administrative settings to be configured that apply to all instances of the search service (e.g., path and credentials to access a remote server), add a Service Configuration page. The Service Configuration page URL entered on the Advanced URLs page of the Search Web Service editor will be included as a page in the associated Federated Search editor.