+
+ + Speckle’s connection to Power BI consists of two parts: - **Data Connector** fetches the data you uploaded from AEC apps to Speckle. @@ -22,19 +30,19 @@ Speckle’s connection to Power BI consists of two parts:  -# Repo Structure +## Repository Structure -This repo is home to our Power BI connector. The Speckle Server provides all the web-facing functionality and can be found [here](https://github.com/specklesystems/Server). +This repository is home to our Power BI connector. The Speckle Server provides all the web-facing functionality and can be found [here](https://github.com/specklesystems/Server). `src/powerbi-data-connector` contains all the code for the Data connector. `src/powerbi-visual` contains all the code for 3D Visual. -# Installation +## Installation -Speckle connector can be installed directly from the [connectors portal](https://app.speckle.systems/connectors/). Full instructions for [installation](https://speckle.guide/user/powerbi/installation.html) and [configuration](https://speckle.guide/user/powerbi/configuration.html) can be found on our docs. +Power BI connector installer can be downloaded from the [connectors portal](https://app.speckle.systems/connectors/). Full instructions for [installation](https://docs.speckle.systems/connectors/power-bi#setup) and [configuration](https://docs.speckle.systems/connectors/power-bi#why-dont-i-see-speckle-as-a-data-source-in-power-bi) can be found on our docs. -# Using 3D Visual +### 3D Visual 3D Visual can be imported as any other Power BI custom visual. @@ -43,34 +51,62 @@ Speckle connector can be installed directly from the [connectors portal](https:/ 3. Go to `Documents/Power BI Desktop/Custom Visuals` and import `Speckle 3D Visual.pbiviz` file. 4. Speckle cube will appear in the Visualization pane. -For more on how to use the visual, [check our docs](https://speckle.guide/user/powerbi-visual/introduction.html). +For more on how to use the visual, [check our docs](https://docs.speckle.systems/connectors/power-bi). -# Usage +## Quick Start -To get started with Power BI connectors, please take a look at the [documentation](https://speckle.guide/user/powerbi/introduction.html) and extensive [tutorials](https://www.youtube.com/playlist?list=PLlI5Dyt2HaEsZHG2WJ75WIM0Brx6VHT2S) published. +To get started with Power BI connector, please take a look at the [documentation](https://docs.speckle.systems/connectors/power-bi) and extensive [tutorials](https://www.youtube.com/@SpeckleSystems) published. -# **Developing & Debugging** +## Development Setup -We encourage everyone interested to debug/hack/contribute/give feedback to this project. +### For local development of the 3D Visual -## **Setup** +1. **Clone the repository**: + ```bash + git clone https://github.com/specklesystems/speckle-powerbi.git + cd speckle-powerbi + ``` -### **Install PowerQuery SDK** +2. **Navigate to the visual directory**: + ```bash + cd src/powerbi-visual + ``` -Follow the instructions from the [official docs](https://docs.microsoft.com/en-us/power-query/installingsdk) +3. **Install dependencies**: + ```bash + npm install + # or + yarn install + ``` -### **Build with Visual Studio** +4. **Start development server**: + ```bash + npm run dev + ``` -Every time you build the connector, VisualStudio will copy the latest `.mez` connector file to the appropriate location. Just restart PowerBI to see the latest changes. +5. **Build the visual**: + ```bash + # Development build + npm run build:dev + + # Production build + npm run build + ``` -### **Debug** +### For local development of the Data Connector -You can start the PowerQuery connector in VisualStudio, this will open a standalone connector you can use for testing purposes. +1. **Install PowerQuery SDK**: + Follow the instructions from the [official docs](https://docs.microsoft.com/en-us/power-query/installingsdk) -We don't know of a way to debug the connector live in PowerBI, but we'd be happy to hear about it. +2. **Open the project in Visual Studio Code**: + - Open `src/powerbi-data-connector/Speckle.proj` + - Build the project to generate the `.mez` file +3. **Testing the connector**: + - Visual Studio will automatically copy the `.mez` file to the appropriate location + - Restart Power BI Desktop to see the latest changes -# About Speckle +## About Speckle What is Speckle? Check our  @@ -91,12 +127,10 @@ What is Speckle? Check our ](https://app.speckle.systems) ⇒ creating an account at our public server +- [](https://app.speckle.systems) ⇒ creating an account at our public server ### Resources - [](https://speckle.community) for help, feature requests or just to hang with other speckle enthusiasts, check out our community forum! - [](https://speckle.systems) our tutorials portal is full of resources to get you started using Speckle -- [](https://speckle.guide/dev/) reference on almost any end-user and developer functionality - - +- [](https://docs.speckle.systems) reference on almost any end-user and developer functionality