SentryOne Document Documentation

Download:  Visit the SentryOne Document product page to learn more about purchasing or to start a free trial. You can explore the product right now in our demo environment.

SentryOne Document Documentation Page

SentryOne Document Documentation page

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

Note:  Select theSentryOne Document Configure Snapshot buttonConfigure Snapshot button for the desired solution on the Solutions dashboard to generate new documentation for that solution.

Opening the Documentation Page

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

Select SentryOne Document View Documentation buttonon the Solutions dashboard for the desired solution.

SentryOne Document Solutions Dashboard View Documentation
View Documentation from the Solutions Dashboard

SentryOne Document Documentation for Solution
Selected Documentation

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

SentryOne Document Documentation tab select Solution
Documentation tab select Solution

SentryOne Document Documentation selected solution
Selected Documentation

Displaying Documentation

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

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

SentryOne Document Web Portal Documentation select link from tree
Expand nodes and select a tree link

SentryOne Document Web Portal Documentation displayed
Tree link documentation displayed

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

SentryOne Document Web Portal select documentation link
Select documentation link

SentryOne Document Web Portal Documentation displayed
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. SentryOne Document Web Portal Change documetation view

Note:  The view button displays as Current Version, or a specified date and time depending on the selected view.

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

SentryOne Document Documentation Point In Time
SentryOne Document Documentation Point in Time select Time

3. Select OK to update the documentation. SentryOne Document Web Portal View documentation window Change Documentation View

Success: You are now viewing your historical documentation!SentryOne Document Web Portal Documentation Historical view

Note:  Return to the current view of your documentation at any time by selecting the view button, then selecting CurrentSentryOne Document Web Portal Documentation View Current

Searching for Data

Note:  Starting with Version 2020.24, any search terms that you search for will include results for your term in the Documentation and in the Data Dictionary values. You can further condense your search by selecting Documentation Only, Data Dictionary Only, or a Data Dictionary Category from the dropdown menu. 

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. SentryOne Document Web Portal Documentation Search bar

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

SentryOne Document Web Portal Documentation Search results
Select Search link

SentryOne Document Web Portal Documentation Search results link
Search related content

Note:  Select Back to Last Search Results to return to the search results documentation page.SentryOne Document Documentation Back to Last Search Results

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. 

SentryOne Document Documentation Search Filter Dropdown menu
SentryOne Document Documentation Search for Data Dictionary Value

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

SentryOne Document Documentation Search Results
SentryOne Document Documentation selection with Data Dictionary Value

Comparing Documentation

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

Documentation buttonDescriptionImage
SentryOne Document Documentation Version History buttonOpens the Version History for the selected object. Select two versions different versions, and then select compare to view any differences between the versions.SentryOne Document Documentation Version History
SentryOne Document Documentation Compare to Previous buttonOpens 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.SentryOne Document Documentation Side by Side View

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

1. Open the SentryOne Document Documentation page, then select a Solution.

SentryOne Document open Documentation page
SentryOne Document Documentation page select Solution

2. Navigate to the desired object through the solution explorer, or search for an object.SentryOne Document Documentation page select 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.

SentryOne Document Documentation page select Version History
SentryOne Document Documentation Version History select Compare

Note:  There needs to be captured differences in the documentation to use the Documentation Version History feature. SentryOne Document displays the following prompt if there are no documented differences:

SentryOne Document Documentation Version History No previous versions message

Note:  In this example, the difference between the object versions can be seen in the available databases. SentryOne Document Documentation Side by Side View

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

Note:  Text in red has been removed from the object , and text in green has been added to the object.

Comparing Solutions

Note:  To use the Comparison feature, the solution snapshots need to be generated by a remote agent from Version 2020.24 or later. See the release notes for more information.

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:

IconDescription
SentryOne Document Solution Comparison Equal IconThe solution items are equal in both solutions.
SentryOne Document Solution Comparison Not Equal IconThe solution items are not equal in both solutions.
SentryOne Document Solution Comparison Left Only IconThe solution item is only present in the left solution.
SentryOne Document Solution Comparison Right Only IconThe 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.SentryOne Document Documentation Select Comparison

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

SentryOne Document Solution Comparison select Left Side
SentryOne Document Solution Comparison select Right Side

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

SentryOne Document Solution Comparison Change Left Start Point
SentryOne Document Solution Comparison Change Left Start Point Update

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

SentryOne Document Solution Comparison Change Right Start Point
SentryOne Document Solution Comparison Change Right Start Point Update

5. Compare the two presented solutions.  SentryOne Document Solution Comparison

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

ButtonDescription
SentryOne Document Solution Comparison Equal buttonRemove Equal items from the comparison.
SentryOne Document Solution Comparison Not Equal buttonRemove Not Equal items from the comparison.
SentryOne Document Solution Comparison Left Only buttonRemove Left Only items from the comparison.
SentryOne Document Solution Comparison Right Only buttonRemove Right Only items from the comparison.

Displaying Lineage

 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.

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

Note:  If there is no Lineage for your selected Documentation, SentryOne Document navigates to the closest parent object.

Documentation buttonDescriptionImage
SentryOne Document Documentation Jump To Lineage buttonOpens the Lineage page focused on the selected documentation object.SentryOne Document Lineage

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

SentryOne Document Documentation Jump To Lineage
SentryOne Document Lineage from Documentation selection

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 SentryOne Document Solutions Dashboard.SentryOne Document Solutions Dashboard

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

SentryOne Document Solutions Dashboard select Export Documentation button
SentryOne Document Solutions Dashboard select Export Documentation

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. 

SentryOne Document Documentation Export window select Point In Time
SentryOne Document Documentation Export window select Date
SentryOne Document Documentation Export window select OK

Note:  The current version of the documentation is selected by default.

4. Select Request Export to begin exporting the documentation. SentryOne Document Documentation Export window select Request Export

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

SentryOne Document Documentation Export window select Task History
SentryOne Document Task History for Documentation Export

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.

SentryOne Document Solutions Dashboard

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

SentryOne Document Solutions Dashboard select Export Documentation button
SentryOne Document Solutions Dashboard select View Exports

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

SentryOne Document Documentation Exports page select download button
SentryOne Document Documentation Exports page select Save

Additional Information: See the Documentation Exports section of the Solutions Dashboard article to learn more about exports.