Data Dictionary

DOC xPress ›› Features ››
Parent Previous Next

Data Dictionary


Data Dictionary provides users with the ability to annotate the objects within a DOC xPress snapshot, including additional information and comments. Users often want to capture additional information as part of their documentation. Information like SLAs, persons responsible for the data, timeliness of the data, and other attributes can be captured using DOC xPress' Data Dictionary. By adding annotations to existing objects in the DOC xPress repository, users can capture any additional information they desire.


Notice: Data Dictionary works hand-in-hand with the DOC xPress feature and requires an already set up Solution with at least one Snapshot generated. If this has not yet been done, please follow the steps described in "Creating your DOC xPress Solution".


Feature Highlights

  Add business definitions to any item in the documentation

  Provide annotations useful to business users


Tutorial Video


Create and manage annotations in your DOC xPress documentation

Notice: Data Dictionary works hand-in-hand with the DOC xPress feature and requires an already set up Solution with at least one Snapshot generated. If this has not yet been done, please follow the steps described in "Creating your DOC xPress Solution".


1.   When you first open the Data dictionary from Pragmatic workbench you will have the option create a metabase or connect to an existing one.



2.   Once you create your metabase or connect to an existing one you will choose which solution to open.



3.   After opening your solution you will be greeted with the Data Dictionary welcome screen. To get started click "Get Started"



4.   When you create a data dictionary, you will first need to create categories. A category is a field that will contain information about different objects in the solution, such as business owner, emergency contact, etc. Click "Add" to create a category.



5.   On the next page you will name your category and select its scope. This scope can be to the metabase, a whole solution, or an item in a solution. After selecting the scope, choose the technology type and a data type for the category.



6.   You will then choose an applicable item and then click Add.



oAdditionally, users can create custom applicable items by using the Workbench Path Language to select specific metadata object types they wish for the current category to be applied.


Important Note:

For more information on the Workbench Path Language syntax used within the Data Dictionary categories, please click here.


7.   After you click "OK" you will be taken back to the choose solution screen. Select your solution and click open. Inside the solution select the item to which the category was added and click open.



8.   Here you can expand the object tree until you see text boxes, this is where information about the individual objects can be added.



9.   The next time documentation is generated, the data dictionary entries will be displayed within the documentation on each of the corresponding objects containing populated Data Dictionary categories.



10.   The Analyze feature of the Data Dictionary tool allows you to scan your metabase or solution for objects that you've assigned mandatory categories, but have yet to be assigned values.


11.   From the Solution Window, click the "Analyze" button. You will see an Activity Monitor as the one below appear. Any errors or warnings caught during the analysis process will be displayed here.



12.   After you complete the analysis, you will see a results window like the one below. In the example shown, you can see that the Smoke solution has a total of 714 objects with categories, and 35 of those objects are missing values for their required categories. You may also note that 20 of those belong to the Localhost solution item, 1 is in the SSAS - FLWSCONS01 solution item, and the remaining 14 are located in the SSIS Catalog solution item. The items in bold are solution items that have missing entries.


13.   To begin working to resolve these, click on one of the solution items and select "Open" from the right. This will open the Grid View of that object so you may edit the category values.