Getting started with the Web Client GUI

How to prepare your system for using the IBM Storage Protect Web Client GUI is described.

Make sure that the following requirements are satisfied before you use the Web Client GUI.

Software requirements

Details of the hardware and software requirements for IBM Storage Protect for Mail: Data Protection for HCL Domino might change with maintenance updates, and other software currency support. For the most up-to-date requirements, visit the Hardware and Software Requirements technote that is associated with the release you are running, http://www.ibm.com/support/docview.wss?uid=swg21219345.

When the page opens, follow the link to the requirements technote for your specific release or update level.

Web browser
A web browser is required for using the IBM Storage Protect Web Client GUI with Data Protection for HCL Domino. The web browser must be installed on the same system as the Backup-Archive Client.
IBM Storage Protect Backup-Archive Client
The IBM Storage Protect Backup-Archive Client is required to use the Web Client GUI with Data Protection for HCL Domino operations. The Backup-Archive Client must be installed on the same system as Data Protection for HCL Domino.
Data Protection for HCL Domino plug-in
The Data Protection for HCL Domino plug-in is required to use the Web Client GUI. It must be installed on the same system as the IBM Storage Protect Backup-Archive Client.
You can verify that the Data Protection for HCL Domino plug-in is installed by entering the dsmc show plugins command. When the IBM Storage Protect Domino Utility opens, the plug-in is installed. For example:
<<< Installed plug-ins: >>>
******************************************************
IBM Storage Protect Domino Utility
******************************************************
******************************************************
IBM Storage Protect Domino Utility
******************************************************
plug-in name 											: PIDOM
library name 											: libPiDOM.a
library path 											: /usr/tivoli/tsm/client/ba/bin64/plugins/libPiDOM.a
function map 											: 0x10099e28
plug-in type 											: Domino
plug-in ver. 											: 7.1.0.0
plug-in info.											: NONE
plug-in lic. 											: /usr/tivoli/tsm/client/ba/bin64/plugins/pidomclient.lic
<<< Plug-in table information >>>
Plug-in directory search path       : /usr/lpp/Tivoli/tsm/client/ba/bin/plugins
Plug-in name criteria               : libPi*
Plug-in load member name            : n/a
Return code from piTable creation   : 00000000

Environment requirements

The following environment settings must exist before you attempt to use the IBM Storage Protect Web Client GUI.

The IBM Storage Protect Web Client is installed and configured.
Important: If you are using DB2 Server 9.1.2 on an AIX or Linux x86 processor, the AIX LIBPATH or Linux LD_LIBRARY_PATH environment variable must be set to include the DB2 instance directory (sqllib/lib32) before you start the Web Client GUI. These examples display the correct setting with DB2 instance name db2inst1:
LIBPATH=/usr/lib:/lib:/home/db2inst1/sqllib/lib32
or
LD_LIBRARY_PATH=/usr/lib:/lib:/home/db2inst1/sqllib/lib32
Use the backup-archive client command line to configure the web client:
  1. Generate the IBM Storage Protect password by starting the backup-archive client session with the following command:
    dsmc query session
  2. Enter the following command to start the client acceptor daemon, CAD:
    dsmcad
Data Protection for HCL Domino is installed and configured.

Ensure that you followed the instructions in the configuration section so that your system is ready to back up and restore Domino data.

The dominstall program assists you in automatically configuring the IBM Storage Protect Web client to operate within your Domino environment. Run the dominstall program for your Domino server partition and configure the IBM Storage Protect web client when prompted. See Configuring manually with dominstall.

Example files and settings that are used by the IBM Storage Protect web client
The following files are created in the profile directory by the dominstall program for use by the web client. They contain settings that are used specifically by the web client.
domdsm.cfg
The Data Protection for HCL Domino preferences file:
ADSMLOGDIR=/opt/tivoli/tsm/client/domino/bin/domdsmc_notes
ADSMOPTFILE=/opt/tivoli/tsm/client/domino/bin/domdsmc_notes
	/dsm.opt
LOGFILE=/opt/tivoli/tsm/client/domino/bin/domdsmc_notes/domdsm.cfg
DOMI_DIR=/opt/tivoli/tsm/client/domino/bin
NOTESINIPATH=/notesdata
DOMINSTALLPATH=/opt/lotus/bin
dsm.opt
The Data Protection for HCL Domino options file:
SERVERNAME serverA_notes
dsm.sys.changes
The IBM Storage Protect system options file contains the server stanza settings for serverA for the original dsm.sys file:
SERVERNAME       serverA
TCPSERV          serverA.storage.sanjose.ibm.com
COMMMETH         tcpip
TCPPORT          1500
NODENAME         CADlinux
PASSWORDACCESS   generate
DOMNODE          /usr/tivoli/tsm/client/domino/bin64/domdsmc_notes/domdsm.cfg
dsm.sys.additions
The IBM Storage Protect system options file contains the server stanza settings for server A of the original dsm.sys file with the addition of the updated server name:
SERVERNAME       serverA_notes
TCPSERV          serverA.storage.sanjose.ibm.com
COMMMETH         tcpip
TCPPORT          1500
NODENAME         notes    
PASSWORDACCESS   generate
PASSWORDDIR      /opt/tivoli/tsm/client/domino/bin/domdsmc_notes
notes.profile
The Domino server notes profile:
export DSMI_LOG=/opt/tivoli/tsm/client/domino/bin/domdsmc_notes
export DSMI_CONFIG=/opt/tivoli/tsm/client/domino/bin/domdsmc_notes/dsm.opt
export DOMI_DIR=/opt/tivoli/tsm/client/domino/bin
export DOMI_LOG=/opt/tivoli/tsm/client/domino/bin/domdsmc_notes
export DOMI_CONFIG=/opt/tivoli/tsm/client/domino/bin/domdsmc_notes/domdsm.cfg
alias domdsmc=domdsmc_notes
export PATH=/opt/lotus/bin:/notesdata:$PATH

Starting the Web Client GUI

  1. Make sure that the software and environment requirements are met.
  2. Specify the URL of the client workstation you are running the web client on, in the web browser. Specify the httpport number that is defined on the client workstation. The default value is 1581. For example, http://myhost.mycompany.com:1581. IBM Storage Protect logs information such as the httpport number, CAD activity, and errors to the dsmwebcl.log file. By default, this file is in the directory where the IBM Storage Protect backup-archive client is installed.
  3. To start the Java client GUI, run the dsm command. The Java client GUI is only available for Linux for System z.

For more information

See the IBM Storage Protect for UNIX and Linux Backup-Archive Clients Installation and User's Guide for detailed instructions about how to configure the Web Client GUI.