Name: SAP BTP DevOps: SAP Alert Notification service for SAP BTP
Uploaded: 2023-9-6
Duration: 685 s

Share feedback

<p>Planned maintenance of Practice Systems</p>

Planned maintenance of Practice Systems

Why create an SAP account?

Enhance your learning experience

SAP Learning

Subscribe now

Learn more

Live Sessions

Hands-on Practice

Certification

My Learning

Ready to start learning?

<div><div><div><div><div>In this video tutorial, Philip Mugglestone shows how to use the SAP Alert Notification service for SAP BTP to automatically send a message to a selected Slack channel whenever an SAP Cloud Transport Management import task starts and finishes.<br><br>0:00 - Introduction<br>0:30 - Create SAP Alert Notification service instance with service key<br>2:00 - Create Destination ALERT_NOTIFICATION_SERVICE using service key settings<br>3:30 - Documentation<br>4:10 - Create new subscription for events TMS import started and finished; assign action type send message to Slack channel<br>6:30 - Slack: Create app and configure incoming webhook<br>7:45 - Finish create subscription<br>8:30 - SAP Cloud Transport Management: Configure QA and PROD node to perform notification<br>9:00 - SAP Business Application Studio: Stage, commit and push <br>9:50 - SAP Cloud Transport Management: Import build into QA node<br><br>DevOps with SAP BTP: <a href="https://help.sap.com/viewer/product/DEVOPS_OVERVIEW" rel="nofollow noopener noreferrer" target="_blank">https://help.sap.com/viewer/product/DEVOPS_OVERVIEW</a><br><br>Please be aware that the structure in SAP Help Portal has been updated since the time of recording. The SAP Cloud Transport Management events can now be found under Extension Events, at: <a href="https://help.sap.com/docs/alert-notification/sap-alert-notification-for-sap-btp/sap-cloud-transport-management-events?version=Cloud" rel="nofollow noopener noreferrer" target="_blank">https://help.sap.com/docs/alert-notification/sap-alert-notification-for-sap-btp/sap-cloud-transport-...</a><br><br>Please note:<br>                     This video was originally published on the SAP HANA Academy YouTube Channel                      and therefore may contain references to SAP HANA Academy and YouTube.                      The tech world is always evolving and the SAP HANA Academy YouTube channel                      is set to close on December 31, 2023.                      At that time, references will no longer be valid                      and will gradually be removed when the videos are updated. <br>Also, this video includes automatically generated captions and therefore might misrepresent the spoken content or display incorrect product names</div><p></p><p><br></p></div></div></div></div>

SAP BTP DevOps: SAP Alert Notification service for SAP BTP

Welcome to this series of hands-on tutorials from the SAP HANA Academy. I'm Philip Muggleston. In this series, we're covering DevOps for SAP Business Technology Platform Extension Applications. In this video tutorial, we're going to see how we can set up alert notifications. So for example, when we start and finish an import to one of our nodes, QA or Prod, we want to have an alert that will actually send a message to a Slack channel, or it could send an email, whatever we want. And we're going to use the alert notification service in the Business Technology Platform to allow us to do that, and it will integrate with our cloud transportation management system. So to get started on that, we'll need to go to our BTP cockpit. I'm going to go to my development sub account, and we'll see the instances and subscriptions that we've already got. So what we're going to do now is actually create a service instance of the alert notifications. So let's hit create and then the service we're going to want is alert notification and we'll choose the plan and we're going to use the standard plan, which is for an instance. It will create a service instance. So it will do that in our cloud foundry organization and space. We give it a name. I'll call it alert and we'll hit create. And then we'll see that we've got a new service instance, which is the alert service. Take a couple of seconds to initialize. Once that's done, we're going to create a service key so that we can access it. So to do that, we're going to click on that service instance, choose service keys and create. Now I'll give it a name. I'm going to call it alert-sk, but call it whatever you want and hit create. Now, once it's created, we can click on the three little dots and then choose view. Now we've got information here. We've got URL, client ID, secret and an OAuth URL. What we're going to need to do is specify these in a destination with a very specific name in the cloud technology platform. Actually, what I'll just do here is I'm going to open up a new tab when I'm accessing my Dev sub account. So just go back and review the information here. So I've got a new tab. I'm now going to go to my connectivity and destinations section. I'm going to create a new destination. Now the destination has to have a very specific name. It's called alert underscore notification underscore service. Make sure you use exactly that name. And then we need to put in the URL and we're going to need to put in the authentication, which will be OAuth to client credentials and we'll need the client ID secret and the token URL. And guess what? We've got all of that information exactly here in the service key we just created. So I'm going to copy and paste the URL and I'm going to copy and paste the client ID. Make sure you copy just the value between the double quotes but not the double quotes themselves. Same thing for the client secret. And finally the token service URL. And once you've got all of that information put in, you should just be able to go ahead and save that destination. So our destination has been configured. The next thing we need to do is to actually go and look and see what events we can actually work with when we're using the alert notification service. For that we can just pop it into the help portal and go to the alert notification service for BTP. And if we scroll down we should find there's a section which allows us to see service events. And there are a lot of built-in events that you can access, different things that happen in Business Technology Platform. And one of them is working with the cloud transportation management. So if we look at that we can see we've got a couple. We've actually got import started and import finished. So here we can see the technical details. Basically when the event type is TMS import started, and I believe that is case sensitive, then we can have that trigger an alert. So I'm going to copy that value and now I'm going to go into the alerts instance. So let's just close that, go back to our alert. Notice we can click here on the URL, maybe it's a bit clearer. I'm going to click on the main part of my service instance called alert, and it will basically launch the alert UI. I can create something called a subscription. So let's go ahead and create a new subscription. So let's create, give it a name. I'll call it maybe TMS import. We're going to do started and finished. So you can put in any other information you want to put in there. Let's hit create. Then we need to create the conditions for when will this alert actually happen. So we'll create a condition which we will call TMSImportStarted and basically the condition will be when the event type, so event type, is equal to, and it's that value, TMSImportStarted. So we'll create that. And we'll set a second condition, which is very similar. This time, let's go back to our documentation. It's going to be the TMS import finished. So it's very similar. This time the event type will be this value. So let's go ahead and paste that in as our name. Of course, the name could be whatever you want. What matters here is the condition where it's going to be the event type is equal to and then this is the value TMS import finished and I'll hit create. So now I've set up a couple of conditions. I need to make sure they're both selected. They should be by default and then I can choose to assign them. So press assign and now I'm going to create an action. What is it that I actually want to go ahead and do? So I'm gonna hit create action. Now there are a whole host of different actions that you can choose from. You can have it send an email. You can have it work with Microsoft Teams etc. What I'm going to do is work with Slack. So I'm going to choose to send a message to a specific Slack channel. So I'm going to click here to select Slack and go next so I can say for example send to Slack. This is the name of this action and then I need to specify, because it's Slack, a specific URL address, basically a Slack webhook. So this is where you'll need to go into Slack, actually create, if needed, a webhook and paste the value in here. So let's go ahead and do that now. We can do that by going into the Slack API, so api.slack.com. You need to make sure you've logged in and then you would go to manage your apps. So let's select that and you'd either have or you'd need to create an app. So I'm going to create my app. I'm going to do it from scratch. I'll give it a name. Well, our app is called App. So let's call it app and select a workspace that you're going to use. So that's my workspace and create the app. Then we need to go to the option which is incoming webhooks and we'll choose to activate incoming webhooks for this application. And if we scroll down, we'll see we can add a new webhook URL to this workspace. So let's add one and it's going to say what channel do you want it to post to when you use this webhook. So we'll choose a channel. In my case, I'll go with the general channel that I've got for that workspace. I'll choose allow. So now it's been configured and we can see we've got a webhook URL and I can copy that value and then I can go back into my definition of my alert and I can paste in that webhook URL and I can hit create. So we've now set that action up, sending to Slack. Now we can finalize this by clicking Assign. And we'll see we've got our overall subscription that's now been created. So basically whenever a TMS import starts or finishes, we're going to actually send a message to Slack. Now we can actually just open up Slack here and see what's up there at the moment. Well, we can see that we've just added the app to this channel, but otherwise the general channel is looking pretty empty. So what we could do then is think about how we might want to actually see these alerts. Well, what we need to do is maybe make a change in our application. But before we do that, there's one other bit of configuration we need to do. We need to go back to the Cloud Transportation Management. And for each of our nodes where we want to have alerts, we can select to edit them and we need to come in and say Perform Notification. Now this option wasn't there before because we hadn't actually configured the destination for the alert notification service. But once it's there, you get the option to say Perform Notification. And we'll save that. I'm going to do the same thing on my prod node. I'm going to have Perform Notification as well. Say OK. And now I may be ready to go ahead and make a change in my application. So we'll go to our development environment. So I'm going to make sure that I stage my changes. Then I'll make a commit with a message, and then I'm going to push. And that will now launch a new continuous integration delivery. And when that's finished, we should be able to then do an import and hopefully we'll get our alerts. So let's just wait for the CI CD process to finish. So we can see that the build has now completed. So if we go to the Cloud Transportation Management, and we'll just refresh that. We can see that we've got a new initial in the QA. So let's go ahead and just have a quick look at the input queue. And now we can see we've got a new initial one at the bottom of our input queue. The commit ID should correspond to 5755. If you have a look, that corresponds with what we've got from that latest build. So we want to import that one. So let's go ahead, select it and choose import selected and click OK. And now we get a message sent a notification is sent to Slack. If we look at it, we can see that we've got a message. This is default. Of course, you can customize what it looks like, but we've got a message basically been sent to Slack, say importer started in the QA node and we'll get another message when it's finished. So let's just wait for that. And now we can see we get a new message in Slack. We can see we've got the TMS import finished event type, so the importer is finished in our QA node and we get the details in the event body. Now we've seen how we can use the alert notification service to actually send us alerts. In this case to Slack, but there are lots of lots and lots of other options you could be using so that when an import is started or finished within the cloud transportation management system, you can get an alert for that. And if you just want to confirm that it has in fact finished, we can go back here. We go to landscape visualization and indeed we can see that there are now two succeeded, so that one's finished. And if we look at the prod, we can now see there's a new one to potentially be imported there. So that's alert notifications. You can find more video tutorials on our YouTube channel. If you'd like to be informed as soon as new video tutorials are published, then please subscribe. Thanks for watching.