Note: This article applies to an in-place upgrade (on the same Server) to DocuShare 7.
If you are migrating to a new Server please use a different solution such as:
- How to upgrade to DocuShare 7.0 64-bit from a previous version of 32-bit DocuShare. (ID: 1706)
- How to migrate DocuShare 6.6.1 from Windows 2008 install to a new DocuShare 7.0 on Windows 2016. (ID: 1927)
Before you start the upgrade procedure
• Review the System Requirements for DocuShare 7 and verify that your Server meets all the requirements. System Requirements are available here: https://www.docushare.com/system-requirements/
• If your site is customized, you will need to back up all your 6.6.1 customizations, then apply the customizations to the DocuShare 7 .vdf files once DocuShare is upgraded.
All customizations should be in the <dshome>\amber\templates\local directory. To back them up, copy the contents of the local directory to another location such as Docushare\tmp\661vdfs.
• If your DocuShare installation has custom integrations or custom solutions, please notify DocuShare customer support of this so they can advise on the appropriate upgrade path.
• If you are using XPA or eForms contact DocuShare customer support to discuss an upgrade path that is suitable for your environment.
• If you are using 3rd party software that scans into DocuShare verify that it supports DocuShare 7 before upgrading. You may need to contact the 3rd party software vendor to confirm.
• DocuShare 7.0 supports upgrades from Docushare 6.6.1 R2 or Docushare 6.6.1 build 139 Update 2 or higher.
• Contact the Licensing Department via email at docushare.licenses@xerox.com at least 2 business days prior to performing the upgrade.
The email must contain the following:
o Information on the version of DocuShare you will be upgrading to and when the upgrade will be taking place.
o Your current DocuShare Host ID / Server ID.
o Company and Address.
o Site ID (if you have it).
Preparing for the upgrade
• Clear the event queue and close site access.
a. Go to Admin Home | Services and Components | Subscription.
b. 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.
c. 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.
d. Go to Site Management l Access Policies.
a. Set the Site Access Authority to Administrator, then click Apply.
b. Go to Site Management l Site Operations.
c. 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.
d. After ten minutes, enter the message DocuShare is currently in read-only mode in the Admin Message field.
e. In the System Mode field, select Read Only.
f. In the Show Admin Message field select Yes.
g. Click Apply.
• Backup DocuShare.
For detailed information on how to backup DocuShare refer to the How to backup DocuShare site data solution. (ID: 615)
• Backup the IDOL database.
Run one of the following commands from <dshome>\bin depending on your environment.
• idoltool.bat –s backup <path_to_backup_directory> (Windows)
• idoltool.sh –s backup <path_to_backup_directory> (Linux / Solaris).
Where <path to backup directory> is replaced with the path to the backup folder. For example, 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.
• Disable virus and security scanning.
• Close all Windows applications that are currently open on the server.
Start the upgrade
1. Log into your Server as the Local Administrator.
2. Download the DocuShare software from http://www.support.xerox.com/support/xerox-docushare/software/enus.html. Select the Server OS from the drop-down menu, Under the Utilities & Applications section select DocuShare 7.0 with Update 1 for Windows.
3. Unzip/extract the files locally.
4. Stop DocuShare.
5. Open the installation directory you extracted and double-click the docushare.exe. Be patient; it takes several minutes before the system displays the first install Wizard screen.
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 docushareLog.cleanUp=false.
6. 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.
7. 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 one of the following:
o Enter <DSHome>\bin\start_docushare in a command prompt window to start DocuShare.
o In the Administrative Tool, in the Services application, select and start the DocuShare service.
4. 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.
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 the Host ID.
4. Contact docushare.licenses@xerox.com to obtain a license string. You will need to provide your Host ID, Company name
5. When you have the license string, return to the Site Management | License page and paste the string in the License field.
Post upgrade tasks
1. After completing a DocuShare upgrade and licensing and verify that indexing is working correctly.
2. Go to Site Management l Access Policies.
3. Return the Site Access Authority to the pre-upgrade setting, then click Apply.
4. 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.
5. Run a database optimization.
Note: For detailed information refer to the optimization commands for the database in the DocuShare 7 Installation Guide.
6. Any previously customized templates need to be modified to bring customizations forward. This can be done by copying the .vdf files that were customized in DocuShare 6.6.1 from the <dshome>\amber\templates directory to the <dshome>\amber\templates\local directory, then manually applying the DocuShare 6.6.1 customizations again to the DocuShare 7 .vdf files.
7. 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.
Note: DocuShare must be stopped to do this step.
– 4–8 GB RAM: <DSHome>\bin\idolsetup.bat ..\config\idol_default.config
– 8–16 GB RAM: <DSHome>\bin\idolsetup.bat ..\config\idol_medium.config
– 16–32 GB RAM: <DSHome>\bin\idolsetup.bat ..\config\idol_large.config
– 32+ GB RAM: <DSHome>\bin\idolsetup.bat ..\config\idol_unlimited.config
Note: At least 6 GB of RAM is recommended on a 64-bit Windows server.
Solution ID: 1745