How to use the setupDB utility
Note: SetupDB can be downloaded from the following
location: https://docushare.xerox.com/doug/dsweb/View/Collection-5092.
setupDb
Note: This applies to 6.5.x, 6.6.x
Applicable
language(s): English (run on any, but all messages are in English)
The
setupDb utility runs the database upgrade program used by the DocuShare upgrader.
This may be rerun without problem on a system which has already been upgraded,
so it is safe to run when you are not sure whether the upgrade got all the way
to the end. The upgrade completes any unfinished steps to reach the
specified target version. It drops and
re-adds the latest indexes if any upgrade steps have changed tables with
indexes.
A log
file may be specified and is appended to if it exists. If no log file is
specified, it will append to the install upgrade logfile, if it exists.
WARNING: setupDb
cannot tell what version of DocuShare software is installed, so it cannot
protect you if you specify a -v 'to version' that does not match. The db must match the installed software to
run correctly.
Files:
setupDb.jar setupDb.bat setupDb.sh
Installation
***
BACKUP METADATA BEFORE USING THIS UTILITY ***
*** Run
this only under the direction of DocuShare Support ***
Place
setupDb.bat (Windows) or setupDb.sh (Solaris/Linux) in the DocuShare bin
directory. Place
setupDb.jar in the DocuShare lib directory. Run
the command from the command line.
Usage
setupDb [-h] [-l <logfile full path>]
[-a] [-v <target version>] [-s] [-u] [-6]
-h
(this message) -l
Log file for output. Default is stdout. -a
Set up archive server. (This is part of
larger setup process.) -v
to version <xx.xx.xx>. Note this
MUST match the version of your installed
DocuShare. Example version numbers: 06.05.03 06.06.00 06.06.01 -s
(only if upgrading from before 6.0) site type, one of {CPX | DocuShare |
ImageManager } -u
(only if upgrading from before 6.0) default userLevel value, one of {Readonly |
ImageManager | DocuShare | CPX} -6
Use 6-bit permission mode if upgrading from before 6.1. Default is 3-bit.
Example:
Run on a system at 5.0.2, going to 6.6.1
C:\xerox\docushare\bin>
setupDb -v 06.06.01
Looking for an
existing upgrade install log file:
No existing
log file at C:\docushare\logs\database_upgrade.log, sending output to console
Beginning
setupDb on Fri Oct 14 15:33:02 PDT 2011
Database
upgrade begun at Fri Oct 14 15:33:40 PDT 2011
Upgrading from
version 05.00.02 to version 06.00.00
...
Upgrade: All
done. Successful upgrade complete at Fri
Oct 14 15:37:14 PDT 2011
Upgrade: It
would be a good idea to update database statistics.
Note: The output may show the following
warnings. This is harmless and does not
indicate
an actual
problem with setupDb.
log4j:WARN No
appenders could be found for logger (com.xerox.docushare.license.DSLicense).
log4j:WARN
Please initialize the log4j system properly.
log4j:WARN See
http://logging.apache.org/log4j/1.2/faq.html#noconfig for more info.
Example:
Run on a system at 6.0.1, going to 6.6.1, specified log file, setting 6-bit
permission
mode (usually an FX site)
C:\xerox\docushare\bin>
setupDb -v 06.06.01 -l c:\upgrade.log -6
Sending
message output to C:\upgrade.log,
appending to
existing file
Done.
Solution Published: May 9, 2016
Solution ID: 1765
|