Manage replication configurations for projects

This topic explains how to create replication configurations for projects and define replica sites to which to replicate projects.

Define replication configurations for projects

When you create a project replication configuration for the current DB site, you specify the project and branches to be replicated.

After defining the configuration, you can define the replica sites to receive the replicated project. When you run Replicator, it replicates the items that match the configuration to the replica sites.

To define a replication configuration for a project:

  1. In the Administration Console, go to Distributed Development > Replication administration > Replication configurations.

  2. In the navigation pane, select Project Primary from the list.

  3. On the toolbar, click New. The New Replication Configuration dialog box opens.

  4. On the General tab, enter a name for the configuration in the Configuration ID field, up to 25 characters.

  5. (Optional) In the Description field, enter your comment describing the configuration, up 240 characters.

  6. From the Primary Project list, select the project to replicate. To find a project, use the Filter field.

  7. Keep the option Is replication enabled to the replicas selected. This option enables the primary site to replicate items to the replica site.

  8. (Optional) Select the Branches tab, and select the named version branches to replicate.

    To replicate all named branches owned by the primary DB site, select <ALL_LOCAL_BRANCHES>.

    To replicate all named branches on the primary DB site, except those that are owned by the replica DB sites, select <ALL_NAMED_BRANCHES>.

    Note: These options are not supported for local replication. You must select the branches to be replicated to local replica sites.

  9. Click OK to create the configuration.

Back to top

Define replica sites for projects

After you define a project replication configuration, specify the replica projects to which to replicate items. You can also specify whether the replica site can replicate branches back to the primary site.

A replica site can be:

Local On the same machine that hosts the primary DB site.
Remote On a different machine on the Dimensions network that does not host the primary DB site.

To define a replica site for a project replication:

  1. In the Administration Console, go to Distributed Development > Replication administration > Replication configurations.

  2. In the navigation pane, select Baseline Primary from the list.

  3. From the Configurations list, select the configuration to which you want to add the replica site.

  4. In the Remote Replicas or Local Replicas section, click the Add button.

    Note: For a remote replica site, if you have not defined the appropriate remote replica network parameters on the primary site, you need to use the Administration Console > Network administration cluster tools before proceeding. For details, see Network administration.

  5. For a remote replica site, enter the following details, and click OK:

    Field Description
    Node name Select a remote network node from the list.
    DB Connection

    Select the connection string to use for connecting to the database server.

    If the list is empty, go to Administration Console > Network administration to add values for this field.
    Base Database

    Select the base database name.

    If the list is empty, go to Administration Console > Network administration to add values for this field.
    Project

    Specify the project into which to replicate the items. Enter the full project specification using the following syntax:

    <product-id>:<project-id>

    Is replication enabled for this replica

    This option specifies whether the primary site can replicate items to the replica site.

    By default, the replication is enabled.
    Is this online replication

    This option specifies if online or offline (air-gap) replication is used.

    Clear this option to use offline (air-gap) replication.
    Is replica replicating branches back to the primary

    Select this option to allow replication from the replica site back to the primary site.

    You may want to select this option only after you have established and tested replication from the primary to the replica site.

    If you selected this option, select the Branches tab and specify the named branches to replicate back to the primary site. By default, all named branches are selected.

  6. For a local replica site, enter the following details, and click OK:

    Field Description
    Project

    Select the local project to receive the replicated items from the primary site.

    To find a project, use the Filter field.
    Is replica replicating branches back to the primary

    Select this option to allow replication from the replica site back to the primary site.

    Initially, you may now want to select this option until you have established and tested replication from the primary to the replica site.

    If you selected this option, select the Branches tab and specify the named branches to replicate back to the primary site. By default, all named branches are selected.

  7. Restart the Dimensions Listener service.

Back to top

Modify project replication configurations

You can change the details of a project replication configuration or its replica sites.

Delete configurations or replica sites you no longer need.

To edit or delete a project replication configuration:

  1. In the Administration Console, go to Distributed Development > Replication administration > Replication configurations.

  2. In the navigation pane, select Baseline Primary from the list.

  3. From the Configurations list, select the configuration to edit or delete.

  4. To change the configuration details, click the Edit button in the General section, and make changes, as described in Define replication configurations for projects.

    To delete the configuration, click the Delete button on the toolbar, and confirm.

To edit or delete a replica site:

  1. In the Administration Console, go to Distributed Development > Replication administration > Replication configurations.

  2. In the navigation pane, select Baseline Primary from the list.

  3. From the Configurations list, select the configuration that contains the replica site you want to edit or delete.

  4. In the Remote Replicas or Local Replicas section, select the replica site.

    To change the replica site, click the Edit button and make changes, as described in Define replica sites for projects.

    To delete the replica site, click the Delete button and confirm.

Back to top

See also: