Database Mapper Getting Started
Overview
SolarWinds Database Mapper provides documentation and data lineage analysis capabilities that allow you to maintain up-to-date documentation for your desired data sources. Document data sources such as SQL Server, SQL Server Analysis Services (SSAS), SQL Server Integration Services (SSIS), Power BI, Azure Data Factory (ADF) and more.
Additional Information: For a complete list of the data sources supported by SolarWinds Database Mapper, and for information about each data source, see the Data Sources articles.
Cloud vs. Software
There are two versions of Database Mapper:
- Database Mapper (the cloud version at document.sentryone.com)
- Database Mapper Software (the on-premises, self-hosted version)
This article walks through the steps to getting started with both products and highlights the small differences along the way.
SolarWinds Database Mapper Components
SolarWinds Database Mapper consists of the following components:
| Component | Description | Cloud or On-Prem? |
|---|---|---|
| Database Mapper Web Client | The Database Mapper Web Client is the self-hosted infrastructure for Database Mapper Software (On-Prem). | On-Prem Only |
| Database Mapper Configuration Utility | The Database Mapper Configuration Utility allows you to change database, network, security, and web server binding-related properties for the self hosted Database Mapper Software (On-Prem). | On-Prem Only |
| SentryOneDocument Database | A SQL Server Database that's installed on the server hosting your Database Mapper Software. The SentryOneDocument database collects the data that you want to document in Database Mapper. For example, the SentryOneDocument database stores the documentation, lineage, snapshots, users, data dictionary entries, and Remote Agent data for your Database Mapper solutions and solution items. | On-Prem Only |
| Database Mapper Remote Agent |
The Database Mapper remote agent is a service that runs in the background on a machine within your environment, and is responsible for generating the snapshots and documentation for the solutions configured within Database Mapper. It feeds the snapshot and documentation back to Database Mapper Cloud. This agent service needs to be installed on a machine that has access and permissions to the environments configured to be documented. See the System Requirements article for more details. |
Cloud and On-Prem |
| Database Mapper Solution Configuration Tool | The Database Mapper Solution Configuration Tool allows you to add the solutions and solution items you want to document with Database Mapper (Cloud) or Database Mapper Software (On-Prem). | Cloud and On-Prem |
Database Mapper Host (Cloud) Architecture Diagram
The following is a diagram of the Database Mapper Host (Cloud) Architecture.
Summary of installation steps
Installing Database Mapper (Cloud)
1. Install & configure the Database Mapper Remote Agent and Configuration Tool.
2. Create an account and sign in to Database Mapper at document.sentryone.com.
Installing Database Mapper Software (On-Prem)
1. Install the Database Mapper Software Web client.
2. Configure Database Mapper Software using the Database Mapper Configuration Utility.
3. Install & configure the Database Mapper Remote Agent and Configuration Tool.
4. Activate your Database Mapper Software license(s) through the SolarWinds License Manager.
5. Sign in to Database Mapper at your on-premises host server URL for Database Mapper Software.
Step-by-Step Installation
Additional Information: For information about Installing Database Mapper or Database Mapper Software, see the Installing Database Mapper article and select the applicable product installation instructions.
Using Database Mapper
After you've installed the necessary components for your Database Mapper Installation, you can begin configuring Solutions and Solution Items with the Solution Configuration tool.
Additional Information: For more information about Solutions and Solution items, see the Solutions, and Solution Items articles.
Once you have configured your Solution(s) and Solution Item(s), you can begin navigating the Solutions Dashboard, and generating documentation for your Solutions.
With generated documentation, you can explore your Solution meta-data and dependencies with the Documentation and Lineage tabs.