thesis-dfs-customvisual

this is part of my master's thesis at Daimler Financial Services AG

Requirements

NOTE: NPM is blocked by the firewall, as a workaround just use the guest WIFI.

• Git - Installation guide.
• Node.js - Download page.
• NPM - comes with node.
• OpenSSL
• Enable "Enable developer visual for testing" option in Power BI services (link. Follow this link for detailed steps.

IDEs

Visual Studio Code OR Notepad++ to edit the code files

Codebase

Clone to your working directory:

• thesis-simtool-customvisual

Installation

OpenSSL

• Download Win64 OpenSSL v1.1.1c Light from Download
• Add as Environment Variable
  • In Windows Search, enter Edit environment variables for your account
  • Select the Path variable and click edit
  • Add the path to the OpenSSL bin directory to the end of the Variable value. Make sure there is a semicolon before, e.g. ;C:\OpenSSL-Win64\bin
• Verify it works by running openssl in your command prompt (cmd)

Node.js

• Download
• Install
• Make sure it is installed by running npm -v in command prompt (cmd)

Setup

For detailed guide, see the Microsoft documentation.

IMPORTANT: For the first two steps you need to be in guest wifi

1. Run npm install
2. Run npm install powerbi-visuals-tools -g
3. Run pbiviz --install-cert

Create a new custom visual

1. Create a new visual pbiviz new {name}
2. Make sure to install all packages $ npm install

Settings

To change the api endpoint, go to settings.ts and update the endpoint accordingly.

Live debug a custom visual

1. Run npm run start or pbiviz start to start live compiler to start a local server to which Power BI Services will connect
2. Open Power BI Services and open a Report that you can edit
3. Select the development visual and drag it onto the canvas
4. Refresh the visual to see your live development
5. In case it does not work see Can't contact visual server below

package a custom visual

Use package to import the custom visual into Power BI desktop.

1. Run pbiviz package to start the package process.
2. If the process was successful the final package will be the /dist directory.
3. Import the custom visual into Power BI desktop.

Known errors

Can't contact visual server

1. Run pbiviz start
2. Open https://localhost:8080/assets/status in Google Chrome
3. Open Advanced
4. Click Proceed to localhost (unsafe)
5. Go back to the report with your debug visual
6. Reload visual code

source

.api folder missing

https://community.powerbi.com/t5/Developer/Custom-Visual-Setup-Exceptions-pbi-visuals-api-2-2-2-pbi-visuals/m-p/576698