SAP CPI With BTP-1
SAP CPI With BTP-1
| SHIP
PUBLIC
Warning
This document has been generated from the SAP Help Portal and is an incomplete version of the official SAP product
documentation. The information included in custom documentation may not re ect the arrangement of topics in the SAP Help
This is custom documentation. For more information, please visit the SAP Help Portal 1
12/17/2022
Introduction to SAP Integration Suite: Before you start your migration, get to know SAP Integration Suite, learn about
its advantages, and get an overview of the migration process from SAP Process Orchestration to SAP Integration Suite.
Landscape: Assess your existing integration landscape and plan your target landscape.
Connectivity: Learn how to move your connectivity options to the connectors and adapters of the SAP Integration Suite.
Security: Get an overview of the security aspects you must consider while migrating and how to manage them in SAP
Integration Suite.
Error Handling and Logging Strategy: Learn about cloud-based error handling and logging strategies and understand the
different approaches available to you.
Interface Governance: Understand how interfaces are governed in the cloud and how to manage them across multiple
landscapes.
Interface Migration: Discover the different aspects involved in moving interfaces from SAP Process Integration and SAP
Process Orchestration to SAP Integration Suite, as well as scenario and object assessment and how testing can be
automated.
Tip
This guide is open for contributions and feedback using GitHub. This allows you to get in contact with responsible authors of
SAP Help Portal pages and the development team to discuss documentation-related issues. To contribute to this guide, or to
provide feedback, choose the corresponding option on SAP Help Portal:
Edit : Contribute to a documentation page. This option opens a pull request on GitHub.
Feedback: Provide feedback about a documentation page. This option opens an issue on GitHub.
More information:
Contribution Guidelines
This is custom documentation. For more information, please visit the SAP Help Portal 2
12/17/2022
What's New
Find out what's new in the Migration Guide for SAP Process Orchestration.
July 2022
Section Update
Migrating ESR Proxies In the section Interface Migration, you can now nd information on
how to migrate ESR proxies from the Enterprise Services
Repository to the Metadata Repository.
Key Highlights
Simpli ed integrations with capabilities of Cloud Integration, API Management, Integration Advisor, AI-based
development, SAP Integration Solution Advisory Methodology, the API Business Hub Enterprise, Cloud Connector, and
Open Connectors for more than 170 non-SAP applications
Time-to-live is accelerated with 2200+ pre-built integrations, 2500 APIs, 160 business events
Modernization of integrations supported integration use cases/styles: cloud to cloud, cloud to ground, A2A, B2B/G, API-
driven, event-driven
Fully capable feature set that can support cloud-to-cloud and hybrid integrations
This is custom documentation. For more information, please visit the SAP Help Portal 3
12/17/2022
SAP Integration Suite has four main capabilities: Cloud Integration, API Management, Open Connectors, and Integration
Advisor.
Cloud Integration
The Cloud Integration capability within SAP Integration Suite supports end-to-end process integration across cloud-based and
on-premise applications through the exchange of messages, from to cloud to on-premise and vice versa. It provides capabilities
to process messages in integration scenarios spanning different companies, organizations, or departments within an
organization.
Integration developers can use prede ned integration content available on SAP API Business Hub out of the box, enhance it,
or develop their own integration content from scratch. Integration content refers to all design artifacts that de ne how a
message is to be processed during an integration scenario. Cloud Integration provides a set of adapters that allow you to
specify a connection type and de ne, for example, which technical protocols should be used to connect a sender or a receiver
system to the tenant and how this connection is protected.
Since Cloud Integration covers the majority of the capabilities provided by SAP Process Orchestration system, it’s addressed as
main service when planning to migrate to SAP Integration Suite.
API Management
The SAP API Management capability allows you to publish, promote, oversee, and secure APIs in a scalable environment. SAP
API Management technology helps you share digital assets and enable developer communities to consume these assets in new
channels, devices, and user interfaces.
Open Connectors
A third key capability is SAP Open Connectors, which provides out-of-the-box capabilities to connect to over 170 non-SAP
services and applications on the market today. The number of standard connectors is growing and can be supplemented by the
implementation of bespoke connectors. Once a particular Open Connector instance has been con gured, it can be consumed in
a homogeneous way within either Cloud Integration or API Management.
Integration Advisor
This is custom documentation. For more information, please visit the SAP Help Portal 4
12/17/2022
The nal key capability is SAP Integration Advisor, a machine learning-based design tool that can be used to accelerate the
implementation of mappings between different source and target message structures. The tool uses a knowledge graph that
tracks past message structure de nitions and how they were previously mapped. Using machine learning algorithms, the
knowledge graph can propose mapping solutions for new mapping requirements to accelerate the design and development
process. The capability is particularly useful for B2B scenarios but is also applicable for use in other areas such as A2A and B2G.
SAP NetWeaver Process Integration and Process Orchestration is an on-premise integration platform hosted on customer-
managed infrastructure. It offers a service-oriented architecture and was one of the most widely adopted integration platforms.
However, modern day IT landscapes are evolving towards a cloud- rst approach. They're leveraging SaaS offerings to offload IT
maintenance efforts and focus on solving business challenges and innovating on customer experience. In this digital
transformation journey, it's important that the integration platform is also a cloud native solution that can also support cloud
(cloud ↔ cloud) and hybrid (cloud ↔ on-premise) integration scenarios.
Integration platforms play a strategic role for businesses coping with heterogeneous and hybrid IT landscapes. Seamless
integration across applications and systems — whether they're SAP, non-SAP, on-premise, or cloud — enable organizations to
digitize their end-to-end processes and make the enterprise more connected and intelligent. Forward-thinking organizations are
taking a holistic and strategic approach to their enterprise integration initiatives as they pursue digital transformation,
embracing the agility and simplicity of modern cloud-based integration platforms as they move to more intelligent solutions
such as SAP S/4HANA and SAP’s Intelligent Suite. The right integration platform can help businesses achieve end-to-end
process excellence across their systems, simplify connected experiences for customers, build business-to-business (B2B)
networks and digital ecosystems, and innovate with new business models, while also bringing along the best of their existing
integration investments.
SAP Integration Suite is a future-proof, cloud native, fully managed integration platform as a service (iPaaS) that can help in
accelerating digital transformation journeys. It supports all types of modern-day integration patterns, helping customers build
an enterprise IT landscape that transforms the organization into an Intelligent Enterprise.
SAP Integration Suite is a fully managed SaaS offering that can help you get started with no intervention from the service
provider. It also offers 2000+ prebuilt integrations, 2500 APIs, and 150 business events on the SAP API Business Hub, and this
list keeps growing. You can quickly get started and implement your integration projects with a combination of these features,
helping you generate value in less time. In line with SAP’s motto of “Run Simple”, SAP Integration Suite aims to “simplify
integration” as much as possible by democratizing integration using the low-code no-code approach, an intuitive graphical user
interface, and intelligent technologies to improve productivity. The overall learning curve for SAP Integration Suite is
signi cantly smaller compared to other integration solutions owing to the innovative and intuitive features it offers.
SAP Integration Suite provides prepackaged business content for different line of business scenarios on SAP API Business Hub
without any additional costs. These integration packages contain integration ows, message and value mappings, and
scripts among other integration artifacts that can accelerate your integration projects and reduce the overall implementation
This is custom documentation. For more information, please visit the SAP Help Portal 5
12/17/2022
time. This also results in signi cant cost savings, with some customers reporting as much as 60% cost savings. SAP also
manages the lifecycle of these integration packages, providing updates and patches that can be consumed with a few clicks.
Lower cost of initial deployment and ongoing cost of running the solution
Since SAP Integration Suite is hosted on the SAP Business Technology Platform (BTP), it's fully managed by SAP. You can easily
get started with SAP Integration Suite as it's offered in exible licensing models like CPEA (Cloud Platform Enterprise
Agreement) and PayG (Pay-As-You-Go). With minimal upfront effort, you have an enterprise-grade integration platform that
you can leverage to implement any modern-day integration pattern. Messages are relatively inexpensive and offered in a tiered
pricing model that offers a lower price per message block as the message consumption increases. This pricing model offers
greater value over a at pricing model where customers with high message loads don't get any bene t.
SAP fully manages and operates SAP Integration Suite, helping you focus your efforts on leveraging the service to solve your
organization’s problems. With no weekly downtime for updates and upgrades, you can be sure that your business-critical
processes are not affected during the maintenance windows. The monthly release cycle ensures that you will receive updates
and upgrades on a regular basis without any impact on your existing scenarios, helping you to improve and innovate
continuously. SAP Integration Suite is also the future-proof and recommended solution from SAP where all new innovations and
features will be delivered. Here’s a preview of some of the features that will be delivered only on SAP Integration Suite:
Future-proof your investments and move to multicloud (Amazon Web Services, Azure, Ali Cloud, Google Cloud)
deployments.
One license and metric for all capabilities of SAP Integration Suite
Free SAP-to-SAP messages via standard prepackaged content shipped by SAP via SAP API Business Hub
This is custom documentation. For more information, please visit the SAP Help Portal 6
12/17/2022
Full lifecycle API management for modern API- rst strategy
Unlimited Async Message Queues (required for reliable delivery, e.g. if the target system isn't available)
Getting started with SAP Integration Suite has never been easier. Once you license SAP Integration Suite, you can leverage the
self-service to provision your tenant and get started quickly. The entire process of provisioning a tenant takes less than 4 hours,
reducing the deployment risk and helping you focus on implementing integration scenarios. You can easily set up a global
integration landscape in multiple regions within a few hours. The required capabilities can be activated separately, as and when
required. The common launchpad acts as the ʻhome page’ for SAP Integration Suite, helping you seamlessly switch between
capabilities.
For detailed instructions on how to quickly get started with SAP Integration Suite, see Initial Setup - SAP Integration Suite.
This is custom documentation. For more information, please visit the SAP Help Portal 7
12/17/2022
their existing business processes but also innovate and deliver a world-class customer experience to their customers and
partners. The following section features a preview of a few customers who reaped the bene ts of using SAP Integration Suite as
their integration platform of choice.
For a full list of references of customers who are using SAP Integration Suite as their primary integration platform, see SAP
Integration Suite Customer Stories on SAP Customer Story Finder .
In a bid to future-proof their integration platform, American Styrenics LLC (AmSty) decided to migrate their existing 40 SAP
Process Integration interfaces to SAP Integration Suite. They successfully completed the migration project within 3 months,
with no impact on existing business. The fact that there were no major incidents after the migration is a testament to the
degree of success of their migration project. The organization also leveraged SAP Alert Noti cation Service to integrate
alerting with ServiceNow. This enabled them to distribute the monitoring of their integrations across their support organization.
For the full story, see American Styrenics LLC success story on SAP Innovations Award portal .
QforIT
QforIT streamlined enterprise integrations for its customers with SAP Integration Suite. They took advantage of the
prepackaged integration scenarios available on the SAP API Business Hub, improving the speed of con guring integration
scenarios by 400%. They also achieved a lift and shift approach to shifting scenarios from SAP Process Orchestration and SAP
Process Integration to SAP Integration Suite with minimal efforts and risks. Improved monitoring capabilities provided by SAP
Integration Suite helped them identify possible problems and enable fast, reactive monitoring support. QforIT uses SAP
Integration Suite for smart integration of processes, people, things, and data.
For the full story, see SAP Customer Story Finder portal .
This is custom documentation. For more information, please visit the SAP Help Portal 8
12/17/2022
There are two approaches in which you can plan to transition to SAP Integration Suite:
1. All interfaces from SAP Process Integration and SAP Process Orchestration are moved to SAP Integration Suite
(recommended).
In this approach, SAP Integration Suite is used as the primary integration platform and all the interfaces on SAP Process
Integration and SAP Process Orchestration are transitioned to SAP Integration Suite. This transition is an opportunity to
evaluate the integration scenarios and improve or adapt them to suit the cloud- rst architecture. Modern integration
approaches like event-based integration can be leveraged to build intelligent scenarios and improve the end-to-end
efficiency of business processes.
2. Deploy and maintain all cloud-to-cloud and hybrid integration scenarios on SAP Integration Suite and use SAP Process
Integration and SAP Process Orchestration for a limited set of scenarios.
In this approach, too, SAP Integration Suite is the primary integration platform. All new scenarios including cloud-to-
cloud and cloud-to-on-premise are deployed on SAP Integration Suite. Only on-premise-to-on-premise integration
scenarios are deployed on the existing SAP Process Integration and SAP Process Orchestration landscape.
If you prefer this approach, follow these steps as a high-level strategy for choosing the integration platform:
Build all new scenarios on SAP Integration Suite and deploy on-premise scenarios on the Cloud Integration
runtime available in SAP NetWeaver 7.5
See the article Technical Guide: Transitioning to SAP Cloud Platform Integration Suite .
This is custom documentation. For more information, please visit the SAP Help Portal 9
12/17/2022
Assess
Assess your existing landscape and identify areas of improvement and innovation for you envisioned target landscape, which
can amplify the bene t of transitioning to the cloud.
The following tools and assets can help with the assessment:
The Integration Value Calculator considering parameters like the type of integrations, average price per hour for
integration consultants, duration, etc. to provide a subjective view of the estimated cost savings that can be achieved
with SAP Integration Suite.
The SAP Integration Solution Advisory Methodology tool evaluates the current integration maturity level of an
organization and provides possible improvements.
As enterprise-grade integration scenarios must be scalable, robust, and secure, the Integration Flow Design Guidelines
provide best practices that can be used to build such high-quality integration scenarios. They contain patterns, tips and
tricks, and development best practices that can act as guiding principles for development.
A Future-proof Integration Strategy ensures that organizations are prepared for the next steps in their digital
transformation journeys. It's critical for organizations to factor this into the overall strategy to control costs and
encourage innovation at the same time.
Transform
One of the primary objectives of moving to the cloud and to SAP Integration Suite is to digitally transform your organization.
The key component in this transformation journey is to upgrade, refactor, and build modern business process and customer
experiences that leverage the latest integration patterns, like API- rst approach, event-sensing capability, and machine
learning-based interface development. While a lift and shift may sound like the path of least resistance, a transformation with a
KPI to improve business process efficiency and user experience results in maximum return on investment.
Accelerate Using Prebuilt Integrations from SAP API Business Hub : One of the key differentiators of SAP Integration
Suite is the business content provided on SAP API Business Hub, which accelerates your development project and saves
you maintenance effort. The content is managed by the content owners who provide upgrades and patches that can be
consumed with a few clicks and no impact to running processes. If standard unedited content is used for SAP-to-SAP
integration, the messages processed by this are free of cost. Customization of this standard content can be done
through extensions that don't disrupt the lifecycle of the prepackaged content.
Leverage APIs and Events : A modern-day integration landscape takes advantage of APIs and events to build an
intelligent enterprise. The scenarios can be con gured to sense and respond to business events in real time.
Communication is simpli ed with APIs that not only provide a greater degree of control over the way data is exposed, but
also protect the mission backend systems. An API- rst approach is recommended to build a landscape that is open to
innovation and helps deliver world-class customer experience.
Secure the Cloud : Cloud- rst strategy should be coupled with enterprise-grade security to ensure data con dentiality
and protection. There are various approaches to securing cloud-based business processes, in addition to the security
features provided by the SaaS service providers. SAP Integration Suite offers security policy templates that offer
enterprise-grade security and ensure that APIs are protected at the highest possible standards.
Move
This is custom documentation. For more information, please visit the SAP Help Portal 10
12/17/2022
To make your transition to SAP Integration Suite efficient, the steps involved ensure that existing integration assets are reused
as much as possible to reduce costs and time, while also supporting that transformation goals are achieved.
Assess the Landscape: A detailed assessment of the existing integration landscape and the involved artifacts provides
an overview of the artifacts that can be reused, refactored, and developed from scratch. This ensures optimum reuse
while accelerating your move and saving costs at the same time.
Connectivity Migration: The connectivity in the on-premise SAP Process Integration and SAP Process Orchestration
systems must be migrated to the respective adapters and connectors on SAP Integration Suite. In this step, the
protocols used in these communication channels are evaluated and equivalent connectivity options should be chosen on
SAP Integration Suite.
Security: The security aspects of a cloud-based integration platform depend on two main factors: security features
provided by the platform (in this case SAP), and the security con gurations that are developed to protect the
integration scenarios using the features provided by the platform. This security guide provides an overview of the
security aspects that should be considered when moving to SAP Integration Suite from SAP Process Integration and
SAP Process Orchestration.
Error Handling and Logging: When transitioning to a cloud-based integration platform, you also require a cloud-based
error handling and logging strategy. Learn about the different approaches and adapt to the error handling and logging
features provided by SAP Integration Suite.
Interface Governance: Understand how interfaces are governed in the cloud and how to manage them across multiple
landscapes. Learn about how transport service on the SAP Business Technology Platform can be used to implement an
interface governance model.
Interface Migration: Understand the different aspects involved in moving interfaces from SAP Process Integration and
SAP Process Orchestration to SAP Integration Suite. Learn about scenario and object assessment and how parts of
testing can be automated with the available tools.
Landscape
Get an overview of the important aspects regarding integration landscape, which must be evaluated before migrating from SAP
Process Orchestration to SAP Integration Suite in SAP BTP, Cloud Foundry Environment.
This is custom documentation. For more information, please visit the SAP Help Portal 11
12/17/2022
One of the rst steps in your migration journey is to evaluate is which systems are currently connected to SAP Process
Orchestration.
Cloud Middleware
Learn more about possible communications between Cloud Integration and an on-premise system.
Future Support of On-Premise Integration
Many customers will still have a strong on-premise landscape and on-premise integration scenarios. This scenario is
planned to be supported by a hybrid deployment option to avoid sending data to and receiving data from the cloud.
Identity Provider
Learn more about identity providers and user governance in SAP BTP.
For this assessment process, SAP recommends using the SAP Integration Solution Advisory Methodology . The goal of SAP
Integration Solution Advisory Methodology is to simplify integration and help enterprise architects to manage the complexity in
their hybrid landscapes.
There are three use cases on how the methodology can support enterprise architects:
One of the rst steps of SAP Integration Solution Advisory Methodology is to analyze the as-is landscape and de ne the to-be
landscape. The focus is on the integration landscape, integration domains, integration patterns, and use cases. At this phase,
there are no technologies evaluated. This provides a good overview of where the organization currently is and in which direction
the organization is evolving in the next years with regards to the integration strategy.
Once the direction of the integration strategy has been mapped out at a high level, a more detailed evaluation of the current
technologies used within the SAP Process Integration and SAP Process Orchestration landscape can commence.
SAP Process Orchestration Architecture describes the important factors to analyze with regards to the existing SAP Process
Integration and SAP Process Orchestration landscape, and the high-level steps to follow to ensure a successful migration.
This is custom documentation. For more information, please visit the SAP Help Portal 12
12/17/2022
In an SAP Process Orchestration system, there are different tools to de ne, design, and develop integration scenarios. The
following gure illustrates its high-level architecture:
System Landscape Directory (SLD) : The SLD is a component of SAP NetWeaver and is implemented with Java
technology. It's the central information repository for the system landscape and stores all information related to the
installed components of the landscape, which means it also facilitates the easy access to the information of the different
systems and software. The information is divided in three categories:
Landscape: con guration of the technical systems, landscapes, and business systems.
Enterprise Services Repository (ESR): ES Repository is a central repository that makes it possible to de ne, design, and
create objects to be used in the integration scenario. The repository stores the de nitions and metadata of enterprise
services and business processes. It also provides a central modeling and design environment for creating and
aggregating data models. ES Repository is managed using the Enterprise Services Builder (ESB), which is the tool used
to develop and access the objects in ES Repository and the Services Registry:
Enterprise Services Builder (ESB): ESB is used to de ne and manage objects in ESR. It contains the namespaces,
data types, message types, service interfaces (outbound/inbound), message mapping, and operation mappings
of interfaces.
Services Registry: Services Registry represents a registry for Web services and centrally stores information
regarding the services within SOA landscape. Contains information related to the services, with references to the
WSDL of registered services and endpoints. It provides support for SAP and non-SAP applications and controls
This is custom documentation. For more information, please visit the SAP Help Portal 13
12/17/2022
the available services in SOA landscape. It's an important source for developers to nd the available services in
the system landscape that could be reused in integration scenarios.
Integration Directory (ID): The Integration Directory is used to con gure the end-to-end integration scenarios using the
objects created in ESR and SLD.
Objects included:
Communication Channels
Routing between the sender and target systems, and the mappings.
Related Toolset:
Integration Builder: Edit (create, copy) and manage the objects in the Integration Directory.
Advanced Adapter Engine (AAE): With the Advanced Adapter Engine, you can connect SAP systems and non-SAP
systems. You use the various adapters in the Advanced Adapter Engine to convert XML- and HTTP-based messages to
the speci c protocol and format required by these systems, and the other way around.
Cloud Integration Content: You can deploy, execute, and operate cloud integration content from the SAP Integration
Content Catalog in the Advanced Adapter Engine with all the deployment options (PI-AEX, decentralize Adapter Engine,
SAP Process Orchestration and SAP Process Integration dual usage type). For more information, see SAP Note 2197483
.
Con guration and Monitoring: These components provide an overview of the status of the individual components of SAP
Process Integration and SAP Process Orchestration and include the capability to perform test message execution to
verify that the runtime components are working correctly, test connectivity, check the status of your communication
channels or the Java Proxies, etc. For more information, see the section Error Handling and Logging Strategy.
The integrated development environment SAP NetWeaver Developer Studio (NWDS) is an Eclipse-based tool that can be used
to develop end-to-end scenarios (interfaces). In NWDS, it’s possible to create ESR objects and Integration Directory
con gurations, and to graphically model the message handling within the Process Integration Designer perspective.
With NWDS, you can build end-to-end integrations using integration ows, more plug-ins for development that might be
accessed by the perspectives and views, and an integrated runtime view. The SAP Process Integration Runtime perspective
allows you to directly navigate into the respective monitoring environments of SAP Process Integration such as message
monitoring and channel monitoring. For more information, see SAP NetWeaver Developer Studio Basics.
The following section describes the three high-level architectural models in SAP Process Orchestration deployment: Central,
Distributed (Model 1), and Distributed (Model 2). The scope is to give an overview of architecture topology with speci c
reference to federation, and not to discuss scaling with respect to performance or high availability.
Central
A single integration server communicating with all business systems. Central deployment of SAP Process Orchestration is a
common architecture for most organizations as it represents the smallest possible installation footprint and holds associated
TCO bene ts.
Bene ts
This is custom documentation. For more information, please visit the SAP Help Portal 14
12/17/2022
Less complex system architecture
Considerations
For SAP Process Orchestration, system sizing and con guration must re ect both human-centric and integration-centric
scenarios.
Distributed (Model 1)
A single integration server with one or more decentralized adapter engines communicating with relevant business systems. It's
often found in organizations where performance or security reasons dictate a more complex solution compared to
centralization. This is a hybrid approach between central and federated models combining the bene ts around performance and
security with the bene ts from centralized governance, maintenance, and monitoring.
Bene ts
Localization: Reduced message travel time and reduced network load in global networks
Security: Secure deployment of AAE instances in DMZ enforcing network isolation for B2B scenarios
Considerations
BPM/ccBPM scenarios require central SAP Process Integration / SAP Process Orchestration runtime.
This is custom documentation. For more information, please visit the SAP Help Portal 15
12/17/2022
For SAP Process Orchestration, two Integrated Con guration Objects are required for scenarios spanning both Adapter
Engines.
Distributed (Model 2)
Two or more integration servers (domains) within a single landscape tier communicating with relevant business systems. Use of
additional decentralized adapter engines per integration server is also possible and adds a further level of complexity. Due to
the more complex architecture, the second distributed domain model allows greater exibility, however at the expense of a
higher TCO. Such organizations are usually larger in size and require a high degree of abstraction in their landscape. Customer-
driven reasons include:
This is custom documentation. For more information, please visit the SAP Help Portal 16
12/17/2022
Prioritization of messages
Geography
In contrast to customer-driven reasons for this model, there are also some SAP-driven reasons such as isolation for upgrade
path independency or decoupling of business systems and portal UI bindings.
Bene ts
Separation of SAP Process Integration / SAP Process Orchestration systems due to different reasons, such as technical
aspects, business requirements, or geographical distribution
Considerations
The different integration architecture approaches of SAP Process Orchestration categorized in SAP Process Orchestration
Landscape can be used to meet different landscape requirements. The following table lists some assessment aspects of these
requirements:
Administration De nes how difficult the overall landscape is to operate and maintain with respect to downtime, planned
upgrades etc. The application of support packages, notes, and hot xes are included in this criterion.
This is custom documentation. For more information, please visit the SAP Help Portal 17
12/17/2022
Availability Relates to how available the SAP Process Integration system is for message processing. In distributed (model 1)
and distributed (model 2) domain models, availability is improved through the decentralized message
processing capability and technical abstraction.
Monitoring De nes the complexity and coverage of the monitoring solution in each deployment model. With SAP Process
Integration, IT professionals can con gure and monitor service-enabled applications across the landscape.
Using the integrated capabilities of SAP Solution Manager and SAP NetWeaver, IT administrators can monitor
the availability and performance of applications, processes, and services, as well as analyze the root cause of
problems, and undertake optimization measures.
Total Cost of De nes the costs of implementing, operating, and supporting a given IT solution. This includes areas such as
Ownership the technical infrastructure, software licensing, implementation costs, support costs, upgrade, and downtime
costs.
Internal Performance Covers the internal performance of the SAP application software, database, and operating system when
processing a message in SAP Process Integration. It assumes that other variables such as message packaging
and size of messages are constant, which is an indicate measurement for the relationship between each
architectural model.
Network Utilization Re ects the impact on or utilization of the physical communication network. It considers the geographical
location of business systems, integration servers, and adapter engines, as well as latency and reliability.
Common Business The ability to enforce common business processes across the SAP Process Integration landscape, including
Process Delivery design-time object reuse and redundancy avoidance.
Globalization & The ability to meet local and global requirements both technically and on a business level. For example, a
Localization distributed (model 2)-domain solution with local governance can add exibility and abstraction while a
centralized governance model might not meet local requirements.
Cloud Foundry
The Cloud Foundry environment allows you to create polyglot cloud applications. It contains the Cloud Foundry runtime for SAP
BTP, which is based on the open-source application platform managed by the Cloud Foundry Foundation.
The Cloud Foundry environment enables you to develop new business applications and business services, supporting multiple
runtimes, programming languages, libraries, and services. You can leverage a multitude of build packs, including community
innovations and self-developed build packs. For more information, see the official Cloud Foundry documentation .
Microsoft Azure
Alibaba
Google Cloud
Restriction
The availability on Google Cloud is planned for the future and is subject to change. For more information on new
features and future releases, access the Road Map Explorer and the What's New section of SAP Integration Suite.)
Account Provisioning
This is custom documentation. For more information, please visit the SAP Help Portal 18
12/17/2022
With the cloud-centric model on SAP Business Technology Platform, slightly different terminology is used – global accounts,
subaccounts, and regions. License costs are rolled up to the global account level which, based on the account type selected,
offers different entitlements. The entitlements can then be allocated as quota to subaccounts. The quota ensures efficient
allocation of services and resources across subaccounts.
Customers can deploy applications in different regions. Each region represents a geographical location (for example, Europe,
US East) in which applications, data, or services are hosted. Regions are provided either by SAP or by our Infrastructure-as-a-
Service (IaaS) partners Amazon Web Services (AWS), Microsoft Azure, Google Cloud, and Alibaba Cloud. The third-party region
providers operate the infrastructure layer of the regions, while SAP operates the platform layer and Cloud Foundry.
Separated subaccounts can be provisioned to cater for the different environment requirements at the time so customers could
have subaccounts for production, test, development environments etc. Subaccounts can also be provisioned on a temporary
basis (e.g., to support a xed-time-frame project) and deleted later, releasing any services and resources used. Since the
license costs reside at the global account level, you can have as many subaccounts as needed.
Subaccounts enable companies to have a dedicated dev subaccount per development project. After the development and test
phases, the app can be published in one single test subaccount and then one production subaccount. This is especially suited for
companies with a focus on continuous integration and continuous delivery, as it creates isolation and independency for the
different environments. For more details, see Account Model 5: Create a Staged Development Environment Per Functional Area
in the Best Practices for SAP BTP.
This is custom documentation. For more information, please visit the SAP Help Portal 19
12/17/2022
Since Cloud Integration is the main capability used during the migration of SAP Process Integration and SAP Process
Orchestration to SAP Integration Suite, it's described in the following chapters.
The tenant management node represents the web interface of Cloud Integration.
Discover: Discover standard content available on API Business Hub and copy this content to the tenant
workspace.
This is custom documentation. For more information, please visit the SAP Help Portal 20
12/17/2022
Design Content (Workspace): In the workspace you can:
Deploy artifacts (both standard and custom) to the runtime (worker) node(s).
Artifacts: integration ows, value-mappings, script collections, REST API, SOAP API, and custom
integration adapters. Other artifacts such as referenceable message mappings will become available
shortly, and others may be added in the future.
Monitor: In this view all monitoring and operation tasks can be executed, including:
Monitor Message Processing: Provides and overview of the processed messages, with the capability to
drill down into individual message processing instances to diagnose any issues
Manage Integration Content: Deploy integration artifacts and monitor their deployment status
Manage Security:
Access Policies
JDBC Material
User Roles
Connectivity Test: Testing Connectivity from Cloud Integration to other systems (SSH, TLS, FTP,
SMTP etc.)
During the deployment process, an integration artifact is compiled into an executable format and copied to each runtime
container. The worker nodes then process messages that are exchanged with external systems or other integration
ows.
Central Architecture
In a central landscape, many business systems are bound to a single integration server. Most customers use this landscape as a
starting point as it represents the smallest possible installation footprint and holds associated TCO bene ts compared to the
other models. For most organizations this model is ideal and caters for central governance and a high reuse of development
objects. Global requirements can be met in this architectural model by implementing appropriate security and role-based
policies for design time and runtime objects.
The central approach is also the perfect starting point for entering the cloud world, as all business systems connect to a single
SAP Integration Suite.
A distributed architectural model on SAP Process Orchestration is de ned by one integration server integrating with one or
more decentrally deployed adapter engines. Since the SAP Integration Suite doesn’t offer distributed runtime nodes
comparable to an Adapter Engine yet, this scenario can't be used. As an alternative, the distributed (model 2) domain model
can be used with the same restrictions and guidelines as the distributed model. With the planned release of the hybrid
deployment option, the distributed (model 1) architecture can also be resolved with a lightweight runtime in the customer
network. The following table describes some aspects of using distributed (model 1) architecture:
Localization Local processing of messages reduces network The business system can communicate with regional cloud
load while improving performance and reliability data centers. On ground localization will be available in the
future with the hybrid deployment option.
Business Continuity SAP Integration Suite updates (monthly) are done with zero
Downtime minimization
down time. There are up to 4 major upgrades planned on
Technical abstraction from upgrades & the SAP BTP per year (up to 4 hours). Depending on the
downtime datacenter location, the updates occur in different time
slots.
Assessment Summary
Advantages Disadvantages
Availability and failover possible (manually) Multi Hop Scenarios may be introduced
This is custom documentation. For more information, please visit the SAP Help Portal 22
12/17/2022
Separation of A2A and B2B integration scenarios for Automatic scaling depending on
security reasons. resource consumption
Prioritization of messages
Within the distributed (model 2) domain architecture, you can have different governance options.
Central: Similar to the central architecture, development is done in only one speci c tenant and then replicated to the
required tenants. No changes or new developments are allowed in the other tenants.
Local: Design-time objects are created and changed in any development system. Local teams are responsible for their
own development objects. This limits the reusage and avoidance of redundancy of objects due to local autonomy.
Mixed: Changes are made centrally and locally, but with strict control mechanisms to ensure some object reuse is
possible and redundancies are minimized. This needs to be de ned as an enterprise-wide practice by your organization.
An example of such a mechanism is enforcing naming conventions or scenario-speci c object separation. There could be
common or global packages and some speci c local packages.
This is custom documentation. For more information, please visit the SAP Help Portal 23
12/17/2022
Landscape Aspects
Get an overview of the main aspects of landscape, which are governance, business system communication strategy, software
logistics and synchronization, and security utilization.
Governance
Governance can be de ned by the policies, processes, and procedures that support any IT landscape. In the context of SAP
Integration Suite and this guide, governance is de ned relative to change management of design time objects in the SAP
Integration Suite. Who can change what and where are of relevance in this criterion.
In a distributed (model 2) domain model, a decision needs to be made where changes are allowed, for example if changes are
done in one central SAP Integration Suite only or regionally and then replicated with appropriate controls. A central governance
model is highly recommended as a starting point in distributed (model 2) domain scenarios. When this can't be achieved, a
mixed mode can be adhered to as described in the following:
Central
Design-time objects are created and changed in one development system only and then replicated consistently
throughout the landscape as required. No changes are to be made or new objects to be created in other regional
domains.
This is the recommended approach in distributed (model 2) domain scenarios when it can be applied practically. It
may require strict policy enforcement and a higher level of collaboration but the bene ts of object reuse and one
model for everyone are signi cant.
The implementation of access policies and user roles for design-time object creation and authoring is
recommended.
Governance in a central deployment model is simpli ed as there's only one development environment for objects to be
created or changed and hence central governance strategy is enforced.
This is custom documentation. For more information, please visit the SAP Help Portal 24
12/17/2022
While a distributed (model 2) domain scenario may give you greater exibility, the central model is recommended
to guarantee high object reuse and consistency.
The use of developing guidelines (naming conventions, roles, and authorizations) can support global
requirements and cater to the needs of regional divisions or businesses. De ning these constraints before an
implementation is imperative for success and possible future growth.
Regional
Design-time objects are created and changed in any development system. Regional SAP Integration Suite instances are
responsible for their own development objects and are not replicated. The ability to reuse objects and avoid
redundancies is minimized due to local autonomy and resulting loss of control.
At the very least, you should implement naming conventions per region or division so that controlled convergence
is still possible in case of consolidation at a later stage.
This mode guarantees isolation of each instance, which may be a business requirement allowing complete
autonomy and agility when onboarding or decommissioning segments.
Mixed
Changes are to be made centrally and locally however with strict control mechanisms to ensure some object reuse is
possible and redundancies are minimized. An example of such a mechanism is enforcing naming conventions or scenario-
speci c object separation, like transactional relevant objects x master data.
Demarcation of object ownership is recommended. A global SAP Integration Suite instance may be responsible
for master data, and local regions handle the transactional scenarios. Or possibly all SAP-centric content is
managed globally and local divisions or regions manage legacy system objects and scenarios.
The aim of this mode is to achieve some level of reuse and convention such that redundancies are avoided. This
demarcation is speci c to each organization.
Hub-to-Hub Model
This approach normalizes communications between regions or divisions such that each business system belongs to a speci c
SAP Integration Suite. Any messages or scenarios requiring integration to a given business system must be processed via its
nominated integration server. This allows consistent communication paths but requires additional con guration due to the
additional hops from integration server to integration server. Consideration must be given to performance implications and
possible demarcation options based on protocol.
This is custom documentation. For more information, please visit the SAP Help Portal 25
12/17/2022
Hub-to-Business-System Model
This approach allows each SAP Integration Suite to directly communicate with each business system, which increases the
complexity of integration scenarios. Managing such an approach requires a higher level of governance and may be restricted to
certain protocols. For simplicity, this diagram only illustrates one integration server communicating with each business system
In a central deployment model, the transport and synchronization of objects are optimized due to a single production instance.
As a result, no synchronization is required.
Distributed (model 1)
In a distributed (model 1) deployment model, the transport and synchronization of objects are optimized due to a single
production instance. As a result, no synchronization is required.
Distributed (model 2)
In a distributed (model 2) domain deployment model, the transport and synchronization of objects are complex and require
careful consideration per integration scenario. It all depends on whether integration scenarios are local or global in nature.
If the integration scenarios are local and don’t require multihop to each integration server, the development objects are
discrete in scope.
If your integration scenarios cross domains and require multihop integration with other integration servers, an increased
amount of synchronization is required when promoting scenarios within your landscape.
Generally, the level of distributed (model 2) domains and combination of governance models determines how complex your
synchronization effort will be. Keep in mind that models are determined by organisation-speci c architectural practices.
Security Utilization
Although this has been covered to an extent within the governance section, it’s important to reiterate the application of
security in the context of SAP Integration Suite and distributed architectures. It’s common for organizations to specify they
need distributed (model 2) domains due to security reasons. SAP Integration Suite offers a feature to con gure the access to
design-time and runtime artifacts, which allows very strict control. In a global example, you can allow developers in the Europe
to only access and change objects they are assigned to, and the same applies to developers in APJ. The recommendation is to
thoroughly investigate the application of security as a means to enable central governance and simplify your architecture with a
central approach
System Description
Direction
Polling/Pushing
This information can be picked up from the SAP Process Orchestration System Landscape Directory through analysis of the
Integration Directory (ID). With regards to the landscape, the migration to support Cloud systems should always be given
except if the connected system has some speci c requirements. For ground (on-premise) systems, additional checks are
required as discussed in the following chapters.
This is custom documentation. For more information, please visit the SAP Help Portal 27
12/17/2022
Cloud Middleware
Learn more about possible communications between Cloud Integration and an on-premise system.
Restriction
Some features mentioned on this site are planned for the future and are subject to change. For more information on new
features and future releases, access the Road Map Explorer and the What's New section of SAP Integration Suite.
A migration from SAP Process Orchestration to SAP Integration Suite means moving to the cloud, which requires that all on-
premise systems must be able to communicate with the Internet. With the planned release of the on-premise runtime of SAP
Integration Suite (hybrid deployment option), this may no longer be applicable. In that case, it means developing and operating
in the cloud, and executing on-premise. Since the hybrid deployment option isn't available yet, we'll focus on the cloud-only
version. The guide will be updated when the hybrid deployment option is available.
The on-premise system must be able to establish an HTTPS connection to Cloud Integration (SSL Handshake,
Authorization, and Authentication).
If any proxies or rewall changes are required, this should be considered and recorded as an infrastructure change
requirement.
Since Cloud Integration is a cloud solution, security is a key aspect and therefore SSL protocol is a must.
The on-premise system must be able to receive a message from the Internet, using one of several options:
Cloud Connector
There might also be some challenges regarding security that have to be evaluated for on-premise systems and are described in
Security.
This is custom documentation. For more information, please visit the SAP Help Portal 28
12/17/2022
Restriction
This feature is planned for the future and is subject to change. For more information on new features and future releases,
access the Road Map Explorer and the What's New section of SAP Integration Suite.
SAP is working on providing a lightweight runtime allowing you to have an on-premise runtime, which can be used for all SAP
Integration Suite scenarios (e.g. on-premise to on-premise integration processes).
The runtime can hold any SAP Integration Suite services or engines
The software lifecycle of the hybrid deployment option shall be in sync with the cloud delivery speed
This is custom documentation. For more information, please visit the SAP Help Portal 29
12/17/2022
Identity Provider
Learn more about identity providers and user governance in SAP BTP.
The users of SAP BTP are provided by identity providers. You can either use the default SAP identity provider (SAP ID service)
with your email ID or con gure your own corporate identity provider (e.g. SAP Cloud Identity Services - Identity and
Authentication service or Azure Active Directory). If you use an external identity provider, you must con gure a trust
relationship between SAP BTP and the identity provider.
For more information on how to connect with different Active Directory services, see the tutorial Integrate Microsoft Azure AD
with SAP BTP, Cloud Foundry environment and the blog How to integrate Azure AD with SAP BTP, Cloud Foundry environment
.
Additionally, you can enable single sign-on using the Identity Authentication service and an external Active Directory as
described in the following tutorials:
Note
Once the custom IDP con guration is complete, it's necessary to grant permissions to users for SAP BTP applications
through the SAP BTP cockpit before they try to access them. See Con guring User Access to the Application.
This is custom documentation. For more information, please visit the SAP Help Portal 30
12/17/2022
You can nd the different personas for administering the roles in Persona in the Cloud Integration documentation and in SAP
Note 2872526 on roles in API Management.
User Governance
The global account and subaccounts get their users from identity providers. Administrators make sure that users can only
access their dedicated subaccount by making sure that there's a dedicated trust relationship only between the identity
providers and the respective subaccounts. Developers con gure and deploy application-based security artifacts containing
authorizations, and administrators assign these authorizations using the SAP BTP cockpit.
The SAP Integration Suite is a bundle of services running on SAP BTP. The authorization groups, roles, and their assignments of
the SAP Integration Suite are managed through the SAP BTP cockpit and can be managed via web browser. There's also the
option to perform Authorization Management using SAP BTP APIs.
Using SAP BTP Authorization Management REST APIs provides functionality to manage roles and their assignments to users.
It’s not limited to SAP Integration Suite and can be extended to other subscriptions and services under SAP BTP subaccounts.
These APIs can be used in cases where user assignment needs to happen in a controlled manner to enforce security policies,
audit, and compliance from SAP GRC or other user management and governance solutions.
Groups – Manage groups and their assignments to users and roles within the speci ed account.
Roles – Manage roles and their assignments to users and groups in the speci ed account and application.
Connectivity
Get an overview of the important aspects regarding the connectivity migration, for example, where it’s necessary to identify the
systems in use, their protocols, if custom adapters are used, and more.
Steps in a Migration
Follows these several structured steps to migrate your communication channels from an SAP Process Orchestration
format to a Cloud Integration format.
Connected Systems and Protocols
When analyzing your SAP Process Orchestration system, extracting as many details as possible with regards to what
systems it connects to and which transport and messaging protocols it uses is the rst step.
Standard Adapter Migration
SAP Process Orchestration provides many adapter types as standard. Depending on the adapter type, an equivalent
may be available in Cloud Integration, or an alternative may need to be used.
Custom Adapter Migration
If you, or your implementation partner, have implemented fully bespoke adapters for SAP Process Orchestration, you
may need to have these reimplemented using the Adapter Development Kit (ADK) provided for Cloud Integration.
Adapter Modules
Learn about the differences between adapter modules in SAP Process Orchestration and in Cloud Integration, and how
you can redesign the adapter modules.
Linking Communication Channels to Interfaces
In Cloud Integration, there’s no separation between the communication channels and the other artifacts (such as
Message Mapping Schema de nitions) that make up an interface. It’s therefore key to understand which communication
channels are used by which interfaces as the same channel can be used by more than one interface.
Migration of Value Mappings
This is custom documentation. For more information, please visit the SAP Help Portal 31
12/17/2022
Learn how you can import value mappings from SAP Process Orchestration to Cloud Integration.
Connecting to On-Premise Systems Using Cloud Connector
Find out how Cloud Connector can help you to connect cloud-based services and on-premise systems.
Steps in a Migration
Follows these several structured steps to migrate your communication channels from an SAP Process Orchestration format to
a Cloud Integration format.
In SAP Process Orchestration, adapter con gurations are maintained in communication channel objects. Each communication
channel de nes which transport protocol to use, speci ed as an adapter type, and several con guration parameters that de ne,
for example, hostname, port, user, and password to the remote system.
Each communication channel in use in a particular SAP Process Orchestration system needs to be analyzed in order to map it to
a corresponding communication channel de nition in Cloud Integration.
Details on this topic are discussed in the sections Connected Systems and Protocols and Standard Adapter Migration.
Adapter direction (sender or receiver) – some adapter types are only available in one direction in Cloud Integration (for
example the RFC adapter)
Quality of Service (QoS) requirements – Is Exactly Once in Order (EOIO) required, or Exactly Once (EO)
Protocol – For example, if it’s an HTTP, non-HTTP or File-based service, this can help while choosing a migration strategy
for a similar adapter supported in .
This is custom documentation. For more information, please visit the SAP Help Portal 32
12/17/2022
Details on this topic are discussed in the section Standard Adapter Migration.
Alternatively, you can search for an OEM adapter equivalent, or use the SAP Open Connectors service to connect to non-SAP
solutions.
Details on this topic are discussed in the section Custom Adapter Migration.
Cloud doesn't support this concept, but instead supports the concept of introducing additional conversion steps into any
integration ow to support any additional manipulation required before full processing, or transmission to the target system.
This is arguably a much more transparent and exible approach, but it also means that a conversion process needs to take
place. Another option is to create a custom adapter providing the same features as the standard adapter and extend it with the
additional functionality.
This information about connected systems and protocols can then be further analyzed to identify any issues or challenges
ahead, and to allow for an estimation of the effort required to migrate to a Cloud Integration tenant solution.
Restriction
Some features mentioned on this site are planned for the future and are subject to change. For more information on new
features and future releases, access the Road Map Explorer and the What's New section of SAP Integration Suite.
1. Utilize the standard Web Services that are available as part of the Integration Directory API. For details on this method,
see the blog SAP PI/PO Directory API: Extract detailed Communication Channel con gurations into an Excel sheet
without custom codes/macros .
This is custom documentation. For more information, please visit the SAP Help Portal 33
12/17/2022
2. Utilize the upcoming SAP PI/PO Assessment Tool: Data Extraction Utility. This tool provides the capability to extract not
only the communication channel data, but also details regarding each integrated con guration object, as well as the
design time artifacts such as operation mappings and message mappings. It uses a Java Swing-based UI to provide a
more user-friendly approach to extracting the data. Connectivity to your SAP Process Orchestration system is de ned
using the Settings dialog.
For detailed documentation of the adapters in Cloud Integration, see Con gure Adapter in Communication Channels.
Restriction
Some adapters mentioned on this site are planned for the future and are subject to change. For more information on new
features and future releases, access the Road Map Explorer and the What's New section of SAP Integration Suite.
File Available through FTP or SFTP adapter Alternative – Possible use of FTP or SFTP
adapters.
HTTP_AAE HTTP
JDBC Planned for future Alternative – Use timer event along with
JDBC receiver adapter to achieve the same
JDBC polling mechanism.
Mail Mail
Marketplace Available through HTTP adapter Alternative – Possible use of the HTTP
adapter with implementation of XSLT to
convert from MML and XML or JSON.
This is custom documentation. For more information, please visit the SAP Help Portal 34
12/17/2022
OFTP (Odette FTP) Available through external application Alternative – Possible use of an external
application to make a bridge between HTTP
requests and OFTP.
SFSF SuccessFactors
SOAP SOAP
File Available through FTP or SFTP adapter Alternative – Possible use of FTP or SFTP
adapters.
HTTP_AAE HTTP
This is custom documentation. For more information, please visit the SAP Help Portal 35
12/17/2022
Mail Mail
Marketplace Available through HTTP adapter Alternative – Possible use of the HTTP
adapter with implementation of XSLT to
convert from MML and XML or JSON.
RFC RFC
SFSF SuccessFactors
SOAP SOAP
It may be of value to assess the marketplace to determine whether an OEM partner has already implemented an adapter that
provides the connectivity you require. Some of the adapters provided by SAP partners are fully SAP-certi ed and fully
supported for several non-SAP systems. There are many adapters like Salesforce, ServiceNow, Workday, etc. available out-of-
the-box in SAP Integration Suite. For a full list of available adapters, see Con gure Adapter in Communication Channels.
You can search on API Business Hub and the internet for different OEM partners and their adapters.
If an OEM adapter isn't available, an additional alternative is to use the SAP Open Connectors service, which is one of the key
complimentary components of the SAP Integration Suite. Open Connectors provides out-of-the-box connectivity to more than
170 non-SAP applications or services. It provides harmonized RESTful APIs with built-in interactive API documentation using
OpenAPI Speci cation and normalized authentication, which provides built in security capabilities for secure robust connectivity
to third-party applications. It also drastically reduces the time needed to connect to top non-SAP SaaS applications.
Once a connection instance to a particular non-SAP system has been con gured, the built-in Open Connectors adapter in Cloud
Integration can seamlessly connect to it using con gurable authentication credentials to perform the usual CRUD (Create,
Read, Update, Delete) operations.
This is custom documentation. For more information, please visit the SAP Help Portal 36
12/17/2022
The following blogs provide details on the topic:
Google Calendar’s Info with API Management and Open Connectors Services
If neither of these options provides a solution, the nal option is the reimplementation of your custom adapter using the ADK.
As both Process Orchestration and Cloud Integration are based on Java, and the adapters are, too, a signi cant proportion of
coding can be ported easily.
The ADK is available for download from SAP Development Tools - Cloud Integration. The deployment of adapters can be done via
the Web UI of Cloud Integration.
The blog Cloud Integration Adapter development using Maven Project perspective walks you through the process of adapter
development by illustrating the creation of a simple sample adapter. Additionally, the blog Cloud Integration - Developing
Custom Adapters to access On-Premise systems illustrates the creation of a custom adapter that is able to communicate
with on-premise systems via Cloud Connector.
Adapter Modules
Learn about the differences between adapter modules in SAP Process Orchestration and in Cloud Integration, and how you can
redesign the adapter modules.
In SAP Process Orchestration, you can add a standard or custom adapter module while you're de ning the properties of your
communication channel. This allows you to perform different transformations like zip and encrypt the message, or change and
remove the namespace in the XML. Although the same concept doesn't apply to adapter modules in Cloud Integration, you can
transform the message using the standard integration ow steps or creating a JavaScript or Groovy script. The following table
displays some strategies that can be used to redesign these adapter modules:
AF_Modules/PayloadSwapBean You use this module to replace the This module is normally used while sending
application payload of the XI message that a single attachment as the application
contains the business data with another payload with Mail adapter.
payload that is appended to the XI message
as an additional attachment. Cloud Integration offers multiple options to
handle this:
This is custom documentation. For more information, please visit the SAP Help Portal 37
12/17/2022
AF_Modules/StrictXml2PlainBean You use this module to convert an XML In Cloud Integration, you have different
document that is in the main payload of the ways to convert your XML document to text
XI message to text format. format. The most common way is to use the
conversion steps available (e.g., XML to
CSV, XML to EDI, XML to JSON). You can
also use Groovy script to convert the XML
message as you want in a step before the
adapter call.
AF_Modules/XMLAnonymizerBean You use this module to anonymize XML In Cloud Integration, you can use an XSLT in
elements and attributes by removing the step before the adapter call to
namespaces or namespace pre xes from change/remove the namespaces or
the XML document of the main payload. pre xes.
SAP_XI_IDOC/IDOCXmlToFlatConvertor You can use this module to convert IDoc In Cloud Integration, you can use the
XML to IDoc Flat format. If you add this standard XML to CSV converter to achieve
module to the module chain, then it it.
converts the data in the XI message
payload from IDoc XML to IDoc Flat format.
For example, you can add this module to the
module chain of a receiver le adapter and
create an IDoc Flat le.
SAP_XI_IDOC/IDOCFlatToXmlConvertor You can use this module to convert the data In Cloud Integration, you can use an external
in the XI message payload from IDoc Flat library or develop a custom
format to XML format. For example, you can Groovy/Javascript script to perform this
add this module in the module chain of a conversion.
sender le adapter and create IDoc XML
from IDoc Flat format.
AF_Modules/PayloadZipBean You use this module to compress one or In Cloud Integration, you can use the
more payloads or extract payloads from a standard Encoder and Decoder steps to
compressed le. compress or extract payloads in ZIP, GZIP,
Base64, or MIME.
AF_Modules/DynamicCon gurationBean You use this module to edit the message In Cloud Integration, you don’t have the
header for adapter-speci c message same concept of adapter-speci c
attributes. You can add attributes to the attributes but you can use external
header or delete attributes from the header. parameters or runtime parameters (e.g.,
${property.queryOptions}) while de ning
dynamic attributes in your adapter.
You can nd more information of these standard adapter modules in the help documentation on Adding Modules to the Module
Processor.
This is custom documentation. For more information, please visit the SAP Help Portal 38
12/17/2022
To achieve this understanding, a list of Integrated Con guration objects needs to be extracted and analyzed to provide the
linkage between the Integrated Con guration objects and the communication channels the interface uses.
Several techniques can be employed to extract this information, for example the one described in the following:
Like the communication channel extraction, utilize the standard Web services that are available as part of the Integration
Directory API. The blog SAP PI/PO Directory API: Extract detailed Communication Channel con gurations into an Excel sheet
without custom codes/macros provides details on how to extract the information for the communication channels. A similar
approach can be employed, but in this case using an alternative Web service. Go to SAP NetWeaver Administrator
Con guration Connectivity Single Service Administration , and in Service De nitions, search for
IntegratedCon guration750In instead of CommunicationChannelIn:
Some of the columns that can be found in the extraction after converting to MS Excel are:
With that, you can apply pivot tables and formulas to improve the visualization of key data.
In SAP Process Orchestration, the value mapping standard function is de ned in ESR and is used to map different
representations of an object to each other. At the same time, it's needed to de ne a value mapping group (value-mapping
tables) in Integration Directory. The image below shows the representation of the value mapping de ned in SAP Process
Orchestration.
This is custom documentation. For more information, please visit the SAP Help Portal 39
12/17/2022
This function can be used in different message mappings with the same key eld, but the same value mapping group need to be
referenced. Additionally, you can choose to use a rather static option called xValues, which is a key-value list in which you can
directly insert the value mapping in the message mapping while designing your interface in ESR. The xValue mappings are
automatically imported when importing the Message Mapping or Operation Mapping from SAP Process Orchestration.
For more information, see Designing and Con guring Value Mappings.
In Cloud Integration, the value mapping con guration is similar. It’s possible to import a CSV le containing the values. After the
CSV le importation and deployment, on the message mapping, you need to add the value mapping function and ll in the
identi er and agency. For more information, see Creating Value Mapping.
It's possible to export a CSV le from SAP Process Orchestration and import it in Cloud Integration in a value mapping. If the
value mapping already exists in Cloud Integration, the process only works if you import a CSV in an existing value mapping, too.
The values are merged with existing Agency and Identi er entries.
Another way to import value mappings from SAP Process Orchestration to Cloud Integration using the SOAP API (Directory
APIs) from of SAP Process Orchestration. This API exports the value mappings as a XML le. After this step, the XML le must
be converted to CSV format and follow the process described in the previous paragraph.
While businesses across the globe are rapidly adopting a cloud-centric approach to their IT landscapes, many will inevitably end
up with a hybrid environment whereby some software systems reside on-premise and others have moved to the cloud as
subscription-based services. Due to the requirements imposed by the diverse nature of many business processes and their
need to interact with multiple software systems in a fully connected manner, integration between the cloud-based services and
the on-premise systems is an inevitable necessity.
SAP Cloud Connector was implemented as a solution to bridge the gap between on-premise and the cloud. The SAP Cloud
Connector is an on-premise piece of software that needs to be installed inside your landscape. Once con gured and paired with
your SAP BTP account, a secure tunnel is established between SAP BTP (and all the services and applications that run on it)
and the Cloud Connector. This way, all communication between SAP BTP and the backend system gets routed via the Cloud
Connector over the secure SSL tunnel. As a result, the access control now only needs to be con gured in the Cloud Connector.
Despite having a light footprint, SAP Cloud Connector is a secure, richly featured application that provides full logging, auditing,
and traceability features together with the capability to be installed as a cluster to ensure high availability.
This is custom documentation. For more information, please visit the SAP Help Portal 40
12/17/2022
For more information about how to install Cloud Connector, see SAP BTP Connectivity.
HTTP
RFC (currently Cloud Integration only provides an RFC receiver adapter, so no RFC calls from an on-premise application
to Cloud Integration are possible)
LDAP
Caution
TCP-based connections can pose a security risk by permitting unmonitored traffic, so ensure only trustworthy applications
have access. Because it uses plain TCP, the Cloud Connector can't see or log any detail information about the calls.
Therefore, in contrast to HTTP or RFC (both running on top of TCP), the Cloud Connector can't check the validity of a
request.
This is custom documentation. For more information, please visit the SAP Help Portal 41
12/17/2022
To minimize this risk, make sure you
con gure an application allow list in the Cloud Connector, as described in Set Up Trust for Principal Propagation, and
take the recommended security measures for your SAP BTP (sub)account, as described in section Security in the
SAP BTP documentation.
For more information on con guration, operation, and security, see the Cloud Connector help documentation.
Access Control
The Cloud Connector offers the feature to allow only speci c services and paths to be exposed to SAP BTP. This can be speci ed
with the Access Control. For help documentation on setting up access for each protocol type, see the following:
The key con guration settings are illustrated in the following graphic using an SFTP adapter as an example:
This is custom documentation. For more information, please visit the SAP Help Portal 42
12/17/2022
The rst key change is to set the Proxy Type to On-Premise (rather than Internet), at which point the Location ID eld becomes
visible. If you have multiple Cloud Connector instances connected to a single SAP BTP tenant subaccount, you need to specify a
unique location ID when setting up the connections. In this situation, you must specify the location ID of the correct Cloud
Connector you wish to connect to as part of the channel con guration. If you only have a single Cloud Connector instance with
no location ID, this can be left blank.
The second key information is the Address (the URL of the target server) and must correspond to the URL speci ed in the
destination de nition.
Security
Discover the important aspects regarding security that must be evaluated before migrating from SAP Process Orchestration to
Cloud Integration.
Using a cloud-based integration platform imposes dedicated security requirements on the software vendor (SAP) that hosts
the platform, as well as on the customers who use the platform. Customers who use Cloud Integration agree that a signi cant
part of their (and their customers’) sensitive data is processed by and stored within an infrastructure not owned by themselves.
The core task of an integration platform is to serve as the transit place for messages that can contain sensitive customer data.
First and foremost, these messages must be protected against eavesdropping and unauthorized access.
Therefore, the integration platform must ful ll the following main requirements:
The integration infrastructure is already designed and built in such a way that it meets the highest security standards.
For more information on compliance, visit the SAP Trust Center .
It must be guaranteed that the technical system landscape, the communication between the components of the
integration platform, and the storage locations of messages are secure.
The processes related to the usage of Cloud Integration meet the highest security standards.
These processes include processes at SAP related to the development and upgrade of the Cloud Integration software,
the processes related to the provisioning and operation of the customers' virtual environment by the infrastructure
provider, and the customer onboarding process during which customers set up secure connections between their
infrastructure and SAP's integration platform.
Customers have several options to con gure how messages are exchanged within an integration scenario so that the
involved data is protected at the highest level.
When designing integration ows, customers can choose between several options to protect messages by establishing
secure communication channels (transport-level security) and by con guring digital encryption and digital signing of
messages (message-level security).
For full help information on the security capabilities of Cloud Integration in the Cloud Foundry environment, see Security, Cloud
Foundry Environment.
For access to the recommended Learning Journey to learn all about security from an SAP BTP perspective, go to Security with
SAP BTP.
This is custom documentation. For more information, please visit the SAP Help Portal 43
12/17/2022
the next stage (authorization check) takes place to determine what access to features and functions the user has for a
particular application.
Cloud applications hosted on the SAP BTP typically use role-based access control. This means that authorizations to access
speci c applications (such as Cloud Integration) and execute speci c tasks (for example, Create and Edit Artifacts, Deploy
Security Material, Monitor Integration Flows) are provided to each user through the assignment of roles and role collections.
The provision of roles and role collections to users is a task typically performed by a Tenant Administrator using the security
tools provided on the SAP BTP Cockpit. For detailed information on how to con gure user access to the Cloud Integration
application by assignment of roles and role collections, see Con guring User Access to the Application.
The help documentation on Tasks and Permissions provides a detailed table of the roles and roles collections available as
standard to control access to each speci c task and feature within Cloud Integration. The table provides the corresponding
information for both the Cloud Foundry and the Neo environment.
Security Material
Keystore Entries
Access Policies
JDBC Material
User Roles
Before using such security material to start transmitting or receiving messages, it can be useful to test their validity, for
example by executing a connectivity test.
Authentication Description
Client certi cate authentication Using this option, authentication of a sender is performed based on a client certi cate.
At runtime, the system checks if a service key that contains the client certi cate
provided by the sender is available. If a service key is available, the system checks if
the associated service instance has a role speci ed that grants permissions to call the
integration ow endpoint.
An SAP BTP tenant administrator can generate the service key used for certi cate-
based authentication.
This process is also describes in the blog How to Set Up Secure HTTP Inbound
Connection with Client Certi cates .
This is custom documentation. For more information, please visit the SAP Help Portal 44
12/17/2022
Authentication Description
OAuth with client credentials grant The sender is authenticated based on an OAuth access token. The access token is
retrieved in a preceding call from an authorization server.
An SAP BTP tenant administrator can generate the service key used for OAuth with
client credentials grant.
Basic Authentication for a user with client The sender is authenticated based on user credentials that are generated together
credentials from the service key with a service key.
The steps to create service instance and service key are the same as for the option
“OAuth with client credentials grant”. However, during runtime no access token is
retrieved. Instead, the values of clientid and clientsecret from the service key are used
for authentication.
Basic authentication for user registered with an The sender is authenticated based on user credentials associated with a user
identity provider registered at an identity provider (IDP).
User Credentials Used for Basic Authentication (with Username / Password combination)
OAuth2 Client Credentials Many Web servers nowadays use OAuth credentials for authorization purposes. Cloud Integration
provides the capability to store and use such credentials to allow the system to connect at runtime.
OAuth2 SAML Bearer Assertion Used for accessing OAuth protected resources by propagating the user identity
For more information, see the blog OAuth2 SAML Bearer/X.509 Certi cate Authentication Support in
SuccessFactors Connector .
OAuth2 Authorization Code This is another form of use of OAuth2: if you use an OAuth2 authorization code, the authentication is
performed via a separate authorization server as an intermediary step. The client can exchange the
OAuth2 authorization code for an access token that is granted by the authorisation server and
typically has a restricted Time-To-Live (TTL). This way the actual user credentials are never shared
with the client, and the owner of the user credentials can revoke the authorisation code at any time.
Secure Parameters Used to deploy con dential data, for example, key information such as passwords that may be
required for custom adapters.
Known Hosts (SSH) The known hosts le contains the public keys for all hosts with which the Cloud Integration tenant
intends to communicate by using the Secure Shell (SSH) protocol.
This is custom documentation. For more information, please visit the SAP Help Portal 45
12/17/2022
PGP Public Keyring This artifact contains one or more public keys that enable the Cloud Integration tenant to encrypt or
verify messages using the Pretty Good Privacy (PGP) encryption standard as part of support for
Message Layer Security (MLS).
PGP Secret Keyring This artifact contains one or more public and private key pairs for the usage of Open Pretty Good
Privacy (PGP). The private key enables the Cloud Integration tenant to decrypt or sign messages as
part of Message Layer Security (MLS).
For details on how to create a key pair, see Creating a Key Pair.
For more information about importing and exporting PGP secret keys, see the blog Import and
Export PGP Secret Key - Change PGP Secret Key Password .
The methods to access, import, and export each certi cate differ between the systems and the administrative tools. This
section provides details on how to migrate certi cates in SAP Process Orchestration and Cloud Integration.
In SAP Process Orchestration, you can access the keystores by going to SAP NetWeaver Administrator Con guration
Security Certi cates and Keys .
On this page, you can manage the application server Java certi cates and keys. For instance, you access the server credentials
of multiple virtual keystores called keystore views. The keys and certi cates in the keystore views can be used for encryption,
identi cation, and veri cation purposes when using AS Java functions.
Assuming that the certi cate is in TrustedCAs, click on that to check the entries associated.
In the details of TrustedCAs, select the certi cate and select Export Entry. Save the key/certi cate on your local le system.
This is custom documentation. For more information, please visit the SAP Help Portal 46
12/17/2022
By default, SAP NetWeaver Java comes with some keystore views serving different purposes:
UMEKeystore (contains key-pair used by the UME provider service of the AS Java)
ICM_SSL_<instance _ID> (contains the SSL key pair and trusted server certi cates for client authentication over SSL)
For more information about how to import a certi cate into the keystore view, see Uploading Certi cates to SAP Process
Integration and SAP Note 2056672 .
The Keystore Monitor in Cloud Integration allows a tenant administrator to manage the tenant keystore and its entries (i.e.,
X.509 certi cates and key pairs).
Connections between a Cloud Integration tenant and a remote system can be secured in different ways, such as basic
authentication, client authentication, or OAuth2. Using client authentication, you must maintain these certi cates in the
keystore.
In Cloud Integration, you can access the Keystore tile in the Manage Security section.
A keystore typically contains entries that belong to the tenant administrator (customer) and entries that are owned by SAP.
Each entry is uniquely identi ed by an alias.
The operations you can perform on a keystore entry depend on whether it's owned by SAP or the tenant administrator. As the
tenant administrator, you can, for example, delete or backup entries that are owned by the tenant administrator. SAP can't
access or download any keystore entries owned by the tenant administrator.
In Cloud Integration, there’s the concept of security material, which is stored in the tenant and enables the reuse of some
parameters such as authentication parameters (for Basic authentication), PGP private and public keys (to support encryption
and decryption for Message Layer Security), and OAuth2 credentials.
Currently, access policies can be used to control access to the following integration artifacts and integration content on a Cloud
Integration tenant:
Integration ows
Global datastores
Global variables
A single access policy can be used to control access to multiple types of objects. The actual names of the objects can be
speci ed by using a speci c name, or a regular expression (e.g., HR, Finance) can be used to protect multiple objects.
In Cloud Integration, the access policies restrict the access to selected integration artifacts and associated data, provide
controlled access, and safeguard the operations from unauthorized users. Thus, access policies are associated with a role and
contain references to integration artifacts. It’s possible to group some integration ows and provide protection to the business
data processed.
The access policies are de ned in the design and runtime of integration artifacts and include the protection of integration ows
and artifacts, REST and SOAP APIs, and so on.
With the access policies, the following actions are restricted: edit, copy, download, delete, con gure, mass delete and download,
and simulation of integration ow.
For more information, see Managing Access Policies, Cloud Foundry Environment, as well as the blogs Access policy for securing
design artifacts and Access Policies: De ning Roles on Artifact Level .
JDBC Data Sources: Allow you to create and manage a cluster of artifact connections to interact with a database (DB).
Each data source contains information on database type, as well as database-speci c con guration parameters.
This is custom documentation. For more information, please visit the SAP Help Portal 48
12/17/2022
For more information, see Managing JDBC Data Sources.
JDBC Drivers: Typically the tenant administrator con gures JDBC drivers on your Cloud Integration tenant to enable you
to establish connections to a database managed by a third-party vendor. Your database vendor should provide the driver
or the access to download it from their official website.
In order to access user roles, in the Monitor view, click the User Roles tile in the Manage Security section. User roles de ned by
SAP and by the tenant administrator are displayed.
In this app, roles can be added, changed (only the description), or deleted. The actual assignment to users in the system must,
however, still be performed by an administrator that has the authorization to modify roles, role collections, and role assignment
in the SAP BTP Cockpit. This process is described in the section Securing User Access to Cloud Integration.
On the Operations page of the Cloud Integration tenant, the Manage Security area provides an overview of security-related
artifacts. You open the Connectivity Tests area by clicking the tile titled Connectivity Tests.
TLS Checks HTTPS connectivity and allows you to verify that certi cates are valid and trusted.
SSH Allows you to verify access to an SFTP server and verify that the credentials used are accepted by
the server. You also have the option to verify access to speci c directories on the server. Supported
credential types:
User credentials
Public key
FTP Allows veri cation of access to an FTP server (on the Internet or on-premise) and also veri es that
the user credentials are accepted (if authentication is required).
SMTP Allows veri cation of SMTP connectivity to a mail server. Supported credential types are:
Encrypted username/password
Plain username/password
This is custom documentation. For more information, please visit the SAP Help Portal 49
12/17/2022
IMAP Allows veri cation of connectivity to an IMAP mail server. Supported credential types are:
Encrypted username/password
Plain username/password
POP3 Allows veri cation of connectivity to a POP3 mail server. Supported credential types are:
Encrypted username/password
Plain username/password
AMQP Allows veri cation of connectivity to an AMQP server via either TCP or WebSocket transport protocol.
Both Internet-based and on-premise (via Cloud Connector) connectivity is supported. Connectivity is
via TLS and the test can also validate Server Certi cates.
Kafka Allows veri cation of connectivity to a Kafka broker using either SASL or Client Certi cates over TLS.
Cloud Connector Validates that connectivity to a particular Cloud Connector instance is working. If multiple Cloud
Connector instances are connected to the same SAP BTP tenant, the Location ID can be used to
uniquely identify the correct target. See later section for details on Cloud Connector.
The security material deployed and managed in a Cloud Integration tenant is accessed at runtime by integration ows and APIs
to implement two forms of security:
Transport-Level Security (TLS), which involves the encryption of traffic communication between two systems across a
network.
Message-Level Security (MLS), which involves the encryption of actual message payload being transmitted, and they
remain encrypted until the payload is explicitly decrypted using a valid key.
Cloud Integration uses the security material discussed in Managing Security Material in Cloud Integration to implement TLS
and MLS.
Transport-Level Security
Transport-level security provides communication security and protection of data integrity and privacy between two
communicating applications. It's used for web browsers and other applications that require data to be securely exchanged on a
network.
Security Description
Elements
This is custom documentation. For more information, please visit the SAP Help Portal 50
12/17/2022
Security Description
Elements
Certi cate- The authentication of a sender is done based on a client certi cate. The system checks if a service key is available that
based contains the client certi cate (provided by the sender). Afterwards, the system checks if the associated service
authentication instance has a role speci ed which has permissions to call the integration ow endpoint.
For more information, see the blog How to Set Up Secure HTTP Inbound Connection with Client Certi cates .
Securely For more information, see the section Connecting to On-Premise Systems Using Cloud Connector.
connecting to
on-premise
via Cloud
Connector
SSH Used to read les from the system (sender adapter) or to write les to the system (receiver adapter).
See SAP Note 2700759 for information on how to obtain a Host Key to establish an SSH connection between Cloud
Integration and an SFTP server.
OAuth2 The following receiver adapter types support the option OAuth2 Client Credentials:
Authentication
AMQP/WebSocket, OData V2, OData V4, HTTP
The following receiver adapter types support the option OAuth2 SAML:
For more information, see the blog SAP Cloud Integration - OAuth2 Client Credentials Support in OData V2 Adapter .
Principal The Connectivity and Destination services on SAP BTP allow the use of principal propagation to forward the identity of a
Propagation Cloud user to the remote system. This assists in the use of Single Sign-On (SSO).
For more information, see the help documentation on Principal Propagation, Scenario for Cloud to On-Premise, and
Scenario for Cloud to Cloud.
For more information about transport-level security, see Security Elements (Transport-Level Security).
Message-Level Security
Message-level security allows you to digitally encrypt or decrypt, and sign or verify a message (or both). It can be used when the
transport-level security can't be implemented, which happens if a legacy communication endpoint doesn't support this option.
Message-Level Description
Security Options
PGP Encryption and Used to encrypt/decrypt the message content and signing/veri cation a message.
Decryption
For more information, see the blog on using a HCI Encrypt with PGP on how to use a PGP public key to
encrypt data, and the help documentation on using a PGP encryption step and on using a PGP decryption step.
PKCS#7 Encryption Used to encrypt the content of the message while it’s being sent to the cloud.
For more information, see the help documentation on encrypting and signing with PKCS#7, and on verifying
PKCS#7 signatures.
This is custom documentation. For more information, please visit the SAP Help Portal 51
12/17/2022
Message-Level Description
Security Options
XML Signatures Used for signing and verifying a payload, which ensures the authenticity of a message and guarantees the
identity of the signer and the message was not changed after signing. It’s possible to digitally sign and validate
a message based on the XML signature standard. In this case, the digital signature of a document is stored as
an XML element.
For more information, see the help documentation on signing message content with an XML digital signature
and on verifying XML digital signatures.
WS Security Used for signing and verifying a SOAP body and encrypt/decrypt message content (and the other way round to
verify a message and to decrypt the message content).
For more information, see the help documentation on Sender SOAP Adapter and Receiver SOAP Adapter.
For more information about message-level security options, see Message-Level Security.
Similar to destinations in SAP BTP, in SAP Process Orchestration, for some communication channels you can maintain
RFC/HTTP destinations to reuse them as much as necessary, for example, when you want to connect SAP Process
Orchestration to your ECC receiver.
A destination has a name, a URL, authentication details, and other con guration details speci c to the requirement and type of
destination.
For full help documentation regarding the use of the Destinations Editor (and other methods to maintain destinations), as well
as the setup of the different destination types, see SAP BTP Connectivity - Initial Setup.
Error Handling
Discover the different types of error messages and how they're handled in SAP Process Orchestration and Cloud
Integration.
Logging
Learn about different ways to do logging and tracing in SAP Process Orchestration and Cloud Integration.
Simulation
While developing the interface, you need to test your message mapping, or in Cloud Integration, test part of your
integration ow. To do so, both SAP Process Orchestration and Cloud Integration provide features to support this
development activity.
Monitoring
Find out which monitors you can utilize when working with SAP Process Orchestration and Cloud Integration, and
discover offerings for application lifecycle management.
Operation
This is custom documentation. For more information, please visit the SAP Help Portal 52
12/17/2022
Learn more about the ways both SAP Process Orchestration and Cloud Integration operate, for example when deploying
interfaces, performing connectivity tests, logging les, or working with APIs to automate operations.
Error Handling
Discover the different types of error messages and how they're handled in SAP Process Orchestration and Cloud Integration.
Error Messages
There are two types of errors that you can encounter when handling errors in SAP Process Orchestration and Cloud Integration:
Technical Errors: Errors triggered by the system because of technical issues. These can be a wrong password, the Web
Service is down, scheduling error, mapping error, etc.
Business Errors: Errors triggered by the target application itself. These errors can be, for example, an error while
creating a business partner, or a response error while creating a sales order because the material number doesn’t exist
in the target system.
In the middleware layer, you normally provide support for technical errors, while for the business errors you only need to assure
that the error message is propagated for the source/caller system. Alternatively, you can also use SAP Application Interface
Framework to process the error in the business layer.
Error Handling
In SAP Process Orchestration, there’s a built-in mechanism to reprocess asynchronous error messages, or, depending on the
business requirements, enable alerts via e-mail and customize a response error message to the source system (in case of
synchronous messages). For point-to-point interfaces, you have the possibility to con gure an error message while designing
the interface in Enterprise Services Repository. Some communication channels also count with speci c parameters to handle
errors (e.g., REST, SFTP). When using SAP Business Process Management (SAP BPM), you can implement other types of error
handling, such as generating a log le to an SFTP server and/or sending an asynchronous message to a third system. The
following are the general recommendations while handling errors in SAP BPM:
Make the error as speci c as possible and provide all the necessary information to facilitate the process for the future
administrator who has to handle it.
Create reusable exception processes, if possible, for different processes that share the same error handling.
In Cloud Integration, if you don't use an external system or service to generate alerts via e-mail (SAP Solution Manager, SAP
Cloud ALM, SAP Alert Noti cation service for SAP BTP) or use an asynchronous adapter with native support for reprocessing
(AS2, AMQP, JMS), you can achieve both capabilities implementing exception subprocesses directly into the integration ow:
This is custom documentation. For more information, please visit the SAP Help Portal 53
12/17/2022
For more information about how to use exception subprocess, see De ne Exception Subprocess in the documentation for Cloud
Integration.
For documentation about best practices while handling errors in Cloud Integration, see Handle Errors Gracefully.
If you want to access the delivered package for Cloud Integration with some examples of integration ows with error handling,
go to the API Business Hub or access it directly from the Cloud Integration tenant.
Logging
Learn about different ways to do logging and tracing in SAP Process Orchestration and Cloud Integration.
Persist duration time at the Adapter Engine for synchronous and asynchronous messages
Audit Log: Stores information on system changes. The retention time in database is 30 days.
System Log: Stores information on HTTP requests or default trace les. The retention time in database is 7 days.
Message Processing Log (MPL): Stores information on every message processed on a tenant and all their relative
details such as attachments, processing steps, etc. This is the data model for the Message Processing Log entity:
This is custom documentation. For more information, please visit the SAP Help Portal 54
12/17/2022
The retention time in the database for the messages is 30 days. The retention time and method may change for each log type
in the future. For more information, see Speci c Data Assets.
Data Store is another option for developers in Cloud Integration who need to keep messages or attachments for a longer
period. Data Stores are collections that can be created to store or read temporary messages. Possible use cases are:
Collect error messages in a data store. A scheduled integration ow can collect all those error messages and send a
summary of those errors via email to the IT Team or automatically create support tickets.
Receive different asynchronous messages (with different data types) and wait before composing a full enriched target
message. This is common in Commerce Cloud integrations. In SAP Process Orchestration, you could only do something
similar using SAP BPM.
Although the data stores are a powerful resource, they must not be used as a database to keep data inde nitely. For more
information about the guidelines while using data store, see Data Storages in the Cloud Integration documentation.
If long-term storage of message logs or data is required (for example, for legal or compliance reasons), it’s recommended to
use a separate storage mechanism such as a separate SAP HANA database instance and publish APIs that can be invoked from
Cloud Integration to post any data. However, keep in mind that the introduction of these capabilities increases the processing
time for integration ows.
Trace
When doing troubleshooting in SAP Process Orchestration, you may need to access the message payload in all its phases, for
example, right after SAP Process Orchestration receives the message from the sender, before and after the internal operation
mapping, and more. The following overview provides each message log step:
This is custom documentation. For more information, please visit the SAP Help Portal 55
12/17/2022
You can enable the log of each message trace level as described in the section Message Staging and Logging. Alternatively, you
can change it directly in your Integrated Con guration object by going to Edit Integrated Con guration Advanced Settings
. In section Staging, select Use scenario-speci c con guration, and for Message Preparation, select Store. In section Logging,
select Use scenario-speci c con guration, and for Receiver Determination and Mapping, select Log.
After activating it, you can access the message details page in message monitor and display all the relevant steps.
In Cloud Integration, if you need to nd out how a message is processed and transformed at runtime, an option is to run the
related integration ow with the logging level set at Trace. Unlike SAP Process Orchestration, in Cloud Integration you don't
need to redeploy your integration ow to activate the trace feature. With this level of logging turned on, you can then use the
log monitor to examine the Message Payload, as well as the Properties and Header values that exist in each step in the
integration ow execution:
This is custom documentation. For more information, please visit the SAP Help Portal 56
12/17/2022
If the traces contain sensitive data, they can be protected with access policies. For more information, see Managing Access
Policies, Cloud Foundry Environment.
Simulation
While developing the interface, you need to test your message mapping, or in Cloud Integration, test part of your integration
ow. To do so, both SAP Process Orchestration and Cloud Integration provide features to support this development activity.
In SAP Process Orchestration, you can test your message directly in the monitoring page as described in SAP Note 2367889 .
In Enterprise Services Repository, you can also test your message in the message mapping and operation-mapping level. For
more information, see Test Environment for Operation Mappings.
A more robust tool that allows you to set up automatic tests for existing SAP Process Integration scenarios and to reduce the
business downtime is the SAP Process Integration Test Tool. For more information, see SAP Process Integration Test Tool.
In Cloud Integration, there are two different options to test an integration scenario: simulating a mapping or simulating an
integration ow.
Simulate Mapping
Similar to the SAP Process Orchestration mapping test, within the Design Environment of an integration ow open a Message
Mapping and click Simulate. In the next step, it's required to upload a source le as input for the simulation. Afterwards, the
simulation can be executed with the Test button, and the result is displayed.
This is custom documentation. For more information, please visit the SAP Help Portal 57
12/17/2022
In Cloud Integration, you can use the Display Queue functionality, previously available in SAP Process Orchestration, to examine
the context queue of any target element. The result mapping can also be downloaded if needed.
For more information, see the blog Message Mapping Simulation in SAP Cloud Platform Integration .
When developing your integration ow, you can use a simulation feature that allows you to simulate parts of your integration
process or all of it. At various steps in your integration ow, you can set a Simulation Start point and inject the input data. If you
don't want to execute the integration ow until the end, you can also specify a Simulation End point:
For more information, see Simulation of an Integration Flow and the blog Integration Flow Simulation in Cloud Integration .
This is custom documentation. For more information, please visit the SAP Help Portal 58
12/17/2022
Monitoring
Find out which monitors you can utilize when working with SAP Process Orchestration and Cloud Integration, and discover
offerings for application lifecycle management.
Message Monitor
Using the message monitor in SAP NetWeaver Administrator, you can monitor the processing of messages on the Advanced
Adapter Engine. You can use message monitoring in the following cases:
To create an overview of message processing. Message overview also provides two different modes for searching
messages.
You can also search for messages that were persisted in the database, or for messages that have already been archived.
Use the communication channel monitor to obtain information about communication channels that are set up for the Advanced
Adapter Engine. You can also perform some administrative activities.
If the Advanced Adapter Engine runs on a server cluster, the communication channels comprise multiple instances for the
various cluster nodes.
Use the IDoc message monitor to search for IDoc messages processed in the adapter. Based on the various parameters of the
IDoc message you provide as search criteria, the monitor retrieves the messages and displays information about them.
It's also possible to use the IDoc metadata monitor to display IDoc metadata information and clear the metadata for the
selected IDoc type from the cache.
Use the adapter engine status to get information about the adapter engine, queues, message traffic (e.g. number of
asynchronous or synchronous messages), database locks, overview of messages (being) processed per sender, and receiver
components.
Channel-Independent Logs
Use the channel-independent logs to display execution steps of adapters that can't be assigned to a particular communication
channel.
Cache Monitor
This is custom documentation. For more information, please visit the SAP Help Portal 59
12/17/2022
Use the cache monitor to display objects that are currently in the runtime cache of the Advanced Adapter Engine and the
Mapping Runtime. You can enter selection criteria to search for current objects in the runtime cache and review the details of a
selected object.
Performance Monitor
Use the performance monitor to inspect the processed data by intervals of time and their processing time for individual
adapters.
Use the CPA cache history to display an overview of cache refresh actions and their statuses.
Displays an overview of background jobs (adapter engine, adapter framework scheduler jobs, etc.) and offers the ability to
manage them.
More Information
You can also centralize the Process Integration monitoring with SAP Solution Manager .
SAP Process Orchestration has a standard functionality called Component-Based Message Alerting which allows you to
create alert rules to your interfaces.
Cloud Integration isn't delivered with pre-built out-of-the-box alert capabilities, but you can use a predelivered package that
uses the SAP Alert Noti cation service for SAP BTP to send alerts of failure of integration ows. You can also create your own
integration using the available APIs to read the Cloud Integration tenant content.
Receive Noti cations for Failed SAP Cloud Integration Flows via Any Channel with Alert Noti cation
For a comprehensive walkthrough of the capabilities of the SAP Alert Noti cation service, review this blog series about SAP
Alert Noti cation .
If the standard capabilities of the SAP Alert Noti cation service aren't sufficient to meet customer requirements, or there's no
external system or service like SAP Solution Manager to generate alert noti cations, integration ows that invoke calls to the
standard APIs published by the SAP Alert Noti cation service can be built within Cloud Integration. Full documentation of these
APIs can be found on the API Business Hub . Another option is to combine the exception subprocesses while developing your
integration ow with some procedure to collect the error/success message and send it via email. For details, see the blog How
to send a mail from SAP Cloud Platform Integration .
This is custom documentation. For more information, please visit the SAP Help Portal 60
12/17/2022
SAP Cloud ALM is an offering for application lifecycle management. It's intended for customers who use cloud solutions
provided by SAP, and who don't want to use their own ALM on-premise platform for managing those solutions. SAP Cloud ALM
runs on SAP Business Technology Platform and is optimized for SAP HANA. It provides extensive implementation and operation
capabilities for cloud solutions with the following key features:
Implement cloud-centric solutions with a precon gured, content-driven guided workspace based on SAP Activate
methodology and SAP Best Practices.
Run t-to-standard workshops and manage all implementation, testing, and deployment activities.
Accelerate team member onboarding, de ne business process scope according to project milestones, manage
requirements, and track project progress.
Ensure smooth business operations without disruptions with proactive end-to-end monitoring and alerting.
Increase business-process execution quality and performance by nding and analyzing issues on business process,
integration, user, and application level.
Understand solution health and efficiency with advanced analytics and intelligence.
For more information, access the openSAP courses SAP Cloud ALM in a Nutshell and Accelerate Cloud Implementations with
SAP Cloud ALM .
You can also access the SAP Support pages SAP Cloud ALM for Implementation and SAP Cloud ALM for Operations .
SAP Solution Manager is an application lifecycle management platform used to implement, maintain, and integrate SAP
systems, troubleshoot issues, and keep operations running securely, cleanly, and smoothly. This tool was originally designed to
support on-premise systems only (including SAP Process Orchestration), but the scope of capability has been increased to
include cloud-based services, including Cloud Integration.
For detailed information on the capabilities and setup procedures to connect SAP Solution Manager to Cloud Integration, see
the SAP Support page for Cloud Integration .
Restriction
Some features mentioned on this site are planned for the future and are subject to change. For more information on new
features and future releases, access the Road Map Explorer and the What's New section of SAP Integration Suite.
Though SAP Solution Manager can currently be used for cloud products and SAP Cloud ALM can also be used for hybrid
scenarios as part of future roadmap, it's important to understand the positioning of these two different products. SAP Solution
Manager is recommended for on-premise products and SAP Cloud ALM is engineered keeping the cloud applications in mind.
Both of these products have different use cases, and both serve a different market.
For more information, see the blog SAP Cloud ALM vs SAP Solution Manager .
Operation
This is custom documentation. For more information, please visit the SAP Help Portal 61
12/17/2022
Learn more about the ways both SAP Process Orchestration and Cloud Integration operate, for example when deploying
interfaces, performing connectivity tests, logging les, or working with APIs to automate operations.
Deploying Interface
In SAP Process Orchestration, once you activate your Integrated Con guration object, your interface is up and running.
In Cloud Integration, once you nish the design of your integration ow, you must deploy the artifact. After deployment, you can
perform some tasks such as restarting the artifact, undeploying the artifact, and downloading the deployed artifact to your PC.
The last option is useful when you need to recover the deployed version of your integration ow.
Connectivity Tests
A feature introduced in Cloud Integration is the connectivity tests, which allow you to perform some simple test connections in
different protocols to assure the connectivity with the target system. In TLS protocol, for example, you can download the full
certi cate chain that should be imported in Cloud Integration keystore most of the times. For more information, see Performing
Connectivity Tests.
In SAP Process Orchestration, after activating your communication channel in Integration Directory, for some of them (see SAP
Note 1890633 ) you can also navigate to the Communication Channel Monitor and try the ping channel, which provides the
result of a basic connectivity test. Another option, especially for TLS protocol, is to use XPI Inspector tool to have access to
the certi cate chain that should be imported to the keystore. XPI Inspector offers a full trace and dump during a connectivity
test, which helps to analyze and solve connectivity issues. The only exception concerns the RFC adapter, for which you need to
maintain an HTTP destination in the SAP BTP tenant as described in Creating an RFC Destination.
Log Files
Both SAP Process Orchestration and Cloud Integration provide logging mechanisms to support the monitoring and
troubleshooting of interfaces that are executed on the middleware systems. As Cloud Integration is a cloud-based service, the
persistence of logs and any attachments to logs differs from SAP Process Orchestration in that the duration of persistence is
much shorter and the deletion of logs lies outside of the control of the customer.
SAP Process Orchestration stores activities of system, integration, and database events. In the Log Viewer, you can see the
technical detail system status. Based on information in system logs, you can check, monitor, and investigate any issues and
possible root causes.
Error messages
Warning messages
Information messages
Path messages
Debug messages
You can access the Log Viewer by going to SAP NetWeaver Administrator Troubleshooting Logs and Traces Log Viewer
.
For Cloud Integration, you must use the SAP Audit Log service to monitor the security-relevant chronological records such as
events, activity logs, and application logs. For more information, see Audit Logging in the Cloud Foundry Environment. You can
also use the Audit Log Retrieval API to extract possessed by the tenant. For more information, access the API Business Hub .
This is custom documentation. For more information, please visit the SAP Help Portal 62
12/17/2022
To access the most updated list of APIs for Cloud Integration, visit the API Business Hub . The capabilities include:
Get an overview of the messages processed on a tenant and get the details for individual messages.
Access message store entries, JMS resources, and data store entries.
Access and manage security content to con gure secure connections with remote systems.
For SAP Process Orchestration, there's official documentation for some available APIs, for example for Integration Directory
and SAPControl Web Service , and also some blogs that explore other types of automation, for example An overview on SAP
PI/PO APIs .
Interface Governance
Discover important aspects regarding the tools and services available that support the management, auditing, and governance
surrounding the transport of integration artifacts within a Cloud Integration landscape.
Multi-tier Environments
For SAP Process Integration and SAP Process Orchestration, it's recommended to set up separate landscapes for development,
test, and productive system. In any organization using Cloud Integration as their integration middleware service, there's
typically what is commonly referred to as a multi-tier environment, like in PI/PO. In both cases, this concept supports the
capability for an organization to have a ʻlive’ production middleware service in place that handles the actual movement of
This is custom documentation. For more information, please visit the SAP Help Portal 63
12/17/2022
business messages between production systems, while still being able to develop, perform quality assurance, and x and test
new or revised integration content before deploying to production where the real business processes are performed.
The minimum number of tiers possible is a 2-tier system comprised of a development (Dev/Test) tenant and a production
tenant.
Many larger organizations, however, opt for a much larger multi-tier environment such as:
3-tier: Development (Dev) → Test (or Quality Assurance System) → Production (Prod)
Preproduction is typically closer in size to production (in terms of resources such as memory and CPU) and traditionally would
be used for performance and volume testing, analysis of any bugs detected in production. It's often deemed as part of the
production landscape and used for live support.
In some situations, organizations may opt for even more development and test tenants to support either multiple projects on
the go, depend on the dimension of the project, segregate development by geographical region, by business function (e.g.
separate HR, Finance). One of the bene ts of multi-tier landscape is the possibility to perform tests in parallel with the
developments or numerous other reasons.
For more information, see the blog Multitenancy Architecture on SAP Cloud Platform, Cloud Foundry environment .
Managing Environments
Governing, and managing the proper testing and audited transport of integration objects between the different tier systems
can become complex. It remains equally critical that only properly tested and signed-off integration objects reach the
production tier in a synchronized manner to ensure business continuity and prevent any breakdown in business processes. To
aid in this governance process, SAP provides tools, products, and services to manage this governance process. The current
toolset available is summarized in the next sections.
It allows to attach the objects developed/created to a CTS+ transport request. When the development objects are ready to be
tested in quality environment, for example, the request should be released. After this step, it's not possible to add or change
the objects already released and for other changes, a new change request must be created. CTS+ provides a uni ed transport
tool and simpli es the execution of imports in a new environment.
This is custom documentation. For more information, please visit the SAP Help Portal 64
12/17/2022
Since all transports are logged in CTS+, it’s possible to have an overview of the status of the change requests, like the errors
that could happen during the transport, which allows you to quickly solve the issues. You can also check if a change request was
already executed and the ones that are planned.
For more information, see Transporting Non-ABAP Objects in Change and Transport System.
Development artifacts
CTS+ can only be used for organizations that intend to adopt a hybrid approach in which some systems remain either on-
premise or choose to opt for the Private Cloud Edition (PCE) for SAP Solutions such as SAP S/4HANA and SAP Solution
Manager.
Note that the ABAP server acting as CTS+ control system (in many cases an SAP Solution Manager) resides in your on-
premise data center even for the SAP BTP transports.
For more information, see Transporting Multitarget Applications in Cloud Foundry using CTS+, the support page for CTS+ , and
the blog Setting up a CTS+ enabled transport landscape in SAP Cloud Platform .
SAP Cloud Transport Management allows you to manage software deliverables between accounts of different environments
(like Cloud Foundry environment) by transporting them across runtimes. It's a multi-tenant application and provides a tenant
separation.
It will cover further content types in the future (see the roadmap for SAP Cloud Transport Management )
This is custom documentation. For more information, please visit the SAP Help Portal 65
12/17/2022
It covers the SAP BTP, Cloud Foundry environment and is planned to be extended to further multi-environments and to
SAP SaaS solutions (such as SAP Cloud Price Quote)
Cloud Transport Management and CTS+ can be used in parallel: Cloud Transport Management for cloud transports, and
CTS+ for ABAP and non-ABAP on-premise transports.
For more information, see the SAP Cloud Transport Management documentation.
Some bene ts of using SAP Solution Manager are the efficient project administration, control of cross-component
implementations, minimizing the risk and increasing the reliability of solutions, and speeds up test preparation and execution.
SAP Solution Manager can store the testing materials and test results to support cross-component tests.
For more information, see the support page for SAP Solution Manager .
In a hybrid environment, any changes or new development can involve development objects that span both on-premise and
cloud-based services or components. For example, there may be changes required to ABAP objects in an on-premise system,
while integration artifacts to support the hybrid application may be required as well. It can be critical to ensure that all objects
are veri ed and moved in a synchronized manner to ensure the hybris application doesn't fail. By using tools such as Change
Request Management (ChaRM) in SAP Solution Manager, this synchronized movement of objects can be managed.
Both Cloud Transport Management and CTS+ can be integrated with the Change Management tools on SAP Solution
Manager:
This allows synchronized transports of ABAP and non-ABAP on-premise assets via CTS+, and cloud artifacts via Cloud
Transport Management in hybrid projects.
This setup is important for customers with strict audit requirements such as banking or pharmaceuticals.
This is custom documentation. For more information, please visit the SAP Help Portal 66
12/17/2022
The prerequisite for integrating Cloud Transport Management with SAP Solution Manager is release 7.2 with SPS10
(available as of December 2019) or higher.
Note
gCTS is the Git-based CTS solution that's currently not relevant to integration artifacts and hence isn't covered further here.
For more information, visit the blog Interplay of SAP Cloud Platform Transport Management, CTS+ and ChaRM in hybrid
landscapes .
For detailed guidance on the options available to transport integration artifacts, and how to set up the transport service, it's
recommended to read the sections on Content Transport in the Cloud Integration documentation.
Decision Help
We provide a decision help that looks at cloud-based transport options and describes the advantages and disadvantages of
each:
Manual export/import
Use only in exceptional cases, for example for urgent xes in case the transport system is
down.
No control and logging of the transport events and the involved users.
Risk of losing control of who is transporting what and when. Using this option, you don't
have any advantage of the tool support provided by a transport system, like, for example,
logging. For this reason, manual exports and imports should be avoided in an integration
project or while operating Cloud Integration.
CTS+
CTS+ is a recommended option.
This option provides a fully automated transport mechanism (allows the assignment of
roles, de nition of transport routes, approvals, and comes with additional useful features
like logging).
If an on-premise CTS+ is already installed and used for other systems or objects, it's an
option to use CTS+ also for integration content transport.
Note
CTS+ has been available for many years to transport on-premise non-ABAP content. This
concept has been extended some time ago to support SAP BTP. However, only cloud content
that can be packaged in MTAR les can be transported. For integration content transport, this
constraint is ful lled. Therefore, if you use MTAR-based content only in SAP BTP, CTS+ is a
valid choice.
This is custom documentation. For more information, please visit the SAP Help Portal 67
12/17/2022
If there's no on-premise CTS+ available in your landscape, a good option is to go for SAP
Cloud Transport Management. SAP Cloud Transport Management is the solution for
transporting content in SAP BTP. Compared to using CTS+, this option initially implies a
smaller investment in implementation and operation. Note that SAP Cloud Transport
Management is a cloud service (subscription-based with maintenance and updates by
SAP). It's therefore the way to go for customers planning to implement projects using SAP
BTP services.
MTAR Download
MTAR Download is a semiautomated option (in between manual export/import on the one
hand and using CTS+ or SAP Cloud Transport Management on the other hand).
It allows you to download an integration package manually from a source tenant as an .mtar
le. In a subsequent step, you can upload this le to the transport system and, nally,
transport it to the target tenant.
Using this option, you bene t of having certain advantages of a transport system. However,
there's still a manual step. As manual steps should be avoided as far as possible, it's
recommended to use this option only in exceptional cases, for example for urgent xes in
case the connection between source tenant and transport system is down.
Note
The manual export/import and the MTAR download options are not discussed any further in this document due to their lack
of full automation and inherent lack of ability to support any governance model.
Prerequisites
For the two automated approaches speci ed above, there are prerequisites that need to be performed depending on the
environment your SAP BTP is deployed in.
For more information, see Enabling Content Transport, Cloud Foundry Environment.
CTS+
For more information on enabling the use of CTS+, see Content Transport Using CTS+.
For more information on using the SAP Cloud Transport Management solution, see also the blog Introducing SAP Content Agent
service: Enhanced Transport Capabilities for Cloud Integration Content
This is custom documentation. For more information, please visit the SAP Help Portal 68
12/17/2022
For initial information on connecting your SAP Solution Manager system to various cloud services (including Cloud Integration),
see Integrating Cloud Services in SAP Solution Manager.
The API Management capability comes with the objective to create an enterprise-wide governance, secure and harmonized
experience for customers, partners and employees while consuming exposed APIs. API Management isn't only a service to
gateway some particular API, but it also counts with a try-subscribe developer portal for external parties, real-time insights, and
analytics on the API traffic and meter/monetization possibilities.
The following image shows how you can position the API Management while migrating from SAP Process Orchestration:
You can nd more details about the API Management capability and how to provision it under the following links:
Interface Documentation
SAP Solution Manager 7.2 makes it possible to manage the interface documentation and document it sustainably.
Interface Documentation in SAP Solution Manager 7.2 as part of Solution Documentation provides the possibility to centrally
document interfaces in the solution landscape. All interface technologies that exist in an SAP landscape are available, including
SAP PI interfaces where the processing is done through different kinds of adapters. Each interface can be speci ed individually,
as every interface technology provides a set of so-called interface attributes that come out-of-the-box. In case further interface
attributes are needed, it’s possible to create custom attributes and use them in the same way as the attributes delivered by
SAP. Moreover, custom-speci c interface technologies can be de ned in case the standard technologies are insufficient to
describe the interface properly.
Moreover, many customers still use offline documents like spreadsheets to list their interfaces, which are cumbersome to
handle and often pose the risk that data gets lost or outdated information is used because of improper document management.
The Interface Documentation application aims at replacing this type of maintenance mode. Although it's some initial effort to
transfer the offline documentation into the SAP system, it's worthwhile to do so. Interfaces and their attribute data can then
This is custom documentation. For more information, please visit the SAP Help Portal 69
12/17/2022
bene t from all features Solution Documentation provides. For example, different versions of the same interface can exist in
parallel, and attribute data for the same interface can vary per site or system role.
In addition, integration with the Interface & Connection Monitoring application is available: interface attribute data maintained
in Interface Documentation can be used to con gure Interface Channels for monitoring & alerting, without having to enter the
same data into the system again. This integration re ects the best practice-like approach for Interface Management in SAP
Solution Manager as indicated in the following gure.
For more details and setup instructions, see the wiki page Interface Documentation for Solution Manager 7.2 and the blog
Interface Documentation with SAP Solution Manager .
In SAP API Management, you can design you own RESTful API de nitions using the API Designer UI and OpenAPI speci cation
(formerly known as Swagger Speci cation).
With that, you can describe and document different aspects of your API using a language-agnostic syntax, including:
Authentication methods
This is custom documentation. For more information, please visit the SAP Help Portal 70
12/17/2022
With the OpenAPI speci cation, you can import it in different tools for different purposes (test generation, client code
generation, server code generation) or you can also import into SAP API Management to generate the APIs proxy.
This is custom documentation. For more information, please visit the SAP Help Portal 71
12/17/2022
For more information about how to use API Designer, see Create an API from API Designer.
For more information about how to import OpenAPI (Swagger) les into API Management, see Import an API.
For more about how to create API services using OpenAPI, see the blog Develop and Manage API- rst Enterprise Microservices
in API Management .
Interface Migration
Learn about the different aspects involved in migrating your interfaces from SAP Process Orchestration to SAP Integration
Suite.
This is custom documentation. For more information, please visit the SAP Help Portal 72
12/17/2022
Restriction
This feature is planned for the future and is subject to change. For more information on new features and future releases,
access the Road Map Explorer and the What's New section of SAP Integration Suite.
At the current state, SAP is working on a migration tool to support customers on a fully automated migration of integration
artifacts. The tool is not available yet and might be released with different function sets in the rst stages, but in general it will
include:
Extraction tool to extract required information about the SAP Process Orchestration system such as:
Landscape
Integration Scenarios
This information will be used to generate a high-level list of artifacts that need to be considered. It can also be used to
feed the migration tool for an automatic conversion.
Automatic migration/conversion
Using the extracted data of objects from SAP Process Orchestration, these objects are converted automatically
to artifacts in SAP Integration Suite.
Depending on the release level and the particular scenarios, some manual activities might be required.
The migration process itself can be covered by a migration project, which can contain different phases as illustrated in the
following diagram:
1. Evaluate
Analyze the current and the to-be landscape. SAP recommends using the SAP Integration Solution Advisory
Methodology .
If not available, create a high-level architecture for the connected systems and a detailed list of these systems
with the used protocols, adapters, triggers, and authentication.
Check if there are other options to integrate the systems on the SAP API Business Hub such as:
This is custom documentation. For more information, please visit the SAP Help Portal 73
12/17/2022
Standard Integration Packages
2. Plan
Automatically migrated (depending on the availability and features of SAP Migration Tool)
Redesign scenarios (standard content, standard APIs, interfaces not covered by the SAP Migration Tool)
Side-By-Side Migration
Depending on different aspects of the customer like business or functional requirements and availability of
features on Cloud Integration
3. Preparation/Implementation
Certi cates, user credentials, known-host le, public and private keyring.
Setup of implementation guidelines and architecture, mainly in case of redesigning integration scenarios
Migration of content
Automatic migration
Reimplementation for redesigned interfaces and non-supported objects by the SAP Migration Tool.
4. Test
Different test phases to test the migrated content (e.g., connectivity, developer, unit, process, system, acceptance)
6. Live
This is custom documentation. For more information, please visit the SAP Help Portal 74
12/17/2022
The migration phases can be adjusted to the needs of the customer and the preferred project methodology. There are different
options to execute the phases.
The migration of Cloud Integration from Neo to Cloud Foundry allows you to keep current on the roadmap for the offerings
inside SAP BTP and it brings bene ts such as:
Availability on hyperscale environments, such as Amazon Web Services, Microsoft Azure, and Alibaba Cloud
Scalability
B2B Libraries
Be aware of some restrictions that you may nd while migrating from Neo to Cloud Foundry. Some of them are:
The audit log access via Cloud Integration Monitoring UI is not supported.
RFC adapter with principal propagation on a tenant that is hosted in Cloud Foundry environment is not supported.
Customers can move their Cloud integration license from Neo to Cloud Foundry and perform the technical migration of
the Content tenant afterwards.
Note
Such “as-is” migration is not available for Enterprise Edition, App Edition, and Enterprise Messaging Upsell
(8005999). SAP Integration licenses shall be considered for such cases. For more details, contact your SAP
representative.
Note
Before performing the necessary analyses of your migration project, access the SAP API Business Hub to nd
predelivered templates, packages, and blueprints for various market cloud solutions.
Since SAP regularly delivers updates and features to SAP Integration Suite, follow the previous and future releases in the
Road Map Explorer and the What's New section of SAP Integration Suite.
This is custom documentation. For more information, please visit the SAP Help Portal 75
12/17/2022
Message Cloud Integration supports various types of mapping methods, such as Operation Mapping (from SAP Process
Mapping Orchestration), Message Mapping (XML and JSON), XSLT, and Groovy Script.
See Import Mapping Artifacts for strategies on migrating each type of object.
B2B There are some limitations compared to SAP Process Orchestration regarding adapters and features.
Note
For more information on new features and future releases, access the Road Map Explorer and the What's New
section of SAP Integration Suite.
Regarding B2B Scenarios, SAP recommends using the Integration Content Advisor.
For more information, see the blog Partner Directory - Step-by-Step example .
OP2OP
Restriction
This feature is planned for the future and is subject to change. For more information on new features and future
releases, access the Road Map Explorer and the What's New section of SAP Integration Suite.
For ground-to-ground scenarios, SAP plans to provide a hybrid deployment option with which you can leverage all
the capabilities of the Cloud Integration, but in a local deployment.
You can also use the Integration Gateway Component to execute and operate cloud integration content from the Cloud
Integration in the Advanced Adapter Engine with all the deployment options (PI-AEX, decentral Adapter Engine, SAP
Process Orchestration and SAP PI dual usage type).
See Enable the Integration Gateway Component and SAP Note 2428801 .
Message For more information, see Monitoring in Error Handling and Logging Strategy.
Monitoring
Standard See API Business Hub for new standard content released for SAP Integration Suite.
Content
Job Scheduler When developing an integration ow to create a scheduled execution, you can use timer events. See Add a Timer Start
Event.
This is custom documentation. For more information, please visit the SAP Help Portal 76
12/17/2022
SWCV Different from SAP Process Orchestration, Cloud Integration doesn't have the concept of software component (de ned
in SLD) and namespace.
In Cloud Integration, you can create a package into your tenant and create some design artifacts, such as integration
ow and value mapping. The following artifacts can be created inside a package:
Integration Flow
REST API
Message Mapping
SOAP API
Value Mapping
OData API
Script Collection
Integration Adapter
Service Registry In Cloud Integration, there's no concept equivalent to Service Registry. However, you can combine your interfaces
created in Cloud Integration with the API Management capability to create an omni-channel experience for customers
and employees (mobile, web, devices). It can bring the following bene ts:
Broad analytics
The following limitations and possible workarounds exist for the automatic import feature:
Graphical Mapping When importing the message mapping, User-De ned Functions (UDFs) with function libraries, imported archives, or
(UDF) parameters are not supported.
Local Java UDFs are supported and can be viewed and edited.
Note
Lookups (e.g., RFC, JDBC) are not supported. Use additional integration ow steps instead.
This is custom documentation. For more information, please visit the SAP Help Portal 77
12/17/2022
Value Mappings Message Mapping containing reference to Value Mapping is not supported at runtime. In this case, you must
redesign your message mapping and use the value mapping of Cloud Integration.
Access the Connectivity Migration document for more information about how to migrate value mappings from SAP
Process Orchestration to Cloud Integration.
Fixed Values Although it’s supported in automatic import feature, it’s highly recommended to change the Fixed Values reference
to a Value Mapping in Cloud Integration. This way, you can reuse this artifact and maintain the values without
changing the integration ow when necessary.
For more information about how to import a CSV le as a Value Mapping, see Formatting Guidelines for CSV Files
used in Value Mapping, or see Connectivity.
Libraries The JAR les that contain the external Java libraries can be imported manually in Cloud Integration.
Function Libraries Message Mapping containing reference to Function Libraries is not supported. In this case, it’s necessary to
redesign these mappings. You can use Javascript/Groovy script in this case. The scripts can be created locally in
the integration ow or you can create a Script Collection to make it available for different integration ows inside
your package.
Note
Lookups (e.g., RFC, JDBC) are not supported. Use additional integration ow steps instead.
Java Mappings The JAR les can be imported and reused in Cloud Integration.
You can also work with Javascript/Groovy scripts, which is the preferable approach when working in Cloud
Integration. In this option, you can edit the script without having to reimport a compiled version.
For more information about the Java Mappings, see the blog Using Java Mappings in SAP Cloud Platform Integration
.
ABAP Mapping ABAP Mapping is not supported, which means that the logic must be reimplemented using any of other mapping
methods in Cloud Integration: Graphical Mapping, XSLT, or Javascript/Groovy script.
For more information about how to set up the connection between SAP Process Orchestration and Cloud Integration, see
Con guring Connectivity to ES Repository or the blog How to connect CPI and PI system to import mappings via SAP Cloud
Connector .
Test Automation
As part of the testing phase in every migration project, you can nd several products on the market that enable you to create
automatic testing scenarios. This reduces risks to critical business processes and lowers the human effort to cover the test
tasks of part or most of the interfaces.
Some of these tools support different SAP Products (e.g. SAP Process Orchestration, Cloud Integration) and can be used not
only in the project but also in the future developments and maintenance. Note that it’s important to verify the pricing conditions
for each product.
There are some additional tools available from our partner ecosystem. For more information, visit the SAP Store .
This is custom documentation. For more information, please visit the SAP Help Portal 78
12/17/2022
Use transaction SPXNMIG and report SPROX_MDR_MIGRATION to migrate existing ESR proxies to the MDR. The web services
are then available locally in the backend system where they can be changed and extended.
Prerequisites
Before the migration, de ne which namespaces should be considered by assigning them to the MDR. Since MDR proxies and
ESR proxies share the same namespaces, the system checks which namespaces should be assigned whenever a proxy object is
to be generated.
1. Open transaction SPXNGENAPPL to customize the default settings for namespace assignment.
By default, ESR is considered for Business Suite systems and MDR for Business By Design.
2. Maintain the list of namespaces by selecting Backend Metadata Repository as the Generation Source.
Since wildcards are allowed, you can create a generic entry * that considers all valid namespaces.
Steps
1. In transaction SPXNMIG, de ne a namespace range and select Execute. If no namespace range is provided, all entries
previously maintained in SPXNGENAPPL are used as selection.
2. The system displays a list of all proxy objects that can be migrated, with information if additional steps are needed. It
cross-checks the ESR object/namespace and MDR namespace assignment.
Some object types cannot be migrated and are therefore not included in the list. See Restrictions.
3. Select Migrate to trigger the migration for the complete list, or a previously selected subset. Once the migration is
nished, the results are displayed.
Restrictions
The following objects cannot be migrated and are therefore not displayed in the list of proxies to be migrated:
External de nitions
Migrating ESR interfaces based on external de nitions is not supported. They can be replaced by an external
consumer/provider generated from WSDL directly in backend. A new ABAP name for the class is then generated so the
previous usage should be reviewed.
Additionally, inline types cannot be migrated to the MDR automatically. You can migrate them manually by using one of the
following options:
Change inline types to global types in the ESR and regenerate them to become global types in the backend, too.
Convert inline types using the migration tool semiautomatically. This means that inline types can be converted into
global types by specifying a global name for each inline type the tool needs to generate a global type for. If this option is
used, a migration back to ESR is not possible.
New Interfaces
This is custom documentation. For more information, please visit the SAP Help Portal 79
12/17/2022
For new interfaces, the creation of objects should be done directly in the backend. You can use wizards for this task.
The Cloud Integration Web UI provides a modeling environment that allows you to design the details of message processing (its
senders and receivers as well as the individual processing steps) with a graphical user interface. For a comprehensive
description of the main aspects when starting the development of a new interface, see Getting Started with Integration Flow
Development.
How the senders and receivers are connected to the tenant (adapters)
Related Information
Guidelines to Design Integration Flows
Integration Patterns
Additional References for Interface Development
Guidelines Description
High Availability Carefully build an integration ow considering certain patterns that never break the
business process.
Resource Management To correctly process messages in Cloud Integration, some resources are needed, like
the capabilities used in the integration ow, on the computing system, database, and
messaging service broker to process the messages.
Readability When an integration developer is designing an integration ow, it’s important take the
best practices and the readability of an integration ow into account. During the
maintenance, it’s easier and simple to quickly check the message processing ow if the
integration ow is well designed.
Handling Failures Gracefully Even well-designed integration ows can break during message processing, but this
shouldn't disrupt the business process. To avoid this situation or increase the impact
of the failure, it’s important to extend the integration ow with error handling. It’s
convenient to have supervision during the integration ow execution to check the
message ow, keep the data to test, and analyze the causes of the error.
Prepackaged Integration Content Cloud Integration has prepackaged integration content available that contains
integration ows, value mappings, documentation, and more. This is useful for the
integration developer since these packages are a quick start into an integration project.
Cloud Integration also allows to extend the capabilities of prepackaged integration
content provided by SAP. In this case, the integration developer can design custom
integration ows without changing the content.
Highest Security Standards The integration ow ultimately speci es how a message is processed and which
options are applied to protect the content of the messages on the way between the
sender and the receiver. Therefore, the integration developer has to make sure that the
integration ows are designed in a way that ensures that the highest security standards
are applied.
Use Scripting Appropriately You can use the Script step to apply script operations on the message content. The
Script step type supports the following script languages:
Groovy
JavaScript
If you don't consider the proposed guidelines during integration design, there's the risk
that your scenario is affected in the following way:
It's hard for the integration expert to understand the logic of the integration ow.
Your scenario runs into compatibility issues if there are Java upgrades or Cloud
Integration updates.
This is custom documentation. For more information, please visit the SAP Help Portal 81
12/17/2022
Guidelines Description
Use the Partner Directory Appropriately When designing business-to-business scenarios, you can use the Partner Directory to
store information on business partners that are connected to the tenant in the context
of a larger business network.
The Partner Directory contains information on partners that are connected to a tenant in
the context of a larger business partner network. The information stored in the Partner
Directory can be used to parameterize integration ows.
There's no dedicated user interface to access the Partner Directory. You can access its
content only based on APIs.
Integration Patterns
Gregor Hohpe and Bobby Woolf have detailed a catalog of 65 common patterns in Enterprise Application Integration (EAI)
scenarios in the book titled Enterprise Integration Patterns: Designing, Building, and Deploying Messaging Solutions (Addison-
Wesley, 2003). SAP published a blog about implementing Integration Patterns on SAP Process Orchestration .
An Integration Flow Design Guidelines – Enterprise Integration Patterns package is available on the SAP API Business Hub ,
where you can nd more information on how to con gure and use different integration patterns. It also contains sample
integration ows, which can be used to test integration patterns on a Cloud Integration tenant or on SAP Process Orchestration
7.5.
The next chapters describe the following patterns in detail, and how to implement it in SAP Process Orchestration and on Cloud
Integration:
Aggregator
Splitter
Scatter-Gather
Content-Based Routing
Recipient List
Message Filter
Content Filter
Content Enricher
Aggregator
The Aggregator pattern is a special lter that receives a stream of messages and identi es messages that are correlated.
Once a complete set of messages has been received, the Aggregator collects information from each correlated message and
publishes a single, aggregated message to the output channel for further processing.
The following sections describe the usage of this stateful pattern in SAP Process Orchestration and Cloud Integration.
This is custom documentation. For more information, please visit the SAP Help Portal 82
12/17/2022
Since the Aggregator pattern keeps a state, Business Process Management (BPM) is required to orchestrate the message
ow. For the actual exchange of messages with the involved systems, the Process Integration runtime of SAP Process
Orchestration is used. In the following, the focus is on the BPM process only. For a detailed description of the overall
implementation, see the blog Enterprise Patterns in Process Orchestration – Aggregator .
In this example, the process collects messages within a speci c period, and each bulk should have 5 items at most. This model is
a combination of an intermediate timer event and a loop. The incoming messages meeting the correlation condition are
collected. An incoming message triggers the process instance. In the Start event, the counter is reset and the correlation
condition is stored. A parallel split gateway is used to branch into the intermediate timer event path and the path containing
the loop. The loop waits on further incoming messages with the same correlation condition as the start event. If a message
arrives, the respective data object is appended, and the counter is incremented. Depending on which event occurs rst, either
the maximum number of messages or the waiting time has been exceeded, the aggregated message is sent, and the process
instance is ended. Optionally, the model can be enhanced to wait for a dedicated message stopping the collection (not shown
here).
Cloud Integration
For a detailed description of the Aggregator pattern on Cloud Integration, see Aggregator.
The integration ow model presented in the help documentation illustrates the use of a dedicated Aggregator ow step. Itʻs not
required to model the pattern in a loop as seen for SAP Process Orchestration. In the Aggregator ow step, the correlation
condition, as well as the completion conditions, can be de ned. Right now, the last message condition and the completion
timeout are supported in this model step. Unfortunately, maximum number of messages isn't supported yet. The rest of the
ow steps are used to map the collection of items to the right message format. In this case, an order with order header
information and all items, hence removing redundant information.
Splitter
The Splitter pattern is used when it's required to split up a bulk or composite message into individual messages. For the
following example, there’s an order document with multiple lines. The message needs to be split into individual messages each
containing the data related to one item. Furthermore, it must be ensured that the order header information is available in every
message. You can nd the XML les from before and after transformation in the Splitter help documentation.
The following sections describe the usage of this stateless pattern in SAP Process Orchestration and Cloud Integration.
This is custom documentation. For more information, please visit the SAP Help Portal 83
12/17/2022
An example of the rst option via BPM is described in the blog Enterprise Patterns in Process Orchestration – Splitter . The
BPM process is picked if further message orchestration steps are required.
This document illustrates the message mapping option since this option is more often used compared to the BPM process. In
the message mapping, the occurrence of the source message type is set to 1, and for the target message type, it’s unbound.
For each item within the source structure, a new message should be created. Every item node is mapped to the PurchaseOrder
node.
This is custom documentation. For more information, please visit the SAP Help Portal 84
12/17/2022
The order header information such as the order number should be added to each individual target message. So, this
information needs to be replicated. This can be achieved by using the CopyValue standard message function.
The item node and all child nodes can be mapped one by one. For the item, it’s required to insert a context change to ensure
that each message contains one item only. Here, the SplitByValue standard message function is used.
This is custom documentation. For more information, please visit the SAP Help Portal 85
12/17/2022
Cloud Integration
On Cloud Integration, depending on the use case, several options are available. In the Splitter documentation, two use cases are
illustrated:
For the rst use case, an Iterating Splitter ow step can be used. For a detailed description, see the Variant with Iterating
Splitter documentation.
For the second use case, we describe two options: either reusing the Message Mapping or using a General Splitter ow step.
When the General Splitter ow step is added to the integration process, it takes care of splitting up the message into individual
messages based on the items. On the processing tab of the General Splitter con guration, the XPath is selected as expression
type and an XPath expression is maintained. The XPath expression is pointing to the location of the item node. The bene t of
this option is that the General Splitter automatically duplicates the header information of the order for each individual
message.
For more information, see the blog SAP Cloud Platform Integration – Splitter .
Scatter-Gather
The Scatter-Gather pattern is used when it’s required to send a message to multiple recipients and collect the individual
responses in an aggregated message.
This is custom documentation. For more information, please visit the SAP Help Portal 86
12/17/2022
The process model starts with a message start event. For a new loan request, a new process instance is created. After having
carried out a solvency check, the request is broadcast to multiple banks. Here, this is a service call, the distribution of the
request to the banks is done within SAP Process Integration (not shown here). The bidding process should be open for a limited
time, for example 2 days. Within this time frame, all bids from the banks are collected. Once the time has been exceeded, the
bidding is closed, so no further bids are accepted. This is implemented via an event-based choice gateway with two branches.
One branch contains an intermediate message event with a correlation condition so that the bids are assigned to the right
process instance. The other branch contains an intermediate timer event, which is triggered once the time is up. In this case,
the best quote is calculated, and a response is sent to the original requester. If a bid arrives after the time has been exceeded,
the message is discarded because there's no active intermediate message event that meets the correlation condition.
Cloud Integration
For a detailed description of the Scatter-Gather pattern on Cloud Integration, see Scatter-Gather. In the following, only the
rough model is outlined.
Since an intermediate message event is available on Cloud Integration, the Scatter and the Gather parts are modeled as
separate integration processes. This is not a disadvantage, as the distribution and the collection don't have to be modeled in
the same process. If the information from one part is used in the other, an exchange via a data store is modeled. Furthermore,
to be able to correlate both parts in the message monitor, a common Application ID based on the request ID for instance can be
de ned.
The Scatter part takes the request and broadcasts it to multiple banks. Before, the timer is triggered via a separate message
sent to the Gather part.
The Gather part collects the bids using an aggregator ow step, calculates the best quote, and sends the response to the
original requester. The best quote calculation is done via a message mapping that can be imported from the Enterprise Service
Repository (ESR) of SAP Process Orchestration.
By default, if a bid arrives after the time has been expired, a new process instance is created. To avoid this, a third integration
process that checks if the bidding process is still active and eventually forwards the bids to the Gather part must be added. The
check is based on a respective entry in the data store. Once the request has been received, the request is stored in the data
This is custom documentation. For more information, please visit the SAP Help Portal 87
12/17/2022
store with the request ID as the key. This is done in the Scatter part, as described before. Once the time has been exceeded, the
data store entry is deleted. This is done in the Gather part, as described before. In the model below, it's checked if the data
store entry still exists. If not, the exception subprocess is triggered, and the message processing is stopped, hence discarding
the message. Otherwise, the message is sent to the Gather part.
The BPM process is modeled following the BPMN (Business Process Model & Notation) speci cation. The process model starts
with a message start event receiving an order with multiple items. In a mapping, the order is split. For the mapping, looping is
de ned as part for each although the individual split messages actually run in sequence. For each item, a condition is carried
out, and the processing is routed to either of the branches depending on the respective product category. A router condition
checks if all items have been processed. If not, the processing is looped back, and the next item is processed. Otherwise, the
aggregated message is returned.
Cloud Integration
For a detailed description of the Composed Message Processor pattern on Cloud Integration, see Composed Message
Processor. In the following, only the rough model is outlined.
In the sample integration ow presented in the help documentation, a General Splitter is used to split an order into multiple
individual messages according to the number of items. In the General Splitter property, the Parallel Processing check box is
selected to ensure concurrent processing of the split messages. The Router forwards the items to different inventory systems
depending on the product category where the items are enriched. Finally, the Gather step reaggregates the multiple messages
into a single message.
This is custom documentation. For more information, please visit the SAP Help Portal 88
12/17/2022
Content-Based Routing
The Content-Based Routing pattern is used to route a message to the correct recipient based on its content. The message is
routed to exactly one channel.
static (an XPath condition either based on the payload data or the message header), and
SAP Process Orchestration doesn’t distinguish between the Content-based Router and the Recipient List patterns. While the
former message is routed to exactly one receiver, the latter can broadcast the message to multiple receivers. However, if used
routing conditions are disjoint, each message is routed to exactly one receiver strictly following the de nition of the Content-
based Router. In the example, a static routing condition is used.
Here, the focus is on the Receiver Not Found con guration options. During message processing, the condition is evaluated, and
if met, the message is routed to the respective receiver. If no receiver could be determined, various options to proceed are
available:
raise an error,
In the following example, the latter option is used. The message is discarded without raising an error if neither condition is met.
This is custom documentation. For more information, please visit the SAP Help Portal 89
12/17/2022
Cloud Integration
The Content-based Router pattern is modeled using a router ow step. Like for SAP Process Orchestration, the XPath condition
can be either based on the payload data or the message header. For each of the Receiver Not Found options described above,
SAP has shipped an integration ow variant. For a detailed description of all three variants of the Content-based Router pattern
on Cloud Integration, see Content-Based Routing. The gure in the documentation shows the variant where the message should
be discarded if neither condition is met. For all variants, it’s recommended to store the XPath expression as an Exchange
property, which is then used in the routing conditions. This way, it’s easier to trace the value of the XPath condition in case of
errors. Furthermore, a better runtime behavior can be expected since the message needs to be parsed only once. For each
receiver, the routing condition is con gured accordingly. In addition, we de ne a default route that points to an End event.
Recipient List
The Recipient List pattern is used to route a message to a list of recipients. It's similar to the Content-Based Routing
pattern, but the receiver determination doesn’t rely on the content of the message.
Static (an Xpath condition either based on the payload data or the message header),
This is custom documentation. For more information, please visit the SAP Help Portal 90
12/17/2022
Other than for the Content-Based Router, here the routing conditions don’t have to be disjoint, and hence the same message
may be routed to multiple receivers.
In the following example, we stick to the dynamic routing condition in combination with the receiver wildcard. As you can see in
the gure, we've chosen the Dynamic Message Router as routing technique and have selected the Allow arbitrary receivers
ag.
On the Dynamic Routing tab, a message mapping is selected which is carried out to determine the receivers the message
should be routed to.
For each potential receiver, we need to create a receiver agreement. This way you can add new receivers without the need of
changing and redeploying the integration ow. When selecting the receiver in the integration ow model, in the tab Receivers
you get a list of receiver agreements displayed which t the particular integration ow.
Cloud Integration
The Recipient List pattern is modeled using the same message mapping that we've used for SAP Process Orchestration before.
The message mapping can be imported from SAP Process Orchestration. The message mapping returns a list of receivers,
This is custom documentation. For more information, please visit the SAP Help Portal 91
12/17/2022
which is then split using an Iterating splitter ow step. For each split item, the message is then routed to another integration
ow via Process Direct adapter. The Process Direct address is dynamically determined based on the mapping outcome.
For each potential receiver, we create an own integration ow that would correspond to a receiver agreement in SAP Process
Orchestration. By decoupling the main integration ow from the receiver-speci c message delivery, we don’t need to maintain a
xed number of receivers in the main integration ow. Furthermore, other than for the receiver wildcard in SAP Process
Orchestration, each receiver can have a different receiver-speci c mapping or other receiver-speci c ow steps.
For a detailed description of the Recipient List pattern on Cloud Integration, see Recipient List, which also describes another
variant of the Recipient List pattern with static routing.
Message Filter
The Message Filter pattern is similar to the Content-Based Router pattern . For the Message Filter pattern however, you
only have one single receiver. Any incoming message is evaluated, and if it meets the routing criteria speci ed by the lter, the
message is routed to the receiver, or is discarded otherwise.
Cloud Integration
On Cloud Integration, the Message Filter pattern is modeled using a router ow step with one route pointing to the actual
receiver and a default route pointing to an End event. In our case, messages with the product category Notebooks are routed to
the receiver. Otherwise, the messages are discarded. For a detailed description, see Message Filter.
Content Filter
This is custom documentation. For more information, please visit the SAP Help Portal 92
12/17/2022
The Content Filter pattern is used to remove data from a message that you don't need in your application system. You only
keep the important information.
As illustrated in the following gure, all the header elds are mapped one by one. For the Item node, we check if the Category
equals Notebooks. If so, we create the node, otherwise, the item is discarded. All elds below the Item node are mapped one by
one.
Cloud Integration
On Cloud Integration, there are two options:
Both options are described in Content Filter. The latter option can be resolved by importing the message mapping from Process
Orchestration or modeling it the same way as described in the earlier chapter. In this chapter, the focus is on the second option.
In the integration ow model in the documentation, you can see that we use a Filter ow step where we maintain the XPath
expression. Here, we keep all items with category Software. Value type needs to be nodelist since the XPath expression may
apply to multiple items. The lter removes the purchase order header. So, we need to save this part in an exchange property
using a content modi er, and in another content modi er, we construct the message based on the item list and the stored
header elds.
This is custom documentation. For more information, please visit the SAP Help Portal 93
12/17/2022
Content Enricher
The Content Enricher pattern is used to access an external system in order to add missing data to a message. This process is
also called look-up.
The rst option using a BPM process is described in the blog Enterprise Patterns in Process Orchestration – Content
EnricherOn SAP Process Orchestration, there are two options: . In this example, you rst gather an order list for a speci c
employee. Here, customer details are missing which you need to read from a different system. Therefore, you loop over the list
of orders, and within each loop pass, you do a Web Service call using an automated activity. Within the automated activity, the
additional information is then mapped to the respective order item, hence enriching the message.
For RFC and JDBC lookups, the message mapping tool within the Enterprise Services Repository (ESR) of SAP Process
Orchestration supports standard functions to con gure the lookups. Those functions use the message types stored in the ESR
so that you can simply select the input and output elds when con guring the lookup.
This is custom documentation. For more information, please visit the SAP Help Portal 94
12/17/2022
Cloud Integration
On Cloud Integration, you can model the Content Enricher:
For RFC and JDBC lookups, theIn the example described, a dedicated Content Enricher step was used. The bene t of the
Content Enricher ow step is that it automatically matches the responses to the different items of the original message.
Therefore, it’s suited especially for enriching bulk data. Using this option is better in terms of performance compared to a
request-response pattern. Here, you don’t need to loop over all items carrying out individual lookup calls, but instead do one
call, and the matching is done automatically based on your key.
In the example in the documentation, there's an order with multiple items, including product and product category information.
We perform a lookup to gather the main category names (OData query not displayed), and automatically match them to the
respective item based on the category as the key element.
SFTP Poll-Enrich Interface Development How to utilize this feature to enhance the
SFTP Features
This is custom documentation. For more information, please visit the SAP Help Portal 95
12/17/2022
Cloud Integration Developer Corner Interface Development Updated list on new enhancement and
guidelines from SAP
Asynchronous Messaging Interface Development How to setup and con gure asynchronous
delivery on Cloud Integration
CI/CD for SAP Integration Suite Interface Development Integration ows recipes
This is custom documentation. For more information, please visit the SAP Help Portal 96