Frequently asked questions

Generic questions#

Is SAP Cloud SDK for JavaScript Open Source#

Yes. The SAP Cloud SDK for JavaScript is Open Source and available under the Apache 2.0 license. You can find the source code on Github and the modules on NPM. The SAP Cloud SDK command-line interface resides in a separate Github repository.

What is Virtual Data Model?#

In simple words, Virtual Data Model is a nick-name for pre-generated type-safe client libraries for allowlisted OData services of SAP S/4HANA Cloud. These libraries are a part of SAP Cloud SDK for JavaScript but they are not Open Source and shipped under SAP Developer license. Libraries are updated with every release of S/4HANA Cloud and you can always find them on NPM

Do you continue developing of the SDK for JavaScript?#

The SAP cloud SDK for JavaScript is developed and maintained by the experienced team at SAP. Publishing the SDK as Open Source allows anyone to benefit from library value adds, instantly contribute new functionality, faster fix issues, and speed up feature development.

Can I contribute to the SAP Cloud SDK for JavaScript?#

We are happy to accept and review your valuable contribution. For details on contributing check our contribution guide

How often do you release a new SDK version?#

We usually release bi-weekly. All features that are in Generally Available or Beta state get into the next release.

Pre-generated type-safe client libraries are released quarterly to follow the SAP S/4HANA Cloud release cycle.

Do you release hotfixes?#

Yes, we do. They usually have a higher patch number according to semver, i.e: 1.24.1 instead of 1.24.0. Check our release notes for more details.

Should I update with every release?#

The general recommendation is YES. This way you'll reduce the effort to keep up with the fast pace of cloud development. We try to keep stable functionality consistent and explicitly notify about breaking changes. Be cautious about using features annotated as Beta because their API can change with every release.

Which Node versions are supported by the SDK?#

We support and recommend the latest active LTS version of Node. You can try using a later Node version on your own risk.

Can I use features annotated as Beta in production?#

We do not recommend using API that is marked unstable in productive code. We do not guarantee any API compatibility for future updates and the features might be experimental. You can use these features to test cutting edge functionality, provide us feedback, and plan migration steps when Beta features are releases as General Availability.

I think I found a bug in the SDK, what should I do?#

Please, report it to us through any available channel. The preferred support channel is Github.

I'm creating a BCP incident, what's your component name?#

Choose XX-S4C-SDK if you are reporting an issue via BCP.

OData related questions#

What versions of OData protocol do you support?#

We support OData v2 and OData v4 services. You can use pre-generated client libraries supplied with SDK or generate your client from the SDK specification. Find more details here.

Do you support ALL OData features?#

We support most of the OData features that are exposed by SAP services. However, the OData specification is huge and contains many features that would see rare to no use. If you found a feature that you need but it is not yet supported by Cloud SDK for Java, please, make a feature request via Github

I receive an OData error/exception when using Cloud SDK for JavaScript#

You may see some errors while developing. These errors are not always caused by flaws in the SDK as we often see inconsistent OData protocol handling by different services. Some of them even have known flaws for which we have workarounds. If you can't solve your issue via debugging and experimenting, please, report your incident via Stack Overflow or Github.

REST related questions#

Do you support REST client libraries?#

We're working on it. The current support is experimental and not ready for production use.

Questions about SAP Cloud Platform#

Do you support SAP Cloud Platform - Cloud Foundry?#

SAP Cloud SDK for JavaScript has first-class support for SCP Cloud Foundry. We provide plenty of helpful abstractions for connectivity and authentication that make developing Apps a pleasant and rewarding experience. Let us know if you're missing any features about SCP Cloud Foundry support from SAP Cloud SDK for JavaScript.

Last updated on by Marika Marszalkowski