23 Procedures for Installing Site Capture

Site Capture can be installed graphically or silently. You will first create the war file using the installer, then manually deploy the war file and test the installation.

This chapter contains the following topics:

23.1 Installation Steps

To install Site Capture, you will complete the following basic steps:

  1. Run the silent or GUI installer to create the Site Capture war file (ROOT.war).

  2. Note:

    Keep in mind the following about clustered installations and installing the sample crawlers:

    • If you are creating a clustered installation:

      Run the installer once. You will deploy the ROOT.war file (and ROOT folder) on all cluster members, as shown in this chapter. The Site Capture installation directory must be a shared directory, accessible to all other cluster members.

    • We recommend installing the sample crawlers. Procedures for quickly testing and using the Site Capture installation are based on the Sample crawler, described below.

      Sample is a basic crawler that can be easily configured to capture any dynamic site. The configuration step amounts to setting the crawler's start URI in the crawler's configuration file.

      FirstSiteII is a crawler with advanced configuration code for capturing the WebCenter Sites FirstSiteII sample website. The code demonstrates the implementation of various methods and interfaces that are used to control the crawler's site capture process, in this example, downloading a dynamic site (FirstSiteII) as a static site.

      Crawlers can be easily deleted should you no longer need them.

  3. If WebCenter Sites is running with Oracle Access Manager (OAM), integrate OAM with Site Capture.

  4. Deploy the Site Capture application.

Detailed steps are provided in the rest of this section.

23.1.1 Running the Silent Installer

Note:

If you wish to run the GUI installer instead of the silent installer, skip to Section 23.1.2, "Running the GUI Installer."

  1. Unzip the sitecapture.zip file into the desired location on the server.

  2. Configure the omii.ini file (located at the root level in the extracted folder) according to instructions provided in the file, and save the file.

    The host name and port number of both single and clustered installation must be accessible externally.

    Reminder:

    We recommend installing the sample crawlers. For information about the crawlers, see the note in step 1 in Section 23.1, "Installation Steps."

  3. Open the Install.ini file (located at the root level in the extracted folder), add the line loadfile=omii.ini to the first section, and save the file.

  4. Open a command prompt and run one of the following commands:

    • Windows: scInstall.bat -silent

    • Linux: scInstall.sh -silent

    You will see the following message in the command window after installation is successful – "Installation Finished Successfully"

  5. Wait until the installer process exits normally and shows the command prompt again. The ROOT folder and the ROOT.war file will be created in the webapps folder of the installation directory specified in the omii.ini file.

  6. Do one of the following:

23.1.2 Running the GUI Installer

Note:

If you wish to run the silent installer instead of the GUI installer, go to Section 23.1.1, "Running the Silent Installer."

  1. Download sitecapture.zip to a directory on your Site Capture server and extract it into a temporary directory. The extracted folder contains the scInstall.bat and scInstall.sh files, which are needed to run the Site Capture installer.

  2. Execute the following installer script:

  3. Specify the path to the directory where Site Capture will be installed (Figure 23-2) and click Next.

    Figure 23-2 Site Capture Installation Directory

    Description of Figure 23-2 follows
    Description of "Figure 23-2 Site Capture Installation Directory"

  4. Select the product (Site Capture) to be installed (Figure 23-3) and click Next.

    Figure 23-3 Select Products to Install

    Description of Figure 23-3 follows
    Description of "Figure 23-3 Select Products to Install"

  5. Select either Single Server or Cluster (Figure 23-4), and click Next.

    Figure 23-4 Site Capture Installation Type

    Description of Figure 23-4 follows
    Description of "Figure 23-4 Site Capture Installation Type"

  6. Enter information about the Site Capture host machine (Figure 23-5). The host name and port number of both single and clustered installation must be accessible externally.

  7. Enter information about the WebCenter Sites system on which Site Capture will run as an application (Figure 23-7):

  8. Enter the WebCenter Sites administrator's credentials (Figure 23-8):

  9. Enter information about the CAS application (Figure 23-9):

  10. Select the application server on which Site Capture will be installed (Figure 23-10).

    Note:

    The installer will create a ROOT.war file, which you will deploy on the application server.

    Figure 23-10 Application Server Information

    Description of Figure 23-10 follows
    Description of "Figure 23-10 Application Server Information"

  11. Enter database information (Figure 23-11):

    • Select the database to which Site Capture will connect (select either Site Capture's database or WebCenter Sites' database).

    • Specify the name of Site Capture's data source exactly as it is configured in the application server.

      Figure 23-11 Database Information

      Description of Figure 23-11 follows
      Description of "Figure 23-11 Database Information"

  12. Select whether to install the sample crawlers (Figure 23-12):

    Note:

    We recommend installing the sample crawlers. For information about the crawlers, see the note in step 1 in Section 23.1, "Installation Steps."

    Figure 23-12 Sample Crawler Configuration

    Description of Figure 23-12 follows
    Description of "Figure 23-12 Sample Crawler Configuration"

  13. Review the settings summary to verify the data you have entered (Figure 23-13). To edit your settings, click Previous to return to the relevant screens.

    Figure 23-13 Settings Summary

    Description of Figure 23-13 follows
    Description of "Figure 23-13 Settings Summary"

  14. Once you have confirmed your settings (Figure 23-14), click Install.

    Figure 23-14 Installation Progress

    Description of Figure 23-14 follows
    Description of "Figure 23-14 Installation Progress"

    When the installation process successfully ends (Figure 23-15), the installer displays the following message: "Site Capture war file was successfully created".

    Figure 23-15 Site Capture Installation Successful

    Description of Figure 23-15 follows
    Description of "Figure 23-15 Site Capture Installation Successful"

    The Site Capture file system was also created. The war file, called ROOT.war, is located in the <SC_INSTALL_DIR>/fw-site-capture/webapps folder. For information about the Site Capture file system, see the chapter, "Site Capture File System" in the Oracle Fusion Middleware WebCenter Sites Administrator's Guide.

  15. Do one of the following:

23.1.3 Deploying Site Capture

Note:

Consider the following:

  • For clustered installations, complete the deployment steps on each cluster member.

  • The Site Capture application must have a context root of /.

This section provides instructions for deploying the Site Capture ROOT.war file. For instructions, see one of the following sections:

23.1.3.1 Deploying on Tomcat Application Server

  1. Copy the ROOT folder in <SC_INSTALL_DIR>\fw-site-capture\webapps\ and overwrite the ROOT folder in the <apache-tomcat-6.0.29 directory>\webapps\ directory.

  2. To start Site Capture:

    1. Ensure that WebCenter Sites is running.

    2. Start the application server (run the startup.bat or startup.sh file in the <apache-tomcat-6.0.29 directory>\bin folder).

  3. Continue to Section 23.2, "Post-Installation Steps."

23.1.3.2 Deploying on WebLogic Application Server

  1. Copy the files named antlr-2.7.7.jar and commons-lang-2.5.jar in Site capture's WEB-INF\lib folder:

    <SC_INSTALL_DIR>\fw-site_capture\webapps\ROOT\WEB-INF\lib

    and paste them into the WebLogic installation path:

    <Weblogic Home>\wlserver_10.3\common\lib.

  2. Set the pre-class path in the setdomainEnv.cmd or setdomainEnv.sh file (located in <Weblogic Home>\user_projects\domains\<domain name>\bin) for the Site Capture domain.

    Below is an example of where the changes need to be made:

    • On Windows (in setdomainEnv.cmd):

      set WL_HOME=E:\<WL HOME\Weblogic\wlserver_10.3
      set PRE_CLASSPATH=%WL_HOME%\common\lib\antlr-2.7.7.jar;%WL_HOME
      %\common\lib\commons-lang-2.5.jar(in windows machine)
      for %%i in ("%WL_HOME%") do set WL_HOME=%%~fsi
      
    • On Linux (in setdomainEnv.sh):

      WL_HOME="/root/Oracle/Middleware/wlserver_10.3"
      PRE_CLASSPATH=$WL_HOME/common/lib/antlr-2.7.7.jar:
      $WL_HOME/common/lib/commons-lang-2.5.jar
      export WL_HOME
      
  3. Deploy the Site Capture application:

    1. Go to the deployment section in the console and select the path to the ROOT folder located in <SC_INSTALL_DIR>\fw-site-capture\webapps.

    2. Select the managed server as the deployment target.

  4. To start Site Capture:

    1. Ensure that WebCenter Sites is running.

    2. Start the managed server <managed_server_name>. For example:

      ./startmanagedweblogic.sh <managed_server_name>

      http://<admin_server_hostname>:<admin_server_port>/

  5. Continue to Post-Installation Steps.

23.1.3.3 Deploying on WebSphere Application Server

  1. In the WebSphere Admin interface, do the following:

    1. Go to the path Application > Application Types > WebSphere enterprise applications and select the ROOT.war file located in <SC_INSTALL_DIR>\fw-site-capture\webapps\.

    2. From the WebSphere console, navigate to Enterprise Applications > Site Capture Webapp > Class loader (Class loading and update detection) to display the classloading options. Site Capture requires default configuration for War Policy. Ensure that the Class loader for each WAR file in application option is selected under the WAR class loader policy section.

      Description of sc_ws_cl_loader.png follows
      Description of the illustration sc_ws_cl_loader.png

    3. Complete the deployment process.

  2. To start Site Capture:

    1. Ensure that WebCenter Sites is running.

    2. Start the application server.

  3. Continue to Section 23.2, "Post-Installation Steps."

23.2 Post-Installation Steps

When Site Capture is installed and the application server is started, Site Capture starts and automatically registers itself as an application enabled on AdminSite. In addition, Site Capture adds the necessary tables and records to its database, unless the database is Oracle.

To complete and verify your Site Capture installation, complete the steps in the following sections:

23.2.1 If Site Capture Is Using an Oracle Database

When Site Capture uses the Oracle database, the sql script that creates the schema must be run manually. The script, named crawler_oracle_db.sql, is available in the <SC_INSTALL_DIR>/Sql-Scripts folder.

23.2.2 Add the Site Capture URL in the customBeans.xml File

  1. In your installation, navigate to <Sites_Installation_Directory>/bin/customBeans.xml.

  2. Open the customBeans.xml file.

  3. In the bean id section, add the Site Capture URL as follows:

    <bean id="RequestParamValidator"
    class="com.fatwire.cas.web.RequestParamValidator">
         <property name="validUrls">
              <list>
                 <value>http://<Sites_Host_Name>:<Sites_Port>/<Sites_Context_root>/*</value>
                 <value>http://<Site Capture Hostname>:<SiteCapture_port>/__admin/*</value>
              </list>
         </property>
    </bean>
    
  4. Restart WebCenter Sites application servers and Site Capture servers.

23.2.3 Verifying the Site Capture Application

Ensure that the Site Capture application is available in the WEM Admin interface:

  1. Log in to WebCenter Sites as a general administrator.

  2. Navigate to AdminSite and select the WEM Admin application.

  3. In the menu bar, click Apps and verify that Site Capture is listed on the "Apps" page.

  4. Navigate to the Site Capture application, represented by the icon shown in Figure 23-16.

    Figure 23-16 Site Capture Application Icon

    Description of Figure 23-16 follows
    Description of "Figure 23-16 Site Capture Application Icon"

    The home page opens. If you chose to install the sample crawlers, they are listed on the home page as Sample and FirstSiteII (Figure 23-17).

    Figure 23-17 FirstSiteII and Sample Crawlers

    Description of Figure 23-17 follows
    Description of "Figure 23-17 FirstSiteII and Sample Crawlers"

23.2.4 Authorizing Users to Work with Site Capture

The Site Capture application is designed for WebCenter Sites general administrators and developers with general administrator rights. All such users have access to AdminSite, where the Site Capture application is registered and running. (Access is granted via the GeneralAdmin role on AdminSite and the user's membership in the RestAdmin security group. For more information about user authorization and the WEM Admin interface, see the chapter "Creating and Authorizing Users" in theOracle Fusion Middleware WebCenter Sites Administrator's Guide.

Site Capture users also require administrative access to its host machine, especially to retrieve statically captured sites and crawler logs.

23.3 Next Step