From 8152c78ca99ac60cc52a7bb3f8170fbab6274ecb Mon Sep 17 00:00:00 2001 From: "Dr. David A. Kunz" Date: Thu, 20 Feb 2025 14:09:37 +0100 Subject: [PATCH 1/6] . --- node.js/messaging.md | 51 ++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 51 insertions(+) diff --git a/node.js/messaging.md b/node.js/messaging.md index 4ad793faf..33f155bde 100644 --- a/node.js/messaging.md +++ b/node.js/messaging.md @@ -399,6 +399,57 @@ This will not work in the `dev` plan of SAP Event Mesh. If you enable the [cors middleware](https://www.npmjs.com/package/cors), [handshake requests](https://help.sap.com/docs/SAP_EM/bf82e6b26456494cbdd197057c09979f/6a0e4c77e3014acb8738af039bd9df71.html?q=handshake) from SAP Event Mesh might be intercepted. ::: +### SAP Advanced Event Mesh (beta) + +`kind`: `advanced-event-mesh` + +Use this if you want to communicate using [SAP Integration Suite, Advanced Event Mesh](https://help.pubsub.em.services.cloud.sap/Get-Started/get-started-lp.htm). +It uses the native [Solace PubSub+ JavaScript API](https://docs.solace.com/API-Developer-Online-Ref-Documentation/nodejs/readme.html) to send and receive messages and the +[Solace Element Management Protocol](https://docs.solace.com/Admin/SEMP/Using-SEMP.htm) for queue and subscription management. + +Here are the configuration options with default values: + +```js +{ + "requires": { + "messaging": { + "kind": "advanced-event-mesh", + "queue": { + "queueName": "$appId", + "ingressEnabled": true, + "egressEnabled": true + }, + "consumer": { + "queueDescriptor": { + "type": "QUEUE" + }, + "acknowledgeMode": "CLIENT", + "requiredSettlementOutcomes": [1, 3] + }, + "session": { + "authenticationScheme": "AuthenticationScheme_oauth2", + "publisherProperties": { + "acknowledgeMode": "PER_MESSAGE" + }, + "connectRetries": -1 + }, + "logLevel": 1, + "outbox": true, + "subscribePrefix": "", + "publishPrefix": "" + } +} +``` +For available settings, please refer to the [Solace API documentation](https://docs.solace.com/API-Developer-Online-Ref-Documentation/nodejs/index.html): + +| Property | Description | +|----------|-------------| +| `queue` | [MsgVpnQueue](https://docs.solace.com/API-Developer-Online-Ref-Documentation/swagger-ui/software-broker/config/index.html#/msgVpn/createMsgVpnQueue) | +| `consumer` | [solace.MessageConsumerProperties](https://docs.solace.com/API-Developer-Online-Ref-Documentation/nodejs/solace.MessageConsumerProperties.html) | +| `session` | [solace.SessionProperties](https://docs.solace.com/API-Developer-Online-Ref-Documentation/nodejs/solace.SessionProperties.html) | +| `logLevel` | [solace.LogLevel](https://docs.solace.com/API-Developer-Online-Ref-Documentation/nodejs/solace.LogLevel.html) | + + ### SAP Cloud Application Event Hub { #event-broker } From e6066b2d55459217279b9fa127b4e80fa22313e8 Mon Sep 17 00:00:00 2001 From: "Dr. David A. Kunz" Date: Thu, 20 Feb 2025 14:20:10 +0100 Subject: [PATCH 2/6] . --- node.js/messaging.md | 17 ++++++++++++++--- 1 file changed, 14 insertions(+), 3 deletions(-) diff --git a/node.js/messaging.md b/node.js/messaging.md index 33f155bde..ce9f0295e 100644 --- a/node.js/messaging.md +++ b/node.js/messaging.md @@ -401,13 +401,24 @@ If you enable the [cors middleware](https://www.npmjs.com/package/cors), [handsh ### SAP Advanced Event Mesh (beta) +::: warning +This is a beta feature. Beta features aren't part of the officially delivered scope that SAP guarantees for future releases. +::: + `kind`: `advanced-event-mesh` -Use this if you want to communicate using [SAP Integration Suite, Advanced Event Mesh](https://help.pubsub.em.services.cloud.sap/Get-Started/get-started-lp.htm). +Use this if you want to communicate with [SAP Integration Suite, Advanced Event Mesh](https://help.pubsub.em.services.cloud.sap/Get-Started/get-started-lp.htm). It uses the native [Solace PubSub+ JavaScript API](https://docs.solace.com/API-Developer-Online-Ref-Documentation/nodejs/readme.html) to send and receive messages and the -[Solace Element Management Protocol](https://docs.solace.com/Admin/SEMP/Using-SEMP.htm) for queue and subscription management. +[Solace Element Management Protocol](https://docs.solace.com/Admin/SEMP/Using-SEMP.htm) for queue and subscription management, both using OAuth 2.0. + +The integration is provided using the plugin [`@cap-js/advanced-event-mesh`](https://github.com/cap-js/advanced-event-mesh). +Hence, you first need to install the plugin: + +```bash +npm add @cap-js/advanced-event-mesh +``` -Here are the configuration options with default values: +Here are the available configuration options with their default values: ```js { From 3b425c2d9bca87fb090bfc20e31d9bfdf19f9aae Mon Sep 17 00:00:00 2001 From: "Dr. David A. Kunz" Date: Thu, 20 Feb 2025 14:54:22 +0100 Subject: [PATCH 3/6] . --- node.js/messaging.md | 20 +++++++++++++++++++- 1 file changed, 19 insertions(+), 1 deletion(-) diff --git a/node.js/messaging.md b/node.js/messaging.md index ce9f0295e..e2143c505 100644 --- a/node.js/messaging.md +++ b/node.js/messaging.md @@ -409,7 +409,7 @@ This is a beta feature. Beta features aren't part of the officially delivered sc Use this if you want to communicate with [SAP Integration Suite, Advanced Event Mesh](https://help.pubsub.em.services.cloud.sap/Get-Started/get-started-lp.htm). It uses the native [Solace PubSub+ JavaScript API](https://docs.solace.com/API-Developer-Online-Ref-Documentation/nodejs/readme.html) to send and receive messages and the -[Solace Element Management Protocol](https://docs.solace.com/Admin/SEMP/Using-SEMP.htm) for queue and subscription management, both using OAuth 2.0. +[Solace Element Management Protocol (SEMP)](https://docs.solace.com/Admin/SEMP/Using-SEMP.htm) for queue and subscription management, both using OAuth 2.0. The integration is provided using the plugin [`@cap-js/advanced-event-mesh`](https://github.com/cap-js/advanced-event-mesh). Hence, you first need to install the plugin: @@ -418,6 +418,24 @@ Hence, you first need to install the plugin: npm add @cap-js/advanced-event-mesh ``` +You need [create a user-provided service instance](https://help.sap.com/docs/btp/sap-business-technology-platform/creating-user-provided-service-instances?version=Cloud) with the following credentials: + +```js +{ + "vpn": "", + "clientid": "", + "clientsecret": "", + "tokenendpoint": "", + "management_uri": "", + "uri": "" +} +``` + +::: warning +The IAS application must be authorized to use the SEMP v2 config APIs as well as the Solace web messaging API. +::: + + Here are the available configuration options with their default values: ```js From 32406440ac1412ec69e4774abab7501b4f25a7ec Mon Sep 17 00:00:00 2001 From: "Dr. David A. Kunz" Date: Thu, 20 Feb 2025 15:35:13 +0100 Subject: [PATCH 4/6] . --- node.js/messaging.md | 19 +++++++++++-------- 1 file changed, 11 insertions(+), 8 deletions(-) diff --git a/node.js/messaging.md b/node.js/messaging.md index e2143c505..c84b9c2fe 100644 --- a/node.js/messaging.md +++ b/node.js/messaging.md @@ -418,21 +418,24 @@ Hence, you first need to install the plugin: npm add @cap-js/advanced-event-mesh ``` -You need [create a user-provided service instance](https://help.sap.com/docs/btp/sap-business-technology-platform/creating-user-provided-service-instances?version=Cloud) with the following credentials: +You need [create a user-provided service instance](https://help.sap.com/docs/btp/sap-business-technology-platform/creating-user-provided-service-instances?version=Cloud) with name `advanced-event-mesh` and the following credentials: ```js { - "vpn": "", - "clientid": "", - "clientsecret": "", - "tokenendpoint": "", - "management_uri": "", - "uri": "" + "name": "advanced-event-mesh", + "credentials": { + "vpn": "", + "clientid": "", + "clientsecret": "", + "tokenendpoint": "", + "management_uri": "", + "uri": "" + } } ``` ::: warning -The IAS application must be authorized to use the SEMP v2 config APIs as well as the Solace web messaging API. +The IAS application must be authorized to use the SEMP v2 config APIs as well as the Solace web messaging API. The appropriate OAuth 2.0 profiles need to be created in SAP Advanced Event Mesh. ::: From 5df049dd77dfe2af97f5bd60a30dc02ae18918d9 Mon Sep 17 00:00:00 2001 From: "Dr. David A. Kunz" Date: Thu, 20 Feb 2025 15:36:27 +0100 Subject: [PATCH 5/6] . --- node.js/messaging.md | 40 ++++++++++++++++++++-------------------- 1 file changed, 20 insertions(+), 20 deletions(-) diff --git a/node.js/messaging.md b/node.js/messaging.md index c84b9c2fe..53fd49451 100644 --- a/node.js/messaging.md +++ b/node.js/messaging.md @@ -418,26 +418,6 @@ Hence, you first need to install the plugin: npm add @cap-js/advanced-event-mesh ``` -You need [create a user-provided service instance](https://help.sap.com/docs/btp/sap-business-technology-platform/creating-user-provided-service-instances?version=Cloud) with name `advanced-event-mesh` and the following credentials: - -```js -{ - "name": "advanced-event-mesh", - "credentials": { - "vpn": "", - "clientid": "", - "clientsecret": "", - "tokenendpoint": "", - "management_uri": "", - "uri": "" - } -} -``` - -::: warning -The IAS application must be authorized to use the SEMP v2 config APIs as well as the Solace web messaging API. The appropriate OAuth 2.0 profiles need to be created in SAP Advanced Event Mesh. -::: - Here are the available configuration options with their default values: @@ -482,6 +462,26 @@ For available settings, please refer to the [Solace API documentation](https://d | `logLevel` | [solace.LogLevel](https://docs.solace.com/API-Developer-Online-Ref-Documentation/nodejs/solace.LogLevel.html) | +You need [create a user-provided service instance](https://help.sap.com/docs/btp/sap-business-technology-platform/creating-user-provided-service-instances?version=Cloud) with name `advanced-event-mesh` and the following credentials: + +```js +{ + "name": "advanced-event-mesh", + "credentials": { + "vpn": "", + "clientid": "", + "clientsecret": "", + "tokenendpoint": "", + "management_uri": "", + "uri": "" + } +} +``` + +::: warning +The IAS application must be authorized to use the SEMP v2 config APIs as well as the Solace web messaging API. The appropriate OAuth 2.0 profiles need to be created in SAP Advanced Event Mesh. +::: + ### SAP Cloud Application Event Hub { #event-broker } From 8fe53f3673680b48cd95888ce748f5d12b12813a Mon Sep 17 00:00:00 2001 From: "Dr. David A. Kunz" Date: Mon, 24 Feb 2025 11:42:45 +0100 Subject: [PATCH 6/6] . --- node.js/messaging.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/node.js/messaging.md b/node.js/messaging.md index 53fd49451..4346b2389 100644 --- a/node.js/messaging.md +++ b/node.js/messaging.md @@ -399,7 +399,7 @@ This will not work in the `dev` plan of SAP Event Mesh. If you enable the [cors middleware](https://www.npmjs.com/package/cors), [handshake requests](https://help.sap.com/docs/SAP_EM/bf82e6b26456494cbdd197057c09979f/6a0e4c77e3014acb8738af039bd9df71.html?q=handshake) from SAP Event Mesh might be intercepted. ::: -### SAP Advanced Event Mesh (beta) +### SAP Integration Suite, advanced event mesh (beta) ::: warning This is a beta feature. Beta features aren't part of the officially delivered scope that SAP guarantees for future releases. @@ -407,7 +407,7 @@ This is a beta feature. Beta features aren't part of the officially delivered sc `kind`: `advanced-event-mesh` -Use this if you want to communicate with [SAP Integration Suite, Advanced Event Mesh](https://help.pubsub.em.services.cloud.sap/Get-Started/get-started-lp.htm). +Use this if you want to communicate with [SAP Integration Suite, advanced event mesh](https://help.pubsub.em.services.cloud.sap/Get-Started/get-started-lp.htm). It uses the native [Solace PubSub+ JavaScript API](https://docs.solace.com/API-Developer-Online-Ref-Documentation/nodejs/readme.html) to send and receive messages and the [Solace Element Management Protocol (SEMP)](https://docs.solace.com/Admin/SEMP/Using-SEMP.htm) for queue and subscription management, both using OAuth 2.0. @@ -479,7 +479,7 @@ You need [create a user-provided service instance](https://help.sap.com/docs/btp ``` ::: warning -The IAS application must be authorized to use the SEMP v2 config APIs as well as the Solace web messaging API. The appropriate OAuth 2.0 profiles need to be created in SAP Advanced Event Mesh. +The IAS application must be authorized to use the SEMP v2 config APIs as well as the Solace web messaging API. The appropriate OAuth 2.0 profiles need to be created in SAP Integration Suite, advanced event mesh. :::