- SAP Managed Tags
This is a simple example on how to integrate SAP Cloud ALM with a SLACK channel, to post the SAP Cloud ALM alerting information.
This blog referred following help documentation:
- SAP Cloud ALM Integration with External Chat Systems
- External API Management in SAP Cloud ALM
- Slack API chap.postMessage
Create a new Slack Channel
- Add a new channel as an administrator of your SLACK workspace.
- Channel ID can be found in the "View Channel Details", this might be used in the mapping rule.
Build a new APP for the incoming webhook message.
- Build a new application from scratch
- Define the Scopes for the new application.
Under the "Oauth& Permissions" tab, add the following Bot Token Scopes- incoming-webhook
- channels:read
- chat:write.customize
- chat:write
- Install the application to the workspace
- Get the Bot user Oauth Token.
The Bot user Oauth Token will be used to create the BTP Destination in the next step.
Create a Destination under the SAP Cloud ALM subaccount
- Access the SAP Cloud ALM subaccount in the SAP BTP Cockpit
- Under the Connectivity -> Destinations tab, to create a HTTP destination with the following details
- Type: HTTP
- URL: https://slack.com/api/
- Proxy type: Internet
- Authentication: No Authentication
- Additional Properties:
URL.headers.Authorization = Bearer <BOT User Oauth token>
(Missing this property might lead to "not_authed" response)
Create a new Webhook in SAP Cloud ALM - External API Management with the BTP destination.
- Access to the SAP Cloud ALM tenant
- Goto application "External API Management" under the "Administration" tab
- In the Webhooks Management tab, create a new webhook with the following details
- Destination Source: BTP Destination
- Path: chat.postMessage
- Destination Id: <destination created in the above step>
- Ext. Resource Type: Chat
Create a new mapping rule for the Slack integration.
- Go to the Mappings Management tab
- Create a new mapping rule for the Slack integration with the following details:
Here is a sample JSON file for the mapping rule.
Please exchange the parameters "username" and "channel" to your channel ID and user name.
Refer to this documentation for more information on how to properly configure the Mappings using the Resource Changes API.
{
"_information": {
"_version": "1",
"_source": "SAP Cloud ALM Event Situation",
"_destination": "Slack",
"_name": "SAP Cloud ALM Event Situations to Slack",
"_comment": "SLACK - Channel #calm(Workplace CALM)"
},
"switches": [
{
"name": "switchPriority",
"cases": [
{
"when": "FATAL",
"then": "Highest"
},
{
"when": "ERROR",
"then": "High"
},
{
"when": "WARNING",
"then": "Low"
},
{
"when": "INFO",
"then": "Lowest"
}
],
"default": "Lowest"
}
],
"structure": {
"request": {
"ok": true,
"username": "<user name>",
"channel": "<channel ID>",
"blocks": [
{
"type": "section",
"text": {
"type": "mrkdwn",
"text": "*SAP Cloud ALM Event: EVENT-SITUATION.CREATED*"
}
},
{
"type": "section",
"text": {
"type": "plain_text",
"text": "Subject: #{subject}"
}
},
{
"type": "section",
"text": {
"type": "plain_text",
"text": "Description: rating:#{rating} - priority:${SWITCH(switchPriority,rating)} - serviceType:#{serviceType} - serviceId:#{serviceId} - eventType:#{eventType} - eventName:#{eventName}"
}
},
{
"type": "section",
"text": {
"type": "plain_text",
"text": "workNotes: #{workNotes}"
}
}
]
},
"response":
{
"chatCreated": true
}
},
"eventTypeMapping": {
"_comment": "Specificeventtypemapping",
"operationMappings": [
{
"eventType": "EVENT-SITUATION.CREATED",
"operation": "POST",
"responseRoot": ""
},
{
"eventType": "EVENT-SITUATION.CLOSED",
"operation": "POST",
"responseRoot": "",
"structure": {
"request": {
"ok": true,
"username": "<user name>",
"channel": "<channel ID>",
"blocks": [
{
"type": "section",
"text": {
"type": "mrkdwn",
"text": "*SAP Cloud ALM Event: EVENT-SITUATION.CLOSED*"
}
},
{
"type": "section",
"text": {
"type": "plain_text",
"text": "Subject: #{subject}"
}
},
{
"type": "section",
"text": {
"type": "plain_text",
"text": "Description: rating:#{rating} - priority:${SWITCH(switchPriority,rating)} - serviceType:#{serviceType} - serviceId:#{serviceId} - eventType:#{eventType} - eventName:#{eventName}"
}
},
{
"type": "section",
"text": {
"type": "plain_text",
"text": "workNotes: #{workNotes}"
}
}
]
},
"response":
{
"chatCreated": true
}
}
},
{
"eventType": "EVENT-SITUATION.UPDATED",
"operation": "POST",
"responseRoot": "",
"structure": {
"request": {
"ok": true,
"username": "<user name>",
"channel": "<channel ID>",
"blocks": [
{
"type": "section",
"text": {
"type": "mrkdwn",
"text": "*SAP Cloud ALM Event: EVENT-SITUATION.UPDATED*"
}
},
{
"type": "section",
"text": {
"type": "plain_text",
"text": "Subject: #{subject}"
}
},
{
"type": "section",
"text": {
"type": "plain_text",
"text": "Description: rating:#{rating} - priority:${SWITCH(switchPriority,rating)} - serviceType:#{serviceType} - serviceId:#{serviceId} - eventType:#{eventType} - eventName:#{eventName}"
}
},
{
"type": "section",
"text": {
"type": "plain_text",
"text": "workNotes: #{workNotes}"
}
}
]
},
"response":
{
"chatCreated": true
}
}
},
{
"eventType": "EVENT-SITUATION.PING",
"operation": "POST",
"responseRoot": "",
"structure": {
"request": {
"ok": true,
"username": "<user name>",
"channel": "<channel ID>",
"blocks": [
{
"type": "section",
"text": {
"type": "mrkdwn",
"text": "*SAP Cloud ALM Event: EVENT-SITUATION.PING*"
}
},
{
"type": "section",
"text": {
"type": "plain_text",
"text": "Subject: #{subject}"
}
},
{
"type": "section",
"text": {
"type": "plain_text",
"text": "Description: rating:#{rating} - priority:${SWITCH(switchPriority,rating)} - serviceType:#{serviceType} - serviceId:#{serviceId} - eventType:#{eventType} - eventName:#{eventName}"
}
},
{
"type": "section",
"text": {
"type": "plain_text",
"text": "workNotes: #{workNotes}"
}
}
]
},
"response":
{
"chatCreated": true
}
}
}
]
}
}
Create a new Subscription with the Webhook and Mapping rule created in the above steps.
- Go to the Mappings Management tab
- Create a new mapping rule for the Slack integration with the following details
- Resource Type: Event Situation
- Wbehook: <the webhook created in the above step>
- Mapping: <the mapping created in the above step>
- Type: Built-in
Testing the Slack integration under any Alert generated in the SAP Cloud ALM Monitoring application
- In any monitoring applications under the Operation tab
- Open an existing alert, and click on the Actions button
- Send chat notification
- Select the Subscription created and click on OK
- Check whether the message can be sent to the Slack channel.
Verify the Console log in the External API Management for troubleshooting
In case there is some error happens, or the notification can't be sent successfully. It is possible to check the console log in the "Console" tab of the "External API Management" application for more details.
2 Comments
Bluesky| User | Count |
|---|---|
| 48 | |
| 46 | |
| 27 | |
| 23 | |
| 21 | |
| 16 | |
| 14 | |
| 13 | |
| 12 | |
| 12 |
