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.
SentryOne Document Lineage
The SentryOne Document Lineage feature allows you to discover where data originates and where it gets used. It simplifies the process of tracing the lineage and impact of data within a system by enabling you to explore the dependencies in your environment.
- Diagrammatic and interactive form saves time
- Speeds up development by allowing you to view dependencies clearly
- Enables you to pinpoint the source of data in objects
- Allows business analysts to make clear judgments about the correctness of data
- Enables you to identify areas where errors may be introduced
Using SentryOne Document Lineage
After creating a solution using the SentryOne Document configuration tool, and taking a snapshot, you can view the lineage for your solution. Complete one of the following steps to open SentryOne Document Lineage:
Select the on the SentryOne Document Solutions Dashboard to open the Lineage Analysis for your Solution.
Select the Lineage tab to open Lineage Analysis, and then select a Solution from the drop-down list.
Navigating SentryOne Document Lineage
In SentryOne Document Lineage, the view diagram panel takes up a majority of the window. All the settings selected with the Lineage toolbar apply to the currently selected object within the Solution Explorer to create a visual representation of the object's lineage. The following table describes the buttons and settings within the SentryOne Document Lineage toolbar:
|Use the Solution drop-down list to select the solution you want to display lineage.|
|The Manage Aliases button opens the Manage Solution Aliases window and allows you to clarify the location of implicit items for this solution.|
Note: After aliases have changed, SentryOne Document requires a snapshot of the solution in to refresh the dependency links within lineage analysis. For more information about Solution aliases in SentryOne Document, see the Solution Aliases article.
|The Granularity Detail drop-down allows you to adjust the granularity of the objects that are included within the current session of lineage analysis. The following options are available:|
|The Reset View button allows you to refresh the lineage data from the SentryOne Document database.|
|The Legend button allows you to toggle viewing of the legend.|
|The Text View switch allows you to toggle viewing the lineage in a textual or graphical representation. For a large and complex graph, this text option can help you make sense of the inbound and outbound dependencies.|
Example with Environment Map lineage:
|The Dependency Direction drop-down allows you to select the direction types of the dependencies you want to include within the current session of Lineage Analysis. An object's dependencies are typically created when an object is included within another object's definition. The following options are available:|
|The Track Selection button allows you to disable the feature that causes the diagram to re-draw every time a new selection is made within the Solution Explorer.|
|The Dependency Levels drop-down allows you to increase or decrease the number of levels of separation from the currently focused object to display within the Lineage Diagram.|
Important: Including too many dependency levels within the Lineage Diagram may cause difficulty in reading it.
|The Filter by Link Type button allows you to toggle the visibility of relationships. The key filter toggles the visibility of relationship links that involve the use of foreign keys.|
|The object filter button allows you to toggle the visibility of relationship links that involve object dependencies.|
|The data lineage filter button allows you to toggle the visibility of relationship links that involve the impact or dependency of another object's data.|
|Select the Filter button to open the Technology Filter menu. Select the desired filter options and then select Apply to apply the filter to your lineage graph.|
The Solution Explorer contains a hierarchically organized tree of all objects within the current detail level that contain lineage. Select an object with Track Selection enabled to re-draw the focus of the lineage diagram to the newly selected object within the Solution Explorer.
Select to expand and collapse selected objects and display the object's children.
Note: If an object does not have a in the Solution Explorer, the object does not have any child objects that contain lineage, or the current detail level prevents it from expanding further.
Searching the Solution Explorer
Search the current solution for the exact object you want to view lineage for with the Search bar. Enter what you want to search for, then select Search to display the results.
Select an object from the search results to display the corresponding lineage graph.
Select Back to explorer view to return to the previous Solution Explorer view.
Note: Your Search Results will vary based on the Granularity Detail level you have selected.
Lineage Graph Views
The icons and colors within the diagram help you to quickly identify the object, and technology types associated with each node. The following legend displays in the Solution Explorer when you select Show Legend:
Hover over an object in the graph to display a tool-tip about the object.
Hover over inbound or outbound dependency routes to display a tool-tip about the route path.
Lineage Graph Route Legend
|Blue||Blue lines indicate an object reference.|
|Green||Green lines indicate data lineage.|
|Black||Black lines indicate a Foreign key reference.|
|Purple||Purple lines indicate references from multiple categories (Foreign key, object, data lineage).|
Lineage Graph Context Menu Options
|Extend Item||Displays more dependency levels for the currently selected object.|
|Focus on this||Select Focus on this to re-draw the diagram with the currently selected object as the main focus.|
|View Metadata||Opens the DDL script for the selected object.|
|Jump to documentation||Opens the documentation view for the selected object.|
|View Data Dictionary||Opens the Data Dictionary window for the selected Lineage object. Select Edit to makes changes to your Data Dictionary Values.|
Note: You can only edit documentation values that have Data Dictionary configured.
Granularity Detail Views
Select an object in the Solution Explorer to display the lineage diagram for the object. The following detail levels are available:
|Granularity Detail||Graph Example|
Dependency Level Views
Select an object in the Solution Explorer to display the lineage diagram for the object. Dependencies display based on the selected dependency level view. The following dependency level views are available:
|Dependency Level||Graph Example|
Moving the Lineage Graph
You can adjust the view of the Lineage graph by doing one of the following:
|Moving a Node||Left-clicking on a node and then dragging the mouse allows you to move a single node around the diagram without affecting the other nodes.|
|Panning||Left clicking on the view diagram allows you to pan the lineage diagram and adjust the visual if it does not all fit within the screen.|
|Zooming||Use the mouse wheel to zoom in and out to see more details within the diagram.|