SAP BTP and SAP CPI Basics: Palette, Adapters and Every Option in the Cockpit

A beginner-friendly tour of SAP BTP and SAP Cloud Integration: how BTP is organised, every area of the cockpit, the integration flow palette and the adapters you will use most.

What Is SAP BTP?

SAP Business Technology Platform (SAP BTP) is SAP's cloud platform. It brings services for integration, data and analytics, application development and automation into one place. You do not install SAP CPI on a server. You subscribe to it as a service on SAP BTP, and SAP runs it for you.

To feel comfortable in the cockpit, you only need to understand how BTP is organised:

  • Global account – the top level. It is created when your company contracts SAP BTP, or when you start a trial. It contains your subaccounts.
  • Subaccount – where the real work happens. Each subaccount sits in one region on one cloud provider. You subscribe to applications, create service instances and manage users here.
  • Entitlements – what your global account is allowed to use. A service must be entitled to a subaccount before you can use it there.
  • Subscriptions and instances – what you actually use. Software-as-a-service applications such as SAP Integration Suite appear as subscriptions. Services that other tools call appear as service instances, and each instance can have service keys (credentials).
  • Environments – for example Cloud Foundry, which groups instances into orgs and spaces. On a current tenant, SAP Cloud Integration typically runs with the Cloud Foundry environment.
SAP BTP structure: global account, subaccount, subscriptions, Cloud Foundry environment and securityGlobal accountyour company's SAP BTP contract (or your trial)Subaccountone region, one cloud providerSubscriptionsSAP Integration Suite(an application you openwith “Go to Application”)Cloud Foundry environmentOrg → SpaceService instances, for exampleProcess Integration Runtimewith service keys (credentials)SecurityUsers and role collectionsdecide who may design,deploy and monitor
Figure 1: How SAP BTP is organised, and where Integration Suite sits.
Consultant Tip

You will use the Instances and Subscriptions page of the subaccount again and again. It is where you open Integration Suite, and also where you create the service instance and key that Postman needs to call your integration flows (we do this in article 3).

SAP Integration Suite and Where CPI Fits

"CPI" stands for Cloud Platform Integration. The product started as SAP HANA Cloud Integration, became SAP Cloud Platform Integration, and is now delivered as the Cloud Integration capability of SAP Integration Suite. Everybody still says "CPI", and you will meet all of these names in blogs, job descriptions and interviews.

SAP Integration Suite bundles several capabilities. The tiles you see on its home page depend on what has been activated for your tenant.

CapabilityWhat it is for
Cloud IntegrationBuild, run and monitor integration flows that connect cloud and on-premise systems. This is what this series covers.
API ManagementDesign, secure, publish, monitor and retire APIs, with policies for authentication and traffic control.
Open ConnectorsPrebuilt connectors for many third-party cloud applications.
Integration AdvisorHelps design B2B and industry-standard message interfaces and mappings, using a knowledge base and machine learning.
Trading Partner ManagementManage partner profiles, agreements and communication settings for B2B scenarios.
Event MeshPublish and consume business events for event-driven scenarios.
Integration AssessmentHelps decide which integration technology and pattern fits a requirement.
Migration AssessmentEstimates the effort to move SAP Process Orchestration scenarios to Integration Suite. It does not perform the migration itself.
OData ProvisioningPublishes OData services so business data is easy to consume.
GraphLets applications work with business data from several SAP solutions through one data model.

SAP adds and renames capabilities over time, so always compare this list with your own home page. When a job advert says "CPI", it almost always means the Cloud Integration capability.

How to Open SAP CPI From the BTP Cockpit

  1. Log in to the SAP BTP cockpit and open your global account, then your subaccount.
  2. In the left menu choose Instances and Subscriptions.
  3. Under Subscriptions, find Integration Suite and choose Go to Application.
  4. On the Integration Suite home page, look at the Capabilities tiles and open Cloud Integration.

If you cannot see Integration Suite, either it is not subscribed in that subaccount or your user is missing role collections, which your BTP administrator assigns. To practise, SAP offers a free trial account, and its tutorials explain how to enable Cloud Integration there.

Every Area of the Cloud Integration Cockpit

The left-hand menu of Cloud Integration has four main areas: Discover, Design, Monitor and Settings. SAP changes names and adds entries between releases, so treat this section as a map rather than a promise.

Discover – ready-made content

Discover lists prebuilt integration packages from SAP and partners, for example for SuccessFactors, S/4HANA or Ariba. You copy a package into your own workspace and configure it, instead of building everything from nothing. Always check how recent a package is before you use it in a project.

Design – where you build

  • Integration package – a container that groups related artifacts. You create it under Design → Integrations and APIs.
  • Artifacts tab – lists everything inside the package. Choose Add to create an Integration Flow, a Value Mapping, an API artifact (OData, REST or SOAP) or a Script Collection for shared scripts.
  • Edit, Save, Deploy – you edit a flow in the graphical editor, save a version, then deploy it so it runs on the tenant.
  • Configure – lets you change externalised parameters (such as URLs and credential names) without editing the flow. This is how the same flow moves from test to production.

Monitor – where you operate and troubleshoot

TileWhat you do with it
Monitor Message ProcessingSee every message processed on the tenant, with its status (for example Completed, Processing, Retry, Escalated, Failed, Abandoned), and open its processing log.
Manage Integration ContentSee deployed integration flows and APIs, their status and endpoint URLs. Change the log level, download or undeploy.
Security MaterialDeploy security artifacts that flows need, such as user credentials, OAuth2 client credentials and PGP keyrings.
KeystoreManage the tenant keystore: key pairs and certificates used for certificate-based security. Check validity dates here.
Connectivity TestsTest outbound connections from your tenant to a receiver system (availability can depend on your release and environment).
Access Policies, User Roles, JDBC MaterialRestrict access to artifacts, define your own roles for sender authorisation, and define database connections for the JDBC adapter. Exact tiles vary by release.
Data StoresTemporary data that flows save with the Data Store Operations step.
VariablesValues that flows keep between runs (for example a "last run time").
Message QueuesJMS queues for asynchronous, reliable processing.
Number RangesUnique sequence numbers, mainly used in EDI and B2B scenarios.
Access LogsReview access to tenant resources, which helps with security and compliance.
Manage LocksSee and release message locks that stop the same message from being processed twice at the same time.
Log levels

Each deployed flow has a log level. Info is enough for daily operation. Debug and Trace show far more detail and can capture message content, so use them only for short troubleshooting sessions and never leave them on for sensitive production data.

Settings – tenant-level configuration

Settings holds tenant-wide configuration. The entries depend on your role and release, so open it once in your own tenant to see what is available to you.

Inside an Integration Flow

An integration flow (iFlow) is a visual pipeline. A message enters through a sender channel, passes through processing steps and leaves through a receiver channel. Three words matter:

  • Sender – the system that sends a message to CPI. The connection is called the sender channel and uses a sender adapter.
  • Integration Process – the processing area in the middle, where steps change, route or enrich the message.
  • Receiver – a system that CPI sends a message to or calls. The connection is a receiver channel with a receiver adapter.
Message path in an integration flow from sender through the integration process to the receiverSendersource systemSenderadapterIntegration ProcessContentModifierMappingRoutersteps change, route or enrich the messageReceiveradapterReceivertarget systemA message = body + headers + properties (+ attachments)
Figure 2: Sender, adapters, integration process and receiver.

While a message is processed it has four parts that you will meet in almost every step:

  • Body (payload) – the content itself, for example XML or JSON.
  • Headers – key and value pairs that travel with the message. Adapters can pass allowed headers on to the receiver.
  • Properties – key and value pairs that exist only while the message is processed inside CPI. The receiver never sees them.
  • Attachments – extra content attached to the message. Used less often.

SAP Cloud Integration is built on Apache Camel, which is why expressions such as ${header.OrderID} or ${property.Counter} (Camel Simple language) appear in steps.

The Palette: Every Step Group

When you edit a flow, the palette above the model lists the building blocks. Each icon opens a group of steps.

Palette groupSteps insideUsed for
ParticipantsSender, ReceiverRepresent the external systems your flow talks to.
ProcessIntegration Process, Local Integration Process, Exception SubprocessThe main flow, reusable sub-flows and error handling.
EventsStart Message, Timer Start, Error Start, End Message, Error End, Escalation End, Terminate MessageWhere a flow starts and ends, scheduling, and ending a flow on purpose.
MappingMessage Mapping, XSLT Mapping (plus ID Mapping and Operation Mapping for special cases)Convert one structure into another.
Message TransformersContent Modifier, Converter, Decoder, Encoder, Filter, Message Digest, Script, XML ModifierChange the body, headers and properties; convert formats; run Groovy or JavaScript.
CallExternal Call (Request Reply, Content Enricher, Poll Enrich, Send) and Local Call (Process Call)Call other systems or sub-processes.
Message RoutingRouter, Multicast, Splitter, Join, Gather, AggregatorChoose paths, send to several receivers, split and merge messages.
Security ElementsEncryptor, Decryptor, Signer, VerifierEncrypt, decrypt, sign and verify messages.
PersistenceData Store Operations, Persist Message, Write VariablesKeep data between steps or between runs.
Message ValidatorsXML ValidatorCheck that XML follows a schema.

Besides the groups, the palette has tools to copy and paste, delete, draw connections, search for a step, and run a simulation to test the flow. These are the steps you will use first:

  • Content Modifier – set or change the body, headers and properties. You will use it in almost every flow.
  • Converter – convert between CSV, JSON, XML and EDI formats.
  • Encoder and Decoder – Base64, GZIP, ZIP and MIME multipart.
  • Script – Groovy or JavaScript for logic standard steps cannot do. Try standard steps first.
  • Router – send the message down different paths based on conditions, like if / else.
  • Splitter, Gather, Aggregator – break one large message into many, and join results back together.
  • Multicast – send the same message to several branches, in parallel or in sequence.
  • Request Reply – call a receiver and wait for its answer.
  • Send – send a message and carry on without waiting for an answer.
  • Content Enricher – call a service and merge its answer into the current message.
  • Data Store Operations and Write Variables – save data for later steps or later runs.

Adapters: How CPI Connects to Other Systems

An adapter is a connector that understands one protocol or application. You choose it when you draw a connection line from a sender to the start of the flow, or from a call step to a receiver.

Direction matters. A sender adapter opens an endpoint, or polls a source, so that a message can enter your flow. A receiver adapter sends a message to a target. Some adapters work in both directions and some in only one. For example, HTTPS is a sender adapter, while HTTP is a receiver adapter.

AdapterDirectionTypical use
HTTPSSenderExpose an HTTPS endpoint so tools such as Postman, or other systems, can call your flow.
HTTPReceiverCall any REST or HTTP service.
SOAP (SOAP 1.x)Sender and receiverWeb-service (SOAP) integrations.
OData (V2 and V4)Sender and receiverExpose or call OData services.
IDocSender and receiverExchange IDocs with SAP ERP systems.
RFCReceiverCall function modules in SAP systems.
SFTPSender and receiverRead and write files on SFTP servers.
MailSender and receiverRead emails (IMAP or POP3) or send emails (SMTP).
JDBCReceiverRead from and write to relational databases.
JMSSender and receiverAsynchronous messaging with queues on the tenant.
Kafka and AMQPSender and receiverEvent streaming and messaging brokers.
AS2 and AS4Sender and receiverB2B document exchange with partners.
XISender and receiverCommunicate with SAP PI / PO systems.
ProcessDirectSender and receiverCall one integration flow from another on the same tenant.
LDAPReceiverRead from directory servers.
SuccessFactorsSOAP, REST, OData V2 and OData V4 variantsConnect to SAP SuccessFactors, for example in Employee Central integrations.
Application adaptersVariesOpen Connectors, Ariba, Salesforce, ServiceNow and others for specific applications.

SAP adds and retires adapters over time, and the available versions depend on your tenant. Always check the connectivity options in SAP Help for the current list.

How to choose an adapter

Ask three questions:

  1. Which protocol or application does the other system speak?
  2. Does the other system send to CPI (sender) or does CPI call it (receiver)?
  3. How is the connection secured: basic authentication, OAuth or certificates?

Receiver adapters usually need credentials in Security Material and trusted certificates in the Keystore. Keep that in mind when a call fails with a connection or certificate error.

Consultant Tip for SuccessFactors

For Employee Central integrations you will mostly use the SuccessFactors adapters. Before you choose between SOAP and OData, check SAP's current API guidance, because SAP recommends different APIs for new work than for older integrations.

A Message's Journey Through CPI

  1. A system calls the endpoint created by the sender adapter.
  2. CPI checks who is calling and whether that caller has the required role.
  3. CPI creates a message with a body, headers and properties.
  4. The message passes through the steps: modify, map, route, call, and so on.
  5. A receiver adapter sends the result to the target system.
  6. For synchronous calls, the answer travels back to the original sender.
  7. CPI writes a message processing log, which you can open under Monitor.

Interview Questions

1. What is the difference between SAP CPI and SAP Integration Suite?

Cloud Integration (CPI) is one capability of SAP Integration Suite. The suite also contains capabilities such as API Management, Open Connectors, Integration Advisor and Trading Partner Management.

2. What is the difference between a sender adapter and a receiver adapter?

A sender adapter lets a message enter the flow, either by opening an endpoint or by polling a source. A receiver adapter sends a message from the flow to a target system.

3. What is the difference between a header and a property?

A header travels with the message and can be passed to the receiver by the adapter. A property exists only while CPI processes the message and is never sent to the receiver.

4. Where do you check a failed message?

Under Monitor, open Monitor Message Processing, filter for the failed message and open its processing log. Raising the log level of the flow temporarily gives more detail.

Frequently Asked Questions

Is SAP CPI the same as SAP PI / PO?

No. SAP PI / PO is an on-premise integration platform. CPI is cloud-based and is delivered as part of SAP Integration Suite. Many companies move scenarios from PI / PO to the cloud.

Do I need to know programming to learn CPI?

Most of the work is graphical configuration. Basic Groovy scripting helps for advanced requirements, and you can learn it later.

Can I practise for free?

SAP offers a free trial on SAP BTP where you can enable Cloud Integration. Check SAP's current trial terms, because they change from time to time.

Conclusion

You now have the map: SAP BTP hosts Integration Suite, Cloud Integration is one capability inside it, the cockpit is split into Discover, Design, Monitor and Settings, and every flow is built from sender, steps and receiver connected through adapters. The next articles use this map to explain why companies use CPI and then build your first flow.

SAPwithSAI

Practical SAP SuccessFactors Employee Central and SAP CPI learning for consultants.