Note: This applies to DocuShare 6.6.x connecting to an SQL Server
Warning: You must verify the bucket structure (Step 2) before starting DocuShare for the first time.
Note: After completing this solution all configuration settings on your DocuShare Server will need to be verified, to ensure that they were properly restored.
Prerequisites:
· Before beginning this solution you must already have a backup that contains at minimum your documents and database files.
Note: 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.
· The DocuShare server that you will be restoring to must have the same version, update and patch levels applied as the server that was backed up.
Note: The Server version, update and patches installed information can be found in the <dshome>\config\DSCommon.properties file if backed up.
· You must be a Windows Administrator to perform this solution.
To restore DocuShare 6.6.x:
Warning: The DocuShare Server must have the same version and updates applied as the server that you are restoring from to perform this solution. You cannot restore files from a different version and/or patch level.
1. Verify that the Server you are restoring to is licensed.
Warning: If old DocuShare server information is restored to the new DocuShare server before a new license key is installed on it all of the users will be set to inactive and you will need to activate them.
Note: The user levels (Read-Only, DocuShare, and CPX) will be retained as long as you have the same amount or more of each user licensed on the new server.
Note: If the server is not licensed, obtain a license key from the licensing department. DocuShare Licensing can be reached by calling 1-800-735-7749 and/or emailing docushare.licenses@xerox.com. The licensing department will require the version of DocuShare installed on your server and the Host ID of the server. The DocuShare license key will need at least the same number of users as the server had that you will be restoring.
2. Verify the Bucket Structures of the backed up server and the new server match (If applicable)
Warning: This step is very important and applies to DocuShare sites that have been freshly installed and will have a backup restored from a previously upgraded version of DocuShare. Please verify all the information below before proceeding with the restore procedures.
A. To verify your bucket structure on the backed up server:
o If you have a copy of the <dshome>\config directory
a) Open Windows Explorer.
b) Navigate the folder structure into the <dshome>\config directory.
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.
c) Open the ContentStore.xml file (in notepad or WordPad).
d) 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.
o If you do not have a copy of the <dshome>\config directory
a) Open the backup of the <dshome>\documents directory.
b) If there are folders with labels higher than b064 then your site is running the 512 bucket structure. If the buckets listed are from b000 to b064 then your site is most likely running a 64 bucket structure. It is very important that you make a note of this value.
B. To verify the newly installed server has the same bucket structure as the server that was backed up:
a) On the newly installed server, open Windows Explorer.
b) Navigate the folder structure into the <dshome>\config directory.
c) Open the ContentStore.xml file in a text editor such as Notepad.
d) Look for an entry in the file called NumberOfDirectories= edit this value to match the value found in step 2.
e) Save the file.
f) Open the ContentStore.Properties files in a text editor such as Notepad.
g) Look for an entry in the file called NumberOfDirectories= edit this value to match the value found in Step 2.
h) Save the file.
Note: It is important that you modify both the ContentStore.xml and ContentStore.properties files to maintain consistency on the server and prevent issues in the future.
3. Restoring the Database and Documents
From the New DocuShare Server,
A. Log in to DocuShare web interface as admin.
B. Click Admin Home | Site Management | Access Policies.
C. Set the Access Policies to Admin for the following:
a) Site Access Authority
b) Registry Access Authority
c) Account Creation Authority
d) Group Creation Authority
D. Click the Apply button.
Note: Changing the site access policies to Admin will prevent users from making any changes or adding any new content until the DocuShare Admin has had a chance to verify that the restore procedure from the old server to the new one was successful.
E. Stop the DocuShare.
F. Use your standard restore procedure to restore the <dshome>\documents directory.
Warning: Do not overwrite the <dshome>\documents\guid.txt file on DocuShare 6.6.x sites when restoring the documents directory.
At the SQL Server,
a) Open the SQL Server Management Studio.
b) Use your standard restore procedure to restore the DocuShare SQL Database on the SQL Server.
Note: Please refer to the Microsoft website at _http://www.microsoft.com to obtain the most current information on restoring the SQL Server Database. If necessary, contact the vendor directly for additional information.
c) Verify that the Restored Database is online and available.
From the New DocuShare Server,
a) Open a command prompt and change directory to <dshome>\bin directory.
b) From the bin directory type dssetup and press Enter.
c) Confirm all the entries by pressing Enter until you get to the Database section.
d) You will need to change the following entries to connect to your Old DocuShare Server’s SQL database.
· Database host (this value will be the same if the same SQL Server was used)
· Database port number (this value will be the same if the same SQL Server was used)
· Database link chunck size (default value is 100)
· Database search result chunk size (default value is 100)
· Database user (this value will be the same if the same SQL Server was used)
· Database name (Type the Old DocuShare Server’s SQL database name to connect to it)
· Database is a Named Instance (this value will be the same if the same SQL Server was used)
· Database Instance Name (if applicable)
e) Once the Database information has been changed to the new information press enter until you finish the configuration questions (pressing enter accepts the your previous settings).
f) A message stating that –success! Should be displayed.
g) Start DocuShare.
Note: Search will not be available until you run a full index on the new site or do a backup and restore of the IDOL Index.
h) Verify that the Site is restored properly.
i) Log in to DocuShare web interface as admin, Click Admin Home | Site Management | Access Policies.
j) Set the Access Policies to Admin, User, or guest for the following:
· Site Access Authority
· Registry Access Authority
· Account Creation Authority
· Group Creation Authority
k) Click the Apply button.
The Restore Information Provided below is Optional
Warning: The DocuShare Server must have the same version and updates applied as the server that you are restoring from to perform this solution. You cannot restore files from a different version and/or patch level.
Restore LDAP Configuration
A. Use your standard restore procedure to restore the DirectoryConfigLDAP.xml and the DirectoryConfigCommon.xml files to the <dshome>\config directory to the new DocuShare server.
B. Log into DocuShare as admin from the web UI
C. Click Admin Home | Account Management | Providers |Security Services.
D. Place a check mark in the checkbox to enable LDAP.
E. Click Directory Services under Account Management, on the pane on the left hand side of your web browser.
F. Place a check mark in the checkbox to enable LDAP.
G. Log out of DocuShare.
Restore Subscription Setup
A. Stop DocuShare
B. Open a Command Prompt window.
C. Change into the <dshome>\bin directory.
D. From the bin directory type dssetup and press Enter.
E. Confirm or change the DocuShare SMTP Server and the admin email address info when prompted if necessary.
F. When the settings changes have been completed, close the command prompt window.
G. Start DocuShare.
Set the Access Policies
A. Log in to DocuShare web interface as admin.
B. Click Admin Home | Site Management | Access Policies.
C. Set the Access Policies for the following using the drop down menu to select Admin, User or Guest.
· Site Access Authority
· Registry Access Authority
· Account Creation Authority
· Group Creation Authority
Custom Configuration Files (if applicable)
If the backed up DocuShare server had any custom configurations such as Monitor.xml, SearchServer.xml, etc. Then these custom configuration files will have to be manually changed again on your new server.
Restore Customized VDF files (if applicable)
To restore the customized VDF files from the backup. Create a directory called local in the <dshome>\amber\templates\<language> directory.
Note: Customized Release 5.x or older VDF versions are not convertible to DocuShare Release 6.6.x/CPX Release 6.6.x. Please refer to the DocuShare VDF Reference Guide to migrate your custom VDFs to DocuShare Release 6.6.x/CPX Release 6.6.x VDFs.
Solution Updated: August 17th, 2015
Solution ID: 1065
