Professional Documents
Culture Documents
2
Administrators Guide
Table of Contents
Copyright & Trademarks ............................................................................................................................... 4
Preface .......................................................................................................................................................... 5
Conventions .............................................................................................................................................. 5
References................................................................................................................................................ 5
CYA Technical Support ................................................................................................................................. 6
Telephone ................................................................................................................................................. 6
E-mail ........................................................................................................................................................ 6
Web........................................................................................................................................................... 6
Chapter 1....................................................................................................................................................... 7
CYA Solution Overview ............................................................................................................................ 7
System Architecture .................................................................................................................................. 8
Prerequisites ........................................................................................................................................... 11
EMC Documentum Content Server Platforms ................................................................................... 11
Full-Text Index Servers ...................................................................................................................... 12
Database Server................................................................................................................................. 13
Enterprise System Backup Applications............................................................................................. 13
CYA HOTBackup Server Prerequisites .............................................................................................. 15
CYA HOTBackup Client Prerequisites ............................................................................................... 17
SMTP Server ...................................................................................................................................... 17
Time Synchronization ......................................................................................................................... 19
IPv6 Support ....................................................................................................................................... 19
Application default port matrix: ........................................................................................................... 19
Chapter 2..................................................................................................................................................... 20
Server Installation ................................................................................................................................... 20
Deploy from Tomcat Manager ............................................................................................................ 20
Deploy from webapps directory .......................................................................................................... 20
Client Installation .................................................................................................................................... 20
Administrators Guide
Page |1
Administrators Guide
Page |2
Appendix A .................................................................................................................................................. 46
Known Issues and Notes ........................................................................................................................ 46
Notes .................................................................................................................................................. 46
Known Issues ..................................................................................................................................... 47
Appendix B .................................................................................................................................................. 50
Glossary .................................................................................................................................................. 50
Appendix C .................................................................................................................................................. 51
Sample Scripts ........................................................................................................................................ 51
Database Backup Scripts ................................................................................................................... 51
FTI Backup Scripts ............................................................................................................................. 52
Administrators Guide
Page |3
Administrators Guide
Page |4
Preface
This guide describes how to administer CYA HOTBackup. Throughout this guide CYA HOTBackup will be
referred to as HOTBackup.
Conventions
This guide uses the following conventions.
Convention Meaning
Bold
Used in procedures to indicate the name of a user interface object such as a menu or button.
Also used in procedures to indicate text that you type in a user interface object such as a text
box.
Italic
Select
Used in a procedure to indicate that you should select a user interface object, such as an
item from a list, or a check box.
Click
Used in a procedure to indicate that you should click the left mouse button to select a user
interface object, such as a button tab, or shortcut menu.
References
This guide describes how to manage system backups using HOTBackup. This guide references the
following related documentation.
Reference Document
Publisher
EMC Documentum
EMC
EMC
Symantec
Symantec
IBM
IBM
Administrators Guide
Page |5
Telephone
You can contact technical support at (480) 889-5951 , Monday Friday, from 9:00 a.m. - 9:00 p.m. (ET).
E-mail
You can send an e-mail with a description of the error encountered for which you require assistance to
support@cya.com.
Web
You can connect to the CYA Support Web site and log your request for assistance at
http://support.cya.com. This method requires you to have an established user account. If you do not
currently have an account you can register for one at http://support.cya.com.
CallSend SMSAdd to SkypeYou'll need Skype CreditFree via Skype
Administrators Guide
Page |6
Chapter 1
CYA Solution Overview
CYA HOTBackup enables companies to mitigate and even eliminate planned Documentum downtime by
performing hot, consistent backups of the entire Documentum application that are automatically stored
and managed within EMC NetWorker, EMC Avamar, Symantec NetBackup or IBM Tivoli Storage
Manager. CYA HOTBackup software can leverage the existing components of your backup solution in
such a way as to perform a consistent backup of all Documentum components, avoiding the following:
It is possible for a very small number of content files to be backed up that are unreferenced in the
database; this ensures that no broken links (see below) will exist.
CYA HOTBackup is designed to automate the backup processes associated with Documentum and
provide more synchronous backups of your entire Documentum environment. It is not a stand-alone
backup tool; therefore, it requires existing backup software to operate.
CYA HOTBackup is designed to integrate seamlessly with CYAs flagship product, CYA
SmartRecovery. CYA SmartRecovery mitigates unplanned Documentum downtime by enabling hot,
granular recovery of Documentum objects in response to logical failures such as viruses, power surges,
and user/programmatic errors.
Administrators Guide
Page |7
System Architecture
CYA HOTBackup automates the backup steps required to take a synchronized backup of your
Documentum environment while it remains live (hot). CYA HOTBackup is web application and requires a
Web Application Server. All operations are performed through the web interface.
xPlore Server
Administrators Guide
Page |8
CYA HOTBackup Client- Required for Integration with the CYA HOTBackup server.
Backup Client Required for CYA HOTBackup to store the xPlore backup performed on the backup
server.
Database Server
CYA HOTBackup Client- Required for Integration with the CYA HOTBackup server.
RMAN / MS SQLCMD Required for CYA HOTBackup native backup of the database.
Backup Client Required for CYA HOTBackup to store the database backup on the backup server. In
addition, clients can leverage the system backup database module/agents for the database.
Administrators Guide
Page |9
Administrators Guide
P a g e | 10
Prerequisites
EMC Documentum Content Server Platforms
The following table lists the Content Server software requirements. Please refer to the appropriate EMC
Documentum Content Server documentation for supported software versions.
Content Server
Operating System
RDBMS
6.0, SP1
Windows
6.0, SP1
Oracle
6.0, SP1
Oracle
6.0, SP1
Solaris
Oracle
6.0, SP1
AIX
Oracle
6.5, SP1-SP3
Windows
6.5, SP1-SP3
Oracle
6.5, SP1-SP3
Oracle
6.5, SP1-SP3
Solaris
Oracle
6.5, SP1-SP3
AIX
Oracle
6.6
Windows
6.6
Oracle
6.6
Oracle
6.6
Solaris
Oracle
6.6
AIX
Oracle
6.7, SP1
Windows
6.7, SP1
Oracle
Administrators Guide
P a g e | 11
6.7, SP1
Oracle
6.7, SP1
Solaris
Oracle
6.7, SP1
AIX
Oracle
7.0
Windows
7.0
Oracle
7.1
Windows
7.1
Oracle
Environment variables - Set CYA_XPLORE_HOME for the xPlore install directory (for example,
c:\xPlore) and JAVA_HOME (for example, c:\xPlore\jdk).
-OR1.
a. From the command line, run <xPlore install location>/dsearch/xhive/admin/XHAdmin to start
xDB administrator
b. Click Menu Database -> Connect
c.
Login
Administrators Guide
P a g e | 12
Database Server
If you plan to use Native (Standard) mode for database backups, you must ensure the PATH
Environment Variable contains a reference to the appropriate database backup tools on the HOTBackup
Client machine:
Oracle Deployments require ARCHIVELOG mode must be turned on for hot backups.
Enterprise System Backup Applications
The following table lists the Backup Server software requirements.
Backup Software
Versions
EMC NetWorker
7.x, 8.x
EMC Avamar
7.x
Symantec NetBackup
7.x
5.x, 6.x
NetWorker prerequisites:
Append the absolute path of the backup software client directory to the PATH environment variable
on each server to be backed up by CYA HOTBackup
Windows default installation path: C:\Program Files\Legato\nsr\bin
Linux/Unix default installation path: /usr/sbin
Avamar prerequisites:
Administrators Guide
P a g e | 13
Append the absolute path of the backup software client directory to the PATH environment variable
on each server to be backed up by CYA HOTBackup
Windows default installation path: C:\Program Files\avs\bin
Linux/Unix default installation path: /usr/local/avamar/bin
NetBackup prerequisites:
Append the absolute path of the backup software client directory to the PATH environment variable
on each server to be backed up by CYA HOTBackup
Windows default installation path: C:\Program Files\VERITAS\NetBackup\bin
Linux/Unix default installation path: /usr/openv/netbackup/bin
Create one or more policies to be used by CYA HOTBackup. Add a user backup schedule called
"User" to the policies. If you would like to use a default policy, the policy creation is not necessary,
however, you must still add the "User" schedule to the policy.
Using the concurrent DB & FTI jobs option requires the CYA HOTBackup client to be installed on the
NetBackup server.
Install CYA HOTBackup Client on the NetBackup server and add the "admincmd" folder (under the
NetBackup bin directory) to the PATH environment variable. Note the CYA HOTBackup client user
name and password just created. These will be used in the "Manage HOTBackup Client Settings for
NetBackup Server" section in the CYA HOTBackup settings page.
The FTI policy name used in this option needs to be unique for identifying activity of the job. Create a
new policy described above. The policy name will be used for the "FTI Policy Name" field in the CYA
HOTBackup job configuration page (also the "Wait for FTI backup to complete" checkbox needs to be
unchecked for this option).
Using the multi-streaming option for SA backups requires the CYA HOTBackup client to be installed
on the NetBackup server.
Install CYA HOTBackup Client on the NetBackup server and add the "admincmd" folder (under the
NetBackup bin directory) to the PATH environment variable. Note the CYA HOTBackup client user
name and password just created. These will be used in the "Manage HOTBackup Client Settings for
NetBackup Server" section in the CYA HOTBackup settings page.
Create a new policy used for the SA backup on the master server. For the full job create a full backup
schedule called Full. For the incremental job create an incremental backup schedule called
Incremental. Add the content server machine name in the Clients tab and leave Backup
Selections empty. Check the Allow multiple data streams checkbox in the Attributes tab. The
policy name will be used for the "SA Policy Name" field in the CYA HOTBackup job configuration
page (also the "SA Backup on the Master Server" checkbox needs to be checked for this option).
Create any policy(ies) you wish to use for the backup jobs prior to configuring the backups in CYA
HOTBackup. If planning to leverage the NetBackup for SQL Server Agent, you must create at least
one MS-SQL-Server type policy. The DB server must be listed as a client for this policy.
TSM prerequisites:
Append the absolute path of the backup software client directory to the PATH environment variable
on each server to be backed up by CYA HOTBackup
Windows default installation path: C:\Program Files\Tivoli\TSM\baclient
Linux/Unix default installation path: /opt/tivoli/tsm/client/ba/bin
Set the DSM_DIR environment variable on each server to be backed up by CYA HOTBackup
Administrators Guide
P a g e | 14
All Documentum server components must have an existing backup client installed on them prior to
configuring CYA HOTBackup:
o Content Server: Must have the File System Client from the backup software vendor
o FTI Server: Must have the File System Client from the backup software vendor
o Database Server: Must have the appropriate database-specific client from the backup
software vendor, OR a standard backup client and a database-vendor specific backup
solution such as Microsoft SQL VSS or Oracle RMAN
Appropriate Networker, NetBackup or Tivoli Storage Manager DB Modules are required if you plan
to use Networker, NetBackup or Tivoli Storage Manager to back up the database(s) in your
environment. Alternatively, HOTBackup supports the usage of database-specific backup software,
such as SQLServer VSS or Oracle RMAN.
Operating Systems
Microsoft Windows Server
Linux
Solaris
* Must be minimum requirements to Apache Tomcat Server and MySQL Server
The Documentum Foundation Classes (DFC) - must be installed on the server where you plan to
deploy CYA HOTBackup
Administrators Guide
P a g e | 15
The DFC standalone installer may be downloaded from EMCs Powerlink website
DFC version should match the version of the Content Server that is installed
Versions
Apache Tomcat
6.x, 7.x
Regardless of your Operating System, you must use forward slashes ("/") in the
catalina.properties file.
While backups of AIX servers are supported by the CYA HOTBackup software, deploying the CYA
HOTBackup server software on AIX is not supported.
Administrators Guide
P a g e | 16
Digital Shredding is not supported at this time and needs to be disabled while the backup jobs are
running
If you are installing CYA HOTBackup server on a Linux 64bit machine you might have to install a
32bit libgcc library prior to deploying CYA HOTBackup.
RMI connectivity is required between the CYA HOTBackup Server and any remote machines where
the CYA HOTBackup Client is installed. The default server port for RMI is 1099 and the default
client port for RMI is random. The RMI ports can be configured.
SMTP Server
Job notifications are completed via SMTP. This requires an SMTP server to be available and
authentication credentials if required.
Administrators Guide
P a g e | 17
Permission Requirements
To ensure successful backups, permissions must be granted appropriately for all files to be backed up.
This includes:
The user to which the permissions must be granted for all files listed, as well as any other files that
require backing up, varies based on the OS being used:
On Windows: The user configured as the service logon account for CYA HOTBackup Client services.
By default, for Documentum content, only the SYSTEM user and the Documentum Installation Owner
are granted access.
On UNIX/LINUX: The user that started the HOTBackup Client. By default, for Documentum content,
only the Documentum Installation Owner is granted access.
If you are backing up a remote file system, such as a UNC-path, the CYA HOTBackup client service is
required to be configured with permissions to access the file system.
it is required that a user running the CYA HOTBackup client has the proper permissions to access
the content.
If backing up any files or directories via NFS using Symantec NetBackup, you must enable the
"Follow NFS" option in the policy.
If backing up files or directories in a different file system using Symantec NetBackup, enable the
"Cross Mount Points" option in the policy.
Administrators Guide
P a g e | 18
Time Synchronization
Server times must be synchronized between all servers that will be operating under the control of
HOTBackup. This includes:
IPv6 Support
If your machines have IPv6 enabled, please add a line to the "C:\Windows\System32\drivers\etc\hosts"
file on the CYA HOTBackup machine for each remote server with IPv6 enabled:
[IP address] [machine name]
i.e: 133.33.1.99 cyamachine1
Application default port matrix:
Tomcat: 8080 - HOTBackup server
SMTP: 25 - SMTP server
Documentum: 1489 - Connection Broker host (Content Server)
HOTBackup Client/Server RMI: 1099 + Any random - Database , Content, and Fulltext servers
MySQL: 3306 - HOTBackup server
EMC Networker, Symantec Netbackup and IBM TSM: Please see the vender specific documentations
Administrators Guide
P a g e | 19
Chapter 2
Server Installation
Installation of the CYA HOTBackup Server is completed by deploying the cyahotbackup.war file. The
typical methods for deploying are via Tomcat Manager or by copying the cyahotbackup.war to the
webapps directory:
Deploy from Tomcat Manager
1. Open tomcat manager in browser (http://<host>:<port>/manager)
2. Browse to WAR file to deploy section, and click Browse
3. Choose CYA HOTBackup war file (cyahotbackup.war), and click Open
4. Click Deploy
Deploy from webapps directory
1. Copy cyahotbackup.war to Tomcat webapps directory.
2. Verify the war file was deployed on the Apache Tomcat instance, if the war file does not deploy on its
own you will need to restart the Apache Tomcat instance.
Client Installation
The CYA HOTBackup Client components must be installed on all remote machines. To install the Client,
run the installer and the Wizard will guide you. The CYA HOTBackup client must be installed by the
same OS user used to install the software relevant to Documentum on that server. Please see below:
On UNIX/LINUX:
Administrators Guide
P a g e | 20
Enter the location where you would like to install the Client application
Press Next
Administrators Guide
P a g e | 21
Enter the same user id and password as you specified in the CYA HOTBackup repository settings page
for this server; change the RMI port if you would like
If you change the RMI port for the Client, you must change it on server, as well; please see "Chapter 5 Security & Properties" for details
Press Next
Administrators Guide
P a g e | 22
Select the desired level of logging for the Client application and enter remote hosts, if desired, separating
multiple hosts by commas (with no leading or trailing spaces)
Press Next
Administrators Guide
P a g e | 23
Administrators Guide
P a g e | 24
Please enter a Directory to be used to store the CYA HOTBackup application settings. A small database
will be created in this directory, as well as some helper files required by the HOTBackup software. Please
note this directory must already exist, as it will not be created automatically by the Wizard. It is
recommended that the directory be empty.
If there is a previous installation of CYA HOTBackup and you would like to recreate all DB tables, enable
the Recreate CYA Tables if they already exist checkbox. Please note that by recreating CYA tables all
previously entered configuration will be lost. You also have the option to upgrade existing tables; for
clients upgrading from v.2.0 or v.3.0 (no changes from v.3.1.x), this option should be selected if you wish
to keep your configurations.
If you would like to reuse the same database and configuration files as a previous installation, be sure to
choose the same Directory as before.
If you would like to upgrade your existing DB tables from a previous CYA HOTBackup installation
older than v.3.1, you must verify the provided DB scripts in the CYA HOTBackup installation
directory BEFORE you complete this page and select "Configure". Navigate to [Installation
Directory]/WEB-INF/classes/scripts and rename the correct script from the list below to
"upgrade_hb_database.sql". This will require first renaming the existing script by that name.
The following scripts are available:
Administrators Guide
P a g e | 25
The selection Recreate CYA Tables if they already exist will delete all previous information, such
as backup jobs and job logs.
Click Configure.
Once the configuration successfully completes, the Login button will become enabled; click it to be
presented with the following screen:
This is a one-time screen that allows you to create the HOTBackup administrators username and
password. Enter your chosen username and enter the password twice. This username will be valid only
for HOTBackup and does not need to be a user in any other applications or domains. When finished, click
Create. This will create the user and log you in. The username and password you have chosen will be
required for all subsequent logins to the HOTBackup application.
Administrators Guide
P a g e | 26
Navigation Bar
Settings
o SMTP Settings
Jobs Manager
o General Information
o Component Settings
o Database Settings
Script Mode
o Full Text Index Settings
o Backup System Settings
EMC Networker
EMC Avamar
Symantec NetBackup
IBM Tivoli Storage Manager (TSM)
o Job Schedule
Logs
Help
Navigation Bar
Navigation throughout CYA HOTBackup is controlled using the Navigation Bar. The Navigation Bar has
five options. This section will expand on each of these options.
Logs Clicking on this icon will load the Application Logs View.
Jobs Manager Clicking on this icon will load the Jobs Manager.
Settings Clicking on this icon will load the Settings View.
Help Clicking on this icon will load the Help Screen.
Logout Clicking on this icon will log you out of the application.
Settings
The Settings section of the HOTBackup interface allows the administrator to make application level
configuration changes. From here, you can modify your alerts settings, set the logging level for the
application logs, and add, delete, or configure repositories to be used in backup jobs, created through the
Jobs Manager.
Administrators Guide
P a g e | 27
SMTP Settings
HOTBackup alerts and notifications are handled via e-mail through your organizations SMTP server.
SMTP Host: The hostname of your organizations SMTP server.
Port Number: The port number to use for the connection to the SMTP server.
User Name: A valid user name to connect to the SMTP server.
Password: The password that corresponds to the user name entered.
From Address: The address you would like used as the "from:" address on e-mails sent by CYA
HOTBackup.
Notify on Success: A comma-delimited list specifying one or more e-mail addresses to which you would
like an e-mail notification sent when any job completes successfully. This can be left blank in which case
no e-mail notification will be sent upon successful job completion.
Notify on Failure: A comma-delimited list specifying one or more e-mail addresses to which you would
like an e-mail notification sent when any job encounters an error during execution. This can be left blank
in which case no e-mail notification will be sent upon job failure.
Administrators Guide
P a g e | 28
Repository Configuration
You can edit or delete existing configurations, or click on Add to add a new repository configuration.
Repository Credentials
Connection Broker Server: The server on which the Connection Broker resides.
Connection Broker Port: The port number to use to connect to the Connection Broker.
Repository: The name of the repository you would like to configure for backups.
Host Name: This optional setting specifies a host name used in the connection string when connecting to
the repository and mainly used in a clustered environment.
User Name: A valid Superuser login for that repository.
Password: The password for the user name specified above.
Domain: This optional setting specifies a domain to be used in conjunction with the user name and
password to connect to the Documentum repository, if necessary.
Test: This button allows you to test the Documentum connection credentials youve entered.
Database Server Settings
The "Database Server Settings" section of the Configuration Information" page is slightly different based
on your DB Type.
Administrators Guide
P a g e | 29
"Database Server Settings" section when "Microsoft SQL Server" is selected as the DB Type.
Host Name: The hostname of the database server; this is case sensitive. It must be specified using the
same case in the CYA HOTBackup Repository Configuration as it is in the Backup Server software
configuration.
HB Client User Name: The HOTBackup Client username on the database server.
HB Client Password: The HOTBackup Client password corresponding to the User Name specified
above.
DB Type: Select the type of database.
Authenticated Login: Select this checkbox if using authenticated login.
Backup Location: Specify a location for the database backup to be temporarily written to disk.
Instance/Server Name (MS SQL only): Enter the Instance or Server name of the MS SQL instance or
server you wish to backup.
Database Name (MS SQL only): Enter the database name you wish to backup.
Oracle SID (Oracle only):Enter the SID of the Oracle instance you wish to backup.
Tablespace Name (Oracle only): Enter the name of the Oracle Tablespace you wish to backup.
Backup Logs:Select this checkbox if wish to backup the database logs.
Administrators Guide
P a g e | 30
Delete Local Backup: Select this checkbox if you do not wish to keep the temp copy of the backup on
local disk.
xPlore Server Settings
The "xPlore Server Settings" section of the Configuration Information" page is slightly different based on
your Backup Type.
"xPlore Server Settings" section when "Hot" is selected as the Backup Type.
"xPlore Server Settings" section when "Warm" is selected as the Backup Type.
Script Mode:
If you plan to perform cold backups, you must specify all FTI client names in a comma-separated
list (without spaces), and the scripts will be executed on each individual server.
For warm or hot backups, only specify the primary FTI server as the FTI client name and scripts
will only be executed on the primary server.
Because of this difference, it is not possible to mix cold FTI backups with warm or hot backups for
any single repository.
Administrators Guide
P a g e | 31
Host Name: The hostname of the FTI server; this is case sensitive. It must be specified using the same
case in the CYA HOTBackup Repository Configuration as it is in the Backup Server software
configuration
HB Client User Name: The HOTBackup Client username on the FTI server.
HB Client Password: The HOTBackup Client password corresponding to the User Name specified
above.
Backup Type: Select how you would like the xPlore backup to be taken.
Backup Location (Warm only): Select the location to where you would like to write the xPlore backup.
Backup Level (Warm only): Select at what level you wish to backup xPlore.
Content Server Settings
Host Name: The hostname of the Content Server; this is case sensitive. It must be specified using the
same case in the CYA HOTBackup Repository Configuration as it is in the Backup Server software
configuration
HB Client User Name: The HOTBackup Client username on the Content Server.
HB Client Password: The HOTBackup Client password corresponding to the User Name specified
above.
Jobs Manager
The Jobs Manager is the default view when you login to the HOTBackup application, once the application
settings have been properly configured. From here, you can create, modify, or delete backup jobs,
manually run the jobs, or check the history logs for each job.
You may filter the view to include only jobs from a single repository by selecting that repository from the
Filter Jobs by Repository: drop-down list at the top of this page. Change this selection back to ALL if
you would like to see all jobs again. On this page, you can click on the job name to edit or delete existing
jobs, or click on New to add a new job.
Administrators Guide
P a g e | 32
General Information
Job Name: A name you specify for this job; this can be any combination of letters and/or numbers you
choose; spaces are allowed.
Connection Broker: The name of the Connection Broker to which you would like to establish a
connection for this backup job.
Connection Broker Port: Select the port from the drop-down that corresponds to the Connection Broker
you would like to connect to.
Repository: The name of the repository you would like to backup with this backup job.
Full Back Job Name: Use this drop-down to link an incremental job to a full job. Each time the
incremental job runs after the linked full job, it will only backup to the point where that full job left off,
instead of backing up to the point of the last time the incremental job ran.
Component Settings
Select Components for Backup: From this drop-down, you can select which components you would like
backed up with this backup job; valid options are as follows:
ALL Backup all components of the Documentum repository specified: DB and SA_ALL are
automatically performed and FTI_ALL and ICF can be optionally selected or deselected.
DB Backup only the database for the specified repository.
FTI Backup only a specific Full Text Index for the specified repository.
FTI_ALL Backup only all of the Full Text Indexes of the specified repository.
SA Backup only a specific Storage Area for the specified repsository.
SA_ALL Backup only all of the Storage Areas for the specified repository.
ICF Backup only the Documentum Installation & Configuration Files.
Component Name: Enter the name of the component you wish to backup. If Component for Backup is
SA, specify the name of a dm_filestore object. If Component for Backup is FTI, specify the name of the
full-text index, for example, <repository_name>_ftindex_01.
Include Installation & Configuration Files: Select this checkbox if you wish to include the Documentum
installation & configuration files (ICF) in this backup; ICF backups are always full backups.
ICF Directories: Specifies the directory(ies) to backup as part of the ICF backup; separate multiple
directories with commas and do not use quotes, even if the directories include spaces; do not include
spaces before or after delimiting commas
Administrators Guide
P a g e | 33
It is recommended that, unless your environment requires the backup of the installation and
configuration files as part of the system backup, the ICF backup be configured to run as a separate
job.
Database Settings
Database Backup Mode: Select "Native" or "Script". In Native mode, the database is backed up using
native database tools and streamed automatically to your backup device. For enhanced control, you can
select Script and specify a script to be executed for the database backup. This script must contain all
commands associated with the database backup, as no additional steps are taken by HOTBackup to
backup the database when this mode is selected.
Send DB to Backup System (Native only): Select this checkbox if you wish for the database backup to
be sent to the backup device after being written to the temp location specified in the Repository Settings.
Script Mode
DB Script Name: Specifies the database script to be executed for the backup of the database. Use the
full/absolute local path (relative to the DB Server) of the file.
For backups using the backup vendors' modules for SQL Server, the OS user specified for DB server
in Repository Configuration must be granted the sysadmin role within SQLServer.
For SQL Server backups without the backup vendors' modules for SQL Server, a sysadmin user (or
the database owner) must be specified in the osql command.
For Oracle backups with or without the backup vendors' modules for Oracle, a user with SYSDBA
privileges must be specified in the RMAN command file.
Sample scripts are provided for all supported combinations of backup software, database software,
and operating systems; please see Appendix C for more information on sample scripts.
Full Text Index Settings
Include Full Text Index: Enable this checkbox if you have selected ALL, FTI, or FTI_ALL for Select
Components for Backup and you would like to include a backup of the FTI; an FTI backup is always a
FULL backup.
Administrators Guide
P a g e | 34
Throughout this section, the Full-Text Index (FTI) Server will be referred to as "xPlore." Backups of
FAST servers are still supported through "Script" mode.
FTI Backup Mode: Select "Native" or "Script". In Native mode, the xPlore server is backed up using
Native-xDB backup and streamed automatically to your backup device. For enhanced control, you can
select Script mode and specify a script to be executed for the FTI backup. This script must contain all
commands associated with the FTI backup, as no additional steps are taken by HOTBackup to backup
the FTI when this mode is selected.
FTI Quiesce Script (Script only): Specifies a script to execute before backing up the FTI.
Sample scripts are provided for all supported combinations of backup software, database software,
and operating systems; please see Appendix C for more information on sample scripts.
FTI Directories: The directories that contain the Full Text Index(es); separate multiple directories with a
comma, using quotes only on UNIX systems (do not use quotes on Windows even if the directories
include spaces); do not include a space before or after delimiting commas.
FTI Unquiesce Script (Script only): Specifies a script to execute after backing up the FTI.
In an environment with multiple xPlore servers, it is not possible to mix cold file backups with warm
or hot backups in a single job. Please see the Repository Configuration section for more information
on how to specify multiple FTI server names for your environment.
FTI xPlore Hot Backup: Enable this checkbox if you wish to backup the xPlore Index server hot.
Backup System Settings
The "Backup System Settings" section of the Configuration Information" page is slightly different based
on your Backup Device Type.
EMC Networker
"Backup System Settings" section when "NetWorker" is selected as the Device Type.
Administrators Guide
P a g e | 35
Group Name (NetWorker): Specify a valid backup group name, or leave blank to use the default.
Data Volume Pool (NetWorker): Specify a valid Data Volume Pool name, or leave blank to use the
default. You must enclose the Data Volume Pool name in double quotes ("...") if there are any spaces in
the name.
EMC Avamar
"Backup System Settings" section when "Avamar" is selected as the Device Type.
While flag file can be left blank, doing so requires that you enter the id, password and account into
the .properties file that corresponds to your job, located in the [HB storage
directory]/[hostname]_[port number]/[repository name] directory. For example,
D:\CYA_HOTBackup\cyademo101_1489\demo\cya_hotbackup_documentum_system_full.propert
ies.
Valid attributes are:
DEVICE_ADDITIONAL_PARAMS_FTI
DEVICE_ADDITIONAL_PARAMS_SA
DEVICE_ADDITIONAL_PARAMS_ICF
For example, if you are running a Storage Area backup, add the following line:
DEVICE_ADDITIONAL_PARAMS_SA=id=<user> --password=<password> --account=/<client
domain>
Symantec NetBackup
"Backup System Settings" section when "NetBackup" is selected as the Device Type.
Administrators Guide
P a g e | 36
Backup Level: Select whether to perform a full or incremental backup; this setting applies only to the
content backup, while FTI & ICF backups are always full; the DB backup level is specified in the
applicable scipt.
CS Policy Name (NetBackup): Specify the storage policy to use for backing up the Content Server.
DB Policy Name (NetBackup): Specify the storage policy to use for backing up the database server.
FTI Policy Name (NetBackup): Specify the storage policy to use for backing up the FTI server. A unique
policy name needs to be used for the concurrent DB & FTI option.
ICF Policy Name (NetBackup): Specify the storage policy to use for backing up the Installation and
Configuration Files.
Wait for FTI Backup to complete (NetBackup): Uncheck this option if you choose to concurrently run
the DB and FTI backup jobs .
SA Backup on the Master Server (NetBackup): Check this option if you choose to multi-stream the SA
backup.
IBM Tivoli Storage Manager (TSM)
"Backup System Settings" section when "TivoliStorageManager" is selected as the Device Type.
Begin backups by first running a full backup job. Running an incremental job first will still cause a
full backup of all content.
Administrators Guide
P a g e | 37
When performing a SQLServer database backup using osql or sqlcmd utility, the backup job will
fail if it is run for the first time using the WITH DIFFERENTIAL clause.
Backup Level, Group Name, Data Pool Volume, Policy Name, Flag File and Options File settings
only apply to the database backup in "Native" backup mode; in "Script" Mode, these can be
specified in the script leveraged for the database backup
Job Schedule
Job Schedule:
Status: Select to Enable automatic scheduled runs of this job, or to Pause this jobs schedule.
Start Date: The next date you would like this job to run.
Start Time: The next time you would like this job to run.
Scheduler: Select Frequency if you would like to setup a job to run daily, or weekly. Select Monthly if
you would like to run a job on a schedule such as the 3rd Friday of the month, or the last day of the
month.
Frequency (Frequency only): Select the interval on which you would like this job to run.
Exclude Day (Frequency only): Select the checkbox corresponding to any days of the week you would
like this job NOT to run; this setting is useful if, for example, you would like to implement a backup
schedule such as run an incremental backup every day except run a full backup on Sunday.
Recurring (Monthly only): Select the interval on which you would like this job to run.
Administrators Guide
P a g e | 38
Logs
From the Logs view, you can view the Application Logs for HOTBackup.
Help
The help section shows you version information about the HOTBackup product version you are running,
as well as contact information for the CYA Support Team.
Administrators Guide
P a g e | 39
Chapter 4
Advanced Configurations
Configuration for Multiple Content Servers with a single repository
Sample Environment:
Multiple content servers with a single repository using the same port for Connection Broker (cs1, cs2,
cs3)
1 storage areas server (sa1)
1 database server (db1)
2 FTI servers deployed as high-availability indexing (fti1, fti2)
Enter domain user to login all content servers in Global / Remote Access (i.e.
devtech\dmadmin)
Enter domain user to login both FTI servers in Global / Remote Access
When cs1/fti1 server is down, files from other servers can still be backed up to the clients.
HOTBackup settings:
1. Modify hosts file on HOTBackup server, and add two virtual hosts for content server and FTI server:
a. <IP of cs1> <alias of cs>
b. <IP of fti1> <alias of fti>
Administrators Guide
P a g e | 40
Administrators Guide
P a g e | 41
Chapter 5
Changing HOTBackup Security
Changing a HOTBackup Client username or password
The HOTBackup username and encrypted password are stored in the cyahb_client_params.properties
file. To change the username or password after installation:
1. Open a command prompt on the machine where the HOTBackup Client password you wish to
change is located and navigate to the HOTBackup client installation directory.
2. Run the following command (excluding quotes):
o
4. Edit the cyahb_client_params.properties. Be sure to use a Plain Text editor. Update pwd value to the
value of the string above.
o
Ex: pwd=51B23930F16D71C7F16EF6B92CC50B63
Description
rmi_port
Specifies the RMI server port to be used for communication between the CYA
HOTBackup Server and Client. After changing this value, you must restart the CYA
HOTBackup Client. If you change the RMI server port for the Client, you must change it
on server, as well. Please see the "Changing the RMI port on the CYA HOTBackup
Server" section of this chapter for details.
rmi_client_port Optional. Specifies the RMI client port to be used for communication between the CYA
HOTBackup Server and Client. After changing this value, you must restart the CYA
HOTBackup Client. If not specified random ports will be used.
rmi_host
Optional. Specifies the host name or the IP address to be used for communication
between the CYA HOTBackup Server and Client. After changing this value, you must
restart the CYA HOTBackup Client. If not specified the default host name will be used.
Administrators Guide
P a g e | 42
Parameter
Description
uid
Specifies the user ID to be used to communicate between the CYA HOTBackup Server
and Client.
pwd
Specifies the password that corresponds to the user specified in the uid parameter,
above.
log_level
Specifies the logging level to be used for the CYA HOTBackup Client. The options are
ALL, FINER, INFO, WARNING or OFF.
log_size
Optional. Specifies the maximum size for the CYA HOTBackup client log . After changing
this value, you must restart the CYA HOTBackup Client. The default value is 20MB with
up to 50 files.
remote_host
Used to limit connectivity to this CYA HOTBackup Client instance to specified CYA
HOTBackup server machine(s). To restrict access, list hostname(s) of desired CYA
HOTBackup server to which to grant access, delimited by commas, without spaces.
Leave blank to allow connectivity from any CYA HOTBackup Server installation that
supplies the correct username & password.
The RMI port used for communication MUST be configured to the same value on the CYA
HOTBackup Server and on each CYA HOTBackup Client. Currently, using different RMI ports for
different clients is not supported.
Administrators Guide
P a g e | 43
Chapter 6
NDMP NAS Backups
Using the CYA HOTBackup replace command to perform NAS backups via NDMP with EMC
NetWorker (nsrndmp_save)
If you wish to leverage NDMP to backup your data from a NAS device using EMC NetWorker, the CYA
HOTBackup replace command can be leveraged to replace the standard save command with the
nsrndmp_save command.
The following steps can be used to configure the servers:
On NAS:
1. start ndmp service
o
ndmpd on
On NetWorker Server:
1. Create client resource for NAS server:
a. On the "General" Tab:
c.
Ndmp: checked
2. Configure the User Groups - add repository owner on content server to a group with "Operate
NetWorker" privilege, or create a new group:
o
Administrators Guide
P a g e | 44
On Windows: change the service logon to repository owner, and restart the service
On Unix: logon as the repository owner and start CYA HOTBackup client
On HOTBackup server:
1. Configure SA/SA_ALL/ALL backup jobs using networker device as regular
2. Modify job config manually and add replace command as follows:
o
3. OPTIONAL: You may also replace the backup command for the FTI and/or ICF backups using:
o
DEVICE_REPLACE_CMD_FTI=
DEVICE_REPLACE_CMD_ICF=
Administrators Guide
P a g e | 45
Appendix A
Known Issues and Notes
Notes
It is strongly recommended that you ensure a NetWorker backup job is configured to perform regular
backups of the NetWorker server bootstrap and client file index.
If a CYA HOTBackup job is manually terminated and not allowed to complete, including situations in
which a server is restarted or a CYA HOTBackup backup session is manually terminated through the
backup server software, please follow these steps to ensure the Documentum jobs are properly
restarted:
Fast Index server - Go to FTI client and start the FAST InStream service (if applicable).
xPlore - Using a browser, navigate to: http://<fti client host>:9200/IndexAgent1/ and execute Start action
for the repository by selecting "Start" from the drop-down BEFORE logging in.
Maintenance jobs - Ensure jobs that should be enabled for the repository are set to active. The jobs in
the following table may need to be enabled via Documentum Administrator. Steps to enable are:
Right-click each of the jobs, open its properties and change state
Jobs
dm_DMClean
dm_DMFilescan
dm_FTCreateEvents
dm_FTIndexAgentBoo
If multiple FTI, SA or ICF directories are input through the UI, NetWorker could potentially return a
success code if any of the directories succeed, even if the backup of one or more directories fail. In
order to ensure NetWorker will return a failure code if any directories fail, please enable the "-u"
parameter for the appropriate backup type.
1. These parameters can be added to the end of the .properties file that corresponds to your
job, located in the [HB storage directory]/[hostname]_[port number]/[repository name]
directory. For example,
D:\CYA_HOTBackup\cyademo101_1489\demo\cya_hotbackup_documentum_system_full.pr
operties.
2. The valid attributes are:
DEVICE_ADDITIONAL_PARAMS_FTI
DEVICE_ADDITIONAL_PARAMS_SA
DEVICE_ADDITIONAL_PARAMS_ICF
Administrators Guide
P a g e | 46
3. For example, if you enter multiple ICF directories in the HotBackup interface, add the
following line: DEVICE_ADDITIONAL_PARAMS_ICF=-u
On Solaris, edit "/etc/dfs/dfstab", and update the share folder to use root option as
"share -F nfs -o rw,root=<CS host1>:<CS host2> <share folder>"
NetBackup: backup Network Drive or UNC path (from NetBackup Admin Guide):
o The network drives must be available to the service account that the NetBackup Client service
logs into at startup. By default, the startup account is set to System. You must change this
account on each Windows client that is backed up that contains data that is shared from another
computer.
If you wish to back up the database to a Network Drive or UNC path, you MUST start the HOTBackup
client service with a user that has read and write access permissions to the remote server.
Known Issues
If the NetBackup job fails during the first run of the CYA HOTBackup job, NetBackup will remain in
the "Wait for Retry" job state, and the CYA HOTBackup job will hang.
o To cancel the NetBackup job, open the NetBackup Administrator Console, go to Activity
Monitor, and cancel the NetBackup job that is in the "Wait for Retry" state.
Administrators Guide
P a g e | 47
When HOTBackup is deployed on a separate server from the Content Server, if the Content Server is
running UNIX, HOTBackup uses the current login user (user id) or root user of the HOTBackup server
to login to the CS/DB/FTI servers.
o You must create a user on the HOTBackup Server with same username and user id of the
DM Installation Owner on the Content Server.
o Login to HOTBackup server using user created in last step to start the Tomcat Service.
o Due to permission settings on the files created by RMAN, the root user must be added into
the Oracle users group as a supplementary group. To do this, follow these steps:
1. Login to the DB server as root user
2. Edit /etc/group, and add root user to Oracle users group as supplementary group, i.e.:
oinstall:x:500:root
3. Logout and login to DB server again
4. Restart Networker service:
o nsr_shutdown
o /etc/init.d/networker start
With FTI backup in the script mode, xPlore 1.3 always returns exit code 0 which results in CYA
HOTBackup jobs to report successful even though the backup was failed. This is due to a new line
added in the xPlore 1.3 xplore.sh/xplore.bat file. To workaround remove the last line "cd $EXE_DIR"
from the xPlore 1.3 xplore.sh/xplore.bat file. In the native mode CYA HOTBackup jobs report
correctly.
After restoring xPlore 1.1 from a warm file backup, document search fails with error
"LUCENE_SNAP_SHOT_TOO_OLD_ERROR: entry name=LI-e229e15b-66c0-47fd-b236707cb3bf22fb Snapshot too old, entry was merged"
o This is a bug in xPlore 1.1 and the solution is to apply the Patch 01 to resolve this issue.
In some cases, if a Windows command contained within an unquiesce script fails, Windows may
reset the error code returned by the command to 0, causing HOTBackup to report success. In these
cases, the original return code and error will be shown in the LOG files for the job.
In environments with multiple xPlore servers, you cannot mix a cold file backup on one with a warm
file or hot backup on any others. For cold file backups, you have to specify multiple FTI client names
separated by commas, to ensure the scripts run on all the servers. For warm file or hot backup, you
may only specify the primary server in FTI client name, because the scripts only can be run on the
primary server.
If you are using Tivoli and wish to specify an options the options file must be placed in the same
directory on each server to be backed up. This location must match what is specified in the Backup
System Settings for the specific job. As an alternative, you can place the options file in the CYA
HOTBackup Client home location. You should then specify only the file name in Backup System
Settings instead of the full path.
If you are using Avamar and wish to specify a flag file the flag file must be placed in the same
directory on each server to be backed up. This location must match what is specified in the Backup
System Settings for the specific job. As an alternative, you can place the flag file in the CYA
Administrators Guide
P a g e | 48
HOTBackup Client home location. You should then specify only the file name in Backup System
Settings instead of the full path.
Avamar has a 48 character maximum limitation for a backup label name. The label name created by
CYA HOTBackup may be truncated depending on the repository name length and the scope of the
operation being performed. If a label is truncated a warning will appear in the job log file as below:
avtar Warning <7374>: Flag --label="CYAHB_db7061_FTI_db7061_ftindex_01:2014-0416_10:45:13" (54 characters) exceeds maximum length of 48, truncated.
Administrators Guide
P a g e | 49
Appendix B
Glossary
This Guide uses some terms that are specific to Documentum or to traditional backup software. Weve
tried to define any potentially confusing terms here.
Connection Broker: The Connection Broker is a Documentum construct that handles communication
with the repositories. It was previously called the docbroker.
Repository: This is the term for the broadest Documentum organizational structure for containing data. It
was formerly called the docbase.
FTI: The Full Text Index server is responsible for indexing all content files for searchability. This is a
Documentum server, and can either be running the older FAST search engine or the newer xPlore search
engine software technologies.
FAST Older FTI Search Engine; will not be supported after December 31, 2011.
xPlore - Latest FTI Search Engine; replaces FAST.
Data Volume (NetWorker): This is a NetWorker organizational concept. Settings can be configured at
the Data Volume level on the NetWorker server.
Group Name (NetWorker): This is a NetWorker organizational concept. Settings can be configured at the
Group level on the NetWorker server.
Content Server: This is the main software server for Documentum. The content files reside on this
server, and there can be multiple Content Servers in a single environment. Typically, the Documentum
server software resides on the Content Server.
Storage Area: This is the term referring to the location of the content files on the Documentum Content
Server(s).
ICF: Installation & Configuration Files.
Policy Storage (NetBackup): This is a NetBackup organizational concept. Settings can be configured at
storage unit, storage lifecycle policy or storage unit group on the NetBackup server.
Policy Volume Pool (NetBackup): This is a NetBackup organizational concept. Settings can be
configured at Media/Volume Pools on the NetBackup server.
NDMP: The Network Data Management Protocol (NDMP) allows more efficient backups to be taken from
NAS devices that support this protocol by streaming the data to be backed up directly from the NAS
device to the backup server, instead of streaming it through an intermediate machine with a backup client
installed.
RMI: RMI stands for Remote Method Invocation. It is the Java API utilized by CYA HOTBackup for
communication between the Server and Client(s).
Administrators Guide
P a g e | 50
Appendix C
Sample Scripts
Sample scripts are provided for database backups, FTI quiesce operations, and FTI unquiesce
operations. A sample script is provided for all supported combinations of FTI servers, DB applications,
versions, backup software/versions and operating systems.
The sample scripts are located in [CYA_Deployment_Dir]/WEB-INF/samples, where
[CYA_Deployment_Dir] is the location where the CYA HOTBackup application was deployed into the
Application Server, i.e. on windows, D:\Program Files\Apache Software Foundation\Tomcat
6.0\webapps\cyahotbackup
To determine the correct database script to use, please use the outline on the following pages and make
the appropriate selection at each level.
Windows:
o NetWorker
Microsoft SQL
NetWorker module for SQL Server
o Use: nsrcya_db_mssql.bat
Microsoft SQL VSS
o Use: nsrcya_db_mssql_without_nm.bat
Oracle
NetWorker module for Oracle
o Use: nsrcya_db_oracle.bat
NetWorker module for Databases and Applications for Oracle
o Use: nsrcya_db_oracle_nmda.bat
Oracle RMAN
o Use: nsrcya_db_oracle_without_nm.bat
o NetBackup
Microsoft SQL
NetBackup Database Agent for SQL Server
o Use: nbcya_db_mssql.bat
Microsoft SQL VSS
o Use: nbcya_db_mssql_without_agent.bat
Oracle
NetBackup Database Agent for Oracle
o Use: nbcya_db_oracle.bat
Oracle RMAN
o Use: nbcya_db_oracle_without_agent.bat
o or Use: nbcya_db_oracle_template.bat
o TSM
Microsoft SQL
TSM Data Protection for SQL Server
o Use: tsmcya_db_mssql.bat
Administrators Guide
P a g e | 51
Oracle
TSM Data Protection for Oracle
o Use: tsmcya_db_oracle.bat
Oracle RMAN
o Use: tsmcya_db_oracle_without_DP.bat
UNIX/LINUX:
o NetWorker
Oracle
NetWorker module for Oracle
o Use: nsrcya_db_oracle.sh
Oracle RMAN
o Use: nsrcya_db_oracle_without_nm.sh
o NetBackup
Oracle
NetBackup Database Agent for Oracle
o Use: nbcya_db_oracle.sh
Oracle RMAN
o Use: nbcya_db_oracle_without_agent.sh
o or Use: nbcya_db_oracle_template.sh
o TSM
Oracle
TSM Data Protection for Oracle
o Use: tsmcya_db_oracle.sh
Oracle RMAN
Use: tsmcya_db_oracle_without_DP.sh
FAST
o
Windows:
Use: nsrcya_fti_q.bat for quiesce
Use: nsrcya_fti_u.bat for unquiesce
UNIX/LINUX:
Use: nsrcya_fti_q.sh for quiesce
Use: nsrcya_fti_u.sh for unquiesce
xPlore
o xPlore 1.0 - All the sample files are under the "xPlore_10" folder
o xPlore 1.1 and above - All the sample files are under the "xPlore_11" folder
Administrators Guide
P a g e | 52