-
Notifications
You must be signed in to change notification settings - Fork 15
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
1 changed file
with
56 additions
and
52 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,96 +1,100 @@ | ||
| <h1 align="center"> | ||
| <img src="https://user-images.githubusercontent.com/2679513/131189167-18ea5fe1-c578-47f6-9785-3748178e4312.png" width="150px"/><br/> | ||
| Speckle | PowerBI | ||
| Speckle | Power BI | ||
| </h1> | ||
| <h3 align="center"> | ||
| Data Connector and 3D Viewer Visual for PowerBI platform | ||
| Data Connector and 3D Viewer Visual for Power BI platform | ||
| </h3> | ||
| <p align="center"><b>Speckle</b> is the data infrastructure for the AEC industry.</p><br/> | ||
|
|
||
| <p align="center"><a href="https://twitter.com/SpeckleSystems"><img src="https://img.shields.io/twitter/follow/SpeckleSystems?style=social" alt="Twitter Follow"></a> <a href="https://speckle.community"><img src="https://img.shields.io/discourse/users?server=https%3A%2F%2Fspeckle.community&style=flat-square&logo=discourse&logoColor=white" alt="Community forum users"></a> <a href="https://speckle.systems"><img src="https://img.shields.io/badge/https://-speckle.systems-royalblue?style=flat-square" alt="website"></a> <a href="https://speckle.guide/dev/"><img src="https://img.shields.io/badge/docs-speckle.guide-orange?style=flat-square&logo=read-the-docs&logoColor=white" alt="docs"></a></p> | ||
| <p align="center"></p> | ||
|
|
||
| # About Speckle | ||
| Speckle Power BI Data Connector lets you easily get data from Speckle into Power BI reports and visualizations. You can access and analyze data from various AEC apps (like Revit, Archicad, Grasshopper, and more) and open-source files (IFC, STL, OBJ, etc.) into Power BI with ease. | ||
|
|
||
| What is Speckle? Check our  | ||
| Speckle’s connection to Power BI consists of two parts: | ||
|
|
||
| ### Features | ||
| - **Data Connector** fetches the data you uploaded from AEC apps to Speckle. | ||
| - **3D Visual** allows you to see those models in 3D within Power BI. | ||
|
|
||
| - **Object-based:** say goodbye to files! Speckle is the first object based platform for the AEC industry | ||
| - **Version control:** Speckle is the Git & Hub for geometry and BIM data | ||
| - **Collaboration:** share your designs collaborate with others | ||
| - **3D Viewer:** see your CAD and BIM models online, share and embed them anywhere | ||
| - **Interoperability:** get your CAD and BIM models into other software without exporting or importing | ||
| - **Real time:** get real time updates and notifications and changes | ||
| - **GraphQL API:** get what you need anywhere you want it | ||
| - **Webhooks:** the base for a automation and next-gen pipelines | ||
| - **Built for developers:** we are building Speckle with developers in mind and got tools for every stack | ||
| - **Built for the AEC industry:** Speckle connectors are plugins for the most common software used in the industry such as Revit, Rhino, Grasshopper, AutoCAD, Civil 3D, Excel, Unreal Engine, Unity, QGIS, Blender and more! | ||
|  | ||
|
|
||
| ### Try Speckle now! | ||
| # Repo Structure | ||
|
|
||
| Give Speckle a try in no time by: | ||
| 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). | ||
|
|
||
| - [](https://speckle.xyz) ⇒ creating an account at our public server | ||
| - [](https://marketplace.digitalocean.com/apps/speckle-server?refcode=947a2b5d7dc1) ⇒ deploying an instance in 1 click | ||
| `src/powerbi-data-connector` contains all the code for the Data connector. | ||
|
|
||
| ### Resources | ||
| `src/powerbi-visual` contains all the code for 3D Visual. | ||
|
|
||
| - [](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 | ||
| # Installation | ||
|
|
||
|  | ||
| Speckle connector can be installed directly from [Manager for Speckle](https://speckle.systems/download/). 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. | ||
|
|
||
| # Repo structure | ||
| # Using 3D Visual | ||
|
|
||
| This repo is the home to our Speckle 2.0 PowerBI project. The [Speckle Server](https://github.com/specklesystems/Server) is providing all the web-facing functionality and can be found [here](https://github.com/specklesystems/Server). | ||
| 3D Visual can be imported as any other Power BI custom visual. | ||
|
|
||
| ## Install | ||
| 1. Navigate to the Visualization Pane. | ||
| 2. Click the three dots (…) and select “Import a visual from a file”. | ||
| 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. | ||
|
|
||
| Go to the [Releases](https://github.com/specklesystems/speckle-powerbi/releases) page, downlad the `.mez` file of the latest release and copy it into the following folder in your computer: | ||
| For more on how to use the visual, [check our docs](https://speckle.guide/user/powerbi-visual/introduction.html). | ||
|
|
||
| ``` | ||
| YOUR_USER_FOLDER\Documents\Power BI Desktop\Custom Connectors\ | ||
| ``` | ||
| If the folder doesn't exist, create it. | ||
| # Usage | ||
|
|
||
| ### Allow custom extensions to run | ||
| 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. | ||
|
|
||
| Go to `Settings -> Security -> Data Extensions` and activate the following option: | ||
| # **Developing & Debugging** | ||
|
|
||
|  | ||
| We encourage everyone interested to debug/hack/contribute/give feedback to this project. | ||
|
|
||
| ### Checking the connector is loaded | ||
| ## **Setup** | ||
|
|
||
| Now open PowerBI and you should see `Speckle (beta)` appear in the data source. | ||
| ### **Install PowerQuery SDK** | ||
|
|
||
|  | ||
| Follow the instructions from the [official docs](https://docs.microsoft.com/en-us/power-query/installingsdk) | ||
|
|
||
| ## Usage | ||
| ### **Build with Visual Studio** | ||
|
|
||
| > More detailed instructions on how to use the connector will be added shortly! | ||
| 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. | ||
|
|
||
| ### **Debug** | ||
|
|
||
| You can start the PowerQuery connector in VisualStudio, this will open a standalone connector you can use for testing purposes. | ||
|
|
||
| ### Current limitations | ||
| We don't know of a way to debug the connector live in PowerBI, but we'd be happy to hear about it. | ||
|
|
||
| Chunked data currently is not automatically de-chunked when received, we are aware of this limitation and are working to resolve it! | ||
|
|
||
| ## Developing & Debugging | ||
| # About Speckle | ||
|
|
||
| We encourage everyone interested to debug / hack / contribute / give feedback to this project. | ||
| What is Speckle? Check our  | ||
|
|
||
| ### Setup | ||
| ### Features | ||
|
|
||
| #### Install PowerQuery SDK | ||
| - **Object-based:** say goodbye to files! Speckle is the first object based platform for the AEC industry | ||
| - **Version control:** Speckle is the Git & Hub for geometry and BIM data | ||
| - **Collaboration:** share your designs collaborate with others | ||
| - **3D Viewer:** see your CAD and BIM models online, share and embed them anywhere | ||
| - **Interoperability:** get your CAD and BIM models into other software without exporting or importing | ||
| - **Real time:** get real time updates and notifications and changes | ||
| - **GraphQL API:** get what you need anywhere you want it | ||
| - **Webhooks:** the base for a automation and next-gen pipelines | ||
| - **Built for developers:** we are building Speckle with developers in mind and got tools for every stack | ||
| - **Built for the AEC industry:** Speckle connectors are plugins for the most common software used in the industry such as Revit, Rhino, Grasshopper, AutoCAD, Civil 3D, Excel, Unreal Engine, Unity, QGIS, Blender and more! | ||
|
|
||
| Follow the instructions from the [official docs](https://docs.microsoft.com/en-us/power-query/installingsdk) | ||
| ### Try Speckle now! | ||
|
|
||
| #### Build with Visual Studio | ||
| Give Speckle a try in no time by: | ||
|
|
||
| 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. | ||
| - [](https://speckle.xyz) ⇒ creating an account at our public server | ||
| - [](https://marketplace.digitalocean.com/apps/speckle-server?refcode=947a2b5d7dc1) ⇒ deploying an instance in 1 click | ||
|
|
||
| #### Debug | ||
| ### Resources | ||
|
|
||
| You can start the PowerQuery connector in VisualStudio, this will open a standalone connector you can use for testing purposes. | ||
| - [](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 | ||
|
|
||
| We don't know of a way to debug the connector live in PowerBI, but we'd be happy to hear about it. | ||
|  |