https://github.com/cumulocity-iot/cumulocity-note-widget-plugin
Easily manage and share notes for your device and asset
https://github.com/cumulocity-iot/cumulocity-note-widget-plugin
cumulocity-iot cumulocity-package cumulocity-plugin cumulocity-profserv-package iot-analytics
Last synced: 5 months ago
JSON representation
Easily manage and share notes for your device and asset
- Host: GitHub
- URL: https://github.com/cumulocity-iot/cumulocity-note-widget-plugin
- Owner: Cumulocity-IoT
- License: apache-2.0
- Created: 2023-10-24T09:27:07.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2024-02-16T07:18:51.000Z (over 1 year ago)
- Last Synced: 2024-12-20T17:16:31.745Z (5 months ago)
- Topics: cumulocity-iot, cumulocity-package, cumulocity-plugin, cumulocity-profserv-package, iot-analytics
- Language: TypeScript
- Homepage:
- Size: 5.94 MB
- Stars: 4
- Watchers: 1
- Forks: 1
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- License: LICENSE.txt
Awesome Lists containing this project
README
# Cumulocity Note Widget Plugin
## General
Use the Note Widget to easily manage notes for devices and assets. Users can add new notes or extend existing ones. These notes will be shared with all users, who have access to the related device/asset and its dashboards. Each note update is stored as an event for the corresponding device/assets. Using the log section users can have a look on past notes.
**Important:** Users need to have `READ` and `ADMIN` permission on the Events API, as notes and updates on notes are stored as events.
## Local development
### Recommended version
- node version >= 16.x
- npm version 6.x
### Plugin versions
- Angular version 14.x
- WebSDK version 1017.0.x
**How to start**
Change the target tenant and application you want to run this plugin on in the `package.json`.
```
c8ycli server -u https://{{your-tenant}}.cumulocity.com/ --shell {{cockpit}}
```
Keep in mind that this plugin needs to have an app (e.g. cockpit) running with at least the same version as this plugin. if your tenant contains an older version, use the c8ycli to create a cockpit clone running with at least v 1017.0.x! Upload this clone to the target tenant (e.g. cockpit-1017) and reference this name in the --shell command.
The widget plugin can be locally tested via the start script:
```
npm start
```
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.
> Note that the `--shell` flag creates a proxy to the cockpit application and provides` AdvancedMapWidgetModule` as an `remote` via URL options.
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.
## Useful links
📘 Explore the Knowledge Base
Dive into a wealth of Cumulocity IoT tutorials and articles in our [Tech Community Knowledge Base](https://tech.forums.softwareag.com/tags/c/knowledge-base/6/cumulocity-iot).
💡 Get Expert Answers
Stuck or just curious? Ask the Cumulocity IoT experts directly on our [Forum](https://tech.forums.softwareag.com/tags/c/forum/1/Cumulocity-IoT).
🚀 Try Cumulocity IoT
See Cumulocity IoT in action with a [Free Trial](https://techcommunity.softwareag.com/en_en/downloads.html).
✍️ Share Your Feedback
Your input drives our innovation. If you find a bug, please create an issue in the repository. If you’d like to share your ideas or feedback, please post them [here](https://tech.forums.softwareag.com/c/feedback/2).
More to discover
* [How to install a Microfrontend Plugin on a tenant and use it in an app?](https://tech.forums.softwareag.com/t/how-to-install-a-microfrontend-plugin-on-a-tenant-and-use-it-in-an-app/268981)
* [Cumulocity IoT Web Development Tutorial - Part 1: Start your journey](https://tech.forums.softwareag.com/t/cumulocity-iot-web-development-tutorial-part-1-start-your-journey/259613)
* [The power of micro frontends – How to dynamically extend Cumulocity IoT Frontends](https://tech.forums.softwareag.com/t/the-power-of-micro-frontends-how-to-dynamically-extend-cumulocity-iot-frontends/266665)
---
These tools are 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.