Connecting an Environment to Deployment Server

Prev Next

Overview

This document demonstrates how administrators can connect any Decisions Server (Development/QA/Production Environment) to a Deployment Server. The connection uses a secure, key-based authentication model for server-to-server communication. Authentication keys are generated on the Deployment Server and configured on each target environment during registration, improving the security and reliability of cross-environment communication.

Prerequisites:
  • Already installed the Deployment Server. 
  • Copy the Deployment Server's Portal Base URL for future reference.
  • Already configured the Organization in the Deployment server.
Breaking change
Environments registered using the previous (Beta) authentication model must be re-registered with the Deployment Server to continue working. To re-register, follow the steps in this article and select Re-register with Deployment Server in System > Settings > Deployment Server Connection Parameters.

Connect to the Deployment Server

The following subsection explains how to connect Decisions with the Deployment server. After these settings are configured and saved, the Deployment server will be connected.

  1. Generate an Authentication Key in the Deployment Server: In the Deployment Server, navigate to the required Organization, right-click the Organization folder, and select Start Registering Environment. Copy the generated Authentication Key.
    Notes:
    • The Authentication Key is valid for 10 minutes.
    • One key = one instance. The key expires once the instance is connected. Generate a new key for each environment registered (Development/QA/Production).
  2. In the environment to connect (Development/QA/Production), navigate to System > Settings > Deployment Server Connection Parameters
  3. Right-click Deployment Server Connection Parameters and select Register (or Re-register with Deployment Server, if the environment was previously connected. Re-registration is required for environments connected using the previous (Beta) authentication model).
  4. In the registration dialog:
    • Enter the Environment Name.
    • Select the Environment Type (Development/QA/Production).
    • Under Deployment Server Address, paste the Deployment Server's Portal Base URL.
    • Paste the copied Authentication Key into the Authentication Key field.
  5. Click Register
  6. After registering, verify the connection by navigating to the project level and selecting the Check-in action. If the connection is successful, the Check-in dialog will appear, displaying all entities available for check-in.

Common Troubleshooting Points

  1. Ensure the Deployment Server URL entered in the Deployment Server Connection Parameters settings is correct.
  2. Ensure the Deployment Server is reachable and actively running. If the server is unreachable, please contact your IT administrator.
  3. Ensure to use HTTPS in the URL in the Deployment Server Connection Parameters settings if the deployment server is configured with a secured connection.

For further information on Repository, visit the Decisions Forum.