1.1 Portal Search Install & Configuration Overview
To support Portal Search in a clustered environment, you must install and configure search for remote search service on an IBM WebSphere Application Server node that is not part of the IBM WebSphere Portal cluster.
Complete the following steps to install and configure the search service to work remotely. Place the search service on a remote WebSphere Application Server node which is not part of the cluster. Remote search service will be provided as an EJB web service. Deploy the appropriate EJB EAR file on the remote WebSphere Application Server node.
• Install WebSphere Application Server on a remote node
• Prepare the remote search service
• Configure the remote search service
• Configure the search portlets for remote search service so that they access the remote server accordingly.
If you have configured a remote search service for a portal cluster, you need to configure the default location for search collections to a directory on the remote server that has write access.
The portal site default search collection is created only once at the first time when an administrator selects the search administration portlet Manage Search. If this occurred before you configure the portlet for remote search, then the default portal site search collection is only available on the primary node of the cluster, but not on the remote server. In this case you need to re-create the portal site collection to make it available for search on all nodes of the cluster.
This document covers all the installations using the silent method of installation on a Unix box, so no GUI is needed on those boxes.
1.2 Install WebSphere Application Server on a remote node
1.2.1 Install IBM Installation Manager
WebSphere Application Server product installation will be achieved using IBM Installation Manager. So before installing WebSphere Application Server on a remote node, IBM Installation Manager needs to be installed first.
Copy the attached response file (IIM-reponse.xml) to the remote node that will be used to install IBM Installation Manager in a silent mode. Edit this response file to make the changes as per your requirement.
Execute the following command to begin the installation of IBM Installation Manager silently.
/setup/IIM/linux_x86/installc -acceptLicense input IIM-response.xml
When this command completed, you have successfully installed IBM Installation Manager.
1.2.2 Install WebSphere Application Server
Copy the attached response file (WAS-response.xml) to the remote node that will be used to install WebSphere Application Server in a silent mode. Edit this response file to make the changes as per your requirement.
Execute the following command to begin the installation of Application Server binaries silently.
/opt/IBM/InstallationManager/eclipse/tools/imcl -acceptLicense input WAS-response.xml
Verify that there no error messages while running the above command and make sure that it completed successfully. At this point, you have successfully installed Application Server binaries. However no profile has been created yet.
To create a profile, execute the following command,
/opt/IBM/WebSphere/AppServer/bin/manageprofiles.sh -create -templatePath /opt/IBM/WebSphere/AppServer/profileTemplates/default/ -hostname -profileName -profilePath /opt/IBM/WebSphere/Profiles/ -enableAdminSecurity true -adminUserName -adminPassword
/opt/IBM/WebSphere/AppServer/bin/manageprofiles.sh -create -templatePath /opt/IBM/WebSphere/AppServer/profileTemplates/default/ -hostname myhost.mycompany.com -profileName searchProfile -profilePath /opt/IBM/WebSphere/Profiles/searchProfile -enableAdminSecurity true -adminUserName wsadmin -adminPassword admin123
After the successful installation, you should see the following output;
INSTCONFSUCCESS: Success: Profile searchProfile now exists. Please consult /opt/IBM/WebSphere/Profiles/searchProfile/logs/AboutThisProfile.txt for more information about this profile.
Run this command to start the server
Open the /opt/IBM/WebSphere/Profiles/searchProfile/logs/AboutThisProfile.txt and note down the administrative console port. Also note down the SOAP port that you will need to configure security. Verify that you can access the server by logging into administrative console.
At this point, you have successfully completed the installation of WebSphere Application Server on a remote node that will be utilized to configure the remote search service for WebSphere Portal.
Before going further, you must also configure this WebSphere Application Server instance with the same security as the security setup configured for the WebSphere Portal instance.
1.3 Configure Remote Search Server
You need to deploy the remote search applications on the WebSphere Application Server instance that you just installed. These applications then need to be configured so that they can be used for remote search.
1.3.1 Install Remote Document Conversion Service (DCS)
Perform these steps on the Remote Search server where WebSphere Application Server has been installed.
Copy remotedcs.zip (this file is in the Portal installation under Components/dcs) from the WebSphere Portal node to the directory was_profile_root/installableApps on the remote search server machine on which you want to install the remote search service.
Unzip the remotedcs.zip file
Follow these steps to install dcs.war
a. Log in to the WebSphere Integrated Solutions Console.
b. Select Applications -> WebSphere Enterprise Application -> Install New Application.
c. Browse and select /opt/IBM/WebSphere/Profiles/searchProfile/installableApps/dcs/dcs.war.
d. Specify dcs as the context root and click Next.
e. Leave all other values as default.
Restriction: The application name must be dcs_war. Do not change the default name.
f. Map the application to the server1 and specify the installation options as required.
g. Click Finish and save your changes to the master configuration.
4. Ensure dcs.war is running.
a. Log in to the WebSphere Integrated Solutions Console.
b. Select Applications -> Enterprise Applications.
c. Locate dcs_war in the list of installed applications.
d. Select dcs_war and click Start if the application is not started.
Run the configuration script to configure DCS service
When prompted, specify the WebSphere Application Server installation directory; /opt/IBM/WebSphere/AppServer
When prompted for the profile, specify the directory profile is installed; /opt/IBM/WebSphere/Profiles/searchProfile
When prompted for the cell name, specify the cell name where dcs.war is installed;
The configuration script copies all the required files to new directory named oiexport in the directory where you installed dcs.war
Add the oiexport directory to the library path variable by following these steps
and add this line
Save this file.
Restart the server by executing these commands
/opt/IBM/WebSphere/Profiles/searchProfile/bin/stopServer.sh server1 -user wsadmin -password wsadmin
1.3.2 Configure Remote Document Conversion Service (DCS)
Perform these steps on the WebSphere Portal node. Select primary node if configured as cluster.
Edit the /opt/IBM/WebSphere/Profiles/wp_profile/ConfigEngine/properties/wkplc.properties and add the following property name and value, this property does not exist already.
Run the following command to delegate document conversion services to the remote search server
Restart WebSphere Portal.
NOTE: For using DCS on Linux 64 bit environment, make sure the following required operating system libraries are installed in the running OS. Current version of DCS is 32 bit based code and these libraries are required for Linux 64-bit environment to run the 32 bit code.
1.3.3 Install Remote Search Service
If SSL is required between WebSphere Portal and remote WebSphere Application Server node, add the signer certification of the remote search service server into the portal server. To do this, proceed by the following steps:
a. On the WebSphere Portal, Login to the Admin Console.
b. Click Security -> SSL certificate and key management -> Key stores and certificates -> CellDefaultTrustStore -> Signer certificates -> Retrieve from port.
c. Enter the remote search service server host, its SOAP port and an alias.
d. Click Retrieve Signer information -> OK -.> Save.
Perform following steps on the Remote Search server where WebSphere Application Server has been installed.
1. Copy the files WebScannerEjbEar.ear and PseLibs.zip from the WebSphere Portal box to the directory was_profile_root/installableApps on the remote search server machine on which you want to install the remote search service.
2. Follow these steps to install the WebScannerEjbEar.ear file
a. Access the WebSphere Integrated Solutions Console.
b. Click Applications -> WebSphere Enterprise Application -> Install New Application
c. Browse and select /opt/IBM/WebSphere/Profiles/searchProfile/installableApps/WebScannerEjbEar.ear
d. Click Next.
e. On the following panels, accept the default settings.
f. A message confirms that the application PSEStandalone (for EJB) was installed successfully.
g. Click Save to Master Configuration.
h. Click Save.
3. Configure the shared libraries
unzip /opt/IBM/WebSphere/Profiles/searchProfile/installableApps/PseLibs.zip -d /opt/IBM/lib/search
Login to the Admin console
Click Environment -> Shared Libraries -> Select Cell scope -> New
Name = PSE
Description = Portal Search library
Classpath = /apps/IBM/lib/search/lib/
Note: The list of class-path entries must be separated by a new line and without any : or ;.
Check the option ‘Use an isolated class loader for this shared library’ in class loading.
Click OK -> Save.
Add a reference from the application WebScannerEJbEar.ear to the shared library. To do this, proceed as follows:
Login to the Admin Console.
Navigate to Applications -> Application Types -.> WebSphere enterprise applications -> PSEStandalone -> Shared library references.
On the window that opens up click the checkbox for PSEStandalone, then click the button Reference shared library
From the Available list select PSE.
Click the appropriate arrow so that PSE appears in the selected list.
Click OK -> OK -> Save.
Restart the application PSEStandalone.
4. Determine the required values for configuring the portlet parameters by following these steps.
Login to the Admin Console,
Determine the required values for configuring the portlet parameters, depending on whether you are using EJB or web service via SOAP:
For EJB: Determine the value for the port under Servers -> Server Types -> Application Servers -> server1 -> Communications -> Ports -> BOOTSTRAP_ADDRESS.
5. Create a new work manager
Login to the Admin Console,
Navigate to Resources -> Asynchronous beans -> Work managers -> Select cell as scope -> New to create a new Work manager
JNDI Name: wps/searchIndexWM
Minimum Number of Threads: 20
Maximum number of Threads: 60
Growable = True (Ensure that the Growable check box is selected.)
Service Names: Application Profiling Service, WorkArea, Security, Internationalization
Click OK -> Save.
6. Restart the application by navigating to Applications -> Application Types -> WebSphere enterprise applications -> PSEStandalone -> Click the check box and click Start.
7. Set the Search user id using the following steps;
a. Open the WebSphere Integrated Solutions Console.
b. Click Applications -> Application Types -> WebSphere enterprise applications.
c. Locate the application PSEStandalone.
d. Enter this application and click Security roles to user/group mapping.
e. Select the role SearchUser and click Map users.
f. On the portal that accesses the EJB, search for the user ID that is set as the WebSphere Application Server Admin User. For example, you can find this ID by using the following procedure:
a. Open the WebSphere Integrated Solutions Console of WebSphere Portal.
b. Click Global Security -> Federated Repositories.
c. Determine the primary administrative user ID.
g. Return to the WebSphere Integrated Solutions Console of the remote Search server.
h. Type the name that you found as the user ID in a previous step as the search string and click Search. As a result, the user ID and its configuration parameters are displayed in the Available box.
i. Add this user ID to the Selected box by clicking the double-angled bracket
j. Click OK to save your updates.
8. Restart the WebSphere Application Server on Remote Search Server.
9. Perform this step on the WebSphere portal server, enable CSIv2 identity assertion on the outbound connections. To do this, proceed as follows:
a. Login to the Deployment Manger Admin Console.
b. Navigate to Security -> Global Security -> RMI/IIOP security -> CSIv2 outbound communications.
c. Check Use identity assertion.
d. Restart the portal cluster.
10. Perform this step on the remote Search server, enable CSIv2 Identity Assertion on the inbound connection. To do this, proceed as follows:
a. Access the WebSphere Integrated Solutions Console of the remote server.
b. Navigate to Security -> Global Security -> RMI/IIOP security -> CSIv2 inbound communications.
c. Check Use identity assertion.
d. Under Trusted identities, enter either an asterisk (*) or the identity of the portal server.
e. Restart the remote search server.
11. If you are planning to use seedlist search service, then you need to follow this step. The Seedlist servlet requires HTTPs by default. Perform this step on the primary and all secondary WebSphere Portal nodes.
a. Edit the file /opt/IBM/WebSphere/PortalServer/search/wp.search.servlets/seedlist/servletEAR/installableApps/wp.search.seedlist.ear/wp.search.servlets.seedlist.war/WEB-INF/web.xml
b. Search for the text lines below
And replace by the following text
12. Run the following task only on the primary portal node. Before you run the task, make sure that you have provided correct wsadmin user, wsadmin password in the wkplc.properties file.
13. Update the search administrator user id by following these steps.
a. Login to the Deployment Manager Admin console.
b. Navigate to Security -> Global Security -> Java Authentication and Authorization Service -> J2C Authentication data.
c. Edit the SearchAdminUser alias.
d. Update the user ID and/or password to match the WebSphere Portal administrator information.
14. Restart all servers.
15. Perform the following steps to setup the single sign on remote search server.
a. Login to the Deployment manager admin console of the Portal cluster
b. Navigate to Security -> Global Security -> Under Authentication, select LTPA
c. Provide the fully qualified key file name and click the Export keys button. The keys are written to the file /opt/IBM/WebSphere/Profiles/DmgrWP/Key File Name.
d. Login to Search Server admin console.
e. Navigate to Security -> Global Security -> Under Authentication, select LTPA
f. Provide the fully qualified key file name and click the Import keys button.
g. Click Save and Apply.
i. Restart the Search Server.
j. Perform these steps both on Deployment manager admin console and search server admin console. Navigate to Security -> Global Security -> Under Authentication, select LTPA -> Key set groups -> NodeLTPAKeySetGroup -> disable the Automatically generate keys -> OK -> Save.
Restart the servers.
1.4 Configure Remote Search Service for Portal Search
To configure a remote search service for Portal Search, perform these steps as follows:
1. Log in to WebSphere portal as an administrator.
2. Navigate to Administration -> Search Administration -> Manage Search -> Search Services ->
Click New Search Service.
3. Type Remote PSE service EJB for the service name.
4. For the Search service implementation select Portal Search Service Type.
5. To configure for remote search service via EJB, make the following modifications
a. Edit the search service parameter PSE_Type
and change its value to ejb
b. Set the parameter IIOP_URL
is the fully qualified name of the remote search server and port
is the port number that you obtained in the Install Remote Search Service
. For example, this can be iiop://ejb_server.your_company.com:2809
c. Set the parameter EJB
6. Set the parameter DefaultCollectionsDirectory to the portal search service.
Use it to determine the default directory where your search collections are created on the server that hosts the remote search service. This parameter does not have a default value.
7. Add the parameter CONFIG_FOLDER_PATH to the portal search service.
Use it to determine where the configuration data for search collections is stored on the server that hosts the remote search service. The default is /opt/IBM/WebSphere/Profiles/wp_profile/CollectionsConfig.
8. Click OK to save the new search service.
9. Restart all servers in your configuration for your changes to take effect.
Name= Remote PSE service EJB
Search service implementation= Portal Search Service Type
The Remote search service is configured and ready to use with Portal.
Note: In order to use Remote Search Service with other authenticated users you have to complete the following:
Add the new user to the Portal Server and the wpsadmins group.
Add the new user to the Remote search service. It is important that you use the same name for both steps 1 and 2.
Restart the servers.
1.5 Create and Configure Search Collections
Once Remote Search service is configured, you need to create Search collection to use the remote search functionality into your portal. Perform these steps on the Primary Portal.
1. Login to the Primary Portal node using the portal admin user.
2. Navigate to Search Administration -> Manage Search -> Search Collections.
3. Click on New Collection, Select “Remote PSE Search Service” in the Search Service field and provide the following values in the form field
Name of Collection=My_collection
Location of Collection=/search/collections/My_collection
Description of Collection=collection used for test
Specify Collection Language=English (US)
Select Summarizer=Automatic (# depending upon whethere you want summarizer or not)
4. Press OK to save the collection.
Content Source Name=WCM Seedlist
5. Click the Collection name from the list of collections
6. If planning to use seedlist search for source type, Click on ‘New Content Source’ and select Content Source Type as ‘Seedlist provider’.
7. On the General Parameters tab, provide the values as below,
Collect documents linked from this URL=http://:/wps/seedlist/myserver?SeedlistId=&Source=com.ibm.workplace.wcm.plugins.seedlist.retriever.WCMRetrieverFactory&Action=GetDocuments
Stop fetching a document after (sec)=1800
6. If planning to use website for source type, Click on ‘New Content Source’ and select Content Source Type as ‘Web site’.
7. On the General Parameters tab, provide the values as below, note the values differ based on your requirements, these values are for demonstration purpose only
Content Source Name=Web Pages Only
Collect documents linked from this URL=http(s)://:/wps/portal
Stop fetching a document after (sec)=1800
Stop fetching a document after (sec)=300
Levels of links to follow:=5
Number of documents to collect=100,000
Stop collecting after (min)=300
Stop fetching a document after (sec)=120
Links expire after (days)=Unlimited
8. On the Advanced Parameters tab, provide the values as below,
Number of parallel processes=5
Default character encoding= UTF-8
If using Robots.txt, check this checkbox.
Leave everything as default.
9. On the Schedulers tab, select a schedule and click on Add.
10. On the Fitlers tab, specify the filters based on what you want to filter out in your seach results.
11. for seedlist, On the Security tab, provide the values as below and click Create button.
12. Press Save to save the content source.
13. Create a new or use the default search scope for the Portal search.
14. Start crawl now or wait until the shceduled crawl has finished.