How to upgrade to DocuShare 8.0 (In-place upgrade)

How to upgrade to DocuShare 8.0 (In-place upgrade)

About This Procedure

Use this procedure to upgrade an existing DocuShare installation to DocuShare 8.0 in place. It does not cover migration to a new server. Confirm that your current version and patch level meet the supported upgrade requirements before starting.

An in-place upgrade of an IDOL-based site retains IDOL; it does not automatically replace IDOL with Solr. For a new-server migration, follow the dedicated procedure for your source version and intended search engine.

This procedure is also available in the DocuShare 8.0 Installation Guide.

Plan Your Migration to Solr

Xerox recommends that all customers running the IDOL search engine plan their migration to Solr. IDOL support is being phased out and will reach end of life in a future release.

Step-by-step KB procedures are available for upgrading supported source versions and migrating from IDOL to Solr. This is a separate, planned migration that uses a fresh Solr-based installation and requires a full reindex. Follow the procedure that matches your current DocuShare version and patch level. Contact Xerox DocuShare Support for assistance selecting the appropriate procedure or planning your migration.

Related migration procedure: How to migrate DocuShare 7 to a new DocuShare 8.0 Server on Windows.

System requirements review

Before making any DocuShare upgrades, review the system requirements for the upgrade version, and make sure your server meets those requirements. Look carefully at the operating system, database, web server, memory, and disk space requirements for the upgrade.

The paths for update from various software version include:

•   The DocuShare system must be at DS 7.6 Patch 6 at minimum or DS 7.7 Patch 1 at minimum to update the system to DocuShare 8.0.

Installation logs

The DocuShare installer records all upgrade activity and stores it in the DocuShareInstallLog.txt file.

Before you start the upgrade procedure

•   A day prior to upgrading the site, inform users that the site will be down

1.   Go to Site Management l Site Operations.

2.  In the Admin Message field, enter a message telling users when the site will be unavailable and for how long; then select Yes in the Show Admin Message field.

3.  Click Apply.

         •          Review the information required for DocuShare software installation presented in Chapter 1. Record all your current configuration settings so you can enter them in the upgrade Wizard windows.

         •          From the Administration menu, click Site Management | License. On the License page, locate and write down the Host ID number of the server.

         •          Stop all automated or programmatically generated activities; especially those that use the Content Intake Manager, Content Rules, or Scan to DocuShare services.

         •          Close site access

1.   Log into the DocuShare site as admin.

2.  Go to Site Management l Access Policies.

3.  Set the Site Access Authority to Administrator, then click Apply.

4.  Go to Site Management l Site Operations.

5.  In the Admin Message field, enter a message telling users that the site is going down in ten minutes, select Yes in the Show Admin Message field, then click Apply.

6.  After ten minutes, enter the message DocuShare is currently in read-only mode in the Admin Message field.

7.  In the System Mode field, select Read Only.

8.  In the Show Admin Message field select Yes.

9.  Click Apply.

         •          Close all Windows applications that are currently open on the server.

         •          Backup the IDOL index (if using IDOL)

1.   Make sure the target directory exists and is empty before starting backup. The target directory is represented as  <path_to_backup_directory> in the command.

2.  Open a command prompt window (Windows) or terminal window (Linux/Solaris)

3.  Change into the <dshome>\bin directory, where <dshome> is replaced with the installation directory for DocuShare. The default installation directory is C:\Xerox\Docushare. Depending on your installation environment the path may vary.

4.  Run the following command: idoltool.bat -backup  <path_to_backup_directory>, where <path to backup directory> is replaced with the path to the backup folder. For a backup folder: D:\content_backup, the command would be: idoltool.bat –s backup D:\content_backup

Note: The backup will need to be run on each content if you are running more than one content. The command line statement will need to be modified if you have more than one content.

•   Backup the SOLR index (if using SOLR)

1.  Create a Solr_bak folder in: $DSHOME\Solr\server\solr

2.  Run from browser: http://localhost:8983/solr/admin/collections?action=BACKUP&name=SolrBackUpWithURL&collection=DocuShare&location=C:\Xerox\Docushare\Solr\server\solr\Solr_bak

3.  Move the Solr_bak folder outside of $DSHOME (or outside of the DocuShare folder).

         •          Clear the event queue

1.   Go to Site Management l Site Operations.

2.  In the System Mode field, select Read Write and select No in the Show Admin Message field; then click Apply.

3.  Go to Services and Components | Subscription.

4.  Set the Weekly Notification Day to the current day of the week and set the Weekly Notification Hour and Weekly Notification Minute to five minutes from the current time; then click Apply.

5.  Wait ten minutes before proceeding with the upgrade.

This allows the DocuShare notification service to send all subscribed notifications and clear the event queue. Failure to clear the event queue before starting the upgrade results in the loss of all events waiting in the queue.

•   Stop DocuShare via Services or command line depending on your installation. You must have Windows local server administrator account.

•   Backup the site database

1.   In your database server manager, stop the database.

2.  Perform a system backup of your DocuShare site.

3.  When the backup is finished, start the database.

4.  The database must be running for the DocuShare Installer to upgrade the database schema.

5.  If you are using a Microsoft SQL Server database, run exec sp_fulltext_database enable on the server to enable full text search.

Note: It is recommended that you temporarily disable your antivirus during the installation. The software may cause issues based on the antivirus used and the settings deployed.

Start the upgrade

1.    Download the DocuShare software to a temporary directory on your server. Unzip and extract the file locally to the system.

2.   Upgrade the system by one of two ways:

•   Open the file and locate docushare.exe. Right-click docushare.exe and select Run as Administrator.

•   If you want the installer to save all configuration and upgrade data, start the upgrade in a command prompt window by entering the command line: docushare.exe -P docushareLog.cleanUp=false.

3.  Be patient; it takes several minutes before the system displays the first install Wizard screen.

4.  When the Upgrade Option window appears, select the appropriate Upgrade. Be patient; it takes several minutes for the system to load and start the installer.

5.  Follow the onscreen instructions; accept the defaults or enter your own configuration information.

Finish the upgrade

1.    When the upgrade successfully completes, click Finish to close the installer.

2.   Reboot the server.

3.  After the server restarts, if you did not set DocuShare to run as an AutoStart service, do the following:

•   In the Administrative Tool, in the Services application, select and start the DocuShare service.

4.  If the DocuShare site uses LDAP over a secure SSL channel, you need to import the SSL certificate into in $DSHOME\jdk\lib\security\cacerts. For example, in the case you use your own self-signed certificate. Instructions for importing the LDAP SSL Certificate are in the LDAP Active Directory Guide that is located on the Help page of your DocuShare site.

5.  The DocuShare Installer stops the IIS service during the upgrade and restarts it at completion. If the installer does not restart the IIS service, open the IIS console, and restart the service.

License the site

1.    Use a browser to connect to your newly upgraded site and login as admin.

2.   From the Administration menu, click Site Management | License.

3.  On the License page, locate and write down the Host ID number exactly as displayed.

4.  Follow the instructions that Xerox® DocuShare provided to obtain a site license string.

5.  When you have the license string, return to the Site Management | License page and enter the string in the License field.

Post upgrade tasks

1.    Run database optimization as defined in the DocuShare Administrator Guide database optimization procedures.

2.   Refer to the DocuShare VDF Reference Guide to migrate your custom VDFs to the current DocuShare release.

3.  If you changed the Subscription Notification settings to clear the event queue, go to the Services and Components | Subscription administration page and return the Weekly Notification Day, Hour, and Minute to their values prior to the upgrade.

4.  Go to Site Management l Access Policies.

5.  Return the Site Access Authority to the pre-upgrade setting, then click Apply.