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.
- node version >= 16.x
- npm version 6.x
- 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
--shellflag creates a proxy to the cockpit application and providesAdvancedMapWidgetModuleas anremotevia 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.
📘 Explore the Knowledge Base
Dive into a wealth of Cumulocity IoT tutorials and articles in our Tech Community Knowledge Base.
💡 Get Expert Answers
Stuck or just curious? Ask the Cumulocity IoT experts directly on our Forum.
🚀 Try Cumulocity IoT
See Cumulocity IoT in action with a Free Trial.
✍️ 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.
More to discover
- How to install a Microfrontend Plugin on a tenant and use it in an app?
- Cumulocity IoT Web Development Tutorial - Part 1: Start your journey
- The power of micro frontends – How to dynamically extend Cumulocity IoT Frontends
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.