0% found this document useful (0 votes)
35 views10 pages

Event Notifications in SAP Cloud For Customer

This document provides an overview of event notifications in SAP Cloud for Customer. It describes how to configure event notifications for external consumers or SAP Cloud Platform extensions. It also explains how to monitor event notifications and use the OData API for event notification subscriptions.

Uploaded by

Diego
Copyright
© © All Rights Reserved
We take content rights seriously. If you suspect this is your content, claim it here.
Available Formats
Download as PDF, TXT or read online on Scribd
0% found this document useful (0 votes)
35 views10 pages

Event Notifications in SAP Cloud For Customer

This document provides an overview of event notifications in SAP Cloud for Customer. It describes how to configure event notifications for external consumers or SAP Cloud Platform extensions. It also explains how to monitor event notifications and use the OData API for event notification subscriptions.

Uploaded by

Diego
Copyright
© © All Rights Reserved
We take content rights seriously. If you suspect this is your content, claim it here.
Available Formats
Download as PDF, TXT or read online on Scribd
You are on page 1/ 10

PUBLIC

2021-03-09

Event Notifications in SAP Cloud for Customer


© 2021 SAP SE or an SAP affiliate company. All rights reserved.

THE BEST RUN


Content

1 Overview. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3

2 Configure an Event Notification. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4


2.1 External Consumer. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4
2.2 SAP Cloud Platform Extensions. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5

3 Event Notification Monitoring. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .7

4 OData API for Event Notification Subscriptions. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8

Event Notifications in SAP Cloud for Customer


2 PUBLIC Content
1 Overview

With Event Notifications, you can subscribe to changes to business objects in SAP Cloud for Customer.
Notifications are available for create, update, and delete at both root and node levels.

Consumer Types

Event Notifications supports the following:

● Kyma , an open -source extension platform.


● External or Custom Consumer

Authentication

Support for the following authentication methods is available:

● SSL Client Certificate


● Basic Authentication
● No authentication

Event Notifications in SAP Cloud for Customer


Overview PUBLIC 3
2 Configure an Event Notification

See how to configure an event notification for the following consumer types:

External Consumer [page 4]


To configure an event notification for an external customer, follow these instructions:

SAP Cloud Platform Extensions [page 5]


To configure an event notification for SAP Cloud Platform Extensions, follow these instructions:

2.1 External Consumer

To configure an event notification for an external customer, follow these instructions:

1. In SAP Cloud for Customer, navigate to Administrator General Settings System Administration
Event Notification .
2. Go to All Consumers, click Add.
3. Select type External Consumer, and then enter a Name and the Endpoint and then click Save.
4. Select the consumer and click Edit Credentials to enter authentication details.
5. Go to Subscriptions Add .
6. Select a Business Object and Node and then select at least one of Create, Update, or Delete.
7. Enable Field changed to receive notifications based on change in the status of a business object.
For root nodes of a business object, you can receive a notification when there's a status change in the
business object. For example, you can use this feature to configure the system to generate a notification
when an opportunity is created, updated, or deleted.
8. Enable Enhanced Payload to enhance the event notification payload to include changes to business
objects.
Enable this feature if, in addition to receiving a notification of change in a business object, you also want to
see the changes in the payload. Here's a summary of the changes available in the payload:

Notification Changes Available in Payload

Updated Old and new values of NodeIDs, ParentNodeIDs, and field


changes are available for root node and most subnodes.

Created/Deleted Only NodeIDs and ParentNodeIDs

9. Click Save.
10. Select the consumer and then go to Actions Activate .

Parent topic: Configure an Event Notification [page 4]

Event Notifications in SAP Cloud for Customer


4 PUBLIC Configure an Event Notification
Related Information

SAP Cloud Platform Extensions [page 5]

2.2 SAP Cloud Platform Extensions

To configure an event notification for SAP Cloud Platform Extensions, follow these instructions:

Step 1: Register your SAP Cloud for Customer system to connect with an SAP Cloud
Platform global account.
For instructions, see Register an SAP Customer Experience System.

Step 2: Configuration in SAP Cloud for Customer Event Notifications.

1. In SAP Cloud for Customer, navigate to Administrator General Settings System Administration
Event Notification .
2. Go to All Consumers, click Add.
3. Select type SAP Cloud Platform Extensions, and then enter the following information:
○ Name: Give a name to the consumer.
○ Remote Environment URL: Paste the token that you copied from SAP Cloud Platform cockpit.
○ Callback User: Enter your SAP Cloud for Customer user ID
○ Callback Password: Enter your SAP Cloud for Customer password
and then click Save.
4. Go to Subscriptions Add .
5. Select a Business Object and Node and then select at least one of Create, Update, or Delete.
6. Enable Field changed to receive notifications based on change in the status of a business object.
For root nodes of a business object, you can receive a notification when there's a status change in the
business object. For example, you can use this feature to configure the system to generate a notification
when an opportunity is created, updated, or deleted.
7. Enable Enhanced Payload to enhance the event notification payload to include changes to business
objects.
Enable this feature if, in addition to receiving a notification of change in a business object, you also want to
see the changes in the payload. Here's a summary of the changes available in the payload:

Notification Changes Available in Payload

Updated Old and new values of NodeIDs, ParentNodeIDs, and field


changes are available for root node and most subnodes.

Created/Deleted Only NodeIDs and ParentNodeIDs

8. Click Save.
9. Select the consumer and then go to Actions Activate .

Parent topic: Configure an Event Notification [page 4]

Event Notifications in SAP Cloud for Customer


Configure an Event Notification PUBLIC 5
Related Information

External Consumer [page 4]

Event Notifications in SAP Cloud for Customer


6 PUBLIC Configure an Event Notification
3 Event Notification Monitoring

See how to use monitor the events you have subscribed to.

Go to Administrator General Settings System Administration Event Notification Monitoring .

You can see successful and failed notifications here. Details on events such as status, endpoint, and payload is
available.

Event Notification Monitoring also allows you to resend event notifications. Select one or more events and click
Resend and refresh the list to see the latest notifications.

Event Notifications in SAP Cloud for Customer


Event Notification Monitoring PUBLIC 7
4 OData API for Event Notification
Subscriptions

Create an event notification without using the user interface.

We've introduced an OData API that allows you to configure event notifications. Details are as follows:

● Service URL: https://<your-tenant>/sap/c4c/odata/v1/eventnotification


● Refer c4c:value-help attributes for codelist values of BusinessObject and codes of
BusinessObjectNode.
● If the consumer requires authentication, you must use the Event Notification user interface to set it.

Event Notifications in SAP Cloud for Customer


8 PUBLIC OData API for Event Notification Subscriptions
Important Disclaimers and Legal Information

Hyperlinks
Some links are classified by an icon and/or a mouseover text. These links provide additional information.
About the icons:

● Links with the icon : You are entering a Web site that is not hosted by SAP. By using such links, you agree (unless expressly stated otherwise in your
agreements with SAP) to this:

● The content of the linked-to site is not SAP documentation. You may not infer any product claims against SAP based on this information.
● SAP does not agree or disagree with the content on the linked-to site, nor does SAP warrant the availability and correctness. SAP shall not be liable for any
damages caused by the use of such content unless damages have been caused by SAP's gross negligence or willful misconduct.

● Links with the icon : You are leaving the documentation for that particular SAP product or service and are entering a SAP-hosted Web site. By using such
links, you agree that (unless expressly stated otherwise in your agreements with SAP) you may not infer any product claims against SAP based on this
information.

Videos Hosted on External Platforms


Some videos may point to third-party video hosting platforms. SAP cannot guarantee the future availability of videos stored on these platforms. Furthermore, any
advertisements or other content hosted on these platforms (for example, suggested videos or by navigating to other videos hosted on the same site), are not within
the control or responsibility of SAP.

Beta and Other Experimental Features


Experimental features are not part of the officially delivered scope that SAP guarantees for future releases. This means that experimental features may be changed by
SAP at any time for any reason without notice. Experimental features are not for productive use. You may not demonstrate, test, examine, evaluate or otherwise use
the experimental features in a live operating environment or with data that has not been sufficiently backed up.
The purpose of experimental features is to get feedback early on, allowing customers and partners to influence the future product accordingly. By providing your
feedback (e.g. in the SAP Community), you accept that intellectual property rights of the contributions or derivative works shall remain the exclusive property of SAP.

Example Code
Any software coding and/or code snippets are examples. They are not for productive use. The example code is only intended to better explain and visualize the syntax
and phrasing rules. SAP does not warrant the correctness and completeness of the example code. SAP shall not be liable for errors or damages caused by the use of
example code unless damages have been caused by SAP's gross negligence or willful misconduct.

Gender-Related Language
We try not to use gender-specific word forms and formulations. As appropriate for context and readability, SAP may use masculine word forms to refer to all genders.

Event Notifications in SAP Cloud for Customer


Important Disclaimers and Legal Information PUBLIC 9
www.sap.com/contactsap

© 2021 SAP SE or an SAP affiliate company. All rights reserved.

No part of this publication may be reproduced or transmitted in any form


or for any purpose without the express permission of SAP SE or an SAP
affiliate company. The information contained herein may be changed
without prior notice.

Some software products marketed by SAP SE and its distributors


contain proprietary software components of other software vendors.
National product specifications may vary.

These materials are provided by SAP SE or an SAP affiliate company for


informational purposes only, without representation or warranty of any
kind, and SAP or its affiliated companies shall not be liable for errors or
omissions with respect to the materials. The only warranties for SAP or
SAP affiliate company products and services are those that are set forth
in the express warranty statements accompanying such products and
services, if any. Nothing herein should be construed as constituting an
additional warranty.

SAP and other SAP products and services mentioned herein as well as
their respective logos are trademarks or registered trademarks of SAP
SE (or an SAP affiliate company) in Germany and other countries. All
other product and service names mentioned are the trademarks of their
respective companies.

Please see https://www.sap.com/about/legal/trademark.html for


additional trademark information and notices.

THE BEST RUN

You might also like