Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Scroll ignore
scroll-viewporttrue
scroll-pdftrue
scroll-officetrue
scroll-chmtrue
scroll-docbooktrue
scroll-eclipsehelptrue
scroll-htmltrue
scroll-epubtrue

Open in new tab

About Collectors

Insert excerpt
Collector Method
Collector Method
nameabout

...

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

Code Block
languagejson
{
"somehost.adw": "analytics.adw"
}

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
languagejson
{
    "client": "",
    "secret": "",
    "tenant": "",
    "output_path": "/tmp/output",
    "mask": true,
    "timeout": 20,
    "filter_flag": true,
    "filter_workspaces": [],
    "mapping": {
        "myDSN": {
            "host": "myhost",
            "database": "mydatabase"
        }
    },
    "compress": true
}

...