Understanding the Event Mesh Capability in SAP Integration Suite

The Event Mesh capability is hosted in SAP Integration Suite in an SAP BTP subaccount. Therefore, the user must first log in to the corresponding SAP BTP subaccount. In this step, we log in to the development SAP BTP subaccount.

1. Log in to the SAP BTP subaccount

2. Call: https://emea.cockpit.btp.cloud.sap

3. Select the global account and subaccount. Here is an example - CLD900-DEV-CO21.

4. Authentication against the SAP IDP or Custom IDP with the user and password.

   Result

   

   The user is logged in as an SAP BTP administrator on the development SAP BTP subaccount.

   Further Information

   Event Driven Integrations - Video: Event-driven Integrations: Discovering SAP Integration Suite’s Event Mesh Capabilities.

1. Log in to the Integration Suite.

2. Navigate to Home.

   

3. Depending on whether capabilities are already activated or not, the activated capabilities are displayed here. In this case, none are activated yet.

4. Search for the Add Capabilities tile.

5. Click on the Add Capabilities link.

6. Click on the Add Capabilities button.

7. Select Manage Business Events.

8. Activate Event Mesh.

   

9. Click on Next.

10. Then, click on the Activate button.

    

11. If the action was successful, the active capability Event Mesh is displayed.

    

12. Click on the OK button to return to the SAP Integration Suite Welcome page.

1. Log in to the Integration Suite.

2. Navigate to Home.

   

3. Depending on whether capabilities are already activated or not, the activated capabilities are displayed here. In this case, Event Mesh is already activated.

4. Search for the Manage Capabilities tile.

5. Click on the Manage Capabilities link.

6. Click on the Add Capabilities button.

   

7. Select Build Integration Scenarios.

   

8. Click on Next.

9. Select Production or Non-Production as the environment.

10. Activate the message queues.

    

11. Click on Next.

12. Click on Activate. The activation process can take up to an hour.

1. Assigning the required role collections to the application user. In our case, the application user is the same as the platform user.

   1. Log in to the SAP BTP cockpit of the subaccount.

      

   2. Open Security→Users and locate the application user to whom the role collections should be assigned.

      

   3. On the right, click the small black triangle at the end of the row with the application username.

   4. A panel opens to the right of the user field.

      

   5. The right panel can be enlarged using a slider.

   6. Click the three dots to the right of the search field, then click the Assign Role Collections link.

      

2. Assigning role collections for Event Mesh.

   The Event Mesh capability in SAP Integration Suite offers two predefined role collections. There is no distinction between different roles.

   Name	Description
   EventMeshAdmin	Management of the message broker, queues, and topic subscriptions, and monitoring Event Mesh usage and its resources.
   EventMeshDevelop	Management of queues and topic subscriptions, as well as monitoring Event Mesh usage and its resources.

   1. Select both role collections.

      

   2. Then, click the Assign Role Collections button.

      

3. Assigning role collections for Cloud Integration

   The Cloud Integration capability offers four predefined role collections. Again, no role distinction is made.

   Name	Description
   PI_Administrator	SAP Process Integration - for administrators
   PI_Business_Expert	SAP Process Integration - for business experts with access to critical business data
   PI_Integration_Developer	SAP Process Integration - for users developing integration flows
   PI_Read_Only	SAP Process Integration - read-only access for support users without access to critical business data

   1. Proceed with the assignment just like before.

   2. Select all role collections as shown in the following figure.

      

   3. Then, click the Assign Role Collections button.

1. Create a service instance.

   1. Navigate to Services→Instances and Subscriptions and click the Create button.

   2. Fill in the form using the following values:

      

      Field	Value	Task
      Service	SAP Integration Suite, Event Mesh	Select from the dropdown list
      Plan	message-client	Select from the dropdown list
      Runtime Environment	Cloud Foundry	Select from the dropdown list
      Space	for example, dev	Select from the dropdown list
      Instance Name	emis-s4hana	Any name of your choice

   3. Click the Create button.

   4. No additional parameters must be defined in the service descriptor.

1. Create a Service Key

   1. Navigate to the emis-s4hana service instance under Services→Instances and Subscriptions.

      

   2. Click on the row of the service instance to open the details panel on the right.

   3. Click the Create button in the Service Keys section.

      

   4. Fill out the form using the following values:

      Field	Value	Task
      Service Key Name	for example, sk-emis-s4hana	Any name of your choice

   5. Then, click the Create button to generate the service key.

      

2. Review the Service Key

   1. Click the name of the service key you just created.

      

   2. Upon opening the service key, you see three sections. Section 1 is relevant for us. For security reasons, some parts are masked with the following characters: "%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%"

      

   3. We communicate with the Event Mesh using:

      Name	Value
      Transmission Protocol	AMQP (Advanced Message Queuing Protocol)
      Transport Layer	TCP
      Network Protocol	WebSocket
      WebSocket	URI wss://cld900……./amqp10ws

   4. With the clientid, clientsecret, and tokenurl, a bearer token can be generated to access the endpoint shown under URI. From a technical point of view, this is an OAuth 2.0 client.

3. Copy the Service Key

   For configuring the communication channel in SAP S/4HANA Cloud, we need this service key. Therefore, copy the entire service key and store it securely for later use.

   1. In the open service key window, click the Copy JSON button at the bottom and save the service key in a secure location.

1. Create a Queue in a Message Client in Event Mesh

   1. Log in to SAP Integration Suite.

   2. Navigate to Configure→Event Mesh.

   3. Click on the message client name emis-s4hana.

      

   4. Select the Queues tab.

   5. Click the Create button.

   6. Provide a meaningful name for the queue, for example, emis-s4hana-uc123.

      

   7. Then, click the Create button.

1. Open the relevant URL, for example: https://myxxxx.s4hana.ondemand.com

   1. Log in using your username and password.

   2. Open the Maintain Business Users app.

      

   3. Click the Maintain Business Users tile.

   4. Search for your login user using the search field and click the Go button.

      

   5. Click on the row containing your user.

      

   6. Switch to the Assigned Business Roles tab.

   7. Verify that your user has the business role BR_ADMINISTRATOR assigned.

1. Log in to SAP S/4HANA Cloud Public Edition.

   1. Launch the Communication Arrangements app.

      

   2. Click the New button.

   3. In the Scenario field, search for and select Enterprise Eventing Integration with Scenario ID SAP_COM_0092.

      

   4. Click the selected entry to confirm and transfer it to the Scenario field.

      

   5. After selecting the Scenario ID, the previously created Service Key from the SAP Integration Suite, Event Mesh instance must be pasted into the Service Key field.

   Note

   Before pasting, the service key must be manually extended with the following entry inside the messaging section of the amqp10ws configuration: The namespace must consist of exactly three segments. In this example: demo/ s4hc/e4l.

   1 ........

   2 "namespace": "demo/s4hc/e4l",

   3 "messaging": [ .......

   1. Then, paste the extended service key into the Service Key field.

   2. Choose a name for the Arrangement. It must not start with SAP and must not contain hyphens (-).

   3. Next, assign an Inbound Communication User or create a new one using the New button.

      

   4. Then, click the Create button.

   5. If everything is valid, the communication arrangement is successfully created, for example, with the name ESA-DEMO_0092.

      

      The previously entered values—such as the extended service key, the namespace, and the communication arrangement name—are visible in various sections of the created arrangement.

1. Assign topics to the communication channel

   1. In SAP S/4HANA Cloud Public Edition, navigate to the Enterprise Event Enablement app.

      

   2. Locate the communication arrangement you just created—referred to here as a Channel. In our case, this is EDA_DEMO_0092.

   3. Click on the entry.

   4. A detail page opens.

   5. Verify that the correct channel is selected and that it is active.

      

   6. Select the Outbound Topic Bindings tab.

   7. Click the Create link.

   8. Then, click the selection icon in the search field on the right.

   9. A search mask appears, it shows all available topics in the system. Each topic corresponds to an event that can be triggered.

      

   10. Search for Business Partner events by entering the search term Business into the search field.

   11. Then, select the following topics:

       1 sap/s4/beh/businesspartner/v1/BusinessPartner/Changed/v1

       

       If the assignment was successful, the selected topic name displays.

       

   12. Copy the topic name. You will need it in the next step in Event Mesh.

1. Create a topic subscription in the previously created queue.

   1. Open SAP Integration Suite.

   2. Navigate to Configure→Event Mesh.

      

   3. Click on the previously created Message Client, here named emis-s4hana.

   4. A detail view opens, showing all queues configured within this message client.

      

   5. Click on the name of the queue.

   6. A new screen opens.

      

   7. Click the Create button in the selected queue here: emis-s4hana-uc123.

   8. Construct the topic subscription using the following schema:

      • Namespace from the extended service key: demo/s4hc/e4l
      • Topic name of the outbound event: sap/s4/beh/businesspartner/v1/BusinessPartner/Changed/v1
      • Separator: ce

   9. Final topic subscription: demo/s4hc/e4l/ce/sap/s4/beh/businesspartner/v1/BusinessPartner/Changed/v1

   10. Copy the topic subscription into the Topic Name field of the Create Topic Subscription form.

       

   11. Confirm by clicking the Create button.

1. Create OAuth2 client credentials for the AMQP inbound adapter under Manage Security.

   1. In your SAP BTP subaccount, navigate to Services→Instances and Subscriptions.

   2. Click the Integration Suite link.

      

   3. In SAP Integration Suite, go to Monitor→Integrations and APIs.

      

   4. Click on the Security Material tile.

      

   5. Click the Create button in the upper-right corner.

   6. From the dropdown list, select OAuth2 Client Credentials.

   7. Fill in the form fields with the data from the service key of the SAP Integration Suite, Event Mesh instance.

      

   8. Click Deploy.

1. In the Integration Suite, navigate to Design→Integration and APIs.

   1. Click the Create button.

      

   2. Enter a name and short description in the form.

      

   3. Then, click the Save button.

   4. Go to the Artifacts tab and open the menu under the Add button.

   5. Select Integration Flow.

      

   6. Assign a meaningful name and click Add and Open in Editor.

      

   7. Click the Edit button and drag a Groovy Script element from the palette.

      

   8. After inserting it, click the plus icon to insert a standard script.

      

   9. Accept the suggested script, click Apply, and then Close.

      

   10. Back in the main window, click Save.

       

2. Configure the AMQP Inbound Adapter

   1. Click on the Sender and connect it to the Start event.

   2. In the pop-up adapter selection, choose AMQP.

      

   3. Then, select WebSocket.

      

   4. In the Connection tab, add the Host, Path, and Port from the service key. The host starts with wss://

   5. Ensure that there is a leading slash / in the Path.

   6. Under Authentication, choose OAuth2 Client Credential.

   7. In Credential Name, enter the alias of the client credentials created earlier—in our case: emis.

      

   8. Now, open the Processing tab and enter the name of the queue to be read—in our case: emis-s4hana-uc123.

      

   9. Leave all other parameters as suggested.

      

   10. Save the iFlow.

3. Test the iFlow

   Once the iFlow is deployed, it starts reading the events from the queue.

   Currently, there are three events stored in the queue.

   1. Click the Deploy button.

   2. Navigate to Monitor→Integrations and APIs→All Artifacts.

1. Log in to SAP S/4HANA Cloud Public Edition.

   1. Open the Maintain Business Partner app.

   2. Select or search for an existing Business Partner.

      

   3. Click the Start button.

   4. Click the selected Business Partner.

      

   5. Click Switch Between Display and Change.

   6. Modify any attribute of the selected Business Partner.

      

   7. Click the Save button.



2. Verify in SAP S/4HANA Cloud Public Edition if an Event Was Created and Sent

   1. Open theEnterprise Event Enablement–Event Monitor app in SAP S/4HANA Cloud Public Edition.

   2. Check whether an event was processed under your channel. In our example, the channel EDA_DEMO_0092 has processed an event.

      

   3. Click on the EDA_DEMO_0092 channel.

      

   4. Click the topic: demo/s4hc/e4l/ce/sap/s4/beh/businesspartner/v1/BusinessPartner/Changed/v1.

      

   5. Click the Cloud Event ID.

      

   6. Click Show More to view the event details. The Business Event—also known as the Cloud Event — was successfully processed in SAP S/4HANA Cloud Public Edition.

      

3. Check in SAP Integration Suite, Event Mesh if the Event Was Received

   1. Log in to SAP Integration Suite, Event Mesh.

   2. Navigate to Configure→Event Mesh→emis-s4hana.

      

4. Successful retrieval by iFlow

   1. In this case, you do not see an entry in the queue.

      

5. Unsuccessful retrieval of the event from iFlow

   

   1. In this case, you see the event in the queue.

6. Check whether iFlow has processed the event

   1. Navigate to Design→Integrations and APIs→EDADemo→EDA_DEMO.

      

   2. Click on Deploy.

   3. In the configuration area, click on Deployment Status→Navigate to Manage Integration Content.

      

   4. Check whether the adapter displays in the Polling Information area.

   5. In the Log Configuration area, change the Log Level to Trace.

      

7. Change a business partner again in SAP S/4HANA Cloud Public Edition

   1. After another event has been triggered, caught by EMIS, and picked up by iFlow, we now see it in the trace.

   2. Click on the link Monitor Message Processing.

      

   3. Click on the link Trace.

   4. Select End→Message Content→Payload.

      

   5. The fired event displays as payload.