How to Configure the TX Dictionary project

Visualize your Discovery Hub metadata with TX Dictionary

The TX Dictionary project allows developers and business users alike to benefit from the valuable insight provided by Discovery Hub's metadata. Once deployed & executed, this project extracts the raw data from Discovery Hub's project repository and transforms it into a denormalized data warehouse format ready for reporting and analysis. 

With this project you can:

1. Provide an always up-to-date Data Dictionary to your business users in the reporting tool of your choice including custom object definitions & data lineage. 
2. Analyze execution packages in detail to improve performance & pinpoint problem areas.
3. See detailed execution messages over time. 
4. Report on validation errors and warnings counts over time. 

Below is an example dashboard analyzing execution performance. 

To learn more about the tables and fields available in the TX Dictionary project you can download the 'TX Dictionary Table & Field Descriptions' excel file at the bottom of this article. It contains descriptions of all the tables and fields in the presentation layer as well as a simple data model. 

Download and Configure the TX Dictionary Project

Download the TX Dictionary Project from the Cube Store

1. In the File Menu, click CubeStore.
2. Click TXDictionary in the list
3. Click Request Trial
4. Click Download

Once imported Select ‘Yes’ to run the Connection Manager

In the Connection manager, Click Run Wizard. The wizard will open the "edit" dialogue for each of the database connections in the project. 

1. Create an ODX database
2. Connect to an existing MDW Database (Optional)
3. Connect to an existing Project Repository and ‘Test Connection’
4. Create an MDW database
5. Create a DSA database
6. Create an OLAP Server (Optional)
   • *If you do not have an OLAP server, or plan to use an SSAS Multidimensional OLAP database for analysis, you should delete the OLAP server in the project later. 

Once complete, click ‘Test Connections’ and validate the Connection States are all green.

Finally, be sure to Deploy and Execute the Project.

Dashboards included with TX Dictionary

Excel Pivot Table Report

The Excel Pivot Table Report works with the included SSAS Multidimensional OLAP Cube as a data source. Ensure you have deployed and executed the OLAP cube included in the TX Dictionary Project. If the Cubes are guarded, right-click the cube and under advanced click Gaurd. 

Download and open the attached "Data Dictionary Pivot Table Report.xlsx" 

In the Analyze tab click Change data source. 

Point Excel to the OLAP server created by the TX Dictionary Project. If you are unsure what this is called, open the project and edit the OLAP server to see the proper name. It should be called "TXDictionary_OLAP"

Once this is done, in the Analyzed tab, click Refresh All. You may need to remove and re-add the pivot table "rows" to get the dashboard to update properly. 

Qlik App

The Qlik App provides easy access and reporting on your repository.  There are 4 Dashboards included as part of the TX Dictionary, Execution Time, Failed Executions, and Data Quality. This App connects to the "TXDictionary" Semantic Model, with an added Qlik Endpoint.

Qlik App Installation Instructions:

1. In the TX Dictionary Discovery Hub project, Add a Qlik Endpoint to the TXDictionary Semantic Model & Deploy. 
2. Right Click on the Endpoint>Qlik Sens Scripts.
3. Copy the Qlik Script from the Endpoint.
4. Download the  ‘TX Dictionary.qvf’ file at the end of this article and place into your Qlik Apps folder.
5. Open the app in Qlik and navigate to the 'Data load editor'. 
6. In the section called TX DWA (auto-generated) delete any existing script. 
7. Paste in the script copied from the Qlik Endpoint & Load Data. 

Tableau Workbook

The Tableau Workbook provides 4 dashboards including Data Dictionary, Execution Time, Execution Status, and Data Health. 

Tableau Workbook Installation Instructions:

1. In the TX Dictionary Discovery Hub project, Add a Tableau Endpoint to the FieldData and Executions Semantic Models & Deploy. Remember the file path where the TDS files are stored. 
2. Download The 'TXDictionary.twb' file at the end of this article and open with Tableau. 
3. Under the 'Data' menu, and under 'FieldData' click 'Replace Data Source...'
4. Select the FieldData TDS file created earlier. 
5. Now repeat the last two steps for the 'Executions' Data Source. 

PowerBI Report

The PowerBI report contains 4 sheets including a data dictionary, executions, failed executions, and data quality. This report operates from an SSAS Tabular model. *An SSAS Tabular instance is required. 

1. In the TX Dictionary Discovery Hub project, Add a Tabular Endpoint to the TX Dictionary Semantic Model and Deploy & Execute. Remember the server and database name of your tabular model.  
2. Download the 'TXDictionary.pbix' file at the end of this article and open with PowerBI. 
3. Open the pbix file and you will receive an error message like this. 
   1.     Click Edit. 
4. Put in the server\instance and database name of the TX Dictionary tabular model you deployed in step 1. 
5. Now click refresh and the report should load with the TX Dictionary data.