This article describes the different configuration options for BI Pixie.
After you configured the mandatory parameters for BI Pixie Instrumentation in this article, you can find all the additional configuration options in this article.
Configuring BI Pixie Instrumentation ('bi-pixie.exe') is a straightforward process that involves setting up the 'bi_pixie_config.json' file with key parameters to tailor the instrumentation to your specific needs. This configuration file allows you to define project details, subscription information, and web trigger URL, among other settings. Proper configuration ensures that BI Pixie can effectively instrument your Power BI reports and track usage and engagement events. Below, you will find detailed descriptions of each parameter in the configuration files to help you get started.
When you run 'bi-pixie.exe' for the first time, the instrumentation generates the configuration file 'bi_pixie_config.json' with its default parameters. You don't need to download the file.
Before you use BI Pixie Instrumentation on your Power BI reports, you will need to configure 'bi_pixie_config.json' using a text editor (e.g., Notepad) and update the required parameters below. Once you save the configuration file, run 'bi-pixie.exe' again to take the changes into account.
Global Configuration File
The following table describes the parameters in the global configuration file 'bi_pixie_config.json'. After the first run of 'bi-pixie.exe', you can find this file in the target folder. You can configure the parameters and run BI Pixie Instrumentation to instrument the pixies.
| Parameter | Description | Default |
|---|---|---|
project_name | A string that represents the Power BI reports in the target folder. It can be your company name, team name, business unit, or project codename. | "" |
subscription_email | The email you used when you registered for BI Pixie. | "" |
license_key | The license key you received from us. | "" |
pixies_flow_endpoint_url | The URL of the BI Pixie web trigger or Azure Function that listens to events. | "" |
pixies_inventory_flow_url | The URL of the BI Pixie inventory web trigger (Starter deployment only). | "" |
starter_deployment | Set to true for Power Platform deployment, false for Azure deployment. | false |
clean_only | When true, BI Pixie removes all pixies without adding new ones. | false |
use_report_folder_as_project | When true, the folder name of each report is used as the project field in events. | false |
allow_report_level_overrides | When true, BI Pixie reads report-specific configuration from bi_pixie_config_details.json. | false |
track_visual_interaction_details | When true, enables the Visual Clicks Heatmap feature. | false |
track_visual_interaction_max_fields | Maximum number of fields tracked per visual for the heatmap. | 3 |
include_filtered_values | When true, tracks selected dimension values. Set to false for sensitive data. | true |
pixie_visual_group_name | The name of the visual group in the Selection pane. | "{'{'{'} BI Pixie {'}'}'}" |
pixie_measure_folder_name | The name of the measure folder in the Data pane. | "{'{'{'} BI Pixie {'}'}'}" |
Git Settings
BI Pixie can integrate with Git to pull report definitions, commit instrumented changes, and sync with Power BI workspaces. Learn more in this article.
| Parameter | Description | Default |
|---|---|---|
git_enabled | Enable Git integration. | false |
git_url | The URL of the Git repository. | "" |
git_username | Git username or GitHub account name. | "" |
git_password_or_key | Git password or GitHub personal access token. | "" |
git_commit_changes | When true, BI Pixie commits and pushes instrumented changes. | false |
git_commit_message | The commit message for instrumented changes. | "BI Pixie instrumentation" |
git_sync_changes_to_workspaces | When true, syncs committed changes to connected Power BI workspaces. | false |
git_branch | The Git branch to use. | "main" |
Fabric API Settings
BI Pixie can connect to Microsoft Fabric / Power BI service to automatically export and import report definitions. Learn more in this article.
| Parameter | Description | Default |
|---|---|---|
enable_workspace_context | Enable workspace context in events. | false |
auto_mapping_folders_to_workspaces | Auto-map folders to workspace names. | false |
load_items_using_fabric_api | Load report definitions from Fabric API. | false |
save_items_using_fabric_api | Save instrumented definitions back via Fabric API. | false |
include_all_workspaces | When true, reads from all workspaces (not recommended). | false |
include_workspace_ids | Array of workspace IDs to include. | [] |
exclude_workspace_ids | Array of workspace IDs to exclude. | [] |
include_all_reports | When true, reads from all reports in target workspaces. | true |
include_report_ids | Array of report IDs to include. | [] |
exclude_report_ids | Array of report IDs to exclude. | [] |
Feedback Collection Settings
Configure user feedback collection. Learn more in this article.
| Parameter | Description | Default |
|---|---|---|
collect_feedback_enabled | Enable feedback collection. | false |
collect_feedback_in_all_pages | Add feedback slicer on all pages (true) or bookmark navigator on one page (false). | false |
collect_feedback_in_page | Page index for feedback control (when collect_feedback_in_all_pages is false). | 1 |
use_icons_thumbs_up_down | Use thumbs up/down icons. | true |
use_icons_smile_frown | Use smile/frown icons (ignored if thumbs_up_down is true). | false |
use_icons_other | Custom icons object with icon_positive, icon_neutral, icon_negative. | null |
tooltip_label | Tooltip text for the feedback control. | "Is this report helpful?" |
hide_neutral_icon | Hide neutral button in bookmark navigator. | true |
optimize_bookmark_navigators | Group ungrouped bookmarks to prevent them from showing in feedback control. | false |
Embedded Survey Settings
Configure embedded surveys. Learn more in this article.
| Parameter | Description | Default |
|---|---|---|
survey_enabled | Enable embedded survey. | false |
survey_page_title | Survey page name and header title. | "Share Feedback" |
survey_page_description | First sentence in the survey header. | "We appreciate your time..." |
survey_page_instructions | Second sentence in the survey header. | "Simply click on the slicers..." |
survey_progress_gauge_title | Label for the progress gauge. | "% Completed" |
survey_thank_you_title | Thank you message when survey is complete. | "Thank you for the feedback!" |
include_button_to_survey | Add navigation button to survey page. | false |
Report-Level Configuration File
The second configuration file, 'bi_pixie_config_details.json', allows you to override global settings at the report level. To use this file, set allow_report_level_overrides to true in the global configuration file.
After the first run of BI Pixie Instrumentation, you can find this file in the target folder. It will be populated with a list of detected reports. For each report, you can override the following parameters:
track_visual_interaction_detailstrack_visual_interaction_max_fieldsinclude_filtered_valuescollect_feedback_enabledcollect_feedback_in_all_pagescollect_feedback_in_pagesurvey_enabled- All survey question settings
For the full and most up-to-date configuration reference, see the configuration files generated by 'bi-pixie.exe' after its first run. Each parameter includes inline documentation.