Xerox DocuShare 6.6.1 Installation Guide
DocuShare
Installation Guide
Publication date: February 2011
This document supports DocuShare Release 6.6.1
Prepared by:
Xerox Corporation
DocuShare Business Unit
3400 Hillview Avenue
Palo Alto, California 94304
USA
© 2011 Xerox Corporation. All rights reserved. Xerox®, DocuShare®, and Fuji Xerox® are trademarks of
Xerox Corporation in the United States and/or other countries. All other trademarks are the property of
their respective companies and are recognized as such.
Table of Contents
Chapter 1 Before you begin installation
DocuShare license information . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1–1
DocuShare technical support . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1–1
System requirements . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1–2
Minimum server requirements . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1–2
DocuShare Web Client requirements (all product editions) . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1–3
DocuShare Education and DocuShare support . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1–3
DocuShare Enterprise supports . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1–4
Information required for DocuShare installation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1–5
Chapter 2 DocuShare on a Windows platform
Install DocuShare . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2–1
Uninstall DocuShare . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2–4
Uninstall SQL Server Express database . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2–4
Upgrade DocuShare . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2–5
Update DocuShare software or add a language . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2–9
Chapter 3 DocuShare on a Solaris platform
Install DocuShare . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3–1
Uninstall DocuShare . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3–4
Upgrade DocuShare . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3–5
Update DocuShare software or add a language . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3–10
Chapter 4 DocuShare on a Linux platform
Install DocuShare . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4–1
Uninstall DocuShare . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4–4
Upgrade DocuShare . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4–5
Update DocuShare software or add a language . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4–10
Chapter 5 Database configuration
Oracle . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5–1
SQL Server . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5–3
PostgreSQL. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5–4
Windows platform . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5–4
Solaris platform. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5–4
Linux platform . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5–5
DB2 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5–6
Chapter 6 Web server bridge
Create a bridge to an Apache web server. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6–1
Create a bridge to an IIS web server . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6–2
DocuShare Installation Guide iii
Table of Contents
Chapter 7 Add-on installation
OCR (Optical Character Recognition). . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7–1
Archive Server. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7–3
iv DocuShare Installation Guide
Before you begin installation
This chapter contains the system requirements and installation information that you need to install or
upgrade a DocuShare site. Before you begin an installation, read this chapter to make sure your server
meets minimum requirements and that you are prepared with the information required by the install
Wizard.
1
DocuShare license information
• If your installation is a 30-day trial version and you want to continue use of DocuShare after the
trial expires, contact a Xerox DocuShare sales representative, call our sales team at 1-800-7357749 (US and Canada), or email us at dsbu.sales@xerox.com.
• If your installation is a non-trial version of DocuShare, if you are upgrading your site, or you have
purchased an add-on, Xerox DocuShare or your DocuShare reseller will provide instructions for
obtaining a license.
DocuShare technical support
Your site is covered by DocuShare technical phone support for 30 days from the date you obtained a
license. If you require technical assistance, go to the Related Links on your site home page. To purchase
extended support, contact DocuShare sales.
DocuShare Installation Guide 1–1
System requirements Before you begin installation
System requirements
Note: Before installing or upgrading, go to docushare.xerox.com for the latest system requirements.
Minimum server requirements
DocuShare and DocuShare Education
Intel or AMD platforms
Windows 2003 Server R2 or SP2 Standard and Enterprise (32 and 64 bit)
Windows 2008 Server SP2 Standard and Enterprise (32 and 64 bit)
Windows 2008 Server R2 SP1 Standard and Enterprise (64 bit)
Red Hat Enterprise Linux ES 5 (32 and 64 bit)
3.0 GHz Intel Pentium 4 or AMD Athlon MP processor or better
3 GB RAM or higher (32 bit) / 4 GB RAM or higher (64 bit)
20 GB of free disk space
Ethernet network interface
Sun SPARC platform
Solaris 10 with current patch clusters
UltraSPARC III processor or better
4 GB RAM or higher
20 GB of free disk space
Ethernet network interface
Virtual server
VMware ESX Server
An average use installation requires for each virtual server; a minimum of 4 GB virtual memory and 40
GB of free disk space for the operating system and DocuShare software.
If a database and stored documents are on the same virtual server; a minimum of 8 GB virtual memory
and 200 GB of free disk space.
A high use installation requires for each virtual server; a 64 bit OS, 16 GB virtual memory, and 2 TB of
free disk space.
DocuShare Enterprise
Intel or AMD platforms
Windows 2003 Server R2 or SP2 Enterprise (64 bit)
Windows 2008 Server R2 SP1 or SP2 Enterprise (64 bit)
Red Hat Enterprise Linux ES 5 (64 bit)
3.0 GHz Intel Pentium 4 or AMD Athlon MP processor or better
1–2 DocuShare Installation Guide
Before you begin installation System requirements
8 GB RAM or higher
40 GB of free disk space
Ethernet network interface
Sun SPARC Platform
Solaris 10 with current patch clusters
UltraSPARC III processor or better
8 GB RAM or higher
40 GB of free disk space
Ethernet network interface
Virtual Server
VMware ESX Server
An average use installation requires for each virtual server; a minimum of 4 GB virtual memory and 40
GB of free disk space for the operating system and DocuShare software.
If a database and stored documents are on the same virtual server; a minimum of 8 GB virtual memory
and 200 GB of free disk space.
A high use installation requires for each virtual server; a 64 bit OS, 16 GB virtual memory, and 2 TB of
free disk space.
DocuShare Web Client requirements (all product editions)
Web browsers
Microsoft Internet Explorer 6 SP3, 7, or 8
Mozilla Firefox 3.5 or 3.6
Apple Safari 4.0 or 5.0
WebDAV
Windows XP Professional with Office 2003/2007/2010
Apple Mac OS X 10.6
DocuShare Education and DocuShare support
Web servers
IIS 6 on Windows 2003 Server
IIS 7 or 7.5 on Windows 2008 Server (review the Windows installation to make sure that all of the IIS
Application Development and Management Tool components are installed on the server)
SunONE/Sun Java System Web Server 6.1 on Solaris 10
Apache Web Server 2.2.9
DocuShare Installation Guide 1–3
System requirements Before you begin installation
Databases
IBM DB2 (for upgrading customers only)
Microsoft SQL Server 2005 SP3
Microsoft SQL Server 2005 Express Edition
Microsoft SQL Server 2008 R2 or SP2
Oracle 10.2 or 11.2
PostgreSQL 8.4.4
Note: DocuShare requires a database connector for the Microsoft SQL Server and Oracle databases.
LDAP
Sun Java Directory Server Enterprise Edition 6.x
Microsoft Active Directory
DocuShare Enterprise supports
Web servers
IIS 6 on Windows 2003 Server
IIS 7 or 7.5 on Windows 2008 Server (review the Windows installation to make sure that all of the IIS
Application Development and Management Tool components are installed on the server)
SunONE/Sun Java System Web Server 6.1 on Solaris 10
Apache Web Server 2.2.9
Databases
Microsoft SQL Server 2008 SP2 Enterprise Edition
Oracle 11.2
LDAP
Sun Java Directory Server Enterprise Edition 6.x
Microsoft Active Directory
1–4 DocuShare Installation Guide
Before you begin installation Information required for DocuShare installation
Information required for DocuShare installation
The install Wizard asks questions about how you want the site installed. You may accept the defaults, but
there is some required information that you should have before starting the installation. After installation,
the administrator of the site can change most of the information that was provided during installation.
Information that you need for an installation include:
Web server installation information:
• Windows platform: If you choose to use Microsoft IIS as your web server, load IIS during Windows
Server software installation. Choose Tomcat interacts with IIS from the Wizard Web Server
Interaction window. This choice installs the DocuShare Tomcat servlet engine and the software
that connects the Tomcat engine to the IIS web server. If you choose to install Tomcat with IIS, you
need to declare an IIS port number to use if you do not accept the default port number.
If you choose to install a web server other than IIS, you must follow the installation instructions for
that web server. The web server must be installed and running before you begin the DocuShare
software installation. In this case, choose Tomcat only from the Web Server Interaction window.
Caution: WebDAV does not work if your DocuShare site is set up to use IIS via the Tomcat/IIS
bridge connection. Your site must be configured to use an Apache server. See the Web
Server Bridge chapter of this guide for information on creating a bridge to an Apache
server.
• Refer to the Web Server Bridge section of this guide for instruction on how to edit specific files to
create a bridge between your web server and the Tomcat servlet.
Web server options:
• A fully qualified DNS hostname (such as sales.acme.com) or the IP address for the server. You
cannot use aliases or WINS names.
• The server root (the default is docushare).
• Whether you want to run the server as HTTP or HTTPS. Choose HTTPS only if you configured
your web server for HTTPS service.
Database installation information:
• If you choose to install the default Microsoft SQL Express database, you can accept the default
database port number or enter one of your own.
• If you choose to install a different database, refer to the Database Configuration section of this
guide for installation information.
Crucial ports and pathnames:
• A designated port for the Tomcat servlet (default port=8080)
• A designated port for the RMI server (default port=1099)
• A designated location for document repository
• A fully qualified DNS name for the SMTP mail server
• A designated port for the SMTP server (default port=25)
• A designated port for the Tomcat Web Bridge (default port=8009)
DocuShare Installation Guide 1–5
Information required for DocuShare installation Before you begin installation
• A designated port for the Tomcat Web servlet (default port=8005)
What type of DocuShare installation you want installed:
• DocuShare with FTP scan feature. This installation installs SMB scan service and an FTP scan
service to receive documents. Make sure your site security rules allow the use of FTP.
• DocuShare without FTP scan feature. This installation installs only SMB scan service.
• DocuShare Archive Server. This installation installs the Archive Server software.
What type of user can access the site; Guest (anyone), User (only registered users), or Administrator
(only registered administrators).
Who can create new user accounts on the site; Guests, Registered Users, or Administrators.
Who can create new group accounts on the site; Registered Users or Administrators.
The default user level that is assigned to all new user accounts; Read-only, DocuShare User, or CPX
User. User levels are license dependent, so the CPX level is available only if your site is licensed for
CPX users.
How do you want to display dates; US English (mm/dd/yy) or International English (dd/mm/yy).
A unique site admin password and the email address of the site administrator.
A location on your server where you want the Wizard to install the DocuShare software.
For Windows platforms, decide how you want to control stopping and starting DocuShare; either
AutoStart or manually through the Services window.
1–6 DocuShare Installation Guide
DocuShare on a Windows platform
Installation logs
The DocuShare installer records all initial installation activity and stores it in InstallLog.txt in the Temp
directory of the server. At a command prompt; go to %temp%, then enter >dir to display the logs in Temp.
After the installer creates the DocuShare directory, it creates a second DocuShareInstallLog.txt file in the
home directory; where it stores the remaining installation information. To save the initial
DocuShareInstallLog file, start the installation process in a command prompt window by entering the
command: docushare.exe -P docushareLog.cleanUp=false.
2
Install DocuShare
Before you begin
1. Review Chapter 1 of this guide to make sure your server meets the minimum requirements for
DocuShare installation and that you have gathered the information required by the install Wizard.
2. If you have chosen not to install the DocuShare supplied web server, make sure you have installed
and configured the web server of your choice, and that web server is running before you begin
DocuShare installation.
3. If you have chosen not to install the DocuShare default database, make sure you have installed
and configured the database of your choice, and that database is running before you begin
DocuShare installation.
4. For an easier installation, we recommend that you install DocuShare on a clean server; one with
newly installed operating system software.
5. If you have other instances of DocuShare running on the same server, make sure those instances
are running before installing additional instances. Failure to do so can later result in indexing
problems and in situations where stopping one instance of DocuShare stops all instances.
DocuShare Installation Guide 2–1
Install DocuShare DocuShare on a Windows platform
Start the installation
Caution: If you have other instances of DocuShare running on the same server, make sure those
instances are running before installing additional instances.
1. Log into the server as a Windows server administrator.
2. Launch the DocuShare software install Wizard by doing one of the following:
• 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.
• 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.
Be patient; it takes several minutes before the system displays the first install Wizard screen.
3. Follow the onscreen instructions; accept the defaults or enter your own configuration information.
4. Click Next to advance the installation or click Back to return to a previous page to make a change.
Before the installer loads DocuShare, the Wizard allows you to make changes to your choices.
After installation, the administrator of the site has the authority to change most of the information
that was provided during installation; using either the Admin UI or a command prompt window.
5. In the database configuration window, select a database option then click Next and enter the
configuration information for your database.
If you selected the SQL Server Express database, enter a Database User Password (at least eight
characters, with a mix of upper/lower case and numbers, select Named Instance to create a new
database, and select Install SQL Server Express.
A reboot message appears, at the completion of reboot, restart the DocuShare installation.
6. In the Web Server Interaction window, select how you want the web server to connect with the
Tomcat servlet engine.
•Select Tomcat/llS if you installed IIS as part of your operating system software and want to
use IIS as your web server.
•Select Tomcat only if you installed a web server other than IIS. At the end of the installation,
you will have to manually edit some files to connect the web server to the Tomcat servlet.
Note: If you later want to use IIS as your web server, refer to the Create a bridge to an IIS web
server section of this guide.
7. In the Windows service setup window, select Install the DocuShare Windows Service.
Running DocuShare as a service on your Windows server is recommended. If your DocuShare
server is in a clustered environment, do not select DocuShare Windows Service AutoStart; the
clustered resource group will start DocuShare.
Finish the installation
1. When the installation successfully completes, click Finish to close the installer.
2. Remove the product media from the server drive.
3. Reboot the server.
2–2 DocuShare Installation Guide
DocuShare on a Windows platform Install DocuShare
4. If you selected Tomcat only, refer to Web Server Bridge chapter of this guide to edit specific files to
create a bridge between your web server and the Tomcat servlet.
5. After the server restarts; if you selected DocuShare with FTP scan feature, use the IIS Manager to
disable the IIS FTP service.
6. 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.
DocuShare initial startup automatically updates the search indexes; allow five minutes before
attempting to connect to the site through a browser.
7. If the site uses SSL and you selected IIS as your web server, follow these instructions to close the
Tomcat servlet port to prevent unauthorized access to the Tomcat web servlet though that port.
a. Stop DocuShare by entering the command, stop_docushare.
b. Run the dssetup command and change the status of the Tomcat http port to off.
c. Start DocuShare by entering the command, start_docushare.
d. Reboot the system if you are using IIS.
License the site
1. Use a browser to connect to your newly installed site.
• The default URL is http://<fully qualified DNS name>:8080/docushare.
• If DocuShare was installed in the home directory on your web site, the URL is:
http://<fully qualified DNS name>:<port>/
• If DocuShare was installed in a subdirectory on your web site, the URL is:
http://<fully qualified DNS name>:<port>/virtual web directory name/
• If you installed IIS on your server, then the :<port> component of the URL is not used. For
example: http://<fully qualified DNS name>/docushare
• If you installed only Tomcat on your server, then the :<port> component of the URL is 8080
(default).
• If you changed the server root to root during the installation, the /docushare (default)
component of the URL is not required. For example, http://<fully qualified DNS name> or http:/
/<fully qualified DNS name>:8080
2. Use the admin password you set during installation and log into the site as admin.
3. On the navigation bar, click Admin Home.
4. From the Administration menu, click Site Management | License.
5. On the License page, locate and write down the Host ID number exactly as displayed.
6. Follow the instructions that Xerox DocuShare or your DocuShare reseller provided to obtain a site
license string.
7. When you have the license string, return to the Site Management | License page and enter the
string in the License field.
8. Refer to the Administrator Guide for information on post-installation site configuration, such as
setting up your site to use SSL.
DocuShare Installation Guide 2–3
Uninstall DocuShare DocuShare on a Windows platform
Uninstall DocuShare
If you select to retain the content store, the uninstall Wizard does not remove the DocuShare directory that
includes your DocuShare repository content. To be safe, before uninstalling DocuShare move the
repository content to another storage media by using the DocuShare command line utility, dsexport. Refer
to the DocuShare Command Line Utilities Guide for details.
Uninstall removes all installed language packs.
Caution: The DocuShare uninstaller only removes DocuShare, not the installed database. You
should back up data for all Windows applications sharing the database. If you are using
the SQL Server Express database, back up all data to a secure location.
To uninstall DocuShare:
1. In Administrative Tools, select and open the Services application.
2. Select DocuShare, and then select STOP the service.
3. In the Control Panel, select and open the Add/Remove application.
4. Scroll and select DocuShare, click Remove, and then follow the onscreen instructions.
5. After Add/Remove uninstalls DocuShare, manually delete the directory where DocuShare was
installed.
Uninstall SQL Server Express database
The uninstall Wizard does not remove the installed SQL Server Express database. After you have
uninstalled and removed all DocuShare files, follow this procedure to remove the SQL Server Express
database files.
Note: Before you begin, refer to the Microsoft website for any updated uninstall instructions.
1. If you have not done so already, back up all data in the database to a secure location.
2. In the Control Panel, select and open the Add/Remove application.
3. Select Microsoft SQL Server 2005, then click Remove.
4. The Component Selection page appears; select Remove SQL Server 2005 instance
components.
5. Select Workstation Components.
6. The Confirmation page appears, listing the components to remove.
7. Click Finish to complete the SQL Server Express uninstall.
8. Then the process has completed, you must now remove the SQL Native Client.
9. In the Control Panel, select and open the Add/Remove application.
10. Select Microsoft SQL Native Client, then click Remove.
11. A window appears asking you to confirm the removal of the SQL Native Client, click Yes.
The SQL Server Express software and Native Client are removed from your drive.
2–4 DocuShare Installation Guide
DocuShare on a Windows platform Upgrade DocuShare
Upgrade DocuShare
A DocuShare upgrade utility is included with the software install Wizard. The utility can take sites as low as
v5.0.3 and upgrade them to the current version of DocuShare.
Installation logs
The DocuShare installer records all initial installation activity and stores it in DocuShareInstallLog.txt in
the C:..\Temp directory of your server. After the installer creates the DocuShare directory, it creates a
second DocuShareInstallLog.txt file in the home directory where it stores the remaining installation data.
To save the initial DocuShareInstallLog file, start the installation process in a command prompt window by
entering the command: docushare.exe -P docushareLog.cleanUp=false
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
of 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.
Backup the IDOL database
1. Make sure the target directory exists and is empty before starting backup. The target directory is
represented as <exportdir> in the command.
2. Run the command idoltool.bat -s export <exportdir>.
Backup the site database
DocuShare Installation Guide 2–5
Upgrade DocuShare DocuShare on a Windows platform
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.
The database must be running for the DocuShare Installer to upgrade the database schema.
4. If you are using a Microsoft SQL Server database, run exec sp_fulltext_database enable on the
server to enable full text search.
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 lost of all
events waiting in the queue.
Stop DocuShare
1. Log into the server as a Windows server administrator.
2. In the Administrator Tool, select and open the Services application, select DocuShare and stop
the service.
Close all Windows applications that are currently open on the server.
Start the upgrade
1. Launch the DocuShare software install Wizard by doing one of the following:
• 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.
• 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.
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.
2. When the Upgrade Option window appears, select Upgrade.
Be patient; it takes several minutes for the system to load and start the installer.
3. 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.
2–6 DocuShare Installation Guide
DocuShare on a Windows platform Upgrade DocuShare
3. 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.
4. 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.
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 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 and write down the Host ID number exactly as displayed.
4. Follow the instructions that Xerox DocuShare or your DocuShare reseller 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. Do not use your old site license nor a trial license.
Post upgrade tasks
1. 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.
2. Run database optimization as defined in the DocuShare Administrator Guide database
optimization procedures.
3. 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 the current DocuShare release.
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. Go to Site Management l Access Policies.
6. Return the Site Access Authority to the pre-upgrade setting, then click Apply.
Index the site
After completing DocuShare upgrade and licensing, index the site and verify that index is working correctly.
DocuShare Installation Guide 2–7
Loading...