cap-js / notifications

CDS Plugin that provides support for publishing business notifications in SAP Build WorkZone.
https://cap.cloud.sap/docs/
Apache License 2.0
7 stars 1 forks source link

Confusing package description mentioning ANS and readme #36

Open myakinkii opened 10 months ago

myakinkii commented 10 months ago

Hey guys, Nice that you published this plugin, thx! Would it make sense to change it to SAP Fiori Launchpad Notifications Service maybe (or whatever the current name of this poor guy is)? Because we have this guy https://github.com/SAP/alert-notification-node-client which kinda does that. So, it took me some time to double check that yours only does flp notifications, while the fact that you call this cds service "alert" in readme is also a little bit misleading. Also an offtop question: do you maybe have an idea how to resolve recipients at runtime for broadcast notification based on role that target app is assigned to? Regards, Alex.

sebastianesch commented 9 months ago

I got also a little bit confused - the destination that is created in the README is for the Notifications for SAP Build WorkZone and the Notification Types relate to Notifications in the Launchpad of WorkZone as well. SAP Alert Notification has a different API and I did not recognise the API calls of the Plugin to match the ANS APIs.

The about of the Plugin mentions "Business Notifications" which matches the notifications in SAP Build WorkZone for me - SAP Alert Notification Services is more about DevOps and distributing alerts from Applications and Infrastructure and less about "Business Notifications".

Kind regards, Sebastian

myakinkii commented 9 months ago

Maybe they have some intention to combine it with ANS, because in cap plugin docs they reiterate that statement: "The Notifications plugin provides integration with the SAP Alert Notifications service to send notifications via email, Slack, Microsoft Teams, or SAP Fiori notifications."

I checked ANS actions again, but currently there's no dedicated FLP/Workzone type mentioned. https://help.sap.com/docs/alert-notification/sap-alert-notification-for-sap-btp/managing-actions?locale=en-US

Could be indeed work-in-progress on sap side.

Regards, Alex

sebastianesch commented 8 months ago

The plugin description in the README is now much clearer. I just noticed that in the description in package.json ANS is still mentioned and in the "About" section of the Repo in GitHub.

gregorwolf commented 6 months ago

Beside the description in the project also the description in the Capire Plugins documentation needs to be changed. There it also links to ANS instead of pointing to SAP Build Work Zone, standard edition - Enabling Notifications for Custom Apps on SAP BTP Cloud Foundry.

CC: @renejeglinsky