SentryOne Document Data Dictionary

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

Data Dictionary Overview

Data Dictionary allows you to annotate the objects within a SentryOne Document snapshot, including additional information and comments. Within your documentation, you may want to capture additional information like SLAs, persons responsible for the data, timeliness of the data, and other attributes. This additional information can be captured using the SentryOne Document data dictionary. Add annotations to existing objects in your SentryOne Document portal to capture any additional information you desire.

Note:  Data Dictionary requires an existing solution with at least one snapshot generated. For more information about creating a solution and creating a snapshot, see the Getting Started article. 

Feature Highlights

  • Add business definitions to any item in the documentation
  • Provide annotations useful to business users

Data Dictionary Tabs

The following pages are available within the SentryOne Document data dictionary tab:

Categories

Data Dictionary Categories 

SentryOne Document Data Dictionary Categories

Create Data Dictionary categories to enter your annotated data. Categories can be applied to varying object types within your solutions. Define the scope for each category, and set restrictions for technology and data types. For example, you can create a Use Case category that applies only to SQL Sever database tables. 

FeatureDescription
NameThe name of the Data Dictionary category.
ScopeThe Solutions and Solution items that are applicable to the Data Dictionary category.
Technology TypeThe Technology type of the Data Dictionary category.
RequiredDenotes if the Data Dictionary category is required in the documentation. 
ButtonDescription
SentryOne Document Data Dictionary Show Deleted buttonDisplays previously deleted Data Dictionary categories. 
SentryOne Document Data Dictinoary Add buttonOpens the Add Category window, and allows you to configure a new Data Dictionary category.
SentryOne Document Data Dictionary Edit buttonOpens the Edit Category window and allows you to edit the selected Data Dictionary category. Select Save to save your changes.
SentryOne Document Data Dictionary Delete buttonOpens the Confirm Action window. Select Delete to delete the selected Data Dictionary Cateogry
SentryOne Document Data Dictionary Restore buttonRestores the selected Data Dictionary category.

Note:  Data Dictionary categories can be applied only to specific solutions or solution items, or can be applied globally throughout your SentryOne Document environment.

Note:  Before your SentryOne Document solutions are annotated with Data Dictionary entries, you need to create categories. A category is a field that contains information about different objects in the solution such as business owner, emergency contact, etc.

Data Dictionary categories can consist of one of the following data types: 

Data TypeDescriptionExample
TextThe Data Dictionary category will store a simple text value on a single line.SentryOne Document Data Dictionary Text Category example
ListThe Data Dictionary category will store values in a bulleted list format.SentryOne Document Data Dictionary List Category example
NoteThe Data Dictionary category will store a long text value.SentryOne Document Data Dictionary Note Category example
DateTimeThe Data Dictionary category will store a date and time value.SentryOne Document Data Dictionary DateTime Category example
NumberThe Data Dictionary category will store a numerical value.SentryOne Document Data Dictionary Number Category example
DropDownThe Data Dictionary category will store a drop-down list of values, where you can select one value.SentryOne Document Data Dictionary Dropdown category example
PickListThe Data Dictionary category will store a list of values where you can select multiple values.SentryOne Document Data Dictionary Picklist Category example
MarkDownThe Data Dictionary category will store a lightweight markup where you can apply simple formatting like bold or italic. Add italics to your text in this format *text*. Add bold around your text in this format **text**.SentryOne Document Data Dictionary Markdown Category example

To add Categories to the SentryOne Document Data Dictionary, complete the following steps :

1. Select Data Dictionary > Categories to open the Categories page. SentryOne Document select Data Dictionary Categories

2. Select the button to open the Add Category form.  

3. Enter a Name for your category, and select the Solution where you want the category to be applied. Note:  All Solutions is selected by default. Selecting an individual solution allows you to make a selection in the Solution Item drop-down list. All solutions Items is selected by default.SentryOne Document Data Dictionary Add Category select Solution

4. Select the applicable Technology Type for your Data Dictionary category. Note:  Global is selected by default, which applies to all technology types supported by SentryOne Document.SentryOne Document Data Dictionary Add Category select Technology Type

5. Select the Data Type for your Data Dictionary Category. Note:  If you select DropDown, or PickList, the Value Set drop-down becomes selectable and allows you to select a previously created Value List.SentryOne Document Data Dictionary Add Category select Data Type

6. Select the Required selector if you want the category to be required, and then select the Applicable Item(s) for the category from the drop down list. Select Save to create your category.

SentryOne Document Data Dictionary Add Category select Applicable items
SentryOne Document Data Dictionary Add Category select Save

7. Return to the Solutions dashboard, and start a snapshot for the applicable solution(s) to have your category added to the documentation. 

SentryOne Document Snapshot Configuration for Solution

Success: You have now created a Data Dictionary category for your documentation!

Adding Values to your Categories

After successfully adding Data Dictionary Categories to your documentation, and creating a new snapshot, you can begin adding values to applicable objects. Add values to your Data Dictionary categories by completing the following steps:

1. Open the SentryOne Document Documentation page, and then select the applicable solution.

SentryOne Document select Documentation page
SentryOne Document Documentation select Solution

2. Select a solution item from the solution explorer, and navigate to an object that applies to the category. SentryOne Document Documentation select Solution item

Note:  Data Dictionary categories that have Global Entry values are populated automatically. Global Entry values are designated by a SentryOne Document Data Dictionary Global Entry iconicon. 

3. Select Edit to begin adding values to your category. SentryOne Document Documentation Edit Data Dictionary

4. Enter the desired values, then select Save to commit your changes. SentryOne Document Documentation Save Data Dictionary values

Note:  While in the Edit menu, select Override global entry to make changes to a category with a global entry value. Enter your desired change, then select Save to save your changes. Select Revert to global entry to return the category to the global entry value.

SentryOne Document Data Dictionary Override global entry
SentryOne Document Data Dictionary enter new value

Change History

Select the view history SentryOne Document Data Dictionary View History buttonbutton on the Documentation page to open the Change History window and review the changes made to your Data Dictionary values. 

SentryOne Document Data Dictionary Change History

OptionDescription
ViewSelect the View SentryOne Document Data Dictionary View Changes buttonbutton to open the Data Dictionary Change window and view the changes for the selected time period.
Changed AtThe date and time the Data Dictionary was changed.
Changed ByThe user or event that made changes to the Data Dictionary.
Change TypeThe type of change made to the Data Dictionary.
SummaryA brief display of the changes made to the Data Dictionary. To see more information about the changes, select the View button. 

Select the View SentryOne Document Data Dictionary View Changes button button to display the changes made to your Data Dictionary values. SentryOne Document Data Dictionary Changes

Note:  The Show Changes only toggle is enabled by default. Deactivate the Show Changes only toggle to display Data Dictionary values that haven't been changed.SentryOne Document Data Dictionary Changes show all

Deleting a Category

Delete a Data Dictionary category within your SentryOne Document portal by completing the following steps:

1. Select the Delete button for the desired Data Dictionary category to open the Confirm action prompt.SentryOne Document Data Dictionary Categories Delete Category

2. Select Delete to remove your Data Dictionary category.SentryOne Document Data Dictionary Categories Confirm Delete

Note:  You can use the Show Deleted toggle to display previously deleted Data Dictionary categories.SentryOne Document Data Dictionary Categories Show Deleted

Global Entries

Global Entries

SentryOne Document Data Dictionary Global Entries

Global Entries are default values that can be applied to varying objects within your documentation if you haven't already defined the values in the documentation view. 

FeatureDescription
CategoryThe Category assigned to the global entry.
ScopeThe Solutions and Solution items that are applicable to the Data Dictionary Global Entry. 
Technology TypeThe Technology type of the Global Entry.
ButtonDescription
SentryOne Document Data Dictionary Show Deleted buttonDisplays previously deleted Data Dictionary Global Entries. 
SentryOne Document Data Dictinoary Add buttonOpens the Add Global Entry window, and allows you to configure a new Data Dictionary Global Entry.
SentryOne Document Data Dictionary Edit buttonOpens the Edit Global Entry window and allows you to edit the selected Data Dictionary Global Entry. Select Save to save your changes.
SentryOne Document Data Dictionary Delete buttonOpens the Confirm action window. Select Delete to delete the selected Data Dictionary Global Entry.
SentryOne Document Data Dictionary Restore buttonRestores the selected Data Dictionary Global Entry.

Note:  You don't need to take a snapshot to make Global Entries applicable to your documentation. 

Note:  You need to create Data Dictionary Categories before creating Global Entries. 

Add Global Entries to your SentryOne Data Dictionary by completing the following steps: 

1. Select Data Dictionary > Global Entries to open the Global Entries page.SentryOne Document select Data Dictionary Global Entries

2. Select the button to open the Add Global Entries form.SentryOne Document Data Dictionary Global Entries Add entry

3. Select the applicable category for your Global Entry.SentryOne Document Data Dictionary Add Global Entry select Category

4. Select the solution where you want the global entry to be applied. Note:  All Solutions is selected by default. Selecting an individual solution allows you to make a selection in the Solution Item drop-down list. All solutions Items is selected by default.SentryOne Document Data Dictionary Add Global Entry select Solution

5. Select the applicable Technology type for your Global Entry. Note:  Global is selected by default, which applies to all technology types supported by SentryOne Document.SentryOne Document Data Dictionary Add Global Entry select Technology Type

6. Enter the default value for your Global Entry in the Value section. SentryOne Document Data Dictionary Add Global Entry enter Value

7. Select the Applicable Item(s) for the Global Entry from the drop down list, and then select Save to create your Global Entry.SentryOne Document Data Dictionary Add Global Entry select Applicable Items

Note:  When you generate new documentation, the global entries display on each applicable object.

Deleting a Global Entry

Delete a Data Dictionary Global Entry within your SentryOne Document portal by completing the following steps:

1. Select the Delete button for the desired Data Dictionary Global Entry to open the Confirm action prompt.SentryOne Document Data Dictionary Global Entries Delete Entry

2. Select Delete to remove your Data Dictionary Global Entry.SentryOne Document Data Dictionary Global Entries Confirm Delete

Note:  You can use the Show Deleted toggle to display previously deleted Global Entries.

Value Lists

Value Lists

SentryOne Document Data Dictionary Value Lists

Value Lists in SentryOne Document are user-defined lists of supported values that can be selected to populate multiple Data Dictionary categories. For example, if you have created an employee category, you can add a value list to the category that lists each employee within your organization. If you decide to create another category that uses this same list of employees, you can add the value list to the category instead of re-creating your employee list. 

FeatureDescription
List nameThe name of the Data Dictionary value list.
ButtonDescription
SentryOne Document Data Dictinoary Add buttonOpens the Add Value List window, and allows you to configure a new Data Dictionary Value List.
SentryOne Document Data Dictionary Edit buttonOpens the Edit Value List window and allows you to edit the selected Data Dictionary Value List. Select Save to save your changes.
SentryOne Document Data Dictionary Delete buttonOpens the Confirm action window. Select Delete to delete the selected Data Dictionary Value List.

Note:  Value Lists are applicable to categories that use the picklist or dropdown data types.

Create a re-usable Value List for your SentryOne Document Data Dictionary by completing the flowing steps:

1. Select Data Dictionary > Value Lists to open the Value Lists page.SentryOne Document select Data Dictionary Value Lists

2. Select the button to open the Value List form.SentryOne Document Data Dictionary Value List add list

3. Enter a name for the value list, and enter a value. Select the symbol to add the value to the list. You can add as many values as you want. SentryOne Document Data Dictionary Create new value list

Note:  You can select (delete) to remove an entered value. Selecting the Show-Deleted toggle displays all previously deleted values. Select the (restore) button to restore the value to the list. 

SentryOne Document Data Dictionary Create new value list delete entry
SentryOne Document Data Dictionary Create new value list restore entry

4. After you are satisfied with the values in your list, select Save to create your value list. SentryOne Document Data Dictionary Create new value list select Save

Success: You can now use your value list for Data Dictionary categories with the picklist or dropdown data types.

SentryOne Document Data Dictionary Add Category select Value List
SentryOne Document Data Dictionary Value List selection

Deleting a Value List

Delete a desired Value List in your SentryOne Document environment by completing the following steps:

1. Select the Delete button for the desired value list to open the Confirm action window.SentryOne Document Data Dictionary Value Lists Delete list

2. Select Delete to remove your Data Dictionary Value List.SentryOne Document Data Dictionary Value Lists Confirm Delete