Introduction
Starting with DTP 2026.2, MongoDB is no longer included with Extension Designer. To continue using Extension Designer with DTP 2026.2 or later, you must deploy and configure your own standalone MongoDB server instance.
Using MongoDB version 8.x is recommended. Before continuing, make sure your own standalone MongoDB server instance is running. Deploying MongoDB contains a quick start guide to get you started if you need it.
If you have existing Extension Designer data from an embedded MongoDB instance (DTP 2026.1 or older), see Upgrading from 2026.1 or Older to migrate that data to your standalone MongoDB instance.
You can connect Extension Designer to your MongoDB server with a configuration file or by configuring environment variables, which is useful for containerized environments. Environment variables take precedence over the configuration file.
For New Installations
For new installations, follow this procedure:
- Deploy your own MongoDB server instance. See Deploying MongoDB to get started.
- Connect Extension Designer to the database by modifying a configuration file or configuring environment variables.
- Restart Extension Designer.
For Upgrades
For upgrades, follow this procedure:
- Deploy your own MongoDB server instance. See Deploying MongoDB to get started.
- If you are upgrading from DTP 2026.1 or older, see Upgrading from 2026.1 or Older to migrate the data to your own MongoDB instance.
- Connect Extension Designer to the database by modifying a configuration file or configuring environment variables.
- Restart Extension Designer.
Updating the Configuration File
You can update the parameters in the database-config.json file found in the <DTP_DATA_DIR>/dtpservices/shared/ directory.
{
"hostname": "localhost",
"port": 27017,
"username": "<username>",
"password": "<password>",
"authDb": "auth"
}
See the table in the Configuring Environment Variables section below for more information about the configuration elements.
Configuring Environment Variables
| Environment Variable | database-config.json Element | Description |
|---|---|---|
| DEP_DB_HOSTNAME | hostname | Specifies the hostname where the MongoDB instance is running. |
| DEP_DB_PORT | port | Specifies the port where the MongoDB instance is running. |
| DEP_DB_USERNAME | username | Specifies the username for authenticating the connection to the database. This variable is optional and should only be used when the database has authentication enabled. |
| DEP_DB_PASSWORD | password | Specifies the password for authenticating the connection to the database. This variable is optional and should only be used when the database has authentication enabled. Passwords must be encrypted using the |
| DEP_AUTH_DB | authDb | Specifies the database to use for authenticating the user. This variable is optional and should only be used when the database has authentication enabled. See MongoDB Authentication below for more information. |
MongoDB Authentication
MongoDB can be configured to run with authentication enabled or disabled. If authentication is enabled, you can use one of the following options to configure the user that Enterprise Pack uses to connect to MongoDB.
Option 1: Use the user with the root role
This option uses the MongoDB user with the root role. The default authentication database for this user is admin.
"username": "<root_username>", "password": <password>, "authDb": "admin"
Option 2: Create a user with the required roles
This option creates a MongoDB user with the readWrite role on each of the following databases:
- administration
- service-designer
- service
First, select the authentication database in which to create the user. For example, to use the user-database as the chosen authentication database, you would enter:
use user-database
Then, create the user with the required roles as in the following:
db.createUser({
user: 'enterprise-pack',
pwd: passwordPrompt(),
roles: [
{ role: 'readWrite', db: 'administration' },
{ role: 'readWrite', db: 'service-designer' },
{ role: 'readWrite', db: 'service' }
]
})
In this example, the user enterprise-pack is created in user-database and granted read and write access to the three databases required by Enterprise Pack.
"username": "enterprise-pack", "password": <password>, "authDb": "user-database"
Logging
The main.log file keeps track of DB connections. See Viewing Log Files for additional information.
[2026-10-19T14:41:19.833] [DEBUG] main - Database configuration loaded from C:\ProgramData\Parasoft\DTP\dtpservices\shared\database-config.json
[2026-10-19T14:41:19.835] [INFO] main - Validating database configuration
[2026-10-19T14:41:19.835] [INFO] main - Database configuration is in a valid format
[2026-10-19T14:41:20.428] [DEBUG] main - Opening new connection to database: mongodb://localhost:27017/administration {}
[2026-10-19T14:41:20.429] [DEBUG] main - [1] Connecting to database: mongodb://localhost:27017/administration
[2026-10-19T14:41:22.728] [INFO] main - Configured number of access log backups to retain: 90
[2026-10-19T14:41:22.728] [DEBUG] main - Opening new connection to database: mongodb://localhost:27017/administration {}
[2026-10-19T14:41:50.449] [ERROR] main - MongooseServerSelectionError: connect ECONNREFUSED 127.0.0.1:27017, connect ECONNREFUSED ::1:27017
[2026-10-19T14:47:40.573] [DEBUG] main - Database configuration loaded from C:\ProgramData\Parasoft\DTP\dtpservices\shared\database-config.json
[2026-10-19T14:47:40.574] [INFO] main - Validating database configuration
[2026-10-19T14:47:40.574] [INFO] main - Database configuration is in a valid format
[2026-10-19T14:47:40.830] [DEBUG] main - Opening new connection to database: mongodb://localhost:27017/administration {}
[2026-10-19T14:47:40.831] [DEBUG] main - [1] Connecting to database: mongodb://localhost:27017/administration
[2026-10-19T14:47:43.099] [INFO] main - Configured number of access log backups to retain: 90
[2026-10-19T14:47:43.099] [DEBUG] main - Opening new connection to database: mongodb://localhost:27017/administration {}
[2026-10-19T14:47:43.112] [DEBUG] main - [1] Connected to database: mongodb://localhost:27017/administration
[2026-10-19T14:47:43.112] [DEBUG] main - [1] Database connection is open: mongodb://localhost:27017/administration
