RADE

Source Code Manager

adl_mk_is_transfer

Creating an intersite transfer between two workspaces

Quick Reference

Abstract

The adl_mk_is_transfer command is an intersite command that is used for setting up an intersite transfer between the current workspace and a workspace of another SCM site. 


Synopsis

adl_mk_is_transfer [transfer_name] -r_is_server host:port | ( -r_is_server_host host -r_is_server_port port) -r_parent_ws remote_workspace [-r_tree ws_tree_name] [-tree local_ws_tree_name] [[-image image_name]|[-dir directory [-local_dir]]] [-no_mirror_ws] [-h | -help | -?]

Usage

The adl_mk_is_transfer command is the first command to be used for setting up an intersite transfer between two SCM sites.

The command takes in argument two workspaces (the current one and the one specified by the -r_ws option) and creates a new workspace right under the remote workspace (-r_ws).

The new workspace is called the remote mirror workspace or mirror workspace and the one specified by the -r_ws option becomes the remote parent workspace.

Once the command will be completed, the remote parent workspace won't be directly managed by other intersite commands. All commands (adl_attach_is, adl_sync_is, adl_promote_is, ...) will operate on the current workspace and the remote mirror workspace. The remote parent workspace will be the target workspace with which developments will be shared and to which local developments will be promoted.

With the "-no_mirror_ws" option, you can transfer all the modifications from the current workspace to the remote workspace without remote mirror workspace. Only the adl_mirror_is command is available. No mirror workspace is created on remote site.

Remote actions are performed by the SCM Multisite Transfer Manager which is specified by the -r_is_server_host and -r_is_server_port options.

Each time this transfer will be used, it will need to stored transfer specific information on the user file system. It is possible to choose between two locations:

If no directory is specified, the command will used the current working image for storing information.

In case of multitree workspace, the adl_mk_is_transfer command is to be used between the first couple of workspace tree (local tree, remote tree) and the adl_link_is_transfer [1] for the other workspace trees.

The existing transfers can be listed by using the adl_ls_transfer [2] command. 

[Top]

Options

adl_mk_is_transfer accepts the following options:

-h|-help|-? Help of the command
transfer_name Name of an existing transfer associated with the current local workspace
-r_is_server The remote SCM Multisite server host name and port number with the format host:port
-r_is_server_host Name or IP address of the remote host where the SCM Multisite Transfer Manager is running (see also "Routing Support")
-r_is_server_port ¨Port on which the remote SCM Multisite Transfer Manager is running (see also "Routing Support")
-attached_fw_mod Attach all internal modules and data components in the workspace hierarchy of attached frameworks
-r_parent_ws workspace_name Name of the remote workspace with which the transfer is to be set up.
-r_tree ws_tree_name To specify with which remote tree the transfer is to be set up.
This parameter can be omitted in case the remote workspace exists in only one tree.
-tree ws_tree_name To specify with which local tree the transfer is to be set up.
This parameter can be omitted in case the local workspace exists in only one tree.
-image image_name Name of one image of the current workspace that will be used for storing transfer specific files
-dir path Path to a directory that will be used for storing transfer specific files.
-local_dir To indicate that the directory specified by -dir option is local to the current host
-no_mirror_ws To indicate that a mirror workspace (child of remote workspace) is not created in remote site.

[Top]

Routing Support

When there is no direct connection possible between a client host and the remote SCM Multi-site Transfer Manager, for instance because this is forbidden by firewall rules, it is possible to use intermediate transfer managers between the client host and the final transfer manager. 

This is explained in the figure here after:

The adl_transfer_client  cannot join directly the host H3 where the transfer manager is listening on port XXX.

Connections can be made from host H1 to host H2 using port YYY.

In this case, we can start a SCM Multi-site transfer manager on port YYY on host YYY and ask the client to specify that transfers must be performed to host H3 through host H2.

There is no database nor file server to set up on host H2, we just need to install the SCM commands and to run the SCM Multi-site transfer manager using the port YYY. 

Here is the command to execute in order to declare a transfer to host H3 going through host H2 - note that only the parameters related to the remote transfer managers are shown here:

adl_mk_is_transfer my_transfer -r_is_server "H2:YYY#H3:XXX" ...
...

More than one intermediate SCM Multi-site transfer manager can be specified, the syntax is:

host1:port1#host2:port2#....#hostn:portn

where "host1:port1" is the first transfer manager to contact and "hostn:portn" is the last transfer manager, that is to say the one on which remote SCM commands will be executed.

[Top]

Examples

Creation of a transfer between the workspace "devlocal" and the remote workspace prjV5R7, the transfer information will be stored in the current image of the workspace "devlocal":

adl_ch_ws devlocal
...

adl_mk_is_transfer -r_is_server_host randdsy -r_is_server_port 23453 -r_parent_ws prjV5R7 -r_tree V5R7 -tree treelocal
Checking current workspace devlocal...
Checking remote workspace prjV5R7...
Creating mirror workspace under prjV5R7...
Registering the new intersite transfer between devlocal and prjV5R7 in local database.
 
Intersite command successful

 

Creation of the transfer "my_transfer" between the local workspace and the remote workspace prjv5R7, the transfer information will be stored in the directory E:\transfers: 

adl_mk_is_transfer my_transfer -r_is_server_host randdsy -r_is_server_port 23453 -r_parent_ws prjV5R7 -r_tree V5R7 -tree treelocal -dir E:\transfers -local_dir
...

[Top]


References

[1] adl_link_is_transfer: LInking an intersite transfer into a workspace tree
[2] adl_ls_transfer: Listing intersite transfers

[Top]


History

Version: 2 [Jan 2004] Document update : -no_mirror_ws option added
Version: 1 [Mar 2002] Document created

[Top]


Copyright © 2002, Dassault Systèmes. All rights reserved.