SAP Cloud SDK Overview

former_member273171 · ‎05-10-2017

In June 2020 we have launched a brand new documentation portal which consolidates all the knowledge, feature documentation, comprehensive guides, video tutorials, troubleshooting, release notes, API documentation, and more. Please, use it as a single reference point about SAP Cloud SDK. From now on it's the most complete and up-to-date source of information about the product.

Disclaimer: The blog posts mentioned in this overview are only applicable for the SAP Cloud SDK (Java) version of at most 2.19.2. We plan to continuously migrate these blog posts into our List of Tutorials. Feel free to check out our updated Tutorials on the SAP Cloud SDK.

Disclaimer: The SAP Cloud SDK for Continuous Delivery and its features have been merged into project "Piper". Therefore we recommend to use the General Purpose Pipeline of project "Piper" instead of the SAP Cloud SDK pipeline. The reasoning for this change, as well as further information on how to adopt the General Purpose Pipeline are described in this guide.

SAP S/4HANA has become de-facto ERP standard with now more than 5,800 customers worldwide. It accompanies organizations across the world in their digital transformation journey that requires them to adopt best-in-class software with high agility. This is further extended by SAP Cloud Platform that gives developers the power to build and run high-quality applications that conform to the highest order of performance, security and reliability tests.

This is where the SAP Cloud SDK comes in. Making the application development experience delightful, the SDK provides you out-of-the-box capabilities, such as the simplified integration with SAP S/4HANA and Business Suite and beyond using the virtual data model for exposed APIs, abstractions of the underlying cloud platform implementation of SAP Cloud Platform, fault-tolerance, cache management, tutorials, project templates, and many more.

SAP Cloud SDK is based on the SAP S/4HANA Cloud SDK that you might know from the past. We announce this evolution and support of other SAP LoB solutions at SAPPHIRE 2019.
Find more information about this announcement in the following resources:
SAP Cloud SDK on SAP News Center
SAP Cloud SDK technical introduction blog post

The list of supported LoB solutions already includes systems such as SAP SuccessFactors, SAP Business ByDesign, SAP Cloud for Customer, and SAP Cloud for Real Estate. We are working on extending the list of supported systems and on providing users of the SAP Cloud SDK with the comprehensive documentation on the corresponding SDK components.

On a high level, the SAP Cloud SDK consists of two technical components: SAP Cloud SDK libraries and the Continuous Delivery Toolkit. Note, that you can use the SDK libraries in integration with SAP Cloud Application Programming Model, as well as independently with any framework of choice, as depicted in the figure below.

The libraries are provided for Java and for JavaScript/TypeScript in SAP Cloud Platform. The SAP Cloud SDK is available for free under SAP Developer License. Java libraries can be downloaded from Maven Central. JavaScript/TypeScript libraries are available via SAP npm repository, as described in the announcement blog post for the SAP Cloud SDK for JavaScript.

Continuous Delivery Toolkit for projects based on the SAP Cloud SDK is an open-source component and is available via GitHub. Please, refer to the following blog post containing the detailed instructions on how to set up the CI/CD pipeline of the Continuous Delivery Toolkit.

The purpose of this blog post is to provide the step by step hands on guide for developers starting their work with the SAP Cloud SDK and the Continuous Delivery Toolkit.

The table below sums up the resources and tutorial links for languages, currently supported by the SAP Cloud SDK: Java and JavaScript/TypeScript.

	Java	JavaScript/TypeScript
Announcement blog post	Overview of the SDK resources	Announcement of the SAP Cloud SDK for JavaScript
Community update call	Update call on the SDK releases
Overview tutorials	Get Started with the SAP Cloud SDK for Java	Get Started with the SAP Cloud SDK for JavaScript
Specific tutorials	Learn about Other Core Components of the SAP Cloud SDK	Build an Address Manager with the SAP Cloud SDK's OData Virtual Data Model
Deep dives	Specific Technical Topics	Coming soon
Release notes	Release notes for the SAP Cloud SDK (Java)	Release notes for the SAP Cloud SDK (JavaScript)
API documentation	Detailed JavaDoc for the SAP Cloud SDK for Java	API documentation in JSDoc
Example projects	Project examples on GitHub

Community Update Calls on the SAP Cloud SDK

Since December 2018, we are conducting a series of community update calls in addition to our tutorials and blog posts. Here, you can learn more about the latest releases, features of the SAP Cloud SDK, and its integration with other SAP offerings.

It is live sessions, so, you can also ask experts the questions about the releases, roadmap, and specific features of the SAP Cloud SDK that are particularly relevant for your project.

Check out the details and register for the upcoming sessions following the link to this blog post.

Tutorials (JavaScript): Get Started with the SAP Cloud SDK

Tutorials for the SAP Cloud SDK for JavaScript are available via https://developers.sap.com/.

Access individual tutorials following the links below or via the tutorial mission:

Get Set to Use SAP Cloud SDK for JavaScript

Get Started with SAP Cloud SDK for JavaScript

Create Your First Application with SAP Cloud SDK for JavaScript

Deploy Application to Cloud Foundry with SAP Cloud SDK for JavaScript

Tutorials (JavaScript): Build an Address Manager with the SAP Cloud SDK's OData Virtual Data Model

Access individual tutorials following the links below or via the tutorial mission:

Build OData Queries with the SAP Cloud SDK's Virtual Data Model

Use OData Navigation Properties with the SAP Cloud SDK's Virtual Data Model

Create OData Entities with the SAP Cloud SDK's Virtual Data Model

Update OData Entities with the SAP Cloud SDK's Virtual Data Model

Delete OData Entities with the SAP Cloud SDK's Virtual Data Model

Tutorials (Java): Get Started with the SAP Cloud SDK

Step 1 with SAP Cloud SDK: Set up

Step 2 with SAP Cloud SDK: HelloWorld on SCP Neo

Step 3 with SAP Cloud SDK: HelloWorld on SCP CloudFoundry

Step 4 with SAP Cloud SDK: Calling an OData Service

Step 5 with SAP Cloud SDK: Resilience with Hystrix

Step 6 with SAP Cloud SDK: Caching

Step 7 with SAP Cloud SDK: Secure your Application on SAP Cloud Platform, CloudFoundry

Step 8 with SAP Cloud SDK: Secure your Application on SAP Cloud Platform, Neo

Tutorials (Java): Learn about Other Core Components of the SAP Cloud SDK

Deep Dives (Java): Specific Technical Topics

An End-to-End Story on the Virtual Data Model using the Business Partner API

What is what? Your quick reference to Communication Management, and Identity & Access Management Art...

Cloud Platform Abstractions in the SAP Cloud SDK

Continuous Delivery Pipeline for SAP Cloud SDK Based Projects

Executing BAPIs inside S/4HANA On-Premise from your Cloud Application

Extend your Cloud Foundry Application with Tenant-Aware Persistency

S/4HANA Connectivity – Made Simple

Leverage Principal Propagation via OAuth 2 when consuming a Business API from S/4HANA Cloud

Tenant and User Aware Microservices Communication via REST APIs

Generating Java VDM for S/4HANA Custom OData Service

Calling an OData Service from a Web IDE Project using the SAP Cloud SDK

Use the SAP Cloud SDK in the Application Programming Model for SAP Cloud Platform

Quickly build a prototype with SAP Leonardo Machine Learning Foundation, SAP API Business Hub, and S...

Integrate SAP Cloud Platform Blockchain using Hyperledger Fabric into a SAP Cloud SDK application

Production-ready integration of SAP Leonardo Machine Learning Foundation services with an SAP S/4HAN...

An End to End story of the integration of an OData service with SAP Conversational AI (also known as...

Integrate SAP Cloud Platform Blockchain using MultiChain into a SAP Cloud SDK application

Convenient Consumption of SAP S/4HANA SOAP APIs

Experimental serverless CI/CD with SAP Cloud SDK Continuous Delivery Toolkit

Migrate SAP Cloud SDK Based Applications from SAP Cloud Platform Neo Environment to Cloud Foundry

Consuming Messages representing Business Events from SAP S/4HANA Cloud

Access any REST service with the SAP Cloud SDK

Step-by-Step: Consume REST Service API with SAP Cloud SDK

Create an application with SAP Cloud SDK to integrate with SAP SuccessFactors

Releases

With the SAP Cloud SDK, we follow the bi-weekly release strategy. We always recommend to migrate to the newer version of the SDK after its release, as each release enriches the feature set and improves the product. Below you find the links to the release notes providing details on the SAP Cloud SDK releases. Each release is also accompanied with a release blog post, providing more detailed information on the main new features, as well as the information on how to migrate to new versions. You will find links to the corresponding release blog posts in release notes:

Release notes for the SAP Cloud SDK (JavaScript)

Release notes for the SAP Cloud SDK (Java)

In case you have questions to the releases, feel free to join our community update call series where we go through the "what's new" in the SDK and have a dedicated Q&A sessions

Interested to discover more?

We also recommend you the following resources in addition to the tutorials and deep dives:

To learn more about the side-by-side extensibility of SAP S/4HANA, join our free Open SAP Course.

To dig deeper into the introduced topics, check out the book "Extending SAP S/4HANA".

Technical troubleshooting and Q&A: Feel free to reach out to us on StackOverflow via our sap-cloud-sdk tag. We actively monitor this tag in our core engineering teams. You can also leave us a comment or a question in SAP Community using the SAP Cloud SDK tag.