Welcome to @cap-js/advanced-event-mesh
About this project
CDS plugin providing integration with SAP Integration Suite, advanced event mesh.
Table of Contents
Requirements
See Getting Started on how to jumpstart your development and grow as you go with SAP Cloud Application Programming Model (CAP). To learn about messaging in CAP, please consult the guide on Events & Messaging.
Setup
Install the plugin via:
npm add @cap-js/advanced-event-mesh
Then, set the kind of your messaging service to advanced-event-mesh:
{
"cds": {
"requires": {
"messaging": {
"kind": "advanced-event-mesh"
}
}
}
}
Setting Up the Broker
The broker itself must be created manually in SAP Integration Suite, advanced event mesh and trust must be established to the respective application in SAP Cloud Identity Services, both for the Solace broker and the SEMP API. For details, please consult SAP Integration Suite, advanced event mesh's documentation at help.pubsub.em.services.cloud.sap and help.sap.com.
Specifically, you need to configure SAP Integration Suite, advanced event mesh to allow your CAP application to connect to the broker. For this, follow guide CAP Plugin for SAP Integration Suite, Advanced Event Mesh.
Finally, the broker's credentials must be provided via a user-provided service instance with the name advanced-event-mesh and credentials in the following format:
{
"authentication-service": {
"tokenendpoint": "https://<ias host>/oauth2/token",
"clientid": "<client id>",
"clientsecret": "<client secret>"
},
"endpoints": {
"advanced-event-mesh": {
"uri": "https://<broker host>:<port>",
"smf_uri": "wss://<broker host>:<port>"
}
},
"vpn": "<vpn>"
}
To troubleshoot connection issues, set log level for component messaging to DEBUG.
Check cds.log() for how to maintain log levels.
Broker Validation
Your app must be bound to an instance of service SAP Integration Suite, advanced event mesh with plan aem-validation-service.
Please see Validation of VMR Provisioning for more information.
Additional Configuration Options
Additional configuration options for the messaging service (i.e., cds.requires.messaging) are:
| Property | Type | Description |
|---|---|---|
skipManagement | boolean | If set to true, the plugin will not create a queue or subscription. This is useful if you want to manage these resources manually, default: false |
subaccountId | string | The ID of the subaccount in which SAP Integration Suite, advanced event mesh is subscribed. This is necessary in case the app runs in a different subaccount. |
session | SessionProperties | Used for createSession |
queue | createMsgVpnQueue | The queue object which is created via the SEMP API |
consumer | MessageConsumerProperties | Used for createMessageConsumer |
clientFactory | SolclientFactoryProperties | Used to create the SolclientFactory instance |
Example for manually managed resources (no queue/subscription creation by the plugin):
{
"cds": {
"requires": {
"messaging": {
"kind": "advanced-event-mesh",
"skipManagement": true,
"queue": {
"queueName": "<name of queue>"
}
}
}
}
}
With skipManagement: true, the queue and its topic subscriptions must already exist on the broker — the plugin only binds the consumer to the existing queue and will not create them.
The default values can be found in the plugin's package.json.
As always, the effective configuration for your project can be queried via CLI command cds env.
For more details, please refer to the messaging section of the CAP Node.js documentation.
Support, Feedback, Contributing
This project is open to feature requests/suggestions, bug reports etc. via GitHub issues. Contribution and feedback are encouraged and always welcome. For more information about how to contribute, the project structure, as well as additional contribution information, see our Contribution Guidelines.
Security / Disclosure
If you find any bug that may be a security problem, please follow our instructions at in our security policy on how to report it. Please do not create GitHub issues for security-related doubts or problems.
Code of Conduct
We as members, contributors, and leaders pledge to make participation in our community a harassment-free experience for everyone. By participating in this project, you agree to abide by its Code of Conduct at all times.
Licensing
Copyright 2024 SAP SE or an SAP affiliate company and advanced-event-mesh contributors. Please see our LICENSE for copyright and license information. Detailed information including third-party components and their licensing/copyright information is available via the REUSE tool.