Integrate with Deployment Automation

This topic provides instructions on how to set up the integration between Dimensions CM and Deployment Automation (DA).

Configure for Deployment Automation

To use Deployment Automation, modify the Dimensions CM dm.cfg configuration file.

Note: If you do a clean install of Dimensions CM with Deployment Automation, you do not need to change the dm.cfg configuration file. These steps are completed automatically when you run the installer. For details, see Install Dimensions CM.

To configure Dimensions CM to use Deployment Automation:

  1. Open the Dimensions CM configuration file:

    %installdir%/dm.cfg

  2. Add the following variables:

    Variable Description
    DM_SDA_URL

    Specifies the URL of the Deployment Automation server, for example:

    DM_SDA_URL %DM_WEB_URL%/da

    Tip: Multiple Dimensions CM servers can use the same DA server.
    DM_SDA_NOTIFY_TO_USER

    Specifies a Dimensions CM user ID that Deployment Automation uses to notify CM about the success or failure of automation runs, for example:

    DM_SDA_NOTIFY_TO_USER notifyusr

  3. Save changes to the dm.cfg file.

  4. Register the notification user account password in registry.dat specifying DM_SDA_NOTIFY_TO_USER (not a real user ID) as the first parameter:

    Copy code 
    dmpasswd DM_SDA_NOTIFY_TO_USER -add -pwd <password>

  5. Restart the Dimensions CM Listener.

Back to top

Authenticate with Deployment Automation

If you use single sign-on (SSO) to authenticate between Dimensions CM and Deployment Automation, verify that relevant CM users have privileges in DA to list applications, components, and processes and to run automations.

SSO between CM and DA is enabled by default if you do a clean install (not an upgrade) of both products at the same time.

If you are not using SSO, configure the integration to authenticate through the Deployment Automation service account.

To set up the authentication through the DA service account:

  1. Open the Dimensions CM configuration file:

    %installdir%/dm.cfg

  2. To specify the service account username for authenticating all integration actions, add this variable:

    Copy code 
    DM_SDA_USER <DA user ID>

  3. Save changes to the dm.cfg file.

  4. Register the service account password in registry.dat specifying DM_SDA_USER (not a real user ID) as the first parameter:

    Copy code 
    dmpasswd DM_SDA_USER -add -pwd <sda_user_password>

  5. Restart the Dimensions CM Listener.

Back to top

Map products to DA applications

After configuring the dm.cfg file and setting up authentication, map your Dimensions CM products Deployment Automation applications.

You can mix deployment models in the same base database. Some Dimensions CM products can use Dimensions deployment, while others can use DA.

To map a Dimensions CM product to a DA application:

  1. Log in to the Dimensions CM Administration Console and go to Product Administration > Product definitions.

  2. In the navigation pane, select a product.

  3. On the Product Details tab, click Edit.

  4. For Automation Application, select an DA application.

    A DA application brings together all the components that need to be deployed at the same time.

  5. For Default Process, select a default DA application process.

    An application process defines how to deploy, install, or interact with components. A process typically contains a sequence of interdependent steps and may include the automation of multiple components and complex logic based on conditions.

  6. Click OK.

Back to top

Map the GSL to DA environments

After you have mapped products to Deployment Automation applications, map stages in the Dimensions CM Global Stage Lifecycle (GSL) to Deployment Automation environments or a pipeline.

When you promote a baseline to a stage, the application process runs as follows:

  • Environment: in the mapped DA environment.

  • Pipeline: in the first DA environment in the pipeline.

To map the GSL to a DA environment or pipeline:

  1. Log in to the Dimensions CM Administration Console and go to Distributed Development > Areas & Deployment > Global stage lifecycle.

  2. Select the stage you want to map to Deployment Automation.

  3. On the toolbar, click Properties.

  4. In the Stage Properties dialog box, select an option for Deployment automation to:

    No Automation Do not map this stage to DA (automation doesn't happen when promotions are made to this stage).
    Pipeline Select a Deployment Automation pipeline. A pipeline is a sequence of environments where an application process runs.
    Environment Select a Deployment Automation environment where the deployment automation process runs when promoted to the corresponding stage.

  5. Click OK.

Back to top

See also: