Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

experimental: SAP documentation #4267

Merged
merged 25 commits into from
Oct 14, 2024
Merged
Show file tree
Hide file tree
Changes from 3 commits
Commits
Show all changes
25 commits
Select commit Hold shift + click to select a range
8318a9b
initial poc commit
akeller Sep 6, 2024
68eeaa2
Merge branch 'main' into sap-poc
vobu Sep 10, 2024
368b7b4
wip: sap odata connector
Sep 13, 2024
64ba313
wip: further docs
vobu Sep 15, 2024
fdbe374
docs: spell check
vobu Sep 15, 2024
900fd6a
feat: first draft of the sap docs
vobu Oct 10, 2024
8ec4736
initial edits
christinaausley Oct 10, 2024
4034aba
revise rfc connector
christinaausley Oct 10, 2024
fc2627e
remove from sidebar for now
christinaausley Oct 10, 2024
620dd8f
Update docs/guides/sap/btp-integration.md
christinaausley Oct 10, 2024
551f6da
Update docs/guides/sap/camunda-sap-integration.md
christinaausley Oct 10, 2024
e7a9b1e
Update docs/guides/sap/rfc-connector.md
christinaausley Oct 10, 2024
6c05d0d
resolve comments
christinaausley Oct 11, 2024
8002e91
second review of sap content
christinaausley Oct 11, 2024
1dd73d2
fix link
christinaausley Oct 11, 2024
036a809
resolve comments
christinaausley Oct 11, 2024
ad57903
Merge branch 'experimental-structure-PR' into sap-poc
christinaausley Oct 11, 2024
24e9df6
move into components for now
christinaausley Oct 11, 2024
60c0ac9
Merge branch 'experimental-structure-PR' into sap-poc
christinaausley Oct 14, 2024
86785f8
Update docs/components/sap/odata-connector.md
christinaausley Oct 14, 2024
263c6fa
Update docs/components/sap/odata-connector.md
christinaausley Oct 14, 2024
6190188
Update docs/components/sap/odata-connector.md
christinaausley Oct 14, 2024
74c12b5
Update docs/components/sap/rfc-connector.md
christinaausley Oct 14, 2024
9a68eff
Update docs/components/sap/rfc-connector.md
christinaausley Oct 14, 2024
9f9f3de
Update docs/components/sap/rfc-connector.md
christinaausley Oct 14, 2024
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
87 changes: 87 additions & 0 deletions docs/guides/sap/guide1-sap-e2e.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,87 @@
# SAP Integration

Camunda's SAP Integration consists of several -in the non-technical sense- packages. Together they live under the umbrella term "SAP Integration", yet each fulfilling a dedicated purpose. Every package of the SAP Integration can be used standalone w/o any tight coupling to the others.

- SAP OData outbound connector: interact with an S/4HANA or ECC System via OData v2 + v4 APIs, directly from your BPMN model task
- SAP RFC outbound connector: query BAPIs and remote-enable function modules on SAP ECC Systems
- SAP BTP Integration
- use Tasklist's forms as Fiori UI
- operate BTP services from BPMN tasks
- Inbound proxy endpoint: start Process Instances of BPMN models, including custom variables

## SAP OData protocol outbound connector

The SAP OData protocol outbound connector (or short: SAP OData connector) runs as a docker image on BTP.

It is designed to run in [hybrid connector mode](https://docs.camunda.io/docs/guides/use-connectors-in-hybrid-mode/), living in the customer's BTP (sub-)account in the Cloud Foundry environment.
christinaausley marked this conversation as resolved.
Show resolved Hide resolved

It connects to Camunda 8 SaaS, utilizing BTP's Destination and Connectivity concept to query an SAP system, via both OData v2 and v4.

### Prerequisistes

The Connector integrates into a standard BTP landscape and doesn't need any proprietary setup.

Yet a minimum set of SAP infrastructure requirements need to be in place for the SAP OData connector docker image to run:

- BTP subaccount with a [Cloud Foundry environment](https://discovery-center.cloud.sap/serviceCatalog/cloud-foundry-runtime?region=all) enabled and a [Space created](https://help.sap.com/docs/btp/sap-business-technology-platform/create-spaces)

- minimum [1GB storage quota, 2 GB runtime memory](https://help.sap.com/docs/btp/sap-business-technology-platform/managing-space-quota-plans)

- [Entitlements](https://help.sap.com/docs/btp/sap-business-technology-platform/managing-entitlements-and-quotas-using-cockpit) for

- [Connectivity Service](https://discovery-center.cloud.sap/serviceCatalog/connectivity-service?region=all), `lite` plan (to connect to the SAP is on-premises)
- [Destination Service](https://discovery-center.cloud.sap/serviceCatalog/destination?service_plan=lite&region=all&commercialModel=btpea), `lite` plan

- 1 or more instance- or subaccount-level destinations, pointing to the SAP systems to communicate with.
![sample BTP destination configuration](./images/btp-destination.png)

:warning: check that `Additional Properties` are correctly set on the Destination
Here's a recommended set of Properties:

```json
HTML5.DynamicDestination: true
sap-client: <client/"Mandant" to work with on the SAP system>
WebIDEEnabled: true
WebIDESystem: <SAP system ID>
WebIDEUsage: odata_gen
```

:warning: Currently, only `BasicAuthentication` is supported on the Destination by the SAP OData connector.

### Deployment to BTP

Log into the desired BTP subaccount via the Cloud Foundry `cli` (cf-cli):

```shell
$> cf login
API endpoint: https://api.cf. ...
...
```

(explain mtad)

Use the `mtad.yaml.template` depyloment descriptor template. fill in your info and credentials, and rename it to `mtad.yaml`.

Eventually adjust the names of the destination- and connectivity-instances to your liking.

Then deploy the SAP OData connector via the cf-cli:

```shell
$> cf deploy ./ # append the -f flag to shortcircuit ongoing deployments
Deploying multi-target app archive /Some/path/sap-odata-connector.mtar in org <your-org> / space <your-space> as [email protected] ..
...
Application "sap-odata-connector" started and available at "some.url.hana.ondemand.com"
```

### Deployment in Camunda 8 SaaS

Import the Element Template to use the Connector.

![sample BPMN diagram with SAP OData connector](./images/sap-odata-connector-task-in-model.png)

### Working with the Connector in Camunda Modeler

- make sure the connection from the Cloud Foundry environment via the destination to the SAP systems works.
Using the [Terminal in Business Application Studio](https://community.sap.com/t5/technology-blogs-by-sap/how-to-check-the-connectivity-to-your-backend-system-in-business/ba-p/13479832) is a quick way to verify that.
- validate requests first in an API client before trying with the SAP OData connector in Modeler, then copy over to the Element template fields
→ saves time and reduces potential error sources
Empty file.
Binary file added docs/guides/sap/images/btp-destination.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
6 changes: 6 additions & 0 deletions sidebars.js
Original file line number Diff line number Diff line change
Expand Up @@ -46,6 +46,12 @@ module.exports = {
},
],
},
{
"Working with SAP": [
"guides/sap/guide1-sap-e2e",
"guides/sap/guide2-sap-e2e",
],
},
{
"Migrate from Camunda 7": [
"guides/migrating-from-camunda-7/index",
Expand Down
Loading