Database Mapper Solutions Dashboard

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.

Overview

The Database Mapper Solutions Dashboard allows you to manage the solutions that are uploaded to Database Mapper. Select Solutions to open the Solutions Dashboard.

The Solutions Dashboard displays details about the solutions within your environment.

Database Mapper Solutions Dashboard

Feature	Description
Name	The name of the selected solution.
Created	The date and time the solution was created.
Last Updated	The date and time the solution was last updated.
Default Agent Pool	The remote agent pool that generates the documentation for the solution.

Button

Description

Image

Database Mapper Web Portal View Documentation button

Opens the Documentation page for the selected Database Mapper solution. View the most recent snapshot results for the solution. Drill down into the solution, and the solution items within the solution for a more granular view into your environment.

Database Mapper Web Portal Documentation

This feature is not available with Essentials or Standard licensing. If you'd like to use this feature, please visit our product pricing page to learn more.

Opens the Lineage page for the selected solution.

Note: You must take a snapshot of your solution before you can view any lineage.

Database Mapper Web Portal Start a Snapshot button

Take a snapshot of the selected solution. Selecting the Snapshot Configuration button opens the Snapshot Configuration window. Select the documentation type, and then select Start Snapshot to take a snapshot of the selected solution with the assigned Remote agent.

The Business Analyst and Developer documentation views are available with Version 2022.3. The Business Analyst view is applied by default, and provides a streamlined view of your data source. For example, the Business Analyst view for a SQL Server data source will display information such as SQL Server databases and tables. The Developer view records more detailed and granular information, such as security logins and roles, SQL Server Agent Jobs, etc.

Note: Starting a Snapshot Request sends the request to the assigned remote agent. After the snapshot has completed, the remote agent generates documentation, and uploads the snapshot and documentation to Database Mapper. Schedule a snapshot using the Database Mapper CommandLine executable.

Note: If you are requesting a snapshot for the first time, you must first authenticate using the command provided in the window.

Database Mapper Web Portal Confirm Snapshot Request window

Select the Export button and then select Export Documentation to export the current documentation for the selected solution. Select the Export button and then select View Exports to open Documentation Exports page for the selected solution.

Database Mapper Documentation Export window

Database Mapper Documentation Exports for Solution

Database Mapper Web Portal Change Pool assignment button

Select the Change Pool assignment button to assign a different remote agent to the selected solution. Selecting this button opens the Assign to Pool window. Select the desired remote agent from the drop-down list, and then select Save to save the remote agent pool assignment for the solution.

Note: Select the Include Solution Items toggle to move all Solution Items associated with your selected Solution to the new Remote Agent Pool.

Database Mapper Web Portal Assign to Pool window

Database Mapper Web Portal View Solution Items button

Opens the Solution items window for the selected solution. The solution items window displays details about the solution items within the selected solution, giving you a more granular look at the items within your environment.

Database Mapper Web Portal Solution items page

Opens the Manage solution aliases window for the selected solution. For more information about managing aliases in Database Mapper, see the Solution Aliases article.

Database Mapper Manage solution aliases window

Database Mapper Web Portal Task History button

Opens the Task History page for the selected solution.

Database Mapper Web Portal Task History for Solution

Solution Dashboard Card View

Starting with Versions 2022.4 and later, you can view your Solutions and Solution Items as cards on the Solutions Dashboard. Open the Solutions Dashboard and select to open the Solution Card view.

Database Mapper Solution Card View

The Solution Card view displays information about your Solution and Solution items. In the Solution Card view, each Solution in your Database Mapper Environment displays as a singular card. The Solution name is displayed at the top of the card, followed by solution meta-data such as the Solution creation date and assigned Agent pool below. Select the ^ Solution Items Found toggle to display the Solution Item(s) for the selected Solution.

Database Mapper Solution Cards displaying Solution Items

Solution Dashboard Card View Options

The following information and buttons are presented on each Solution Card:

Feature

Description

Name

The name of the selected solution.

Last Updated

The date and time the solution was last updated.

Created On

The date and time the solution was created.

Agent Pool

The remote agent pool that generates the documentation for the solution.

^ Solution Items Found

Select the ^ Solution Items Found toggle to display the Solution Item(s) for the selected Solution.

Option	Description
Name	The name of the Solution item.
Default Agent Pool	Displays the Remote Agent pool that runs the snapshot for the solution item.
	Select the Change Pool assignment button to assign a different remote agent to the selected solution. Selecting this button opens the Assign to Pool window. Select the desired remote agent from the drop-down list, and then select Save to save the remote agent pool assignment for the solution. Note: Select the Include Solution Items toggle to move all Solution Items associated with your selected Solution to the new Remote Agent Pool.
	Opens the Task History page for the selected solution item.

Database Mapper Solution Card View Documentation button

Opens the Documentation view for the selected Solution.

Database Mapper Solution Card View Lineage button

Opens the Lineage view for the selected solution.

Database Mapper Solution Card View Configure Snapshot button

	This button indicates that the last solution snapshot has completed successfully.
	This button indicates that the last solution snapshot has failed.
	This button indicates that a snapshot has been configured for this solution.
	This button indicates that your last Solution Snapshot was canceled.
	This button indicates that your Solution is configured for a snapshot.

The Business Analyst and Developer documentation views are available with Version 2022.3. The Business Analyst view is applied by default, and provides a streamlined view of your data source. For example, the Business Analyst view for a SQL Server data source will display information such as SQL Server databases and tables. The Developer view records more detailed and granular information, such as security logins and roles, SQL Server Agent Jobs, etc.

Note: Starting a Snapshot Request sends the request to the assigned remote agent. After the snapshot has completed, the remote agent generates documentation, and uploads the snapshot and documentation to Database Mapper. Schedule a snapshot using the Database Mapper CommandLine executable.

Note: If you are requesting a snapshot for the first time, you must first authenticate using the command provided in the window.

Database Mapper Solution Card View Task History button

Opens the Task History page for the selected solution.

Solution Items

Database Mapper Solution Items page

The Solution Items page displays metadata for the selected solution item in your environment.

Feature	Description
Name	The name of the selected solution.
Created	The date and time the solution was created.
Last Updated	The date and time the solution was last updated.
Default Agent Pool	The remote agent pool that runs the snapshot for the solution item.

Button	Description	Image
	Select the Change Pool Assignment button to select a different remote agent to snapshot the selected solution item. Selecting this button opens the Assign to Pool window. Select the desired remote agent from the drop-down list, then select Save to save the remote agent pool assignment for the solution item.
	Opens the Task History page for the selected solution item.

Task History

The Task History page displays the usage history for a selected Solution, or Solution item.

Solution Task History

Database Mapper Web Portal Task History for Solution item

Solution Item Task History

Expand a Task to display the individual task steps and their statuses. Database Mapper Task History expand task

The Task History page gives you historical insight into the tasks that run on your Database Mapper solutions and solution items. The following details are provided:

Feature	Description
	The task status indicator means the task was successful. The task status indicator means that the task was unsuccessful. The task status indicator means the task was cancelled.
Command Description	The Command Description section provides you with a description of the Task, and the solution name.
Created	The Created section notes the day and time the task was created.
Started	The Started section notes the day and time the Task was started for the solution or solution item.
Completed	The Completed section notes the day and time the Task was completed for the solution or solution item.
User	The User section notes the user responsible for the Task.

Task History Actions

Button	Description	Image
	Opens the Confirm Workflow Cancellation window for the selected solution. Select Confirm to cancel the snapshot. Note: You can cancel snapshots that are in progress, or snapshots that are scheduled to take place at a later time.
	When selected, the Task History page refreshes every 20 seconds. Note: This option is active by default. The auto refresh option turns off after ten minutes of activity.
	Select the Download Log Output button to download the selected Task history log. Select Open to open the file, or select Save to save the file to your machine.
	Select the See log output button to display the log output for the selected task.

Documentation Exports

Database Mapper Documentation Export page

The Documentation Exports page displays details about your selected solution's exported documentation. The following details are provided:

Feature	Description
Requested Documentation Version	The day and time that the documentation was created. The version (referenced by the date and time the documentation was created) of the exported documentation.
Export Generated	The day and time that the documentation was exported.
Page Count	The number of pages of the exported documentation.
File Size	The file size in MB of the exported documentation.

Documentation Exports Actions

Use the Documentation Exports page to download any of your exported documentation versions.

Button	Description	Image
	Select the Download Documentation export button to download the selected documentation. Select Open to open the file, or select Save to save the zip file to your machine. Note: Database Mapper exports HTML files only. This is applicable to all solution items.
	Select the Delete export button to open the deletion prompt. Select Delete to delete the selected documentation export.

Documentation Export window

Database Mapper Documentation Export window

Select the Export Documentation button for the desired solution, and then select Export Documentation to open the Export Documentation window. The following options are available:

Option	Description
	Select the Current Version button to change your view of your Documentation export. Select Point in Time, and then select the Date and Time of the documentation you want to export. Select OK to save your documentation view selection. The Current Version option is the default selection.
	Select the Use enhanced logging checkbox to enable enhanced logging for your documentation export.
	Select Request Export to begin exporting your documentation.
	Select Close to close the Documentation Export window.