alesi documentation #2352
alesi documentation #2352
Conversation
![github-actions[bot]](https://avatars.githubusercontent.com/in/15368?s=60&v=4){kind=small}
There was a problem hiding this comment.
Spelling Mistakes
- java/cap_in_non_cap_applications.md:138:26 Unknown word "alesi"
Generally, for each spelling mistake there are 2 ways to fix it:
- Fix the spelling mistake and commit it.
- The word is incorrectly reported as misspelled → put the word on the project-words.txt list, located in the root project directory.
Co-authored-by: René Jeglinsky <[email protected]>
There was a problem hiding this comment.
Spelling Mistakes
- java/cap_in_non_cap_applications.md:170:135 Unknown word "applicaton"
Generally, for each spelling mistake there are 2 ways to fix it:
- Fix the spelling mistake and commit it.
- The word is incorrectly reported as misspelled → put the word on the project-words.txt list, located in the root project directory.
java/cap_in_non_cap_applications.md
Outdated
| </dependency> | ||
| ``` | ||
|
|
||
| Credentials and service coordinates for connecting to a SAP Event Hub instance need to be provided by the runtime environment of your applicaton. |
There was a problem hiding this comment.
| Credentials and service coordinates for connecting to a SAP Event Hub instance need to be provided by the runtime environment of your applicaton. | |
| Credentials and service coordinates for connecting to a SAP Event Hub instance need to be provided by the runtime environment of your application*. |
Or maybe one of these: applicator, applicators, applicatory, applications?
There was a problem hiding this comment.
Spelling Mistakes
- java/cap_in_non_cap_applications.md:185:378 Unknown word "applicaton"
Generally, for each spelling mistake there are 2 ways to fix it:
- Fix the spelling mistake and commit it.
- The word is incorrectly reported as misspelled → put the word on the project-words.txt list, located in the root project directory.
|
|
||
| Credentials and service coordinates for connecting to a SAP Event Hub instance need to be provided by the runtime environment of your application. For more details you can have a look at the the [SAP Event Hub CAP Plugin](https://github.com/cap-java/cds-feature-event-hub). | ||
|
|
||
| ## Use the Transactional Outbox to add Resilience to Audit Log and Messaging |
There was a problem hiding this comment.
Outbox requires CDS model -> requires cds build -> workaround is required in none-CAP app. Better omit for now.
There was a problem hiding this comment.
@BraunMatthias As far as I understood it only the persistent outbox requires a CDS model. Thus, I would remove the sections about the persistency (and resilience) and just explain that with the automatically added in-memory outbox the service call is linked to the transaction outcome.
java/cap_in_non_cap_applications.md
Outdated
|
|
||
| {{ $frontmatter.synopsis }} | ||
|
|
||
| The CAP Java framework [integrates itself with Spring Boot](./spring-boot-integration) every CAP Java app is also a Spring Boot app. Thus, CAP Java applications can also declare native Spring Boot components in order to integrate legacy code or features that are not yet supported by CAP Java. |
There was a problem hiding this comment.
First sentence is syntactically incorrect.
CAP Java offers integration with Spring Boot - but this is not a must.
Spring Boot is one aspect - but actually Alesi is mainly about reusing our CAP integration plugins as client APIs for BTP platform services w/o having to add CDS to the project.
A link to the (C)alesi guide would be helpful.
java/cap_in_non_cap_applications.md
Outdated
|
|
||
|
|
||
| ::: info | ||
| The foundation for this guide is that you can take complete applications built with idiomatic Spring Web MVC and Spring Data JPA and combine them with parts of of the CAP Java framework. This works because the core of CAP Java is just an event machine working with String identifiers and maps ([Cds Data](./cds-data)) and don't have a dependency to a CDS model or database schema. |
There was a problem hiding this comment.
Spring / CdsData is not the point - the point is that the Alesi integration part can be used in none-CAP projects w/o the CDS model.
|
|
||
| <dependency> | ||
| <groupId>com.sap.cds</groupId> | ||
| <artifactId>cds-framework-spring-boot</artifactId> |
There was a problem hiding this comment.
why is the spring boot dependency required for audit log API?
There was a problem hiding this comment.
I guess cds-services-impl as runtime dependency is mandatory.
java/cap_in_non_cap_applications.md
Outdated
|
|
||
| ## CAP Messaging | ||
|
|
||
| The CAP framework offers a logical messaging layer. This means that applications can emit events and messages to a `MessagingService` regardless of the target messaging infrastructure. The local default implementation for messaging is using the filesystem as the communication layer. Similar to the logical audit log support the messaging layer is already part of the core CAP Java modules. Thus, a plain Spring Boot application only needs to perform these two steps to activate CAP messaging: |
There was a problem hiding this comment.
The CAP framework offers an abstraction layer for messaging services.
java/cap_in_non_cap_applications.md
Outdated
|
|
||
| ## CAP Messaging | ||
|
|
||
| The CAP framework offers a logical messaging layer. This means that applications can emit events and messages to a `MessagingService` regardless of the target messaging infrastructure. The local default implementation for messaging is using the filesystem as the communication layer. Similar to the logical audit log support the messaging layer is already part of the core CAP Java modules. Thus, a plain Spring Boot application only needs to perform these two steps to activate CAP messaging: |
|
|
||
| <dependency> | ||
| <groupId>com.sap.cds</groupId> | ||
| <artifactId>cds-framework-spring-boot</artifactId> |
There was a problem hiding this comment.
not required for messaging - would expect other dependencies such as cds-services-impl
There was a problem hiding this comment.
Spelling Mistakes
- java/cap_in_non_cap_applications.md:17:168 Unknown word "depdendencies"
- java/cap_in_non_cap_applications.md:180:378 Unknown word "applicaton"
Generally, for each spelling mistake there are 2 ways to fix it:
- Fix the spelling mistake and commit it.
- The word is incorrectly reported as misspelled → put the word on the project-words.txt list, located in the root project directory.
|
|
||
| {{ $frontmatter.synopsis }} | ||
|
|
||
| One of the strengths of CAP (Java) is that it offers a [variety of plugins integrating with SAP BTP services](../plugins) while keeping applications free of technical depdendencies to such services. But not only CAP applications can benefit from these plugins. CAP Java itself is designed independent of other application frameworks it offers an [integration layer to Spring Boot](./spring-boot-integration). |
There was a problem hiding this comment.
| One of the strengths of CAP (Java) is that it offers a [variety of plugins integrating with SAP BTP services](../plugins) while keeping applications free of technical depdendencies to such services. But not only CAP applications can benefit from these plugins. CAP Java itself is designed independent of other application frameworks it offers an [integration layer to Spring Boot](./spring-boot-integration). | |
| One of the strengths of CAP (Java) is that it offers a [variety of plugins integrating with SAP BTP services](../plugins) while keeping applications free of technical dependencies* to such services. But not only CAP applications can benefit from these plugins. CAP Java itself is designed independent of other application frameworks it offers an [integration layer to Spring Boot](./spring-boot-integration). |
Or maybe one of these: dependences, dependence, dependence's, dependency's?
|
|
||
| ## Use the Transactional Outbox to add Resilience to Audit Log and Messaging | ||
|
|
||
| The CAP Java transactional outbox is a component that allows binding of external service calls to the outcome of the current request's transaction. With that semantics you can be sure that e.g. the SAP Audit Log Service is only called when your business transaction was successful. With added persistence for the outbox you can even make the *outboxed* calls resilient against applicaton restarts. |
There was a problem hiding this comment.
| The CAP Java transactional outbox is a component that allows binding of external service calls to the outcome of the current request's transaction. With that semantics you can be sure that e.g. the SAP Audit Log Service is only called when your business transaction was successful. With added persistence for the outbox you can even make the *outboxed* calls resilient against applicaton restarts. | |
| The CAP Java transactional outbox is a component that allows binding of external service calls to the outcome of the current request's transaction. With that semantics you can be sure that e.g. the SAP Audit Log Service is only called when your business transaction was successful. With added persistence for the outbox you can even make the *outboxed* calls resilient against application* restarts. |
Or maybe one of these: applicator, applicators, applicatory, applications?
No description provided.