SentryOne Document Lineage

SentryOne Document Lineage

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. 

Feature Highlights

  • 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

Note:  A snapshot must be taken before Lineage allows you to view the dependencies for a solution.

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.

Select the SentryOne Document Lineage buttonon the SentryOne Document Solutions Dashboard to open the Lineage Analysis for your Solution.

Navigating SentryOne Document Lineage

SentryOne Document Lineage Toolbar

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:

Toolbar buttonDescription
SentryOne Document Lineage Detail Level buttonThe Detail Level 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:

  • High Detail:  Allows you to see down to the column, measure, and attribute level of lineage.
  • Medium Detail:  Allows you to see down to the table, component, SSRS item, KPI, and measure group level of lineage.
  • Low Detail:  Allows you to only see the database, package, and report level of lineage.
SentryOne Document Lineage Show Legend button The show legend button allows you to toggle viewing of the legend.
SentryOne Document Lineage Depdency Direction buttonThe 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:

  • Bi-directional:  Both inbound (lineage) and outbound (impact) dependencies are included within the current session.
  • Inbound Only:  Only relationships that an object depends on are included within the current session.
  • Outbound Only:  Only relationships that are impacted by objects are included within the current session.
SentryOne Document Lineage Track Selection buttonThe 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.
SentryOne Document Lineage Initial Only buttonEnable Initial Only mode to display only the dependencies from the initial to the secondary modes. Disable Initial Only to display dependencies from secondary modes to other secondary modes.
SentryOne Document Lineage Dependency Levels buttonThe 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:  The more dependency levels included within the Lineage Diagram may cause it to become increasingly more difficult to read the diagram.
SentryOne Document Lineage Filter by relationship type Key buttonThe Filter by relationship 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.
SentryOne Document Lineage Filter by relationship type Object buttonThe object filter button allows you to toggle the visibility of relationship links that involve object dependencies.
SentryOne Document Lineage Filter by relationship type Lineage buttonThe data lineage filter button allows you to toggle the visibility of relationship links that involve the impact or dependency of another object's data.
SentryOne Document Lineage Reset View buttonThe Reset View button allows you to refresh the lineage data from the SentryOne Document database.
SentryOne Document Lineage Manage Aliases buttonThe 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.

Solution Explorer 

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.SentryOne Document Lineage Solution Explorer selection with Track Selection active

Expand and collapse selected objects and display the object's children by using the arrow to the left. 

SentryOne Document Lineage Solution Explorer Expand object
Expand Object

SentryOne Document Lineage Solution Explorer Object expanded
Object Expanded

Note:  If an object does not expand when selected, the object does not have any child objects that contain lineage, or the current detail level prevents it from expanding further. SentryOne Document Lineage Solution Explorer Object fully expanded

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, and then select Search to display the results.SentryOne Document Lineage Solution Explorer Search bar

Select an object from the search results to display the corresponding lineage graph.SentryOne Document Lineage select object from Search results

Select Back to explorer view to return to the previous Solution Explorer view.

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:  SentryOne Document Lineage Technology Legend

Hover over an object in the graph to display a tooltip about the object. SentryOne Document Lineage hover over object to display tooltip

Hover over inbound or outbound dependency routes to display a tooltip about the route path.SentryOne Document Lineage hover over route to display tooltip

Lineage Graph Route Legend

Line ColorDescription
BlueBlue lines indicate an object reference.
GreenGreen lines indicate data lineage.
BlackBlack lines indicate a Foreign key reference.
PurplePurple lines indicate references from multiple categories (Foreign key, object, data lineage).

Lineage Graph Context Menu Options

OptionDescription
Extend ItemDisplays more dependency levels for the currently selected object.
SentryOne Document Lineage Extend ItemSentryOne Document Lineage Object depdencies extended

Focus on thisSelect Focus on this to re-draw the diagram with the currently selected object as the main focus.
SentryOne Document Lineage Focus On thisSentryOne Document Lineage Focused object graph

View MetadataOpens the DDL script for the selected object. SentryOne Document Lineage Metadata DDL Script window
Jump to documentationOpens the documentation view for the selected object.
SentryOne Document Lineage Jump to documentationSentryOne Document Documentation from Lineage selection

Detail Level Views

Select an object in the Solution Explorer to display the lineage diagram for the object. The following detail levels are available:

Detail LevelGraph Example
LowSentryOne Document Lineage Low Detail Level
MediumSentryOne Document Lineage Medium Detail Level
HighSentryOne Document Lineage High Detail Level

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 LevelGraph Example
1SentryOne Document Lineage 1 Dependency level
2SentryOne Document Lineage 2 Dependency levels
3SentryOne Document Lineage 3 Dependency Levels
4SentryOne Document Lineage 4 Dependency Levels
5SentryOne Document Lineage 5 Dependency Levels

Dependency Directions

DirectionImage
Bi-directionalSentryOne Document Linage Bi-directional
Inbound OnlySentryOne Document Lineage Inbound Only
Outbound OnlySentryOne Document Lineage Outbound Only

Moving the Lineage Graph

You can adjust the view of the Lineage graph by doing one of the following:

MovementDescriptionExample
Moving a NodeLeft-clicking on a node and then dragging the mouse allows you to move a single node around the diagram without affecting the other nodes.SentryOne Document Lineage Moving a Node
PanningLeft 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.SentryOne Document Lineage Panning graph
ZoomingUse the mouse wheel to zoom in and out to see more details within the diagram.SentryOne Document Lineage Zooming In on graph