Note: This applies to DocuShare 6.6.1 Only.
This upgrade procedure should be used when moving from a 32-bit Operating System with 32-bit DocuShare JVM’s and IDOL to a 64-bit Operating system using 64-bit JVMs and IDOL.
Prerequisite
· The DocuShare version must be 5.0.3 or higher.
Note: If you are running an older version of DocuShare contact DocuShare Technical Support at 1-800-835-9013 to discuss recommended the upgrade path for your environment.
Before you start the upgrade procedure
· Verify the bucket structure:
Warning: This step is very important, please verify all the information below before proceeding with the backup and restore procedures. You must verify the bucket structure before starting DocuShare for the first time.
From the Old DocuShare Server,
a. Open Windows Explorer.
b. Navigate the folder structure into the <dshome>\config directory.
c. Where <dshome> is replaced with the installation directory for DocuShare. Depending on your installation environment the path may vary. The default installation path is C:\Xerox\Docushare.
d. Open the ContentStore.properties file a text editor such as Notepad.
e. Look for an entry in the file called NumberOfDirectories= it will have a value of 64 or 512, this is very important, make a note of this value.
From the New DocuShare Server,
a. Stop DocuShare.
b. Open Windows Explorer.
c. Navigate the folder structure into the <dshome>\config directory.
d. Make a copy of the ContentStore.properties file and rename the copy ContentStore.properties.orig.
e. Open the ContentStore.properties file in a text editor such as Notepad.
f. Look for an entry in the file called NumberOfDirectories= edit this value to match the value that was on your old server.
g. Save the changes to the file.
h. Copy the <dshome>\config\ContentStore.xml and rename the copy ContentStore.xml.orig.
i. Open the <dshome>\config\ContentStore.xml file in a text editor.
j. Search for the <NumberOfBuckets> entry and match the value that was on your old server.
k. Save the changes to the file.
l. Start DocuShare.
· Review the information required for DocuShare software installation presented in Chapter 1 of the Install Guide.
a. Record all your current configuration settings so you can enter them in the upgrade Wizard windows.
b. From the Administration menu, click Site Management | License. On the License page, locate and write down the Host ID number of the server.
· Clear the event queue
a. Go to Site Management l Site Operations.
b. Go to Services and Components | Subscription.
c. 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.
d. Wait ten minutes before proceeding with the upgrade.
e. 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 all automated or programmatically generated activities; especially those that use the Content Intake Manager, Content Rules, or Scan to DocuShare services.
· Backup the IDOL database
Note: Backup of the IDOL database only applies to sites that are currently running DocuShare 6.5.x or higher.
a. Make sure the target directory exists and is empty before starting backup. The target directory is represented as <exportdir> in the command.
b. Run the command idoltool.bat -s export <exportdir>.
· Backup the DocuShare Database and the Documents directory
Warning: The backup of the database files and the documents directory must be done at the same time so that the information contained is in sync, otherwise there will be inconsistencies between the documents and the database information. To prevent inconsistencies between the documents and the database, you will need to stop DocuShare or place DocuShare in Read Only mode so that no new data is written during the backup period.
o Backup the site database
a. In your database server manager, stop the database.
b. Perform a system backup of your DocuShare site.
Note: The default DocuShare database files in SQL are called docushare.mdf and docushare_log.ldf.
c. When the backup is finished, start the database.
d. The database must be running for the DocuShare Installer to upgrade the database schema.
o Backup the Content (documents directory)
Note: The location of the documents directory may vary depending on your installation environment. The location of the documents directory in your environment can be found in Admin Home | Site Management | Directory Paths | Document Repository.
Upgrading to DocuShare 6.6.1
Note: If you are running DocuShare 6.0.x or a legacy version and using MSDE for the database, you will need to upgrade to version 6.6.1 Build 801 or 6.6.1 Build 257 R2 and later using SQL Express 2010. For detailed information click the Upgrade / migration fails from version 6.0.x or older to a new install using SQL Express 2012 solution link at the bottom of the page.
1. Move a copy of the DocuShare documents directory to the new server or destination.
2. Move a copy of the DocuShare database files to the new Database Server and verify that the copy of the database is connected, running and available.
Note: If you are using a New Microsoft SQL Server database, run exec sp_fulltext_database enable on the server to enable full text search.
3. Launch the DocuShare software install Wizard by doing one of the following:
4. If you are installing from a product media: Insert the DocuShare media into the server drive. If the installer does not open automatically, open the media, locate and double-click setup.bat.
5. If you downloaded DocuShare from the web: Download the file to a temporary directory on your server and unzip the file. Open the file, locate and double-click docushare.exe.
6. Note: 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
7. docushareLog.cleanUp=false.
8. Be patient; it takes several minutes for the system to load and start the installer.
9. Follow the onscreen instructions; when the Content Store field is displayed point to the copy of the documents directory.
10. Follow the onscreen instructions until you have selected the database.
11. When the Database Configuration Wizard window displays point to the copy of the database.
12. Follow onscreen instructions.
13. During the Installation, The DocuShare Installation Wizard window will pop up and state that The installation wizard has found the existing DocuShare data in the database remove? Select No.
14. The installer will then proceed to upgrade the target database.
15. When the upgrade successfully completes, click Finish to close the installer.
16. Reboot the server.
17. After the server restarts, if you did not set DocuShare to run as an autostart service, do one of the following:
· Enter <DSHome>\bin\start_docushare in a command prompt window to start DocuShare.
· In the Administrative Tool, in the Services application, select and start the DocuShare service.
18 If your DocuShare site uses LDAP over a secure SSL channel, you need to import the SSL certificate into the newly installed dstrust store. 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.
19 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 a command prompt window and enter: net start w3svc.
Apply updates and patches
Apply the following updates and patches, rebooting the server after each installation:
Note: Updates and patches can be downloaded from the following location.
Example installation order:
Note: Verify the most recent updates and patches available from the site above. For detailed information on each update and patch review the release notes.
- 661 update 1.
- 661 update 3.
- DocuShare 6.6.1 filter10.0.1-content10.3.1-proxy10.3.0.a - Windows Server,
- 6.6.1 update 3 patch 3.
Note: After installing patch < DocuShare 6.6.1 filter10.0.1-content10.3.1-proxy10.3.0.a > run the startidol10.3.bat command from a command prompt started as Administrator before starting DocuShare: <DSHOME>/bin /startidol10.3.bat
Licensing the site
Use a browser to connect to your newly upgraded site and login as admin.
1. From the Administration menu, click Site Management | License.
2. On the License page, locate and write down the Host ID number exactly as displayed.
3. Follow the license request procedure and obtain a site license.
4. When your account is verified, you will be emailed a license string.
5. When you have the license string, return to the Site Management | License page and enter the string in the License field. Do not use your old site license nor a trial license.
Post upgrade tasks
1. Run resetindexes.
a. Stop DocuShare.
b. Change into the <dshome> /bin directory.
c. Type resetindexes
d. Once the command completes, start DocuShare.
2. Reset User Levels for all user accounts on your site.
If you upgraded from DocuShare 5.x, all user accounts are now set to the CPX level. You must now activate and set each account to either Read-Only or DocuShare user levels as appropriate.
Refer to the DocuShare Administrator Guide for information on user levels and changing user levels through Account Management l Users l Change User Level.
3. Run database optimization.
Note: For detailed instructions on this refer to the DocuShare Administrator Guide or refer to the DocuShare Knowledge Base database optimization procedures.
4. To access customized VDF and image files, the upgrade installer relocates these files to <DSHome>\DSUpgrade\BackUpDir.0\amber.jar and <DSHome>\DSUpgrade\BackUpDir.0\root.jar.
Note: VDF files customized to work with DocuShare 5.x or older are not upgraded by the installer and do not work with this release of DocuShare. Refer to the DocuShare VDF Reference Guide to migrate your custom VDFs to DocuShare 6.6.
5. 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.
a. Go to Site Management l Access Policies.
b. Return the Site Access Authority to the pre-upgrade setting, then click Apply.
c. Go to Site Management l Site Operations.
d. In the System Mode field, select Read Write and select No in the Show Admin Message field; then click Apply.
Index the site
After completing DocuShare upgrade and licensing, index the site and verify that index is working correctly.
Note: If you are upgrading from version 6.5.3m some of the steps below are not required. The steps not required are indicated.
1. Stop DocuShare.
2. In a command window, run <DSHome>\bin\idoltool -s resetserver all y. (Not required for upgrades from 6.5.3)
Caution: The idoltool -s resetserver all y command clears the IDOL search indexes. Run this immediately before running dsindex index_all.
3. Optional: To increase the allocation of available memory for IDOL on 64-bit Windows, run the appropriate idolsetup.bat command according to the amount of RAM on the server.
4–8 GB RAM: <DSHome>\bin\idolsetup.bat idol_default.config
8–16 GB RAM: <DSHome>\bin\idolsetup.bat idol_medium.config
16–32 GB RAM: <DSHome>\bin\idolsetup.bat idol_large.config
32+ GB RAM: <DSHome>\bin\idolsetup.bat idol_unlimited.config
Note: At least 6 GB of RAM is recommended on a 64-bit Windows server.
4. Start DocuShare.
5. Run <DSHome>\bin\dsindex index_all. (Not required for upgrades from 6.5.3)
6. Review the recoverIndex.log file written to <DSHome>\bin directory. (Not required for upgrades from 6.5.3)
7. Run <DSHome>\bin\verifyIndex.bat to verify that the documents in the repository have been indexed. (Not required fro upgrades from 6.5.3)
8. If DocuShare was configured for LDAP, continue with the following steps. If your site does not use LDAP, you are finished with this procedure.
9. If DocuShare was configured for LDAP; start DocuShare, log into DocuShare as admin and go to Admin Home.
10. From the Administration menu, click Account Management | LDAP Accounts | Bind Group.
Note: These last two steps invoke a schema update to replace incorrect schema information with up-to-date attribute values from the LDAP server.
11. On the Bind Group page, set the Keywords LDAP Attribute to cn. Click Apply.
12. On the same Bind Group page, remove the Keywords LDAP Attribute entry. Click Apply.
Solution Updated: February 13, 2019
Solution ID: 816