At the end of this exercise, you'll have successfully sent messages to the integration flow deployed in the previous exercise and have a basic understanding of how we can monitor the integration flow.
ℹ️ While going through the exercise, you might encounter common problems not explicitly related to it. Your first stop should be the troubleshooting.md page, which includes a list of these common problems and their potential solutions.
As part of the prerequisites of this CodeJam, you should have imported the Postman collection and environments included in the assets folder. We will use these to send messages to the integration flow we deployed.
👉 First, we will update the Current Value of the host, client_id, client_secret, and token_url variables included in the Cloud Integration Instance environment. Open the Cloud Integration Instance environment and update the variable's Current Value.
For your reference, values have been included in the Initial Value column. These are dummy values and are only meant to give you an idea of what a real value will look like. For
hostyou can extract the value from the HTTP endpoint URL obtained in the previous exercises. The values forclient_id,client_secret, andtoken_urlcan be retrieved from the service key created as part of the Create SAP Cloud Integration runtime client credentials prerequisite.
Once set up, we will need to authenticate against the SAP Cloud Integration authentication server to get an access token. This token will then be included in messages sent to the integration flow as a Bearer Token1.
👉 Open the POST Token request and click the send button.
ℹ️ You'll notice some Javascript code if you click on the Tests tab part of the
POST Tokenrequest. The code facilitates copying the value of theaccess_tokenfield in the response payload to theaccess_tokenvariable in our environment. The token expires after 4200 seconds, as stated in theexpires_infield, meaning that during the CodeJam, we will need to refresh it a couple of times. Keep this in mind in case you get an HTTP 401 error when sending messages to the integration flow.
GET access token from authentication server
Hooray! 🎉 🥳 We are now ready to send messages to the integration flow.
👉 Firstly, select the Cloud Integration Instance environment. Next, expand the cloud-integration folder in collections and open the GET Request Employee Dependants request. Finally, click the Send button.
If everything goes as expected, you should see a response similar to the one in the screenshot below. If not, check out the troubleshooting.md page, which includes a list of common problems and their potential solutions.
What's going on in the request/response
In the request body, we specified that we want the details available for employee with ID 1003764. SAP Cloud Integration retrieves the value in the employee_id field, passes the value to the Business Partner mock service as part of the URL and returns the response from the Business Partner mock service.
The response contains Business Partner (employee) data, as expected, and address information in the to_BusinessPartnerAddress field. This is because we specified, in the HTTP Receiver adapter, to $expand the to_BusinessPartnerAddress field as a query parameter.
Send message to integration flow - Successful response
⚠️ The URL's hostname 2 where our integration flow is deployed , e.g. https://my-instance.it-cpi018-rt.cfapps.eu10-003.hana.ondemand.com/http/my-endpoint is very similar to the URL's hostname through which we access the SAP Cloud Integration UI, e.g. https://my-instance.it-cpi018.cfapps.eu10-003.hana.ondemand.com/itspaces/. So make sure to use the correct hostname when invoking the integration flow; if not, an HTML page will be returned as a response when trying to send a message to the integration flow. A sample response is included under the request - Wrong host - HTML page response. 🙋♂️ Can you spot the difference in the URL hostnames❓❓❓
We've successfully sent a message to our integration flow. Now, let's have a look at the monitoring section to check the status of messages sent to our Cloud Integration tenant.
SAP Cloud Integration provides us monitoring capabilities out-of-the-box. We can check the status of messages and integration content artefacts for our tenant via the Monitor section.
👉 Go to the Monitor > Integrations component of the SAP Integration Suite. A page like the one below will be on display.
Monitor - Overview
As we've deployed an integration flow and sent some requests to it, we will see some numbers indicating such artefacts/actions in this view.
- Monitor Message Processing: You should at least have one successful message in the
All Integration Flows - Completed Messagestile. If there were any errors when processing the message sent this will be under theAll Integration Flows - Failed Messages - Manage Integration Content: There should be at least one integration content here - the integration flow we deployed. If we navigate to the tile here and select the deployed integration flow you will see the HTTP endpoint URL to which we sent our message and several options to manage the deployed artefact, e.g. Restart, Undeploy, and Configure the Log Level.
- Manage Security: We can manage the security artefacts deployed in our tenant. If you faced the PKIX certificate issue described on the troubleshooting page, you will be familiar with the
Keystoretile. In a future exercise, we will deploy additional authentication credentials to our tenant through theSecurity Materialtile.
A detailed description of each section/tile in the Monitoring start page can be found here - https://help.sap.com/docs/CLOUD_INTEGRATION/368c481cd6954bdfa5d0435479fd4eaf/05446d0616d44e1daf821c273b69fcc6.html?locale=en-US
👉 Go to the All Integration Flows - Messages tile to view all the messages sent in the past hour. You'll see a screen like the one below.
In a productive tenant, we will have thousands of messages here. By using the filter options (highlighted in orange) we can narrow down the messages that we are interested in. In the example below I filtered by Time, extending it to the past 24 hours, so that we can see how multiple messages will appear on the screen.
🧭 Navigate around a couple of Completed and Failed messages in your tenant. Then, click around and observe the available information; this will vary depending on the message status. Once you've done some self-discovery, come back here to continue with the exercise.
Message monitoring - Overview and successful message
👉 Select from the list, a message in Completed status
The following information is presented to us when selecting a message:
- Status:
Completed,Processing,Failed, andCancelled, are among the statuses that we can see for a message. In our case, we only have two statuses:CompletedandFailed. For a complete list check out the documentation. - Basic properties: These are properties of this particular message (exchange). The Message ID and Correlation ID uniquely identify the message. The value might seem meaningless at this stage but they are quite useful when searching for a needle in a haystack, e.g. these values can be easily shared with colleagues when troubleshooting a problematic message.
- Logs: In the logs, we can find structured information about a message. Some basic information will be available if a message was successful, as in the screenshot above, and if you select a failed message, there will be more information available, e.g. in the screenshot below, there is a hyperlink in the
Log Levelfield and the Open Text View more details on where the error occured. - Artifact details: From here we can jump directly to the deployed integration content or to the modelling area to edit the integration flow.
The cause and solution to the error in the screenshot below is included in the troubleshooting page. You can replicate this error by sending a message to the integration flow with no request body. An example is included in the Postman collection (
cloud-integration > GET Request Employee Dependants > 500 Error - No body in request).
Message monitoring - Failed message
👉 If available, select a message in Failed status and click the Info link in the Log Level field.
The log level will tell us exactly where the integration flow is failing and details of the erorr. If additional information is required to "debug" our integration flow, we can update the log level of our deployed integration flow. This is exaplained in the tracing section of the troubleshooting page.
Message monitoring - Failed message log content
Congratulations, you've sent messages to the deployed integration flow. Also, you now have a basic understanding of some of the Monitoring capabilities of SAP Cloud Integration.
If you finish earlier than your fellow participants, you might like to ponder these questions. There isn't always a single correct answer and there are no prizes - they're just to give you something else to think about.
- Compare the response headers when calling the service directly (s4-bp-mock-server > GET Single Business Partner) vs via Cloud Integration (cloud-integration > GET Request Employee Dependants). Do you see any headers returned that might be specific to SAP Cloud Integration? Can you think of a place where you can use one of those headers?
- Go ahead and on purpose make the integration flow fail. You can do this by sending a malformed payload to the integration flow. What's the error that you get? Try not sending a valid access token, what error do you get? What happens if no authentication token is sent? The idea here is to get familiar with different error situation that you might face.
Continue to 👉 Exercise 05 - Log request in BigQuery