| Scroll ignore | ||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||||||||
About Collectors
| Insert excerpt | ||||||
|---|---|---|---|---|---|---|
|
...
Python 3.6 - 3.10
Access to the KADA Collector repository that contains the PowerBI whl
The repository is currently hosted in KADA’s Azure Blob Storage. You will be given a SAS token to access the repository. Reach out to KADA Support (support@kada.ai) if you do not have access.
Download the Power BI whl (e.g. kada_collectors_extractors_powerbi-#.#.#-py3-none-any.whl)
Access to K landing directory
Access to Power BI (see section below)
...
Some python packages also have dependencies on the OS level packages, so you may be required to install additional OS packages if the below fails to install.
You can download the latest Core Library and whl via Platform Settings → Sources → Download Collectors
...
Run the following command to install the collector.
| Code Block |
|---|
pip install kada_collectors_extractors_powerbi-3.1.0-py3-<version>-none-any.whl |
You will also need to install the common library kada_collectors_lib -1.0.2 for this collector to function properly.
| Code Block |
|---|
pip install kada_collectors_lib-1.0.2-py3<version>-none-any.whl |
...
Step 4: Configure the Collector
The collector requires a set of parameters to connect to and extract metadata from Power BI
FIELD | FIELD TYPE | SUPPORTED VERSION | DESCRIPTION | EXAMPLE | |||||
|---|---|---|---|---|---|---|---|---|---|
client | string | 2.0.0+ | Onboarded client in Azure to access powerbi | ||||||
secret | string | 2.0.0+ | Onboarded client secret in Azure to access powerbi | ||||||
tenant | string | 2.0.0+ | Tenant ID of where powerbi exists | ||||||
output_path | string | 2.0.0+ | Absolute path to the output location where files are to be written | “/tmp/output” | |||||
mask | boolean | 2.0.0+ | To enable masking or not | true | |||||
timeout | integer | 2.0.0+ | Timeout in seconds allowed against the powerbi APIs, for slower connections we recommend 30, default is 20 | 20 | |||||
filter_flag | boolean | 2.1.0+ | Enable or disable filtering workspaces based on filter_workspaces | false | |||||
filter_workspaces | list<string> | 2.1.0+ | List of workspace names that should be processed, this is case insensitive. Note that personal workspaces are excluded globally and will never be included even if you include it here. | [“data lab”, “analysis models”] | |||||
mapping | JSON | 2.0.0+ | Add the mapping for each data source in Power BI to a data source that is loaded into K. You will need to map the data source name in Power BI to the data source host name in K (these can be found on the Sources page) Skip any data sources are not onboarded in K (these will be loaded in as references until the source is added to K). See Host / Database Mapping for more details | Where somehost is the alternate name created in Power BI for the Analytics database that has been onboarded to K
| |||||
compress | boolean | 3.0.0+ | To gzip the output or not | true |
These parameters can be added directly into the run or you can use pass the parameters in via a JSON file. The following is an example you can use that is included in the example run code below.
...
| Code Block | ||
|---|---|---|
| ||
{
"client": "",
"secret": "",
"tenant": "",
"output_path": "/tmp/output",
"mask": true,
"timeout": 20,
"filter_flag": true,
"filter_workspaces": [],
"mapping": {
"myDSN": {
"host": "myhost",
"database": "mydatabase"
}
},
"compress": true
} |
...