btp-cloud-connector-setup-automation
A Yeoman generator that adds the Cloud ConnectorCloud ConnectorSAP's on-premises agent that links SAP BTP applications to systems in a customer's own network, as a reverse invoke proxy that exposes only the systems and resources it is configured to allow.sap official, btp system mappings for an XS Advanced system and writes the matching SAP BTP destination files.
Reaching an XS Advanced system from SAP Business Application StudioSAP Business Application StudioSAP's development environment for business applications, delivered as a cloud service and opened in a browser, where work happens in preconfigured dev spaces.sap official, btp means creating Cloud Connector system mappings by hand and then building matching destination files for the subaccount. Running yo bas-xsa-connectivity asks for the Cloud Connector login URL, username, password and location ID, the SAP BTP subaccount region and ID, and a directory for the output; it then adds the system mappings and resources Business Application Studio needs, and writes the destination files into that directory. Importing those files under Connectivity > Destinations in the subaccount is still a manual step.
Facts
Where it sits
Who is behind it
In the atlas: maintains 222@SAP-samplesmaintainerJonathan BreglerContributes to this
In the atlas: contributes to 3@breglerjBrian BernardContributes to this
In the atlas: contributes to 64@btbernardSushil JainContributes to this
In the atlas: contributes to 2@sushiljain013 contributors
What it declares
Every artifact
- Type
- Generator
- Origin
- By SAP
- Runtime
- Node.js
As a generator
- Generates
- Configuration
- Run with
- Yeoman
- Distributed through
- does not say
Connections
Reaching remote systems without addresses or credentials in the code
SAP's on-premises agent linking SAP BTP to customer-network systems
SAP's on-premises agent linking SAP BTP to customer-network systems
A cross-platform JavaScript runtime that servers, command line tools and scripts written in JavaScript are run with. For the things here, the prerequisite a repository names when its build is a set of npm scripts.
Download
README
quoted from SAP-samples/btp-cloud-connector-setup-automation under Apache-2.0, readSAP BTP Cloud Connector Setup Automation
Description
This Yeoman generator helps you connect to a SAP BTP Subaccount in Cloud connector, add necessary System Mappings and resources to work access XS Advanced Systems in SAP Business Application Studio (BAS), and generate files for import in SAP BTP Destinations.
Requirements
- Node.js v18.14.2
- Yeoman - If not installed, install it using
npm install -g yo - XS Advanced CLI client
- Cloud Connector is installed
- Ensure you're logged in and the target space is SAP.
- You've connected to your SAP BTP Subaccount
Download and Installation
First, build and install the generator using npm:
npm install && npm linkUsage
To start the generator, navigate to the directory where you want to generate your project and run:
yo bas-xsa-connectivityYou will be prompted to enter the following information:
- Cloud Connector Login Url
- Cloud Connector Username
- Cloud Connector Password
- Cloud Connector Location ID
- SAP BTP Subaccount Region
- SAP BTP Subaccount ID
- Directory for Destination Files
Once you have entered the required information, the generator will perform the following tasks:
- Add necessary System Mappings and resources to work access XS Advanced Systems in SAP Business Application Studio (BAS)
- Generate files for import in SAP BTP Destinations
After the generator completes its tasks, you should see your new files in the directory you specified. Import these files in your BTP Subaccount > Connectivity > Destinations
Known Issues
How to obtain support
Create an issue in this repository if you find a bug or have questions about the content.
For additional support, ask a question in SAP Community.
Contributing
If you wish to contribute code, offer fixes or improvements, please send a pull request. Due to legal reasons, contributors will be asked to accept a DCO when they create the first pull request to this project. This happens in an automated fashion during the submission process. SAP uses the standard DCO text of the Linux Foundation.
License
Copyright (c) 2024-2026 SAP SE or an SAP affiliate company. All rights reserved. This project is licensed under the Apache Software License, version 2.0 except as noted otherwise in the LICENSE file.
Others providing
Compare all 15 on the Destinations page →- SAP Destination serviceSAP Destination serviceNamed, credentialed addresses of other systems, resolved at runtime — so an application holds no URL and no secret of its own, and the same code reaches a different system in every landscape.sap official, btpNamed, credentialed addresses of other systems resolved at runtimefrom BTP/BAIP
- SAP Private Link ServiceSAP Private Link ServiceA private network connection between a selected SAP BTP service and a selected service in an application's own account with a partner cloud provider, so the traffic between them never touches the public internet.sap official, btpPrivate network link between a BTP service and a partner cloudfrom BTP/BAIP
- com.sap.cds:cds-feature-remote-odatacom.sap.cds:cds-feature-remote-odataA CAP Java feature for consuming remote OData V2 and V4 services as Remote Services, translating CQN queries into OData requests against a destination or a service binding.sap official, capRemote Services for consuming OData V2 and V4 APIs in CAP Javafrom CAP
- com.sap.cds:cds-integration-cloud-sdkcom.sap.cds:cds-integration-cloud-sdkA CAP Java feature that integrates the SAP Cloud SDK, so features such as remote OData and enterprise messaging resolve a destination or service binding and reach a remote REST-based service.sap official, capSAP Cloud SDK integration for remote REST services in CAP Javafrom CAP
- capire/s4capire/s4A pre-built integration package for SAP S/4HANA, holding the imported service definitions a CAP project would otherwise generate for itself.sap official, capPrebuilt SAP S/4HANA integration package for CAP projectsfrom CAP
- cdsecdseResolves a destination from a CAP project's own configuration, then makes the outbound call with axios: the url, the method and the body are written at the call site.independent, capDestination resolution and axios calls from CAP configurationfrom CAP
- @sap/cds@sap/cdsThe CAP Node.js runtime, which compiles the CDS model, serves the services declared in it, answers generic requests before any handler runs, and loads every cds-plugin.sap official, capCAP Node.js runtimefrom CAP
- @sap-cloud-sdk/connectivity@sap-cloud-sdk/connectivityDestination lookup and the connectivity proxy — the package that turns a destination name into a reachable endpoint with credentials attached.sap official, capDestination lookup and connectivity proxy for the Cloud SDKfrom CAP
- @sap-cloud-sdk/http-client@sap-cloud-sdk/http-clientThe HTTP client that carries a destination's credentials, so an outbound call inherits the authentication rather than assembling it.sap official, capHTTP client carrying a destination's credentialsfrom CAP
- @sap-cloud-sdk/odata-common@sap-cloud-sdk/odata-commonThe shared machinery under the SDK's OData and OpenAPI client generators; a dependency of the generated clients rather than something written against directly.sap official, capShared machinery under the Cloud SDK's OData and OpenAPI clientsfrom CAP
- @sap-cloud-sdk/openapi@sap-cloud-sdk/openapiGenerated OpenAPI clients for the Cloud SDK, so a REST API described by a specification is called through typed functions.sap official, capGenerated OpenAPI clients for the Cloud SDKfrom CAP
- @sap-cloud-sdk/resilience@sap-cloud-sdk/resilienceTimeouts, retries and circuit breaking around a remote call, so one slow downstream system does not take the application with it.sap official, capTimeouts, retries and circuit breaking around remote callsfrom CAP
- @sap-cloud-sdk/util@sap-cloud-sdk/utilGeneral utilities shared across the Cloud SDK packages — a dependency, not a thing to reach for on its own.sap official, capGeneral utilities shared across the Cloud SDK packagesfrom CAP
- @sapmentors/cds-scp-api@sapmentors/cds-scp-apiA Node module for CAP that calls an external API through a destination instead of a hardcoded endpoint, taking its address, credentials and on-premise tunnel from the SAP Destination and Connectivity services.community org, capNode module for CAP calling external APIs through a destinationfrom CAP
Details
Sources
Sources are graph entities: the same page may back several entries, and an unreachable source flags every row that rests on it.
Compatibility and provenance
Contributors
History in the atlas
- First seen.
For your agent
- Ref
artifact:sap-samples-btp-cloud-connector-setup-automation- JSON
- /artifacts/sap-samples-btp-cloud-connector-setup-automation.json
- MCP
- Connecting an agent