CLI operation

You can create a DCM database definition representing another database in the DCM cluster. The database definition defines how DCM will transfer packages to that database, and if and how those packages can be automatically received. You must create a database definition before you can replicate any data to that database. The database definition should use a database identifier that matches the DCM database identifier of that database.

The Any database definition represents a special predefined database for producing broadcast packages. These are produced by a DCM generate and are received in any database with a compatible Rational Synergy version.

Before you begin

The current database must be initialized to use DCM.

You must be working as the DCM manager to use the -create option.

You must be working as the CM administrator to use the -automatic_receive and -noautomatic_receive options.

About this task

ccm dcm -c|-create -dbid|-database_id new_database_id 
       [-desc|-description description] 
       [-tm|-transfer_mode ((manual|manual_copy) | direct |
       (cp|copy|local_copy) | (rcp|remote_copy) | 
       (ftp|file_transfer_protocol) | (user|user_defined))] 
       ([-ar|-automatic_receive] | [-noar|-noautomatic_receive]) 
       ([-rb|-run_in_background] | [-norb|-norun_in_background]) 
       [-host host] [-os|-operating_system (unix | (windows|windows_nt))] 
       [-path path] [-tp|-transfer_path path] [-ccm_home ccm_home] 
       ([-zip] | [-nozip]) ([-ga|-generate_allowed] | 
       [-noga|-nogenerate_allowed]) ([-handover_allowed] | 
       [-nohandover_allowed]) ([-hidden] | [-nohidden]) 
       [-location location] [-admin_info admin_info]
-admin_info admin_info
Specifies the contact information for the database administrator. The admin_info value can be any string that does not contain newline characters. For example, phone numbers and email addresses are valid entries.
-ar|-automatic_receive
Specifies that after a DCM generate to this database, the transfer package will be received automatically. The default is -noar|-noautomatic_receive.
-ccm_home path
Specifies the Synergy $CCM_HOME installation path. Synergy uses this path to perform an automatic receive for packages generated for the database definition. Enter an absolute path if a UNIX server hosts the corresponding database. Enter a UNC path if a Windows server hosts it.
-dbid|-database_id new_database_id
Specifies the DCM database identifier for the new database definition. The new_database_id cannot be longer than 8 characters and must be unique in a DCM cluster. In a cluster using lowercase databases, identifiers should be unique without respect to case. For example, do not use "a" and "A" for two different definitions.

See DCM restrictions for details on naming restrictions for DCM databases.

-desc|-description description
Specifies a description of the database definition you're creating. The description cannot contain newline characters.
-ga|-generate_allowed
Specifies that the new database can use DCM generate. This is the default.
-handover_allowed
Specifies to give control of objects to the new database. The default is
-nohandover_allowed.
-hidden
Specifies to hide the new database definition in dialogs that list database identifiers.

The default is -nohidden.

-host host
Specifies the name of the machine hosting the database. This is required for the remote copy and file transfer protocol transfer modes. Be sure that the host name is valid and is set to an IP address.
-location location
Specifies the geographic location of the database (for example, Costa Mesa, California). The location can be any string not containing newline characters.
-noar|-noautomatic_receive
Specifies that after a DCM generate to this database, the transfer package should not be received automatically. The package must be received manually. This is the default.
-noga|-nogenerate_allowed
Specifies that the new database cannot use DCM generate. The default is
-ga|-generate_allowed.
-nohandover_allowed
Specifies not to give control of objects to the new database. This is the default.
-nohidden
Specifies to show the new database definition for dialogs that list database identifiers. This is the default.
-norb|-norun_in_background
Specifies not to run automatic receive in the background, if it is being used.

If you are using automatic receive, when DCM generate completes generating and transferring the package, it will start a session on the destination database to start the receive of the package. If you're using -norun_in_background, the generate waits for completion of the receive and shows the results of the receive in the destination database.

This is the default.

-nozip
Specifies that the transfer packages generated for the database will not be compressed. This is the default for the direct transfer mode. You cannot use this option with the file transfer protocol transfer mode.
-rb|-run_in_background
Specifies to run automatic receive in the background, if it is being used.

If you're using automatic receive, when DCM generate completes generating and transferring the package, it will start a session on the destination database to start the receive of the package. If you're using -run_in_background, the generate does not wait for completion of the receive and immediately returns. This means that you don't have to wait for the transfer package to be received to continue using your session, but you won't see if the receive was successful. You can view details of the receive later, in the DCM event log in the destination database.

The default is -norb|-norun_in_background.

-os|-operating_system (unix|(windows|windows_nt))
Specifies the operating system for the machine hosting the database.

The default is to use the same setting as the server for the current database.

-path path
Specifies the path to the database. Use an absolute path for UNIX servers; use a UNC path for Windows servers. This option requires a database path if you use a transfer mode other than manual.
-tp|-transfer_path transfer_path
Specifies the transfer path to the database. The transfer path is the location where transfer packages are placed. This is an absolute path for UNIX servers, and a UNC path for Windows servers. If you do not specify a transfer path or if you use an empty string, Synergy places the packages under the dcm/receive directory under the database path.
-tm|-transfer_mode value
Specifies the transfer mode to use for the new database definition. The default is manual. The transfer mode defines the way transfer packages are transferred to the destination database:

The transfer_mode option must have one of these values:

  • manual | manual_copy

    The package is not copied by DCM and will have to be manually transferred.

  • cp | copy | local_copy

    The package is generated and then copied to the transfer path for the destination database.

  • direct

    The package is generated directly into the transfer path for the destination database.

  • ftp | file_transfer_protocol

    The package is generated and then transferred to the transfer path for the destination database using ftp.

  • rcp | remote_copy

    The package is generated and then remote copied to the transfer path for the destination database using rcp.

  • user | user_defined

    The package is generated and then transferred by invoking a user-customized shell script (Unix) or batch file (Windows).

-zip
Specifies that the transfer packages generated for the database will be compressed. This is the default for all transfer modes except direct; you cannot use this option with direct.

Feedback