Database Mapper 2023.1 System Requirements
EOL: An end of life announcement has been made for Database Mapper on February 28, 2023. See the Solarwinds End of Life Policy for more information.
SolarWinds strongly recommends that you install Database Mapper on a server that is protected from unauthorized access by the public. If your use of Database Mapper does not need to be public or internet-facing, install it on a server that is neither public, nor internet-facing. To learn about best practices for configuring your Database Mapper installation securely, see Best practices to secure SolarWinds Products.
System Requirements
Compatible Browsers (Cloud and On-Prem)
- Chrome
- Edge
Note: Using an unsupported browser to access Database Mapper prompts an Improve Your Experience message, and asks you to use Chrome or Microsoft Edge for the best experience.
Database Mapper Software (On-Prem Only)
Database Mapper Software is an on-premises, browser-based option for documenting your data estate. This product is a replacement for the DOC xPress product and is the self-hosted version of Database Mapper cloud.
Note: Hardware requirements are workload-specific. The specs listed below are the minimum recommended.
If you're using Database Mapper Software (the on-premises, self-hosted version), the hardware requirements are:
- 2 CPU cores
- 8+ GB RAM
- 40+ GB free storage space
The software requirements for Database Mapper Software (the on-premises, self-hosted version) are :
- SQL Server 2012 or later (to host the Database Mapper database)
- Database Mapper Software uses port 44302 for the UI host and port 44322 for the API.
Database Mapper Software Host (On-Prem Only)
To install the Database Mapper Software Host, your machine must have Microsoft .NET Core 3.1 Desktop Runtime (v3.1.19).
Database Mapper Software Additional Permissions (On-Prem Only)
This user (or the account you change it to) must have read/write access to:
- C:\Program Files (x86)\SentryOne\SentryOne Document (or your custom installation directory)
- C:\Windows\Temp
- C:\ProgramData\SentryOne\Document\_blobStorage
If you are using Windows authentication to access the Database Mapper database, the user account must:
- Exist as a login account on the database server
- Have access to the Database Mapper database
- Be added to the db_datareader, db_datawriter, and db_ddladmin roles on the Database Mapper database
Note: The Database Mapper Software installer grants the required access to the SentryOneDocument database for the NETWORK SERVICE account.
Remote Agent (Cloud and On-Prem)
Note: Hardware requirements are workload-specific. The specs listed below are the minimum recommended. Because agent workloads do not benefit significantly from parallelization, one or two cores for each agent is recommended.
Remote Agent Permissions
Remote Agent Service Account
The remote agent service account must have the following for both Database Mapper Cloud and Database Mapper Software:
- Log on as a service rights
- Log on as a batch job rights
- Write access to the remote agent’s config file located at C:\ProgramData\PragmaticWorks\ServiceCore\SentryOneDocumentRemoteAgentService.{Agent Name}.xml
Additional Information: See the Log on as a service article on Microsoft Docs for instructions.
Multi-Factor Authentication
Using service accounts that require Multi-Factor Authentication (MFA) is not currently supported for connecting the remote agent service to Azure SQL Database targets. It is recommended that generalized service accounts are used for configuring connection credentials rather than accounts that are directly linked to users. For environments that require MFA for Azure Active Directory users, a service account can be excluded from the MFA requirement by using an exclusion for conditional access.
Additional Information: See the Use Azure AD access reviews to manage users excluded from Conditional Access policies article on Microsoft Docs for guidance on how to set up exclusions for MFA.
Remote Agent Hardware
- Recommend a relatively recent 64-bit processor, 8+ GB of RAM, and 20+ GB free storage space.
Remote Agent Software
- Windows PC with .NET 4.6.1 installed
Remote Agent Supported Operating Systems
64-bit (x64) Operating Systems | 32-bit (x86) Operating Systems |
---|---|
Windows Server 2012 | Windows Server 2012 |
Windows Server 2016 | Windows 8 |
Windows 8 | Windows 10 |
Windows 10 |
|
Supported Provider Versions (Cloud and On-Prem)
Unsupported: SQL, SSAS, SSIS, and SSRS versions 2008 R2 and earlier are not officially supported. The providers remain accessible in the software if the prerequisites are met, however, we will not be able to provide support for any issues that are specific to these older releases.
Provider | Supported Versions | |||||||||
---|---|---|---|---|---|---|---|---|---|---|
MySQL |
MySQL versions 5.6 through 8 |
|||||||||
Oracle |
Oracle versions 12c Release 1 through 21c |
|||||||||
PostgreSQL |
PostgreSQL versions 9.5 through 13.2 |
|||||||||
SQL |
Note: Microsoft SQL Server Transact-SQL ScriptDom is included in the Database Mapper installer. Important: The SQL Server provider works against SQL Server 2005 and above when connecting to both SQL Server On-Premises and Azure Instances. The SQL Server Provider can collect columns with the Sensitivity Classification in Azure, and SQL Server 2019. |
|||||||||
SSAS |
Important: The SSAS provider works against SSAS 2005 and above when connecting to Multidimensional Instances and SSAS 2012 and above when connecting to a Tabular Instances. |
|||||||||
SSIS |
SQL Server Integration Services 2012 or later. |
|||||||||
SSRS and Power BI Report Server |
Note:
|
|||||||||
Tableau | Tableau Servers with REST API enabled with the following API Versions: 2.3, 2.2, 2.1 and 2.0. |
Required Provider Files (Cloud and On-Prem)
Important: Provider files must be installed on the machine that will run your Database Mapper Remote Agent. For more information about installing the Remote Agent, see the Remote Agent article.
Note: Due to legal restrictions, some libraries cannot be redistributed by software providers. Database Mapper does not include the following libraries:
Provider | Requirement |
---|---|
SSAS |
You need to install Microsoft ® .NET 4.5 to monitor SSAS 2017. To connect to Azure Analysis Services, you need to download and install the latest Microsoft Analysis Services Client Libraries. |
SSIS | To monitor SSIS 2012 or later, you need to install SQL Server Data Tools for Visual Studio or Business Intelligence Development Studio, and you need to install the SSIS Version that you want to document. Additional Information: For more information about SSIS Prerequisites in Database Mapper, see the SSIS Software prerequisites for DOC xPress, S1 Document, BI xPress KB article. Important: You need to have the SSIS Version that you want to document installed. Important: You need to have any Third-Party Products (Connection Managers, Tasks, Components, etc) that are used within the SSIS Package(s) installed to document your packages. Important: You need to select SQL Server Integration Services when installing SQL Server features in Microsoft SQL Server Data Tools for Visual Studio. Warning: In Visual Studio 2019, you need to download SQL SeverData Tools (SSDT) and SSIS separately because SSIS, SSAS, and SSRS are not bundled with SSDT in this version of Visual Studio. |
SSRS and Power BI Report Server | To monitor SSRS 2012 or later, or to monitor Power BI Report Server, you need to install SQL Server Data Tools for Visual Studio or Business Intelligence Development Studio. Note: You need to select SQL Server Reporting Services when installing SQL Server features in Microsoft SQL Server Data Tools for Visual Studio. |
Downloading Provider Files from Microsoft (Cloud and On-Prem)
Note: These instructions reference an external system from Microsoft and may appear differently than described below.
Download the additional provider requirements by completing the following steps:
1. Navigate to the Microsoft SQL Server 2012 SP4 Feature Pack.
2. Select the following additional files:
|
|
3. Select Next.
4. Select Download to install the selected components.
Success: You have now downloaded the additional provider requirements!
Permissions (Cloud and On-Prem)
It's recommended that the machine running the remote agent has network access and permission to access all the solution items that you want to scan. See the Remote Agents article for additional recommendations about where to install them.
Note: Database Mapper (the cloud version at document.sentryone.com) uses https://document-api.services.sentryone.com/ as the communication endpoint and port 443 for HTTPS. These will need to be allowed by your firewall.
Technology-Specific Permissions
Technology | Required Permissions |
---|---|
Azure Power BI |
|
MySQL |
Examples Setting permissions on a limited user account (to enable configuring a solution item and taking a snapshot):
For stored procedures or functions: MySQL prior to version 8:
MySQL version 8 (or later):
|
Oracle |
|
PostgreSQL |
Example Setting permissions on a limited user account (to enable configuring a solution item and taking a snapshot):
|
SQL Server |
|
SQL Server Analysis Services |
|
SQL Server Integration Services |
|
SQL Server Reporting Services |
|
Tableau Permissions |
|
Accessing Database Mapper Solutions
The following script shows you how to grant the necessary permissions to users so that all server level objects, databases, associated database objects and SQL Server Agent objects can be read. This needs to be executed against any SQL Server that exists as a solution in Database Mapper.
SQL Server
USE [master];
GO
IF NOT EXISTS
(
SELECT *
FROM syslogins
WHERE [name] = 'Domain\Account'
)
CREATE LOGIN [Domain\Account] FROM WINDOWS WITH DEFAULT_DATABASE = [master];
GRANT VIEW SERVER STATE TO [Domain\Account];
GRANT VIEW ANY DEFINITION TO [Domain\Account];
GRANT CONNECT ANY DATABASE TO [Domain\Account];
GO
USE [msdb];
GO
CREATE USER [Domain\Account] FOR LOGIN [Domain\Account];
GO
USE [msdb];
GO
ALTER ROLE [SQLAgentOperatorRole] ADD MEMBER [Domain\Account];
GO
SSIS
If the server hosting the solution also has SSIS and the solution contains SSIS items, then permissions must be granted for the SSISDB in addition to the SQL Server permissions above.
USE [SSISDB];
GO
CREATE USER [Domain\Account] FOR LOGIN [Domain\Account];
GO
USE [SSISDB];
GO
ALTER ROLE [SSIS_Admin] ADD MEMBER [Domain\Account];
GO
BSD 2-Clause "Simplified" License Disclaimer
A component of the Database Mapper remote agent is attributed to MarkDig and licensed with the BSD 2-Clause "Simplified" License.
BSD 2-Clause "Simplified" License text as of November 26, 2019:
Copyright (c) 2018-2019, Alexandre Mutel
All rights reserved.
Redistribution and use in source and binary forms, with or without modification
, are permitted provided that the following conditions are met:
1. Redistributions of source code must retain the above copyright notice, this
list of conditions and the following disclaimer.
2. Redistributions in binary form must reproduce the above copyright notice,
this list of conditions and the following disclaimer in the documentation
and/or other materials provided with the distribution.
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
Additional Information: See https://github.com/lunet-io/markdig/blob/master/license.txt for current text and additional details.
Database Mapper Host (Cloud) Architecture Diagram
The following is a diagram of the Database Mapper Host (Cloud) Architecture.