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.
- 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.
- 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.
- 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.
- 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 the Verify & Save button to apply any changes.
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.
|Server||The Server name where Database Mapper software is installed.|
|Database Name||The Database name for your Database Mapper software installation.|
|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 your Database Mapper software server connection.|
|Port||The port used to connect to your Database Mapper software site.|
|Packet Size||The network packet size for your Database Mapper 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.
|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.|
|API Port||The port used to connect to the API Service.|
|Host Port||The port used to connect to the Host Service.|
|Use HTTPS||Select the checkbox to Use HTTPs and enter a TLS certificate.|
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. Enter your Database Server for your Database Mapper Software connection.
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 Database Server.
3. Select the credentials to use for your database connection, and then enter a valid username and password.
- If you select Windows Login and don't enter a username, the Database Mapper Configuration Utility will use the Windows Service account.
- You can use the Verify Connection button to verify your Database Connection credentials.
4. Configure any applicable Advanced Properties for your connection.
Additional Information: For more information about Advanced Properties within the Database Mapper Configuration Utility, see the Advanced Properties section.
5. Select the Hosting Services tab, and then enter the username and password for the service account.
Note: The DMCU will use the local service account if the Service user username and password are left blank.
6. Select the IP address you want to use for the binding from the drop-down menu. Enter the desired API, and Host ports.
7. Select Install Services to install the Host Service and API Service. Select the Start button for the Host Service and API Service.
8. Select the Database Connection tab, and then select Verify Connection. Select Verify & Save to verify your configured settings, and save your Database Mapper Software connection.