examples/example_usage.ipynb

{
 "cells": [
  {
   "cell_type": "markdown",
   "metadata": {},
   "source": [
    "# Install dependencies"
   ]
  },
  {
   "cell_type": "code",
   "execution_count": null,
   "metadata": {},
   "outputs": [],
   "source": [
    "!pip install --upgrade pbir-utils -q"
   ]
  },
  {
   "cell_type": "markdown",
   "metadata": {},
   "source": [
    "# Import Libraries"
   ]
  },
  {
   "cell_type": "code",
   "execution_count": null,
   "metadata": {},
   "outputs": [],
   "source": [
    "import pbir_utils as pbir"
   ]
  },
  {
   "cell_type": "markdown",
   "metadata": {},
   "source": [
    "# Initialize Path Variables"
   ]
  },
  {
   "cell_type": "code",
   "execution_count": null,
   "metadata": {},
   "outputs": [],
   "source": [
    "pbip_directory = r\"C:\\DEV\\Power BI Report\"\n",
    "csv_path = r\"C:\\DEV\\Attribute_Mapping.csv\"\n",
    "output_csv_path  = r\"C:\\DEV\\output.csv\"\n",
    "pbir_report_folder = r'C:\\DEV\\Power BI Report\\Report Name.Report'"
   ]
  },
  {
   "cell_type": "markdown",
   "metadata": {},
   "source": [
    "# Example 1: Batch update attributes in PBIR project\n",
    "Performs a batch update on all components of a Power BI Enhanced Report Format (PBIR) project by processing JSON files in the specified directory. This function updates table and column references in PBIR files based on mappings provided in a CSV file. It is designed to handle the PBIR folder structure where report components are divided into individual JSON files.\n",
    "\n",
    "**Parameters:**\n",
    "- `directory_path` (str): The path to the root directory of the PBIR project (typically the 'definition' folder). This directory should contain all the JSON files representing different components of the PBIR project.\n",
    "- `csv_path` (str): The path to the `Attribute_Mapping.csv` file that contains mappings for updating table and column names. This CSV file should include the following columns:\n",
    "\n",
    "  - `old_tbl`: Old table names\n",
    "  - `old_col`: Old column names\n",
    "  - `new_tbl`: New table names (optional if the table name is unchanged)\n",
    "  - `new_col`: New column names\n",
    "\n",
    "  The `Attribute_Mapping.csv` file should be formatted as follows:\n",
    "\n",
    "  | old_tbl   | old_col         | new_tbl    | new_col        |\n",
    "  |-----------|-----------------|------------|----------------|\n",
    "  | Sale      | sale_id         | Sales      | Sale Id        |\n",
    "  | Sale      | order_date      | Sales      | OrderDate      |\n",
    "  | Date      |                 | Dates      |                |\n",
    "  | Product   | product_name    |            | Product Name   |\n",
    "  | Product   | product_id      |            | Product ID     |\n",
    "\n",
    "  This format enables you to document changes to table and column names within the Semantic Model. If a table name remains unchanged, specifying `new_tbl` is optional. Similarly, if only the table name has changed but the column names remain the same, you do not need to specify `old_col` and `new_col`."
   ]
  },
  {
   "cell_type": "code",
   "execution_count": null,
   "metadata": {},
   "outputs": [],
   "source": [
    "pbir.batch_update_pbir_project(pbip_directory, csv_path)"
   ]
  },
  {
   "cell_type": "markdown",
   "metadata": {},
   "source": [
    "# Example 2: Export attribute metadata to CSV\n",
    "Exports metadata from Power BI Enhanced Report Format (PBIR) into a CSV file. The function processes JSON files within a specified directory to extract detailed information about tables, columns, measures, their DAX expressions, and their usage contexts. It consolidates this information and writes it to a CSV file, which provides a structured view of the PBIR report's metadata.\n",
    "\n",
    "**Parameters:**\n",
    "- `directory_path` (str): The path to the directory containing PBIR JSON files to be processed. You can even specify a parent folder that includes multiple reports within its subdirectories.\n",
    "- `csv_output_path` (str): The path where the output CSV file will be saved.\n",
    "- `filters` (dict): A dictionary where the keys are column names and the values are sets of allowed values. This dictionary is used to pre-filter the data for the final CSV output. \n",
    "    - If a key has an empty set or an empty dictionary as its value, that key will be ignored.\n",
    "    - If `filters` is `None` or an empty dictionary, all data will be processed without any filtering.\n"
   ]
  },
  {
   "cell_type": "code",
   "execution_count": null,
   "metadata": {},
   "outputs": [],
   "source": [
    "pbir.export_pbir_metadata_to_csv(\n",
    "    directory_path=pbip_directory,\n",
    "    csv_output_path=output_csv_path,\n",
    "    filters={\n",
    "        \"Report\": {},\n",
    "        \"Page Name\": {},\n",
    "        \"Page ID\": {},\n",
    "        \"Table\": {},\n",
    "        \"Column or Measure\": {},\n",
    "        \"Expression\": {},\n",
    "        \"Used In\": {},\n",
    "        \"Used In Detail\": {},\n",
    "        \"ID\": {},\n",
    "    },\n",
    ")"
   ]
  },
  {
   "cell_type": "markdown",
   "metadata": {},
   "source": [
    "# Example 3: Display Report Wireframe\n",
    "The function generates and displays interactive wireframes for a report using Dash and Plotly. This function visualizes the layout of pages and their visual components.\n",
    "\n",
    "### Parameters:\n",
    "- **`report_path` (str)**: The path to the root folder of the PBIR report. This folder should contain the `definition/pages` subfolder where the JSON files for pages and visuals are located.\n",
    "\n",
    "- **`pages` (list, optional)**: A list of page names to include in the wireframe visualization. If this list is empty or not provided, all pages will be included. For example: `pages=['Overview', 'Detail']`.\n",
    "\n",
    "- **`visual_types` (list, optional)**: A list of visual types to include in the visualization. Visuals not matching these types will be excluded. If this list is empty or not provided, all visual types will be included. For example: `visual_types=['slicer', 'tableEx']`.\n",
    "\n",
    "- **`visual_ids` (list, optional)**: A list of visual IDs to include. Only visuals with these IDs will be displayed. If this list is empty or not provided, all visuals will be included. For example: `visual_ids=['f0a86ce15d6071a24950', '0b80818ed5eede98baa8']`.\n",
    "\n",
    "- **`show_hidden` (bool, optional)**: Determines whether to display hidden visuals. Set to `True` to show hidden visuals, or `False` to exclude them. Default is `True`.\n",
    "\n",
    "### Behavior:\n",
    "The `pages`, `visual_types`, and `visual_ids` parameters work with an AND logic, meaning that only visuals matching all specified criteria will be shown. For example, setting `pages=['Overview']` and `visual_types=['slicer']` will display only `slicer` visuals on the `Overview` page.\n"
   ]
  },
  {
   "cell_type": "code",
   "execution_count": null,
   "metadata": {},
   "outputs": [],
   "source": [
    "pbir.display_report_wireframes(\n",
    "    report_path=pbir_report_folder,\n",
    "    pages=[],\n",
    "    visual_types=[],\n",
    "    visual_ids=[],\n",
    "    show_hidden=True\n",
    ")"
   ]
  },
  {
   "cell_type": "markdown",
   "metadata": {},
   "source": [
    "# Example 4: Disable Visual Interactions\n",
    "This function disables interactions between visuals based on the provided parameters.\n",
    "\n",
    "### Parameters:\n",
    "\n",
    "- **`report_path` (str)**: The path to the root folder of the PBIR report.\n",
    "\n",
    "- **`pages` (list, optional)**: List of page names to process. If not provided, all pages will be processed. For example: `pages=['Overview']`.\n",
    "\n",
    "- **`source_visual_ids` (list, optional)**: List of specific source visual IDs. If not provided, all visuals will be used as sources. For example: `source_visual_ids=['f0a86ce15d6071a24950', '0b80818ed5eede98baa8']`.\n",
    "\n",
    "- **`source_visual_types` (list, optional)**: List of source visual types. If not provided, all visuals will be used as sources. For example: `source_visual_types=['slicer']`.\n",
    "\n",
    "- **`target_visual_ids` (list, optional)**: List of specific target visual IDs. If not provided, all visuals will be used as targets. For example: `target_visual_ids=['p05f7ce15d6071a24950']`.\n",
    "\n",
    "- **`target_visual_types` (list, optional)**: List of target visual types. If not provided, all visuals will be used as targets. For example: `target_visual_types=['tableEx']`.\n",
    "\n",
    "- **`update_type` (str, optional)**: Determines how interactions are managed. Options include:\n",
    "  - **`\"Upsert\"`**: Disables any existing interactions that match the specified source/target parameters and inserts new combinations. Interactions not part of the specified source/target parameters will remain unchanged. This is the *default option*.\n",
    "  - **`\"Insert\"`**: Inserts new interactions based on the source/target parameters without modifying existing interactions.\n",
    "  - **`\"Overwrite\"`**: Replaces all existing interactions with the new ones that match the specified source/target parameters, removing any interactions not part of the new configuration.\n",
    "\n",
    "### Behavior:\n",
    "\n",
    "1. **If Only `report_path` Is Provided:**\n",
    "   - The function will disable interactions between all visuals across all pages in the report. This means that no visuals on any page will interact with each other.\n",
    "\n",
    "2. **If `report_path` and `pages` Are Provided:**\n",
    "   - The function will disable interactions between all visuals but only on the specified pages. Visuals on pages not listed will remain unaffected.\n",
    "\n",
    "3. **If `source_visual_ids` or `source_visual_types` Are Provided:**\n",
    "   - The function will disable interactions from the specified source visuals (IDs or types) to all other visuals (targets) on the pages specified. For example, if `source_visual_ids` includes `['p05f7ce15d6071a24950']`, interactions involving `p05f7ce15d6071a24950` to all other visuals (or specified target visuals/types) will be disabled on the page.\n",
    "\n",
    "4. **If `target_visual_ids` or `target_visual_types` Are Provided:**\n",
    "   - The function will disable interactions from all source visuals to the specified target visuals. For instance, if `target_visual_ids` includes `['f0a86ce15d6071a24950']`, interactions from all source visuals (or specified source visuals/types) to `f0a86ce15d6071a24950` will be disabled on the page."
   ]
  },
  {
   "cell_type": "code",
   "execution_count": null,
   "metadata": {},
   "outputs": [],
   "source": [
    "pbir.disable_visual_interactions(\n",
    "    report_path=pbir_report_folder,\n",
    "    pages=[],\n",
    "    source_visual_ids=[],\n",
    "    source_visual_types=[],\n",
    "    target_visual_ids=[],\n",
    "    target_visual_types=[],\n",
    "    update_type=\"Upsert\"\n",
    ")"
   ]
  },
  {
   "cell_type": "markdown",
   "metadata": {},
   "source": [
    "# Example 4: Remove report level Measures\n",
    "This function scans through a Power BI PBIR Report and removes report-level measures. It can remove all measures or a specified list of measures, with an option to check if the measures are used in any visuals before removal.\n",
    "\n",
    "## Parameters\n",
    "\n",
    "- **`report_path` (str)**: The file system path to the folder containing the PowerBI report.\n",
    "\n",
    "- **`measure_names` (Optional[list])**: A list of measure names that you want to remove from the report. **If this parameter is `None` or an empty list, all measures in the report will be considered for removal**. \n",
    "\n",
    "- **`check_visual_usage` (bool)**: A flag indicating whether to only remove measures that are not used in any visuals within the report.\n",
    "    - **True**: Only remove a measure if neither the measure itself nor any of its dependent measures are used in any visuals. (default behavior if not specified)\n",
    "    - **False**: Measures will be removed regardless of their usage in visuals."
   ]
  },
  {
   "cell_type": "code",
   "execution_count": null,
   "metadata": {},
   "outputs": [],
   "source": [
    "pbir.remove_measures(\n",
    "    report_path=pbir_report_folder, \n",
    "    measure_names=[], \n",
    "    check_visual_usage=True\n",
    ")"
   ]
  },
  {
   "cell_type": "markdown",
   "metadata": {},
   "source": [
    "# Example 5: Generate measure dependencies report\n",
    "This function generates a dependency tree for measures in a Power BI report, *focusing only on measures that have dependencies on other measures*. \n",
    "\n",
    "## Parameters\n",
    "\n",
    "- **`report_path` (str)**: The file system path to the folder containing the PowerBI report.\n",
    "\n",
    "- **`measure_names` (Optional[list])**: \n",
    "    - This is an optional list of measure names that you want to analyze. \n",
    "    - If you pass a list of measure names, the function will only analyze the dependencies for those specific measures.\n",
    "    - If you pass `None` (default) or an empty list `[]`, the function will analyze all measures in the report.\n",
    "\n",
    "- **`include_visual_ids` (bool)**: This boolean flag determines whether to include the IDs of visuals that use the measures being analyzed.\n",
    "    - **True**: The function will append the visual IDs in square brackets after each measure in the dependency tree.\n",
    "    - **False**: Visual IDs will be excluded (default behavior if not specified)"
   ]
  },
  {
   "cell_type": "code",
   "execution_count": null,
   "metadata": {},
   "outputs": [],
   "source": [
    "print(\n",
    "    pbir.generate_measure_dependencies_report(\n",
    "        report_path=pbir_report_folder, measure_names=[], include_visual_ids=True\n",
    "    )\n",
    ")"
   ]
  },
  {
   "cell_type": "markdown",
   "metadata": {},
   "source": [
    "# Example 6: Update report level filters in the filter pane\n",
    "This function allows you to update the filters added to the Power BI report level filter pane \n",
    "\n",
    "## Parameters\n",
    "\n",
    "- **`directory_path` (str)**: The root directory that contains all the reports to be processed\n",
    "\n",
    "- **`filters` (list)**: A list of filter configurations to apply to the reports.\n",
    "\n",
    "- **`reports` (list, optional)**: A list of specific reports to update. This parameter is optional.\n",
    "\n",
    "### Explanation of Condition Types and Filter Values in `filters`\n",
    "\n",
    "When using the `update_report_filters` function, the `filters` parameter is a list of filter configurations, each consisting of a table, column, condition, and values. The condition types define how the filter should be applied, and the values represent the data that the condition will be matched against. Below is an explanation of the supported condition types and the expected values for each:\n",
    "\n",
    "#### Condition Types:\n",
    "\n",
    "1. **Comparison Conditions**:\n",
    "   - **GreaterThan**, **GreaterThanOrEqual**, **LessThan**, **LessThanOrEqual**:\n",
    "     - These conditions are used to filter records based on comparison operations.\n",
    "     - **Expected Values**: A single value (e.g., a number or date).\n",
    "     - **Example**: For `GreaterThan`, the filter could be configured as `{ \"Condition\": \"GreaterThan\", \"Values\": [50] }`, meaning that only records where the column value is greater than 50 will be included.\n",
    "\n",
    "2. **Range Conditions**:\n",
    "   - **Between**, **NotBetween**:\n",
    "     - These conditions filter records by checking if a value falls within a range.\n",
    "     - **Expected Values**: Two values, representing the start and end of the range.\n",
    "     - **Example**: `{ \"Condition\": \"Between\", \"Values\": [10, 20] }` will include records where the column value is between 10 and 20.\n",
    "\n",
    "3. **Inclusion/Exclusion Conditions**:\n",
    "   - **In**, **NotIn**:\n",
    "     - These conditions check whether a value is within a specified list of values.\n",
    "     - **Expected Values**: A list of one or more values.\n",
    "     - **Example**: `{ \"Condition\": \"In\", \"Values\": [\"A\", \"B\", \"C\"] }` includes records where the column value is \"A\", \"B\", or \"C\".\n",
    "\n",
    "4. **Text Matching Conditions**:\n",
    "   - **Contains**, **StartsWith**, **EndsWith**, and their negated versions (**NotContains**, **NotStartsWith**, **NotEndsWith**):\n",
    "     - These conditions apply to text fields and filter records based on substring matching.\n",
    "     - **Expected Values**: A single string value.\n",
    "     - **Example**: `{ \"Condition\": \"Contains\", \"Values\": [\"keyword\"] }` will filter records where the column value contains the substring \"keyword\".\n",
    "\n",
    "5. **Multi-Value Text Matching Conditions**:\n",
    "   - **Conditions ending in \"And\" or \"Or\"** (e.g., **ContainsAnd**, **StartsWithOr**):\n",
    "     - These conditions allow combining multiple text-matching conditions with logical \"AND\" or \"OR\" operations.\n",
    "     - **Expected Values**: A list of two or more string values.\n",
    "     - **Example**: `{ \"Condition\": \"ContainsOr\", \"Values\": [\"keyword1\", \"keyword2\"] }` will filter records where the column value contains either \"keyword1\" or \"keyword2\".\n",
    "\n",
    "#### Filter Values:\n",
    "\n",
    "- **Date Values**: If the column being filtered is a date field, the filter values should be provided as strings in the format `DD-MMM-YYYY`, such as `\"15-Sep-2023\"`. These values should be included in the `Values` list as `[\"15-Sep-2023\"]`.. \n",
    "  \n",
    "  - **Example**: For a `GreaterThan` condition on a date field, the filter might look like:\n",
    "    ```python\n",
    "    {\n",
    "      \"Table\": \"Orders\",\n",
    "      \"Column\": \"OrderDate\",\n",
    "      \"Condition\": \"GreaterThan\",\n",
    "      \"Values\": [\"01-Jan-2023\"]\n",
    "    }\n",
    "    ```\n",
    "    This would filter records to include only those where the `OrderDate` is after January 1, 2023.\n",
    "\n",
    "- **Numeric Values**: For numeric filters, values should be provided as integers or floats. The function will format these appropriately for the filter condition.\n",
    "  - **Example**: `{ \"Condition\": \"LessThan\", \"Values\": [100] }`\n",
    "\n",
    "- **Text Values**: For text-based conditions, values should be strings.\n",
    "\n",
    "- **None Values**: If the `Values` field is set to `None`, the filter for that column will be cleared, regardless of the condition. This means that any existing filter applied to the specified column will be removed from the report. The `None` value effectively acts as a reset for the filter.\n",
    "  - **Example**: `{ \"Table\": \"Orders\", \"Column\": \"OrderDate\", \"Condition\": \"GreaterThan\", \"Values\": None }` will clear any existing filter on the `OrderDate` column.\n"
   ]
  },
  {
   "cell_type": "code",
   "execution_count": null,
   "metadata": {},
   "outputs": [],
   "source": [
    "pbir.update_report_filters(\n",
    "    directory_path=pbir_report_folder,\n",
    "    filters=[\n",
    "        {\n",
    "            \"Table\": \"Tbl\",\n",
    "            \"Column\": \"Col1\",\n",
    "            \"Condition\": \"In\",\n",
    "            \"Values\": [\"abc\", \"xyz\"],\n",
    "        },\n",
    "        {\n",
    "            \"Table\": \"Tbl\",\n",
    "            \"Column\": \"Col2\",\n",
    "            \"Condition\": \"Between\",\n",
    "            \"Values\": [\"01-Jan-2023\", \"31-Dec-2023\"],\n",
    "        },\n",
    "        {\n",
    "            \"Table\": \"Tbl\",\n",
    "            \"Column\": \"Col3\",\n",
    "            \"Condition\": \"GreaterThan\",\n",
    "            \"Values\": [200],\n",
    "        },\n",
    "        {\n",
    "            \"Table\": \"Tbl\",\n",
    "            \"Column\": \"Col4\",\n",
    "            \"Condition\": \"In\",\n",
    "            \"Values\": None,\n",
    "        },\n",
    "    ],\n",
    "    reports=None,\n",
    ")"
   ]
  },
  {
   "cell_type": "markdown",
   "metadata": {},
   "source": [
    "# Example 7: Sort report level filter pane items\n",
    "This function is designed to reorder filters in report filter pane on a specified sorting strategy. This function supports several different sorting options, which determine the order in which filters are presented in the reports.\n",
    "\n",
    "## Parameters:\n",
    "\n",
    "- **`directory_path`** (str): The root folder containing the reports.\n",
    "- **`reports`** (list, optional): A list of specific reports to update. If not provided, the function will update all reports in the directory.\n",
    "- **`sort_order`** (str, optional): The strategy to use for sorting the filters. Default is `\"SelectedFilterTop\"`.\n",
    "- **`custom_order`** (list, optional): A custom list of filter names to prioritize in order, required only when the sort order is set to `\"Custom\"`.\n",
    "\n",
    "## Sorting Strategies:\n",
    "\n",
    "1. **`Ascending`**:\n",
    "   - This option sorts all filters in alphabetical order by the filter name (i.e., the column's property name).\n",
    "   - **Effect**: Filters are displayed from A to Z.\n",
    "\n",
    "2. **`Descending`**:\n",
    "   - This option sorts all filters in reverse alphabetical order by the filter name.\n",
    "   - **Effect**: Filters are displayed from Z to A.\n",
    "\n",
    "3. **`SelectedFilterTop`** (default):\n",
    "   - This option prioritizes filters that have been selected (i.e., those that have a filter condition applied).\n",
    "   - **Effect**:\n",
    "     - Selected filters are placed at the top of the list, sorted in ascending order.\n",
    "     - Unselected filters (filters with no conditions applied) are placed at the bottom, also sorted in ascending order.\n",
    "     - If there are no selected filters, all filters are sorted in ascending order.\n",
    "\n",
    "4. **`Custom`**:\n",
    "   - This option allows you to define a custom sort order using the `custom_order` parameter.\n",
    "   - **Effect**:\n",
    "     - Filters are ordered based on the list provided in `custom_order`.\n",
    "     - Filters not in `custom_order` are sorted alphabetically and placed below the custom-ordered filters.\n"
   ]
  },
  {
   "cell_type": "code",
   "execution_count": null,
   "metadata": {},
   "outputs": [],
   "source": [
    "pbir.sort_report_filters(\n",
    "    directory_path=pbir_report_folder,\n",
    "    reports=None,\n",
    "    sort_order=\"SelectedFilterTop\",\n",
    "    custom_order=None,\n",
    ")"
   ]
  },
  {
   "cell_type": "markdown",
   "metadata": {},
   "source": [
    "# Example 8: Sanitize PBIR Report\n",
    "Thes function is a powerful utility designed to clean up and optimize Power BI reports by performing various sanitization actions. It helps remove unnecessary components, improve report performance, and maintain a clean report structure.\n",
    "\n",
    "## Parameters\n",
    "\n",
    "### `report_path` (str): The file system path to the folder containing the PowerBI report.\n",
    "\n",
    "### `actions` (list[str]):  A list of sanitization actions to perform on the report.\n",
    "- **Available Actions**:\n",
    "  1. `\"remove_unused_measures\"`: \n",
    "     - Removes measures that are not used in any visuals either directly or indirectly through measure dependencies.\n",
    "     - Helps reduce report complexity and improve performance.\n",
    "\n",
    "  2. `\"remove_unused_bookmarks\"`: \n",
    "     - Removes bookmarks that are not activated through bookmark navigators or actions.\n",
    "     - Cleans up unused bookmark configurations.\n",
    "\n",
    "  3. `\"remove_unused_custom_visuals\"`: \n",
    "     - Removes custom visuals that are not used in the report.\n",
    "     - Reduces report file size and potential performance overhead.\n",
    "\n",
    "  4. `\"disable_show_items_with_no_data\"`: \n",
    "     - Disables the \"Show items with no data\" option for all visuals.\n",
    "     - Helps improve visual performance.\n",
    "\n",
    "  5. `\"hide_tooltip_drillthrough_pages\"`: \n",
    "     - Hides tooltip and drillthrough pages from the report view.\n",
    "     - Keeps the main report clean and focused.\n",
    "\n",
    "  6. `\"set_first_page_as_active\"`: \n",
    "     - Sets the first page of the report as the default active page.\n",
    "     - Ensures a consistent initial view when opening the report.\n",
    "\n",
    "  7. `\"remove_empty_pages\"`: \n",
    "     - Removes pages that do not contain any visuals.\n",
    "     - Streamlines the report structure.\n",
    "\n",
    "  8. `\"remove_hidden_visuals_never_shown\"`: \n",
    "     - Removes visuals and groups that are permanently hidden and never displayed.\n",
    "     - Reduces report complexity with rougue visuals.\n",
    "\n",
    "  9. `\"cleanup_invalid_bookmarks\"`: \n",
    "     - Removes bookmarks referencing non-existent pages or visuals.\n",
    "     - Ensures bookmark integrity and prevents potential errors.\n",
    "\n",
    "- **Example**: \n",
    "  ```python\n",
    "  pbir.sanitize_powerbi_report(\n",
    "      r\"C:\\DEV\\MyReport.Report\", \n",
    "      [\n",
    "          \"remove_unused_measures\", \n",
    "          \"hide_tooltip_drillthrough_pages\", \n",
    "          \"remove_hidden_visuals_never_shown\"\n",
    "      ]\n",
    "  )\n",
    "  ```\n",
    "\n",
    "## Behavior\n",
    "- The function processes each specified action sequentially.\n",
    "- If an unknown action is provided, it will be skipped with a warning message.\n",
    "- Actions are independent and can be combined as needed.\n",
    "\n",
    "## Warnings and Considerations\n",
    "- Always backup your report or have it under version control before running sanitization.\n",
    "- Some actions are irreversible and will permanently remove report components.\n",
    "- Test the sanitized report thoroughly to ensure no critical functionality is lost."
   ]
  },
  {
   "cell_type": "code",
   "execution_count": null,
   "metadata": {},
   "outputs": [],
   "source": [
    "pbir.sanitize_powerbi_report(\n",
    "    r\"C:\\DEV\\git\\Fabric-Cricsheet\\Power BI Report\\Cricsheet Analysis.Report\",\n",
    "    [\n",
    "        \"cleanup_invalid_bookmarks\",\n",
    "        \"remove_unused_measures\",\n",
    "        \"remove_unused_bookmarks\",\n",
    "        \"remove_unused_custom_visuals\",\n",
    "        \"disable_show_items_with_no_data\",\n",
    "        \"hide_tooltip_drillthrough_pages\",\n",
    "        \"set_first_page_as_active\",\n",
    "        \"remove_empty_pages\",\n",
    "        \"remove_hidden_visuals_never_shown\",\n",
    "    ],\n",
    ")"
   ]
  }
 ],
 "metadata": {
  "kernelspec": {
   "display_name": "Python 3",
   "language": "python",
   "name": "python3"
  },
  "language_info": {
   "codemirror_mode": {
    "name": "ipython",
    "version": 3
   },
   "file_extension": ".py",
   "mimetype": "text/x-python",
   "name": "python",
   "nbconvert_exporter": "python",
   "pygments_lexer": "ipython3",
   "version": "3.12.7"
  }
 },
 "nbformat": 4,
 "nbformat_minor": 2
}