Database Mapper Configuration Utility
Prerequisites
Before installing Database Mapper Software, ensure your credentials and machine(s) meet the System Requirements as well as the security and additional requirements listed below.
Additional Requirements
- Chrome and Microsoft Edge (the Edge version based on Chromium) are the recommended browsers for using Database Mapper Software.
- Note: Only Windows devices are officially supported.
- The preferred IP address and port that Database Mapper software should use to listen for HTTP traffic.
Important:
For Version 2022.3 and later, the default ports for Database Mapper are as follows:
- The default port for the Database Mapper Software Host is 80.
- The default port for the Database Mapper Host with HTTPS is 443.
- The default port for the Database Mapper Software API is 5000.
For Versions 2022.2 and prior, the default ports for Database Mapper are as follows:
- The default port for the Database Mapper Software Host is 44302.
- The default port for the Database Mapper Software API is 44322.
- If you plan to change the binding address or port, ensure that there isn't already something listening to that address and port on the machine.
- If you are running Database Mapper Software on a virtual machine, it's recommended to keep the default IP address of 0.0.0.0. Setting it to 127.0.0.1 may make it so that it can be accessed from the local host, but not other locations in the domain.
- It's recommended to set the IP address to 127.0.0.1 if you're planning to route requests through IIS or other reverse proxy on the same machine as the service. This will prevent external requests from directly reaching the service.
Database Mapper Software Configuration Utility
Changes to your Database Mapper Software configuration must be made through the Database Mapper Configuration Utility (DMCU).
Installing the DMCU
The Database Mapper Configuration Utility is installed through the Database Mapper Software Installer.
Accessing the DMCU
Database Mapper Software
After installing Database Mapper Software, the Database Mapper Configuration tool is set to launch by default. You can also locate the DMCU through the file directory or use the Windows Start menu as Database Mapper Configuration Utility . When you open the DMCU, use the Run as administrator option to open it.
File path:
- Navigate to the SentryOne DocumentConfigUtility directory in your Database Mapper Software installation. The default path is C:\Program Files (x86)\SentryOne\SentryOne Document\SentryOneDocumentConfigUtility. In this example, we are using the default file path.
- Locate the SentryOne.Document.WebClient.ConfigurationUtility file and use the Run as administrator option to open it.
Using the DMCU
The DMCU allows you to change database, network, security, and web server binding-related properties for Database Mapper Software. Select Next to apply any changes and continue with the configuration process.
The DMCU also provides an option to stop/start the Database Mapper Host and API Services (Database Mapper Host and Database Mapper API in Windows Services).
Important: If the Database Mapper Services failed to install, open the Event Viewer for more information.
Start here
The Start here screen opens when you open the Database Mapper Configuration Utility for the first time on a new installation. The Start here screen details that the Database Mapper Configuration Utility will install a new Database Mapper database on your SQL Server Instance, a Host service, and an API service.
Select Start to continue.
Repository Configuration
Configure your SQL Server connection that will contain the Database Mapper database on the Repository Configuration screen.
| Option | Description |
|---|---|
| Server | The Server name where Database Mapper software is installed. |
| Database Name | The Database name for your Database Mapper software installation. Note: The Database Name is SentryOneDocument by default. |
| Username | The login used for the Database Mapper Remote Agent service. |
| Password | The password for the Database Mapper Remote Agent service login. |
| Windows Login / SQL Login | The Windows or SQL Server credentials for the server where Database Mapper Software is installed. |
Advanced Options
Select Advanced Options to open the advanced configuration options for your SQL Server that will contain the Database Mapper database.
| Option | Description |
|---|---|
| Port | The port used to connect to your SQL Server that will contain the Database Mapper database. |
| Packet Size | The network packet size for your Database Mapper database connection. Select an option from the drop-down list. |
| Encrypt Network Traffic | Select the checkbox to encrypt network traffic. |
| Trust Server Certificate | Select the checkbox to trust the server certificate. |
| Multi Subnet | Select the checkbox to apply multi subnet to the connection. |
Additional Information: For more information about the settings in the Advanced Properties:
- Port: See the Setting the Connection Properties topic from Microsoft Docs for more information on the portNumber property.
- Packet Size: See the Configure the network packet size Server Configuration Option topic from Microsoft Docs for additional information on SQL Server network pack sizes.
- Encrypt Network Traffic: See the Enable Encrypted Connections to the Database Engine topic from Microsoft Docs.
- Trust Server Certificate: See the Setting the Connection Properties topic from Microsoft Docs for more information on the trustServerCertificate property.
- Multi Subnet: See the Setting the Connection Properties topic from Microsoft Docs for more information on the multiSubnetFailover property.
Windows Service Account
Configure the Windows service account that will be used with the Host and API services on the Windows Service Account screen.
| Option | Description |
|---|---|
| Username | The username for the hosting service. |
| Password | The password for the hosting service username. |
| IP |
The binding IP address for your connection. Use the drop-down list to select an IP address. |
| Host Domain | The friendly name (web server address) of the host domain. Important: The Host Domain field will determine your Database Mapper Web URL. For example, if your Database Mapper site will be connected locally with localhost like the example above, you will use localhost in the URL. If you want your Database Mapper site to be accessible outside of the host machine, enter the host machine name. For example, if the host machine name is AppServer23, you would enter AppServer23 in the Host Domain field. |
Advanced Options
Select Advanced Options to open the advanced configuration options for your Windows Service account that will be used with the Database Mapper Host and API services.
| Option | Description |
|---|---|
| API Port | The port used to connect to the API Service. Note: The default API Port is 5000. |
| Host Port | The port used to connect to the Host Service. Note: The default Host Port is 80. |
| Use HTTPS | Select the checkbox to Use HTTPs and enter a TLS certificate. Note: The default Host Port if you select to use HTTPS is 443. |
Use TLS
To use TLS for SolarWinds Database Mapper:
- Select the box next to Use HTTPS. Once selected, you'll see the TLS Certificate section.
- Enter the name of the certificate in Subject.
- Select Next to continue with the Database Mapper configuration.
Success: You have enabled TLS for SolarWinds Database Mapper. Use HTTPS:// at the beginning of the URL to open it in your browser.
Note:
- For a signed certificate from a trusted authority, you must register it on the machine so it goes into the LocalMachine/My store.
- Additional Information: See the System Store Locations and Local Machine and Current User Certificate Stores articles on Microsoft Docs for details.
- When updating a certificate, you need to add it to the machine. Database Mapper will use the latest valid certificate (by expiration date) without requiring a restart of the machine or service. Older, invalid, and expired certificates will be ignored.
Review
The Review screen displays your configured options for your Database Connection and Hosting Connection.
Services
The Services screen displays after you've completed your configuring Database Mapper Software. The Host Service and API Service are installed automatically after configuration, and can be started/stopped from this screen.
| Options | Description |
|---|---|
| Host Service status: | Displays the current status of the Host service. Select Stop to stop the host service. |
| API Service status: | Displays the current status of the API Service. Select Stop to stop the API service. |
|
Copies your Database Mapper connection URL to the clipboard. |
| Launch |
Opens your Database Mapper URL connection. |
| Edit Configuration | Opens the Repository Configuration screen and allows you to change your configuration options. |
| Uninstall Services
|
Uninstalls the API and Host services. |
Establishing your Connection
Use the Database Mapper Configuration Utility to create a site for your Database Mapper Software environment. Establish a connection by completing the following steps:
1. Open the Database Mapper Configuration Utility as an administrator.
2. Select Start to configure a new Database Mapper Software connection.
3. Enter your Database Server that will host the Database Mapper database.
Note: The database for Database Mapper Software is named SentryOneDocument. If you don't have a Database Mapper Software database, the SentryOneDocument database will be installed onto your Server.
4. Select the login mode to use for your database server connection, and then enter a valid username and password.
Note: If you select Windows Login and don't enter a username, the Database Mapper Configuration Utility will use the Windows Service account by default.
5. Select Advanced Options and configure any applicable options for your database connection. Select Next to continue to the Windows Service Account configuration.
Additional Information: For more information about Advanced Options within the Database Mapper Configuration Utility, see the Advanced Options sections.
6. Enter the username and password that will be used for the Host and API services.
Note: The username should use the following syntax: <server\username>.
The DMCU will use the local service account if the Service user username and password are left blank.
7. Select the IP address you want to use from the drop-down menu and then enter the domain name (friendly name) in the Host Domain field.
Important: The Host Domain field will determine your Database Mapper Web URL. For example, if your Database Mapper site will be connected locally with localhost like the example above, you will use localhost in the URL.
If you want your Database Mapper site to be accessible outside of the host machine, enter the host machine name. For example, if the host machine name is AppServer23, you would enter AppServer23 in the Host Domain field.
8. Select Advanced Options and configure any applicable options for your windows service account. Select Next to continue to the review screen.
9. Review the information you've entered for the Database Connection and Hosting Connection. Select Next to continue.
Note: Selecting Next automatically installs the Host and API services.
10. Select Start for the Host Service and API Service.
11. Select Launch to open your Database Mapper Software connection in your web browser. Note: You can also select to copy the Database Mapper URL to your clipboard. Your URL will use the following syntax: http://ServerName:HostBinding or http://IpAddress:HostBinding.
Note: In this example, our Database Mapper Software URL is http://localhost:44303 or http://127.0.0.1:44303. You will be prompted to login with your Integrated or SQL Server Credentials used for the Hosting Services account.
Important: If you selected the Use HTTPS checkbox, your URL will begin with https:// .
What's Next?
After configuring your Database Mapper Software installation you need to install the Remote Agent(s) and Solution Configuration Tool.