Register your Project with DMC

Connecting your client to the Deployment Monitoring Console (DMC) database allows the DMC to detect the status of each pipeline step and all performed operations to make information and reports available through the browser.

Uses

Connecting to the DMC database gives you access to your pipeline data within the DMC WebApp. You would typically connect to the DMC database to include status and operational reports associated with projects, pipelines, and steps you are managing in the DMC WebApp.

Connecting to the internal Datical demo database

To connect to the internal Datical demo database, you can find connection credentials and instructions on the Client Connect page in the WebApp.

Image of the Client Connect Navigation Selector

Connecting to an external database

To connect to your external database, you can find connection details and instructions on the Client Connection page in the WebApp.

Image of the Client Connect left navigation selector

Note: For external databases, contact your database administrator to get the external database password.

Where are the DMC database credentials stored?

The DMC stores these credentials in two places:

  1. In the web server.
  2. On the client side in Eclipse and the Command Line Interface (CLI).

Connecting your project

To connect your project to the DMC database you must register your project through the desktop client or through the CLI.

Note: You will need to have the PostgreSQL JDBC driver installed if you have not already done so!

Desktop client

To connect your project using the desktop client:

  1. Navigate to Project Settings.
  2. Expand DMC database settings.
  3. Enter the information provided in the Connection details section above.
  4. Test the connection.
  5. Confirm and Exit.

Your project will automatically be imported and visible to all system administrator roles in the DMC.

Command line

The process for using the command line differs depending on whether you want to use stored credentials or runtime credentials for your DMC DB

Command line instructions for Stored Credentials

To connect your project using the command line, use the newDbDef hammer command to create the DMC dbDef. Then use the registerprojectwithdmcdb hammer command to register your project.

  1. Run these commands from your project directory.

Note: Replace the items in <> with your actual values:

$ hammer newDbDef DbDefClass PostgresqlDbDef name DMC hostname <YourHostname> port <YourPort> username <YourUsername> password <YourPassword> database datical dbDefType dmcdb
  1. Next, register the project with DMC DB
$ hammer registerprojectwithdmcdb

Command line instructions for Runtime Credentials

To connect your project using the command line, use the newDbDef hammer command to create the DMC dbDef. Then use the registerprojectwithdmcdb hammer command to register your project.

  1. Run these commands from your project directory.

Note: Replace the items in <> with your actual values:

$ hammer newDbDef DbDefClass DelayedCredentialPostgresDbDef name DMC hostname <YourHostname> port <YourPort> username <YourUsername> password <YourPassword> database datical dbDefType dmcdb
  1. Next, register the project with DMC DB
$ hammer registerprojectwithdmcdb
  1. Define these two environment variables with your credentials:

DDB_DMCDB_USER

DDB_DMCDB_PASS

  1. Edit your datical.project file. Find the dmcDB line, which starts like this:

<dmcDB xsi:type="dbproject:DelayedCredentialPostgresDbDef"

  1. Remove the username and password from the dmcDB line.

Example: username="<YourUsername>" password="<YourPassword>"

  1. After you have removed the dmcDB credentials from your datical.project file, commit the modified project file to source control (such as git).

Related links