You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
description: "Learn about the Camunda SAP Business Technology Platform (BTP) integration, an artifact run on BTP."
2
+
id: btp-plugin
3
+
title: SAP BTP plugin
4
+
description: "Learn about the Camunda SAP Business Technology Platform (BTP) plugin, an artifact run on BTP."
5
5
---
6
6
7
-
The Camunda SAP Business Technology Platform (BTP) integration is an artifact run on BTP. This connects to Camunda 8 SaaS to provide:
7
+
The Camunda SAP Business Technology Platform (BTP) plugin is an artifact run on BTP. This connects to Camunda 8 SaaS to provide:
8
8
9
9
- A generic Fiori app for starting BPMN processes and displaying [Camunda Forms](/components/modeler/forms/camunda-forms-reference.md) in the Fiori design language.
10
10
- The select exposure of SAP BTP services to [BPMN tasks](/components/modeler/bpmn/bpmn.md) and vice versa.
11
11
- A generic endpoint to start BPMN processes with.
12
12
13
13
:::note Important!
14
-
The SAP BTP integration is an alpha feature available upon request. Visit [our contact page](/reference/contact.md) to contact us.
14
+
The SAP BTP plugin is an alpha feature available upon request. Visit [our contact page](/reference/contact.md) to contact us.
Copy file name to clipboardexpand all lines: docs/components/early-access/alpha/sap/camunda-sap-integration.md
+6-5
Original file line number
Diff line number
Diff line change
@@ -1,14 +1,14 @@
1
1
---
2
2
id: sap-integration
3
3
title: SAP integration
4
-
description: "Camunda's SAP integration consists of several features that can be used independently of one another: SAP OData, RFC, and BTP."
4
+
description: "Camunda's SAP integration consists of several modules that can be used independently of one another: SAP OData, RFC, and BTP."
5
5
---
6
6
7
-
Camunda's SAP integration consists of several features that can be used independently of one another: SAP OData, RFC, and BTP.
7
+
Camunda's SAP integration consists of several modules that can be used independently of one another: SAP OData, RFC, and BTP.
8
8
9
-
-[SAP OData Connector](./odata-connector.md): Interact with a S/4HANA or ECC System via OData v2 + v4 APIs, directly from your BPMN model.
9
+
-[SAP OData outbound Connector](./odata-connector.md): Interact with a S/4HANA or ECC System via OData v2 + v4 APIs, directly from your BPMN model.
10
10
-[SAP RFC outbound Connector](./rfc-connector.md): Query BAPIs and remote-enabled function modules on SAP ECC systems.
11
-
-[SAP BTP integration](./btp-integration.md)
11
+
-[SAP BTP plugin](./btp-plugin.md)
12
12
- Use [Tasklist's](/components/tasklist/introduction-to-tasklist.md) forms in the Fiori UI
13
13
- Operate SAP BTP services from [BPMN tasks](/components/modeler/bpmn/bpmn.md)
14
14
- Inbound proxy endpoint to start process instances of BPMN models, including custom variables
@@ -21,6 +21,7 @@ These features run in the customer's [SAP BTP instance](https://www.sap.com/prod
21
21
22
22
All SAP integration artifacts have the following technical requirements:
23
23
24
+
- Camunda version 8.5+
24
25
- They run on SAP BTP, Cloud Foundry environment, and thus [need the respective service](https://discovery-center.cloud.sap/serviceCatalog/cloud-foundry-runtime?region=all).
25
26
-[(free) Destination Service](https://discovery-center.cloud.sap/serviceCatalog/destination?region=all&service_plan=lite&commercialModel=btpea) for system and service connectivity.
26
27
- If the S/4 or ECC system is located on-premises:
@@ -41,6 +42,6 @@ No additional requirements.
41
42
-[(free) SAP Authorization and Trust Management Service](https://discovery-center.cloud.sap/serviceCatalog/authorization-and-trust-management-service?region=all)
42
43
-[PostgreSQL on SAP BTP, hyperscaler option](https://discovery-center.cloud.sap/serviceCatalog/postgresql-hyperscaler-option?region=all)
43
44
44
-
For scaling out and up, either add multiple instances of an integration module (for example, the SAP OData Connector) or equip an integration module with more runtime memory (for example, the SAP BTP integration).
45
+
For scaling out and up, either add multiple instances of an integration module (for example, the SAP OData Connector) or equip an integration module with more runtime memory (for example, the SAP BTP plugin).
45
46
46
47
For more sophisticated tuning, all mechanisms of BTP can be applied (such as the [(free) Application Autoscaler](https://discovery-center.cloud.sap/serviceCatalog/application-autoscaler?service_plan=standard®ion=all&commercialModel=btpea)), as all SAP integration artifacts fully adhere to the BTP cloud-based development standards and can be fully configured just as any custom developed apps on BTP.
Copy file name to clipboardexpand all lines: docs/components/early-access/alpha/sap/odata-connector.md
+12-5
Original file line number
Diff line number
Diff line change
@@ -50,21 +50,28 @@ Currently, only `BasicAuthentication` is supported on the Destination by the SAP
50
50
51
51
A descriptor file is required to deploy the SAP OData Connector to a space in a SAP BTP subaccount. An exemplary deployment descriptor `mtad.yaml.example` is provided by Camunda. This is a standard format in SAP BTP's Cloud Foundry environment to describe the application that needs deployment. Take the following steps:
52
52
53
-
1. Adjust the values to match those of the targeted Camunda 8 SaaS environment and rename it to `mtad.yaml`.
54
-
2. Adjust the names of the SAP BTP Destination and Connectivity instances to your liking - both will be created automatically for you upon deployment. If instances in your subaccount of any of the two services exist, they will be reused.
55
-
3. After creating the `mtad.yaml` file, log into the desired SAP BTP subaccount via the [Cloud Foundry `cli`](https://github.com/cloudfoundry/cli) (cf-cli):
53
+
1. Find the matching [Docker image](https://hub.docker.com/r/camunda/sap-odata-connector/tags) for the targeted Camunda 8 SaaS version.
54
+
The version follows the format `<C8 version major>.<C8 version minor>.<OData connector version>`.
55
+
Examples:
56
+
57
+
-`8.6.0` is the OData Connector in version `0` for C8 SaaS version `8.6`
58
+
-`8.5.1` is the OData Connector in version `1` for C8 SaaS version `8.5`
59
+
60
+
2. Adjust the values for the credentials (client ID, client secret, etc.) to match those of the API client of the targeted Camunda 8 SaaS environment and rename it to `mtad.yaml`.
61
+
3. Adjust the names of the SAP BTP Destination and Connectivity instances to your liking - both will be created automatically for you upon deployment. If instances of the same name in your subaccount of any of the two services exist, they will be reused.
62
+
4. After creating the `mtad.yaml` file, log into the desired SAP BTP subaccount via the [Cloud Foundry `cli`](https://github.com/cloudfoundry/cli) (cf-cli):
56
63
57
64
```shell
58
65
$> cf login
59
66
API endpoint: https://api.cf. ...
60
67
...
61
68
```
62
69
63
-
4. Deploy the SAP OData Connector via the `cf-cli`. Note that this requires [the "multiapps" plugin of Cloud Foundry](https://github.com/cloudfoundry/multiapps-cli-plugin) to be installed on the machine the deployment runs on:
70
+
5. Deploy the SAP OData Connector via the `cf-cli`. Note that this requires [the "multiapps" plugin of Cloud Foundry](https://github.com/cloudfoundry/multiapps-cli-plugin) to be installed on the machine the deployment runs on:
64
71
65
72
```shell
66
73
$> cf deploy ./ # append the -f flag to shortcircuit ongoing deployments
67
-
Deploying multi-target app archive /Some/path/sap-odata-connector.mtarin org <your-org> / space <your-space> as you@example.org ..
74
+
Deploying multi-target app archive /some/path/sap-odata-connector in org <your-org> / space <your-space> as you@example.org ..
68
75
...
69
76
Application "sap-odata-connector" started and available at "some.url.hana.ondemand.com"
Copy file name to clipboardexpand all lines: docs/components/early-access/alpha/sap/rfc-connector.md
+15-36
Original file line number
Diff line number
Diff line change
@@ -4,7 +4,7 @@ title: SAP RFC Connector
4
4
description: "The SAP RFC Connector is a Java Spring Boot application that runs on SAP BTP."
5
5
---
6
6
7
-
The SAP RFC [Connector](/components/connectors/introduction.md) is a [protocol and outbound Connector](/components/connectors/connector-types.md). This Connector is a Java Spring Boot application that runs on SAP Business Technology Platform (BTP).
7
+
The SAP RFC [Connector](/components/connectors/introduction.md) is a [protocol and outbound Connector](/components/connectors/connector-types.md). This Connector is a Java Spring Boot application that runs as a `.war`on SAP Business Technology Platform (BTP).
8
8
9
9
It connects to Camunda 8 SaaS, and utilizes SAP BTP's [Destination](https://learning.sap.com/learning-journeys/administrating-sap-business-technology-platform/using-destinations) and [Connectivity](https://help.sap.com/docs/connectivity/sap-btp-connectivity-cf/what-is-sap-btp-connectivity) concepts to query a SAP system via the RFC protocol to interact with remote-enabled Function Modules and BAPIs.
10
10
@@ -20,7 +20,7 @@ For a standard overview of the steps involved in the SAP RFC Connector, see the
20
20
21
21
## Prerequisites
22
22
23
-
To run the SAP RFC Connector Docker image, the following SAP infrastructure setup is required:
23
+
To run the SAP RFC Connector, the following SAP infrastructure setup is required:
24
24
25
25
-[Cloud Foundry CLI](https://github.com/cloudfoundry/cli) with the [multiapps plugin](https://github.com/cloudfoundry/multiapps-cli-plugin) installed on the machine executing the deployment.
26
26
- SAP BTP subaccount with a [Cloud Foundry environment](https://discovery-center.cloud.sap/serviceCatalog/cloud-foundry-runtime?region=all) enabled and a [created space](https://help.sap.com/docs/btp/sap-business-technology-platform/create-spaces).
@@ -35,54 +35,33 @@ To run the SAP RFC Connector Docker image, the following SAP infrastructure setu
35
35
36
36
## Deployment to BTP
37
37
38
-
Unlike other Camunda Connectors, the SAP RFC Connector must be deployed as a Java application. This is because it uses SAP's [JCo Java library](https://support.sap.com/en/product/connectors/jco.html) to connect via RFC to the configured SAP system. You must build the application yourself as the JCo library's license prohibits redistribution, so Camunda cannot pre-build it for you.
38
+
Unlike other Camunda Connectors, the SAP RFC Connector must be deployed as a Java `.war` archive. This is because it uses SAP's [JCo Java library](https://support.sap.com/en/product/connectors/jco.html) to connect via RFC to the configured SAP system. the JCo library's license prohibits redistribution, but it is available at runtime on BTP and auto-discovered by Camunda's RFC Connector.
39
39
40
-
### Building the Java application
40
+
A descriptor file is required to deploy the SAP RFC Connector to a space in a SAP BTP subaccount. An exemplary deployment descriptor `mtad.yaml.example` is provided by Camunda. This is a standard format in SAP BTP's Cloud Foundry environment to describe the application that needs deployment.
41
41
42
-
1. In the application folder, navigate to `src/main/resources/application.properties` and insert the credentials for the cluster the SAP RFC Connector should connect to:
42
+
### Deploying to BTP
43
43
44
-
```properties
45
-
zeebe.client.cloud.region=xxx
46
-
zeebe.client.cloud.clusterId=guid
47
-
zeebe.client.cloud.clientId=yyy
48
-
zeebe.client.cloud.clientSecret=zzz
49
-
camunda.connector.polling.enabled=false
50
-
```
51
-
52
-
2. Copy the deployment descriptor `mta.yaml.example` to `mta.yaml` and enter the same credentials in the `modules.properties` scope:
53
-
54
-
```yaml
55
-
_schema-version: 3.3.0
56
-
ID: sap-rfc-connector
57
-
# ...
58
-
modules:
59
-
- name: sap-rfc-connector
60
-
# ...
61
-
properties:
62
-
ZEEBE_CLIENT_CLOUD_CLUSTERID: 'guid'
63
-
ZEEBE_CLIENT_CLOUD_CLIENTID: 'xxx'
64
-
ZEEBE_CLIENT_CLOUD_CLIENT_SECRET: 'yyy'
65
-
ZEEBE_CLIENT_CLOUD_REGION: 'zzz'
66
-
```
67
-
68
-
3. Adjust any property describing an infrastructure setting to your requirements. For example, if a pre-existing destination instance is to be used, adjust the respective resource name. Otherwise, the deployment will create any of the services listed in `resources` for you.
69
-
4. Build the deployable archive via `$> mbt build`.
44
+
1. Find the matching `.war` archive for the targeted Camunda 8 SaaS version.
45
+
The version follows the format `<C8 version major>.<C8 version minor>.<OData connector version>`.
46
+
Examples:
70
47
71
-
### Deploying the Java application
48
+
-`rfc-8.6.0.war` is the RFC Connector in version `0` for C8 SaaS version `8.6`
49
+
-`rfc-8.5.1.war` is the RFC Connector in version `1` for C8 SaaS version `8.5`
72
50
73
-
1. Log in to the desired SAP BTP subaccount via the [Cloud Foundry `cli`](https://github.com/cloudfoundry/cli) (cf-cli):
51
+
2. Adjust the values for the credentials (client ID, client secret, etc.) to match those of the API client of the targeted Camunda 8 SaaS environment and rename it to `mtad.yaml`.
52
+
3. Log into the desired SAP BTP subaccount via the [Cloud Foundry `cli`](https://github.com/cloudfoundry/cli) (cf-cli):
74
53
75
54
```shell
76
55
$> cf login
77
56
API endpoint: https://api.cf. ...
78
57
...
79
58
```
80
59
81
-
2. Deploy the SAP RFC Connector via the `cf-cli`. Note that this requires [the "multiapps" plugin of Cloud Foundry](https://github.com/cloudfoundry/multiapps-cli-plugin) to be installed on the machine the deployment runs on.
60
+
4. Deploy the SAP RFC Connector via the `cf-cli`. Note that this requires [the "multiapps" plugin of Cloud Foundry](https://github.com/cloudfoundry/multiapps-cli-plugin) to be installed on the machine the deployment runs on.
82
61
83
62
```shell
84
-
$> cf deploy mta_archives/*.mtar # append the -f flag to shortcircuit ongoing deployments
85
-
Deploying multi-target app archive <path/to/>.mtar in org <your-org> / space <your-space> as you@example.org ..
63
+
$> cf deploy ./# append the -f flag to shortcircuit ongoing deployments
64
+
Deploying multi-target app archive /some/path/sap-rfc-connectorin org <your-org> / space <your-space> as you@example.org ..
86
65
...
87
66
Application "sap-rfc-connector" started and available at "some.url.hana.ondemand.com"
0 commit comments