V11 SP8
Loading...

Configuring Documentum Databases Using the Command Line Interface

Table of Contents

Setting Up Oracle Database Instances Using XML Configuration Files

Creating a Documentum Oracle Database Instance Using the Command Line Interface

Use the command line interface to create the Documentum Oracle database instances. You can run a configuration operation from the command line, or automate the configuration by combining command-line operations in a script.

The CreateInstance_Template.xml configuration file is used as part of the qoperation command to pass the input arguments to the command-line parameters. You can specify the attribute values or instance settings in the XML file, or you can set them in the command-line parameters and options. For more information on command line parameters and XML elements, see Command Line - Syntax.

Before You Begin

To correctly set up the Full-Text Index (FTI) in the XML file, verify that FTI component is activated on the Documentum application.

Procedure

  1. On the Documentum Agent host, run the qlogin command to log on to the CommServe computer.
  2. Save the CreateInstance_Template.xml file to the computer where you will run the command.
  3. On the computer where you want to run the command, open the CreateInstance_Template.xml file, add the attribute values for the new instance, and save the file.

    For UNIX operating systems, you can specify the value of Storage Area (sa) and Full-Text Index (FTI) in your XML configuration file for any of the UNIX operating systems, as shown in the sample CreateInstance_UNIX.xml file.

    Similarly, you can create an XML configuration file for the Windows operating system by providing the correct values for sa and FTI components as shown in the sample CreateInstance_Windows.xml file.

    For information on supported instance XML elements, see XML Parameters for Documentum Instance Configuration.

  4. On the command line, go to Software_Installation_Directory/Base directory and type the following command, based on your operating system:
    • On Windows client

      qoperation execute -af CreateInstance_Template.xml -appName Documentum -clientName <client_name> -instanceName <instance_name> -description [command_description] -docbaseName <docbase_name> -docbaseVersion <docbase_version> -docbaseID <docbase_id> -documentumRepository/userAccount/domainName <domain_name> -documentumRepository/userAccount/userName <user_name> -documentumRepository/userAccount/password <password> -documentumSharedPath <shared_path> -documentumHomePath <home_path> -appType Oracle -ftiEnabled {true|false} -oraclesid <oracle_sid> -oracleProperties/userAccount/domainName <oracle_domain_name> -oracleProperties/userAccount/userName <oracle_user_name> -oracleProperties/userAccount/password <oracle_password> -oracleProperties/oracleHome <oracle_home_path> -ctrlFileAutoBackup 1 -connectString/userName <connect_user_name> -connectString/password <connect_password> -connectString/instance <connect_instance>

    • On UNIX client

      qoperation execute -af CreateInstance_Template.xml -appName Documentum -clientName <client_name> -instanceName <instance_name> -description [command_description] -docbaseName <docbase_name> -docbaseVersion <docbase_version> -docbaseID <docbase_id> -documentumRepository/userAccount/userName <user_name> -documentumRepository/userAccount/password <password> -documentumSharedPath <shared_path> -documentumHomePath <home_path> -appType Oracle -ftiEnabled {true|false} -oraclesid <oracle_sid> -oracleProperties/userAccount/userName <oracle_user_name> -oracleProperties/userAccount/password <oracle_password> -oracleProperties/oracleHome <oracle_home_path> -ctrlFileAutoBackup 1 -useCatalogConnect true -catalogConnect/userName <catalog_user> -catalogConnect/password <catalog_password> -catalogConnect/instance <catalog_instance> -connectString/userName <connect_user_name> -connectString/password <connect_password> -connectString/instance <connect_instance>

  5. Run the qlogout command to log off the CommServe computer.
Expand All

Creating an Instance with sys as the Connect String

To create instances with 'sys' as the database connect string, set the connectString parameter in the following command:

  • On Windows client

    qoperation execute -af CreateInstance_Template.xml -appName Documentum -clientName client1 -instanceName instance1 -description "instance created using xml" -docbaseName testrep1 -docbaseVersion "6.7.1000.0038 Win64.Oracle" -docbaseID 00000064 -documentumRepository/userAccount/domainName dmadmin -documentumRepository/userAccount/userName docadmin -documentumRepository/userAccount/password docadmin!12 -documentumSharedPath E:\Documentum\Shared -documentumHomePath E:\Documentum -appType Oracle -ftiEnabled true -oraclesid doctest -oracleProperties/userAccount/domainName dmadmin -oracleProperties/userAccount/userName docwin -oracleProperties/userAccount/password docwin!12 -oracleProperties/oracleHome E:\app\dmadmin\product\11.2.0\dbhome_1 -ctrlFileAutoBackup 1 -connectString/userName sys -connectString/password sys -connectString/instance doctest

  • On UNIX client

    qoperation execute -af CreateInstance_Template.xml -appName Documentum -clientName client1 -instanceName instance1 -description "instance created using xml" -docbaseName testrep1 -docbaseVersion "7.1.0000.0151 Linux64.Oracle" -docbaseID 00000064 -documentumRepository/userAccount/userName docadmin -documentumRepository/userAccount/password docadmin!12 -documentumSharedPath /home/docadmin/documentum/Shared -documentumHomePath /home/docadmin/documentum -appType Oracle -ftiEnabled false -oraclesid dctmdb -oracleProperties/userAccount/userName docwin -oracleProperties/userAccount/password docwin!12 -oracleProperties/oracleHome /database/oracle114/app/oracle/product/11.2.0/dbhome_1 -ctrlFileAutoBackup 1 -useCatalogConnect true -catalogConnect/userName cat -catalogConnect/password cat -catalogConnect/instance testcat -connectString/userName sys -connectString/password sys -connectString/instance dctmdb

Modifying a Documentum Oracle Database Instance Using the Command Line Interface

Use the command line interface to modify the Documentum Oracle database instance properties. You can run a configuration operation from the command line, or automate the configuration by combining command-line operations in a script.

The ModifyInstance_Template.xml configuration file is used as part of the qoperation command to pass the input arguments to the command-line parameters. You can specify the attribute values or instance settings in the XML file, or you can set them in the command-line parameters and options. For more information on command line parameters and XML elements, see Command Line - Syntax.

Procedure

  1. On the Documentum Agent host, run the qlogin command to log on to the CommServe computer.
  2. Save the ModifyInstance_Template.xml file to the computer where you will run the command.
  3. On the computer where you want to run the command, open the ModifyInstance_Template.xml file, add the attribute values to modify the instance, and save the file.

    For information on supported instance XML elements, see XML Parameters for Documentum Instance Configuration.

  4. On the command line, go to Software_Installation_Directory/Base directory and type the following command:

    qoperation execute -af ModifyInstance_Template.xml -appName Documentum -clientName <client_name> -instanceName <instance_name>

  5. Run the qlogout command to log off the CommServe computer.

Disabling Catalog Credentials from Documentum Instance Properties

qoperation execute -af ModifyInstance_Template.xml -appName Documentum -clientName client1 -instanceName instance1 -useCatalogConnect false

Setting Auto-Configure Control File to Not Configure

qoperation execute -af ModifyInstance_Template.xml -appName Documentum -clientName client1 -instanceName instance1 -useCatalogConnect false -ctrlFileAutoBackup 0

Setting Auto-Configure Control File to Configure Yes

qoperation execute -af ModifyInstance_Template.xml -appName Documentum -clientName client1 -instanceName instance1 -useCatalogConnect false -ctrlFileAutoBackup 1

Setting Auto-Configure Control File to Configure No

qoperation execute -af ModifyInstance_Template.xml -appName Documentum -clientName client1 -instanceName instance1 -useCatalogConnect false -ctrlFileAutoBackup 2

Updating Database Instance Detail as /

qoperation execute -af ModifyInstance_Template.xml -appName Documentum -clientName client1 -instanceName instance1 -useCatalogConnect false -ctrlFileAutoBackup 1 -connectString/userName /

Modifying Connect String as '/'

qoperation execute -af ModifyInstance_Template.xml -appName Documentum -clientName client1 -instanceName instance1 -useCatalogConnect false -ctrlFileAutoBackup 1 -connectString/userName / -connectString/password -connectString/instance

Modifying Block Size

qoperation execute -af ModifyInstance_Template.xml -appName Documentum -clientName client1 -instanceName instance1 -oracleProperties/blockSize 1048576

Modifying Home Path

qoperation execute -af ModifyInstance_Template.xml -appName Documentum -clientName client1 -instanceName instance1 -oracleProperties/oracleHome E:\app\dmadmin\product\11.2.0\dbhome_1

Modifying User Credentials on Windows

qoperation execute -af ModifyInstance_Template.xml -appName Documentum -clientName client1 -instanceName instance1 -oracleProperties/userAccount/domainName dmadmin -oracleProperties/userAccount/userName docadmin -oracleProperties/userAccount/password docadmin!12

Viewing the Properties of the Documentum Oracle Database Instance Using the Command Line Interface

Use the command line interface to view the Documentum Oracle database instance properties. You can run a configuration operation from the command line, or automate the configuration by combining command-line operations in a script.

Run the view command with the GetInstance_Properties_Template.xml to view the Documentum Oracle database instance properties to verify any changes that you made to the values.

The GetInstance_Properties_Template.xml configuration file is used as part of the qoperation command to pass the input arguments to the command-line parameters. You can specify the attribute values or instance settings in the XML file, or you can set them in the command-line parameters and options. For more information on command line parameters and XML elements, see Command Line - Syntax.

  1. On the Documentum Agent host, run the qlogin command to log on to the CommServe computer.
  2. Save the GetInstance_Properties_Template.xml file to the computer where you will run the command.
  3. On the computer where you want to run the command, open the GetInstance_Properties_Template.xml file, add the attribute values to view the instance, and save the file.

    For information on supported instance XML elements, see XML Parameters for Documentum Instance Configuration.

  4. On the command line, go to Software_Installation_Directory/Base directory and type the following command:
  5. qoperation execute -af GetInstance_Properties_Template.xml -appName Documentum -clientName <client_name> -instanceName <instance_name>

  6. Run the qlogout command to log off the CommServe computer.

Deleting a Documentum Oracle Database Instance Using the Command Line Interface

Use the command line interface to delete the Documentum Oracle database instance. You can run a configuration operation from the command line, or automate the configuration by combining command-line operations in a script.

The DeleteInstance_Template.xml configuration file is used as part of the qoperation command to pass the input arguments to the command-line parameters. You can specify the attribute values or instance settings in the XML file, or you can set them in the command-line parameters and options. For more information on command line parameters and XML elements, see Command Line - Syntax.

  1. On the Documentum Agent host, run the qlogin command to log on to the CommServe computer.
  2. Save the DeleteInstance_Template.xml file to the computer where you will run the command.
  3. On the computer where you want to run the command, open the DeleteInstance_Template.xml file, add the attribute values to delete the instance, and save the file.

    For information on supported instance XML elements, see XML Parameters for Documentum Instance Configuration.

  4. On the command line, go to Software_Installation_Directory/Base directory and type the following command:

    qoperation execute -af DeleteInstance_Template.xml -appName Documentum -clientName <client_name> -instanceName <instance_name>

  5. Run the qlogout command to log off the CommServe computer.

Setting Up Oracle Database Subclients Using XML Configuration Files

Creating a Documentum Oracle Database Subclient Using the Command Line Interface

Use the command line interface to create the Documentum Oracle database subclients. You can run a configuration operation from the command line, or automate the configuration by combining command-line operations in a script.

The CreateSubclient_Template.xml configuration file is used as part of the qoperation command to pass the input arguments to the command-line parameters. You can specify the attribute values or subclient settings in the XML file, or you can set them in the command-line parameters and options. For more information on command line parameters and XML elements, see Command Line - Syntax.

Before You Begin

  • To set up the FTI in the XML file, verify that the Full-Text Index (FTI) component is activated on the Documentum application.
  • Verify that the sa or the FTI components are not enabled on the default subclient before enabling the components in the user-defined subclient.

Procedure

  1. On the Documentum Agent host, run the qlogin command to log on to the CommServe computer.
  2. Save the CreateSubclient_Template.xml file to the computer where you will run the command.
  3. On the computer where you want to run the command, open the CreateSubclient_Template.xml file, add the attribute values for the new subclient, and save the file.

    For UNIX operating systems, you can specify the value of Storage Area (sa) and Full-Text Index (FTI) in your XML configuration file for any of the UNIX operating systems, as shown in the sample CreateSubclient_UNIX.xml file.

    Similarly, you can create an XML configuration file for the Windows operating system by providing the correct values for sa and FTI components as shown in the sample CreateSubclient_Windows.xml file.

    For information on supported subclient XML elements, see XML Parameters for Documentum Subclient Configuration.

  4. On the command line, go to Software_Installation_Directory/Base directory and type the following command:

    qoperation execute -af CreateSubclient_Template.xml -appName Documentum -clientName <client1> -instanceName <instance1> -subclientName <subclient_name> -enablebackup true

  5. Run the qlogout command to log off the CommServe computer.

Creating a Subclient with sa and FTI Components

  • On Windows client

    qoperation execute -af CreateSubclient_Template.xml -appName Documentum -clientName client1 -instanceName instance1 -subclientName subclient1 -enablebackup true -dbProperties/backupDB true -dataBackupStoragePolicy/storagePolicyName SP1 -logBackupStoragePolicy/storagePolicyName CS_SP -dbProperties/backupMode db_backup_online -backupSA true -backupFTI true -ftiProperties/preBackupProcess C:\cvxploreShutdown.bat -ftiProperties/postBackupProcess C:\cvxploreStartup.bat

  • On UNIX client

    qoperation execute -af CreateSubclient_Template.xml -appName Documentum -clientName client1 -instanceName instance1 -subclientName subclient1 -enablebackup true -dbProperties/backupDB true -dataBackupStoragePolicy/storagePolicyName SP1 -logBackupStoragePolicy/storagePolicyName CS_SP -dbProperties/backupMode db_backup_online -backupArchiveLog true -deleteArchiveLog false -backupSA true -backupFTI true -ftiProperties/preBackupProcess /documentum/fti_stop.sh -ftiProperties/postBackupProcess /documentum/fti_start.sh

Modifying a Documentum Oracle Database Subclient Using the Command Line Interface

Use the command line interface to modify the Documentum Oracle database subclient properties. You can run a configuration operation from the command line, or automate the configuration by combining command-line operations in a script.

The ModifySubclient_Template.xml configuration file is used as part of the qoperation command to pass the input arguments to the command-line parameters. You can specify the attribute values or subclient settings in the XML file, or you can set them in the command-line parameters and options. For more information on command line parameters and XML elements, see Command Line - Syntax.

Before running the command, edit the XML script to mention your machine storage area (sa) and FTI details.

  1. On the Documentum Agent host, run the qlogin command to log on to the CommServe computer.
  2. Save the ModifySubclient_Template.xml file to the computer where you will run the command.
  3. On the computer where you want to run the command, open the ModifySubclient_Template.xml file, add the attribute values to modify the subclient, and save the file.

    For information on supported subclient XML elements, see XML Parameters for Documentum Subclient Configuration.

  4. On the command line, go to Software_Installation_Directory/Base directory and type the following command:

    qoperation execute -af ModifySubclient_Template.xml -appName Documentum -clientName <client_name> -instanceName <instance_name> -subclientName <subclient_name>

  5. Run the qlogout command to log off the CommServe computer.

Assigning Storage Policy

qoperation execute -af ModifySubclient_Template.xml -appName Documentum -clientName client1 -instanceName instance1 -subclientName subclient1 - enableBackup true -dataBackupStoragePolicy/storagePolicyName SP1 -logBackupStoragePolicy/storagePolicyName SP2

Enabling Online Database File

qoperation execute -af ModifySubclient_Template.xml -appName Documentum -clientName client1 -instanceName instance1 -subclientName subclient1 - enableBackup true -dbProperties/backupMode db_backup_online -backupDB true

Enabling Backup Control File and Oracle System Parameter File

qoperation execute -af ModifySubclient_Template.xml -appName Documentum -clientName client1 -instanceName instance1 -subclientName subclient1 - enableBackup true -backupDB true -controlFileBackup true -spFileBackup true

Disabling Backup Data

qoperation execute -af ModifySubclient_Template.xml -appName Documentum -clientName client1 -instanceName instance1 -subclientName subclient1 - enableBackup true -backupDB false -controlFileBackup true -spFileBackup true

Enabling Offline Database File, Backup Control File and Oracle System Parameter File

qoperation execute -af ModifySubclient_Template.xml -appName Documentum -clientName client1 -instanceName instance1 -subclientName subclient1 - enableBackup true -dbProperties/backupMode db_backup_offline -backupDB true -controlFileBackup false -spFileBackup true

Disabling Backup Archive Log File, Oracle System Parameter File and Enabling Online Database File, Control File

qoperation execute -af ModifySubclient_Template.xml -appName Documentum -clientName client1 -instanceName instance1 -subclientName subclient1 - enableBackup true -dbProperties/backupMode db_backup_online -backupDB true -backupArchiveLog false -controlFileBackup true -spFileBackup false

Updating Log Only Backup

qoperation execute -af ModifySubclient_Template.xml -appName Documentum -clientName client1 -instanceName instance1 -subclientName subclient1 - enableBackup true -backupDB false -backupArchiveLog true -deleteArchiveLog false

Enabling Online Database, Log File, Control File and Storage Area

qoperation execute -af ModifySubclient_Template.xml -appName Documentum -clientName client1 -instanceName instance1 -subclientName subclient1 - enableBackup true -dbProperties/backupMode db_backup_online -backupDB true -backupArchiveLog true -deleteArchiveLog false - controlFileBackup true -spFileBackup true -backupSA true

Setting Storage Area Client and Streams in the Storage Device Tab of the Documentum Subclient Properties Dialog Box

<saClientStreams streams="1">
<saClient clientName="DOCWIN_cn"/>

qoperation execute -af ModifySubclient_Template.xml -appName Documentum -clientName client1 -instanceName instance1 -subclientName subclient1

Setting the Data Threshold Value

qoperation execute -af ModifySubclient_Template.xml -appName Documentum -clientName client1 -instanceName instance1 -subclientName subclient1 -dataThreshold true -noDataThresholdStreams 1

Viewing the Properties of the Documentum Oracle Database Subclient Using the Command Line Interface

Use the command line interface to view the Documentum Oracle database subclient properties. You can run a configuration operation from the command line, or automate the configuration by combining command-line operations in a script.

Run the view command with the GetSubclient_Properties_Template.xml to view the Documentum Oracle database subclient properties to verify any changes that you made to the values.

The GetSubclient_Properties_Template.xml configuration file is used as part of the qoperation command to pass the input arguments to the command-line parameters. You can specify the attribute values or subclient settings in the XML file, or you can set them in the command-line parameters and options. For more information on command line parameters and XML elements, see Command Line - Syntax.

  1. On the Documentum Agent host, run the qlogin command to log on to the CommServe computer.
  2. Save the GetSubclient_Properties_Template.xml file to the computer where you will run the command.
  3. On the computer where you want to run the command, open the GetSubclient_Properties_Template.xml file, add the attribute values to view the subclient, and save the file.

    For information on supported subclient XML elements, see XML Parameters for Documentum Subclient Configuration.

  4. On the command line, go to Software_Installation_Directory/Base directory and type the following command:

    qoperation execute –af GetSubclient_Properties_Template.xml -appName Documentum -clientName <client_name> -instanceName <instance_name> -subclientName <subclient_name>

  5. Run the qlogout command to log off the CommServe computer.

Deleting a Documentum Oracle Database Subclient Using the Command Line Interface

Use the command line interface to delete the Documentum Oracle database subclient. You can run a configuration operation from the command line, or automate the configuration by combining command-line operations in a script.

The DeleteSubclient_Template.xml configuration file is used as part of the qoperation command to pass the input arguments to the command-line parameters. You can specify the attribute values or subclient settings in the XML file, or you can set them in the command-line parameters and options. For more information on command line parameters and XML elements, see Command Line - Syntax.

  1. On the Documentum Agent host, run the qlogin command to log on to the CommServe computer.
  2. Save the DeleteSubclient_Template.xml file to the computer where you will run the command.
  3. On the computer where you want to run the command, open the DeleteSubclient_Template.xml file, add the attribute values to delete the subclient, and save the file.

    For information on supported subclient XML elements, see XML Parameters for Documentum Subclient Configuration.

  4. On the command line, go to Software_Installation_Directory/Base directory and type the following command:

    qoperation execute –af DeleteSubclient_Template.xml -appName Documentum -clientName <client_name> -instanceName <instance_name> -subclientName <subclient_name>

  5. Run the qlogout command to log off the CommServe computer.