Define a remote instance

  • Release version: Zurich
  • Updated July 31, 2025
  • 1 minute to read
  • For each instance, define other instances in the hierarchy as remote instances.

    Before you begin

    Role required:
    • admin role on the instance you’re registering.
    • teamdev_user role on the instance you’re registering.

    About this task

    This example demonstrates how to set up a remote instance for subdevelopment instances.

    Procedure

    1. If IP address access control is enabled, log in to the remote instance and add the subdevelopment instance as an exception.
    2. On the subdevelopment instance, navigate to Team Development > Remote Instances.
    3. Select New.
    4. Define the remote instance, such as the parent development instance, by completing the form.
    5. Fill in the form.
      Table 1. Remote instance form
      Field Description
      Name Enter a unique name describing the instance.
      Type Specify whether the remote instance is a development, test, or UAT instance.
      Active Specify whether the local instance communicates with the remote instance as a member of Team Development.
      Note:
      Team Development operations such as comparing changes between instances or selecting a parent instance are only available for active remote instances.
      URL Specify the URL of the remote instance using the appropriate transfer protocol. Each remote instance record should have a unique URL.
      Note:
      Creating duplicate records with the same URL can cause errors.
      User name Enter the user on the remote instance who authorizes Team Development operations on the instance.
      Note:
      This user account must have an appropriate role on the remote instance.
      Password Enter the password of the authorizing user.
      Short description

      Enter any other relevant information about the remote instance.

    6. Select Submit.
    7. Repeat step 1 through step 5 for each instance in the hierarchy that this instance interacts with.