Leverage SAP AEM Event Portal for seamless EDA integration and Governance

Estimated read time 15 min read

In my earlier blog “From Traditional to Real-Time: Enhance SAP with Advanced Event Mesh”, I explained why SAP customers need to adopt event driven architecture (EDA), the value of SAP Integration Suite advanced event mesh, types of events in SAP, challenges SAP ECC customers face, and most importantly how effective event management and governance makes or breaks EDA adoption for SAP customers.

SAP architects and developers who are naturally inclined to adopt a design-first approach to solution designing and implementation gain a wide range of benefits by incorporating event governance and management, such as:

Data quality and consistencySecurity and compliancePerformance optimizationMonitoring and observabilityScalability and flexibilityInteroperability

In this blog, I will talk more about the event portal capabilities of the SAP Integration Suite, advanced event mesh and why it’s critical for SAP customers to adopt it into their EDA journey.

How Event Portal can Accelerate the Adoption of EDA and Maximize its Value

SAP Integration Suite, advanced event mesh includes an event portal designed to help organizations efficiently design, deploy, and manage event-driven architectures (EDA). It offers features for event discovery, design, governance, and management, making it easier for businesses to embrace EDA and maximize its benefits.

Key Benefits of SAP AEM Event Portal for SAP Customers

Simplified Event Discovery and Management

Centralized Repository: Catalog and discover all events, both SAP standard and custom, within the enterprise ecosystem.Comprehensive Management: Manage event schemas, metadata, and lifecycle, ensuring a single source of truth and reducing discrepancies.

Enhanced Event Design and Governance

Intuitive Design Tools: Graphically model event-driven architecture, design event flows, and define schemas.Robust Governance: Manage event lifecycle with access controls, version management, and auditing to ensure compliance and security.

Improved Collaboration and Alignment

Shared Platform: Easy collaboration among IT, development, and business units for cohesive event-driven solutions by allowing developers self-service access to events, sharing Event APIs across partners and teams and more.Business-IT Alignment: Bridge the gap between business requirements and technical implementation, aligning EDA initiatives with strategic goals for maximum value.

Empowered User Self-Service with Governance

Controlled Innovation: Empower users to explore event artifacts and flows, identify new use cases, and deploy runtime configurations—all within a governed, secure workflow that integrates seamlessly with existing business processes and systems.

For SAP customers, the SAP AEM Event Portal is a crucial enabler of Event-Driven Architecture (EDA), streamlining its adoption and maximizing its benefits. By simplifying event management, enhancing design and governance, enabling seamless integration, and providing analytics, the portal helps SAP customers reap the full business benefits of EDA. This approach boosts operational efficiency via reuse, drives innovation, and enhances agility and competitiveness. Embracing the SAP AEM Event Portal transforms event management, leading to more responsive, scalable, and intelligent enterprise systems.

What is AsyncAPI and its Compatibility with AEM Event Portal

AsyncAPI is an open-source initiative designed to standardize asynchronous communication between microservices, applications and systems. It provides a framework for defining event driven APIs, similar to how OpenAPI is used for RESTful APIs. With AsyncAPI, it’s possible to create well-documented, consistent and machine-readable specifications for events and messages, enabling easier integration and collaboration across diverse systems.

In the context of the SAP Advanced Event Mesh Event Portal, AsyncAPI is fully compatible, allowing SAP customers to leverage its specification format to describe, visualize, and manage their event-driven architectures. The Event Portal supports AsyncAPI definitions, enabling seamless integration of events across SAP and non-SAP applications. This compatibility ensures that organizations can adopt a standardized approach to event management, enhancing interoperability, reducing integration complexity, and fostering a more agile and responsive enterprise architecture.

Generating AsyncAPI specs for SAP Events

SAP Business Accelerator Hub

The SAP Business Accelerator Hub (formerly SAP API Business Hub) is a platform offering a central repository of APIs, pre-built integrations, and event specifications. Events in this hub are standard notifications from various SAP systems like SAP Ariba, S4 Hana, Customer Experience, etc. and are not customizable.

The AsycnAPI specifications for these standard events are available for download from the SAP Business Accelerator Hub.

Figure 1:SAP Business acclerator hub AsyncAPI download
Source: https://api.sap.com/event/CE_SALESINQUIRYEVENTS/overview

Asapio Connector for SAP Advanced Event Mesh

Following what we discussed in the earlier blog “From Traditional to Real-Time: Enhance SAP with Advanced Event Mesh“, the Asapio Integration for SAP AEM supports publishing and consuming custom events making SAP systems more efficient and responsive.

It’s possible to export these custom event definitions as AsyncAPI specifications as below:

Figure 2:AsyncAPI spec from Asapio plugin

How to import AsyncAPI specs for different events to Event Portal using the AsyncAPI importer

SAP AEM provides several REST APIs for creating or modifying objects and services within the AEM Event Portal. These REST APIs require a token, generated and assigned roles in the AEM Cloud console, to access brokers, the Event Portal, and perform various operations.

To facilitate this process, an open-source CLI utility tool has been developed. This tool internally invokes the aforementioned REST APIs to create, update, or delete AEM Event Portal objects in a clean, version-controlled manner. The tool can be used as a standalone utility or embedded into CI/CD pipelines or other automated mechanisms.

Installing the tool

Install the AsyncAPI Importer CLI tool with a Node package manager or NPM as below:

 

npm install @solace-labs/ep-async-api-importer -g

 

Generating the AEM Token

Since the CLI utility tool internally invokes the AEM Cloud REST APIs, it also requires an access token to function. The documentation over here: Creating a SAP AEM EP token defines in detail the steps for creating a token.

Configuring behavior using flags

The CLI tool’s behavior can be configured by several flags and options. Some examples are listed below :

Option name

Description

CLI_LOGGER_PRETTY_PRINT

Pretty print the log output. Convenience for visual debugging

CLI_IMPORT_ASSETS_TARGET_VERSION_STRATEGY

The versioning strategy for imported assets (bump-patch, bump-minor)

CLI_IMPORT_CREATE_API_APPLICATION

Flag to create an Event Portal Application representing the API Spec

CLI_IMPORT_BROKER_TYPE

The broker type setting for all imported objects (Kafka/Solace)

CLI_IMPORT_CHANNEL_DELIMITER

The channel delimiter used in the spec. Global setting for all imported objects

CLI_VALIDATE_API_BEST_PRACTICES

Flag to run ‘best practices’ validation on API(s)

Other options supported by the CLI tool can be found at the details page: AsyncAPI Importer CLI or by running the help command as: 

 

ep-async-api-importer -h

 

Using the CLI

Below is an example of importing a single AsyncAPI specification file:

 

ep-async-api-importer –filePattern FILE_NAME –domain sap-s4-operational-events

 

Another example of importing multiple AsyncAPI specification file where with a glob pattern can be used to identify multiple AsyncAPI specifications that need to be imported:

 

ep-async-api-importer –-filePattern ‘/*.json’ –domain sap-s4-operational-events

 

In both the cases a successful import process will result in event(s), schema(s) and Event API(s) being imported into the AEM Event Portal as below: 

Image 3: SAP Event specs imported into AEM Event Portal

Image 4: SAP Event schemas imported into AEM Event Portal

Image 5: SAP Events imported into AEM Event Portal as Event APIs

With this, SAP Architects, designers and developers can use the SAP AEM Event Portal to design, catalog and govern their EDA architecture and artefacts. 

Summary and what’s next

This article continues our discussion on adopting EDA for SAP customers, focusing on how the SAP Integration Suite, advanced event mesh and its event portal accelerate EDA adoption. The event portal offers a range of capabilities, including event discovery, design, governance, and management, simplifying event-driven architecture integration across diverse systems.

Key benefits of the SAP AEM Event Portal include:

Simplified Event Management: Centralized repository and comprehensive tools for managing event schemas, metadata, and lifecycle.Enhanced Design and Governance: Intuitive design tools, robust governance, and version management for secure and compliant event management.Improved Collaboration: A shared platform that aligns business and IT, fostering cohesive event-driven solutions. Additionally, the compatibility of the AsyncAPI framework with the Event Portal facilitates standardized and efficient management of asynchronous communications across SAP and non-SAP systems. Practical steps for generating AsyncAPI specifications for SAP events and importing them into the Event Portal using a CLI utility tool are also covered.

This comprehensive suite of tools enables SAP customers to fully leverage EDA, enhancing operational efficiency, innovation, and agility, thereby transforming event management and fostering a more responsive, scalable enterprise architecture.

In the upcoming final part of this blog series, I will dive deeper into how SAP integration architects, product managers, and developers can unlock the full potential of the event portal to discover and manage business-critical events across multiple business lines with robust governance. You’ll also learn how the extensible features of the event portal can drive innovation by generating high-quality scaffolding code, accelerating integration with both SAP and non-SAP systems, including SAP Cloud Platform Integration (CPI). Discover how these tools empower your teams to seamlessly connect and scale your enterprise architecture for greater agility and responsiveness.

 

​ In my earlier blog “From Traditional to Real-Time: Enhance SAP with Advanced Event Mesh”, I explained why SAP customers need to adopt event driven architecture (EDA), the value of SAP Integration Suite advanced event mesh, types of events in SAP, challenges SAP ECC customers face, and most importantly how effective event management and governance makes or breaks EDA adoption for SAP customers. SAP architects and developers who are naturally inclined to adopt a design-first approach to solution designing and implementation gain a wide range of benefits by incorporating event governance and management, such as:Data quality and consistencySecurity and compliancePerformance optimizationMonitoring and observabilityScalability and flexibilityInteroperabilityIn this blog, I will talk more about the event portal capabilities of the SAP Integration Suite, advanced event mesh and why it’s critical for SAP customers to adopt it into their EDA journey.How Event Portal can Accelerate the Adoption of EDA and Maximize its ValueSAP Integration Suite, advanced event mesh includes an event portal designed to help organizations efficiently design, deploy, and manage event-driven architectures (EDA). It offers features for event discovery, design, governance, and management, making it easier for businesses to embrace EDA and maximize its benefits.Key Benefits of SAP AEM Event Portal for SAP CustomersSimplified Event Discovery and ManagementCentralized Repository: Catalog and discover all events, both SAP standard and custom, within the enterprise ecosystem.Comprehensive Management: Manage event schemas, metadata, and lifecycle, ensuring a single source of truth and reducing discrepancies.Enhanced Event Design and GovernanceIntuitive Design Tools: Graphically model event-driven architecture, design event flows, and define schemas.Robust Governance: Manage event lifecycle with access controls, version management, and auditing to ensure compliance and security.Improved Collaboration and AlignmentShared Platform: Easy collaboration among IT, development, and business units for cohesive event-driven solutions by allowing developers self-service access to events, sharing Event APIs across partners and teams and more.Business-IT Alignment: Bridge the gap between business requirements and technical implementation, aligning EDA initiatives with strategic goals for maximum value.Empowered User Self-Service with GovernanceControlled Innovation: Empower users to explore event artifacts and flows, identify new use cases, and deploy runtime configurations—all within a governed, secure workflow that integrates seamlessly with existing business processes and systems.For SAP customers, the SAP AEM Event Portal is a crucial enabler of Event-Driven Architecture (EDA), streamlining its adoption and maximizing its benefits. By simplifying event management, enhancing design and governance, enabling seamless integration, and providing analytics, the portal helps SAP customers reap the full business benefits of EDA. This approach boosts operational efficiency via reuse, drives innovation, and enhances agility and competitiveness. Embracing the SAP AEM Event Portal transforms event management, leading to more responsive, scalable, and intelligent enterprise systems.What is AsyncAPI and its Compatibility with AEM Event PortalAsyncAPI is an open-source initiative designed to standardize asynchronous communication between microservices, applications and systems. It provides a framework for defining event driven APIs, similar to how OpenAPI is used for RESTful APIs. With AsyncAPI, it’s possible to create well-documented, consistent and machine-readable specifications for events and messages, enabling easier integration and collaboration across diverse systems.In the context of the SAP Advanced Event Mesh Event Portal, AsyncAPI is fully compatible, allowing SAP customers to leverage its specification format to describe, visualize, and manage their event-driven architectures. The Event Portal supports AsyncAPI definitions, enabling seamless integration of events across SAP and non-SAP applications. This compatibility ensures that organizations can adopt a standardized approach to event management, enhancing interoperability, reducing integration complexity, and fostering a more agile and responsive enterprise architecture.Generating AsyncAPI specs for SAP EventsSAP Business Accelerator HubThe SAP Business Accelerator Hub (formerly SAP API Business Hub) is a platform offering a central repository of APIs, pre-built integrations, and event specifications. Events in this hub are standard notifications from various SAP systems like SAP Ariba, S4 Hana, Customer Experience, etc. and are not customizable.The AsycnAPI specifications for these standard events are available for download from the SAP Business Accelerator Hub.Figure 1:SAP Business acclerator hub AsyncAPI downloadSource: https://api.sap.com/event/CE_SALESINQUIRYEVENTS/overviewAsapio Connector for SAP Advanced Event MeshFollowing what we discussed in the earlier blog “From Traditional to Real-Time: Enhance SAP with Advanced Event Mesh”, the Asapio Integration for SAP AEM supports publishing and consuming custom events making SAP systems more efficient and responsive.It’s possible to export these custom event definitions as AsyncAPI specifications as below:Figure 2:AsyncAPI spec from Asapio pluginHow to import AsyncAPI specs for different events to Event Portal using the AsyncAPI importerSAP AEM provides several REST APIs for creating or modifying objects and services within the AEM Event Portal. These REST APIs require a token, generated and assigned roles in the AEM Cloud console, to access brokers, the Event Portal, and perform various operations.To facilitate this process, an open-source CLI utility tool has been developed. This tool internally invokes the aforementioned REST APIs to create, update, or delete AEM Event Portal objects in a clean, version-controlled manner. The tool can be used as a standalone utility or embedded into CI/CD pipelines or other automated mechanisms. Installing the toolInstall the AsyncAPI Importer CLI tool with a Node package manager or NPM as below: npm install @solace-labs/ep-async-api-importer -g Generating the AEM TokenSince the CLI utility tool internally invokes the AEM Cloud REST APIs, it also requires an access token to function. The documentation over here: Creating a SAP AEM EP token defines in detail the steps for creating a token. Configuring behavior using flagsThe CLI tool’s behavior can be configured by several flags and options. Some examples are listed below :Option nameDescriptionCLI_LOGGER_PRETTY_PRINTPretty print the log output. Convenience for visual debuggingCLI_IMPORT_ASSETS_TARGET_VERSION_STRATEGYThe versioning strategy for imported assets (bump-patch, bump-minor)CLI_IMPORT_CREATE_API_APPLICATIONFlag to create an Event Portal Application representing the API SpecCLI_IMPORT_BROKER_TYPEThe broker type setting for all imported objects (Kafka/Solace)CLI_IMPORT_CHANNEL_DELIMITERThe channel delimiter used in the spec. Global setting for all imported objectsCLI_VALIDATE_API_BEST_PRACTICESFlag to run ‘best practices’ validation on API(s)Other options supported by the CLI tool can be found at the details page: AsyncAPI Importer CLI or by running the help command as:  ep-async-api-importer -h Using the CLIBelow is an example of importing a single AsyncAPI specification file:  ep-async-api-importer –filePattern FILE_NAME –domain sap-s4-operational-events Another example of importing multiple AsyncAPI specification file where with a glob pattern can be used to identify multiple AsyncAPI specifications that need to be imported:  ep-async-api-importer –-filePattern ‘/*.json’ –domain sap-s4-operational-events In both the cases a successful import process will result in event(s), schema(s) and Event API(s) being imported into the AEM Event Portal as below: Image 3: SAP Event specs imported into AEM Event PortalImage 4: SAP Event schemas imported into AEM Event PortalImage 5: SAP Events imported into AEM Event Portal as Event APIsWith this, SAP Architects, designers and developers can use the SAP AEM Event Portal to design, catalog and govern their EDA architecture and artefacts. Summary and what’s nextThis article continues our discussion on adopting EDA for SAP customers, focusing on how the SAP Integration Suite, advanced event mesh and its event portal accelerate EDA adoption. The event portal offers a range of capabilities, including event discovery, design, governance, and management, simplifying event-driven architecture integration across diverse systems.Key benefits of the SAP AEM Event Portal include:Simplified Event Management: Centralized repository and comprehensive tools for managing event schemas, metadata, and lifecycle.Enhanced Design and Governance: Intuitive design tools, robust governance, and version management for secure and compliant event management.Improved Collaboration: A shared platform that aligns business and IT, fostering cohesive event-driven solutions. Additionally, the compatibility of the AsyncAPI framework with the Event Portal facilitates standardized and efficient management of asynchronous communications across SAP and non-SAP systems. Practical steps for generating AsyncAPI specifications for SAP events and importing them into the Event Portal using a CLI utility tool are also covered.This comprehensive suite of tools enables SAP customers to fully leverage EDA, enhancing operational efficiency, innovation, and agility, thereby transforming event management and fostering a more responsive, scalable enterprise architecture.In the upcoming final part of this blog series, I will dive deeper into how SAP integration architects, product managers, and developers can unlock the full potential of the event portal to discover and manage business-critical events across multiple business lines with robust governance. You’ll also learn how the extensible features of the event portal can drive innovation by generating high-quality scaffolding code, accelerating integration with both SAP and non-SAP systems, including SAP Cloud Platform Integration (CPI). Discover how these tools empower your teams to seamlessly connect and scale your enterprise architecture for greater agility and responsiveness.   Read More Technology Blogs by Members articles 

#SAP

#SAPTechnologyblog

You May Also Like

More From Author