Overhaul and Cleanup of the README File #250

eric-pSAP · 2025-09-30T11:53:37Z

This is meant to add more information as well as clarify current information. Also want to align with the README of the Java version of Attachments. Steps remaining:

Finalize structure and sections
- Removing Java-specific sections and information
Confirm and clarify details
Add in links to sources

This initial change should make the rest of the editing process more streamlined

README.md

KoblerS · 2025-10-08T08:37:11Z

README.md

+The unit tests in this module do not need a binding to the respective object stores, run them with `mvn clean install`.
+
+The integration tests need a binding to a real object store. Run them with `mvn clean install -Pintegration-tests-oss`.
+To set the binding, provide the following environment variables:
+- AWS_S3_BUCKET
+- AWS_S3_REGION
+- AWS_S3_ACCESS_KEY_ID
+- AWS_S3_SECRET_ACCESS_KEY
+
+##### Implementation details
+
+This artifact provides custom handlers for events from the [AttachmentService](../../cds-feature-attachments/src/main/java/com/sap/cds/feature/attachments/service/AttachmentService.java).


Adapt to Jest

README.md

KoblerS · 2025-10-08T08:38:07Z

README.md

+logging:
+  level:
+    ...
+    '[com.sap.cds.feature.attachments]': DEBUG


not sure if it is called com.sap.cds.feature.attachments or com.sap.cds.attachments

How can we find this out? This note comes from Java

I assume it's called attachments

Co-authored-by: Simon Kobler <[email protected]>

README.md

eric-pSAP · 2025-10-08T09:24:54Z

README.md

+
+### Package Setup
+
+The attachments plugin needs to be referenced in the package.json of the consuming CAP NodeJS application: 


I found this in capire docs, but this is not how we are using the application. Which to use? https://cap.cloud.sap/docs/node.js/cds-plugins

You probably can ignore what's written in the cap docs as it does not really cover this use case

you might want to add an example how the profile should look like, in case if I didn't missed it

What do you mean by profile?

eric-pSAP · 2025-10-08T09:25:22Z

README.md

 1. Log in to Cloud Foundry:

    ```sh
    cf login -a <CF-API> -o <ORG-NAME> -s <SPACE-NAME>


Rupa has these two comments on this line as well: "Consider linking to the setup page of SAP Object Store. It may be this - https://help.sap.com/docs/object-store/object-store-service-on-sap-btp/configuring-parameters-of-object-store-instance?locale=en-US"
"You can also provide information about where someone can get CF, Org name and Space name details"

eric-pSAP · 2025-10-08T09:26:20Z

README.md

+
+When using a dedicated storage target, the attachment is not stored in the underlying database; instead, it is saved on the specified storage target and only a reference to the file is kept in the database, as defined in the CDS model. 
+
+For using SAP Object Store, you must already have an SAP Object Store service instance with a storage target which you can access. To connect it, follow this setup.


Should this be further synced this with the other Object Stores section below?

README.md

eric-pSAP

Transferring old notes

eric-pSAP · 2025-10-08T10:46:47Z

README.md

 > [!Note]
 > Starting from version 2.1.0, **separate mode** for object store instances is the default setting for multitenancy.  
 > As of version 2.2.0, both the `standard` and `S3-standard` plans of the SAP Object Store offering are supported.  
 > **Important:** The `S3-standard` plan is no longer available for new subscriptions. For new object store instances, use the `standard` plan.


Note from Rupa: "Are these two lines contradicting each other?"

eric-pSAP · 2025-10-08T10:47:14Z

README.md

+To ensure tenant identification when using a shared object store instance, the plugin prefixes attachment URLs with the tenant ID. Be sure the shared object store instance is bound to the `mtx` application module before deployment.
+
+
+### Object Stores


Java version, should this be combined with Object Storage section above?

README.md

eric-pSAP · 2025-10-08T10:54:15Z

README.md

+
+The unit tests in this module do not need a binding to the respective object stores, run them with `mvn clean install`.
+
+The integration tests need a binding to a real object store. Run them with `mvn clean install -Pintegration-tests-oss`.


Need to update this line, is the -Pintegration-tests-oss part the same for Node?

Co-authored-by: Simon Kobler <[email protected]>

README.md

eric-pSAP · 2025-10-08T11:38:08Z

README.md

+
+The unit tests in this module do not need a binding to the respective object stores, run them with `npm install`. To achieve a clean install, the comman `rm -rf node_modules` should be used before installation.
+
+The integration tests need a binding to a real object store. Run them with `npm install -Pintegration-tests-oss`.


-Pintegration-tests-oss is from Java, needed for Node?

README.md

KoblerS · 2025-10-08T13:40:05Z

README.md

+- The plugin is self-configuring as described in [Package Setup](#package-setup). To enable attachments, simply add the plugin package to your project:  
 ```sh
 npm add @cap-js/attachments


as I'm not really sure, more of a question: does npm add, add the config to the package.json like to use which cloud provider in which profile?

I do not believe so but we can check. From what I know, it simply adds the plugin.

KoblerS · 2025-10-08T13:46:48Z

README.md

+
+### Package Setup
+
+The attachments plugin needs to be referenced in the package.json of the consuming CAP NodeJS application: 


You probably can ignore what's written in the cap docs as it does not really cover this use case

KoblerS · 2025-10-08T13:47:16Z

README.md

+
+### Package Setup
+
+The attachments plugin needs to be referenced in the package.json of the consuming CAP NodeJS application: 


you might want to add an example how the profile should look like, in case if I didn't missed it

README.md

KoblerS · 2025-10-08T14:12:40Z

README.md

+logging:
+  level:
+    ...
+    '[com.sap.cds.feature.attachments]': DEBUG


I assume it's called attachments

Co-authored-by: Simon Kobler <[email protected]>

README.md

eric-pSAP · 2025-10-08T14:37:47Z

README.md

+By default, malware scanning is enabled for all profiles unless no storage provider has been specified. You can configure malware scanning by setting:
 ```json
 "attachments": {
    "scan": true


I have not either, I assumed it was already true

README.md

Initial structural change, still Java elements remaining

de62cfb

eric-pSAP self-assigned this Sep 30, 2025

eric-pSAP added documentation Improvements or additions to documentation good first issue Good for newcomers labels Sep 30, 2025

eric-pSAP added 2 commits October 1, 2025 16:03

Minor changes

dd21ae3

Edits

086c139

KoblerS self-requested a review October 7, 2025 14:21

Tiny edits

32c91f2

KoblerS reviewed Oct 8, 2025

View reviewed changes

eric-pSAP and others added 8 commits October 8, 2025 10:40

Update README.md

6bc679e

Co-authored-by: Simon Kobler <[email protected]>

Apply suggestion from @KoblerS

a0e55ff

Co-authored-by: Simon Kobler <[email protected]>

Apply suggestion from @KoblerS

f2577a2

Co-authored-by: Simon Kobler <[email protected]>

Apply suggestion from @KoblerS

21fecde

Co-authored-by: Simon Kobler <[email protected]>

Apply suggestion from @KoblerS

6c36ce2

Co-authored-by: Simon Kobler <[email protected]>

Apply suggestion from @KoblerS

0509d7d

Co-authored-by: Simon Kobler <[email protected]>

Apply suggestion from @KoblerS

c0bcc5e

Co-authored-by: Simon Kobler <[email protected]>

Apply suggestion from @KoblerS

fc9aa95

Co-authored-by: Simon Kobler <[email protected]>

eric-pSAP commented Oct 8, 2025

View reviewed changes

README.md Outdated Show resolved Hide resolved

eric-pSAP commented Oct 8, 2025

View reviewed changes

README.md Outdated Show resolved Hide resolved

eric-pSAP commented Oct 8, 2025

View reviewed changes

README.md Outdated Show resolved Hide resolved

eric-pSAP commented Oct 8, 2025

View reviewed changes

README.md Outdated Show resolved Hide resolved

eric-pSAP commented Oct 8, 2025

View reviewed changes

README.md Outdated Show resolved Hide resolved

Merge branch 'main' into fix-readme

c488f3e

eric-pSAP commented Oct 8, 2025

View reviewed changes

Apply suggestion from @KoblerS

1ebe5b8

Co-authored-by: Simon Kobler <[email protected]>

eric-pSAP commented Oct 8, 2025

View reviewed changes

README.md Outdated Show resolved Hide resolved

Edits from Simon comments

92a88c9

eric-pSAP commented Oct 8, 2025

View reviewed changes

KoblerS reviewed Oct 8, 2025

View reviewed changes

eric-pSAP and others added 8 commits October 8, 2025 16:27

Update README.md

e0bb57d

Co-authored-by: Simon Kobler <[email protected]>

Update README.md

514ee6e

Co-authored-by: Simon Kobler <[email protected]>

Update README.md

a4fba85

Co-authored-by: Simon Kobler <[email protected]>

Update README.md

e4e0fdb

Co-authored-by: Simon Kobler <[email protected]>

Update README.md

2fe3623

Co-authored-by: Simon Kobler <[email protected]>

Update README.md

503d0ba

Co-authored-by: Simon Kobler <[email protected]>

Update README.md

38108bb

Co-authored-by: Simon Kobler <[email protected]>

Update README.md

033ea6c

Co-authored-by: Simon Kobler <[email protected]>

eric-pSAP commented Oct 8, 2025

View reviewed changes

eric-pSAP added 2 commits October 8, 2025 16:41

Edits

e3d1217

Merge branch 'main' into fix-readme

2cc34e7

eric-pSAP requested a review from lisajulia October 8, 2025 15:24

More edits

339b381


		### Package Setup

		The attachments plugin needs to be referenced in the package.json of the consuming CAP NodeJS application:


		When using a dedicated storage target, the attachment is not stored in the underlying database; instead, it is saved on the specified storage target and only a reference to the file is kept in the database, as defined in the CDS model.

		For using SAP Object Store, you must already have an SAP Object Store service instance with a storage target which you can access. To connect it, follow this setup.

		To ensure tenant identification when using a shared object store instance, the plugin prefixes attachment URLs with the tenant ID. Be sure the shared object store instance is bound to the `mtx` application module before deployment.


		### Object Stores


		The unit tests in this module do not need a binding to the respective object stores, run them with `mvn clean install`.

		The integration tests need a binding to a real object store. Run them with `mvn clean install -Pintegration-tests-oss`.

Overhaul and Cleanup of the README File #250

Are you sure you want to change the base?

Overhaul and Cleanup of the README File #250

Conversation

eric-pSAP commented Sep 30, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

eric-pSAP Oct 8, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

eric-pSAP left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

eric-pSAP commented Sep 30, 2025 •

edited

Loading

eric-pSAP Oct 8, 2025 •

edited

Loading