Database Mapper Documentation

Database Mapper Documentation Page

The Documentation page displays the most recent documentation for your selected solution by default. 

Opening the Documentation Page

Open documentation for your solution through one of the following methods:

Select on the Solutions dashboard for the desired solution.

View Documentation from the Solutions Dashboard

Selected Documentation

Select the Documentation tab, then select the desired solution from the drop-down list.

Documentation tab select Solution

Selected Documentation

Displaying Documentation

On the Documentation page in Database Mapper, you have complete control over your uploaded data. Display the data you want to see by completing one of the following steps:

Select to expand the nodes, then select the desired link from the documentation tree on the left of the page. 

Expand nodes and select a tree link

Tree link documentation displayed

Select a link in the documentation on the right to drill down into desired sections.

Select documentation link

Documentation displayed

Changing Views

View your documentation at a specified point in time by completing the following steps:

1. Select the view button (Current Version) to expand the documentation view options. 

2. Select the Point in time view, then enter the desired time.

3. Select OK to update the documentation. 

Searching for Data

Search for specific metadata within your environment by using the Documentation page search bar. 

Select the desired search parameters from the drop-down menu. Enter a specific search term into the search bar, then select Search to display your results. 

Select a link from the Search results to display the data related to the search.

Select Search link

Search related content

Searching Data Dictionary Categories

Select the desired Data Dictionary Category from the drop-down menu. Enter the Data Dictionary value into the search bar, then select Search to display your results. 

Select a link from the Search results to display the data related to the search.

Comparing Documentation

Use the Database Mapper Documentation page to compare your documentation against previous snapshot versions, and see the changes made to your solution and solutions items over time. 

Documentation button	Description	Image
	Opens the Version History for the selected object. Select two versions different versions, and then select compare to view any differences between the versions.
	Opens the Side By Side view for the selected object. The Side By Side view displays the last collected snapshot of the object, and the Current version of the object in an easy to view comparison screen. Select different versions on the Version History tab.

If there have been changes made to your Solution, you can view these changes by completing the following steps:

1. Open the Database Mapper Documentation page, then select a Solution.

2. Navigate to the desired object through the solution explorer, or search for an object.

3. Select Version History to open the Version History page. Select the object versions you want to compare, then select Compare to display the Side by Side View comparison.

4. Select the Diff View tab to display the object with highlighted changes.

Comparing Solutions

You can compare two different solutions by selecting the Comparison button. This can be useful for comparing similar solutions that may be used in different environments. For example, you might have two SQL Server solutions; one for your development environment, and the second for your production environment. When comparing two solutions, you can recognize similarities and discover differences with the following icons:

Icon	Description
	The solution items are equal in both solutions.
	The solution items are not equal in both solutions.
	The solution item is only present in the left solution.
	The solution item is only present in the right solution.

To compare two applicable solutions, complete the following steps:

1. Select the Comparison button to open the Document Comparison view.

2. Select a solution to compare for the left comparison, then select a solution to compare for the right comparison.

3. Select Change Left Start Point, specify a left starting point, then select update.

4. Select Change right Start Point, specify a right starting point, then select update.

5. Compare the two presented solutions.  

You can filter your document comparison further with the following options:

Button	Description
	Remove Equal items from the comparison.
	Remove Not Equal items from the comparison.
	Remove Left Only items from the comparison.
	Remove Right Only items from the comparison.

Displaying Lineage

Use the Jump to Lineage button to display the data lineage for your selected documentation object.  

Documentation button	Description	Image
	Opens the Lineage page focused on the selected documentation object.

Navigate to your desired documentation object, and then select Jump to Lineage to display the lineage for that object.

Exporting Documentation

You can export the current version, or a point in time version of your documentation for any selected Solution. Save the exported documentation for your records, or distribute the exported documentation across your team and business leaders. Begin exporting your documentation by completing the following steps:

1. Select Solutions to open the Database Mapper Solutions Dashboard.

2. Select the Export Documentation button and the select Export Documentation to open the Documentation Export window. 

3. Select the version of the documentation that you want to export. Select Current Version, and then select Point in Time to select a previous documentation version. Select a date and time from the calendar, and then select Ok to save your selection. 

4. Select Request Export to begin exporting the documentation. 

Success: You have requested to export your documentation! View the progress of your export on the Task History page.

Downloading Exported Documentation

After your Documentation Export request has completed, you can download your documentation. Download your documentation by completing the following steps:

1. Select Solutions to open the Solutions Dashboard.

2. Select the Export Documentation button, then select View Exports for the desired solution to open the Documentation Exports page.

3. Select the download button for the desired documentation version, then select save to save the documentation to your machine.