Configure Desktop Client Connections

You can configure how users connect to OpenText Dimensions CM from the desktop client by defining connection profiles and controlling the login dialog behavior.

Overview

Desktop client connection configuration provides administrators with centralized control over the following aspects:

  • Predefined connection profiles that simplify server access for end users.

  • Control over whether users can create custom connections beyond predefined profiles.

  • Standardized connection string formatting displayed to users.

  • Choice between the new login wizard and the legacy login dialog.

Back to top

Configure connection profiles

The connect_config.xml file (at %DM_ROOT%/dfs/connect_config.xml) defines the desktop client connection profiles that the DmPool RPC service returns to users, giving administrators centralized control over how users connect.

This configuration enables administrators to:

  • Centrally manage connection profiles.

  • Control whether users can create custom connections.

  • Standardize connection string formatting.

  • Provide predefined server configurations for end users.

The connect_config.xml file contains the following main elements:

Element Type / Default Description
AllowCustomConnection String (Y/N) Controls whether users can create custom connections beyond predefined profiles. Y allows custom connections; N restricts to predefined profiles only. Default Y if missing or invalid.
ConnectionFormat String Template shown as a hint when selecting profiles. Variables: {protocol}, {server}, {port}, {db-name}, {db-con}. Common formats: {protocol}://{server}:{port}/{db-name}@{db-con}; {db-name}@{db-con} (default); {server}:{port}/{db-name}; empty for no hint. Default {db-name}@{db-con} if missing or invalid.
Connections Container Holds one or more <Connection> elements defining profiles.

Connection profiles

Individual connection profiles are defined within the <Connections> container element. Each <Connection> element has the following attributes:

Element Required Description
<name> Yes Display name for the connection profile (for example, default, Production Server, Test Environment)
<protocol> Yes Server communication protocol: SDP, SSDP, HTTP, or HTTPS
<server> Yes Server hostname or IP address (for example, dm-server.company.com, 192.168.1.100)
<port> Yes Server port number. Common values: 671 (default SDP port), 443 (default HTTPS port), 80 (default HTTP port)
<db-name> Yes Database name on the OpenText Dimensions CM server (for example, cm_typical, production_db, test_db)
<db-con> Yes Database connection identifier (for example, dim14, production, test)

Example configuration

The following example shows a complete connect_config.xml file with multiple connection profiles:

Copy code
<ConnectConfig>
    <AllowCustomConnection>N</AllowCustomConnection>
    <ConnectionFormat>{protocol}://{server}:{port}/{db-name}@{db-con}</ConnectionFormat>
    <Connections>
        <Connection>
            <name>Production Server</name>
            <protocol>ssdp</protocol>
            <server>dm-prod.company.com</server>
            <port>671</port>
            <db-name>cm_production</db-name>
            <db-con>production</db-con>
        </Connection>
        <Connection>
            <name>Test Environment</name>
            <protocol>https</protocol>
            <server>dm-test.company.com</server>
            <port>443</port>
            <db-name>cm_test</db-name>
            <db-con>test</db-con>
        </Connection>
    </Connections>
</ConnectConfig>

Back to top

Configure login wizard behavior

The FALLBACK_TO_OLD_LOGIN flag in the dm.cfg file controls which login wizard the desktop client uses. This server-side configuration determines whether the client shows the new login wizard or falls back to the legacy login dialog after the first successful login.

The dm.cfg file is located in %DM_ROOT% on the OpenText Dimensions CM server.

Flag details

  • Flag: FALLBACK_TO_OLD_LOGIN

  • Purpose: Decide whether the client should continue with the new login wizard or fall back to the legacy login wizard after the first successful login.

  • Values (case-insensitive): Y, Yes, 1, True are treated as true; N, No, 0, False are treated as false; missing means not present.

  • Client persistence: After the first login, the client stores the interpreted flag value in the Windows registry to determine behavior on subsequent logins.

Behavior scenarios

Scenario Behavior
Flag not present
  • The new login wizard is shown on first login.

  • The new login wizard continues to be shown on subsequent logins.

  • The absence is recorded as not forcing a fallback.

Flag present and true (Y / Yes / 1 / True)
  • The new login wizard is shown on first login.

  • The client records a "fallback enabled" state in the registry.

  • The legacy login wizard is shown on subsequent logins.

Flag present and false (N / No / 0 / False)
  • The new login wizard is shown on first login.

  • The new login wizard continues to be shown on subsequent logins.

  • If the flag was previously set to true, the registry updates to reflect the new false value.

Configuration examples

Add one of the following lines to the dm.cfg file in %DM_ROOT%:

  • Use legacy login wizard from second login onward: FALLBACK_TO_OLD_LOGIN=Yes

  • Always use the new login wizard: FALLBACK_TO_OLD_LOGIN=No

  • Default to new login wizard (flag omitted): # (no entry)

Note: This flag affects the desktop client login experience only. It does not change authentication backends or credentials storage.

Back to top

See also: