Merge pull request #125 from eclipse-tractusx/merge-v1.6.0-RC4-in-main

release(1.6.0-RC4): merge release into main

CHANGELOG.md

@@ -2,6 +2,13 @@
 
 New features, fixed bugs, known defects and other noteworthy changes to each release of the Catena-X Portal Assets.
 
+## 1.6.0-RC4
+
+### Change
+- Documentation of registration and technical integration updated (removal of all daps related documentation)
+- Added new notification types and messages inside the notification service documentation
+- Enhanced policy documentation as part of the user documentation of connectors
+
 ## 1.6.0-RC3
 
 ### Change

developer/02. Technical Integration/01. Connector Registration/01. Summary.md

@@ -20,5 +20,6 @@ Connector stakeholders are mainly app providers and data provider (active CX par
 For the scenario "bring your own connector", the user will be able to register the connector by entering the relevant information. In the case of a "connector as a service" case, the relevant data fields need to get still defined by the Product Team CaaS (not in scope for release 1)
 <br>
 <br>
-<img width="1269" alt="image" src="https://user-images.githubusercontent.com/94133633/210186367-108e5594-b937-401b-8e29-53f4994502e3.png">
-
+<img width="1313" alt="image" src="https://github.com/catenax-ng/tx-portal-assets/assets/94133633/be138852-6112-4914-9572-c7d9f332e408">
+<br>
+<br>

developer/02. Technical Integration/01. Connector Registration/02. View Connector.md

@@ -3,7 +3,7 @@
 
 <br>
 <p align="center">
-<img width="936" alt="image" src="https://user-images.githubusercontent.com/94133633/235527871-e763e509-1c32-484c-9522-97bfd6835141.png">
+<img width="826" alt="image" src="https://github.com/catenax-ng/tx-portal-assets/assets/94133633/5f14e599-8d68-4ff4-8a4a-5db57dc98af7">
 </p>
 <br>
 
@@ -61,7 +61,33 @@ The user can retrieve all connectors which are connected to his/her company as c
 ! GET /api/administration/connectors
 ```
 
-Endpoints supports pagination
+
+<br>
+
+Response Body
+
+    {
+      "meta": {
+        "totalElements": 0,
+        "totalPages": 0,
+        "page": 0,
+        "contentSize": 0
+      },
+      "content": [
+        {
+          "name": "string",
+          "location": "string",
+          "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
+          "type": "COMPANY_CONNECTOR",
+          "status": "PENDING",
+          "hostId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
+          "hostCompanyName": "string",
+          "selfDescriptionDocumentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
+          "documentName": "string"
+        }
+      ]
+    }
+
 <br>
 <br>
 
@@ -93,22 +119,35 @@ Same as the "Onboarded Connector" section, connector status and details will be
 Response Body
 
     {
+      "meta": {
+        "totalElements": 0,
+        "totalPages": 0,
+        "page": 0,
+        "contentSize": 0
+      },
+      "content": [
+        {
           "name": "string",
           "location": "string",
-          "id": "uuid",
-          "type": "e.g. CONNECTOR_AS_A_SERVICE",
-          "status": "e.g. PENDING",
-          "dapsRegistrationSuccessful": true,
-          "providerCompanyName": "string",
-          "selfDescriptionDocumentId": "uuid"
+          "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
+          "type": "COMPANY_CONNECTOR",
+          "status": "PENDING",
+          "hostId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
+          "hostCompanyName": "string",
+          "selfDescriptionDocumentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
+          "documentName": "string"
+        }
+      ]
     }
 
+<br>
+<br>
 
 <br>
 
 Data Mapping
 
-<img width="950" alt="image" src="https://github.com/catenax-ng/tx-portal-assets/assets/94133633/df2a46ec-27ed-440a-8723-36ccde9bb99e">
+<img width="938" alt="image" src="https://github.com/catenax-ng/tx-portal-assets/assets/94133633/fc2a4838-094d-47f3-bbc1-3a1e3a2b0f9a">
 
 <br>
 <br>

developer/02. Technical Integration/01. Connector Registration/03. Create new Connector Registration.md

@@ -1,59 +1,20 @@
 ## 1. Create new Connector Registration - self-owned
 
 <br>
-<img width="1200" alt="image" src="https://user-images.githubusercontent.com/94133633/217815649-14aa6281-81bc-480b-9bf3-dd6a8264b20c.png">
+<img width="1267" alt="image" src="https://github.com/catenax-ng/tx-portal-assets/assets/94133633/4f3056d5-a2a3-4dc5-8225-aaf4db5a04dc">
 <br>
 <br>
 
 The user can create a new connector registration by using the connector POST call.
 <br>
 The registration will automatically
-* register the connector in the daps authentication service (with the public key uploaded inside the connector registration UI / endpoint)
 * trigger the SD Factory to create the self-description of the connector
 
 <br>
-<br>
-
-#### Details to the DAPS
-
-The connector registration job triggers the daps component to register the respective connector inside the daps.
-Therefore the portal backend transforms the connector registration data and provides the needed information to the daps registration service.
-Inside daps, the client for the respective connector is getting created and success message is getting responded back to the portal.
-
-DAPS is not directly reachable. Due to security regulations, the DAPS registration service is wrapped by the portal endpoint.
 
-##### API Details
-
-```diff
-! POST /daps
-```
+If connector data have been successfully stored and SD is created and stored; the connector record will receive the status "ACTIVE".
 
 <br>
-
-Request Body
-
-```json
-{
-  "clientName":"string",
-  "securityProfile":"BASE_SECURITY_PROFILE",
-  "referringConnector": "connector.url+BPN (own connector: own bpn; managed connector: bpn of the provider)",
-  "file": "string($binary)"
-  }
-```
-
-Details
-
-* clientName: Name of a client we create a record for
-* securityProfile: Default value is idsc:BASE_SECURITY_PROFILE
-* referringConnector: URL of a connector with BPN at the end (see details above)
-* file: Certificate of a Connector in PEM format
-
-<br>
-
-<br>
-
-With the success response from DAPS, the newly created DAPS clientID is getting provided back to the portal inside the response body. The portal stores the clientID inside the portal db to be able to trigger (if needed) the connector change or deletion in a later stage.
-
 <br>
 
 #### Details to the SD
@@ -101,21 +62,14 @@ Execution:
 In case of status "success"
 * content is stored as json file inside the portal db
 * connector status:
-  * Active - if the daps auth has status "true" set the connector status to "ACTIVE"
-  * Pending - if the connector.daps_registration_successful is "false" and connector.self_description_document_id is != NULL
-  * Pending - if the connector.daps_registration_successful is "false" and connector.self_description_document_id is = NULL
-  * Pending - if the connector.daps_registration_successful is "true" and connector.self_description_document_id is = NULL
+  * Active - if the sd_document_id is != NULL set the connector status to "ACTIVE"
+  * Pending - if the sd_document_id is = NULL
 
 <br>
 
 In case of status "fail"
 * set status of the "Self_Description_SO" to "FAILED" and store the message inside the checklist comment field application_checklist.comment
 
-<br>
-
-Technical explanation: if the connector.daps_registration_successful is "true" and connector.self_description_document_id is != NULL; connector status is "ACTIVE"
-
-
 <br>
 <br>
 
@@ -175,16 +129,19 @@ Request Body
 
 ## 2. Create new Connector Registration - managed
 
+<img width="1309" alt="image" src="https://github.com/catenax-ng/tx-portal-assets/assets/94133633/4f0167ec-aaee-46d1-8646-064d6a7ed7c6">
+
+<br>
+<br>
+
 Service Provider can create a new registration for a company which subscribed for a service provider service
 
 Same as for self-owned connectors, the connector registration will automatically 
-* register the connector in the daps authentication service (with the public key uploaded inside the connector registration UI / endpoint)
 * trigger the SD Factory to create the self-description of the connector
 
 <br>
 
-If connector data have been successfully stored; DAPS auth has been successful and SD is created and stored; the connector record will receive the status "ACTIVE".
-Technical explanation: if the connector.daps_registration_successful is "true" and connector.self_description_document_id is != NULL; connector status is "ACTIVE"
+If connector data have been successfully stored and SD is created and stored; the connector record will receive the status "ACTIVE".
 
 <br>
 <br>

developer/02. Technical Integration/01. Connector Registration/06. Delete Connector.md

@@ -8,11 +8,6 @@ Delete own connector. The deletion will disable the discovery service for the co
 <img width="712" alt="image" src="https://user-images.githubusercontent.com/94133633/219899187-f6e08c5a-5c6a-4e0b-bc5d-ab171c76ec48.png">
 </p>
 
-<br>
-
-> **Note**
-> In the current implementation; the deactivation of the SD document as well as the deletion of the DAPS Auth is not yet included
-
 <br>
 <br>
 
@@ -32,3 +27,7 @@ Request Body
 <br>
 <br>
 
+With the deletion, the SD document is set to "DELETED" and the connector retrieves the status "INACTIVE".
+
+<br>
+<br>

developer/Technical Documentation/Interface Contracts/BPDM.md

@@ -8,19 +8,15 @@ BPDM Data Pool provides an API (Reference Data API) to lookup business partner d
 API authentication is managed by API keys which is processed via HTTP header. This key manages also authorization, e.g., access to the CX data pool (instead of other community data).
 <br>
 <br>
-For the registration process we are using the BPDM data call to pull the company basic data.
-<br>
-2 Options are available for the data pull
-<br>
-* Via Company Name (Level 2 - not yet implemented)
-* Via BPN Number (BPN Generator: BPN Generator: Modes of Operation)
+For the registration process we are using the BPDM data call to pull the company basic data based on a BPNL data input.
 <br>
 <br>
 
 ## Architecture Overview
 To integrate the API into CX onboarding process, portal team just have to call the lookup REST endpoint and transform the response into a pick list for the portal user.
 <br>
-<img width="927" alt="image" src="https://user-images.githubusercontent.com/94133633/210436463-cdf5e063-b37c-4f28-b9c0-a78af52aaee4.png">
+<br>
+<img width="791" alt="image" src="https://github.com/catenax-ng/tx-portal-assets/assets/94133633/24cbe6d4-3108-4292-9edf-6d8017ff9636">
 <br>
 <br>
 
@@ -43,8 +39,20 @@ Retrieving company data from the CX mirror.
 ```
 
 <br>
-  idValue: {BPN-Number},
-  idType: BPN
+
+Request Body
+<br>
+
+    idValue: {BPN-Number},
+    idType: BPN
+
+<br>
+<br>
+
+The mentioned endpoint is provided by the registration service.
+Behind that, the BPDM endpoint {BPDM Host}/pool/api/catena/legal-entities/{idValue} is getting called.
+The portal is using an technical user for the authentication. The technical user bearer token is send via the api rest call to bpdm.
+
 <br>
 <br>
 
@@ -64,10 +72,5 @@ Retrieving company data from the CX mirror.
 <br>
 <br>
 
-### Service Call via CompanyName
-<br>
-currently not supported
-<br>
-<br>
 
 

developer/Technical Documentation/Others/Notifications.md

@@ -281,11 +281,27 @@ Welcome Messages, triggered by the api endpoint
 
 Topic | Notification Type | Content | UI Message | Receiver
 -------- | -------- | -------- | -------- | --------
-INFO | WELCOME | n/a	| Triggered from the FE locales file<br>Welcome to the Catena-X Network. To easily get you onboarded, a number of notifications / onboarding steps have been defined. Please check your notifications and start the configuration of your company area inside the portal to have a network experience based on your need. | New Registered Company Admin
-INFO | WELCOME_USE_CASES | n/a	| Triggered from the FE locales file<br>The network is quite huge, we want to ensure that you can focus on your preferred use cases. Select your preferred use case from the table below. | New Registered Company Admin
-INFO | WELCOME_SERVICE_PROVIDER | n/a	| Triggered from the FE locales file<br>If you need a service provider to help you with setting up your dataspace or an EDC, just follow us to the Service Provider Marketplace LINK | New Registered Company Admin
-INFO | WELCOME_CONNECTOR_REGISTRATION | n/a	| Triggered from the FE locales file<br>You do not have any registered Connector so far – have a look at the connector offers and get your connector to participate. LINK | New Registered Company Admin
-INFO | WELCOME_APP_MARKETPLACE | n/a	| Triggered from the FE locales file<br>Get a first inside into available apps, just follow us to the marketplace for apps. LINK | New Registered Company Admin
+INFO | WELCOME | n/a | Triggered from the FE locales file<br>Welcome to the Catena-X Network. To easily get you onboarded, a number of notifications / onboarding steps have been defined. Please check your notifications and start the configuration of your company area inside the portal to have a network experience based on your need. | New Registered Company Admin
+INFO | WELCOME_USE_CASES | n/a | Triggered from the FE locales file<br>The network is quite huge, we want to ensure that you can focus on your preferred use cases. Select your preferred use case from the table below. | New Registered Company Admin
+INFO | WELCOME_SERVICE_PROVIDER | n/a | Triggered from the FE locales file<br>If you need a service provider to help you with setting up your dataspace or an EDC, just follow us to the Service Provider Marketplace LINK | New Registered Company Admin
+INFO | WELCOME_CONNECTOR_REGISTRATION | n/a | Triggered from the FE locales file<br>You do not have any registered Connector so far – have a look at the connector offers and get your connector to participate. LINK | New Registered Company Admin
+INFO | WELCOME_APP_MARKETPLACE | n/a | Triggered from the FE locales file<br>Get a first inside into available apps, just follow us to the marketplace for apps. LINK | New Registered Company Admin
+
+<br>
+<br>
+
+#### Manage your company details
+Company detail change messages, triggered by the api endpoint
+
+* PUT /api/administration/companydata/credentials/{credentialId}/approval
+* PUT /api/administration/companydata/credentials/{credentialId}/reject
+
+<br>
+
+Topic | Notification Type | Content | UI Message | Receiver
+-------- | -------- | -------- | -------- | --------
+INFO | CREDENTIAL_APPROVAL | {"type":"{company_ssi_details.type}",<br>"credentialId":"{company_ssi_details.id}" | Triggered from the FE locales file<br> "Verified Credential {credentialType} assigned<br>Verified Credential {credentialType} got assigned to your company wallet." | VC Requester
+INFO | CREDENTIAL_REJECT | {"type":"{company_ssi_details.type}",<br>"credentialId":"{company_ssi_details.id}" | Triggered from the FE locales file<br> "Verified Credential {credentialType} declined<br>Verified Credential {credentialType} got declined. You can start a new request immediately." | VC Requester
 
 <br>
 <br>
@@ -306,6 +322,22 @@ OFFER | SERVICE_RELEASE_REQUEST | OfferId: {offer.id}<br>RequestorCompanyName:{c
 <br>
 <br>
 
+#### Offer Change Process
+Offer Change Messages, triggered by the api endpoint
+
+* POST /api/apps/AppChange/{appId}/role/activeapp
+* PUT /api/apps/AppChange/{appId}/subscription/{subscriptionId}/tenantUrl
+
+<br>
+
+Topic | Notification Type | Content | UI Message | Receiver
+-------- | -------- | -------- | -------- | --------
+INFO | SUBSCRIPTION_URL_UPDATE | {"appId":"{offer.id}",<br>"appName":"{offer.name}",<br>"oldUrl":"{app_subscription_details.url}"<br>"newUrl":"{app_subscription_details.url}" | Triggered from the FE locales file<br> "App URL {appName} updated<br>The app provider has changed the stored App Instance URL for your subscribed app {AppName}." | tbd
+INFO | APP_ROLE_ADDED | not yet supported | not yet supported | not yet supported
+
+<br>
+<br>
+
 #### Offer Subscription
 Offer Subscription Messages, triggered by the api endpoint