Skip to content

Commit

Permalink
Updating the repo of the product
Browse files Browse the repository at this point in the history
Adding readme and manual installation to the repo
  • Loading branch information
ibarrau committed May 12, 2022
1 parent d61c3e7 commit 649169d
Show file tree
Hide file tree
Showing 10 changed files with 93 additions and 2 deletions.
File renamed without changes.
36 changes: 36 additions & 0 deletions Manual Installation/DataQualityReport.bat
Original file line number Diff line number Diff line change
@@ -0,0 +1,36 @@
@echo off

:: Below section defines the server and databasename based on the input captured from the External tools integration.
:: This is defined as arguments \"%server%\" and \"%database%\" in the external tools json.
set Server=%1
set DatabaseName=%2

:: Below you can define your personal preference for file saving and reading.
:: The outputfolder will be used to dump a temporarily file with the connection to the model.
:: The PBITLocation defines where the templated PBIT file is saved.

set PBITLocation="C:\Users\Public\LaDataWeb\DataQualityReport\"DataQualityReport.pbit
set JsonOutput="C:\Users\Public\LaDataWeb\DataQualityReport\"DataQualityReport.json

:: Write Server and Database information to screen.
echo %Server%
echo %DatabaseName%
echo %PBITLocation%
::Write-Host $DatabaseName

:: Generate json array based on the received server and database information.
set jsoncito="{\"Server\":\"%Server%\",\"DatabaseName\":\"%DatabaseName%\"}"
::$json = @"
:: {
:: "Server": "$Server",
:: "DatabaseName": "$DatabaseName"
:: }
::"@
:: Writes the output in json format to the defined file location. This is a temp location and will be overwritten next time.
::$OutputLocation = $OutputFolder + 'DataQualityReport.json'
::$json | ConvertTo-Json | Out-File $OutputLocation
@echo %jsoncito% >%JsonOutput%
:: Open PBIT template file from PBITLocation as defined in the variable.
::"C:\Users\IBARRAU\Desktop\RecentFiles\DocumentPBI\"DataQualityReport.pbit
start "" %PBITLocation%
exit /b
Binary file added Manual Installation/DataQualityReport.json
Binary file not shown.
Binary file added Manual Installation/DataQualityReport.pbit
Binary file not shown.
8 changes: 8 additions & 0 deletions Manual Installation/LaDataWeb_DataQualityReport.pbitool.json

Large diffs are not rendered by default.

Binary file added Manual Installation/Media/CMDedit.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added Manual Installation/Media/external_json.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
27 changes: 27 additions & 0 deletions Manual Installation/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,27 @@
# Manual Installation
Data Quality Report can be installed manually. It consists in four files:
- DataQualityReport.json
- DataQualityReport.pbit
- DataQualityReport.bat
- LaDataWeb_DataQualityReport.pbitool.json

Two of those files will need modifications in order to work out. Let's understand how this works and then how we are distribution and modifying files
<br>First the button from the external tools menú will open cmd batch script in windows and run the bat file. That file captures the server and database of the current instance of PowerBiDesktop Analysis Service endpoint and writes it in the json file.
<br>Before finishing the script it opens the Power Bi Template (pbit file). The template asks for the location of the json file to read the server and database in order to start the analysis.
<br>Once added the parameter you can select windows current credentials
<br>![Windows_Current_Credential](media/Windows_Credentials.png "Instruction to pick correct credentials.")
<br>The first refresh WILL fail. You need to open the Power Bi Settings/Option and change the privacy levels to Ignore them. The main page of the report contains a GIF teaching you how to do it.

### Now let's talk about the files.
#### Distribution
We recommend copying the first three files in the same folder. It might be better under Users folder because windows ask for admin permission outside that structure.
<br>Be sure to copy the last file (pbitool.json) to the following folder: "C:\Program Files (x86)\Common Files\Microsoft Shared\Power BI Desktop\External Tools"
#### Modifications
You need to modify "DataQualityReport.bat". You can open it with a simple text editor like notepad, vs code, notepad++, etc.
<br>The first lines will show you the paths to specify where it should write the json file and where to open the pbit file. If you have everything in the same folder it might be easier.
<br>![CMDmodification](media/CMDedit.png "Instruction to change bat file.")
<br>You also need to edit "LaDataWeb_DataQualityReport.pbitool.json". The file that let PowerBi understand you have an external tool and what to do with it.
<br>There is another path here to modify. This one is asking for the ps1 path. Again if you have save the three first files in the same folder it would be easy to change it.
<br>![pbitool_edit](media/external_json.png "Instruction to change external tool json file.")

We hope that's clear. If you can't make it you can always try the installer that will do this automatically.
24 changes: 22 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,2 +1,22 @@
# data-quality-report
Power Bi External Tool to measure the quality of the data imported in a open Power Bi Desktop file
# Data Quality Report for Power Bi
Data Quality Report is an External Tool to add in Power Bi. It creates a new Power Bi Desktop file from the current one that it's open.
The new file will contain:
- First look on the tables structure and errors/white spaces.
- Understanding the text/date and number distributions of data for each table.
- Getting insights of categorical columns. Most used category for each table.
- Checking how relationships are built.

This tool is perfect for first steps in a new data analytics and science projects. It can help us getting a good understanding of the data we are going to use. Just load the data the customer is talking about in a new Power Bi Desktop File and open the Data Quality Report from External Tools menú.
Understanding the Data Quality is a critical knowledge we need to improve our estimations on a project. Data projects shoulnd't underestimate the time cleaning and transforming data might take.

<br><a href="https://github.com/ladataweb/data-quality-report/blob/main/LICENSE" target="_blank">License</a>

### Public Preview

Data Quality Report is in public preview. The relase will let install the tool in two ways.
1. <a href="">Install file .exe</a>: just clikc on it and it will decompress the necesary files to have the tool automatically in Power Bi Desktop.
2. <a href="">Portable manual version</a>: a set of files with the code and instructions to understand how it works.

### How to use
Open Power Bi Desktop and get data from the sources/tables you want to analyse. You need to get them in import mode. Then just go to "External Tools" in tab and open DataQualityReport.
That will open a new Power Bi Desktop file with the analysis. Navigate it to understand the quality of your data.

0 comments on commit 649169d

Please sign in to comment.