8 Upgrading Site Capture

This chapter contains instructions for upgrading a Site Capture 1.1 or Site Capture 11gR1 (11.1.1.6.x) test environment to Site Capture 11gR1 (11.1.1.8.0), verifying the test environment, and then upgrading the active environment.

This chapter contains the following sections:

8.1 Upgrading the Test Environment

In this section, you will back up your active environment as a precaution. If you choose to create a test environment, you will do so by recovering the backup.

This section contains the following topics:

8.1.1 Backing Up Your FatWire Site Capture 1.1 or WebCenter Sites: Site Capture 11gR1 (11.1.1.6.x) Environment

  1. Review Chapter 9, "Reference: Site Capture Backup and Recovery" for guidelines and specific instructions.

  2. Back up Site Capture in the active environment, as described in Chapter 9, "Reference: Site Capture Backup and Recovery."

  3. Take note of all the information about your existing installation, such as application server configuration and database configuration. While these will not be changed during the upgrade, you might need to reference existing settings if changes are needed elsewhere.

8.1.2 Creating the Test Environment

Note:

Complete a trial upgrade on a test environment before upgrading the active environment. If a test environment is not available, then start by upgrading the active Site Capture environment and expect extended downtime. We strongly recommend using a test environment.

  1. When you are ready to create the test environment, recover the backup that you created in the previous step. Refer to Chapter 9, "Reference: Site Capture Backup and Recovery" for guidelines.

  2. Continue with the guidelines below to complete the test environment:

    1. Site Capture:

      Copy Site Capture into the same location that it occupied on its previous host.

    2. Application Server:

      1. Install the application server using the same paths that were used on the previous host.

      2. Create the data source using the same JNDI name that was used on the previous host. Use the database information for the restored database.

      3. Deploy the Site Capture application as required by your application server.

        Note:

        In the WAS environment, while deploying SiteCapture ROOT.war file, select metadata-complete = true in the deployment screen.

8.1.3 Upgrading Site Capture Instances to Version 11gR1 (11.1.1.8.0)

In this section, you will run the Site Capture 11gR1 (11.1.1.8.0) upgrade installer in the preferred manner (interactive or silent) on each instance of Site Capture 1.1 or Site Capture 11gR1 (11.1.1.6.x).

  • Interactive Upgrade can be used on environments where the X11-like GUI is available.

  • Silent Upgrade can be used on environments where the command prompt is available.

8.1.3.1 Interactive Upgrade

  1. Extract the Site Capture installer archive into a temporary directory and run the installer script:

    • On Windows:   scinstall.bat

    • On UNIX:      /scInstall.sh

    Note:

    Monitor the installer log (install_log.log) during post-upgrade testing. If an error occurs, you can trace its source by reviewing the logs.

    As you proceed through the upgrade, bear in mind the following:

    • Most fields in the installer will be pre-populated with values that the installer detected from your original installation. Check the pre-populated values. If they are outdated, you will need to supply the current values. (Information such as passwords, you will have to enter manually.)

    • Fields whose values you are not permitted to change will be disabled (grayed out).

  2. Proceed to the Oracle Fusion Middleware WebCenter Sites Installation Guide for the Site Capture Application and follow instructions for installing Site Capture. Once the installation is completed, return to this guide and continue.

    Note:

    At this point, it is assumed that the upgrade of Site Capture has been completed and you have a valid Site Capture installation running. If the upgrade failed, review the previous steps and the logs and resolve any issues.

  3. 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.

  4. If you update the Site Capture host name/port number, delete SiteCapture FW_Application and SiteCapture FW_View from AdminSite.

  5. The only way to customize Site Capture is through Java code, which can be incorporated into the Site Capture web application in the form of class/jar files. No other files must be manually configured. Once the upgrade is complete, all changes must be manually preserved in the installer-generated war file. Refer to Section 8.3, "Upgrading Custom Implementations and Integrating with the Publishing System."

  6. Deploy the Site Capture ROOT.war file on the applicable application server.

  7. In the custombeans.xml file located in <Sites_install>/bin directory, add the following sample URL for the Site Capture to work with WebCenter Sites. If this is not added, then the Site Capture Application icon is not displayed in the Sites interface.

    <value>http://<<hostname>>:<<port>>/__admin/*</value>
    

8.1.3.2 Silent Upgrade

  1. Copy the omii.ini file from /fw-site-capture/ominstallinfo to a folder outside and rename the copy as desired. The silent installer will use this copy during the upgrade.

  2. Open the desired omii.ini file.

  3. Search for the isAlreadyInstalled property.

  4. Set the isAlreadyInstalled property to true for upgrade silent installation.

  5. Search for the CSInstallAccountPassword property.

  6. Provide the unencrypted password for the CSInstallAccountPassword property.

  7. Save the property file.

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

  9. 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".

  10. Proceed to the Oracle Fusion Middleware WebCenter Sites Installation Guide and follow instructions for installing Site Capture. Once the installation is completed, return to this guide and continue.

  11. 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.

  12. If you update the Site Capture host name and port number, delete the SiteCapture FW_Application and SiteCapture FW_View assets from AdminSite.

  13. The only way to customize Site Capture is through Java code, which can be incorporated into the Site Capture web application in the form of class/jar files. No other files must be manually configured. Once the upgrade is complete, all changes must be manually preserved in the installer-generated war file. Refer to Section 8.3, "Upgrading Custom Implementations and Integrating with the Publishing System."

  14. Deploy the Site Capture ROOT.war file on the applicable application server.

  15. In the custombeans.xml file located in <Sites_install>/bin directory, add the following sample URL for the Site Capture to work with WebCenter Sites. If this is not added, then the Site Capture Application icon is not displayed in the Sites interface.

    <value>http://<<hostname>>:<<port>>/__admin/*</value>
    

8.1.4 Verifying the Upgraded Environment

If you have a cluster, begin with the primary cluster member, then test each secondary cluster member. Finally, test the cluster via the load balancer.

Complete the following steps on each Site Capture instance in the upgraded environment:

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

  2. Go to the Site Capture application.

  3. Test the Site Capture application and all functions that are routinely used during normal operations.

  4. When the environment is verified, do one of the following:

    • If you upgraded the test environment, continue to Section 8.2, "Upgrading the Active Environment."

    • If you upgraded the active environment:

      1. Enable the publishing schedules.

      2. Enable any events.

      3. Back up the upgraded environment.

      4. Clear Client Browser caches (as existing cached content may cause issues).

      5. Resume work.

Note:

You must verify if passwords are encrypted accurately in the omii.ini file.

8.2 Upgrading the Active Environment

The following steps apply if you upgraded the test environment:

  1. Having verified the test environment, you will now upgrade the active environment. Assuming the active environment continued to operate during the trial upgrade, upgrade the active environment by referring to the previous steps in this chapter and any notes that you may have created during the trial upgrade.

  2. Verify the upgraded environment, as described in Section 8.1, "Upgrading the Test Environment."

  3. Resume work.

8.3 Upgrading Custom Implementations and Integrating with the Publishing System

This section contains the following topics:

8.3.1 Custom Implementations

Site Capture supports custom implementations such as ResourceRewriter and LinkExtractor, so that websites can be crawled according to desired URL patterns. Developers can customize a crawler with these customized implementations and create the required class/jar files. In upgrade scenarios, you must preserve and redeploy custom class/jar files in the latest application war files before starting the application.

8.3.2 Integrating with the Publishing System

In this section you will integrate Site Capture with the WebCenter Sites RealTime publishing process:

  1. On the WebCenter Sites source system:

    1. Do one of the following:

      • For upgrade from Site Capture 11gR1 (11.1.1.6.0):

        Replace the fw-crawler-publish-listener-11.1.1.6.0.jar with fw-crawler-publish-listener-11.1.1.8.0.jar to the /WEB-INF/lib folder.

      • For upgrade from Site Capture 1.1:

        Replace the fw-crawler-publish-listener-1.1.jar with fw-crawler-publish-listener-11.1.1.8.0.jar to the /WEB-INF/lib folder.

      • For upgrade from Site Capture 11gR1 (11.1.1.6.1) Bundled Patch 1:

        Replace fw-crawler-publish-listener-11.1.1.6.1.jar with fw-crawler-publish-listener-11.1.1.8.0.jar to the /WEB-INF/lib folder.

    2. Unzip the fw-crawler-publish-listener-11.1.1.8.0-elements.zip file and re-import FW_PublishingEventRegistry.html using CatalogMover.

    3. Restart the WebCenter Sites source system.

  2. On the WebCenter Sites target system:

    1. Using CatalogMover, re-import ElementCatalog.html and SiteCatalog.html from the unzipped fw-crawler-publish-listener-11.1.1.8.0-elements.zip file extracted in step 1 above (on the WebCenter Sites source system).

    2. There is no need to copy the crawler.properties file (keep the existing file as is). If you update the Site Capture host name/port number, update the crawler.properties file accordingly.

    3. Do one of the following:

      • For upgrade from Site Capture 11gR1 (11.1.1.6.0):

        Replace the fw-crawler-publish-listener-11.1.1.6.0.jar with fw-crawler-publish-listener-11.1.1.8.0.jar file to the /WEB-INF/lib folder.

      • For upgrade from Site Capture 1.1:

        Replace the fw-crawler-publish-listener-1.1.jar with fw-crawler-publish-listener-11.1.1.8.0.jar file to the /WEB-INF/lib folder.

      • For upgrade from Site Capture 11gR1 Bundled Patch 1:

        Replace the fw-crawler-publish-listener-11.1.1.6.1.jar file with fw-crawler-publish-listener-11.1.1.8.0.jar file to the /WEB-INF/lib folder.

    4. Restart the WebCenter Sites target system.