Based on your environment, you might need to fine-tune your Documentum
instance or subclient. Following are the additional configurations that you can
use to configure this Agent.
In order to recover a database during the event of a failure or data loss, you
need to ensure that you always have the latest and consistent copy of the
Documentum Repository data. To do this, you need to plan and decide on the backups to
be performed. It is always recommended that you create separate subclients for each
of these backups.
Although you can re-configure the content of the Default
Subclient to backup specific objects, we strongly recommend against it because
this would disable the capability of the Default Subclient to serve as a
catch-all entity for client data, thus increasing the likelihood that some
data will not get backed up.
Splitting up storage areas across different subclients allows for complete
control of how often they are backed up. For example, you may want to backup
specific storage areas four times a day and backup the database at the end of
the day.
Therefore, a user-defined subclient must be created to specify only storage
areas that are separate from the database.
From the CommCell Browser, right-click the instance for which you want to create a new subclient, click All Tasks and then click New Subclient.
Click the General tab, type the name (up to 32 characters) of the subclient
that you want to create.
Click the Storage Area tab:
Select the Backup SA checkbox.
Click Add and enter the SA Name, Client, and
its SA Path in which the storage area resides.
Click the Storage Device tab:
Select a storage policy to associate with this subclient
from the storage policy list.
Click the Streams tab and configure streams for the storage
areas.
Click OK to save the subclient configuration.
Ensure that Backup FTI and Backup DB
are not selected in the Full Text Index and Database tabs.
In order to discover far stores and their associated clients in a distributed environment,
ensure that they are configured correctly.
Specifying only log files in a subclient allows you to back them up up more
frequently than backing up the entire database. Archive log backups enable you to recover database
transactions that have been lost due to an operating system or disk failure. You
can apply these archive logs to an online backup in order to recover a database.
Full backups generally includes both the data and logs. However, because of
their importance in recovering data, it is recommended that you create separate subclients for backing up archived log files.
From the CommCell Browser, right-click the instance for which you want to create a new subclient, click All Tasks and then click New Subclient.
Click the General tab, type the name (up to 32 characters) of the subclient that you want to create.
Click the Database tab:
Click Backup Archive Log.
Click the Storage Device tab:
Select a storage policy to associate with this subclient
from the storage policy list.
Click the Streams tab and configure streams for the log.
Click OK to save the subclient configuration.
Ensure that Backup FTI and Backup SA
are not selected in the Full Text Index and Storage Area tabs.
Offline backups are performed when the database is shut down and unavailable
for use. Offline backups are always full backups and do not include the archived log files.
In order to backup the database when it is offline, you need to create
a separate user-defined subclient for offline backup.
Make sure that the database used for creating the subclient is up and running. This ensures that the system accesses the most recent configuration of the database.
From the CommCell Browser, right-click the instance for which you want to create a new subclient, click All Tasks and then click New Subclient.
Click the General tab, type the name (up to 32 characters) of the subclient that you want to create.
Click the Database tab:
Select the Backup DB checkbox and click Offline Database.
Click the Storage Device tab:
Select a storage policy to associate with this subclient
from the storage policy list.
Click the Streams tab and configure streams for the database.
Click OK to save the subclient configuration.
Ensure that Backup FTI and Backup SA
are not selected in the Full Text Index and Storage Area tabs.
Including only full-text indexes in a subclient allows for complete control
of how often they are backed up. For example, you may want to backup full-text
indexes periodically.
Therefore, a user-defined subclient must be created to specify only full-text
indexes.
From the CommCell Browser, right-click the instance for which you want to create a new subclient, click All Tasks and then click New Subclient.
Click the General tab, type the name (up to 32 characters) of the subclient
that you want to create.
Click the Full Text Index tab:
Select the Backup FTI checkbox.
Click Add and enter the FTI Name, Client, and
its FTI Path in which the full-text index resides.
Click the Storage Device tab, select a storage policy to associate with this subclient from the storage policy list.
Click OK to save the subclient configuration.
Ensure that Backup DB and Backup SA
are not selected in the Database and Storage Area tabs.
Online backups are performed when the database is online. Data files are included when you back up
the database in online mode. Archived log files can also be included in the backup. These backups do not require database downtime and
are extremely useful when you need to perform a point-in-time restore of the
DB2 database.
You can perform a full or incremental backups when the database is online. In
order to backup the DB2 database when it is online, you need to create a
separate user-defined subclient for online backup.
Make sure that the database used for creating the subclient is up and running. This ensures that the system accesses the most recent configuration of the database.
From the CommCell Browser, right-click the instance for which you want to create a new subclient, click All Tasks and then click New Subclient.
Click the General tab and type the name (up to 32 characters) of the subclient that you want to create.
Click the Database tab:
Select the Backup DB checkbox and click Online Database.
Click Backup Archive Log (optional).
Click Delete Archive Log (optional).
Specify a Post Backup Process (optional).
Click the Storage Device tab:
Select a storage policy to associate with this subclient
from the storage policy list.
Click the Streams tab and configure streams for the database.
Click OK to save the subclient configuration.
Ensure that Backup FTI and Backup SA
are not selected in the Full Text Index and Storage Area tabs.
A selective copy allows you to copy backup data selectively from a source
copy to this copy, providing for better tape rotation. Since only selective
backups can be copied to selective copies, the selective copies cannot be
promoted to the primary copy, only synchronous copies can be promoted. Note that
the data selection process does not have to be the same for all auxiliary
copies.
During an auxiliary copy operation or a data protection operation that
creates an inline copy, only those backups from the primary copy that meet
certain criteria will be copied to a selective copy. You can define a selective
copy to be time-based, automatically selected, or automatically not selected on
the primary copy.
If the copy is defined as All Fulls, all full backups on the primary copy
will be copied during an auxiliary copy operation or a data protection operation
that creates an inline copy. If the copy is defined as time-based, only the
first or last full backup that occurs within each selected weekly, monthly,
quarterly, half-yearly, or yearly interval will be copied. You have the option
of creating and associating a custom calendar to the copy, so that the intervals
can be further customized.
Selective copy will not only copy Selective Online Full and Selective Offline
Full jobs, it will also copy regular Full jobs with the linked Log backup jobs.
From the CommCell Browser, right-click the storage policy for which
you wish to create the secondary copy, click All Tasks and then
click Create New Copy.
From the General tab of the Copy Properties dialog
box:
Enter the copy name in the Copy Name box.
Select the Selective Copy check box. The Selective
Copy tab is enabled.
Select the library, MediaAgent, drive pool and scratch pool from
the lists (drive pool and scratch pool are not applicable for disk
libraries).
Associate a subclient with the storage policy copy:
From the CommCell Browser, right-click the instance for which you want to
create a new subclient, click All Tasks and then click New Subclient.
Click the Subclient Properties (General) tab, type the name (up to
32 characters) of the subclient that you want to create.
Click the Subclient Properties (Content) tab to define the contents
of the subclient.
Click the Subclient Properties (Storage Device) tab and select a
storage policy copy to associate with this subclient from the storage policy list.
You can modify the configurable properties available for your agent from the agent, instance,
or subclient level as per need. For subclients, typically you modify configurable properties in a user-defined
subclient and not the default subclient.
It is recommended that that you do not modify the properties of an instance
or subclient when a job is in progress for that specific instance or subclient.
If a job is in progress, either wait for the job to complete or kill the job
from the Job Controller.
The following table describes the properties that can configured from the
agent and instance levels.
To modify these properties:
From the CommCell Browser, double-click the agent, instance, or
subclient you wish to modify.
Alternatively, you can also right-click the agent, instance, or subclient
and then click Properties.
Navigate to the tab containing the property you wish to modify.
To perform data protection and recovery operations, the Documentum
iDataAgent requires a user account to
log on to the related Documentum docbase to access the data. The user account is the Documentum Install owner
account that was used
to install the Documentum software.
The account must already be set up on the client.
You can change the
Documentum Repository user account details from the instance level.
From the Instance Properties (General) tab, click
Configure Password next to User Account.
In the Enter User Name and Password dialog box, type the
User Name and Password. Confirm the password as well.
Click OK to save your settings.
Click Discover. The Docbase name and User Name and Password
will be validated and the Storage Area and Full-text Indexes are
updated. If successful, the instance is changed and the Docbase
Version and Docbase Id are automatically populated.
Refer to
User
accounts and Passwords documentation for a comprehensive overview prior
to using this feature.
Change the Documentum Repository Instance
Name
You can change the instance name for a Documentum
Repository at the instance level.
To change the name of the Repository in the General tab:
Enter the name (up to 32 characters) for the instance in Docbase
Name.
Click Discover. The Docbase name and User Name and Password
will be validated and the Storage Area and Full-text Indexes are
updated. If successful, the instance is changed and the Docbase
Version and Docbase Id are automatically populated.
Change the Documentum Repository Paths
You can change the paths of the Documentum
Repository at the instance level.
To change the path names in the General tab:
Type the Repository installation path in the DOCUMENTUM Path
box or use Browse to locate the path.
Type the Repository shared path in the DOCUMENTUM_SHARED Path
box or use Browse to locate the path.
Type Repository home path in the DM_HOME Path box or use
Browse to locate the path.
Click Discover. The Docbase name and User Name and Password
will be validated and the Storage Area and Full-text Indexes are
updated. If successful, the instance is changed and the Docbase
Version and Docbase Id are automatically populated.
Change the Path to DB2 Home Directory
You can change the installation path of the
DB2 database at
the instance level.
To change the DB2 path in the Database tab:
From the Instance Properties (Database) tab, enter the path
to the DB2 installation directory in the Home field.
Click OK to save your settings.
Change the DB2 User Account
To perform data protection and recovery operations, the DB2
iDataAgents require a user account
with one of the following privileges to access the DB2 application and database:
Administration privileges (default)
DB2 database administration privileges
SYSADM, SYSCTRL, and SYSMAINT user group privileges
This account must already be set up on the client. Additional accounts should
be established by the DB2 database administrator. To establish additional
accounts on your own, consult the appropriate DB2 application documentation.
You can change the user account details from the instance level.
From the Instance Properties (Database) tab, click
Configure Password next to User Account.
In the EnterUser Name and Password dialog box, type the
User Name.
Click OK to save your settings.
Refer to
User
accounts and Passwords documentation for a comprehensive overview prior
to using this feature.
Change the Storage Area and Full-Text Index after Discovery
You can change the details of the Storage Areas and Full-Text
Indexes at the instance level. When Discover is selected in
the General tab, the Storage Areas and Full-Text Indexes are automatically
discovered and the displayed in the Storage Area and FTI tab.
To change the Storage Area or Full-Text Index details in the Storage
Area and FTI tab:
In Storage Area Details, select a file store that was discovered
and click Edit. In the Edit Operation dialog box,select
the Client name from the pulldown menu.
If a Full-text Index component is present, in FTI Details,
select the full-text index name that was discovered and click Edit.
In the Edit Operation dialog box,select the Client name
from the pulldown menu and type the FTI Path.
Storage Areas and Full-Text Indexes can also be deleted in the Storage
Area and FTI tab.
Select Full-Text Index to Backup
You can add, edit, or delete Full-Text
Index details at the subclient level to determine which ones are backed up.
Quiesce and UnQuiesce scripts can also be entered.
To change the Full-Text Index details in the Full Text Index tab:
Select the Backup FTI checkbox to enable or disable backing
up the Full-text Indexes.
To add a Full-Text Index, click Add and in the Add
Operation dialog box, enter the FTI Name, Client, and
its FTI Path in which the full-text index resides. Click Add.
To edit a Full-Text Index, select a file store and click Edit
and in the Edit Operation dialog box, enter the FTI Name,
Client, and
its FTI Path in which the full-text index resides.
To delete a Full-Text Index, select a file store and click Delete.
To specify a shutdown quiesce script, type the script in Full
Text Index Quiesce Script or click Browse to select it.
To specify a startup quiesce script, type the script in Full Text
Index UnQuiesce Script or click Browse to select it.
Click OK to save the subclient configuration.
Select DB2 Database Components to Backup
You can choose to backup the database
in offline or online mode and specify whether to include archived logs, in the backup. Pre and Post Backup scripts can also be entered.
To change the DB2 Database details in the Database tab at the
subclient level:
Select Backup DB checkbox to enable or disable backing up the
database in Online or Offline mode.
To include archive logs and deleted archive logs in the backup,
click Backup Archive Log and Delete Archive Log.
If applicable, to specify a pre backup process, type the script in Pre Backup
Process or click Browse to select it.
If applicable, to specify a post backup process, type the script in Post Backup
Process or click Browse to select it.
Click OK to save the subclient configuration.
Select Storage Areas to Backup
You can add, edit, or delete Storage
Areas (file store) details at the subclient level to determine which ones
are backed up. Pre and Post Backup scripts can also be entered.
To change the Storage Areas details in the Storage Area tab:
Select the Backup SA checkbox to enable or disable backing up
the Storage Areas.
To add a Storage Area, click Add and in the Add Operation
dialog box, enter the SA Name, Client, and
its SA Path in which the Storage Area resides. Click Add.
To edit a Storage Area, select a Storage Area and click Edit
and in the Edit Operation dialog box, enter the SA Name,
Client, and
its SA Path in which the Storage Area resides.
To delete a Storage Area, select a Storage Area and click
Delete.
To specify a pre backup process, type the script in Pre Backup
Process or click Browse to select it.
To specify a post backup process, type the script in Post Backup
Process or click Browse to select it.
Click OK to save the subclient configuration.
Create a New Index on Full Backup
At the Agent level, this option determines the default
behavior.
Use this option to generate an index of the data with each full
backup. This index provides quick access to the data during a browse or
restore operation. If cleared, all backups will build upon the index
from the previous backup.
To create a new index on a full backup:
From the Index tab, click Create new index on full backup.
Click OK to save your settings.
For more information about the Index and its use, see
Index.
Convert to Full Backup on Indexing Failures
At the Agent level, this option determines the default
behavior.
Use this option to create a new index and convert the next backup to
a full backup if the index is irretrievable. This index provides quick
access to the data during a browse or restore operation. If cleared, the
backup will fail if the index is irretrievable.
To create a new index and convert the next backup to a full if the
index is irretrievable:
From the Index tab, click Convert to full backup on
indexing failures.
Click OK to save your settings.
For more information about the Index and its use, see
Index.
Configure User Security
You can configure user security from the agent or instance
level.
You can perform the following functions:
Identify the user groups to which this CommCell object is associated.
Associate this object with a user group.
Disassociate this object from a user group.
From the Security tab of the associated Properties dialog
box at the Agent or instance, select the appropriate user groups to
which you want to associate to the CommCell object from the Available
Groups pane, and then move the user group to the Associated Groups
pane.
Click OK to save your settings.
Configure Activity Control
You can enable backup and restore operations from the agent and subclient level.
However, you can enable restore operations only from the agent level.
From the Activity Control tab of the associated Properties dialog
box for the instance or subclient, select or clear option(s), as desired.
Click OK to save your settings.
Refer to Activity
Control documentation for a comprehensive overview prior to using this feature.
View Software Version and Installed Updates
The Version tab, at the Agent level displays the
software version and post-release service packs and updates installed for
the component.
View Version of Documentum Repository
Once an application has been discovered, the version of the application on
which the iDataAgent was installed or
upgraded on the client computer is displayed. This can be particularly useful in
disaster recovery situations when you need to rebuild the environment.
To view the version of an application,
Right-click the instance and select Properties.
From the General tab, view the version of the application in the
Version field.
Click OK.
Rename a Subclient
You can rename an existing
subclient.
To rename a subclient,
From the General tab, type the new
name in the Subclient Name field.
Click OK to save your settings.
Change Storage Policies
You can modify the
storage policies in any of the following situations:
To include a different media for the backup operation.
To use a storage policy with a different retention criteria.
You can change the storage policies for command line backup and log
backup from the instance level.
Click Storage Device tab.
From the Data Storage Policy tab, select a data storage
policy to associate with this subclient.
Click OK to save your settings.
Configure Data Transfer Options
You can efficiently configure the available resources for transferring data secured
by data protection operations from the subclient level. This includes the following:
Enable or disable Data Compression either on the client or the MediaAgent.
Configure the transfer of data in the network using the options for Network
Bandwidth Throttling and Network Agents.
To configure data transfer options,
Click the Subclient Properties (Storage Device) tab, and select
Data Transfer Option tab.
From the Data Transfer Option tab, do the following:
Choose the appropriate compression option for this subclient.
Select Throttle Network Bandwidth to set the network bandwidth
settings.
Click OK
View Data Paths
You can view the data paths associated with the primary
storage policy copy of the selected storage policy or incremental storage
policy. You can also modify the data paths including their priority from
the subclient level.
From the Data Storage Policy tab, click Data
Paths to view the data paths used by the subclient to access the
storage media for data protection operations.
Set the Number of Streams
You can set the number of streams for database, log,
or Storage Area backup at the subclient level.
From the Storage Device tab:
Select the Streams tab.
Select the number of data streams for the Database Streams
field.
Select the number of log streams for the Log Streams
field.
Select the number of Storage Areas streams by selecting
a Storage Area and clicking Edit. In the Edit Operation dialog box,
use the spin boxes to set the number of streams.
Select Data Threshold and enter a number to specify whether
to run the backup job immediately when the total number of reserved
streams is greater than or equal to the value in this field.
Click OK to save your settings.
Refer to Streams documentation
for a comprehensive overview prior to using this feature.
Configure a Subclient for Pre/Post Processing of Data
Protection
You can add, modify or view Pre/Post processes for the
subclient. These are batch files or shell scripts that you can run before
or after certain job phases. You can also change the user account for running
Pre/Post processes for data protection operations of agents residing on
Windows platforms.
Consider the following before modifying the Pre/Post processes for the
subclient.
We recommend not configuring a pre/post process for a subclient
that is currently running a data protection or archive operation.
Verify that there are no pre/post processes already assigned for
the subclient.
Pre-process commands for the iDataAgents
will be executed only when the necessary resources (e.g., media, library,
drive, etc.) are available.
Click the Subclient Properties (Pre/Post Process) tab.
Click one of the following phases and type the full path of the
process that you want executed during that phase. Alternatively, click
Browse to locate the process (applicable only for paths that
do not contain any spaces).
PreBackup
PostBackup
Click OK.
If you want to run a post backup process for all attempts to run
that job phase, then select the Run Post Backup Process for all attempts
checkbox.
For subclients on Windows platforms, if Run As displays
Not Selected, or if you want to change the account that has permission
to run these commands, click Change.
In the User Account dialog box, select Use Local System
Account, or select Impersonate User and enter a user
name and password. Click OK.
If you selected Local System Account, click OK to the
message advising you that commands using this account have rights
to access all data on the client computer.
Refer to
Pre/Post Processes documentation
for a comprehensive overview prior to using this feature.
Enable/Disable Data Encryption
You can enable data encryption from the instance and subclient level. When accessing
the Encryption tab from the instance level, you are selecting either Network
and/or Media-side encryption for third-party Command Line operations. When accessing
this same tab from the subclient level, the settings selected apply only to the
selected subclient content for operations run from the CommCell Console.
Consider the following before enabling encryption:
Encryption must be enabled at the client level prior to configuring any
subclients residing on that client.
If you are attempting to configure for third-party Command Line operations,
enable data encryption from the instance level.
Encryption can be set from the Encryption tab of the associated Properties
dialog box at the instance and subclient level.
Refer to the
Data Encryption documentation for a comprehensive overview prior to using
this feature
The following sections describe the steps involved in deleting an instance or subclient.
When you delete an instance or subclient,
the associated data is logically deleted and you can no longer access the
corresponding data from CommCell Console for recovery purposes.
Consider the following before deleting an instance:
When you delete a specific instance all job schedules and job histories
that pertain to any of the levels within the deleted instance are deleted.
You cannot delete an instance if it is being backed up. Attempts to
delete an instance under such conditions cause the deletion to fail. If a
backup is in progress, either wait for the backup to complete or kill the
backup job using the Job Manager. Once the backup is no longer in progress,
you can delete the instance level.
You cannot delete an instance if there is only one instance present for
an agent. To delete the final instance, you must remove the agent
software from the client computer.
From the CommCell Browser, right-click the instance that you want to
delete, click All Tasks and then click Delete.
Click Yes to confirm the deletion. (Clicking No cancels
the deletion and retains the node.)
Type the requested phrase in the Enter Confirmation Text dialog
box and click OK. This should delete the instance.