updated Redme

README.md

@@ -1,33 +1,127 @@
-# Cumulocity widget plugin
+# Power BI Widget for Cumulocity [<img width="35" src="https://user-images.githubusercontent.com/67993842/97668428-f360cc80-1aa7-11eb-8801-da578bda4334.png"/>]
 
-This is the Cumulocity module federation plugin. Plugins can be developed like any Cumulocity application, but can be used at runtime by other applications. Therefore, they export an Angular module which can then be imported by any other application. The exports are defined in `package.json`:
 
-```
-"exports": [
-  {
-     "name": "Example widget plugin",
-     "module": "WidgetPluginModule",
-     "path": "./widget/widget-plugin.module.ts",
-     "description": "Adds custom widget"
-  }
-]
-```
+This Power BI widget is the Cumulocity module federation plugin created using c8ycli. This plugin can be used in Application Builder or Cockpit. The Power BI widget help you to display reports created from data offloaded from DataHub seamlessly in application.
 
-**How to start**
-Run the command below to scaffold a `widget` plugin.
+### Please note that this plugin is in currently under BETA mode.
 
-```
-c8ycli new <yourPluginName> widget-plugin
-```
+### Please choose Smart Map release based on Cumulocity/Application builder version:
 
-As the app.module is a typical Cumuloctiy application, any new plugin can be tested via the CLI:
+|APPLICATION BUILDER | CUMULOCITY | SMART MAP WIDGET |
+|--------------------|------------|------------------|
+| 2.x.x(coming soon) | >= 1016.x.x| 1.x.x            | 
 
-```
-npm start -- --shell cockpit
-```
+![Power_BI](https://user-images.githubusercontent.com/99970126/181720578-e55d7911-bad6-4932-a27c-14232d1647b3.png)
 
-In the Module Federation terminology, `widget` plugin is called `remote` and the `cokpit` is called `shell`. Modules provided by this `widget` will be loaded by the `cockpit` application at the runtime. This plugin provides a basic custom widget that can be accessed through the `Add widget` menu.
+![Power_BI_Config](https://user-images.githubusercontent.com/99970126/181721134-5517d55a-56fe-4eff-8073-37e3559914b2.png)
 
-> Note that the `--shell` flag creates a proxy to the cockpit application and provides` WidgetPluginModule` as an `remote` via URL options.
+## Features
 
-Also deploying needs no special handling and can be simply done via `npm run deploy`. As soon as the application has exports it will be uploaded as a plugin.
+
+*  **DataHub Integration :** Seamless data visualization from DataHub using PowerBI workspace and report selection.
+
+*  **PowerBI Configuration:** Ability to configure various PowerBI report options.
+
+*  **Workspace Selection:** Ability to select the workspace.
+
+*  **Reports:** Select the respective report from list of available reports under the workspace selected.
+
+
+## Prerequisite
+   * DataHub should be subscribed, configured and installed in the tenant.
+   * Reports should be created in PowerBI and you should have connection for PowerBI configured in DataHub.
+
+* Minimum Permission needed:
+DataHub_Manager
+
+* For more information on DataHub,click here:
+https://cumulocity.com/guides/datahub/datahub-overview/ 
+
+
+## Installation
+
+### Runtime Widget Deployment?
+
+* This widget support runtime deployment. Download [Runtime Binary] 
+## add binry
+ and install via Administrations(Beta mode) --> Ecosystems --> Applications --> Packages.
+
+
+## QuickStart
+
+
+
+This guide will teach you how to add widget in your existing or new dashboard.
+
+
+
+
+
+1. Open you application from App Switcher
+
+
+
+2. Add new dashboard or navigate to existing dashboard
+
+
+
+3. Click `Add Widget`
+
+
+
+4. Search for `Power BI`
+
+
+
+5. Select `Target Assets or Devices`
+
+
+
+7. Click `Save`
+
+
+
+Congratulations! Power BI widget is configured.
+
+
+## User Guide
+
+
+
+
+
+-  **DataHub URL :** User can specify DataHub URL if needed or use default.
+
+-  **PowerBI URL :** User can specify Power BI URL if needed or use default.
+-  **Embed URL :** User can specify Embed Report if needed(in case it has been updated on Power BI) or use default.
+
+-  **Load Workspace :** In case user changes DataHub or Power BI URL then they need to click this button to make a call to power BI and get the workspace and reports available if any. If the path is wrong, error will be shown.
+-  **Nav Pane :** To show Navigation Pane in Power BI Report or not. This comes from Power BI and is used if your workspace has more than one report in same page.
+-  **Filter Pane :** To show the Filter Pane in Power BI report or not. This comes from Power BI and can be used to see runtime changes in report based on filter applied.
+
+-  **Workspace :** Choose the workspace from dropdown list. Once selected, the reports dropdown is populated accordingly.
+
+-  **Report :** Choose the report from dropdown list.
+
+
+
+NOTE : By default, first workspace and first report under that workspace comes selected.
+
+------------------------------
+
+
+
+This widget is provided as-is and without warranty or support. They do not constitute part of the Software AG product suite. Users are free to use, fork and modify them, subject to the license agreement. While Software AG welcomes contributions, we cannot guarantee to include every contribution in the master project.
+
+
+
+_____________________
+
+
+
+For more information you can Ask a Question in the [TECHcommunity Forums](https://tech.forums.softwareag.com/tag/Cumulocity-IoT).
+
+
+
+
+You can find additional information in the [Software AG TECHcommunity](https://techcommunity.softwareag.com/home/-/product/name/cumulocity).