MDM Example Project on Windows

The following guide shows you how to install and run the latest MDM example project on Windows. The example project provides a preconfigured environment for working through MDM tutorials.

For macOS instructions, see MDM Example Project on macOS.

Using Docker images to run the example project is available only from 16.3.1.

Step 1: Download PostgreSQL and Keycloak

Using plugins
Using Docker images

Use PostgreSQL and Keycloak plugins to easily deploy the services needed for the MDM example project.

The plugins are intended for demonstration purposes only and are not meant for production environments. By using these, you are accepting Keycloak and PostgreSQL licenses.

Keep in mind that the third-party software used in the plugins might not be up-to-date and might therefore pose a security risk.

Download MDM Example Project Plugins from the Support Service Desk.

Use PostgreSQL and Keycloak Docker images to easily deploy the services needed for the MDM example project.

The Docker images are intended for demonstration purposes only and are not meant for production environments. By using these, you are accepting Keycloak and PostgreSQL licenses.

Keep in mind that the third-party software used in the Docker images might not be up-to-date and might therefore pose a security risk.

Download MDM Example Project Plugins from the Support Service Desk.

Step 2: Download and extract builds

Download the corresponding build packages of MDM, MDM Server, and ONE Desktop from the Support Service Desk.

Extract packages

If using Docker images, create folders for and extract only MDM Server and MDM Web Application packages. PostgreSQL and Keycloak steps in this section are only relevant if using plugins to run the example project.

Unpack ONE Desktop.
In the ONE Desktop folder, create the following folders:
- mdm
- mdm-server
- keycloak
- pgsql
Extract the downloaded packages to these folders:
- mdm-assembly-xxxxx.zip to mdm
- mdm-server-assembly-xxxxx.zip to mdm-server
- keycloak-x.x.x-x-demo.zip to keycloak
- pgsql-xxx.zip to pgsql.
  
  Your folder structure should now look like this. This ensures the scripts in the example project Files > bin work without issues.
  
  Details

Step 3: Start the example project

Using plugins
Using Docker images

Start ONE Desktop.

For detailed instructions, see Install ONE Desktop.
When prompted to select your workspace, keep the default location. For the example to run, the workspace folder must be located in the ONE Desktop installation folder.
In the upper-right corner, switch to the ONE Desktop perspective.
In the Model Explorer, select New Model Project Wizard.
For the initial model, keep the default template (General MDM project - CDI example). Select Finish.
Once the project loads in the Model Explorer, navigate to Files/bin.
Start Keycloak and PostgreSQL:
1. Double-click start-keycloak.bat. Keycloak is ready once the following message appears:
  Keycloak ... started in <number> s. Listening on: \http://0.0.0.0:8083
2. Double-click start-db-postgres.bat.
Start MDM:
1. Double-click start-mdm-server.bat. The MDM Server is ready once the following message appears:
  Started MdmServerApplication in <number> seconds
  Keep the prompt windows running until you are done working with the example project. See Step 4: Stop the example project.
2. Double-click start-mdm.bat. The MDM Web Application is ready once the following message appears:
  Started MdaWebApplication in <number> seconds
Once everything starts, open one of the following in your browser:
- http://localhost:8050 — MDM Web Application
- http://localhost:8051 — MDM Web App Admin Center
Log in with the following credentials:
- Username: admin
- Password: admin

If you want to view logs related to the example project, the default logging file path is defined using the DEFAULT_JVM_OPTS property in the /mdm/bin/start.bat file.

Default value

"-Dlogging.file.path=./log" "-Dlogging.path=./log" "-Dplugins.path=./plugin" "-Dspring.config.additional-location=./etc/application.properties"

Start ONE Desktop.

For detailed instructions, see Install ONE Desktop.
When prompted to select your workspace, keep the default location. For the example to run, the workspace folder must be located in the ONE Desktop installation folder.
In the upper-right corner, switch to the ONE Desktop perspective.
In the Model Explorer, select New Model Project Wizard.
For the initial model, keep the default template (General MDM project - CDI example). Select Finish.
Once the project loads in the Model Explorer, navigate to Files/bin.
Start Keycloak and PostgreSQL. Navigate to the folder where you downloaded the Docker images and load them into your local Docker image store:
```
docker load -i kcWin.tar
docker load -i pg17Win.tar
```
If loading was successful, the following output appears:
```
Loaded image: harbor.ataccama.dev/one/keycloak:26.6.1-1
Loaded image: postgres:17
```
Run the PostgreSQL container:
```
docker run -d --name pg \
  -p 5432:5432 \
  -e POSTGRES_PASSWORD=Testtest1 \
  -v "path/to/downloaded-pg-init/pginit:/docker-entrypoint-initdb.d" \
  postgres:17
```
Replace path/to/downloaded-pg-init with the absolute path to your folder with downloaded package.

If the command was successful, the container ID is returned in response.

Run the Keycloak container:

docker run -d --name kc \
  -p 8083:8080 \
  -e KC_CLIENTS_REDIRECT_URIS_WILDCARDED=true \
  -e KC_CLIENTS_WEB_ORIGINS_WILDCARDED=true \
  -e KC_TEST_USERS_INCLUDED=true \
  -e KC_SSL_REQUIRED=NONE \
  harbor.ataccama.dev/one/keycloak:26.6.1-1 \
  start --db=dev-file

Verify that both containers are running:

docker ps

The expected output is as follows:

CONTAINER ID   IMAGE                                            CREATED              STATUS                PORTS                                       NAMES
6bcffaf2c5e2   harbor.ataccama.dev/one/keycloak:26.6.1-1       10 seconds ago       Up 10 seconds         0.0.0.0:8083->8080/tcp                      kc
a3c16a14aecc   postgres:17                                      About a minute ago   Up About a minute     0.0.0.0:5432->5432/tcp                      pg

Step 4: Stop the example project

When you are finished working with the MDM example project:

Using plugins
Using Docker images

Stop the MDM Server and Web Application by closing their prompt windows.
To stop Keycloak and PostgreSQL, navigate to the Files/bin folder in the Model Explorer:
1. Stop PostgreSQL by double-clicking stop-db-postgres.bat.
2. Stop Keycloak by double-clicking stop-keycloak.bat.

Stop the Docker containers by running:
```
docker stop kc
docker stop pg
```

Was this page useful?