Send Notifications and Emails with SAP Build Work Zone
Imagine you're a poetry slam manager using a poetry slam management app to organize events. You want to notify your artists and guests before the event. The Partner Reference Application uses the SAP Alert Notification service for SAP BTP, integrated into SAP Build Work Zone, to send notifications and emails.
Notifications created with the service appear in the SAP Build Work Zone launchpad of the user. They can also be sent as email. The application defines the notification type, and users can choose which types to display and whether to receive emails. However, the application sets a default. SAP Build Work Zone supports navigation from a notification to a SAP Fiori elements floorplan, like the Poetry Slam List Report.
To use this feature, you need to enable SAP Build Work Zone, standard edition. Follow the tutorial Entitle and Subscribe to SAP Build Work Zone Application.
How to Enhance the Application Step by Step
To explore this feature with the Poetry Slam Manager, you have two options:
-
Clone the repository of the Partner Reference Application. Check out the main-multi-tenant branch and enhance the application step by step.
-
Alternatively, check out the main-multi-tenant-features branch where the feature is already included.
The following describes how to enhance the main-multi-tenant branch (option 1).
Application Enablement
To enable the Poetry Slam Manager, refer to Developing Cloud Foundry Applications With Notifications on SAP Help Portal.
-
Enhance the poetry slam service.
-
Add a new action called sendNotification to the visit entity in the poetry slam service. This action sends a notification to the visitor of the selected visit.
// Action: Inform the visitor about the event
action sendNotification(); -
Copy the notification.js notification class to your project. The notification class manages the creation and sending of the notifications. The example implementation shows how to generate a notification in the user's language. It also shows how to navigate to a floorplan using the NavigationTargetAction and the NavigationTargetObject properties.
Note: For demonstration purposes, the notification type is directly created when sending the notification. In a production scenario, it's recommended to use a different approach since notification types are persisted. Each type has a specific version. As soon as the notification content is changed, the version of the type needs to be increased. Otherwise the content is not adapted. The old notification type version remains visible in the user's settings. To remove it completely, the application needs to delete it from the SAP Build Work Zone notifications.
-
Copy the poetry slam service notification implementation file. The implementation handles the sendNotification action.
-
Add the notification implementation handler to the srv/poetryslam/poetrySlamServiceImplementation.js.
const notificationHandler = require('./poetrySlamServiceNotificationImplementation');
module.exports = class extends cds.ApplicationService {
async init() {
...
await notificationHandler(this); // Forward handler for notification
...
}
}; -
Copy the srv/lib/destination.js file to your project. The reuse functions readDestination, getDestinationURL, and getDestinationDescription are required to read the destination from the subscriber subaccount. To achieve this, pass the JSON Web Token (JWT) of the logged-in user to the function. The JWT contains the tenant information. The reuse function getDestinationDescription returns the destination description from the SAP BTP consumer subaccount.
-
Add the newly created message texts for the action success and error handling into the srv/i18n/messages.properties file.
ACTION_NOTIFICATION_SEND_SUCCESS = The notification to {0} was sent successfully.
ACTION_NOTIFICATION_SEND_FAIL = The notification to {0} could not be sent.
ACTION_NOTIFICATION_SEND_CANCELLED = {0} has canceled the booking and won't receive a notification.
-