SentryOne Document Solution Items

Download:  Visit the SentryOne Document product page to learn more about purchasing or to start a free trial.

Overview

Solution Item Overview

The SentryOne Document Solution Configuration tool allows you to add Solutions and Solution items to your SentryOne Document environment. Selecting to Add a Solution item opens the Add Solution item window. Each Solution item contains the following configurable options:

SentryOne Document Solution Configuration Tool Add Solution item window

OptionDescription
Item NameThe name you want to give your solution item.
Source TypeThe type of solution item that you want to add to your solution. 
Only update this item as part of a manual snapshotSelecting this checkbox only updates the solution item when you choose to manually snapshot the solution.
Snapshot this item using a 32-bit processSelecting this checkbox uses a 32-bit process to snapshot the solution item. Note:  A more efficient 64-bit process is used to snapshot solution items by default. 

You can select from a variety of solutions to document, including the following:

  • Custom Metadata Import
  • Excel Spreadsheet
  • Power BI
  • Power BI Report Server
  •  SQL Server 2005-2019
  • SSAS Server 2005-2014
  • SSAS Server 2016
  • SSAS Server 2017-2019
  • SSIS 2012
  • SSIS 2014
  • SSIS 2016
  • SSIS 2017
  • SSRS 2008 R2-2017
  • Tableau Server

Note:  If a Solution item provider isn't available for you to select in the Solution Configuration tool, your system may not meet the provider's system requirements. For information about the individual requirements to document a provider, see the System Requirements article. 

Unsupported: Hive (Beta) and Informatica PowerCenter (Beta) are not supported.

Select a tab for more specific instructions on configuring a particular Solution item.

Custom Metadata

Custom Metadata import

Solution Item IconSolution Item Description
SentryOne Document Custom Metadata Import Provider

SentryOne Document gathers data using providers. If there is no existing provider for a source, then you can use the Custom Metadata Import provider to import custom metadata files. This is useful when there is a need to incorporate data about unsupported platforms such as Access or DB2.

Adding Custom Metadata import

Add a Custom Metadata import Solution item to your SentryOne Document Solution by completing the following steps:

1. Select Add to add a new Solution, or select Open to open an existing solution in the SentryOne Document Configuration tool. SentryOne Document Solution Configuration Tool Open Solution

2. Select Add to open the Add Solution item window. SentryOne Document Solution Configuration Tool Add Solution Item

3. Enter an item name, and then select Custom metadata import from the Source type drop-down list.  SentryOne Document Add Solution Item Custom Metadata Import

4. Enter the file paths for the three necessary files (object file, property file, and lineage file), and then select OK to add the solution item.SentryOne Document Add Solution Item Custom Metadata Import Credentials

Note:   Object files contain the names of the objects within in the database. Property files contain information about the objects within the database.

Excel

Excel Spreadsheet

Solution Item IconSolution Item Description
SentryOne Document Excel Spreadsheet Provider

SentryOne Document allows you to quickly develop a Lineage overview of your Excel Workbooks (*.xlsx) that contain SQL Server and Analysis Services data sources.

Adding Excel Spreadsheet

Add an Excel Spreadsheet Solution item to your SentryOne Document Solution by completing the following steps:

1. Select Add to add a new Solution, or select Open to open an existing solution in the SentryOne Document Configuration tool. SentryOne Document Solution Configuration Tool Open Solution

2. Select Add to open the Add Solution item window. SentryOne Document Solution Configuration Tool Add Solution Item

3. Enter an item name, and then select Excel Spreadsheet from the Source type drop-down list.SentryOne Document Add Solution Item Excel Spreadsheet

4. Select File to document an Excel Workbook on the file system, or select Folder to recursively document all Excel Workbook items within the selected folder.

SentryOne Document Add Solution Item Excel Spreadsheet File
SentryOne Document Add Solution Item Excel Spreadsheet Folder

Note:  Selecting the ellipsis launces the file explorer, allowing you to navigate to the desired file or file folder. 

5. Select OK to add the Excel Spreadsheet Solution item to your SentryOne Document Solution.SentryOne Document Add Solution Item Excel Spreadsheet select Ok

Power BI

Power BI

Solution Item IconSolution Item Description
SentryOne Document Power BI provider iconSentryOne Document allows you to document the Power BI Files, Folder, or Azure components in your environment.

Adding Power BI

Add a Power BI Solution item by completing the following steps:

1. Select Add to add a new Solution, or select Open to open an existing solution in the SentryOne Document Configuration tool. SentryOne Document Solution Configuration Tool Open Solution

2. Select Add to open the Add Solution item window. SentryOne Document Solution Configuration Tool Add Solution Item

3. Enter an item name, and then select Power BI from the Source type drop-down list.SentryOne Document Add Solution Item Power BI

4. Select the Power BI File, Folder, or Azure Power BI.

SentryOne Document Add Solution Item Power BI File
SentryOne Document Add Solution Item Power BI Folder
SentryOne Document Add Solution Item Azure Power BI

5. Select OK to add the Power BI Solution item to your SentryOne Document Solution.SentryOne Document Add Solution Item Power BI select Ok

Power BI Server

Power BI Report Server

Solution Item IconSolution Item Description
SentryOne Document Power BI Report Server provider iconSentryOne Document allows you to document the Power BI Report Server components within your environment. See the System Requirements article for details on prerequisites.

Adding Power BI Report Server

Add a Power BI Report Server Solution item by completing the following steps:

1. Select Add to add a new Solution, or select Open to open an existing solution in the SentryOne Document Configuration tool. SentryOne Document Solution Configuration Tool Open Solution

2. Select Add to open the Add Solution item window. SentryOne Document Solution Configuration Tool Add Solution Item

3. Enter an item name, and then select Power BI Report Server from the Source type drop-down list.SentryOne Document Add Solution Item Power BI Report Server

4. Enter the Power BI Report Server URI in the Server URI box, and then select Validate to verify the connection.SentryOne Document Add Solution Item Power BI Report Server Validate Connection

5. Select OK to add the Power BI Solution item to your SentryOne Document Solution.SentryOne Document Add Solution Item Power BI Report Server select Ok

SQL

SQL Server

Solution Item IconSolution Item Description
SentryOne Document SQL Server Provider

SentryOne Document allows you to document databases across major versions of SQL Server. See the System Requirements article for details on prerequisites.

Adding SQL Server

Add a SQL Server Solution item to your SentryOne Document Solution by completing the following steps:

1. Select Add to add a new Solution, or select Open to open an existing solution in the SentryOne Document Configuration tool. SentryOne Document Solution Configuration Tool Open Solution

2. Select Add to open the Add Solution item window. SentryOne Document Solution Configuration Tool Add Solution Item

3. Enter an item name, and then select SQL Server 2005 - 2019 from the Source type drop-down list.SentryOne Document Add Solution Item SQL Server 2005-2019

4. Select SQL Server, or SQL Azure, and then enter a valid server name and connection credentials.

SentryOne Document Add Solution Item SQL Server credentials
SentryOne Document Add Solution Item SQL Azure credentials

5. Select OK to add the SQL Server Solution item to your SentryOne Document Solution.SentryOne Document Add Solution Item SQL Server select Ok

Important:  Non-sysadmin users must be granted View Server State permissions to view log file objects within the documentation.

SSAS

SSAS Server

Solution Item IconSolution Item Description
SentryOne Document SSAS Server Provider

SentryOne Document is able to document SSAS Cubes and Databases across major versions of SQL Server. See the System Requirements article for details on prerequisites. With the SSAS Cube and Database Documentation you can see the properties and attributes of each dimension in a cube.

Adding SSAS Server

Add an SSAS Server Solution item to your SentryOne Document Solution by completing the following steps:

1. Select Add to add a new Solution, or select Open to open an existing solution in the SentryOne Document Configuration tool. SentryOne Document Solution Configuration Tool Open Solution

2. Select Add to open the Add Solution item window. SentryOne Document Solution Configuration Tool Add Solution Item

3. Enter an item name, and then select SSAS Server 2005- 2014, SSAS Server 2016, or SSAS Server 2017 - 2019 provider from the Source type drop-down list. SentryOne Document Add Solution Item SSAS Server 2017-2019

Important: 

Use the SSAS Server provider when connecting to the following SSAS Modes:

  • MultiDimensional instances with server versions between 2005 and 2014
  • Tabular instances with server versions between 2012 and 2014

Use the SSAS Server 2016 provider when connecting to the following SSAS Modes:

  • MultiDimensional instances with server versions above 2016
  • Tabular instances with server versions above 2016
  • Azure Analysis Services

4. Select On Premises or Azure, and then enter a valid server name and connection credentials for your connection.

SentryOne Document Add Solution Item SSAS On Premises
SentryOne Document Add Solution Item SSAS Azure

Note:  If you have selected SSAS Server 2016 and are attempting to connect to Azure Analysis Services, Azure Active Directory credentials are required. To connect to Azure Analysis Services, you need to download and install the latest Microsoft Azure Analysis Services Client Libraries.

5. Select OK to add the SSAS Server Solution item to your SentryOne Document Solution.SentryOne Document Add Solution Item SSAS select Ok

SSIS

SSIS Package

Solution Item IconSolution Item Description
SentryOne Document SSIS Package Provider

SentryOne Document allows you to quickly develop an overview of your Integration Services Packages. With the SSIS Package documentation you can display diagrams of both the control and data flow of an SSIS package. See the System Requirements article for details on prerequisites.

Note:  SSIS provider works against SSIS 2005 and above when connecting to the File System, SQL Server, SSIS Package Store and SSIS 2012 and above when connecting to the SSIS Catalog.

Adding SSIS Package

Add an SSIS Package Solution item to your SentryOne Document Solution by completing the following steps:

1. Select Add to add a new Solution, or select Open to open an existing solution in the SentryOne Document Configuration tool. SentryOne Document Solution Configuration Tool Open Solution

2. Select Add to open the Add Solution item window. SentryOne Document Solution Configuration Tool Add Solution Item

3.Enter an item name, and then select SSIS 2012, SSIS 2014, SSIS 2016, or SSIS 2017 from the Source type drop-down list. SentryOne Document Add Solution Item SSIS 2017

4. Select the desired SSIS Package connection option (File, Folder, SQL Server, Package Store, and Catalog) and then enter the connection properties.

SentryOne Document Add Solution Item SSIS FileSentryOne Document Add Solution Item SSIS FolderSentryOne Document Add Solution Item SSIS SQL ServerSentryOne Document Add Solution Item SSIS Package StoreSentryOne Document Add Solution Item SSIS Catalog

Note:  The SSIS Provider contains several connection options:

  • File: Select File to document SSIS Item(s) located on the file system. Select the ellipses to open the file explorer and then navigate to the location of any *.dtsx, *.dtproj, *.sln, or *.ispac files.
  • Folder: Select Folder to recursively document all Excel Workbook Item(s) located within a specific folder on the file system. Select the ellipses to open the file explorer and then navigate to a folder that contains at least one SSIS item.
  • SQL Server: Select SQL Server to document SSIS Item(s) deployed to a SQL Server instance.
  • Package Store: Select Package Store to document SSIS Item(s) deployed to an SSIS Package Store.
  • Catalog: Select Catalog to document SSIS item(s) deployed to an SSIS Package Catalog.

Important:  Due to SentryOne Document's need to extract metadata from SSIS Packages, Integrated Security is required to connect to an SSIS Catalog.

5. Select OK to add the SSIS Package Solution item to your SentryOne Document Solution.SentryOne Document Add Solution Item SSIS select Ok

SSRS

SSRS Report

Solution Item IconSolution Item Description
SentryOne Document SSRS Report Provider

SentryOne Document documents SSRS Reports found on the File System across major versions of SQL Server. See the System Requirements article for details on prerequisites. With SSRS Report documentation you can view the properties, parameters, and data sources of a report.

Adding SSRS Report

Add an SSRS Report Solution item to your SentryOne Document Solution by completing the following steps:

1. Select Add to add a new Solution, or select Open to open an existing solution in the SentryOne Document Configuration tool. SentryOne Document Solution Configuration Tool Open Solution

2. Select Add to open the Add Solution item window. SentryOne Document Solution Configuration Tool Add Solution Item

3. Enter an item name, and then select SSRS 2008 R2 - 2017 from the Source type drop-down list.SentryOne Document Add Solution Item SSRS 2008 R2-2017

4. Select the desired SSRS Report connection option (File, Folder, Native Web Service, or SharePoint Web Service) and then enter the connection properties.

SentryOne Document Add Solution Item SSRS FileSentryOne Document Add Solution Item SSRS FolderSentryOne Document Add Solution Item SSRS Native Web ServiceSentryOne Document Add Solution Item SSRS SharePoint Web Service

Note:   The SSRS Provider contains several connection options:

  • File: Select File to document SSRS Item(s) located on the file system. Select the ellipses to open the file explorer and then navigate to the location of any *.rdl, *.rds, *.rsd, or *.rptproj files.
  • Folder: Like File, select Folder to document SSRS Item(s) located on the file system. Unlike file, the Folder option will recursively document all SSRS items located within the folder. Select the ellipses to open the file explorer and then navigate to a folder that contains at least one SSRS item.
  • Native Web Service: Select Native Web Service to document an SSRS Native Web Service. Use the Folder text box to only document specific folders within an Native Web Service.
  • SharePoint Web Service:  Select SharePoint Web Service to document an SSRS SharePoint Web Service. Use the Folder text box to only document specific folders within an Native Web Service.

5. Select OK to add the SSRS Report Solution item to your SentryOne Document Solution.SentryOne Document Add Solution Item SSRS select Ok

Tableau

Tableau Server

Solution Item IconSolution Item Description
SentryOne Document Tableau Server Provider

SentryOne Document allows you to document databases across major versions of Tableau Server. See the System Requirements article for details on prerequisites.

Adding Tableau Server

Add a Tableau Server Solution item to your SentryOne Document Solution by completing the following steps:

1. Select Add to add a new Solution, or select Open to open an existing solution in the SentryOne Document Configuration tool. SentryOne Document Solution Configuration Tool Open Solution

2. Select Add to open the Add Solution item window. SentryOne Document Solution Configuration Tool Add Solution Item

3. Enter an item name, and then select Tableau Server from the Source type drop-down list.SentryOne Document Add Solution Item Tableau Server

4. Enter your valid server name, and connection credentials.SentryOne Document Add Solution Item Tableau Server credentials

Important:  The credentials used to connect to the Tableau Server must be assigned the Server Administrator role.

5. Select OK to add the Tableau Server Solution item to your SentryOne Document Solution.SentryOne Document Add Solution Item Tableau Server select Ok

Filtering Items

Filtering Solution Items

SentryOne Document allows you to control the amount of data you want to record within your solution items. Manage the data within new or existing solution items by using the Edit Filter button. Complete the following steps to filter your solution item:

1. Open an existing SentryOne Document Solution (or create a new one). SentryOne Document Open Solution

2. Select Add to create a new solution item, or select Edit to open an existing solution item.

SentryOne Document Add Solution Item
Add Solution Item

SentryOne Document Edit Solution Item
Edit Solution Item

3. Select Edit Filter to open the Configure filtering window for the selected solution item. SentryOne Document Edit Solution Item select Edit Filter

4. Select the object type(s) you want to exclude from solution item snapshot, and then select Next to continue. SentryOne Document Configure Filtering window Choose included types

Note:  A checkmark SentryOne Document Included Object indicatorindicates that the Object type is included in the snapshot. An X mark SentryOne Document Excluded object indicatorindicates that the object type is excluded from the snapshot. All Object types are included for the solution item by default.

Note:  The next page presents you with a tree diagram that represents the solution item snapshot.  You can select to exclude individual objects in this section.

5. Select SentryOne Document Tree expander buttonto expand the solution item tree, and then select the object(s) you want to exclude from the snapshot. SentryOne Document Configure Filtering window Choose included and excluded items

Note:  Selecting an object at the top of a hierarchy automatically excludes the objects below the selected object.

SentryOne Document Configure Filtering window select to exclude items in hierarchy
SentryOne Document Configure Filtering window items excluded in hierarcy

6. Select OK to save your solution item filter. SentryOne Document Configure Filtering window select Ok to save filter