Database Mapper System Requirements

System Requirements

Compatible Browsers

• Chrome
• Edge

Database Mapper Software

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.

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 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

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

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:

1. Exist as a login account on the database server
2. Have access to the Database Mapper database
3. Be added to the db_datareader, db_datawriter, and db_ddlamin roles on the Database Mapper database

Remote Agent

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

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.

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

Supported Provider Versions

Required Provider Files

Downloading Provider Files from Microsoft

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.

Permissions

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.

Technology-Specific Permissions

GRANT SELECT ON mysql.user TO 'MyUserName'@'%';
GRANT SELECT, TRIGGER ON myschema.* TO 'MyUserName'@'%'; -- ALL tables/views

GRANT SELECT ON mysql.proc TO 'MyUserName'@'%';

GRANT SHOW_ROUTINE ON *.* TO 'lockdownuser'@'%';

ALTER ROLE myusername WITH LOGIN;
					
GRANT CONNECT ON DATABASE mydatabase TO myusername;
				
GRANT SELECT, INSERT ON ALL TABLES IN SCHEMA myschema TO myusername;

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.