https://github.com/cumulocity-iot/cumulocity-reminder-plugin
A Cumulocity IoT UI plugin to provide, event based, reminder functionality.
https://github.com/cumulocity-iot/cumulocity-reminder-plugin
cumulocity-extension cumulocity-iot cumulocity-package cumulocity-plugin iot-analytics
Last synced: 4 months ago
JSON representation
A Cumulocity IoT UI plugin to provide, event based, reminder functionality.
- Host: GitHub
- URL: https://github.com/cumulocity-iot/cumulocity-reminder-plugin
- Owner: Cumulocity-IoT
- License: apache-2.0
- Created: 2024-05-21T11:58:24.000Z (about 1 year ago)
- Default Branch: main
- Last Pushed: 2024-10-14T10:51:56.000Z (8 months ago)
- Last Synced: 2024-12-10T12:32:59.193Z (6 months ago)
- Topics: cumulocity-extension, cumulocity-iot, cumulocity-package, cumulocity-plugin, iot-analytics
- Language: TypeScript
- Homepage:
- Size: 2.14 MB
- Stars: 2
- Watchers: 0
- Forks: 1
- Open Issues: 7
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Cumulocity IoT UI Critical Alarm Reminder Plugin
[](https://github.com/SoftwareAG/cumulocity-reminder-plugin/actions/workflows/test.yml)
---
## Features
The critical alarm reminder plugin provides an option to manually setup reminders. These [reminders](#reminders) – technically speaking cumulocity events – are attached to groups or devices. They also feature a configurable timestamp, to define when to be reminded.
All the reminders are neatly accessibly from with a new drawer, positioned on the right – just like the "user menu".
### Reminders
As mentioned earlier, reminders are cumulocity events attached to assets (groups or devices). But they function similar to cumulocity alarms, as their status is either "**active**", "**acknowledged**" or "**cleared**". Providing the same clear state handling that should solve the basic question "do I need to do something?".
The "create a reminder" dialog will have the current asset – the page you looking at – preselected.
So why do I need a reminder it is just like an alarm?
Because you want a [notification](#notifications), once the reminder has become due. (continue reading)
### Notifications
Reminders sorted into **three logical groups**:
1. "**due**": reminders that are not cleared, and timestamp is in the past.
2. "**upcoming**": similar to "due"; reminders that are not cleared but whos timestamp is in the future.
3. "**cleared**": reminder that were manually cleared
That said, you will receive a notification once an upcoming reminder reaches its timestamp and will move from "upcoming" to "due".
Please note that, as you can also re-active a cleared alarm, **a notification for this reminder will not be send**.
At the bottom of the reminder drawer, you can choose want type of notification you want to receive: an in-cumulocity "toast" message, a browser notification, both or neither.
> For browser notifications to function, your browser needs to support notifications and you need to accept the permission request.
Please reference your browsers documentation, in case you experience issues granting notification permission.
### Reminder Type Config
Selectable reminder types can be configured using the tenant option – best using the [Tenant Option Manager Plugin](https://github.com/SoftwareAG/cumulocity-tenant-option-management-plugin) –, using the configuration as described below. Per default, no config is set and the type selection hidden.
Reminder type filter – available to the user, accessible from within the reminder drawer –, and display of types on reminder items.
The reminder type field is shown, within the reminder creation dialog, when types are configured.
| Fragment | Type | Info |
| -------- | :----: | ------------------------------------------------------------------------------------------------------------------------------------ |
| `id` | string | Any unique string value, used to reference the filter, when saved in local storage. Not displayed to the user. As short as possible. |
| `name` | string | Human-readable label for the reminder type, displayed to the user. |
Tenant option config: Category `c8y.reminder`, Key `types`.
##### Example Config
```json
[
{
"id": "1",
"name": "Type 1"
},
{
"id": "2",
"name": "My Preferred Type"
},
{
"id": "a_123",
"name": "A123"
}
]
```
---
## Local Development
### Recommended version
| C8Y | Plugin | Versions |
| ----: | ------: | ------------------------------------ |
| ^1020 | v1 | node v18.x, npm v10.x, Angular v17.x |
| 1018 | v0 | |
| 1017 | v0 | node v16.x, npm v9.x, Angular v14.x |
### How to start
Change the target tenant and application you want to run this plugin on in the `package.json`.
```bash
ng serve -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 version 1016.0.59**! Upload this clone to the target tenant (e.g. cockpit-1016) and reference this name in the `--shell` command.
The widget plugin can be locally tested via the start script:
```bash
npm start
```
In the Module Federation terminology, `widget` plugin is called `remote` and the `cockpit` 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 `ReminderPluginModule` 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 the [TECHcommunity 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 [Software AG TECHcommunity Forums](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](./issues) in the repository. If you’d like to share your ideas or feedback, please post them in our [Tech Forums](https://tech.forums.softwareag.com/c/feedback/2).
### More to discover
- [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)
- [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)
- [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)
---
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.