diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md index 6c7aaf31e..7b68d5538 100644 --- a/.github/pull_request_template.md +++ b/.github/pull_request_template.md @@ -17,6 +17,7 @@ Please delete options that are not relevant. - [ ] I have followed the [contributing guidelines](https://github.com/eclipse-tractusx/portal-assets/blob/main/developer/Technical%20Documentation/Dev%20Process/How%20to%20contribute.md#commit-and-pr-guidelines) - [ ] I have performed [IP checks](https://eclipse-tractusx.github.io/docs/release/trg-7/trg-7-04#checking-libraries-using-the-eclipse-dash-license-tool) for added or updated 3rd party libraries - [ ] I have created and linked IP issues or requested their creation by a committer +- [ ] I have added copyright and license headers, footers (for .md files) or files (for images) - [ ] I have performed a self-review of my own code - [ ] I have successfully tested my changes locally - [ ] I have added tests that prove my changes work diff --git a/CHANGELOG.md b/CHANGELOG.md index 0ac753ce8..175909a4d 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -5,39 +5,46 @@ New features, fixed bugs, known defects and other noteworthy changes to each rel ## 1.7.0-RC3 ### Change -* useCase content file updated -* images linked for traceability useCase exchanged -* portal database upgrade documentation updated + +- useCase content file updated +- images linked for traceability useCase exchanged +- portal database upgrade documentation updated ### Feature + n/a ### Bugfix + n/a ## 1.7.0-RC2 ### Change -* identity provider connection documentation (developer & end user); new flow released -* subscription management board (service provider) documentation enhanced (developer & end user) -* updated technical user role definition - * removal of 'Connector User', 'App Tech User' - * updated 'Service Management' to 'Offer Management' - * added 'Semantic Model Management', 'Dataspace Discovery', 'CX Membership Info' - * permission assignment updated (R&R Matrix documentation & portal upgrade script provided for portal db and -* Interface contract documentation for 'Clearinghouse' updated with new architecture images and additional details of relevant authentication users and used endpoints -* traceability use case page images and text sections updated for release 23.12 + +- identity provider connection documentation (developer & end user); new flow released +- subscription management board (service provider) documentation enhanced (developer & end user) +- updated technical user role definition + - removal of 'Connector User', 'App Tech User' + - updated 'Service Management' to 'Offer Management' + - added 'Semantic Model Management', 'Dataspace Discovery', 'CX Membership Info' + - permission assignment updated (R&R Matrix documentation & portal upgrade script provided for portal db and +- Interface contract documentation for 'Clearinghouse' updated with new architecture images and additional details of relevant authentication users and used endpoints +- traceability use case page images and text sections updated for release 23.12 ### Feature + n/a ### Technical Support -* Portal db - technical user upgrade script provided which need to get executed for upgrade from 1.6.0 to 1.7.0 RC -* Keycloak db - technical user upgrade script provided which need to get executed for upgrade from 1.6.0 to 1.7.0 RC -* Added linter rules and prettify gitHub actions for asset repo and fixed findings + +- Portal db - technical user upgrade script provided which need to get executed for upgrade from 1.6.0 to 1.7.0 RC +- Keycloak db - technical user upgrade script provided which need to get executed for upgrade from 1.6.0 to 1.7.0 RC +- Added linter rules and prettify gitHub actions for asset repo and fixed findings ### Bugfix -* md file linkage + +- md file linkage ## 1.7.0-RC1 diff --git a/DEPENDENCIES b/DEPENDENCIES index 0c004552d..4ca330b75 100644 --- a/DEPENDENCIES +++ b/DEPENDENCIES @@ -171,7 +171,7 @@ npm/npmjs/-/once/1.4.0, ISC, approved, clearlydefined npm/npmjs/-/onetime/5.1.2, MIT, approved, clearlydefined npm/npmjs/-/onetime/6.0.0, MIT, approved, clearlydefined npm/npmjs/-/open/9.1.0, MIT, approved, clearlydefined -npm/npmjs/-/opener/1.5.2, MIT OR WTFPL OR (MIT AND WTFPL), approved, clearlydefined +npm/npmjs/-/opener/1.5.2, MIT AND WTFPL AND WTFPL, approved, #11619 npm/npmjs/-/optionator/0.9.3, MIT, approved, #9208 npm/npmjs/-/p-limit/3.1.0, MIT, approved, clearlydefined npm/npmjs/-/p-locate/5.0.0, MIT, approved, clearlydefined diff --git a/README.md b/README.md index 696e1cf29..00338eb9f 100644 --- a/README.md +++ b/README.md @@ -11,7 +11,7 @@ The Catena-X Portal application consists of ![Tag](https://img.shields.io/static/v1?label=&message=LeadingRepository&color=green&style=flat) The helm chart for installing the Catena-X Portal is available in [portal-cd](https://github.com/eclipse-tractusx/portal-cd). -The Catena-X Portal is designed to work with the [Catena-X IAM](https://github.com/eclipse-tractusx/portal-iam). +The Catena-X Portal is designed to work with the [Catena-X IAM](https://github.com/eclipse-tractusx/portal-iam) for further information you can read the [documentation](https://github.com/eclipse-tractusx/portal-iam/tree/main/docs). ## Steps to run local diff --git a/developer/01. Onboarding/01. Invite/01. Summary.md b/developer/01. Onboarding/01. Invite/01. Summary.md index b4735a732..af200f666 100644 --- a/developer/01. Onboarding/01. Invite/01. Summary.md +++ b/developer/01. Onboarding/01. Invite/01. Summary.md @@ -22,3 +22,11 @@ One email has the registration portal URL and the second email the user individu

+ +## NOTICE + +This work is licensed under the [Apache-2.0](https://www.apache.org/licenses/LICENSE-2.0). + +- SPDX-License-Identifier: Apache-2.0 +- SPDX-FileCopyrightText: 2021-2023 Contributors to the Eclipse Foundation +- Source URL: https://github.com/eclipse-tractusx/portal-assets diff --git a/developer/01. Onboarding/01. Invite/02. Overview Invited Companies.md b/developer/01. Onboarding/01. Invite/02. Overview Invited Companies.md index 59e928264..a36a4e913 100644 --- a/developer/01. Onboarding/01. Invite/02. Overview Invited Companies.md +++ b/developer/01. Onboarding/01. Invite/02. Overview Invited Companies.md @@ -49,5 +49,13 @@ The endpoint does support search via the company name > > - Search field added (already available inside the table component but needs to get activated) > - User can add a company name (minimum 3 digits) and receives in realtime (without pressing enter) the results -> - There is a typing validation logic implemented, if the user is not typing for 1 seconds, the serach results will show up, below 1 seconds, the system will wait if any additional characters are getting added -> - the serach field is validating the input, only letters, spaces, "!", "?", "&", "@", ".", "\_", "-" and numbers are allowed +> - There is a typing validation logic implemented, if the user is not typing for 1 seconds, the search results will show up, below 1 seconds, the system will wait if any additional characters are getting added +> - the search field is validating the input, only letters, spaces, "!", "?", "&", "@", ".", "\_", "-" and numbers are allowed + +## NOTICE + +This work is licensed under the [Apache-2.0](https://www.apache.org/licenses/LICENSE-2.0). + +- SPDX-License-Identifier: Apache-2.0 +- SPDX-FileCopyrightText: 2021-2023 Contributors to the Eclipse Foundation +- Source URL: https://github.com/eclipse-tractusx/portal-assets diff --git a/developer/01. Onboarding/01. Invite/03. Invite Company_Create Application.md b/developer/01. Onboarding/01. Invite/03. Invite Company_Create Application.md index 125ebea9b..f41feadf3 100644 --- a/developer/01. Onboarding/01. Invite/03. Invite Company_Create Application.md +++ b/developer/01. Onboarding/01. Invite/03. Invite Company_Create Application.md @@ -31,3 +31,11 @@ Request Body Please note that a standard realm config got configured inside the endpoint to ensure that all security and structural factory are considered - under following page you can find the configuration details **to be added**

+ +## NOTICE + +This work is licensed under the [Apache-2.0](https://www.apache.org/licenses/LICENSE-2.0). + +- SPDX-License-Identifier: Apache-2.0 +- SPDX-FileCopyrightText: 2021-2023 Contributors to the Eclipse Foundation +- Source URL: https://github.com/eclipse-tractusx/portal-assets diff --git a/developer/01. Onboarding/02. Registration/01. Login.md b/developer/01. Onboarding/02. Registration/01. Login.md index 201ba0a2b..33e6216a2 100644 --- a/developer/01. Onboarding/02. Registration/01. Login.md +++ b/developer/01. Onboarding/02. Registration/01. Login.md @@ -24,7 +24,7 @@ After selecting the company for login; the user can login via the email and pass image
-After the successfull login; the user can directly start to proceed with the company registration form. +After the successful login; the user can directly start to proceed with the company registration form.

@@ -36,7 +36,7 @@ Based on the fetched status; the frontend logic will decide how the user proceed
1. If the status is any status before "SUBMITTED" (< id "7"); the company registration form gets displayed; starting with the introduction screen. - If company registration data have been previously added/saved already, the data will be displayed inside the registration form; otherwise an empty registration form woll be displayed. + If company registration data have been previously added/saved already, the data will be displayed inside the registration form; otherwise an empty registration form will be displayed. 2. If the status is in status "SUBMITTED" (= id "7"); the information screen "application in validation" screen is getting displayed. image @@ -50,3 +50,11 @@ Based on the fetched status; the frontend logic will decide how the user proceed ## Portal Login no change / update; same design as used for the registration + +## NOTICE + +This work is licensed under the [Apache-2.0](https://www.apache.org/licenses/LICENSE-2.0). + +- SPDX-License-Identifier: Apache-2.0 +- SPDX-FileCopyrightText: 2021-2023 Contributors to the Eclipse Foundation +- Source URL: https://github.com/eclipse-tractusx/portal-assets diff --git a/developer/01. Onboarding/02. Registration/02. Add Company Data.md b/developer/01. Onboarding/02. Registration/02. Add Company Data.md index 6451ced9c..df582472c 100644 --- a/developer/01. Onboarding/02. Registration/02. Add Company Data.md +++ b/developer/01. Onboarding/02. Registration/02. Add Company Data.md @@ -57,7 +57,7 @@ Flow diagram for option a) and b) ``` The endpoint is fetching the company data (if existing) from the bpdm data pool. -Portal backend transfers the bpdm data pool response for the protal FE to display all relevant information. (similar structure as the portal db GET response) +Portal backend transfers the bpdm data pool response for the portal FE to display all relevant information. (similar structure as the portal db GET response)
@@ -103,10 +103,10 @@ Response Body #### b) manually entered Beside the offered autofill option via BPN, the user can also manually enter the legal company data. -In this scenario, the bpn stays empty, since its expected that the company doesnt have a bpn yet or isnt aware about the owned bpn. +In this scenario, the bpn stays empty, since its expected that the company doesn't have a bpn yet or isn't aware about the owned bpn. In the scenario of manually entering the data, validations (as defined below) are covered. -Additionally to the validations, the unique identifier is getting is relevant and need to get entered by the company administrator based on the enetered legal entity country. +Additionally to the validations, the unique identifier is getting is relevant and need to get entered by the company administrator based on the entered legal entity country. Details to the unique identifier can get found in the following section [unique identifier logic](#unique-identifier)
@@ -171,7 +171,7 @@ Details to the unique identifier can get found in the following section [unique ##### Unique Identifier -The company unique identifier is a company specific identifier which is used to help companies to prove their identity. In Catena-X registration party needs to add minimum one unqiue identifier which is later used inside the application verification flow to identifier the companies identity. +The company unique identifier is a company specific identifier which is used to help companies to prove their identity. In Catena-X registration party needs to add minimum one unique identifier which is later used inside the application verification flow to identifier the companies identity. To support the user entry and ensure that human errors are reduced, an endpoint to fetch the allowed unique identifier (per country) as well as field input validations are implemented.
@@ -256,7 +256,7 @@ no post call existing. The data will get stored as part of the POST /companyDeta ### Store/Save Company Data -To store the added company data in the portal db (no matter if they have been added manually or via bpn search) the POST endpoint is triggered with the user selection of the "Confirm" button on the buttom of the form. +To store the added company data in the portal db (no matter if they have been added manually or via bpn search) the POST endpoint is triggered with the user selection of the "Confirm" button on the bottom of the form.
@@ -294,7 +294,7 @@ Response Body ### Display Company Data (pre-saved) -In case the user has previously added company data already or used the bpn autofill option and saved the autfilled data, the registration app will display the respective company data by fetching them via the GET endpoint from the portal db +In case the user has previously added company data already or used the bpn autofill option and saved the autofill data, the registration app will display the respective company data by fetching them via the GET endpoint from the portal db ```diff ! GET /api/registration/application/{applicationId}/companyDetailsWithAddress @@ -327,3 +327,11 @@ Response Body

+ +## NOTICE + +This work is licensed under the [Apache-2.0](https://www.apache.org/licenses/LICENSE-2.0). + +- SPDX-License-Identifier: Apache-2.0 +- SPDX-FileCopyrightText: 2021-2023 Contributors to the Eclipse Foundation +- Source URL: https://github.com/eclipse-tractusx/portal-assets diff --git a/developer/01. Onboarding/02. Registration/03. Add Additional Users.md b/developer/01. Onboarding/02. Registration/03. Add Additional Users.md index 97989dc9e..02b37cdd1 100644 --- a/developer/01. Onboarding/02. Registration/03. Add Additional Users.md +++ b/developer/01. Onboarding/02. Registration/03. Add Additional Users.md @@ -22,3 +22,11 @@ As part of the registration and onboarding process a number of users will be nee

+ +## NOTICE + +This work is licensed under the [Apache-2.0](https://www.apache.org/licenses/LICENSE-2.0). + +- SPDX-License-Identifier: Apache-2.0 +- SPDX-FileCopyrightText: 2021-2023 Contributors to the Eclipse Foundation +- Source URL: https://github.com/eclipse-tractusx/portal-assets diff --git a/developer/01. Onboarding/02. Registration/04. Company Role & Consent.md b/developer/01. Onboarding/02. Registration/04. Company Role & Consent.md index e796389f0..6e3e29e02 100644 --- a/developer/01. Onboarding/02. Registration/04. Company Role & Consent.md +++ b/developer/01. Onboarding/02. Registration/04. Company Role & Consent.md @@ -40,3 +40,11 @@ Via the endpoint post consent, the consent given by the user to the respective a

+ +## NOTICE + +This work is licensed under the [Apache-2.0](https://www.apache.org/licenses/LICENSE-2.0). + +- SPDX-License-Identifier: Apache-2.0 +- SPDX-FileCopyrightText: 2021-2023 Contributors to the Eclipse Foundation +- Source URL: https://github.com/eclipse-tractusx/portal-assets diff --git a/developer/01. Onboarding/02. Registration/05. Document Upload.md b/developer/01. Onboarding/02. Registration/05. Document Upload.md index ba6c9878b..9ae51b363 100644 --- a/developer/01. Onboarding/02. Registration/05. Document Upload.md +++ b/developer/01. Onboarding/02. Registration/05. Document Upload.md @@ -9,7 +9,7 @@
In Step 4, the users are asked to upload the company identification.
-All documents uploaded under the same application register form are shown. If a second user has already uploaded a doc, the user will be able to see as well as delete this document as weel; as long as the users belong to the same company application. +All documents uploaded under the same application register form are shown. If a second user has already uploaded a doc, the user will be able to see as well as delete this document as well; as long as the users belong to the same company application.

@@ -77,3 +77,11 @@ Uploaded documents can also get viewed / downloaded by the user. To do this, the

+ +## NOTICE + +This work is licensed under the [Apache-2.0](https://www.apache.org/licenses/LICENSE-2.0). + +- SPDX-License-Identifier: Apache-2.0 +- SPDX-FileCopyrightText: 2021-2023 Contributors to the Eclipse Foundation +- Source URL: https://github.com/eclipse-tractusx/portal-assets diff --git a/developer/01. Onboarding/02. Registration/06. Verify Registration Data.md b/developer/01. Onboarding/02. Registration/06. Verify Registration Data.md index 6b88873c3..97ddef297 100644 --- a/developer/01. Onboarding/02. Registration/06. Verify Registration Data.md +++ b/developer/01. Onboarding/02. Registration/06. Verify Registration Data.md @@ -83,3 +83,11 @@ The endpoint triggers the

+ +## NOTICE + +This work is licensed under the [Apache-2.0](https://www.apache.org/licenses/LICENSE-2.0). + +- SPDX-License-Identifier: Apache-2.0 +- SPDX-FileCopyrightText: 2021-2023 Contributors to the Eclipse Foundation +- Source URL: https://github.com/eclipse-tractusx/portal-assets diff --git a/developer/01. Onboarding/02. Registration/07. Error Scenarios.md b/developer/01. Onboarding/02. Registration/07. Error Scenarios.md index 7497aafbb..8a3d58c85 100644 --- a/developer/01. Onboarding/02. Registration/07. Error Scenarios.md +++ b/developer/01. Onboarding/02. Registration/07. Error Scenarios.md @@ -73,7 +73,7 @@ Error scenarios: - Company role load unsuccessful - Agreement load unsuccessful - Agreement pre-saved data load unsuccessful -- Agreement save unusccessfull +- Agreement saved unsuccessfully - Snackbar image @@ -106,3 +106,11 @@ Error scenarios:

+ +## NOTICE + +This work is licensed under the [Apache-2.0](https://www.apache.org/licenses/LICENSE-2.0). + +- SPDX-License-Identifier: Apache-2.0 +- SPDX-FileCopyrightText: 2021-2023 Contributors to the Eclipse Foundation +- Source URL: https://github.com/eclipse-tractusx/portal-assets diff --git a/developer/01. Onboarding/03. Registration Approval/02. View Company Application(s).md b/developer/01. Onboarding/03. Registration Approval/02. View Company Application(s).md index be703a580..dc9d6b8db 100644 --- a/developer/01. Onboarding/03. Registration Approval/02. View Company Application(s).md +++ b/developer/01. Onboarding/03. Registration Approval/02. View Company Application(s).md @@ -186,3 +186,11 @@ The API is downloading the document which is selected by the user.


+ +## NOTICE + +This work is licensed under the [Apache-2.0](https://www.apache.org/licenses/LICENSE-2.0). + +- SPDX-License-Identifier: Apache-2.0 +- SPDX-FileCopyrightText: 2021-2023 Contributors to the Eclipse Foundation +- Source URL: https://github.com/eclipse-tractusx/portal-assets diff --git a/developer/01. Onboarding/03. Registration Approval/03. Registration Approval Process.md b/developer/01. Onboarding/03. Registration Approval/03. Registration Approval Process.md index 2e352102d..c90675c75 100644 --- a/developer/01. Onboarding/03. Registration Approval/03. Registration Approval Process.md +++ b/developer/01. Onboarding/03. Registration Approval/03. Registration Approval Process.md @@ -18,7 +18,7 @@ Depending on the status, the user can execute a number of action / next steps. I ### Approval Overlay/Status -Via an overaly, which is getting displayed as soon as the user clicks on any of the confirmation steps in the approval board, the detailed steps and status of the different application validation steps can get viewed. +Via an overlay, which is getting displayed as soon as the user clicks on any of the confirmation steps in the approval board, the detailed steps and status of the different application validation steps can get viewed. ```diff ! GET /api/administration/registration/application/{applicationId}/checklistDetails @@ -100,7 +100,7 @@ The 6 steps shown above are mapped as a checklist. To ensure that the operator k - Done - Failed -The checklist is processed as far as possible automatically by a worker process. Therfore a checklist item has at least one corresponding process step, these are created for processing in the worker. The distribution of the process steps to the checklist steps is listed in the respective checklist step. +The checklist is processed as far as possible automatically by a worker process. Therefore, a checklist item has at least one corresponding process step, these are created for processing in the worker. The distribution of the process steps to the checklist steps is listed in the respective checklist step. In case of a failed process step, the error code (if any) is recorded for the checklist step of the registration application and can be viewed by the operator. @@ -263,7 +263,7 @@ API Body There are two possible outcomes to the external push. -1. The call to the external system was successful. Then the process step "CREATE_BUSINESS_PARTNER_NUMBER_PUSH" is set to "DONE" and the checklist item "Business Partner Number" is set to "IN_PROGRESS". After that the process item "CREATE_BUSINESS_PARTNER_NUMBER_PULL" is created. Currently there is not implementation to push the data back to the portal. Therefore as soon as the process item "CREATE_BUSINESS_PARTNER_NUMBER_PULL" is created the portal will try to pull a response from the bpdm to get the bpn for the company. When receiving the valid bpn the checklist item "Business Partner Number" is set to "DONE", if the "VERFIY REGISTRATION" is already in state "DONE", the process item "CREATE_IDENTITY_WALLET" is created. +1. The call to the external system was successful. Then the process step "CREATE_BUSINESS_PARTNER_NUMBER_PUSH" is set to "DONE" and the checklist item "Business Partner Number" is set to "IN_PROGRESS". After that the process item "CREATE_BUSINESS_PARTNER_NUMBER_PULL" is created. Currently there is not implementation to push the data back to the portal. Therefore as soon as the process item "CREATE_BUSINESS_PARTNER_NUMBER_PULL" is created the portal will try to pull a response from the bpdm to get the bpn for the company. When receiving the valid bpn the checklist item "Business Partner Number" is set to "DONE", if the "VERIFY REGISTRATION" is already in state "DONE", the process item "CREATE_IDENTITY_WALLET" is created. 2. The call to the external system failed. The checklist item "BUSINESS_PARTNER_NUMBER" is set to "FAILED". A process item "RETRIGGER_BUSINESS_PARTNER_NUMBER_PUSH" is created afterwards to enable the restart a failed BPN process. @@ -358,7 +358,7 @@ Depending on the API response, the system will behave in the following way: - Response "Fail" => store the error message in the checklist table under checklist.comment and set the status to "FAILED" - Response "Success" => set status to "DONE" and store the did provided by the response body inside the comment attribute inside the table checklist.comment -If for some reason the call to the identity wallet failes, a new process item "RETRIGGER_IDENTITY_WALLET" is created. This process item allows the operator to manually retrigger the process with the following endpoint: +If for some reason the call to the identity wallet fails, a new process item "RETRIGGER_IDENTITY_WALLET" is created. This process item allows the operator to manually retrigger the process with the following endpoint: ```diff ! POST /api/administration/registration/application/{applicationId}/trigger-identity-wallet @@ -387,7 +387,7 @@ The "Clearinghouse Check" is getting automatically triggered when the following image
-The interface is an asynchrony interface - due to this the application checklist item associates with two process steps; the interface is explained below in two steps +The interface is an asynchronous interface - due to this the application checklist item associates with two process steps; the interface is explained below in two steps ###### Step 1 - Send company data to clearinghouse @@ -426,7 +426,7 @@ If for some reason the call to the identity wallet or clearinghouse fails, a new ###### Step 2 - Clearinghouse response -In the asyncron call of the clearinghouse check; the portal provides a POST endpoint, which can get triggered by the clearinghouse to update the checklist status. +In the asynchronous call of the clearinghouse check; the portal provides a POST endpoint, which can get triggered by the clearinghouse to update the checklist status.
the clearinghouse needs to be able to store a fail/success message. the message is supposed to get stored inside the checklist comment of the record attribute "clearing_house" @@ -479,11 +479,11 @@ The "Self_Description_Legal_Participant" is getting automatically triggered when - application is in status "submitted"
-The interface is an asynchrony interface - due to this the application checklist item associates with two process steps; the interface is explained below in two steps +The interface is an asynchronous interface - due to this the application checklist item associates with two process steps; the interface is explained below in two steps ###### Step 1 - Create SelfDescription - send company data to SD Factory -The checklist worker checks for the existence of the "START_SELF_DESCRIPTION_LP" process item in state "TODO", when existing the process will automatically post the necessarry data to the SD-Factory to register the self description. A new process item "FINISH_SELF_DESCRIPTION_LP" is created. And the status of the "SELF_DESCRIPTION_LP" checklist item is set to "IN_PROGRESS". +The checklist worker checks for the existence of the "START_SELF_DESCRIPTION_LP" process item in state "TODO", when existing the process will automatically post the necessary data to the SD-Factory to register the self description. A new process item "FINISH_SELF_DESCRIPTION_LP" is created. And the status of the "SELF_DESCRIPTION_LP" checklist item is set to "IN_PROGRESS". Request Body for SD-Factory call @@ -505,7 +505,7 @@ Request Body for SD-Factory call ###### Step 2 - Save self description document -To receive the asyncronos call from the SD-Factory the portal provides a POST endpoint, which can get triggered by the SD-Factory to pass the self description document and or a failed status with a explaining message. +To receive the asynchronous call from the SD-Factory the portal provides a POST endpoint, which can get triggered by the SD-Factory to pass the self description document and or a failed status with a explaining message.
```diff @@ -519,7 +519,7 @@ To receive the asyncronos call from the SD-Factory the portal provides a POST en "selfDescriptionDocument": "string" } -with calling the endpoint; the SD Factory submittes a self-description of the legal person. The portal backend is storing the self-description inside the portal db linked to the company. +with calling the endpoint; the SD Factory submits a self-description of the legal person. The portal backend is storing the self-description inside the portal db linked to the company.
With triggering the endpoint and submitting a document, the status of the checklist item "Self_Description_LP" is set to "DONE".
@@ -574,7 +574,7 @@ With the execution of the application activation, the system will: - set company_application time stamp - set invitation of all users to "CLOSED" - set invitation time stamp -- update user roles (portal db and keycloak) +- update user roles (portal db and Keycloak) - add bpn to user(s) - send a welcome email @@ -628,3 +628,11 @@ Response Body ### Details for retrigger process retriggering any process manually always deletes the current saved comment inside application_checklist.comment to ensure that the reason for the earlier failed execution is not getting displayed to the user anymore. + +## NOTICE + +This work is licensed under the [Apache-2.0](https://www.apache.org/licenses/LICENSE-2.0). + +- SPDX-License-Identifier: Apache-2.0 +- SPDX-FileCopyrightText: 2021-2023 Contributors to the Eclipse Foundation +- Source URL: https://github.com/eclipse-tractusx/portal-assets diff --git a/developer/01. Onboarding/03. Registration Approval/04. Decline Application.md b/developer/01. Onboarding/03. Registration Approval/04. Decline Application.md index f2eb738f6..bb7b25899 100644 --- a/developer/01. Onboarding/03. Registration Approval/04. Decline Application.md +++ b/developer/01. Onboarding/03. Registration Approval/04. Decline Application.md @@ -31,7 +31,7 @@ Request Body: > **Warning** > In the current state of implementation the checklist worker and manual process intervention such as the cancellation have no validation/check implemented where the services can validate if the other service might already run. Means; in the unlikely case that the cancellation is triggered while the activation is running in parallel; the activation might overrule the cancellation. -> The scenario is very unlikely and will get handled in an upcomming release. +> The scenario is very unlikely and will get handled in an upcoming release.

@@ -43,3 +43,11 @@ Input field validations input field FE

+ +## NOTICE + +This work is licensed under the [Apache-2.0](https://www.apache.org/licenses/LICENSE-2.0). + +- SPDX-License-Identifier: Apache-2.0 +- SPDX-FileCopyrightText: 2021-2023 Contributors to the Eclipse Foundation +- Source URL: https://github.com/eclipse-tractusx/portal-assets diff --git a/developer/01. Onboarding/03. Registration Approval/index.md b/developer/01. Onboarding/03. Registration Approval/index.md index 6fc8685db..d096cb548 100644 --- a/developer/01. Onboarding/03. Registration Approval/index.md +++ b/developer/01. Onboarding/03. Registration Approval/index.md @@ -5,7 +5,7 @@ The registration approval board is created for the CX Admin to managed registrat Acting user: CX Admin (Operator)

-The board supports filter, serach and the actual approval / validation function of new company registration requests. +The board supports filter, search and the actual approval / validation function of new company registration requests.

image @@ -36,3 +36,11 @@ With using the application details button, application details such as

+ +## NOTICE + +This work is licensed under the [Apache-2.0](https://www.apache.org/licenses/LICENSE-2.0). + +- SPDX-License-Identifier: Apache-2.0 +- SPDX-FileCopyrightText: 2021-2023 Contributors to the Eclipse Foundation +- Source URL: https://github.com/eclipse-tractusx/portal-assets diff --git a/developer/02. Technical Integration/01. Connector Registration/01. Summary.md b/developer/02. Technical Integration/01. Connector Registration/01. Summary.md index 35b816aa9..4dd582da6 100644 --- a/developer/02. Technical Integration/01. Connector Registration/01. Summary.md +++ b/developer/02. Technical Integration/01. Connector Registration/01. Summary.md @@ -24,3 +24,11 @@ In the technical integration / setup of the connector, 3 different scenarios are image

+ +## NOTICE + +This work is licensed under the [Apache-2.0](https://www.apache.org/licenses/LICENSE-2.0). + +- SPDX-License-Identifier: Apache-2.0 +- SPDX-FileCopyrightText: 2021-2023 Contributors to the Eclipse Foundation +- Source URL: https://github.com/eclipse-tractusx/portal-assets diff --git a/developer/02. Technical Integration/01. Connector Registration/02. View Connector.md b/developer/02. Technical Integration/01. Connector Registration/02. View Connector.md index f727d9d0a..4750ff5fd 100644 --- a/developer/02. Technical Integration/01. Connector Registration/02. View Connector.md +++ b/developer/02. Technical Integration/01. Connector Registration/02. View Connector.md @@ -155,3 +155,11 @@ Data Mapping

+ +## NOTICE + +This work is licensed under the [Apache-2.0](https://www.apache.org/licenses/LICENSE-2.0). + +- SPDX-License-Identifier: Apache-2.0 +- SPDX-FileCopyrightText: 2021-2023 Contributors to the Eclipse Foundation +- Source URL: https://github.com/eclipse-tractusx/portal-assets diff --git a/developer/02. Technical Integration/01. Connector Registration/03. Create new Connector Registration.md b/developer/02. Technical Integration/01. Connector Registration/03. Create new Connector Registration.md index f35244686..b0651e60f 100644 --- a/developer/02. Technical Integration/01. Connector Registration/03. Create new Connector Registration.md +++ b/developer/02. Technical Integration/01. Connector Registration/03. Create new Connector Registration.md @@ -228,3 +228,11 @@ Request Body

+ +## NOTICE + +This work is licensed under the [Apache-2.0](https://www.apache.org/licenses/LICENSE-2.0). + +- SPDX-License-Identifier: Apache-2.0 +- SPDX-FileCopyrightText: 2021-2023 Contributors to the Eclipse Foundation +- Source URL: https://github.com/eclipse-tractusx/portal-assets diff --git a/developer/02. Technical Integration/01. Connector Registration/05. Self Description.md b/developer/02. Technical Integration/01. Connector Registration/05. Self Description.md index ba7b05abf..70b46117e 100644 --- a/developer/02. Technical Integration/01. Connector Registration/05. Self Description.md +++ b/developer/02. Technical Integration/01. Connector Registration/05. Self Description.md @@ -35,7 +35,7 @@ Request Body: ”termsAndConditions”: "", “policies”: "", "issuer": "portal operator bpn", - "holder": "bpn of the provider received inside the request body of the POSt /connector endpoint" + "holder": "bpn of the provider received inside the request body of the POST /connector endpoint" }
@@ -64,7 +64,15 @@ Request Body:
-To trigger the endpoint a technical user is needed. This technical user is issued by the portal adminsitrator only. Own creation of the technical user is not possible. +To trigger the endpoint a technical user is needed. This technical user is issued by the portal administrator only. Own creation of the technical user is not possible.

+ +## NOTICE + +This work is licensed under the [Apache-2.0](https://www.apache.org/licenses/LICENSE-2.0). + +- SPDX-License-Identifier: Apache-2.0 +- SPDX-FileCopyrightText: 2021-2023 Contributors to the Eclipse Foundation +- Source URL: https://github.com/eclipse-tractusx/portal-assets diff --git a/developer/02. Technical Integration/01. Connector Registration/06. Delete Connector.md b/developer/02. Technical Integration/01. Connector Registration/06. Delete Connector.md index b8df3cddf..0d29229c1 100644 --- a/developer/02. Technical Integration/01. Connector Registration/06. Delete Connector.md +++ b/developer/02. Technical Integration/01. Connector Registration/06. Delete Connector.md @@ -30,3 +30,11 @@ With the deletion, the SD document is set to "DELETED" and the connector retriev

+ +## NOTICE + +This work is licensed under the [Apache-2.0](https://www.apache.org/licenses/LICENSE-2.0). + +- SPDX-License-Identifier: Apache-2.0 +- SPDX-FileCopyrightText: 2021-2023 Contributors to the Eclipse Foundation +- Source URL: https://github.com/eclipse-tractusx/portal-assets diff --git a/developer/02. Technical Integration/01. Connector Registration/07. Error Handling.md b/developer/02. Technical Integration/01. Connector Registration/07. Error Handling.md index 4ee898947..f6fb88711 100644 --- a/developer/02. Technical Integration/01. Connector Registration/07. Error Handling.md +++ b/developer/02. Technical Integration/01. Connector Registration/07. Error Handling.md @@ -11,7 +11,7 @@ For the connector table - show owned and managed connectors - following error sc #### #1 Scenario: No Data available -In the scenario of no connector data are available - no connectors are so far registered, the resepctive message in the supported language will be displayed to the user. +In the scenario of no connector data are available - no connectors are so far registered, the respective message in the supported language will be displayed to the user. de-message: Derzeit sind keine verwalteten Konnektoren vorhanden. Neue verwaltete Konnektoren werden hier hinzugefügt, sobald diese hinzugefügt wurden. en-message: Currently no managed connectors are existing. New managed connectors will get added here as soon as available. @@ -37,3 +37,11 @@ In case the endpoint runs on an 4xx error the following error will get displayed image
+ +## NOTICE + +This work is licensed under the [Apache-2.0](https://www.apache.org/licenses/LICENSE-2.0). + +- SPDX-License-Identifier: Apache-2.0 +- SPDX-FileCopyrightText: 2021-2023 Contributors to the Eclipse Foundation +- Source URL: https://github.com/eclipse-tractusx/portal-assets diff --git a/developer/02. Technical Integration/02. Identity Provider Management/01. Summary.md b/developer/02. Technical Integration/02. Identity Provider Management/01. Summary.md index 4d56cc74f..1151b5c44 100644 --- a/developer/02. Technical Integration/02. Identity Provider Management/01. Summary.md +++ b/developer/02. Technical Integration/02. Identity Provider Management/01. Summary.md @@ -6,8 +6,16 @@ The IdP Switch function is used to integrate / connect company idp's or switch b The integration of company idp's is suspected to be the most used scenario when considering the use of idp switch. Companies which want to use their own company authentication can connect their company idp with the catena-x shared idp by using user federation.
-In this scenario - authentication is delivered by the company idp and authorization is still managed inside keycloak. +In this scenario - authentication is delivered by the company idp and authorization is still managed inside Keycloak.
The biggest positive element on ownCompany idp usage is the comfort of the login, as well as the user credentials which are not shared with an operator.
+ +## NOTICE + +This work is licensed under the [Apache-2.0](https://www.apache.org/licenses/LICENSE-2.0). + +- SPDX-License-Identifier: Apache-2.0 +- SPDX-FileCopyrightText: 2021-2023 Contributors to the Eclipse Foundation +- Source URL: https://github.com/eclipse-tractusx/portal-assets diff --git a/developer/02. Technical Integration/02. Identity Provider Management/02. Company IdPs.md b/developer/02. Technical Integration/02. Identity Provider Management/02. Company IdPs.md index 395ed7e5c..556ba7b6c 100644 --- a/developer/02. Technical Integration/02. Identity Provider Management/02. Company IdPs.md +++ b/developer/02. Technical Integration/02. Identity Provider Management/02. Company IdPs.md @@ -10,9 +10,9 @@ Functional Link: [Link](/docs/02.%20Technical%20Integration/02.%20Identity%20Pro ### Implementation -* [ ] each idp record received via the endpoint GET /api/administration/identityprovider/owncompany/identityproviders will be displayed/shown in the idp record table -* [ ] inside the idp table, the progress of each IdP is displayed with colors - depending on the idp status (enabled: true; enabled: false) -* [ ] the idp progress element supports hover. When the user curser hovers the element, additional details (as defined below) are getting displayed. +- [ ] each idp record received via the endpoint GET /api/administration/identityprovider/owncompany/identityproviders will be displayed/shown in the idp record table +- [ ] inside the idp table, the progress of each IdP is displayed with colors - depending on the idp status (enabled: true; enabled: false) +- [ ] the idp progress element supports hover. When the user curser hovers the element, additional details (as defined below) are getting displayed.
@@ -40,8 +40,6 @@ DE: "IdP-Eintrag erstellt. Status deaktiviert und Konfiguration erforderlich." EN: "IdP record created. Status deactivated and configuration necessary." - - Status #3 Display the status element as shown below, if the IdP is available, has a "clientId" value but is inactive @@ -58,8 +56,6 @@ DE: "Der IdP ist derzeit deaktiviert. Sie können den Datensatz aktivieren, um d EN: "The IdP is currently disabled. You can activate the record to use the IdP for login." - - Status #4 IdP active. Means => the IdP is enabled (enabled=true) @@ -89,14 +85,23 @@ GET: api/administration/identityprovider/owncompany/identityproviders
-keep the existing business logic in place which is retrieving the company idp's based on the data available in portal.company_identity_providers -additionally include those idps where the user acting company is mentioned as "owner" inside identity_providers.owners +keep the existing business logic in place which is retrieving the company IdP's based on the data available in portal.company_identity_providers +additionally include those IdPs where the user acting company is mentioned as "owner" inside identity_providers.owners add inside the response body the identity_provider_type (please use the "label" not the "id")

Connected Functions: -* [Configure Company](/developer/02.%20Technical%20Integration/02.%20Identity%20Provider%20Management/02.%20Configure%20Company%20IdP.md) -* [User Migration New IdP](/developer/02.%20Technical%20Integration/02.%20Identity%20Provider%20Management/03.%20User%20Migration.md) -* [User Migration New IdP](/developer/02.%20Technical%20Integration/02.%20Identity%20Provider%20Management/04.%20Delete%20Identity%20Provider.md) + +- [Configure Company](/developer/02.%20Technical%20Integration/02.%20Identity%20Provider%20Management/02.%20Configure%20Company%20IdP.md) +- [User Migration New IdP](/developer/02.%20Technical%20Integration/02.%20Identity%20Provider%20Management/03.%20User%20Migration.md) +- [User Migration New IdP](/developer/02.%20Technical%20Integration/02.%20Identity%20Provider%20Management/04.%20Delete%20Identity%20Provider.md) + +## NOTICE + +This work is licensed under the [Apache-2.0](https://www.apache.org/licenses/LICENSE-2.0). + +- SPDX-License-Identifier: Apache-2.0 +- SPDX-FileCopyrightText: 2021-2023 Contributors to the Eclipse Foundation +- Source URL: https://github.com/eclipse-tractusx/portal-assets diff --git a/developer/02. Technical Integration/02. Identity Provider Management/02. Configure Company IdP.md b/developer/02. Technical Integration/02. Identity Provider Management/02. Configure Company IdP.md index d98246fa8..6fe01cfb3 100644 --- a/developer/02. Technical Integration/02. Identity Provider Management/02. Configure Company IdP.md +++ b/developer/02. Technical Integration/02. Identity Provider Management/02. Configure Company IdP.md @@ -1,4 +1,3 @@ - ## IDP Configuration Functional Link: [Link](/docs/02.%20Technical%20Integration/02.%20Identity%20Provider%20Management/02.%20Configure%20Company%20IdP.md) @@ -6,7 +5,8 @@ Functional Link: [Link](/docs/02.%20Technical%20Integration/02.%20Identity%20Pro
### Create IdP -The initital overlay is used to create the IdP record with the respective IdP type. Currently only OIDC is supported and not enhancement to other types are planned. + +The initial overlay is used to create the IdP record with the respective IdP type. Currently only OIDC is supported and not enhancement to other types are planned.
@@ -17,18 +17,19 @@ The initital overlay is used to create the IdP record with the respective IdP ty
The configuration of the IdP includes the -* Display Name - displayed in the login screen on the company select page - please use a name which the user can relate too; also its important to use a unique value -* Identity Provider Type - sets the type of the IdP; own in case the new configured IdP is used for the own company only; managed if the new configured IdP is supposed to get used for thrid parties - this is only possible for OSPs and OpCos -* Authentication Method - as per latest standards only OIDC is supported -
+ +- Display Name - displayed in the login screen on the company select page - please use a name which the user can relate too; also its important to use a unique value +- Identity Provider Type - sets the type of the IdP; own in case the new configured IdP is used for the own company only; managed if the new configured IdP is supposed to get used for third parties - this is only possible for OSPs and OpCos +- Authentication Method - as per latest standards only OIDC is supported +
#### Implementation details: -* [ ] if the user clicks on the action button "create new IdP" the overlay (see above) is getting displayed with the new design -* [ ] the overlay has an "cancel" (not "back") button which is clickable by the user and results into an closed overlay -* [ ] the button "create IdP entry" is only active if the Display Name is entered -* [ ] "create IdP entry" needs to support load function as long as the backend API did not response to the FE - the user should be only able to click the button once and the button should display a load element till backend response is available. -* [ ] if the "create IdP entry" fails, display inside the overlay an error and let the user not direct to the next page (design support to be requested by Anni - I informed her already) +- [ ] if the user clicks on the action button "create new IdP" the overlay (see above) is getting displayed with the new design +- [ ] the overlay has an "cancel" (not "back") button which is clickable by the user and results into an closed overlay +- [ ] the button "create IdP entry" is only active if the Display Name is entered +- [ ] "create IdP entry" needs to support load function as long as the backend API did not response to the FE - the user should be only able to click the button once and the button should display a load element till backend response is available. +- [ ] if the "create IdP entry" fails, display inside the overlay an error and let the user not direct to the next page

@@ -39,17 +40,17 @@ The configuration of the IdP includes the Endpoint POST: api/administration/identityprovider/owncompany/identityproviders ``` -got enahnced by adding the typeId* inside the request body +got enhanced by adding the typeId\* inside the request body -*typeIds: MANAGED and OWN are supported; SHARED not - user cant create on request a SHARED IdP +\*typeIds: MANAGED and OWN are supported; SHARED not - user cant create on request a SHARED IdP
Validations: -* "identityProviderType: "managed"" is only allowed/possible if the acting user assigned company is either a OSP or an operator (to be checked via company_assigned_role) -* "identityProviderType: "own"" is allowed no matter which role the company of the acting user owns -* "identityProviderType: "shared"" is allowed.... +- "identityProviderType: "managed"" is only allowed/possible if the acting user assigned company is either a OSP or an operator (to be checked via company_assigned_role) +- "identityProviderType: "own"" is allowed no matter which role the company of the acting user owns +- "identityProviderType: "shared"" is allowed....

@@ -62,6 +63,7 @@ no matter which identityProviderType is used, store the user assigned company as
### Configure IdP + After the idp record creation, the idp needs to get configured with the respective authentication details and connect urls.
@@ -73,20 +75,21 @@ After the idp record creation, the idp needs to get configured with the respecti
The configuration of the IdP includes the -* metadata url - this is the configuration url - public available/accessible to to fetch the customer idp config details (such as: logout url, userinfo url, redirect url, etc.) -* client id - generated on the customer IdP to allow the CX idp to connect for user federation between the customer idp and the CX idp -* secret - generated on the customer IdP to allow the CX idp to connect for user federation between the customer idp and the CX idp + +- metadata url - this is the configuration url - public available/accessible to to fetch the customer idp config details (such as: logout url, userinfo url, redirect url, etc.) +- client id - generated on the customer IdP to allow the CX idp to connect for user federation between the customer idp and the CX idp +- secret - generated on the customer IdP to allow the CX idp to connect for user federation between the customer idp and the CX idp
#### Implementation details: -* [ ] all information displayed in the blue table section (bottom) are fetched from the api ; all other fields are input fields and need input patterns and error messages -* [ ] add question mark icons for the different input fields via locale files (this should be already implemented, please check if it already supports multi language) -* [ ] metadata url icon is a copy icon which acts on hover as well as on click. When clicking the metadata url is getting saved inside the clipboard and icon turns green to show the user that the "save" was successful. Please recheck the behavior with Anni to also get her design confirmation on the function -* [ ] as soon as all input fields are added with content without errors, the user can click "Save Metadata" -* [ ] "Save Metadata" needs to support load function as long as the backend API did not response to the FE - the user should be only able to click the button once and the button should display a load element till backend response is available. -* [ ] if the "Save Metadata" fails, display inside the overlay an error and let the user not direct to the next page +- [ ] all information displayed in the blue table section (bottom) are fetched from the api; all other fields are input fields and need input patterns and error messages +- [ ] add question mark icons for the different input fields via locale files (this should be already implemented, please check if it already supports multi language) +- [ ] metadata url icon is a copy icon which acts on hover as well as on click. When clicking the metadata url is getting saved inside the clipboard and icon turns green to show the user that the "save" was successful +- [ ] as soon as all input fields are added with content without errors, the user can click "Save Metadata" +- [ ] "Save Metadata" needs to support load function as long as the backend API did not response to the FE - the user should be only able to click the button once and the button should display a load element till backend response is available. +- [ ] if the "Save Metadata" fails, display inside the overlay an error and let the user not direct to the next page

@@ -102,14 +105,16 @@ PUT /api/administration/identityprovider/owncompany/identityproviders/{identityP
when calling the endpoint - validate the acting user assigned company and check if the company is listed as the idp owner (via identity_providers.owner) - * if yes, proceed - * if no, exception needed - "User not allowed to run the change for identity provider {identityProviderId}" + +- if yes, proceed +- if no, exception needed - "User not allowed to run the change for identity provider {identityProviderId}"

### User Connection -The final step is the user connection test. For this the acting user needs to enter the user ID of thereself into the input field. This user ID will get stored and is the unique identifier when performing the login. Via this ID the existing user account inside the portal iam solution is getting linked to the company IdP user account. This enables the user to login with the already assigned user roles. + +The final step is the user connection test. For this the acting user needs to enter the own user ID into the input field. This user ID will get stored and is the unique identifier when performing the login. Via this ID the existing user account inside the portal iam solution is getting linked to the company IdP user account. This enables the user to login with the already assigned user roles.

image @@ -119,12 +124,12 @@ The final step is the user connection test. For this the acting user needs to en Implementation details: -* [ ] if the user clicks on the action button "save metadata" the configuration overlay (see above) is getting displayed with the new design -* [ ] with the back button the user gets directed to the previous screen (note - currently we can not display any pre-entered data inside the screen - but its planned to do this asap) - means display "***" for the client secret, display the client id and the metadata url (currently this is not possible - we should discuss this as soon as I am back from vacation) -* [ ] the input fields needs input pattern, error message and support icon with multi language support -* [ ] if the input field is filled, the "connect" button will be active and clickable -* [ ] "connect" needs to support load function as long as the backend API did not response to the FE - the user should be only able to click the button once and the button should display a load element till backend response is available. -* [ ] if the "connect" fails, display inside the overlay an error and let the user not direct to the next page +- [ ] if the user clicks on the action button "save metadata" the configuration overlay (see above) is getting displayed with the new design +- [ ] with the back button the user gets directed to the previous screen (note - currently we can not display any pre-entered data inside the screen - but its planned to do this asap) - means display "\*\*\*" for the client secret, display the client id and the metadata url (currently this is not possible - we should discuss this as soon as I am back from vacation) +- [ ] the input fields needs input pattern, error message and support icon with multi language support +- [ ] if the input field is filled, the "connect" button will be active and clickable +- [ ] "connect" needs to support load function as long as the backend API did not response to the FE - the user should be only able to click the button once and the button should display a load element till backend response is available. +- [ ] if the "connect" fails, display inside the overlay an error and let the user not direct to the next page

@@ -137,7 +142,15 @@ Implementation details: Implementation details: -* n/a +- n/a

+ +## NOTICE + +This work is licensed under the [Apache-2.0](https://www.apache.org/licenses/LICENSE-2.0). + +- SPDX-License-Identifier: Apache-2.0 +- SPDX-FileCopyrightText: 2021-2023 Contributors to the Eclipse Foundation +- Source URL: https://github.com/eclipse-tractusx/portal-assets diff --git a/developer/02. Technical Integration/02. Identity Provider Management/03. User Migration.md b/developer/02. Technical Integration/02. Identity Provider Management/03. User Migration.md index abcbd6d28..ac875300d 100644 --- a/developer/02. Technical Integration/02. Identity Provider Management/03. User Migration.md +++ b/developer/02. Technical Integration/02. Identity Provider Management/03. User Migration.md @@ -25,13 +25,14 @@ Request Body supports filtering users for a specific IdP (in case several IdPs a
Response: csv file with following values: -* UserId -* FirstName -* LastName -* Email -* ProviderAlias -* ProviderUserId -* ProviderUserName + +- UserId +- FirstName +- LastName +- Email +- ProviderAlias +- ProviderUserId +- ProviderUserName

@@ -62,10 +63,10 @@ Response Body Validations: -* check if all users included in the list are linked to the acting users company -* ??? -* ??? -* ??? +- check if all users included in the list are linked to the acting users company +- ??? +- ??? +- ???

@@ -76,3 +77,11 @@ Business Logic Change:

+ +## NOTICE + +This work is licensed under the [Apache-2.0](https://www.apache.org/licenses/LICENSE-2.0). + +- SPDX-License-Identifier: Apache-2.0 +- SPDX-FileCopyrightText: 2021-2023 Contributors to the Eclipse Foundation +- Source URL: https://github.com/eclipse-tractusx/portal-assets diff --git a/developer/02. Technical Integration/02. Identity Provider Management/04. Delete Identity Provider.md b/developer/02. Technical Integration/02. Identity Provider Management/04. Delete Identity Provider.md index 48cae24f6..57fe59e85 100644 --- a/developer/02. Technical Integration/02. Identity Provider Management/04. Delete Identity Provider.md +++ b/developer/02. Technical Integration/02. Identity Provider Management/04. Delete Identity Provider.md @@ -17,11 +17,11 @@ If there are users assigned to this IdP only, those users won't be able to login #### Implementation details: -* [ ] "Delete IdP" option is available under the "Action" sub-menu -* [ ] "Delete IdP" option is only visible for IdPs which are deactivated -* [ ] when clicking on "Delete IdP" the endpoint to delete the IdP (already implemented) is running, till the delete process was successful/unsuccessful the user should see a "load" icon inside the sub-menu and cant re-trigger the menu item -* [ ] if the idp delete is successful, the respective information "IdP got deleted" is displayed on the top right and auto closes after 5 seconds (see design below) and the idp is gone from the idp list on the main page -* [ ] if the idp delete is unsuccessful, same as for the success the error is getting displayed on the top right; with the message "Something went wrong. IdP got not deleted." +- [ ] "Delete IdP" option is available under the "Action" sub-menu +- [ ] "Delete IdP" option is only visible for IdPs which are deactivated +- [ ] when clicking on "Delete IdP" the endpoint to delete the IdP (already implemented) is running, till the delete process was successful/unsuccessful the user should see a "load" icon inside the sub-menu and cant re-trigger the menu item +- [ ] if the idp delete is successful, the respective information "IdP got deleted" is displayed on the top right and auto closes after 5 seconds (see design below) and the idp is gone from the idp list on the main page +- [ ] if the idp delete is unsuccessful, same as for the success the error is getting displayed on the top right; with the message "Something went wrong. IdP got not deleted."

@@ -43,3 +43,11 @@ interim only possible for SHARED AND OWN IdPs

+ +## NOTICE + +This work is licensed under the [Apache-2.0](https://www.apache.org/licenses/LICENSE-2.0). + +- SPDX-License-Identifier: Apache-2.0 +- SPDX-FileCopyrightText: 2021-2023 Contributors to the Eclipse Foundation +- Source URL: https://github.com/eclipse-tractusx/portal-assets diff --git a/developer/02. Technical Integration/02. Identity Provider Management/04. FAQ.md b/developer/02. Technical Integration/02. Identity Provider Management/04. FAQ.md index 491021c70..fafca0f8a 100644 --- a/developer/02. Technical Integration/02. Identity Provider Management/04. FAQ.md +++ b/developer/02. Technical Integration/02. Identity Provider Management/04. FAQ.md @@ -19,3 +19,11 @@

+ +## NOTICE + +This work is licensed under the [Apache-2.0](https://www.apache.org/licenses/LICENSE-2.0). + +- SPDX-License-Identifier: Apache-2.0 +- SPDX-FileCopyrightText: 2021-2023 Contributors to the Eclipse Foundation +- Source URL: https://github.com/eclipse-tractusx/portal-assets diff --git a/developer/02. Technical Integration/02. Identity Provider Management/05. Disable Identity Provider.md b/developer/02. Technical Integration/02. Identity Provider Management/05. Disable Identity Provider.md index f08ed6e05..f220a31d2 100644 --- a/developer/02. Technical Integration/02. Identity Provider Management/05. Disable Identity Provider.md +++ b/developer/02. Technical Integration/02. Identity Provider Management/05. Disable Identity Provider.md @@ -16,12 +16,12 @@ The disablement of IdPs supports the user to delete the IdP in a later stage. #### Implementation details: -* [ ] "Disable IdP" is available in the "Action" sub-menu -* [ ] "Disable IdP" is only available if minimum 2 IdPs have the status enabled: true; otherwise the "Disable IdP" functionality is deactivated and can not get triggered -* [ ] when clicking on "Disable IdP" the endpoint to disable the IdP (already implemented) is running, till the disable process was successful we should ideally see a "load" icon inside the sub-menu -* [ ] if the idp disable is successful, the respective information "IdP got disabled" is displayed on the top right and auto closes after 5 seconds (see design below) -* [ ] if the idp disable is unsuccessful, same as for the success the error is getting displayed on the top right; with the message "Something went wrong. IdP got not disabled." -* [ ] idps which are completely configured but deactivated get the status and progress "disabled" (see details below) +- [ ] "Disable IdP" is available in the "Action" sub-menu +- [ ] "Disable IdP" is only available if minimum 2 IdPs have the status enabled: true; otherwise the "Disable IdP" functionality is deactivated and can not get triggered +- [ ] when clicking on "Disable IdP" the endpoint to disable the IdP (already implemented) is running, till the disable process was successful we should ideally see a "load" icon inside the sub-menu +- [ ] if the idp disable is successful, the respective information "IdP got disabled" is displayed on the top right and auto closes after 5 seconds (see design below) +- [ ] if the idp disable is unsuccessful, same as for the success the error is getting displayed on the top right; with the message "Something went wrong. IdP got not disabled." +- [ ] idps which are completely configured but deactivated get the status and progress "disabled" (see details below)

@@ -34,3 +34,11 @@ POST api/administration/identityprovider/owncompany/identityproviders/{identityP

+ +## NOTICE + +This work is licensed under the [Apache-2.0](https://www.apache.org/licenses/LICENSE-2.0). + +- SPDX-License-Identifier: Apache-2.0 +- SPDX-FileCopyrightText: 2021-2023 Contributors to the Eclipse Foundation +- Source URL: https://github.com/eclipse-tractusx/portal-assets diff --git a/developer/02. Technical Integration/03. Company Configuration/01. Summary.md b/developer/02. Technical Integration/03. Company Configuration/01. Summary.md index 58fac8327..7b6378ff3 100644 --- a/developer/02. Technical Integration/03. Company Configuration/01. Summary.md +++ b/developer/02. Technical Integration/03. Company Configuration/01. Summary.md @@ -1 +1,9 @@ content will follow soon + +## NOTICE + +This work is licensed under the [Apache-2.0](https://www.apache.org/licenses/LICENSE-2.0). + +- SPDX-License-Identifier: Apache-2.0 +- SPDX-FileCopyrightText: 2021-2023 Contributors to the Eclipse Foundation +- Source URL: https://github.com/eclipse-tractusx/portal-assets diff --git a/developer/02. Technical Integration/03. Company Configuration/02. View Preferred Use Cases.md b/developer/02. Technical Integration/03. Company Configuration/02. View Preferred Use Cases.md index a455be302..2023828e1 100644 --- a/developer/02. Technical Integration/03. Company Configuration/02. View Preferred Use Cases.md +++ b/developer/02. Technical Integration/03. Company Configuration/02. View Preferred Use Cases.md @@ -24,3 +24,11 @@ Response Body

+ +## NOTICE + +This work is licensed under the [Apache-2.0](https://www.apache.org/licenses/LICENSE-2.0). + +- SPDX-License-Identifier: Apache-2.0 +- SPDX-FileCopyrightText: 2021-2023 Contributors to the Eclipse Foundation +- Source URL: https://github.com/eclipse-tractusx/portal-assets diff --git a/developer/02. Technical Integration/03. Company Configuration/03. Add new Use Case.md b/developer/02. Technical Integration/03. Company Configuration/03. Add new Use Case.md index 34c590c0b..655d4c743 100644 --- a/developer/02. Technical Integration/03. Company Configuration/03. Add new Use Case.md +++ b/developer/02. Technical Integration/03. Company Configuration/03. Add new Use Case.md @@ -19,3 +19,11 @@ Request Body

+ +## NOTICE + +This work is licensed under the [Apache-2.0](https://www.apache.org/licenses/LICENSE-2.0). + +- SPDX-License-Identifier: Apache-2.0 +- SPDX-FileCopyrightText: 2021-2023 Contributors to the Eclipse Foundation +- Source URL: https://github.com/eclipse-tractusx/portal-assets diff --git a/developer/02. Technical Integration/03. Company Configuration/04. Delete Preferred Use Case.md b/developer/02. Technical Integration/03. Company Configuration/04. Delete Preferred Use Case.md index 6c23b9743..0c6b42f4a 100644 --- a/developer/02. Technical Integration/03. Company Configuration/04. Delete Preferred Use Case.md +++ b/developer/02. Technical Integration/03. Company Configuration/04. Delete Preferred Use Case.md @@ -19,3 +19,11 @@ Request Body

+ +## NOTICE + +This work is licensed under the [Apache-2.0](https://www.apache.org/licenses/LICENSE-2.0). + +- SPDX-License-Identifier: Apache-2.0 +- SPDX-FileCopyrightText: 2021-2023 Contributors to the Eclipse Foundation +- Source URL: https://github.com/eclipse-tractusx/portal-assets diff --git a/developer/02. Technical Integration/03. Company Configuration/05. Change Company Role.md b/developer/02. Technical Integration/03. Company Configuration/05. Change Company Role.md index 2bf25771d..3ebf2e7f9 100644 --- a/developer/02. Technical Integration/03. Company Configuration/05. Change Company Role.md +++ b/developer/02. Technical Integration/03. Company Configuration/05. Change Company Role.md @@ -95,3 +95,11 @@ The request will get in real time approved and the role assigned.

+ +## NOTICE + +This work is licensed under the [Apache-2.0](https://www.apache.org/licenses/LICENSE-2.0). + +- SPDX-License-Identifier: Apache-2.0 +- SPDX-FileCopyrightText: 2021-2023 Contributors to the Eclipse Foundation +- Source URL: https://github.com/eclipse-tractusx/portal-assets diff --git a/developer/02. Technical Integration/04. Credentials/00. Wallet Creation.md b/developer/02. Technical Integration/04. Credentials/00. Wallet Creation.md index c778979bd..979c60dcc 100644 --- a/developer/02. Technical Integration/04. Credentials/00. Wallet Creation.md +++ b/developer/02. Technical Integration/04. Credentials/00. Wallet Creation.md @@ -19,3 +19,11 @@ Each dataspace participant will receive (as part of the registration process) 2

+ +## NOTICE + +This work is licensed under the [Apache-2.0](https://www.apache.org/licenses/LICENSE-2.0). + +- SPDX-License-Identifier: Apache-2.0 +- SPDX-FileCopyrightText: 2021-2023 Contributors to the Eclipse Foundation +- Source URL: https://github.com/eclipse-tractusx/portal-assets diff --git a/developer/02. Technical Integration/04. Credentials/01. Get UseCase Credential.md b/developer/02. Technical Integration/04. Credentials/01. Get UseCase Credential.md index a2eb90135..223f81a0e 100644 --- a/developer/02. Technical Integration/04. Credentials/01. Get UseCase Credential.md +++ b/developer/02. Technical Integration/04. Credentials/01. Get UseCase Credential.md @@ -90,3 +90,11 @@ For the documents only pdf documents are allowed till 1 MB

+ +## NOTICE + +This work is licensed under the [Apache-2.0](https://www.apache.org/licenses/LICENSE-2.0). + +- SPDX-License-Identifier: Apache-2.0 +- SPDX-FileCopyrightText: 2021-2023 Contributors to the Eclipse Foundation +- Source URL: https://github.com/eclipse-tractusx/portal-assets diff --git a/developer/02. Technical Integration/04. Credentials/02. Other Certificates.md b/developer/02. Technical Integration/04. Credentials/02. Other Certificates.md index 872c1c7ad..1882c50d9 100644 --- a/developer/02. Technical Integration/04. Credentials/02. Other Certificates.md +++ b/developer/02. Technical Integration/04. Credentials/02. Other Certificates.md @@ -111,3 +111,11 @@ For the documents only pdf documents are allowed till 1 MB

+ +## NOTICE + +This work is licensed under the [Apache-2.0](https://www.apache.org/licenses/LICENSE-2.0). + +- SPDX-License-Identifier: Apache-2.0 +- SPDX-FileCopyrightText: 2021-2023 Contributors to the Eclipse Foundation +- Source URL: https://github.com/eclipse-tractusx/portal-assets diff --git a/developer/02. Technical Integration/04. Credentials/03. Credential Admin Board.md b/developer/02. Technical Integration/04. Credentials/03. Credential Admin Board.md index 6bc39f8d5..9781d9e4a 100644 --- a/developer/02. Technical Integration/04. Credentials/03. Credential Admin Board.md +++ b/developer/02. Technical Integration/04. Credentials/03. Credential Admin Board.md @@ -177,3 +177,11 @@ PUT /api/administration/companydata/credential/{credentialId}/decline

+ +## NOTICE + +This work is licensed under the [Apache-2.0](https://www.apache.org/licenses/LICENSE-2.0). + +- SPDX-License-Identifier: Apache-2.0 +- SPDX-FileCopyrightText: 2021-2023 Contributors to the Eclipse Foundation +- Source URL: https://github.com/eclipse-tractusx/portal-assets diff --git a/developer/03. User Management/01. User Account/01. Summary.md b/developer/03. User Management/01. User Account/01. Summary.md index 8be0c8fa4..0426db951 100644 --- a/developer/03. User Management/01. User Account/01. Summary.md +++ b/developer/03. User Management/01. User Account/01. Summary.md @@ -1,7 +1,15 @@ # Summary Company Administrators as well as IT Administrators of the company can create new user accounts. -With the Catena-X user account, the user can access the Catena-X Portal including the apps marketspace, direct access to subscribed company apps, semantic data models, digital twins, service offers, etc. +With the Catena-X user account, the user can access the Catena-X Portal including the apps marketplace, direct access to subscribed company apps, semantic data models, digital twins, service offers, etc.

+ +## NOTICE + +This work is licensed under the [Apache-2.0](https://www.apache.org/licenses/LICENSE-2.0). + +- SPDX-License-Identifier: Apache-2.0 +- SPDX-FileCopyrightText: 2021-2023 Contributors to the Eclipse Foundation +- Source URL: https://github.com/eclipse-tractusx/portal-assets diff --git a/developer/03. User Management/01. User Account/02. My User Account.md b/developer/03. User Management/01. User Account/02. My User Account.md index 2c3712010..de33ed38e 100644 --- a/developer/03. User Management/01. User Account/02. My User Account.md +++ b/developer/03. User Management/01. User Account/02. My User Account.md @@ -96,3 +96,11 @@ To display those details the endpoint GET api/administration/user/ownUser (detai

+ +## NOTICE + +This work is licensed under the [Apache-2.0](https://www.apache.org/licenses/LICENSE-2.0). + +- SPDX-License-Identifier: Apache-2.0 +- SPDX-FileCopyrightText: 2021-2023 Contributors to the Eclipse Foundation +- Source URL: https://github.com/eclipse-tractusx/portal-assets diff --git a/developer/03. User Management/01. User Account/02. User Account.md b/developer/03. User Management/01. User Account/02. User Account.md index e05e1261e..c9eff5a93 100644 --- a/developer/03. User Management/01. User Account/02. User Account.md +++ b/developer/03. User Management/01. User Account/02. User Account.md @@ -6,7 +6,7 @@ The user account detail view(s) are available for: - admin user (manage company user account) The views mainly differ in the access permission as well as possible "edit" functions. -Below the screen for "specific user account" is displayed. This view is only accessible for adiministration users. +Below the screen for "specific user account" is displayed. This view is only accessible for administration users.

image @@ -75,7 +75,7 @@ Response Body

-Data are fetched from the endpoint GET api/administration/user/ownUser (details see above) and transfered into the table style. +Data are fetched from the endpoint GET api/administration/user/ownUser (details see above) and transferred into the table style. Information are mainly fetched from company_users table as well as: - companies (for the bpn) @@ -107,3 +107,11 @@ To display those details the endpoint GET api/administration/user/ownUser (detai

+ +## NOTICE + +This work is licensed under the [Apache-2.0](https://www.apache.org/licenses/LICENSE-2.0). + +- SPDX-License-Identifier: Apache-2.0 +- SPDX-FileCopyrightText: 2021-2023 Contributors to the Eclipse Foundation +- Source URL: https://github.com/eclipse-tractusx/portal-assets diff --git a/developer/03. User Management/01. User Account/03. Create new user account (single) - UPDATE NEEDED.md b/developer/03. User Management/01. User Account/03. Create new user account (single) - UPDATE NEEDED.md index a969fdc94..a86210566 100644 --- a/developer/03. User Management/01. User Account/03. Create new user account (single) - UPDATE NEEDED.md +++ b/developer/03. User Management/01. User Account/03. Create new user account (single) - UPDATE NEEDED.md @@ -18,3 +18,11 @@ With the first login, the user will be asked to set a own password, password pol

+ +## NOTICE + +This work is licensed under the [Apache-2.0](https://www.apache.org/licenses/LICENSE-2.0). + +- SPDX-License-Identifier: Apache-2.0 +- SPDX-FileCopyrightText: 2021-2023 Contributors to the Eclipse Foundation +- Source URL: https://github.com/eclipse-tractusx/portal-assets diff --git a/developer/03. User Management/01. User Account/04. Create new user account (bulk) - UPDATE NEEDED.md b/developer/03. User Management/01. User Account/04. Create new user account (bulk) - UPDATE NEEDED.md index cd11e220c..c5145678e 100644 --- a/developer/03. User Management/01. User Account/04. Create new user account (bulk) - UPDATE NEEDED.md +++ b/developer/03. User Management/01. User Account/04. Create new user account (bulk) - UPDATE NEEDED.md @@ -1,3 +1,11 @@ ## Create a new user account (bulk) Currently not supported + +## NOTICE + +This work is licensed under the [Apache-2.0](https://www.apache.org/licenses/LICENSE-2.0). + +- SPDX-License-Identifier: Apache-2.0 +- SPDX-FileCopyrightText: 2021-2023 Contributors to the Eclipse Foundation +- Source URL: https://github.com/eclipse-tractusx/portal-assets diff --git a/developer/03. User Management/02. Edit User Account/01. Summary.md b/developer/03. User Management/02. Edit User Account/01. Summary.md index 56e990d3c..556031098 100644 --- a/developer/03. User Management/02. Edit User Account/01. Summary.md +++ b/developer/03. User Management/02. Edit User Account/01. Summary.md @@ -23,3 +23,11 @@ The "My User Account Details" function is a detailed view of your own user accou
image + +## NOTICE + +This work is licensed under the [Apache-2.0](https://www.apache.org/licenses/LICENSE-2.0). + +- SPDX-License-Identifier: Apache-2.0 +- SPDX-FileCopyrightText: 2021-2023 Contributors to the Eclipse Foundation +- Source URL: https://github.com/eclipse-tractusx/portal-assets diff --git a/developer/03. User Management/02. Edit User Account/02. Password Reset.md b/developer/03. User Management/02. Edit User Account/02. Password Reset.md index f1438e2bc..bfe8f2b07 100644 --- a/developer/03. User Management/02. Edit User Account/02. Password Reset.md +++ b/developer/03. User Management/02. Edit User Account/02. Password Reset.md @@ -39,3 +39,11 @@ Request body

+ +## NOTICE + +This work is licensed under the [Apache-2.0](https://www.apache.org/licenses/LICENSE-2.0). + +- SPDX-License-Identifier: Apache-2.0 +- SPDX-FileCopyrightText: 2021-2023 Contributors to the Eclipse Foundation +- Source URL: https://github.com/eclipse-tractusx/portal-assets diff --git a/developer/03. User Management/02. Edit User Account/03. User Permissions.md b/developer/03. User Management/02. Edit User Account/03. User Permissions.md index 461b68cee..66fdd7559 100644 --- a/developer/03. User Management/02. Edit User Account/03. User Permissions.md +++ b/developer/03. User Management/02. Edit User Account/03. User Permissions.md @@ -10,7 +10,7 @@ Normal users can only view their own user account via "my user account". ### Portal Assigned Roles -Administration users can change company users assigned portal roles by using the "User Managamenet" -> "Identity Management" -> Edit User Account by clicking on "Details" -> scroll down to section "Assigned Catena-X Portal Roles" +Administration users can change company users assigned portal roles by using the "User Management" -> "Identity Management" -> Edit User Account by clicking on "Details" -> scroll down to section "Assigned Catena-X Portal Roles"
Assigned users portal role are visible, additionally, with the necessary rights, the roles can get adjusted by clicking on "Change Portal Role" @@ -127,7 +127,7 @@ Request Body ### App Assigned Roles -To change user assigned app roles, open the "User Managamenet" -> "App Access Management" -> Click on the relevant App -> scroll down to "App Access Management" -> select the respective user inside the table/list and click on "Edit" +To change user assigned app roles, open the "User Management" -> "App Access Management" -> Click on the relevant App -> scroll down to "App Access Management" -> select the respective user inside the table/list and click on "Edit"

@@ -279,3 +279,11 @@ Request Body

+ +## NOTICE + +This work is licensed under the [Apache-2.0](https://www.apache.org/licenses/LICENSE-2.0). + +- SPDX-License-Identifier: Apache-2.0 +- SPDX-FileCopyrightText: 2021-2023 Contributors to the Eclipse Foundation +- Source URL: https://github.com/eclipse-tractusx/portal-assets diff --git a/developer/03. User Management/02. Edit User Account/04. Manage user assigned BPN.md b/developer/03. User Management/02. Edit User Account/04. Manage user assigned BPN.md index a2ada1612..d4d90aee2 100644 --- a/developer/03. User Management/02. Edit User Account/04. Manage user assigned BPN.md +++ b/developer/03. User Management/02. Edit User Account/04. Manage user assigned BPN.md @@ -103,3 +103,11 @@ Request body

+ +## NOTICE + +This work is licensed under the [Apache-2.0](https://www.apache.org/licenses/LICENSE-2.0). + +- SPDX-License-Identifier: Apache-2.0 +- SPDX-FileCopyrightText: 2021-2023 Contributors to the Eclipse Foundation +- Source URL: https://github.com/eclipse-tractusx/portal-assets diff --git a/developer/03. User Management/02. Edit User Account/05. Suspend User.md b/developer/03. User Management/02. Edit User Account/05. Suspend User.md index 69f15e3cb..1cec317a9 100644 --- a/developer/03. User Management/02. Edit User Account/05. Suspend User.md +++ b/developer/03. User Management/02. Edit User Account/05. Suspend User.md @@ -1,3 +1,11 @@ # Suspend User currently not supported + +## NOTICE + +This work is licensed under the [Apache-2.0](https://www.apache.org/licenses/LICENSE-2.0). + +- SPDX-License-Identifier: Apache-2.0 +- SPDX-FileCopyrightText: 2021-2023 Contributors to the Eclipse Foundation +- Source URL: https://github.com/eclipse-tractusx/portal-assets diff --git a/developer/03. User Management/02. Edit User Account/06. Delete User.md b/developer/03. User Management/02. Edit User Account/06. Delete User.md index e07007dde..3a5d9a777 100644 --- a/developer/03. User Management/02. Edit User Account/06. Delete User.md +++ b/developer/03. User Management/02. Edit User Account/06. Delete User.md @@ -1,6 +1,6 @@ ## Delete User -Inside the portal, a user will be able to delete an user - the function is differentiated into 2 functions +Inside the portal, a user will be able to delete an user - the function is differentiated into two functions - Delete your own user account - Delete an user account of a user inside your organization (only available for the IT Administrator) @@ -80,9 +80,9 @@ With the deletion an automatic logic will get processed. After latest 5 seconds, ### #2 Delete user {userId}
-Delete an user of the same company inside the portal DB and keycloak. +Delete an user of the same company inside the portal DB and Keycloak.
-Important - due to the audit relevance, we dont delete directly all user related connections. +Important - due to the audit relevance, we don't delete directly all user related connections.
Instead user will get set to "DELETED", and following information/details will get deleted
@@ -109,3 +109,11 @@ Request body

+ +## NOTICE + +This work is licensed under the [Apache-2.0](https://www.apache.org/licenses/LICENSE-2.0). + +- SPDX-License-Identifier: Apache-2.0 +- SPDX-FileCopyrightText: 2021-2023 Contributors to the Eclipse Foundation +- Source URL: https://github.com/eclipse-tractusx/portal-assets diff --git a/developer/03. User Management/02. Edit User Account/index.md b/developer/03. User Management/02. Edit User Account/index.md index c57eaa0bf..eaac86151 100644 --- a/developer/03. User Management/02. Edit User Account/index.md +++ b/developer/03. User Management/02. Edit User Account/index.md @@ -16,3 +16,11 @@ Inside the user account page, a number of services/actions can get triggered.

+ +## NOTICE + +This work is licensed under the [Apache-2.0](https://www.apache.org/licenses/LICENSE-2.0). + +- SPDX-License-Identifier: Apache-2.0 +- SPDX-FileCopyrightText: 2021-2023 Contributors to the Eclipse Foundation +- Source URL: https://github.com/eclipse-tractusx/portal-assets diff --git a/developer/03. User Management/03. Technical User/01. Summary.md b/developer/03. User Management/03. Technical User/01. Summary.md index 633f97bd7..83219954c 100644 --- a/developer/03. User Management/03. Technical User/01. Summary.md +++ b/developer/03. User Management/03. Technical User/01. Summary.md @@ -6,7 +6,7 @@ Example use case: register Digital Twins via the DFT to the digital twin registr
Technical user permissions are created by the operator and need to get loaded as part of the static data.
-Currently the portal doesn't support the technical user permission creation by an administrator operator board. In future releases, the functionality is planned to get implemented. Till that, technical users need to get deployed to keycloak as well as the portal db. +Currently the portal doesn't support the technical user permission creation by an administrator operator board. In future releases, the functionality is planned to get implemented. Till that, technical users need to get deployed to Keycloak as well as the portal db.

CX Member companies can create their technical users on their needs and map them to the pre-defined roles. @@ -68,3 +68,11 @@ The table below gives an overview of the technical user role mapping to the resp

+ +## NOTICE + +This work is licensed under the [Apache-2.0](https://www.apache.org/licenses/LICENSE-2.0). + +- SPDX-License-Identifier: Apache-2.0 +- SPDX-FileCopyrightText: 2021-2023 Contributors to the Eclipse Foundation +- Source URL: https://github.com/eclipse-tractusx/portal-assets diff --git a/developer/03. User Management/03. Technical User/02. View Technical Users.md b/developer/03. User Management/03. Technical User/02. View Technical Users.md index 0d897d8c8..6151577ac 100644 --- a/developer/03. User Management/03. Technical User/02. View Technical Users.md +++ b/developer/03. User Management/03. Technical User/02. View Technical Users.md @@ -109,3 +109,11 @@ Example: /api/administration/serviceaccount/owncompany/serviceaccounts?isOwner=t

+ +## NOTICE + +This work is licensed under the [Apache-2.0](https://www.apache.org/licenses/LICENSE-2.0). + +- SPDX-License-Identifier: Apache-2.0 +- SPDX-FileCopyrightText: 2021-2023 Contributors to the Eclipse Foundation +- Source URL: https://github.com/eclipse-tractusx/portal-assets diff --git a/developer/03. User Management/03. Technical User/03. Create Technical User.md b/developer/03. User Management/03. Technical User/03. Create Technical User.md index 706e5ecb1..9ed5c4058 100644 --- a/developer/03. User Management/03. Technical User/03. Create Technical User.md +++ b/developer/03. User Management/03. Technical User/03. Create Technical User.md @@ -156,20 +156,20 @@ Response Body
> **Note** -> The service account type provides the information if the service account is a own created service account or a service account which is created by app/service provider of an managed offer subscribtion. +> The service account type provides the information if the service account is a own created service account or a service account which is created by app/service provider of an managed offer subscription.

### Service Accounts Created via service/app subscription -If the service account is created due to a servce/app activation; the service account user is created by the app/service provider; but connected to the actual customer (owner of the user). +If the service account is created due to a service/app activation; the service account user is created by the app/service provider; but connected to the actual customer (owner of the user). With that, the customer as well as the offer provider should be able to view the service account with certain privileges. With the POST api, the backend service will
-- creates the user inside keycloak central idp +- creates the user inside Keycloak central idp - updates the data inside portal iam_service_accounts - updates the data inside portal company_service_accounts - service_account type is automatically set to "managed" @@ -186,3 +186,11 @@ More details available inside the autosetup service description.

+ +## NOTICE + +This work is licensed under the [Apache-2.0](https://www.apache.org/licenses/LICENSE-2.0). + +- SPDX-License-Identifier: Apache-2.0 +- SPDX-FileCopyrightText: 2021-2023 Contributors to the Eclipse Foundation +- Source URL: https://github.com/eclipse-tractusx/portal-assets diff --git a/developer/03. User Management/03. Technical User/04. Delete Technical User.md b/developer/03. User Management/03. Technical User/04. Delete Technical User.md index 934cad304..4fa198938 100644 --- a/developer/03. User Management/03. Technical User/04. Delete Technical User.md +++ b/developer/03. User Management/03. Technical User/04. Delete Technical User.md @@ -54,3 +54,11 @@ Request body

+ +## NOTICE + +This work is licensed under the [Apache-2.0](https://www.apache.org/licenses/LICENSE-2.0). + +- SPDX-License-Identifier: Apache-2.0 +- SPDX-FileCopyrightText: 2021-2023 Contributors to the Eclipse Foundation +- Source URL: https://github.com/eclipse-tractusx/portal-assets diff --git a/developer/03. User Management/03. Technical User/04. Reset Credentials.md b/developer/03. User Management/03. Technical User/04. Reset Credentials.md index f490cf514..497c402a9 100644 --- a/developer/03. User Management/03. Technical User/04. Reset Credentials.md +++ b/developer/03. User Management/03. Technical User/04. Reset Credentials.md @@ -28,3 +28,11 @@ Request body

+ +## NOTICE + +This work is licensed under the [Apache-2.0](https://www.apache.org/licenses/LICENSE-2.0). + +- SPDX-License-Identifier: Apache-2.0 +- SPDX-FileCopyrightText: 2021-2023 Contributors to the Eclipse Foundation +- Source URL: https://github.com/eclipse-tractusx/portal-assets diff --git a/developer/03. User Management/03. Technical User/05. FAQ.md b/developer/03. User Management/03. Technical User/05. FAQ.md index b93aa86d9..de5dd6596 100644 --- a/developer/03. User Management/03. Technical User/05. FAQ.md +++ b/developer/03. User Management/03. Technical User/05. FAQ.md @@ -1,6 +1,6 @@ ### How to retrieve a technical user token? -To retrieve a technical user token call the env specific idp/keycloak instance +To retrieve a technical user token call the env specific IdP / Keycloak instance Type: POST Endpoint: //centralidp.{env e.g. "int"}.demo.catena-x.net/auth/realms/CX-Central/protocol/openid-connect/token @@ -25,3 +25,11 @@ access token jwt

+ +## NOTICE + +This work is licensed under the [Apache-2.0](https://www.apache.org/licenses/LICENSE-2.0). + +- SPDX-License-Identifier: Apache-2.0 +- SPDX-FileCopyrightText: 2021-2023 Contributors to the Eclipse Foundation +- Source URL: https://github.com/eclipse-tractusx/portal-assets diff --git a/developer/03. User Management/04. App Access Management/01. Summary.md b/developer/03. User Management/04. App Access Management/01. Summary.md index 6c116ca94..e9e6e6cca 100644 --- a/developer/03. User Management/04. App Access Management/01. Summary.md +++ b/developer/03. User Management/04. App Access Management/01. Summary.md @@ -44,3 +44,11 @@ Response Body

+ +## NOTICE + +This work is licensed under the [Apache-2.0](https://www.apache.org/licenses/LICENSE-2.0). + +- SPDX-License-Identifier: Apache-2.0 +- SPDX-FileCopyrightText: 2021-2023 Contributors to the Eclipse Foundation +- Source URL: https://github.com/eclipse-tractusx/portal-assets diff --git a/developer/03. User Management/04. App Access Management/02. Assign App Role Page Overview.md b/developer/03. User Management/04. App Access Management/02. Assign App Role Page Overview.md index c61fbba20..7da53e9a0 100644 --- a/developer/03. User Management/04. App Access Management/02. Assign App Role Page Overview.md +++ b/developer/03. User Management/04. App Access Management/02. Assign App Role Page Overview.md @@ -88,3 +88,11 @@ In case the api is responding with an empty array, the UI will display following

+ +## NOTICE + +This work is licensed under the [Apache-2.0](https://www.apache.org/licenses/LICENSE-2.0). + +- SPDX-License-Identifier: Apache-2.0 +- SPDX-FileCopyrightText: 2021-2023 Contributors to the Eclipse Foundation +- Source URL: https://github.com/eclipse-tractusx/portal-assets diff --git a/developer/03. User Management/04. App Access Management/03. Assign App Role.md b/developer/03. User Management/04. App Access Management/03. Assign App Role.md index 1729c9554..a3a1fae1f 100644 --- a/developer/03. User Management/04. App Access Management/03. Assign App Role.md +++ b/developer/03. User Management/04. App Access Management/03. Assign App Role.md @@ -52,3 +52,11 @@ Request body

+ +## NOTICE + +This work is licensed under the [Apache-2.0](https://www.apache.org/licenses/LICENSE-2.0). + +- SPDX-License-Identifier: Apache-2.0 +- SPDX-FileCopyrightText: 2021-2023 Contributors to the Eclipse Foundation +- Source URL: https://github.com/eclipse-tractusx/portal-assets diff --git a/developer/03. User Management/index.md b/developer/03. User Management/index.md index a29f30901..f43f9dcec 100644 --- a/developer/03. User Management/index.md +++ b/developer/03. User Management/index.md @@ -8,3 +8,11 @@ Read more details in the following sections: - [Edit User Account](./2%20Edit%20User%20Account/) - [Technical User](./3%20Technical%20User/) - [App Access Management](./4%20App%20Access%20Management/) + +## NOTICE + +This work is licensed under the [Apache-2.0](https://www.apache.org/licenses/LICENSE-2.0). + +- SPDX-License-Identifier: Apache-2.0 +- SPDX-FileCopyrightText: 2021-2023 Contributors to the Eclipse Foundation +- Source URL: https://github.com/eclipse-tractusx/portal-assets diff --git a/developer/04. Apps/01. Marketplace/01. App Overview.md b/developer/04. Apps/01. Marketplace/01. App Overview.md index be91e4298..d06c40a66 100644 --- a/developer/04. Apps/01. Marketplace/01. App Overview.md +++ b/developer/04. Apps/01. Marketplace/01. App Overview.md @@ -1,6 +1,7 @@ ## Summary ...description to be added... +

@@ -25,3 +26,11 @@ API is used to display the active apps of the CX network based on the released a

+ +## NOTICE + +This work is licensed under the [Apache-2.0](https://www.apache.org/licenses/LICENSE-2.0). + +- SPDX-License-Identifier: Apache-2.0 +- SPDX-FileCopyrightText: 2021-2023 Contributors to the Eclipse Foundation +- Source URL: https://github.com/eclipse-tractusx/portal-assets diff --git a/developer/04. Apps/01. Marketplace/02. App Details.md b/developer/04. Apps/01. Marketplace/02. App Details.md index a7de13a04..3df05e39f 100644 --- a/developer/04. Apps/01. Marketplace/02. App Details.md +++ b/developer/04. Apps/01. Marketplace/02. App Details.md @@ -101,7 +101,7 @@ The "Subscribe" button shows different state and color depending on the company ### #3 App Policy Data -Based in the API response the respctive app privacy information will get displayed in the app details page +Based in the API response the respective app privacy information will get displayed in the app details page image @@ -113,3 +113,11 @@ Expected result:

+ +## NOTICE + +This work is licensed under the [Apache-2.0](https://www.apache.org/licenses/LICENSE-2.0). + +- SPDX-License-Identifier: Apache-2.0 +- SPDX-FileCopyrightText: 2021-2023 Contributors to the Eclipse Foundation +- Source URL: https://github.com/eclipse-tractusx/portal-assets diff --git a/developer/04. Apps/01. Marketplace/03. App Favorites.md b/developer/04. Apps/01. Marketplace/03. App Favorites.md index d7c369c29..289fe2f18 100644 --- a/developer/04. Apps/01. Marketplace/03. App Favorites.md +++ b/developer/04. Apps/01. Marketplace/03. App Favorites.md @@ -16,7 +16,7 @@ Links: ### #1 Store User Favorites -The App favourite function is offered in the app marketplace to highlight an app easily and ensure that I as an user can quickly find the app again. +The App favorite function is offered in the app marketplace to highlight an app easily and ensure that I as an user can quickly find the app again. User favorites are stored inside the DB - the portal db will know which user has which favorite selected and can easily retrieve the information for the Front-End
@@ -26,3 +26,11 @@ User favorites are stored inside the DB - the portal db will know which user has

+ +## NOTICE + +This work is licensed under the [Apache-2.0](https://www.apache.org/licenses/LICENSE-2.0). + +- SPDX-License-Identifier: Apache-2.0 +- SPDX-FileCopyrightText: 2021-2023 Contributors to the Eclipse Foundation +- Source URL: https://github.com/eclipse-tractusx/portal-assets diff --git a/developer/04. Apps/01. Marketplace/04. My Business Apps.md b/developer/04. Apps/01. Marketplace/04. My Business Apps.md index dc5513ae7..d71c95ef6 100644 --- a/developer/04. Apps/01. Marketplace/04. My Business Apps.md +++ b/developer/04. Apps/01. Marketplace/04. My Business Apps.md @@ -1,6 +1,7 @@ ## Summary ...description to be added... +

@@ -39,3 +40,11 @@ Important for the function is an active company subscription of the assigned use

+ +## NOTICE + +This work is licensed under the [Apache-2.0](https://www.apache.org/licenses/LICENSE-2.0). + +- SPDX-License-Identifier: Apache-2.0 +- SPDX-FileCopyrightText: 2021-2023 Contributors to the Eclipse Foundation +- Source URL: https://github.com/eclipse-tractusx/portal-assets diff --git a/developer/04. Apps/02. App Release Process/04. Delete App.md b/developer/04. Apps/02. App Release Process/04. Delete App.md index df115f644..a3316d9e1 100644 --- a/developer/04. Apps/02. App Release Process/04. Delete App.md +++ b/developer/04. Apps/02. App Release Process/04. Delete App.md @@ -2,7 +2,7 @@ As part of the app release process; the user needs to get enabled to delete the app which is currently in the create process.
-For the need of the draft app deletio, the "App Deletion - App under App Release Process" got enabled. +For the need of the draft app deletion, the "App Deletion - App under App Release Process" got enabled.
## Implementation @@ -38,3 +38,11 @@ Please note; the documents are not yet in LOCKED state; that means they can get

+ +## NOTICE + +This work is licensed under the [Apache-2.0](https://www.apache.org/licenses/LICENSE-2.0). + +- SPDX-License-Identifier: Apache-2.0 +- SPDX-FileCopyrightText: 2021-2023 Contributors to the Eclipse Foundation +- Source URL: https://github.com/eclipse-tractusx/portal-assets diff --git a/developer/04. Apps/02. App Release Process/App Release Process.md b/developer/04. Apps/02. App Release Process/App Release Process.md index cb0d4fb2d..96515c40e 100644 --- a/developer/04. Apps/02. App Release Process/App Release Process.md +++ b/developer/04. Apps/02. App Release Process/App Release Process.md @@ -138,7 +138,7 @@ Response Body ###### #4 GET/POST App LeadImage The endpoints enable the user to store and retrieve the app leadimage id. -Using the document id of the response body, the document base64 encoding can get retireved and turned to the actual image. +Using the document id of the response body, the document base64 encoding can get retrieved and turned to the actual image.
Supported formats: JPEG and PNG @@ -155,8 +155,8 @@ Supported formats: JPEG and PNG ###### #5 DELETE Image -In case the user identifiers that a wrong image is loaded or the image doesnt fit/has changed; the DELETE endpoint is used to delete doucments linked to the app. -Important: the deletion is not reversable - since the app is still under DRAFT, all app related details will get deleted immediately. +In case the user identifiers that a wrong image is loaded or the image doesn't fit/has changed; the DELETE endpoint is used to delete documents linked to the app. +Important: the deletion is not reversible - since the app is still under DRAFT, all app related details will get deleted immediately. ```diff ! Delete: /api/apps/appreleaseprocess/documents/{documentId} @@ -342,8 +342,8 @@ Please note: if a value is send empty, the existing possible saved value will ge ###### #2 DELETE Image/Documents -In case the user identifiers that a wrong image is loaded or the image doesnt fit/has changed; the DELETE endpoint is used to delete doucments linked to the app. -Important: the deletion is not reversable - since the app is still under DRAFT, all app related details will get deleted immediately. +In case the user identifiers that a wrong image is loaded or the image doesn't fit/has changed; the DELETE endpoint is used to delete documents linked to the app. +Important: the deletion is not reversible - since the app is still under DRAFT, all app related details will get deleted immediately. ```diff ! Delete: /api/apps/appreleaseprocess/documents/{documentId} @@ -493,8 +493,8 @@ Type: CONFORMITY_APPROVAL_BUSINESS_APPS ###### #4 DELETE Document -In case the user identifiers that a wrong document got uploaded in the respective step, the DELETE endpoint is used to delete doucments linked to the app. -Important: the deletion is not reversable - since the app is still under DRAFT, all app related details will get deleted immediately. +In case the user identifiers that a wrong document got uploaded in the respective step, the DELETE endpoint is used to delete documents linked to the app. +Important: the deletion is not reversible - since the app is still under DRAFT, all app related details will get deleted immediately. ```diff ! Delete: /api/apps/appreleaseprocess/documents/{documentId} @@ -518,7 +518,7 @@ With uploading the csv via the dropzone, a preview section will display the resp image

-With approving the upload with the button "Create App Roles" the roles are stored in the portal DB. Keycloak is untouched, since role creation in keycloak will only be relevant if the app instance/client is getting created. +With approving the upload with the button "Create App Roles" the roles are stored in the portal DB. Keycloak is untouched, since role creation in Keycloak will only be relevant if the app instance/client is getting created.

@@ -681,3 +681,11 @@ The GET document endpoint is getting triggered and document downloaded.

+ +## NOTICE + +This work is licensed under the [Apache-2.0](https://www.apache.org/licenses/LICENSE-2.0). + +- SPDX-License-Identifier: Apache-2.0 +- SPDX-FileCopyrightText: 2021-2023 Contributors to the Eclipse Foundation +- Source URL: https://github.com/eclipse-tractusx/portal-assets diff --git a/developer/04. Apps/03. App Release Approval/01. App Approval Board Overview.md b/developer/04. Apps/03. App Release Approval/01. App Approval Board Overview.md index f81f429d4..0943d2afb 100644 --- a/developer/04. Apps/03. App Release Approval/01. App Approval Board Overview.md +++ b/developer/04. Apps/03. App Release Approval/01. App Approval Board Overview.md @@ -70,3 +70,11 @@ Request Only: {hostname}/api/apps/AppReleaseProcess/inReview?page=0&size=15&sort

+ +## NOTICE + +This work is licensed under the [Apache-2.0](https://www.apache.org/licenses/LICENSE-2.0). + +- SPDX-License-Identifier: Apache-2.0 +- SPDX-FileCopyrightText: 2021-2023 Contributors to the Eclipse Foundation +- Source URL: https://github.com/eclipse-tractusx/portal-assets diff --git a/developer/04. Apps/03. App Release Approval/02. App Details.md b/developer/04. Apps/03. App Release Approval/02. App Details.md index 24897d1f1..b9580b457 100644 --- a/developer/04. Apps/03. App Release Approval/02. App Details.md +++ b/developer/04. Apps/03. App Release Approval/02. App Details.md @@ -105,7 +105,7 @@ App documents can get downloaded by clicking on the document name highlighted in ### #4 App Policy Data -Based in the API response the respctive app privacy information will get displayed in the detail page +Based in the API response the respective app privacy information will get displayed in the detail page image @@ -117,3 +117,11 @@ Expected result:

+ +## NOTICE + +This work is licensed under the [Apache-2.0](https://www.apache.org/licenses/LICENSE-2.0). + +- SPDX-License-Identifier: Apache-2.0 +- SPDX-FileCopyrightText: 2021-2023 Contributors to the Eclipse Foundation +- Source URL: https://github.com/eclipse-tractusx/portal-assets diff --git a/developer/04. Apps/03. App Release Approval/03. Approve App Release.md b/developer/04. Apps/03. App Release Approval/03. Approve App Release.md index ed59bbdc9..9947247ac 100644 --- a/developer/04. Apps/03. App Release Approval/03. Approve App Release.md +++ b/developer/04. Apps/03. App Release Approval/03. Approve App Release.md @@ -29,3 +29,11 @@ Details regarding the notification can get found in the notification service doc

+ +## NOTICE + +This work is licensed under the [Apache-2.0](https://www.apache.org/licenses/LICENSE-2.0). + +- SPDX-License-Identifier: Apache-2.0 +- SPDX-FileCopyrightText: 2021-2023 Contributors to the Eclipse Foundation +- Source URL: https://github.com/eclipse-tractusx/portal-assets diff --git a/developer/04. Apps/03. App Release Approval/04. Decline App Release.md b/developer/04. Apps/03. App Release Approval/04. Decline App Release.md index 9e2a01770..1e732e7ee 100644 --- a/developer/04. Apps/03. App Release Approval/04. Decline App Release.md +++ b/developer/04. Apps/03. App Release Approval/04. Decline App Release.md @@ -45,3 +45,11 @@ Details regarding the notification can get found in the notification service doc ##### Email Example image + +## NOTICE + +This work is licensed under the [Apache-2.0](https://www.apache.org/licenses/LICENSE-2.0). + +- SPDX-License-Identifier: Apache-2.0 +- SPDX-FileCopyrightText: 2021-2023 Contributors to the Eclipse Foundation +- Source URL: https://github.com/eclipse-tractusx/portal-assets diff --git a/developer/04. Apps/04. App Provider Management Board(s)/01. App Board.md b/developer/04. Apps/04. App Provider Management Board(s)/01. App Board.md index 4314efe0f..8605abc5b 100644 --- a/developer/04. Apps/04. App Provider Management Board(s)/01. App Board.md +++ b/developer/04. Apps/04. App Provider Management Board(s)/01. App Board.md @@ -86,3 +86,11 @@ Details to the data mapping:

+ +## NOTICE + +This work is licensed under the [Apache-2.0](https://www.apache.org/licenses/LICENSE-2.0). + +- SPDX-License-Identifier: Apache-2.0 +- SPDX-FileCopyrightText: 2021-2023 Contributors to the Eclipse Foundation +- Source URL: https://github.com/eclipse-tractusx/portal-assets diff --git a/developer/04. Apps/05. App Subscription/01. Subscription Flow.md b/developer/04. Apps/05. App Subscription/01. Subscription Flow.md index 76c1418ed..1e866e6f0 100644 --- a/developer/04. Apps/05. App Subscription/01. Subscription Flow.md +++ b/developer/04. Apps/05. App Subscription/01. Subscription Flow.md @@ -64,3 +64,11 @@ text needed

+ +## NOTICE + +This work is licensed under the [Apache-2.0](https://www.apache.org/licenses/LICENSE-2.0). + +- SPDX-License-Identifier: Apache-2.0 +- SPDX-FileCopyrightText: 2021-2023 Contributors to the Eclipse Foundation +- Source URL: https://github.com/eclipse-tractusx/portal-assets diff --git a/developer/04. Apps/05. App Subscription/01.App Subscription Request Management.md b/developer/04. Apps/05. App Subscription/01.App Subscription Request Management.md index 2b3d0297c..e8005013e 100644 --- a/developer/04. Apps/05. App Subscription/01.App Subscription Request Management.md +++ b/developer/04. Apps/05. App Subscription/01.App Subscription Request Management.md @@ -187,3 +187,11 @@ GET: /api/apps/{appId}/subscription/{subscriptionId}/provider

+ +## NOTICE + +This work is licensed under the [Apache-2.0](https://www.apache.org/licenses/LICENSE-2.0). + +- SPDX-License-Identifier: Apache-2.0 +- SPDX-FileCopyrightText: 2021-2023 Contributors to the Eclipse Foundation +- Source URL: https://github.com/eclipse-tractusx/portal-assets diff --git a/developer/04. Apps/05. App Subscription/02. App Subscription Activation (Provider).md b/developer/04. Apps/05. App Subscription/02. App Subscription Activation (Provider).md index 56eece051..3a3184fa3 100644 --- a/developer/04. Apps/05. App Subscription/02. App Subscription Activation (Provider).md +++ b/developer/04. Apps/05. App Subscription/02. App Subscription Activation (Provider).md @@ -126,3 +126,11 @@ POST: /api/services/autoSetup

+ +## NOTICE + +This work is licensed under the [Apache-2.0](https://www.apache.org/licenses/LICENSE-2.0). + +- SPDX-License-Identifier: Apache-2.0 +- SPDX-FileCopyrightText: 2021-2023 Contributors to the Eclipse Foundation +- Source URL: https://github.com/eclipse-tractusx/portal-assets diff --git a/developer/04. Apps/05. App Subscription/03. Unsubscribe.md b/developer/04. Apps/05. App Subscription/03. Unsubscribe.md index 0f6fd4abe..dae474699 100644 --- a/developer/04. Apps/05. App Subscription/03. Unsubscribe.md +++ b/developer/04. Apps/05. App Subscription/03. Unsubscribe.md @@ -3,11 +3,11 @@ Enable customers of an app to unsubscribe the active subscription. With the unsubscription connected objects (see details below) are getting inactivated as well. -[Functional Description](/docs/04.%20App(s)/05.%20App%20Subscription/05.%20App%20Unsubscribe.md) +[Functional Description]()
-### Implementation +### Implementation The function "unsubscribe" off subscriptions is located in the company organization page (interim) @@ -21,16 +21,15 @@ The function "unsubscribe" off subscriptions is located in the company organizat Implementation details: -* [ ] when the user clicks the "unsubscribe" button, an overlay gets displayed -* [ ] inside the overlay details of subscription connections are displayed -* [ ] information to display subscription connections are fetched via GET: /api/apps/{appId}/subscription/{subscriptionId}/subscriber -* [ ] user can select checklist item "Yes I agree that I understood the unsubscribe impact and want to proceed with the process." -* [ ] with clicking/agreeing to the checklist item, the "Unsubscribe" button is active -* [ ] when clicking the "unsubscribe" button, the endpoint PUT /api/Apps/{subscriptionId}/unsubscribe is triggered -* [ ] until endpoint response is available, the button will display the load icon and is not re-clickable -* [ ] in case the endpoint /unsubscribe fails - display the error and keep the cancel overlay displayed to the user -* [ ] in case the endpoint /unsubscribe is successful - close the overlay and show a success notification. Also reload the page to ensure that the app subscription section is up-to-date - +- [ ] when the user clicks the "unsubscribe" button, an overlay gets displayed +- [ ] inside the overlay details of subscription connections are displayed +- [ ] information to display subscription connections are fetched via GET: /api/apps/{appId}/subscription/{subscriptionId}/subscriber +- [ ] user can select checklist item "Yes I agree that I understood the unsubscribe impact and want to proceed with the process." +- [ ] with clicking/agreeing to the checklist item, the "Unsubscribe" button is active +- [ ] when clicking the "unsubscribe" button, the endpoint PUT /api/Apps/{subscriptionId}/unsubscribe is triggered +- [ ] until endpoint response is available, the button will display the load icon and is not re-clickable +- [ ] in case the endpoint /unsubscribe fails - display the error and keep the cancel overlay displayed to the user +- [ ] in case the endpoint /unsubscribe is successful - close the overlay and show a success notification. Also reload the page to ensure that the app subscription section is up-to-date

@@ -40,16 +39,16 @@ Implementation details: Retrieves all app subscriptions of the user acting company.
-##### Business Logic: +##### Business Logic: -* only responsed with active subscriptions +- only responsed with active subscriptions
##### Validation: -* app id must be existing (no matter in which status) -* subscriptionId must be existing and assigned +- app id must be existing (no matter in which status) +- subscriptionId must be existing and assigned
@@ -77,18 +76,18 @@ Response Body Fetches the app subscriptions details incl. possible linked tech user and connector id.
-##### Business Logic: +##### Business Logic: -* based on the subscriptionId check linked technical user and connectors and include the same in the response body - * based on the subscriptionId look-up the possible linked connector ID via table portal.connector_assigned_offer_subscriptions. If an connector ID is found, get via the connector ID and table portal.connectors all related connector data - * +- based on the subscriptionId check linked technical user and connectors and include the same in the response body + - based on the subscriptionId look-up the possible linked connector ID via table portal.connector_assigned_offer_subscriptions. If an connector ID is found, get via the connector ID and table portal.connectors all related connector data + -
##### Validation: -* app id must be existing (no matter in which status) -* subscriptionId must be existing and assigned +- app id must be existing (no matter in which status) +- subscriptionId must be existing and assigned
@@ -141,16 +140,19 @@ Response Body The subsciption customer (offer_subscriptions.company_id) is able to unsubscribe from an app.
-##### Business Logic: +##### Business Logic: + With the PUT api, the backend service will -* set linked "connector" instances to "DELETED" -* set the SD document of the "connector" to "DELETED" -* set linked "technical user" to "DELETED" -* last but not least the subscription record itselfe gets updated to "INACTIVE" + +- set linked "connector" instances to "DELETED" +- set the SD document of the "connector" to "DELETED" +- set linked "technical user" to "DELETED" +- last but not least the subscription record itself gets updated to "INACTIVE" ##### Validation: -* user can only unsubscribe subscriptions where the user assigned company is subscription holder/owner -* only subscriptions in status "ACTIVE" can get set to "INACTIV"E - other status subscriptions will result in an error "Subscription in wrong status. Action not possible." + +- user can only unsubscribe subscriptions where the user assigned company is subscription holder/owner +- only subscriptions in status "ACTIVE" can get set to "INACTIVE" - other status subscriptions will result in an error "Subscription in wrong status. Action not possible."
@@ -160,3 +162,11 @@ With the PUT api, the backend service will

+ +## NOTICE + +This work is licensed under the [Apache-2.0](https://www.apache.org/licenses/LICENSE-2.0). + +- SPDX-License-Identifier: Apache-2.0 +- SPDX-FileCopyrightText: 2021-2023 Contributors to the Eclipse Foundation +- Source URL: https://github.com/eclipse-tractusx/portal-assets diff --git a/developer/04. Apps/06. App Change Process/01. Summary.md b/developer/04. Apps/06. App Change Process/01. Summary.md index 23bcabf98..87c8edc2d 100644 --- a/developer/04. Apps/06. App Change Process/01. Summary.md +++ b/developer/04. Apps/06. App Change Process/01. Summary.md @@ -23,3 +23,11 @@ Functional Details: [click here](
+ +## NOTICE + +This work is licensed under the [Apache-2.0](https://www.apache.org/licenses/LICENSE-2.0). + +- SPDX-License-Identifier: Apache-2.0 +- SPDX-FileCopyrightText: 2021-2023 Contributors to the Eclipse Foundation +- Source URL: https://github.com/eclipse-tractusx/portal-assets diff --git a/developer/04. Apps/06. App Change Process/02. Change App Lead Image.md b/developer/04. Apps/06. App Change Process/02. Change App Lead Image.md index f6311c7d6..4631812b1 100644 --- a/developer/04. Apps/06. App Change Process/02. Change App Lead Image.md +++ b/developer/04. Apps/06. App Change Process/02. Change App Lead Image.md @@ -36,3 +36,11 @@ Request Body

+ +## NOTICE + +This work is licensed under the [Apache-2.0](https://www.apache.org/licenses/LICENSE-2.0). + +- SPDX-License-Identifier: Apache-2.0 +- SPDX-FileCopyrightText: 2021-2023 Contributors to the Eclipse Foundation +- Source URL: https://github.com/eclipse-tractusx/portal-assets diff --git a/developer/04. Apps/06. App Change Process/03. App Instance Url.md b/developer/04. Apps/06. App Change Process/03. App Instance Url.md index e1ea2431c..cf7032800 100644 --- a/developer/04. Apps/06. App Change Process/03. App Instance Url.md +++ b/developer/04. Apps/06. App Change Process/03. App Instance Url.md @@ -25,3 +25,11 @@ Request Body

+ +## NOTICE + +This work is licensed under the [Apache-2.0](https://www.apache.org/licenses/LICENSE-2.0). + +- SPDX-License-Identifier: Apache-2.0 +- SPDX-FileCopyrightText: 2021-2023 Contributors to the Eclipse Foundation +- Source URL: https://github.com/eclipse-tractusx/portal-assets diff --git a/developer/04. Apps/06. App Change Process/03. Change App Description.md b/developer/04. Apps/06. App Change Process/03. Change App Description.md index 9f9e850e0..9fbba5b96 100644 --- a/developer/04. Apps/06. App Change Process/03. Change App Description.md +++ b/developer/04. Apps/06. App Change Process/03. Change App Description.md @@ -40,3 +40,11 @@ Request Body

+ +## NOTICE + +This work is licensed under the [Apache-2.0](https://www.apache.org/licenses/LICENSE-2.0). + +- SPDX-License-Identifier: Apache-2.0 +- SPDX-FileCopyrightText: 2021-2023 Contributors to the Eclipse Foundation +- Source URL: https://github.com/eclipse-tractusx/portal-assets diff --git a/developer/04. Apps/06. App Change Process/04. App Deactivation.md b/developer/04. Apps/06. App Change Process/04. App Deactivation.md index 720e5c391..076541c37 100644 --- a/developer/04. Apps/06. App Change Process/04. App Deactivation.md +++ b/developer/04. Apps/06. App Change Process/04. App Deactivation.md @@ -18,3 +18,11 @@ Request Body

+ +## NOTICE + +This work is licensed under the [Apache-2.0](https://www.apache.org/licenses/LICENSE-2.0). + +- SPDX-License-Identifier: Apache-2.0 +- SPDX-FileCopyrightText: 2021-2023 Contributors to the Eclipse Foundation +- Source URL: https://github.com/eclipse-tractusx/portal-assets diff --git a/developer/04. Apps/06. App Change Process/05. App Instance Url.md b/developer/04. Apps/06. App Change Process/05. App Instance Url.md index e1ea2431c..cf7032800 100644 --- a/developer/04. Apps/06. App Change Process/05. App Instance Url.md +++ b/developer/04. Apps/06. App Change Process/05. App Instance Url.md @@ -25,3 +25,11 @@ Request Body

+ +## NOTICE + +This work is licensed under the [Apache-2.0](https://www.apache.org/licenses/LICENSE-2.0). + +- SPDX-License-Identifier: Apache-2.0 +- SPDX-FileCopyrightText: 2021-2023 Contributors to the Eclipse Foundation +- Source URL: https://github.com/eclipse-tractusx/portal-assets diff --git a/developer/04. Apps/06. App Change Process/06. App Role Change.md b/developer/04. Apps/06. App Change Process/06. App Role Change.md index 4dbff09c1..26fcad0d2 100644 --- a/developer/04. Apps/06. App Change Process/06. App Role Change.md +++ b/developer/04. Apps/06. App Change Process/06. App Role Change.md @@ -80,3 +80,11 @@ Request Body

+ +## NOTICE + +This work is licensed under the [Apache-2.0](https://www.apache.org/licenses/LICENSE-2.0). + +- SPDX-License-Identifier: Apache-2.0 +- SPDX-FileCopyrightText: 2021-2023 Contributors to the Eclipse Foundation +- Source URL: https://github.com/eclipse-tractusx/portal-assets diff --git a/developer/05. Service(s)/01. Service Change.md b/developer/05. Service(s)/01. Service Change.md index 1645b0fa7..96a1af5fc 100644 --- a/developer/05. Service(s)/01. Service Change.md +++ b/developer/05. Service(s)/01. Service Change.md @@ -28,7 +28,7 @@ Service Pre-requisite: - Only those users belonging to the same company as under which the service was created are allowed to upload date Logic: -With the document uplaod; a new data record inside the table documents is created and document is saved connected to the company to which the user belongs as well as to the actual offer for which the document was uplaoded (table: offer_assigned_document) +With the document upload; a new data record inside the table documents is created and document is saved connected to the company to which the user belongs as well as to the actual offer for which the document was uploaded (table: offer_assigned_document) Document status is "PENDING".
@@ -36,3 +36,11 @@ Document status is "PENDING".

+ +## NOTICE + +This work is licensed under the [Apache-2.0](https://www.apache.org/licenses/LICENSE-2.0). + +- SPDX-License-Identifier: Apache-2.0 +- SPDX-FileCopyrightText: 2021-2023 Contributors to the Eclipse Foundation +- Source URL: https://github.com/eclipse-tractusx/portal-assets diff --git a/developer/05. Service(s)/01. Service Marketplace/01. Service Marketplace.md b/developer/05. Service(s)/01. Service Marketplace/01. Service Marketplace.md index 19f01d282..7f0ef3839 100644 --- a/developer/05. Service(s)/01. Service Marketplace/01. Service Marketplace.md +++ b/developer/05. Service(s)/01. Service Marketplace/01. Service Marketplace.md @@ -99,3 +99,11 @@ API Response:

+ +## NOTICE + +This work is licensed under the [Apache-2.0](https://www.apache.org/licenses/LICENSE-2.0). + +- SPDX-License-Identifier: Apache-2.0 +- SPDX-FileCopyrightText: 2021-2023 Contributors to the Eclipse Foundation +- Source URL: https://github.com/eclipse-tractusx/portal-assets diff --git a/developer/05. Service(s)/01. Service Marketplace/02. Service Details.md b/developer/05. Service(s)/01. Service Marketplace/02. Service Details.md index 6a9c41d80..a00cfa863 100644 --- a/developer/05. Service(s)/01. Service Marketplace/02. Service Details.md +++ b/developer/05. Service(s)/01. Service Marketplace/02. Service Details.md @@ -1,6 +1,6 @@ ## Service Offer Details -The service marketplace is providing a list of services (such as consultancy but also datapsace services) to enable CX members to participate in the dataspace. Via a click on the service card; the service offer details will get displayed. +The service marketplace is providing a list of services (such as consultancy but also dataspace services) to enable CX members to participate in the dataspace. Via a click on the service card; the service offer details will get displayed.
Beside the generic list, services can get viewed in specific pre-configured views @@ -111,3 +111,11 @@ The endpoint supports

+ +## NOTICE + +This work is licensed under the [Apache-2.0](https://www.apache.org/licenses/LICENSE-2.0). + +- SPDX-License-Identifier: Apache-2.0 +- SPDX-FileCopyrightText: 2021-2023 Contributors to the Eclipse Foundation +- Source URL: https://github.com/eclipse-tractusx/portal-assets diff --git a/developer/05. Service(s)/02. Service Release Process/01. Service Card.md b/developer/05. Service(s)/02. Service Release Process/01. Service Card.md index d3bf25ae2..f4f922073 100644 --- a/developer/05. Service(s)/02. Service Release Process/01. Service Card.md +++ b/developer/05. Service(s)/02. Service Release Process/01. Service Card.md @@ -14,7 +14,8 @@ In the Step 1 of the publishing process, the service card details are getting fi #### #1 Get Service Type -Service Type options are retrieved with enoum and label via the backend service. +Service Type options are retrieved with enum and label via the backend service. +
```diff @@ -73,7 +74,7 @@ Hints: - Sales Manager: uuid company user with role sales manager - LanguageCode: two digit language short code (e.g. en, de, jp, pt, etc.) -- Service Type Ids: service type label (currently available: DATASPACHE_SERVICE & CONSULTING_SERVICE) +- Service Type Ids: service type label (currently available: DATASPACE_SERVICE & CONSULTING_SERVICE)
@@ -178,3 +179,11 @@ Request body:

+ +## NOTICE + +This work is licensed under the [Apache-2.0](https://www.apache.org/licenses/LICENSE-2.0). + +- SPDX-License-Identifier: Apache-2.0 +- SPDX-FileCopyrightText: 2021-2023 Contributors to the Eclipse Foundation +- Source URL: https://github.com/eclipse-tractusx/portal-assets diff --git a/developer/05. Service(s)/02. Service Release Process/02. Service Detail Page.md b/developer/05. Service(s)/02. Service Release Process/02. Service Detail Page.md index 328d2a39e..f54e9e4d0 100644 --- a/developer/05. Service(s)/02. Service Release Process/02. Service Detail Page.md +++ b/developer/05. Service(s)/02. Service Release Process/02. Service Detail Page.md @@ -105,3 +105,11 @@ Request body:

+ +## NOTICE + +This work is licensed under the [Apache-2.0](https://www.apache.org/licenses/LICENSE-2.0). + +- SPDX-License-Identifier: Apache-2.0 +- SPDX-FileCopyrightText: 2021-2023 Contributors to the Eclipse Foundation +- Source URL: https://github.com/eclipse-tractusx/portal-assets diff --git a/developer/05. Service(s)/02. Service Release Process/02. Service Publish Approval.md b/developer/05. Service(s)/02. Service Release Process/02. Service Publish Approval.md index bd18de3e9..4f2ff42d1 100644 --- a/developer/05. Service(s)/02. Service Release Process/02. Service Publish Approval.md +++ b/developer/05. Service(s)/02. Service Release Process/02. Service Publish Approval.md @@ -154,3 +154,11 @@ The endpoint supports

+ +## NOTICE + +This work is licensed under the [Apache-2.0](https://www.apache.org/licenses/LICENSE-2.0). + +- SPDX-License-Identifier: Apache-2.0 +- SPDX-FileCopyrightText: 2021-2023 Contributors to the Eclipse Foundation +- Source URL: https://github.com/eclipse-tractusx/portal-assets diff --git a/developer/05. Service(s)/02. Service Release Process/03.Terms&Conditions.md b/developer/05. Service(s)/02. Service Release Process/03.Terms&Conditions.md index 71adad324..0dd9a4175 100644 --- a/developer/05. Service(s)/02. Service Release Process/03.Terms&Conditions.md +++ b/developer/05. Service(s)/02. Service Release Process/03.Terms&Conditions.md @@ -88,3 +88,11 @@ Response Body

+ +## NOTICE + +This work is licensed under the [Apache-2.0](https://www.apache.org/licenses/LICENSE-2.0). + +- SPDX-License-Identifier: Apache-2.0 +- SPDX-FileCopyrightText: 2021-2023 Contributors to the Eclipse Foundation +- Source URL: https://github.com/eclipse-tractusx/portal-assets diff --git a/developer/05. Service(s)/02. Service Release Process/04.Technical Integration.md b/developer/05. Service(s)/02. Service Release Process/04.Technical Integration.md index 086f603af..c9b734f03 100644 --- a/developer/05. Service(s)/02. Service Release Process/04.Technical Integration.md +++ b/developer/05. Service(s)/02. Service Release Process/04.Technical Integration.md @@ -1,7 +1,7 @@ ### Step 4 - Technical Integration The 'Technical Integration' is used to enable the service provider to define the technical user profile needed to run the service. Depending on the service type, the technical user profile is relevant or will be skipped. -If the service provider is planning to publish a dataspace service, such as a managed EDC, the technical user profile is needed to retrieve as part of the service subscriiption activation for a specific customer the respective technical user. The technical user will be used to connect to the Catena-X dataspace and enable the provider to run the service authorization etc. +If the service provider is planning to publish a dataspace service, such as a managed EDC, the technical user profile is needed to retrieve as part of the service subscription activation for a specific customer the respective technical user. The technical user will be used to connect to the Catena-X dataspace and enable the provider to run the service authorization etc. For the technical integration the respetive available technical user profiles will be displayed. The service provider can select one or multiple user permissions which are supposed to get assigned to the respective technical user as soon as created. @@ -80,3 +80,11 @@ Request Body

+ +## NOTICE + +This work is licensed under the [Apache-2.0](https://www.apache.org/licenses/LICENSE-2.0). + +- SPDX-License-Identifier: Apache-2.0 +- SPDX-FileCopyrightText: 2021-2023 Contributors to the Eclipse Foundation +- Source URL: https://github.com/eclipse-tractusx/portal-assets diff --git a/developer/05. Service(s)/02. Service Release Process/05.Verify & Submit.md b/developer/05. Service(s)/02. Service Release Process/05.Verify & Submit.md index 6ff65ecac..cee865977 100644 --- a/developer/05. Service(s)/02. Service Release Process/05.Verify & Submit.md +++ b/developer/05. Service(s)/02. Service Release Process/05.Verify & Submit.md @@ -88,3 +88,11 @@ Additionally this endpoint will:

+ +## NOTICE + +This work is licensed under the [Apache-2.0](https://www.apache.org/licenses/LICENSE-2.0). + +- SPDX-License-Identifier: Apache-2.0 +- SPDX-FileCopyrightText: 2021-2023 Contributors to the Eclipse Foundation +- Source URL: https://github.com/eclipse-tractusx/portal-assets diff --git a/developer/05. Service(s)/02. Service Release Process/index.md b/developer/05. Service(s)/02. Service Release Process/index.md index 0ecd5af8f..42b753994 100644 --- a/developer/05. Service(s)/02. Service Release Process/index.md +++ b/developer/05. Service(s)/02. Service Release Process/index.md @@ -12,3 +12,11 @@ Links:

+ +## NOTICE + +This work is licensed under the [Apache-2.0](https://www.apache.org/licenses/LICENSE-2.0). + +- SPDX-License-Identifier: Apache-2.0 +- SPDX-FileCopyrightText: 2021-2023 Contributors to the Eclipse Foundation +- Source URL: https://github.com/eclipse-tractusx/portal-assets diff --git a/developer/05. Service(s)/03. Service Release Approval/01. Service Approval Board Overview.md b/developer/05. Service(s)/03. Service Release Approval/01. Service Approval Board Overview.md index b76e5815b..ff2172e6f 100644 --- a/developer/05. Service(s)/03. Service Release Approval/01. Service Approval Board Overview.md +++ b/developer/05. Service(s)/03. Service Release Approval/01. Service Approval Board Overview.md @@ -71,3 +71,11 @@ Request Only: {hostname}/api/services/ServiceRelease/inReview?page=0&size=15&sta

+ +## NOTICE + +This work is licensed under the [Apache-2.0](https://www.apache.org/licenses/LICENSE-2.0). + +- SPDX-License-Identifier: Apache-2.0 +- SPDX-FileCopyrightText: 2021-2023 Contributors to the Eclipse Foundation +- Source URL: https://github.com/eclipse-tractusx/portal-assets diff --git a/developer/05. Service(s)/03. Service Release Approval/02. Service Details.md b/developer/05. Service(s)/03. Service Release Approval/02. Service Details.md index c49c4527d..f67a9eafe 100644 --- a/developer/05. Service(s)/03. Service Release Approval/02. Service Details.md +++ b/developer/05. Service(s)/03. Service Release Approval/02. Service Details.md @@ -86,3 +86,11 @@ Service documents can get downloaded by clicking on the document name highlighte

+ +## NOTICE + +This work is licensed under the [Apache-2.0](https://www.apache.org/licenses/LICENSE-2.0). + +- SPDX-License-Identifier: Apache-2.0 +- SPDX-FileCopyrightText: 2021-2023 Contributors to the Eclipse Foundation +- Source URL: https://github.com/eclipse-tractusx/portal-assets diff --git a/developer/05. Service(s)/03. Service Release Approval/03. Approve Service Release.md b/developer/05. Service(s)/03. Service Release Approval/03. Approve Service Release.md index 9e4b00db2..124acc064 100644 --- a/developer/05. Service(s)/03. Service Release Approval/03. Approve Service Release.md +++ b/developer/05. Service(s)/03. Service Release Approval/03. Approve Service Release.md @@ -29,3 +29,11 @@ Details regarding the notification created for the service provider can get foun

+ +## NOTICE + +This work is licensed under the [Apache-2.0](https://www.apache.org/licenses/LICENSE-2.0). + +- SPDX-License-Identifier: Apache-2.0 +- SPDX-FileCopyrightText: 2021-2023 Contributors to the Eclipse Foundation +- Source URL: https://github.com/eclipse-tractusx/portal-assets diff --git a/developer/05. Service(s)/03. Service Release Approval/04. Decline Service Release.md b/developer/05. Service(s)/03. Service Release Approval/04. Decline Service Release.md index 4eb7dc911..2fef54c16 100644 --- a/developer/05. Service(s)/03. Service Release Approval/04. Decline Service Release.md +++ b/developer/05. Service(s)/03. Service Release Approval/04. Decline Service Release.md @@ -51,3 +51,11 @@ Details of the api logic/business logic ##### Email Example image to be added + +## NOTICE + +This work is licensed under the [Apache-2.0](https://www.apache.org/licenses/LICENSE-2.0). + +- SPDX-License-Identifier: Apache-2.0 +- SPDX-FileCopyrightText: 2021-2023 Contributors to the Eclipse Foundation +- Source URL: https://github.com/eclipse-tractusx/portal-assets diff --git a/developer/05. Service(s)/03. Service Subscription/01. Service Subscription.md b/developer/05. Service(s)/03. Service Subscription/01. Service Subscription.md index a1c240e2f..06024277f 100644 --- a/developer/05. Service(s)/03. Service Subscription/01. Service Subscription.md +++ b/developer/05. Service(s)/03. Service Subscription/01. Service Subscription.md @@ -93,3 +93,11 @@ Request Body

+ +## NOTICE + +This work is licensed under the [Apache-2.0](https://www.apache.org/licenses/LICENSE-2.0). + +- SPDX-License-Identifier: Apache-2.0 +- SPDX-FileCopyrightText: 2021-2023 Contributors to the Eclipse Foundation +- Source URL: https://github.com/eclipse-tractusx/portal-assets diff --git a/developer/05. Service(s)/03. Service Subscription/01.Service Subscription Request Management.md b/developer/05. Service(s)/03. Service Subscription/01.Service Subscription Request Management.md index b32b4ed1b..807d7c4b0 100644 --- a/developer/05. Service(s)/03. Service Subscription/01.Service Subscription Request Management.md +++ b/developer/05. Service(s)/03. Service Subscription/01.Service Subscription Request Management.md @@ -6,18 +6,18 @@ The main focus / scope of the page is to enable service providers to manage thei The page includes following functions -* search -* filter -* trigger subscription activation -* view subscription details (customer, technical user details, etc.) +- search +- filter +- trigger subscription activation +- view subscription details (customer, technical user details, etc.)

-Links: +Links: -[Design](/docs/05.%20Service(s)/03.%20Service%20Subscription/03.%20Subscription%20Overview%20(Provider).md) -[FAQ](/docs/05.%20Service(s)/03.%20Service%20Subscription/05.%20FAQ.md) +[Design]() +[FAQ]()

@@ -37,7 +37,6 @@ Links: image -

@@ -54,7 +53,7 @@ Links: ##### Function: Views -=> All: {hostname}/api/services/provided/subscription-status?page=0&size=15 +=> All: {hostname}/api/services/provided/subscription-status?page=0&size=15 => Requests: {hostname}/api/services/provided/subscription-status?page=0&size=15&statusId=PENDING => Active: {hostname}/api/services/provided/subscription-status?page=0&size=15&statusId=ACTIVE @@ -113,15 +112,15 @@ If the user selects an filter button (single select only possible) the endpoint (important, the service filter and status filter can be jointly used - as shared in the url above) -

#### #4 Subscription Overview + The endpont shows all subscription requests and active subscriptions.
-Data mapping details: +Data mapping details:

image @@ -147,11 +146,13 @@ GET: /api/services/provided
#### #5 Subscription Details + With the click on "Show Details" the service provider receives the customer subscription details (as defined below)
Data mapping details:
+

image

@@ -186,3 +187,11 @@ GET: /api/service/{serviceId}/subscription/{subscriptionId}/provider

+ +## NOTICE + +This work is licensed under the [Apache-2.0](https://www.apache.org/licenses/LICENSE-2.0). + +- SPDX-License-Identifier: Apache-2.0 +- SPDX-FileCopyrightText: 2021-2023 Contributors to the Eclipse Foundation +- Source URL: https://github.com/eclipse-tractusx/portal-assets diff --git a/developer/05. Service(s)/03. Service Subscription/02. Service Subscription Activation (Provider).md b/developer/05. Service(s)/03. Service Subscription/02. Service Subscription Activation (Provider).md index 439b0507e..374582f74 100644 --- a/developer/05. Service(s)/03. Service Subscription/02. Service Subscription Activation (Provider).md +++ b/developer/05. Service(s)/03. Service Subscription/02. Service Subscription Activation (Provider).md @@ -115,3 +115,11 @@ POST: /api/services/autoSetup

+ +## NOTICE + +This work is licensed under the [Apache-2.0](https://www.apache.org/licenses/LICENSE-2.0). + +- SPDX-License-Identifier: Apache-2.0 +- SPDX-FileCopyrightText: 2021-2023 Contributors to the Eclipse Foundation +- Source URL: https://github.com/eclipse-tractusx/portal-assets diff --git a/developer/05. Service(s)/03. Service Subscription/03. Unsubscribe.md b/developer/05. Service(s)/03. Service Subscription/03. Unsubscribe.md index 3fe06d19a..d434d143e 100644 --- a/developer/05. Service(s)/03. Service Subscription/03. Unsubscribe.md +++ b/developer/05. Service(s)/03. Service Subscription/03. Unsubscribe.md @@ -3,28 +3,30 @@ Enable customers of an app to unsubscribe the active subscription. With the unsubscription connected objects (see details below) are getting inactivated as well. -[Functional Description](/docs/05.%20Service(s)/03.%20Service%20Subscription/04.%20Service%20Unsubscribe.md) +[Functional Description]()

-### Implementation +### Implementation #### #1 PUT Unsubscribe -The subsciption customer (offer_subscriptions.company_id) is able to unsubscribe from an service. +The subscription customer (offer_subscriptions.company_id) is able to unsubscribe from an service.
Business Logic: With the PUT api, the backend service will -* set linked "connector" instances to "DELETED" -* set the SD document of the "connector" to "DELETED" -* set linked "technical user" to "DELETED" -* last but not least the subscription record itselfe gets updated to "INACTIVE" + +- set linked "connector" instances to "DELETED" +- set the SD document of the "connector" to "DELETED" +- set linked "technical user" to "DELETED" +- last but not least the subscription record itself gets updated to "INACTIVE" Validation: -* user can only unsubscribe subscriptions where the user assigned company is subscription holder/owner -* only subscriptions in status "ACTIVE" can get set to "INACTIV"E - other status subscriptions will result in an error "Subscription in wrong status. Action not possible." + +- user can only unsubscribe subscriptions where the user assigned company is subscription holder/owner +- only subscriptions in status "ACTIVE" can get set to "INACTIVE" - other status subscriptions will result in an error "Subscription in wrong status. Action not possible."
@@ -34,3 +36,11 @@ Validation:

+ +## NOTICE + +This work is licensed under the [Apache-2.0](https://www.apache.org/licenses/LICENSE-2.0). + +- SPDX-License-Identifier: Apache-2.0 +- SPDX-FileCopyrightText: 2021-2023 Contributors to the Eclipse Foundation +- Source URL: https://github.com/eclipse-tractusx/portal-assets diff --git a/developer/05. Service(s)/04. Service Provider Management Board(s)/01. App Board.md b/developer/05. Service(s)/04. Service Provider Management Board(s)/01. App Board.md index 867c3ce0f..dcac1e8cd 100644 --- a/developer/05. Service(s)/04. Service Provider Management Board(s)/01. App Board.md +++ b/developer/05. Service(s)/04. Service Provider Management Board(s)/01. App Board.md @@ -134,3 +134,11 @@ The endpoint supports

+ +## NOTICE + +This work is licensed under the [Apache-2.0](https://www.apache.org/licenses/LICENSE-2.0). + +- SPDX-License-Identifier: Apache-2.0 +- SPDX-FileCopyrightText: 2021-2023 Contributors to the Eclipse Foundation +- Source URL: https://github.com/eclipse-tractusx/portal-assets diff --git a/developer/05. Service(s)/06. Service Change Process/01. Summary.md b/developer/05. Service(s)/06. Service Change Process/01. Summary.md index 6cab4c40c..5aaf54f24 100644 --- a/developer/05. Service(s)/06. Service Change Process/01. Summary.md +++ b/developer/05. Service(s)/06. Service Change Process/01. Summary.md @@ -10,3 +10,11 @@ Current supported "Service Changes":

+ +## NOTICE + +This work is licensed under the [Apache-2.0](https://www.apache.org/licenses/LICENSE-2.0). + +- SPDX-License-Identifier: Apache-2.0 +- SPDX-FileCopyrightText: 2021-2023 Contributors to the Eclipse Foundation +- Source URL: https://github.com/eclipse-tractusx/portal-assets diff --git a/developer/05. Service(s)/06. Service Change Process/02. Service Deactivation.md b/developer/05. Service(s)/06. Service Change Process/02. Service Deactivation.md index ece25c7fe..4f73e70aa 100644 --- a/developer/05. Service(s)/06. Service Change Process/02. Service Deactivation.md +++ b/developer/05. Service(s)/06. Service Change Process/02. Service Deactivation.md @@ -59,3 +59,11 @@ Validation:

+ +## NOTICE + +This work is licensed under the [Apache-2.0](https://www.apache.org/licenses/LICENSE-2.0). + +- SPDX-License-Identifier: Apache-2.0 +- SPDX-FileCopyrightText: 2021-2023 Contributors to the Eclipse Foundation +- Source URL: https://github.com/eclipse-tractusx/portal-assets diff --git a/developer/Technical Documentation/Architecture/Architecture Constraints.md b/developer/Technical Documentation/Architecture/Architecture Constraints.md index 52bb1776c..2f074ca8e 100644 --- a/developer/Technical Documentation/Architecture/Architecture Constraints.md +++ b/developer/Technical Documentation/Architecture/Architecture Constraints.md @@ -26,3 +26,11 @@ --comming soon--- (Veracode; Eslinter, Sonarcloud, etc.) + +## NOTICE + +This work is licensed under the [Apache-2.0](https://www.apache.org/licenses/LICENSE-2.0). + +- SPDX-License-Identifier: Apache-2.0 +- SPDX-FileCopyrightText: 2021-2023 Contributors to the Eclipse Foundation +- Source URL: https://github.com/eclipse-tractusx/portal-assets diff --git a/developer/Technical Documentation/Architecture/Building block view.md b/developer/Technical Documentation/Architecture/Building block view.md index 278ff8b7f..6782a9389 100644 --- a/developer/Technical Documentation/Architecture/Building block view.md +++ b/developer/Technical Documentation/Architecture/Building block view.md @@ -17,3 +17,11 @@ Currently integrated (or in the process of being integrated) products are:

+ +## NOTICE + +This work is licensed under the [Apache-2.0](https://www.apache.org/licenses/LICENSE-2.0). + +- SPDX-License-Identifier: Apache-2.0 +- SPDX-FileCopyrightText: 2021-2023 Contributors to the Eclipse Foundation +- Source URL: https://github.com/eclipse-tractusx/portal-assets diff --git a/developer/Technical Documentation/Architecture/Context and scope.md b/developer/Technical Documentation/Architecture/Context and scope.md index ed9e24ab7..07dba1ad4 100644 --- a/developer/Technical Documentation/Architecture/Context and scope.md +++ b/developer/Technical Documentation/Architecture/Context and scope.md @@ -7,3 +7,11 @@ Any uses-case, value stream, function within Catena-X can be exposed an accessed ## Technical Context The provided components (see building block view) comprise the technical foundation for interaction, integration, authentication, authorization, provisioning, monitoring, auditing and further functionalities. They are state of the art in terms of technology portfolio, consist of open-source components whenever possible and are open-sourced themselves 100%. + +## NOTICE + +This work is licensed under the [Apache-2.0](https://www.apache.org/licenses/LICENSE-2.0). + +- SPDX-License-Identifier: Apache-2.0 +- SPDX-FileCopyrightText: 2021-2023 Contributors to the Eclipse Foundation +- Source URL: https://github.com/eclipse-tractusx/portal-assets diff --git a/developer/Technical Documentation/Architecture/Development Concept.md b/developer/Technical Documentation/Architecture/Development Concept.md index 007574f91..50b367b6f 100644 --- a/developer/Technical Documentation/Architecture/Development Concept.md +++ b/developer/Technical Documentation/Architecture/Development Concept.md @@ -211,3 +211,11 @@ The migration will consist of an initial migration as well as delta migration fi ## Configurability Portal configuration is mainly possible via the appsettings files as well as the static data migration files. + +## NOTICE + +This work is licensed under the [Apache-2.0](https://www.apache.org/licenses/LICENSE-2.0). + +- SPDX-License-Identifier: Apache-2.0 +- SPDX-FileCopyrightText: 2021-2023 Contributors to the Eclipse Foundation +- Source URL: https://github.com/eclipse-tractusx/portal-assets diff --git a/developer/Technical Documentation/Architecture/Requirements.md b/developer/Technical Documentation/Architecture/Requirements.md index adae51190..317100a87 100644 --- a/developer/Technical Documentation/Architecture/Requirements.md +++ b/developer/Technical Documentation/Architecture/Requirements.md @@ -18,3 +18,11 @@ For Catena-X Member Companies |REQ-C-002|BPN-Integration|Each member company is integrated with its global BPN the enable unified identification (also cross-network)| |REQ-C-003|Cross-Network|Companies already verified in other (supported/friendly) networks will receive fast-lane onboarding| |REQ-C-004|Identity Integration|Authentication is done vis IdP Federation to minimize administration overhead and to simplify logins. Authorization not included, this must be done Catena-X specific by the Central-IdP| + +## NOTICE + +This work is licensed under the [Apache-2.0](https://www.apache.org/licenses/LICENSE-2.0). + +- SPDX-License-Identifier: Apache-2.0 +- SPDX-FileCopyrightText: 2021-2023 Contributors to the Eclipse Foundation +- Source URL: https://github.com/eclipse-tractusx/portal-assets diff --git a/developer/Technical Documentation/Architecture/Solution strategy.md b/developer/Technical Documentation/Architecture/Solution strategy.md index 7b6fb4f92..6787f695d 100644 --- a/developer/Technical Documentation/Architecture/Solution strategy.md +++ b/developer/Technical Documentation/Architecture/Solution strategy.md @@ -4,3 +4,11 @@ - APIs are always REST-based with token authentication. - OIDC is used for authentication and authorization. - IaC is fully realized via helm charts. + +## NOTICE + +This work is licensed under the [Apache-2.0](https://www.apache.org/licenses/LICENSE-2.0). + +- SPDX-License-Identifier: Apache-2.0 +- SPDX-FileCopyrightText: 2021-2023 Contributors to the Eclipse Foundation +- Source URL: https://github.com/eclipse-tractusx/portal-assets diff --git a/developer/Technical Documentation/Architecture/Whitebox Overall System.md b/developer/Technical Documentation/Architecture/Whitebox Overall System.md index 8c740b230..dfa67eedb 100644 --- a/developer/Technical Documentation/Architecture/Whitebox Overall System.md +++ b/developer/Technical Documentation/Architecture/Whitebox Overall System.md @@ -44,3 +44,11 @@ Integration: Portal, Marketplace, Backend, Wallets, BPDM, SD Factory, AutoSetup, ### Important Interfaces **\* to be added \*\*** + +## NOTICE + +This work is licensed under the [Apache-2.0](https://www.apache.org/licenses/LICENSE-2.0). + +- SPDX-License-Identifier: Apache-2.0 +- SPDX-FileCopyrightText: 2021-2023 Contributors to the Eclipse Foundation +- Source URL: https://github.com/eclipse-tractusx/portal-assets diff --git a/developer/Technical Documentation/Architecture/operational-concept.md b/developer/Technical Documentation/Architecture/operational-concept.md index ea159b478..3333c3615 100644 --- a/developer/Technical Documentation/Architecture/operational-concept.md +++ b/developer/Technical Documentation/Architecture/operational-concept.md @@ -41,3 +41,11 @@ Currently all backend services write log entries as structural data in json form - StatusCode - contains the status code of the response - Elapsed - contains the time a endpoint took to response in milliseconds - RenderedMessage - contains the log message with possible errors + +## NOTICE + +This work is licensed under the [Apache-2.0](https://www.apache.org/licenses/LICENSE-2.0). + +- SPDX-License-Identifier: Apache-2.0 +- SPDX-FileCopyrightText: 2021-2023 Contributors to the Eclipse Foundation +- Source URL: https://github.com/eclipse-tractusx/portal-assets diff --git a/developer/Technical Documentation/DB Views and Details/App - DB - View.md b/developer/Technical Documentation/DB Views and Details/App - DB - View.md index ab8b0ee94..b20afb2b7 100644 --- a/developer/Technical Documentation/DB Views and Details/App - DB - View.md +++ b/developer/Technical Documentation/DB Views and Details/App - DB - View.md @@ -102,3 +102,11 @@ The date_last_changed is getting automatically updated if any of the following e

+ +## NOTICE + +This work is licensed under the [Apache-2.0](https://www.apache.org/licenses/LICENSE-2.0). + +- SPDX-License-Identifier: Apache-2.0 +- SPDX-FileCopyrightText: 2021-2023 Contributors to the Eclipse Foundation +- Source URL: https://github.com/eclipse-tractusx/portal-assets diff --git a/developer/Technical Documentation/DB Views and Details/Connector - DB - View.md b/developer/Technical Documentation/DB Views and Details/Connector - DB - View.md index 93f577489..4542a849f 100644 --- a/developer/Technical Documentation/DB Views and Details/Connector - DB - View.md +++ b/developer/Technical Documentation/DB Views and Details/Connector - DB - View.md @@ -4,3 +4,11 @@

+ +## NOTICE + +This work is licensed under the [Apache-2.0](https://www.apache.org/licenses/LICENSE-2.0). + +- SPDX-License-Identifier: Apache-2.0 +- SPDX-FileCopyrightText: 2021-2023 Contributors to the Eclipse Foundation +- Source URL: https://github.com/eclipse-tractusx/portal-assets diff --git a/developer/Technical Documentation/DB Views and Details/Data Management.md b/developer/Technical Documentation/DB Views and Details/Data Management.md index 08f8a4e1c..b31ce6ed2 100644 --- a/developer/Technical Documentation/DB Views and Details/Data Management.md +++ b/developer/Technical Documentation/DB Views and Details/Data Management.md @@ -101,13 +101,13 @@ Transactional data is created by operating the system in a market or testing act ## Layering Concept on Keycloak side -For keycloak, the concept is similar. +For Keycloak, the concept is similar. There is a base setup (provided as static data setting) as well as transactional data. -The difference between keycloak and portal is inside the load. +The difference between Keycloak and portal is inside the load. -Its not planned to have soon any delta updates in keycloak regarding the base data. Off course there will changes in the inital load, but for a certain time those are planned to get added by the operator manually till an actual delta load solution is in place. +Its not planned to have soon any delta updates in Keycloak regarding the base data. Off course there will changes in the initial load, but for a certain time those are planned to get added by the operator manually till an actual delta load solution is in place.
@@ -147,3 +147,11 @@ Following technical users are part of the base setup of the portal and will be a

+ +## NOTICE + +This work is licensed under the [Apache-2.0](https://www.apache.org/licenses/LICENSE-2.0). + +- SPDX-License-Identifier: Apache-2.0 +- SPDX-FileCopyrightText: 2021-2023 Contributors to the Eclipse Foundation +- Source URL: https://github.com/eclipse-tractusx/portal-assets diff --git a/developer/Technical Documentation/DB Views and Details/Documents - DB - View.md b/developer/Technical Documentation/DB Views and Details/Documents - DB - View.md index 13da1e0e4..13dba9b0b 100644 --- a/developer/Technical Documentation/DB Views and Details/Documents - DB - View.md +++ b/developer/Technical Documentation/DB Views and Details/Documents - DB - View.md @@ -20,3 +20,11 @@ Mainly 4 tables are used for the documents itself
Details to the documents service implementation can get found [here](/developer/Technical%20Documentation/Services/Document_Management.md#summary) + +## NOTICE + +This work is licensed under the [Apache-2.0](https://www.apache.org/licenses/LICENSE-2.0). + +- SPDX-License-Identifier: Apache-2.0 +- SPDX-FileCopyrightText: 2021-2023 Contributors to the Eclipse Foundation +- Source URL: https://github.com/eclipse-tractusx/portal-assets diff --git a/developer/Technical Documentation/DB Views and Details/Subscription - DB - View.md b/developer/Technical Documentation/DB Views and Details/Subscription - DB - View.md index 8407455df..e6ec7621d 100644 --- a/developer/Technical Documentation/DB Views and Details/Subscription - DB - View.md +++ b/developer/Technical Documentation/DB Views and Details/Subscription - DB - View.md @@ -7,13 +7,13 @@

-#### Difference Offer_Subscription and App_Subscriptionn_Details +#### Difference Offer_Subscription and App_Subscription_Details The offer_subscription table is holding all subscription requests; active subscriptions as well as inactive subscriptions. When a user is triggering the subscription request for anything on the marketplace; the request/record will get saved inside the offer_subscription table.
The app_subscription_details table is only used when an app subscription request is getting activated. In that case; the app subscription details (such as the tenant url) is getting stored inside this table. -Endpoints such as "My Busines Application" are using those details to provide the right tenant/url to the respective user. +Endpoints such as "My Business Application" are using those details to provide the right tenant/url to the respective user.

@@ -25,3 +25,11 @@ Planned release 3.2

+ +## NOTICE + +This work is licensed under the [Apache-2.0](https://www.apache.org/licenses/LICENSE-2.0). + +- SPDX-License-Identifier: Apache-2.0 +- SPDX-FileCopyrightText: 2021-2023 Contributors to the Eclipse Foundation +- Source URL: https://github.com/eclipse-tractusx/portal-assets diff --git a/developer/Technical Documentation/Dev Process/Dev-flow_deploy-dev-env.md b/developer/Technical Documentation/Dev Process/Dev-flow_deploy-dev-env.md index 2c96a20d2..8bf385127 100644 --- a/developer/Technical Documentation/Dev Process/Dev-flow_deploy-dev-env.md +++ b/developer/Technical Documentation/Dev Process/Dev-flow_deploy-dev-env.md @@ -49,3 +49,11 @@ Note\*\*\* Unit tests and Sonarcloud runs at pull request, Trivy and KICS scans Note\*\*\*\* Sonarcloud runs at pull request, Trivy and KICS scans at merge as well as daily Note**\*** Trivy and KICS scans are scheduled to daily + +## NOTICE + +This work is licensed under the [Apache-2.0](https://www.apache.org/licenses/LICENSE-2.0). + +- SPDX-License-Identifier: Apache-2.0 +- SPDX-FileCopyrightText: 2021-2023 Contributors to the Eclipse Foundation +- Source URL: https://github.com/eclipse-tractusx/portal-assets diff --git a/developer/Technical Documentation/Dev Process/Dev-flow_git-diagram.md b/developer/Technical Documentation/Dev Process/Dev-flow_git-diagram.md index 62ecaeb18..09eba0eee 100644 --- a/developer/Technical Documentation/Dev Process/Dev-flow_git-diagram.md +++ b/developer/Technical Documentation/Dev Process/Dev-flow_git-diagram.md @@ -123,3 +123,11 @@ gitGraph checkout dev merge main ``` + +## NOTICE + +This work is licensed under the [Apache-2.0](https://www.apache.org/licenses/LICENSE-2.0). + +- SPDX-License-Identifier: Apache-2.0 +- SPDX-FileCopyrightText: 2021-2023 Contributors to the Eclipse Foundation +- Source URL: https://github.com/eclipse-tractusx/portal-assets diff --git a/developer/Technical Documentation/Dev Process/Enumeration Handling.md b/developer/Technical Documentation/Dev Process/Enumeration Handling.md index ce6769f91..a53907fb9 100644 --- a/developer/Technical Documentation/Dev Process/Enumeration Handling.md +++ b/developer/Technical Documentation/Dev Process/Enumeration Handling.md @@ -46,7 +46,7 @@ Since enums have an enhanced impact on the system functionality; it is mandatori ### Change Enums Change of enums (labels) is possible but need to be done carefully and only if necessarily needed. -In the case a change is getting executed; the system configuration / appsettings / env. variables need to get checked to ensure that those dont refer to the enum which is getting changed/ updated. +In the case a change is getting executed; the system configuration / appsettings / env. variables need to get checked to ensure that those don't refer to the enum which is getting changed/ updated. Same applies to frontend and backend logic. Both might refer to the enum label and will automatically fail when an enum value is getting changed.
@@ -66,3 +66,11 @@ It is not recommended to delete enums; instead .......... to be updated; we need

+ +## NOTICE + +This work is licensed under the [Apache-2.0](https://www.apache.org/licenses/LICENSE-2.0). + +- SPDX-License-Identifier: Apache-2.0 +- SPDX-FileCopyrightText: 2021-2023 Contributors to the Eclipse Foundation +- Source URL: https://github.com/eclipse-tractusx/portal-assets diff --git a/developer/Technical Documentation/Dev Process/How to contribute.md b/developer/Technical Documentation/Dev Process/How to contribute.md index e14bfe4e1..2262f980f 100644 --- a/developer/Technical Documentation/Dev Process/How to contribute.md +++ b/developer/Technical Documentation/Dev Process/How to contribute.md @@ -101,3 +101,11 @@ The suggested naming convention is '{type}{(function)}: {short summary}' Add details to the change, fix or feature in the PR description. What was changed, why was it changed (e.g. which issue was fixed or which requirement was implemented), and how was it changed. + +## NOTICE + +This work is licensed under the [Apache-2.0](https://www.apache.org/licenses/LICENSE-2.0). + +- SPDX-License-Identifier: Apache-2.0 +- SPDX-FileCopyrightText: 2021-2023 Contributors to the Eclipse Foundation +- Source URL: https://github.com/eclipse-tractusx/portal-assets diff --git a/developer/Technical Documentation/Dev Process/Multi Language.md b/developer/Technical Documentation/Dev Process/Multi Language.md index 24b014d7f..73304fde2 100644 --- a/developer/Technical Documentation/Dev Process/Multi Language.md +++ b/developer/Technical Documentation/Dev Process/Multi Language.md @@ -45,3 +45,11 @@ Inside the CX Portal, the locales are divided by pages. image
There is one main file holding the generic translation for often used items (e.g. "approval button", headlines,...) and a file for each specific page to translate not often used values. + +## NOTICE + +This work is licensed under the [Apache-2.0](https://www.apache.org/licenses/LICENSE-2.0). + +- SPDX-License-Identifier: Apache-2.0 +- SPDX-FileCopyrightText: 2021-2023 Contributors to the Eclipse Foundation +- Source URL: https://github.com/eclipse-tractusx/portal-assets diff --git a/developer/Technical Documentation/Dev Process/Run frontend on localhost.md b/developer/Technical Documentation/Dev Process/Run frontend on localhost.md index 921318604..ab0b00735 100644 --- a/developer/Technical Documentation/Dev Process/Run frontend on localhost.md +++ b/developer/Technical Documentation/Dev Process/Run frontend on localhost.md @@ -44,3 +44,11 @@ We start each part as a server process running on a different port. Then we star With the last step the portal is fully running and there should automatically open a browser session pointing to your local development instance at http://localhost:3000/ By default the frontend is using the backend services deployed on the public development environment. + +## NOTICE + +This work is licensed under the [Apache-2.0](https://www.apache.org/licenses/LICENSE-2.0). + +- SPDX-License-Identifier: Apache-2.0 +- SPDX-FileCopyrightText: 2021-2023 Contributors to the Eclipse Foundation +- Source URL: https://github.com/eclipse-tractusx/portal-assets diff --git a/developer/Technical Documentation/Dev Process/Shared Components.md b/developer/Technical Documentation/Dev Process/Shared Components.md index 91f722279..61011dd62 100644 --- a/developer/Technical Documentation/Dev Process/Shared Components.md +++ b/developer/Technical Documentation/Dev Process/Shared Components.md @@ -32,3 +32,11 @@ Every time you make a change: 6. if everything works as expected do this: - run npm unpublish --force - change the names back to @catena-x , set the version to one higher than the last published one and raise PR. + +## NOTICE + +This work is licensed under the [Apache-2.0](https://www.apache.org/licenses/LICENSE-2.0). + +- SPDX-License-Identifier: Apache-2.0 +- SPDX-FileCopyrightText: 2021-2023 Contributors to the Eclipse Foundation +- Source URL: https://github.com/eclipse-tractusx/portal-assets diff --git a/developer/Technical Documentation/Identity & Access/00. External Identity Provider.md b/developer/Technical Documentation/Identity & Access/00. External Identity Provider.md deleted file mode 100644 index 49085d044..000000000 --- a/developer/Technical Documentation/Identity & Access/00. External Identity Provider.md +++ /dev/null @@ -1,48 +0,0 @@ -For federated identities, external identity providers are needed. -To support the external identity provider configuration, a user interface flow [Technical Integration IdP](./developer/02.%20Technical%20Integration/02.%20Identity%20Provider%20Management) is implement with which company admins can create / configure the company IdP as external IdP. -For details, please follow the provided link. - -## How does the external IdP connection work? - -Similar like the sharedIdP which is configured for all companies using the catena-x IdP as authentication provider; external company IdPs getting similarily configured. -The company idP is created as external IdP inside the "Identity Provider" menu of the leading realm. - -image - -Keycloak does in general support a huge number of idp(s) - however for Catena-X social network IdPs as well as SAML connections are not planned to get supported. Instead all connections are considered as OIDC connections. - -image - -IdPs are created with the following paraemter - -- Alias (unique name) -- Display Name (IdP display name in the login page) -- Metadata URL (metadata url of the external IdP for automatic configuration) - -
-image -
-
-image -
- -To ensure that the auto user creation is disabled (important to not generate a out of sync mode between the keycloak db and portal db) the "First Login Flow" need to get set to "Login without auto user creation" (customized theme create by CX consortia and part of the release package). - -image - -
- -Last but not least the client id and secret of the external IdP is needed to establish the trust between both the idps. - -image - -
- -After this generic settings are done, the idp is successfully configured. -Each IdP will get automatically (when created via endpoint - which is strongly suggested to ensure a in-sync state of the keycloak and portal db) generate the necessary mappers. -IdP mappers are used to import OIDC ID/Access token claims into user attributes and user role mappings. - -image -
- -Individual mappers are possible; but not suggested. diff --git a/developer/Technical Documentation/Identity & Access/01. Introduction.md b/developer/Technical Documentation/Identity & Access/01. Introduction.md deleted file mode 100644 index e7e75acef..000000000 --- a/developer/Technical Documentation/Identity & Access/01. Introduction.md +++ /dev/null @@ -1,27 +0,0 @@ -## Identity & Access Management - -### As-Is Authentication Management - -
- -Authentication Flow - User login to Catena-X - -
-

-image -

- -\*(Schatten-) User: The „Schatten-User“ is defined as an empty User frame holding limited information. The actual user is managed in the respective Identity Provider. -The Schatten-User are always federated identities - -
-
- -### Authentication Protocol - OpenID Connect (OIDC) - -
-image -
- -
-
diff --git a/developer/Technical Documentation/Identity & Access/02. Generic Setup.md b/developer/Technical Documentation/Identity & Access/02. Generic Setup.md deleted file mode 100644 index cb0086f21..000000000 --- a/developer/Technical Documentation/Identity & Access/02. Generic Setup.md +++ /dev/null @@ -1,148 +0,0 @@ -## Generic Setup - -### Identity Provider - -#### Requirement - -- [x] Identity Providers are configured on CX-Central Realm level only -- [x] Identity Providers are Azure Active Directory, WebEAM, SAP, Amazon,... -- [x] Default Protocol used is OIDC -- [x] Users getting authenticated by an identity provider should only be able to login to the CX Services if a user in Keycloak is available -- [ ] ... - -
-
- -#### What's a Keycloak identity provider - -An Identity Broker is an intermediary service connecting service providers with identity providers. The identity broker creates a relationship with an external identity provider to use the provider’s identities to access the internal services the service provider exposes. - -From a user perspective, identity brokers provide a user-centric, centralized way to manage identities for security domains and realms. You can link an account with one or more identities from identity providers or create an account based on the identity information from them. - -An identity provider derives from a specific protocol used to authenticate and send authentication and authorization information to users. It can be: - -- A social provider such as Facebook, Google, or Twitter. -- A business partner whose users need to access your services. -- A cloud-based identity service you want to integrate. - -Typically, Keycloak bases identity providers on the following protocols: - -- SAML v2.0 -- OpenID Connect v1.0 ![Tag](https://img.shields.io/static/v1?label=&message=CATENA-X-Standard&color=green&style=flat) -- OAuth v2.0 - -
-
- -#### Brokering overview - -When configuring Identity Providers in Keycloak, Keycloak does not force users to provide their credentials to authenticate in a specific realm. -Keycloak displays a list of identity providers from which they can authenticate. - -
- -If you configure a default identity provider, Keycloak redirects users to the default provider. For Catena-X, this is not necessary. - -
-
- -#### (Change) Identity Provider Display Name - -The Identity Provider display name can geht changed by the operator without any negative impact. -The change should still only get executed if necessarily needed. The change is resulting into a new IdP Button Name on the application login side. - -
-
- -#### Delete Identity Provider - -There are a few different scenarios where the deletion of a identity provider within keycloak might be needed. - -- Company wants to move back to Shared CX IdP (currently not supported) -- Company is off-boarding from Catena-X -- Company is changing the company IdP internally (UI supported; no intervention by the platform operator needed) -- Identity Provider link to Shared IdP is not needed anymore (UI supported; no intervention by the platform operator needed) - -
- -More details regarding the function flow of deleting idp's can get found here: [Get there](/docs/02.%20Technical%20Integration/02.%20Identity%20Provider%20Management/04.%20Delete%20Identity%20Provider.md) - -
-
- -### Realms - -> **Note** -> Realms dont get much detailed explained; since it is not planned that they are manually created; all realm related services are automated. - -#### Requirement - -- [x] Realm is created for each registration company -- [x] Realms are created inside the Shared IdP only; the Central IdP only holds the realms of the platform operator -- [x] A realm hold the user data of a company (kind of tenant management) -- [x] Roles and Groups are not managed on realm level -- [ ] ... - -
-
- -#### Realm Emails - -Keycloak can send emails to users for several different scenario - -- to verify the user email address -- to recreate a password in case it was forgotten -- or when an administrator needs to receive notifications about a server event -
- -To enable Keycloak to send emails, SMTP server settings need to get configured by following steps: - -- Login to the respective Keycloak instance and open the relevant realm -- Click Realm Settings in the menu. -- Click the Email tab. -- Fill in the fields and toggle the switches as needed. -
-
- -> **Note** -> The email realm config is automatically taking place when a realm is getting created; no manual adjustments needed. However the config of the email service attributes is needed via the env. var files. - -###### Host - -SMTP server hostname used for sending emails. -
- -###### Port - -SMTP server port. -
- -###### From - -Address used for the From SMTP-Header for the emails sent. -
- -###### From Display Name - -Allows to configure a user friendly email address aliases (optional). If not set the plain From email address will be displayed in email clients. -
- -###### Reply To - -Reply To denotes the address used for the Reply-To SMTP-Header for the mails sent (optional). If not set the plain From email address will be used. -
- -###### Reply To Display Name - -Reply To Display Name allows to configure a user friendly email address aliases (optional). If not set the plain Reply To email address will be displayed. -
- -###### Envelope From - -Envelope From denotes the Bounce Address used for the Return-Path SMTP-Header for the mails sent (optional).Enable SSL and Enable StartTSLToggle one of these switches to ON to support sending emails for recovering usernames and passwords, especially if the SMTP server is on an external network. You will most likely need to change the Port to 465, the default port for SSL/TLS. -
- -###### Enable Authentication - -Set this to ON if your SMTP server requires authentication. When prompted, supply the Username and Password. -
diff --git a/developer/Technical Documentation/Identity & Access/03. Clients.md b/developer/Technical Documentation/Identity & Access/03. Clients.md deleted file mode 100644 index ca0862c7c..000000000 --- a/developer/Technical Documentation/Identity & Access/03. Clients.md +++ /dev/null @@ -1,114 +0,0 @@ -## Clients - -### Overview Clients - -Clients are entities that can request Keycloak to authenticate a user. Most often, clients are applications and services that want to use Keycloak to secure themselves and provide a single sign-on solution. - -Clients can have 3 different client types - -- public (For client-side clients that perform browser logins. As it is not possible to ensure that secrets can be kept safe with client-side clients, it is important to restrict access by configuring correct redirect URIs) -- confidential (For server-side clients that perform browser logins and require client secrets when making an Access Token Request. This setting should be used for server-side applications) -- bearer-only (The application allows only bearer token requests. When turned on, this application cannot participate in browser logins) - -
-
- -### Client Creation - -clients are created with the portal & marketplace services: - -- App Services -- Service Services - -Manual creation of clients is not expected/needed - -
-
- -### Initial Client Load - -In the initial system deployment/data load provided by the catena-x migration script, the relevant core clients are included. - -
-
- -
-
- -### Client Authentication Concept - -** example DFT / SDE ** - -The DFT (Data Format Transformer) is planned to get offered as a data provider essential services, hosted/operated by 3rd party service providers. - -In the design of the authentication flow, it was analyzed which authentication flows are available and how do they differ. - -
- -Two main scenarios are possible and shown in the picture below - -- One Central DFT Client Registration for all costumer -- Multiple Central DFT Client Registration, each customer one registration - -
- -

-image -

- -
- -In the chapter/details both scenarios are detailed. - -##### Scenario 1 - Only one DFT Client - one for all customer - -In the example of one DFT registrations for all customer, following tasks are necessary. - -Whenever a new customer is approaching a service provider for a DFT instance, the service provider needs to request the enhancement of the allowed redirect URIs from the central portal instance. - -Additionally, no additional effort is needed on the portal side. - -
- -For the authentication the result would look the following: - -Below a picture is added with the user JWT token (used for authentication). Green highlighted the identical section and yellow highlighted the difference - -
- -

-image -

- -
- -Summary: in this scenario the difference of user of company 1 and user of company 2 is only the organisation and bpn tag. Everything else is identical and cant get used to ensure that users of company 1 are not able to access the dft instance of company 2. - -
- -Security: MEDIUM - -
-
- -##### Scenario 2 - Multiple DFT Clients - one for each customer - -Instead of Scenario 1 "one app registration for all tenants" - Scenario 2 is focusing on a tenant-specific authorization setup. With that, the operator of the app can distinguish the assigned roles on a tenant basis. In the following figure, you can see that there is a specific section of roles for each tenant. With this setup, a user can only access the tenant to which he actually has roles assigned. If the user gets a link to a tenant of a different customer he will get a not authorized error. There is no Catena-X specfic check based on the bpn necessary. - -
- -

-image -

- -
- -Summary: the user of company 1 will only retrieve jwt token roles/client attributes for the DFT Instance 1. The user of company 2 only receives a JWT token roles/client attributes for DFT instance 2. In case the user is trying to login to another DFT Instance, a JWT token will get created, but the section - -image - -..wont be existing - -
- -Security: HIGH diff --git a/developer/Technical Documentation/Identity & Access/03. User Management.md b/developer/Technical Documentation/Identity & Access/03. User Management.md deleted file mode 100644 index b6a5bc427..000000000 --- a/developer/Technical Documentation/Identity & Access/03. User Management.md +++ /dev/null @@ -1,101 +0,0 @@ -## User Management - -We differenciate between real users and technical users (aka service accounts). -Both scenarios are completly automated / FE supported. There is no necessarity to setup/configure users in keycloak directly. - -Evenmore it should get prohibited to create users via the keycloak admin console; reason: those users would be missing in the portal db since there is no snychronization back to the portal db. This would result into an internal service issue. -When using the available services for real and technical user creation; the issue wont appear since portal will create first of all the relevant user accounts in the portal db and afterwards create the same in keyloak. -With help of the portal db table iam_users; the user id in keycloak central idp (user_entity_id) and the user id inside the portal (company_user_id) are linked. -For service accounts the mapper is the service account clientId. - -
-
- -### Technical User - -For the type of technical (non-human) users, service accounts are to be used. -
-Service accounts differ from normal user accounts in multiple ways: -
- -- They don't have a password and can't be used for browser-based sign-in. -- They're created and managed as a user that belongs to a client. -- How to setup technical user authentication -- The service account should have it's own client. -
- Each OIDC client has a built-in service account which allows it to obtain an access token. This is covered in the OAuth 2.0 specifiation under Client Credentials Grant. To use this feature the Access Type of your client is set to confidential. - -
-
- -#### Role Management - -The technical user relevant roles are managed within a shadow client called "technical-user-management". - -All composite roles available for technical user creation inside the portal are configured in this area. - -Additionally, the role need to be available inside the portal db - user_roles. - -
-
- -### User Attributes - -All users can get specific user attributes added - currently the following attributes are supported / implemented - -- bpn-mapper -- username-mapper - -
-
- -#### bpn-mapper - -The Business Partner Number (BPN) is a verified company credential which is getting added as attribute to each user inside the network. - -The bpn provides an extended user authentication possibility. - -
- -How is the attribute added to the user - -- Option1: With the registration approval: with the registration, a user is invited without the company/bpn connection. The actual confirmation of user / BPN mapping will only take place with the registration approval => if the company registration is getting approved, a backend service is calling the function to add the company BPN to the respective user -- Option 2: Automatically added with the user invite/creation: the IT Administrator is adding one or multiple users to the CX network. By doing so, the user accounts get created => as part of this flow, the newly created user(s) should get a user attribute added which is the same as the Company BPN from the table "company" -- Option 3: Manual added, by permission (via the user management permission "add user"): by opening the user admin account inside the portal, the administrator can add another BPN to the user account. Currently without any limitations. However there is the plan to limit the functionality and to restrict the BPNs which can get selected / added by the admin - -#### username-mapper - -Is handling the username created for each user account inside the central idp. -{idpalias}+uuid - -
-
- -### View Users in a realm - -> **_NOTE:_** -> In general users should not get created via the idp admin console - it will result into a de-sync of the portal db and keycloak db. Also necessary security validations and connections will be missing. We strongly suggest to use the build api(s) only as well as the UI supported by the portal. - -To look up all users created in keycloak under a specific realm or inside the central realm, click on Users in the left menu bar. - -image - -To display the users; click on "View all users" or use the search box to find a specific user via full name, last name or email address. - -
-
- -### Create New User - -> **_NOTE:_** -> In general users and user connections should get viewed inside the portal db. - -To create an user click on Users in the left menu bar. -As soon as the page is reached, select the Add User on the top right of the user table. - -Required mandatory field is Username only. However in Catena-X we also set the first name, last name, email as well as some user attributes. -Details regarding the attributes can get found under the link [attribute details](./03.%20User%20Management.md) - -image - -Details regarding the attributes can get found under the link [attribute details](./03.%20User%20Management.md) diff --git a/developer/Technical Documentation/Identity & Access/04. Authentication Configuration.md b/developer/Technical Documentation/Identity & Access/04. Authentication Configuration.md deleted file mode 100644 index a3bdb1967..000000000 --- a/developer/Technical Documentation/Identity & Access/04. Authentication Configuration.md +++ /dev/null @@ -1,3 +0,0 @@ -## Authentication Configuration - ----- will get added ---- diff --git a/developer/Technical Documentation/Identity & Access/05. Roles & Rights Concept.md b/developer/Technical Documentation/Identity & Access/05. Roles & Rights Concept.md deleted file mode 100644 index 53fbb2ec6..000000000 --- a/developer/Technical Documentation/Identity & Access/05. Roles & Rights Concept.md +++ /dev/null @@ -1,271 +0,0 @@ -## 1. General details - -### 1.1 Scope and binding force of the document - -The Roles & Rights concept is part of the System Implementation for Catena-X. It specifies the roles, authorizations and controls which must be implemented in Catena-X. -
-The Roles & Rights Concept aims at providing a high-level description with respect to the planning and implementation of roles and rights in the context of Catena-X. The Roles & Rights concept is supposed to define required functions, structures and basic principles. Therefore only an illustrative description of specific roles and associated rights is provided. This concept document is high level description of the implemented roles and rights. However, the included roles and rights give a sufficient representation of the relevant functions, structures and principles. -
- -### 1.2 Affected application - -Registration // Portal // Managed Wallet // DFT // BPDM - -
-
- -### 1.3 Referenced documents - -n/a - -
-
- -## 2. Authorization structure and role model - -This chapter explains the business, organizational, and technical principles of the role and authorization definition, thereby illustrating the relationship between business function and authorization structure. The objective is to make the actual authorizations and authorization assignments granted in the new Catena-X solution verifiable against the business, technical, and organizational specifications, specified in this document. -
-
- -### 2.1 Underlying business processes and roles: - -n/a - -
-
- -### 2.2 Basic principles - -n/a - -
-
- -### 2.3 Individual privileges and authorization framework - -n/a - -
-
- -### 2.4 Role definition - -In the concept of the roles and rights management we are differentiating between roles and permissions. - -Permissions are the lowest level which a user can have. Several permissions are collected to a role. - -The assignment of rights to an actual user is happening on the role level itself. -
-
- -It is suggested to setup naming convention for roles and permissions to ensure that they can get clearly defined. - -On the CX Portal side the conventions are setup the following \*please note that this is not mandatorily needed to be followed by 3rd Party Providers - - Naming Convention: - - - Permissions - - always lowercase - - no spaces, only use underscore - - task/role needs to be clearly understandable - - don't use any "Umlaute" (special character) such as: ä, ü, ö - - a permission can get assigned to several roles, but one is the minimum role to which it need to be assigned - - - Roles: - - - capital letters to be used for 1st character - - spaces are allowed - - role should be identifiable - - don't use any "Umlaute" (special character) such as: ä, ü, ö - - a role needs as a minimum 1 permission assigned to it - -
-
- -### 2.5 Role/Permission Matrix - -This role concept covers all roles related to - -- Registration/Onboarding Process Roles -- Portal Roles - -
-
- -image - -
-
- -#### 2.5.1 Technical User (portal internal) - -image - -
-
- -#### 2.5.2 Registration Application - -image - -
-
- -#### 2.5.3 Portal Application - -image - -
-
- -#### 2.5.3b Technical User Accounts - -image - -
-
- -#### 2.5.4 Managed Wallets - -image - -
-
-*depending on the need, technical user will have a subset of the selected roles in the role table "Managed Wallets". - -For example: - -- SD Hub: view and update wallets -- Portal: view and add wallets -- EDC Extension: view and update wallet (technical user needs BPN as user attribute) - -
-
- -#### 2.5.5 BPDM - -For the BPDM Pools READ rights are given to all CX members. - -WRITE into the POOL "add_company_data" is only allowed for the platform owner/ operator and (if integrated) possible service providers of BPDM cleanup services. - -image -
-* Technical User is the corresponding bpdm data provider (operator or/and service provider; no platform customer) - -
-
- -#### 2.5.6 BPDM Gate - -image - -
-
- -#### 2.5.7 BPDMShare - -no roles -
-Note regarding the role setup in context of CPLP-121 - Registration App: Invite additional Registration Participants (FE/BE) CLOSED : - -- the inviting party needs to have the role "manage users" to be able to create users -- the invited party needs to have the role "view users" to be able to see the own roles in the upper right corner of the registration portal - Note regarding the role setup in context of CPLP-225 - Registration Service - Add Users: Roles to be fetched from Keycloak CLOSED : - -The user needs to have the role "view clients" to be able to see the available composite roles in the dropdown. Also, the user needs to have the role "view users" to be able to see the own composite roles in the upper right corner of the registration portal. - -Long term solution: a concept needs to be defined and implemented for technical identities (backend services which gather the composite roles should be executed with technical users, not require the user to have elevated rights). - -
-
- -### 2.6 Segregation of duties - -Segregation of duties is the concept of having more than one person or role required to complete a task. Currently there is no such scenario inside the portal existing. - -
-
- -## 3. Global subjects - -This chapter explains how the Catena-X Platform is embedded into the Business Partner application landscape and what infrastructure components are connected to it in terms of authorization management. Furthermore, technical restrictions, naming conventions, audit logging and the authentication mechanisms are outlined in more detail. - -
-
- -### 3.1 Authorization management connections - -Authorization management is handled in CX central IdP. - -
-
- -### 3.2 Used infrastructure components - -- - -
-
- -### 3.3 Privileged and technical user accounts - -Technical users are used for backend to backend connections. Inside CX but also outbound between member companies and CX components. - -E.g. Central registry connection by a third party app. - -
-
- -### 3.4 Technical restrictions - -For a detailed description of how the internal security system works please refer to Security Concept. In terms of the Catena-X Platform, this approach brings the following technical restrictions: - -A new login is required for user rights changes to take effect -The fact that the rights for a particular user are only read at user login and then cached for the session implicates, that changes to rights can only take effect after a new user login. - -
-
- -### 3.5 Logging the use - -Logging actions that can lead to granting or revocation of authorizations must observe the legal privacy specifications. Access to the logs is restricted. This is allowed only if there is legitimate interest and if it is according to the legal regulations for privacy. - -For the Catena-X Platform, there are three types of logging the use: - -System internal audit history - -System external monitoring system - -System technical server logs - -Internal audit history, an on screen audit record is available for key screens. This functionality is restricted to particular roles (see section 2.5). The following information can be viewed tabular within the System: - -.. - -
-
- -All internal audit and access logs are saved ???. The retention period for audit history is 7 years. After this period the audit history can be deleted, however this is not mandatory in legal terms. - -Finally, each infrastructure component and all surrounding systems have their own logging solutions in use. This includes the logging of grants and revoked of user access rights in the central BMW access management system. However, details on these technical logging solutions are out of scope for the Roles & Rights concept. - -
-
- -## 4. Authorization procedure - -User permission / access withdrawal are possible via - -- Company IT Admin is able to withdraw user rights/permissions -- Company IT Admin can delete company users under the same org -- Company User can delete his/her own user account -- App provider can withdraw app usage for a company, but not for a single user - -
-
- -## 5. Appendix - -
-
diff --git a/developer/Technical Documentation/Identity & Access/06. Password Policy.md b/developer/Technical Documentation/Identity & Access/06. Password Policy.md deleted file mode 100644 index ff0ec1e8c..000000000 --- a/developer/Technical Documentation/Identity & Access/06. Password Policy.md +++ /dev/null @@ -1,147 +0,0 @@ -# Password Policy - -## Password Policy - -Password Policies are restrictions and/or requirements that a user must follow to ensure that their password is strong/secure. -In Keycloak, password policies are set per realm. -
-
- -Requirement - -- [ ] Default Password Policies are needed for every realm - the policies are set by Catena-X and identical for all realms -- [ ] Password refresh every 90 days -- [ ] Password length 15+ digits -- [ ] Password characters: letters + minimum 1 number is mandatory -- [ ] Password shouldn't be the same as the username or email -- [ ] If the Password is getting reset by the user and is not fitting the password policies, a error message with a detailed error code will get shown - -
-
- -#### How to configure Password Policies - -Open Keycloak admin page, go to "Authentication" and open the "Password Policy" tab. -Click on the Add policy … to see the list of available password policies. - -image -
- -Select the relevant policy and set the policy value by adding the relevant number. Important: only numbers are to be added, no letters. -After saving the policy, Keycloak login enforces the policy for new users. Existing users can still login with theire old password, but as soon as a password change request is getting triggered the new policies will take affect. - -Blacklisting passwords is possible via UTF-8 file, for Catena-X no blacklisting is planned so far. - -
-
- -#### Implementation - -Password Policies are auto set (as per the definition mentioned above) for each company tenant. -With the new creation of an company tenant; the password policies are automatically configured for the respective realm inside the sharedIdP. -
-
- -##Password Reset - -If Password reset is enabled, users are able to reset their credentials if they forget their password or lose their OTP generator. - -Requirement - -- [ ] Forgot Password option should be available for all users using Shared IdP -- [ ] New Password needs to get validated against the configured Password Policies -- [ ] Config needs to get automatically set whenever a new realm is getting created -
-
- -#### How to configure Password Recovery - -Go to the Realm Settings left menu item, and click on the Login tab. Switch on the Forgot Password switch. - -image -
- -The new password will get send via email. - -The email text is fully configurable. How: extend or edit the theme associated with it. - -When the user clicks on the email link, they will be asked to update their password, and, if they have an OTP generator set up, they will also be asked to reconfigure this as well. Depending on the security requirements of your organization you may not want users to be able to reset their OTP generator through email. You can change this behavior by going to the Authentication left menu item, clicking on the Flows tab, and selecting the Reset Credentials flow. - -
-
- -#### Implementation - -tbd - -
-
- -## 2-Factor-Auth - -Levels of Authentication - -- Level 0: Authentication by username and password only. No 2-factor-auth. -- Level 1: Authentication by username and password; plus additionally 2-factor-auth via Keycloak OTP -- Level 2: Authentication by username and password; plus additionally 2-factor-auth via configured webauth method - -image - -
-
- -#### Setup for Catena-X - -Keycloak 2-Factor-Auth is suggested for all users/identities which are managed by Catena-X and not federated by any company identity management system. - -
-
- -##### Config for the Master Realm - -The Master realm, holding the admin accounts, is configured to - -- Each User needs to mandatorily configure OTP -- Each User needs to mandatorily update the password after the first login -- Password policies as per chapter PasswordPolicies need to get followed - -
-
- -##### Config for the Catena-X Realm - -tbd -
-
- -##### Config for the Company Spec. Realm - -The Shared Company realm, holding the user accounts for the company, is configured as following - -- Each User needs to mandatorily configure OTP -- Each User needs to mandatorily update the password after the first login -- Password policies as per chapter PasswordPolicies need to get followed - -
-
- -#### How to Setup - Yubikey as 2-Fact-Auth - -The IdP, where the user is stored/created (for SharedIdP Companies its the SharedIdP; for CX Operators its the CentralIdP as well as the SharedIdP) an authentication flow need to get configured. -
-
- -##### #1 Create New Auth Flow as shown below - -image -
- -##### #2 Set the Auth Flow as browser flow - -image -
- -##### #3 Update the Required Actions - -image -
diff --git a/developer/Technical Documentation/Identity & Access/07. Email Configuration.md b/developer/Technical Documentation/Identity & Access/07. Email Configuration.md deleted file mode 100644 index 9da26d77b..000000000 --- a/developer/Technical Documentation/Identity & Access/07. Email Configuration.md +++ /dev/null @@ -1,85 +0,0 @@ -# IdP Email Configuration - -## Requirement - -tbd - setup will be needed - -
-
- -## How to configuring email for a realm - -Keycloak can send emails to users for several different scenario - -- to verify the user email address -- to recreate a password in case it was forgotten -- or when an administrator needs to receive notifications about a server event -
- -To enable Keycloak to send emails, SMTP server settings need to get configured by following steps: - -- Login to the respective Keycloak instance and open the relevant realm -- Click Realm Settings in the menu. -- Click the Email tab. -- Fill in the fields and toggle the switches as needed. -
-
- -###### Host - -SMTP server hostname used for sending emails. -
- -###### Port - -SMTP server port. -
- -###### From - -Address used for the From SMTP-Header for the emails sent. -
- -###### From Display Name - -Allows to configure a user friendly email address aliases (optional). If not set the plain From email address will be displayed in email clients. -
- -###### Reply To - -Reply To denotes the address used for the Reply-To SMTP-Header for the mails sent (optional). If not set the plain From email address will be used. -
-
- -###### Reply To Display Name - -Reply To Display Name allows to configure a user friendly email address aliases (optional). If not set the plain Reply To email address will be displayed. -
-
- -###### Envelope From - -Envelope From denotes the Bounce Address used for the Return-Path SMTP-Header for the mails sent (optional).Enable SSL and Enable StartTSLToggle one of these switches to ON to support sending emails for recovering usernames and passwords, especially if the SMTP server is on an external network. You will most likely need to change the Port to 465, the default port for SSL/TLS. -
-
- -###### Enable Authentication - -Set this to ON if your SMTP server requires authentication. When prompted, supply the Username and Password. -
-
- -#### Catena-X Implementation - -smtp-host: smtp.office365.com -smtp-port: 587 -Enable StartTLS -Enable Authentication -visible in https://catenaxdev003akssrv.germanywestcentral.cloudapp.azure.com/iamcentralidp/auth/admin/master/console/#/realms/CX-Central/smtp-settings -
-
-it's mandatory the 'from' email-address and the smtp-username used to authenticate with the office365 mailing-service are identical. Therefor Notifications@catena-x.net is configured as email address. -This can get changed (if necessary) if a new login/account with the respective email is created. - -
-
diff --git a/developer/Technical Documentation/Identity & Access/08. Event Logging.md b/developer/Technical Documentation/Identity & Access/08. Event Logging.md deleted file mode 100644 index 29a0bca93..000000000 --- a/developer/Technical Documentation/Identity & Access/08. Event Logging.md +++ /dev/null @@ -1,178 +0,0 @@ -# Event Logging - -## Requirement - -- [ ] Keycloak needs to log for each realm the login calls, logout, unsuccessful logins, changes of keycloak configs -- [ ] Date and time should get logged as well as the user which did the change -- [ ] Logs should not show any passwords in clear text -- [ ] Usernames should not show up in clear text, but need to be traceable -- [ ] When a new realm gets created, the log configuration needs to get configured automatically as per the requirement -- [ ] Log retention period 90days -
-
- -## Keycloak events - -Keycloak has two kinds of events: - -- login events and -- admin events -
- -Login events are emitted every time a user-related action around authentication is executed, e.g. login, logout, code-to-token exchanges, registrations, etc. Also errors of these actions are emitted as an event. The event itself then contains some useful information about the action and the corresponding user and/or client. Admin events are emitted on every change of a resource via the Admin-API, no matter if via the web console, REST api, CLI, etc. -
- -It is possible to enable the Keycloak db to store the events. However this is not recommended, since the login events DB table is hardly indexed, the admin events table besides the PK not at all and querying lots of entries will likely slow down the system. Also an important information regarding that: login event retention time can get configured; admin events retention time can't. -
- -Keycloak has a default events listener (called jboss-logging) in each realm configured. When there is e.g. an error during a login attempt, this error event will be logged with log level WARN. -
- -Successful events will be logged with level DEBUG and the root log level of the whole Keycloak server is set to INFO. With this setting, the SUCCESS-events won’t occur in the logs, only the ERROR-events will. -
-
- -## Configure Logging - -##### Keycloak Admin UI/DB - -Login events occur for things like when a user logs in successfully, when somebody enters in a bad password, or when a user account is updated. Every single event that happens to a user can be recorded and viewed. By default, no events are stored or viewed in the Admin Console. Only error events are logged to the console and the server’s log file. To start persisting you’ll need to enable storage. Go to the Events left menu item and select the Config tab. -
- -###### Event Configuration - -image -
- -To start storing events you’ll need to turn the Save Events switch to on under the Login Events Settings. -
-
- -###### Save Events - -image -
- -The Saved Types field allows you to specify which event types you want to store in the event store. The Clear events button allows you to delete all the events in the database. The Expiration field allows you to specify how long you want to keep events stored. Once you’ve enabled storage of login events and decided on your settings, don’t forget to click the Save button on the bottom of this page. -
- -To view events, go to the Login Events tab. -
-
- -###### Login Events - -image -
- -As you can see, there’s a lot of information stored and, if you are storing every event, there are a lot of events stored for each login action. The Filter button on this page allows you to filter which events you are actually interested in. -
-
- -###### Login Event Filter - -image -
- -In this screenshot, we’re filtering only Login events. Clicking the Update button runs the filter. - -###### Event Types - -Login events: - -- Login - A user has logged in. -- Register - A user has registered. -- Logout - A user has logged out. -- Code to Token - An application/client has exchanged a code for a token. -- Refresh Token - An application/client has refreshed a token. -
-
- -Account events: - -- Social Link - An account has been linked to a social provider. -- Remove Social Link - A social provider has been removed from an account. -- Update Email - The email address for an account has changed. -- Update Profile - The profile for an account has changed. -- Send Password Reset - A password reset email has been sent. -- Update Password - The password for an account has changed. -- Update TOTP - The TOTP settings for an account have changed. -- Remove TOTP - TOTP has been removed from an account. -- Send Verify Email - An email verification email has been sent. -- Verify Email - The email address for an account has been verified. - -For all events there is a corresponding error event. - -
-
- -##### Log Files - -Per default keycloak logs are configured to only log on INFO level, to get a detailed logging, the log level need to get updated. - -2 options are available to adjust the logging level in the logs: - - Option1: Change the log level of the org.keycloak.events category logger - With this approach, you add an entry in the logging subsystem of the underlying Wildfly configuration. The new entry tells the logging subsystem to print all log messages from the package org.keycloak.events with DEBUG level and above to the log output: - - /subsystem=logging/logger=org.keycloak.events/:add(category=org.keycloak.events,level=DEBUG) - - - Option2: Configure the jboss-logging listener to log on other levels - As per default, there is no eventsListener SPI config in the Keycloak server configuration. The default behaviour for the jboss-logging events listener is the one which is implemented in the code. To be able to change the configuration of the jboss-logging listener, you’ll have to create the proper SPI node in the keycloak-server subsystem first, then add the desired log levels. - - /subsystem=keycloak-server/spi=eventsListener:add - /subsystem=keycloak-server/spi=eventsListener/provider=jboss-logging:add(enabled=true) - /subsystem=keycloak-server/spi=eventsListener/provider=jboss-logging:write-attribute(name=properties.success-level,value=info) - /subsystem=keycloak-server/spi=eventsListener/provider=jboss-logging:write-attribute(name=properties.error-level,value=warn) - Now the SUCCESS-events will occur in the log output with level INFO, as soon as they are emitted by Keycloak. - -
-
- -## Event Listener - -Event listeners listen for events and perform an action based on that event. There are two built-in listeners that come with Keycloak: Logging Event Listener and Email Event Listener. -The Logging Event Listener writes to a log file whenever an error event occurs and is enabled by default. Here’s an example log message: -
- -11:36:09,965 WARN [org.keycloak.events] (default task-51) type=LOGIN_ERROR, realmId=master, -clientId=myapp, -userId=19aeb848-96fc-44f6-b0a3-59a17570d374, ipAddress=127.0.0.1, -error=invalid_user_credentials, auth_method=openid-connect, auth_type=code, -redirect_uri=http://localhost:8180/myapp, -code_id=b669da14-cdbb-41d0-b055-0810a0334607, username=admin -
- -This logging is very useful if you want to use a tool like Fail2Ban to detect if there is a hacker bot somewhere that is trying to guess user passwords. You can parse the log file for LOGIN_ERROR and pull out the IP Address. Then feed this information into Fail2Ban so that it can help prevent attacks. -
- -The Email Event Listener sends an email to the user’s account when an event occurs. The Email Event Listener only supports the following events at the moment: - -- Login Error -- Update Password -- Update TOTP -- Remove TOTP - -
-
- -To enable the Email Listener go to the Config tab and click on the Event Listeners field. This will show a drop down list box where you can select email. -You can exclude one or more events by editing the standalone.xml, standalone-ha.xml, or domain.xml that comes with your distribution and adding for example: - - - - - - - - - - - - - - - -
-
diff --git a/developer/Technical Documentation/Identity & Access/09. Generic Security.md b/developer/Technical Documentation/Identity & Access/09. Generic Security.md deleted file mode 100644 index c86f07482..000000000 --- a/developer/Technical Documentation/Identity & Access/09. Generic Security.md +++ /dev/null @@ -1,147 +0,0 @@ -## Security Generic - -### Host - -Keycloak uses the public hostname in several ways, such as within token issuer fields and URLs in password reset emails. - -By default, the hostname derives from the request header. No validation exists to ensure a hostname is valid. Therefor its suggested to use a load balancer, or proxy, with Keycloak to prevent invalid host headers. - -The hostname’s Service Provider Interface (SPI) provides a way to configure the hostname for requests. You can use this built-in provider to set a fixed URL for frontend requests while allowing backend requests based on the request URI. If the built-in provider does not have the required capability, you can develop a customized provider. - -
-
- -### Bruce Force Detection - -A brute force attack happens when an attacker is trying to guess a user’s password multiple times. Keycloak has some limited brute force detection capabilities. If turned on, a user account will be temporarily disabled if a threshold of login failures is reached. To enable this feature go to the Realm Settings left menu item, click on the Security Defenses tab, then additional go to the Brute Force Detection sub-tab. - -When an attack is detected, permanent or temporary lockout can get configured. - -Permanent lockout disables a user account until an administrator re-enables it. Temporary lockout disables a user account for a specific period of time. The time period that the account is disabled increases as the attack continues. - -When a user is temporarily locked and attempts to log in, {project_name} displays the default Invalid username or password error message. This message is the same error message as the message displayed for an invalid username or invalid password to ensure the attacker is unaware the account is disabled. - -Details: https://www.keycloak.org/docs/latest/server_admin/index.html#password-guess-brute-force-attacks - -
- -Config: - -1. Click Realm Settings in the menu -2. Click the Security Defenses tab. -3. Click the Brute Force Detection tab. - -Brute force detection - -image - -
-
- -Common Parameters - -image - -
-
- -#### Catena-X configuration - -##### Preventing automated attacks - -- Lock after 10 subsequent login failures -- 1 second between failures (too quick for a human) -- Lock remains active for ~5 min - -##### Preventing manual attacks - -- Lock after 10 subsequent login failures -- Sliding window of 12 hours -- Lock remains active for ~ 45 min - -
-
- -### Clickjacking - -Clickjacking is a technique of tricking users into clicking on a user interface element different from what users perceive. A malicious site loads the target site in a transparent iFrame, overlaid on top of a set of dummy buttons placed directly under important buttons on the target site. When a user clicks a visible button, they are clicking a button on the hidden page. An attacker can steal a user’s authentication credentials and access their resources by using this method. - -By default, every response by {project_name} sets some specific browser headers that can prevent this from happening. Specifically, it sets X-FRAME_OPTIONS and Content-Security-Policy. You should take a look at the definition of both of these headers as there is a lot of fine-grain browser access you can control. -Procedure - -In the Admin Console, you can specify the values of the X-FRAME_OPTIONS and Content-Security-Policy headers. - -1. Click the Realm Settings menu item. -2. Click the Security Defenses tab. - Security Defenses - -By default, Keycloak sets up a same-origin policy for iframes. - -
-
- -### Open redirections - -An open redirector is an endpoint using a parameter to automatically redirect a user agent to the location specified by the parameter value without validation. An attacker can use the end-user authorization endpoint and the redirect URI parameter to use the authorization server as an open redirector, using a user’s trust in an authorization server to launch a phishing attack. - -Keycloak requires that all registered applications and clients register at least one redirection URI pattern. When a client requests that Keycloak performs a redirect, Keycloak checks the redirect URI against the list of valid registered URI patterns. Clients and applications must register as specific a URI pattern as possible to mitigate open redirector attacks. - -
-
- -### Compromised Authorization code - -For the OIDC Auth Code Flow, Keycloak generates a cryptographically strong random value for its authorization codes. An authorization code is used only once to obtain an access token. - -On the timeouts page in the Admin Console, you can specify the length of time an authorization code is valid. Its possible to configure the length of time for a client to request a token from the code. - -You can also defend against leaked authorization codes by applying Proof Key for Code Exchange (PKCE) to clients. - --- not yet considered in CX -- - -
-
- -### Compromised access and refresh tokens - -Keycloak includes several actions to prevent malicious actors from stealing access tokens and refresh tokens. The crucial action is to enforce SSL/HTTPS communication between {project_name} and its clients and applications. {project_name} does not enable SSL by default. - -Another action to mitigate damage from leaked access tokens is to shorten the token’s lifespans. You can specify token lifespans within the Realm Setting → Token. Short lifespans for access tokens force clients and applications to refresh their access tokens after a short time. If an admin detects a leak, the admin can log out all user sessions to invalidate these refresh tokens or set up a revocation policy. - -In the current project phase, we will proceed with the default values for the token lifespans - -image - -
-
- -### CSRF attack - -A Cross-site request forgery (CSRF) attack uses HTTP requests from users that websites have already authenticated. Any site using cookie-based authentication is vulnerable to CSRF attacks. You can mitigate these attacks by matching a state cookie against a posted form or query parameter. - -The OAuth 2.0 login specification requires that a state cookie matches against a transmitted state parameter. {project_name} fully implements this part of the specification, so all logins are protected. - -The {project_name} Admin Console is a JavaScript/HTML5 application that makes REST calls to the backend {project_name} admin REST API. These calls all require bearer token authentication and consist of JavaScript Ajax calls, so CSRF is impossible. You can configure the admin REST API to validate the CORS origins. - -The user account management section in {project_name} can be vulnerable to CSRF. To prevent CSRF attacks, {project_name} sets a state cookie and embeds the value of this cookie in hidden form fields or query parameters within action links. {project_name} checks the query/form parameter against the state cookie to verify that the user makes the call. - -
-
- -### Limiting Scope - Client Token - -By default, new client applications have unlimited role scope mappings. Every access token for that client contains all permissions that the user has. If an attacker compromises the client and obtains the client’s access tokens, each system that the user can access is compromised. - -Limit the roles of an access token by using the Scope menu for each client. Alternatively, you can set role scope mappings at the Client Scope level and assign Client Scopes to your client by using the Client Scope menu. - -For any clients in CX, the scope is limited to the client scope. - -
-
- -### Client Policies - -tbd - -
-
diff --git a/developer/Technical Documentation/Identity & Access/10. FAQ.md b/developer/Technical Documentation/Identity & Access/10. FAQ.md deleted file mode 100644 index 85ee01ed4..000000000 --- a/developer/Technical Documentation/Identity & Access/10. FAQ.md +++ /dev/null @@ -1,197 +0,0 @@ -## FAQ - -### How to crete new roles - -Before creating new roles, check once for which level/purpose the role is needed - -1. Company Role -2. Portal Role -3. App Role -4. Technical User Role - -
- -##### Company Role(s) - -To add a new company role, a couple of steps need to get followed. -Different to Portal/App/Technical User Roles, it is not needed to do any update inside the IdP. - -DB Table Changes: - -- add new company role inside the table company_roles -- if the new company role should be selectable for company registrations, set the role inside table company_role_registration_data to "true"; otherwise "false" -- add description of the new company role inside table company_role_descriptions -- create a new user role collection inside user_role_collections to define selectable user roles for the company role -- add description of the new collection inside table user_role_collection_descriptions -- map user roles to the new created collection via table user_role_assigned_collections -- connect the new company role with the new role collection via "company_role_assigned_role_collections" -- new or existing agreements to be linked to the new company role via table "agreement_assigned_company_roles" - -Additionally needed: - -- create migration -- update "version_upgrade" details [open the file](/Technical%20Documentation/Version%20Upgrade/portal-upgrade-details.md) -- update Roles&Rights Matrix - -
-
- -##### Portal Role(s) - -Portal roles can get added easily if following steps are considered/followed. - -1. Create the roles inside keycloak - central idp; realm: CX-Central inside the respective client - -- open the client via the left side menu Clients -- select the respective client (Cl2-CX-Portal or Cl1-CX-Registration) -- Open the tab Roles -- And click "Add" on the right hand side -- Enter the respective role name (keep in mind the role naming conversation) -- Click "Save" - -
- -To transform the created "role" to an actual role, since currently its a single permission only; click on Composite Roles "ON". - - image - - Afterwards select the respective permissions which should get collected under the new created role/composite role by selecting the client in which the relevant permissions are located. - Note: permissions of multiple clients can get assigned to one composite role without any troubles/issues. - - image - -
- -2. Create the same role inside the portal db (either via a delta migration job) or via sql. - - For the scenario of sql, the relevant sql can get found below: - -
- - 1st create the role - - INSERT INTO portal.user_roles - (id, user_role, offer_id, last_editor_id) - VALUES ('{uuid}', '{user role name}', '{offer.id of portal or registration}', '{operator user uuid}'); - -2nd add role description in german and english - - INSERT INTO portal.user_role_descriptions - (user_role_id, language_short_name, description) - VALUES - ('(user_roles.id)', '{de}', '{description}'), - ('(user_roles.id)', '{en}', '{description}'); - -3rd connect role with company role collection - - INSERT INTO portal.user_role_assigned_collections - (user_role_id, user_role_collection_id) - VALUES ('{user_roles.id}', '{user_role_collections.id}'); - -
-
- -##### App Role(s) - -App roles are managed by app provider by the portal user interface. It should be strictly forbidden to add / change any app roles in any other way. Reason: app roles are (beside that they are in the ownership of the app provider) impacting not only a Keycloak client and portal db; additionally apps have app clients registered in Keycloak and each client need to get enhanced with the new roles where human errors are very likely possible. - -
-
- -##### Technical User Role(s) - -Technical user roles are similar like portal user roles created/managed and enhanced by the platform owner. - -1. Create the roles inside Keycloak - central idp; realm: CX-Central inside the client "technical_role_management" - -- open the client via the left side menu Clients -- Open the tab Roles -- And click "Add" on the right hand side -- Enter the respective role name (keep in mind the role naming conversation) -- Click "Save" - -
- -To transform the created "role" to an actual role, since currently its a single permission only; click on Composite Roles "ON". - - image - - Afterwards select the respective permissions which should get collected under the new created role/composite role by selecting the client in which the relevant permissions are located. - Note: permissions of multiple clients can get assigned to one composite role without any troubles/issues. - - image - -
- -2. Create the same role inside the portal db (either via a delta migration job) or via sql. - -For the scenario of sql, the relevant sql can get found below: - -
- - 1st create the role - - INSERT INTO portal.user_roles - (id, user_role, offer_id, last_editor_id) - VALUES ('{uuid}', '{user role name}', '{offer.id of technical_user_management}', '{operator user uuid}'); - -2nd add role description in german and english - - INSERT INTO portal.user_role_descriptions - (user_role_id, language_short_name, description) - VALUES - ('(user_roles.id)', '{de}', '{description}'), - ('(user_roles.id)', '{en}', '{description}'); - -
-
- -### What is the difference between roles & permission - -In the concept of the roles and rights management we are differentiating between roles and permissions. - -Permissions are the lowest level which a user can have. Several permissions are collected to a role. - -The assignment of rights to an actual user is happening on the role level itself. - -
-
- -### How to setup technical user authentication - -Technical user/service accounts should get created as standalone client to clearly differentiate applications from technical users. -Each OIDC client has a built-in service account which allows it to obtain an access token. -This is covered in the OAuth 2.0 specification under Client Credentials Grant. To use this feature you must set the Access Type of your client to confidential. Make sure that you have configured your client credentials. - -In tab Service Account Roles you can configure the roles available to the service account retrieved on behalf of this client. - -https://github.com/keycloak/keycloak-documentation/blob/main/server_admin/topics/clients/oidc/service-accounts.adoc - -- Create the respective OIDC client, with respective setting - - - Access Type: confidential - - Standard Flow: disabled - - Direct Access Grant: disabled - - Service Accounts: enabled - - Add Mapper "BPN" to the user - - image - - - Add a bpn into the user account 8when using the existing api endpoints; the bon is added automatically based on the company bpn of the acting user) - -After saving the config, the client gets automatically a service user account created which is used as "technical user" - -
-
- -### Retrieve token for service account - - curl --location --request POST '{Keyloak URL}/auth/realms/{realm}/protocol/openid-connect/token' \ - --header 'Content-Type: application/x-www-form-urlencoded' \ - --data-urlencode 'client_secret={secret} \ - --data-urlencode 'grant_type=client_credentials' \ - --data-urlencode 'scope=openid' \ - --data-urlencode 'client_id={clientId}' - -
-
diff --git a/developer/Technical Documentation/Identity & Access/11. Upgrade Details.md b/developer/Technical Documentation/Identity & Access/11. Upgrade Details.md deleted file mode 100644 index 7132bccc7..000000000 --- a/developer/Technical Documentation/Identity & Access/11. Upgrade Details.md +++ /dev/null @@ -1,72 +0,0 @@ -## Upgrade Details - -#### Role Concept changes - UPDATE - 1.7.0 - -In the next Version the Roles 'App Tech User' & 'Connector User' in the client 'technical_user_management' will be removed. To assure that all Users which currently have one or both roles assigned have the correct roles in the future, the following script must be executed on the central idp database: - -```sql -WITH connector_users AS ( - SELECT user_id - FROM public.user_role_mapping AS urm - JOIN public.keycloak_role AS kr - ON urm.role_id = kr.id - WHERE kr.name = 'Connector User' -), -new_connector_roles_to_insert AS ( - SELECT DISTINCT atu.user_id, kr.id AS role_id - FROM connector_users AS atu - CROSS JOIN ( - SELECT id - FROM public.keycloak_role - WHERE name IN ('Semantic Model Management', 'Dataspace Discovery') - ) kr -) -INSERT INTO public.user_role_mapping (user_id, role_id) -SELECT rt.user_id, rt.role_id -FROM new_connector_roles_to_insert rt - LEFT JOIN public.user_role_mapping urm - ON rt.user_id = urm.user_id AND rt.role_id = urm.role_id -WHERE urm.user_id IS NULL; - -WITH app_tech_users AS ( - SELECT user_id - FROM public.user_role_mapping AS urm - JOIN public.keycloak_role AS kr - ON urm.role_id = kr.id - WHERE kr.name = 'App Tech User' -), -roles_to_insert AS ( - SELECT DISTINCT atu.user_id, kr.id AS role_id - FROM app_tech_users AS atu - CROSS JOIN ( - SELECT id - FROM public.keycloak_role - WHERE name IN ('Semantic Model Management', 'Dataspace Discovery', 'CX Membership Info') - ) kr -) -INSERT INTO public.user_role_mapping (user_id, role_id) -SELECT rt.user_id, rt.role_id -FROM roles_to_insert rt - LEFT JOIN public.user_role_mapping urm - ON rt.user_id = urm.user_id AND rt.role_id = urm.role_id -WHERE urm.user_id IS NULL; - -UPDATE public.keycloak_role -SET name = 'Offer Management' -WHERE name = 'Service Management' - -DELETE FROM public.user_role_mapping -WHERE role_id in ( - SELECT id FROM public.keycloak_role AS kr - WHERE kr.name = 'Connector User' -) - -DELETE FROM public.user_role_mapping -WHERE role_id in ( - SELECT id FROM public.keycloak_role AS kr - WHERE kr.name = 'App Tech User' -) - -``` - -! Important ! the new roles: 'Semantic Model Management', 'Dataspace Discovery', 'CX Membership Info' must be existing in the central idp database diff --git a/developer/Technical Documentation/Interface Contracts/BPDM (2).md b/developer/Technical Documentation/Interface Contracts/BPDM (2).md index f95afd62f..1a64df000 100644 --- a/developer/Technical Documentation/Interface Contracts/BPDM (2).md +++ b/developer/Technical Documentation/Interface Contracts/BPDM (2).md @@ -46,7 +46,7 @@ to be added #### Get Membership Flag -The endpoint provides all business partner numbers of those comapny records; where the company status is "ACTIVE" (means: company is part of the catena-x network). +The endpoint provides all business partner numbers of those company records; where the company status is "ACTIVE" (means: company is part of the catena-x network). Those bpns are mapped with the GET Business Partner Data response (see above) and a membership flag is added for matching companies inside the partner network user interface.
@@ -60,3 +60,11 @@ to be added

+ +## NOTICE + +This work is licensed under the [Apache-2.0](https://www.apache.org/licenses/LICENSE-2.0). + +- SPDX-License-Identifier: Apache-2.0 +- SPDX-FileCopyrightText: 2021-2023 Contributors to the Eclipse Foundation +- Source URL: https://github.com/eclipse-tractusx/portal-assets diff --git a/developer/Technical Documentation/Interface Contracts/BPDM.md b/developer/Technical Documentation/Interface Contracts/BPDM.md index d3636ac10..eab7efc36 100644 --- a/developer/Technical Documentation/Interface Contracts/BPDM.md +++ b/developer/Technical Documentation/Interface Contracts/BPDM.md @@ -77,3 +77,11 @@ The portal is using an technical user for the authentication. The technical user

+ +## NOTICE + +This work is licensed under the [Apache-2.0](https://www.apache.org/licenses/LICENSE-2.0). + +- SPDX-License-Identifier: Apache-2.0 +- SPDX-FileCopyrightText: 2021-2023 Contributors to the Eclipse Foundation +- Source URL: https://github.com/eclipse-tractusx/portal-assets diff --git a/developer/Technical Documentation/Interface Contracts/CX-Membership.md b/developer/Technical Documentation/Interface Contracts/CX-Membership.md index 38efbe87e..53d6452d9 100644 --- a/developer/Technical Documentation/Interface Contracts/CX-Membership.md +++ b/developer/Technical Documentation/Interface Contracts/CX-Membership.md @@ -45,3 +45,11 @@ the string response includes all bpn's of active network members

+ +## NOTICE + +This work is licensed under the [Apache-2.0](https://www.apache.org/licenses/LICENSE-2.0). + +- SPDX-License-Identifier: Apache-2.0 +- SPDX-FileCopyrightText: 2021-2023 Contributors to the Eclipse Foundation +- Source URL: https://github.com/eclipse-tractusx/portal-assets diff --git a/developer/Technical Documentation/Interface Contracts/Clearinghouse.md b/developer/Technical Documentation/Interface Contracts/Clearinghouse.md index 1fb3e5018..c3a53e8d9 100644 --- a/developer/Technical Documentation/Interface Contracts/Clearinghouse.md +++ b/developer/Technical Documentation/Interface Contracts/Clearinghouse.md @@ -1,8 +1,9 @@ ## Clearinghouse +
-* [Legal Participant Self Description Creation](/developer/Technical%20Documentation/Interface%20Contracts/Clearinghouse.md#1-notarization-check) -* [Connector/Service Self Description Creation](/developer/Technical%20Documentation/Interface%20Contracts/Clearinghouse.md#2-compliance-check) +- [Legal Participant Self Description Creation](/developer/Technical%20Documentation/Interface%20Contracts/Clearinghouse.md#1-notarization-check) +- [Connector/Service Self Description Creation](/developer/Technical%20Documentation/Interface%20Contracts/Clearinghouse.md#2-compliance-check)

@@ -13,7 +14,7 @@ The Gaia-X Clearinghouse provides two key services - trust (validation of corporate data by verifying data from legal entities, according to the Gaia-X Trust Framework) - conformity assessment (SD Documents via teh compliance check) -
+
Below the respective touched business process steps are highlighted to enable an easier mapping of the interfaces to the portal product business process: @@ -63,8 +64,9 @@ Both the flows are identical and displayed below:

Two technical users are created to allow the clearinghouse to access the available services: -* sa-cl2-01 (for the notarization service response) -* sa-cl2-02 (for the compliance sd submission) + +- sa-cl2-01 (for the notarization service response) +- sa-cl2-02 (for the compliance sd submission)

@@ -73,7 +75,7 @@ Two technical users are created to allow the clearinghouse to access the availab The Clearinghouse is triggered by the respective CX service (depending on the scenario by portal or SD Factory) and processes the data. The response is provided back to the portal in both the cases. -Since the interface is asynchron - a response delay of 60 seconds have been agreed. In special cases it could take longer. +Since the interface is asynchronous - a response delay of 60 seconds have been agreed. In special cases it could take longer. Endpoints used by the CH for response: @@ -83,3 +85,11 @@ Endpoints used by the CH for response:

+ +## NOTICE + +This work is licensed under the [Apache-2.0](https://www.apache.org/licenses/LICENSE-2.0). + +- SPDX-License-Identifier: Apache-2.0 +- SPDX-FileCopyrightText: 2021-2023 Contributors to the Eclipse Foundation +- Source URL: https://github.com/eclipse-tractusx/portal-assets diff --git a/developer/Technical Documentation/Interface Contracts/Dataspace-Discovery.md b/developer/Technical Documentation/Interface Contracts/Dataspace-Discovery.md index eb5d0e103..4caafc234 100644 --- a/developer/Technical Documentation/Interface Contracts/Dataspace-Discovery.md +++ b/developer/Technical Documentation/Interface Contracts/Dataspace-Discovery.md @@ -52,3 +52,11 @@ In case of an empty response, no edc is found for the requested BPNs

+ +## NOTICE + +This work is licensed under the [Apache-2.0](https://www.apache.org/licenses/LICENSE-2.0). + +- SPDX-License-Identifier: Apache-2.0 +- SPDX-FileCopyrightText: 2021-2023 Contributors to the Eclipse Foundation +- Source URL: https://github.com/eclipse-tractusx/portal-assets diff --git a/developer/Technical Documentation/Interface Contracts/Managed Wallets.md b/developer/Technical Documentation/Interface Contracts/Managed Wallets.md index be9a678f8..e23dffe0e 100644 --- a/developer/Technical Documentation/Interface Contracts/Managed Wallets.md +++ b/developer/Technical Documentation/Interface Contracts/Managed Wallets.md @@ -91,3 +91,11 @@ Additional Details: [Click here](/developer/02.%20Technical%20Integration/04.%20

+ +## NOTICE + +This work is licensed under the [Apache-2.0](https://www.apache.org/licenses/LICENSE-2.0). + +- SPDX-License-Identifier: Apache-2.0 +- SPDX-FileCopyrightText: 2021-2023 Contributors to the Eclipse Foundation +- Source URL: https://github.com/eclipse-tractusx/portal-assets diff --git a/developer/Technical Documentation/Interface Contracts/Offer-Autosetup.md b/developer/Technical Documentation/Interface Contracts/Offer-Autosetup.md index ad8e0e542..121776618 100644 --- a/developer/Technical Documentation/Interface Contracts/Offer-Autosetup.md +++ b/developer/Technical Documentation/Interface Contracts/Offer-Autosetup.md @@ -177,3 +177,11 @@ Response Body | 104
Offr Subscription Technical User Creation | Technical User creation in keycloak and metadata storage in portal db, additionally notification creation with technical client id | The process step is set to "DONE"
after technical user ot successfully created | Status "FAILED" if job was running on fail | Yes, in case of an 5xx by keycloak | Yes, in case of an 4xx by keycloak | #105 | | 105
Activate Subscription | Subscription record activation, notification creation and send email. | The process step is set to "DONE"
after xxx | xxx | Yes, in case of an 5xx for the email - auto "TO_DO" | - | Multi Instance: #106
Single Instance: - | | 106
Trigger Provider Callback | Trigger provider callback url to share client and tech user. | The process step is set to "DONE"
after xxx | xxx | Yes, in case of an 5xx | Yes, in case of an 4xx | - | + +## NOTICE + +This work is licensed under the [Apache-2.0](https://www.apache.org/licenses/LICENSE-2.0). + +- SPDX-License-Identifier: Apache-2.0 +- SPDX-FileCopyrightText: 2021-2023 Contributors to the Eclipse Foundation +- Source URL: https://github.com/eclipse-tractusx/portal-assets diff --git a/developer/Technical Documentation/Interface Contracts/Self Description.md b/developer/Technical Documentation/Interface Contracts/Self Description.md index e2eadf0a0..23a16136d 100644 --- a/developer/Technical Documentation/Interface Contracts/Self Description.md +++ b/developer/Technical Documentation/Interface Contracts/Self Description.md @@ -128,3 +128,11 @@ currently not supported currently not supported

+ +## NOTICE + +This work is licensed under the [Apache-2.0](https://www.apache.org/licenses/LICENSE-2.0). + +- SPDX-License-Identifier: Apache-2.0 +- SPDX-FileCopyrightText: 2021-2023 Contributors to the Eclipse Foundation +- Source URL: https://github.com/eclipse-tractusx/portal-assets diff --git a/developer/Technical Documentation/Operations/Auditing.md b/developer/Technical Documentation/Operations/Auditing.md index 334b2917c..49096ea9d 100644 --- a/developer/Technical Documentation/Operations/Auditing.md +++ b/developer/Technical Documentation/Operations/Auditing.md @@ -81,3 +81,11 @@ Additional relevant information: - (warning) If not already existing in the original table, a uuid and last_editor_id attribute need to get added to the original entity. - (warning) whenever the original table attributes are changed (e.g. adding an attribute or deleting and attribute) the already existing audit table will be set to frozen and a new audit table is getting created. All new audit relevant records will be stored in the new audit table + +## NOTICE + +This work is licensed under the [Apache-2.0](https://www.apache.org/licenses/LICENSE-2.0). + +- SPDX-License-Identifier: Apache-2.0 +- SPDX-FileCopyrightText: 2021-2023 Contributors to the Eclipse Foundation +- Source URL: https://github.com/eclipse-tractusx/portal-assets diff --git a/developer/Technical Documentation/Operations/Release-Process.md b/developer/Technical Documentation/Operations/Release-Process.md index 9d689cdfd..0597f0c25 100644 --- a/developer/Technical Documentation/Operations/Release-Process.md +++ b/developer/Technical Documentation/Operations/Release-Process.md @@ -110,7 +110,7 @@ On the release branch the following steps are executed: 2. Update changelog file -3. Update README (chart and root level) +3. Update README (on chart level) Use [helm-docs](https://github.com/norwoodj/helm-docs) (gotemplate driven) for updating the README file. @@ -118,8 +118,6 @@ Use [helm-docs](https://github.com/norwoodj/helm-docs) (gotemplate driven) for u helm-docs --chart-search-root [charts-dir] --sort-values-order file ``` -Copy updated README file on chart level to root level. - Example for commit message: _release: update readme for vx.x.x_ @@ -178,3 +176,11 @@ _Version 1.2.0: Frontend Registration for the Catena-X_ _Version 1.1.0: Assets for the Catena-X Portal_ _Version 1.1.0: Backend for the Catena-X Portal_ + +## NOTICE + +This work is licensed under the [Apache-2.0](https://www.apache.org/licenses/LICENSE-2.0). + +- SPDX-License-Identifier: Apache-2.0 +- SPDX-FileCopyrightText: 2021-2023 Contributors to the Eclipse Foundation +- Source URL: https://github.com/eclipse-tractusx/portal-assets diff --git a/developer/Technical Documentation/Operations/Tests.md b/developer/Technical Documentation/Operations/Tests.md index 83633bc18..084d85e9b 100644 --- a/developer/Technical Documentation/Operations/Tests.md +++ b/developer/Technical Documentation/Operations/Tests.md @@ -12,7 +12,7 @@ Unit tests are available for backend and frontend components and getting automat ## Test Automation -Test Automation as part of functional e2e tests are planned for upcomming releases. +Test Automation as part of functional e2e tests are planned for upcoming releases. Currently all tests are manually handled.
@@ -24,3 +24,11 @@ Manual tests are executed and documented inside the Catena-X consortia. Currentl

+ +## NOTICE + +This work is licensed under the [Apache-2.0](https://www.apache.org/licenses/LICENSE-2.0). + +- SPDX-License-Identifier: Apache-2.0 +- SPDX-FileCopyrightText: 2021-2023 Contributors to the Eclipse Foundation +- Source URL: https://github.com/eclipse-tractusx/portal-assets diff --git a/developer/Technical Documentation/Others/Document Management.md b/developer/Technical Documentation/Others/Document Management.md index 41aa48844..084f02938 100644 --- a/developer/Technical Documentation/Others/Document Management.md +++ b/developer/Technical Documentation/Others/Document Management.md @@ -103,7 +103,7 @@ Overview of all document related GET Endpoints:
-In all those endpoints, the document itself will get retrived (e.g. pdf, json, png, etc.) +In all those endpoints, the document itself will get retrieved (e.g. pdf, json, png, etc.)

@@ -143,3 +143,11 @@ Scheduled deletion job, configurable to run overnight.

+ +## NOTICE + +This work is licensed under the [Apache-2.0](https://www.apache.org/licenses/LICENSE-2.0). + +- SPDX-License-Identifier: Apache-2.0 +- SPDX-FileCopyrightText: 2021-2023 Contributors to the Eclipse Foundation +- Source URL: https://github.com/eclipse-tractusx/portal-assets diff --git a/developer/Technical Documentation/Others/Email Templates.md b/developer/Technical Documentation/Others/Email Templates.md index eb8ebf618..3688e3677 100644 --- a/developer/Technical Documentation/Others/Email Templates.md +++ b/developer/Technical Documentation/Others/Email Templates.md @@ -12,7 +12,7 @@ On this page a summary is provided on which Email Templates are available and us - E-Mail Invite additional Users - E-Mail Submitted Registration & Next Steps - E-Mail Welcome to Catena-X - Join the Network -- E-Mail Passwort Reset +- E-Mail Password Reset - E-Mail Invite New User to Portal - E-Mail Template implementations
@@ -84,7 +84,7 @@ Email Trigger: CX Admin has approved Company Registration request.

-### E-Mail Passwort Reset +### E-Mail Password Reset Email Trigger: Shared IdP User is selecting "Password reset" on the login screen
@@ -101,3 +101,11 @@ Email Trigger: Admin User is inviting inside the Portal User Management a new us


+ +## NOTICE + +This work is licensed under the [Apache-2.0](https://www.apache.org/licenses/LICENSE-2.0). + +- SPDX-License-Identifier: Apache-2.0 +- SPDX-FileCopyrightText: 2021-2023 Contributors to the Eclipse Foundation +- Source URL: https://github.com/eclipse-tractusx/portal-assets diff --git a/developer/Technical Documentation/Others/Images, Graphics and Diagrams.md b/developer/Technical Documentation/Others/Images, Graphics and Diagrams.md index deaeb1569..117188015 100644 --- a/developer/Technical Documentation/Others/Images, Graphics and Diagrams.md +++ b/developer/Technical Documentation/Others/Images, Graphics and Diagrams.md @@ -130,3 +130,11 @@ Follow this (SVG) decision diagram to find the optimal image encoding. Choosing an image for use on a web page is a trade-off between file size and quality of display. The file format has the biggest impact on the result. High quality, high resolution bitmap images look very beautiful on the screen but often come as big files that takes very long to load. Always try to keep the file size as small as possible while preserving an acceptable quality for the user. As a rule of thumb, the file size of any image should not exceed 100kB. Whenever the image type allows to use SVG, then use SVG as it usually is the best choice combining the smallest file size together with best image quality. + +## NOTICE + +This work is licensed under the [Apache-2.0](https://www.apache.org/licenses/LICENSE-2.0). + +- SPDX-License-Identifier: Apache-2.0 +- SPDX-FileCopyrightText: 2021-2023 Contributors to the Eclipse Foundation +- Source URL: https://github.com/eclipse-tractusx/portal-assets diff --git a/developer/Technical Documentation/Others/Notifications.md b/developer/Technical Documentation/Others/Notifications.md index 5dc0adcbc..d798a6f7b 100644 --- a/developer/Technical Documentation/Others/Notifications.md +++ b/developer/Technical Documentation/Others/Notifications.md @@ -414,3 +414,11 @@ Missing documentation:

+ +## NOTICE + +This work is licensed under the [Apache-2.0](https://www.apache.org/licenses/LICENSE-2.0). + +- SPDX-License-Identifier: Apache-2.0 +- SPDX-FileCopyrightText: 2021-2023 Contributors to the Eclipse Foundation +- Source URL: https://github.com/eclipse-tractusx/portal-assets diff --git a/developer/Technical Documentation/TestAutomation/01. Summary.md b/developer/Technical Documentation/TestAutomation/01. Summary.md index fb5dff11c..9a2d4eb4a 100644 --- a/developer/Technical Documentation/TestAutomation/01. Summary.md +++ b/developer/Technical Documentation/TestAutomation/01. Summary.md @@ -158,3 +158,11 @@ source control. The values of secrets can be found under the profile tab in deployed ReportPortal. The further specifics for running and configuring the ReportPortal are highlighted [here](10.%20ReportPortal.md). + +## NOTICE + +This work is licensed under the [Apache-2.0](https://www.apache.org/licenses/LICENSE-2.0). + +- SPDX-License-Identifier: Apache-2.0 +- SPDX-FileCopyrightText: 2021-2023 Contributors to the Eclipse Foundation +- Source URL: https://github.com/eclipse-tractusx/portal-assets diff --git a/developer/Technical Documentation/TestAutomation/02. Access Token Retrieval.md b/developer/Technical Documentation/TestAutomation/02. Access Token Retrieval.md index 643c80a89..4b23c465c 100644 --- a/developer/Technical Documentation/TestAutomation/02. Access Token Retrieval.md +++ b/developer/Technical Documentation/TestAutomation/02. Access Token Retrieval.md @@ -208,3 +208,11 @@ Finally the password message is deleted after fetching the password for security In both cases after getting the username and password, an authentication flow can be processed to get an access token for the user. + +## NOTICE + +This work is licensed under the [Apache-2.0](https://www.apache.org/licenses/LICENSE-2.0). + +- SPDX-License-Identifier: Apache-2.0 +- SPDX-FileCopyrightText: 2021-2023 Contributors to the Eclipse Foundation +- Source URL: https://github.com/eclipse-tractusx/portal-assets diff --git a/developer/Technical Documentation/TestAutomation/03. InterfacePartnerHealthCheck.md b/developer/Technical Documentation/TestAutomation/03. InterfacePartnerHealthCheck.md index 43659e03b..1698bf80b 100644 --- a/developer/Technical Documentation/TestAutomation/03. InterfacePartnerHealthCheck.md +++ b/developer/Technical Documentation/TestAutomation/03. InterfacePartnerHealthCheck.md @@ -114,3 +114,11 @@ already existing. ``` POST: https://managed-identity-wallets.{env}.example.org/api/wallets ``` + +## NOTICE + +This work is licensed under the [Apache-2.0](https://www.apache.org/licenses/LICENSE-2.0). + +- SPDX-License-Identifier: Apache-2.0 +- SPDX-FileCopyrightText: 2021-2023 Contributors to the Eclipse Foundation +- Source URL: https://github.com/eclipse-tractusx/portal-assets diff --git a/developer/Technical Documentation/TestAutomation/04. PortalHealthCheck.md b/developer/Technical Documentation/TestAutomation/04. PortalHealthCheck.md index fd3b79bb7..cbd5fc246 100644 --- a/developer/Technical Documentation/TestAutomation/04. PortalHealthCheck.md +++ b/developer/Technical Documentation/TestAutomation/04. PortalHealthCheck.md @@ -29,3 +29,11 @@ GET /api/registration/companyRoleAgreementData GET /api/registration/rolesComposite GET /api/registration/applications ``` + +## NOTICE + +This work is licensed under the [Apache-2.0](https://www.apache.org/licenses/LICENSE-2.0). + +- SPDX-License-Identifier: Apache-2.0 +- SPDX-FileCopyrightText: 2021-2023 Contributors to the Eclipse Foundation +- Source URL: https://github.com/eclipse-tractusx/portal-assets diff --git a/developer/Technical Documentation/TestAutomation/05. RegistrationScenarios.md b/developer/Technical Documentation/TestAutomation/05. RegistrationScenarios.md index 495c6c4fe..ece3b9415 100644 --- a/developer/Technical Documentation/TestAutomation/05. RegistrationScenarios.md +++ b/developer/Technical Documentation/TestAutomation/05. RegistrationScenarios.md @@ -175,7 +175,7 @@ via: POST: /api/registration/application/{applicationId}/companyDetailsWithAddress ``` -Afterwards stored company data is validated once more time to ensure that company data change was successfull. +Afterwards stored company data is validated once more time to ensure that company data change was successful. ``` Get: /api/registration/application/{applicationId}/companyDetailsWithAddress @@ -188,3 +188,11 @@ submission of agreements are the same as in happy paths with or without bpn. After that the CompanyApplicationStatusId is explicitly set to "VERIFY" and an error is expected because of missing documents.This logic is not implemented in productive code yet. + +## NOTICE + +This work is licensed under the [Apache-2.0](https://www.apache.org/licenses/LICENSE-2.0). + +- SPDX-License-Identifier: Apache-2.0 +- SPDX-FileCopyrightText: 2021-2023 Contributors to the Eclipse Foundation +- Source URL: https://github.com/eclipse-tractusx/portal-assets diff --git a/developer/Technical Documentation/TestAutomation/06. NotificiationInitScenario.md b/developer/Technical Documentation/TestAutomation/06. NotificiationInitScenario.md index 7a5c0b748..86001d621 100644 --- a/developer/Technical Documentation/TestAutomation/06. NotificiationInitScenario.md +++ b/developer/Technical Documentation/TestAutomation/06. NotificiationInitScenario.md @@ -28,3 +28,11 @@ was created: ``` GET: /api/notification/?page=0&size=10&sorting=DateDesc ``` + +## NOTICE + +This work is licensed under the [Apache-2.0](https://www.apache.org/licenses/LICENSE-2.0). + +- SPDX-License-Identifier: Apache-2.0 +- SPDX-FileCopyrightText: 2021-2023 Contributors to the Eclipse Foundation +- Source URL: https://github.com/eclipse-tractusx/portal-assets diff --git a/developer/Technical Documentation/TestAutomation/07. ServiceAccountCUDScenarios.md b/developer/Technical Documentation/TestAutomation/07. ServiceAccountCUDScenarios.md index 578f4c9a8..15eb973c8 100644 --- a/developer/Technical Documentation/TestAutomation/07. ServiceAccountCUDScenarios.md +++ b/developer/Technical Documentation/TestAutomation/07. ServiceAccountCUDScenarios.md @@ -125,3 +125,11 @@ Afterwards it is checked that the deleted service account is not available anymo ``` GET: api/administration/serviceaccount/owncompany/serviceaccounts ``` + +## NOTICE + +This work is licensed under the [Apache-2.0](https://www.apache.org/licenses/LICENSE-2.0). + +- SPDX-License-Identifier: Apache-2.0 +- SPDX-FileCopyrightText: 2021-2023 Contributors to the Eclipse Foundation +- Source URL: https://github.com/eclipse-tractusx/portal-assets diff --git a/developer/Technical Documentation/TestAutomation/08. TestDataFileSetup.md b/developer/Technical Documentation/TestAutomation/08. TestDataFileSetup.md index 9145e7dd5..c738e64c8 100644 --- a/developer/Technical Documentation/TestAutomation/08. TestDataFileSetup.md +++ b/developer/Technical Documentation/TestAutomation/08. TestDataFileSetup.md @@ -208,3 +208,11 @@ The following values are hardcoded in the test scenarios: - name and description for technical user for service accounts - attribute "bpn" to check the correctness of token for technical user for service accounts - [bodies for interface partner health checks](03.%20InterfacePartnerHealthCheck.md) + +## NOTICE + +This work is licensed under the [Apache-2.0](https://www.apache.org/licenses/LICENSE-2.0). + +- SPDX-License-Identifier: Apache-2.0 +- SPDX-FileCopyrightText: 2021-2023 Contributors to the Eclipse Foundation +- Source URL: https://github.com/eclipse-tractusx/portal-assets diff --git a/developer/Technical Documentation/TestAutomation/09. CreateAppScenario.md b/developer/Technical Documentation/TestAutomation/09. CreateAppScenario.md index b4f12395c..198ea0208 100644 --- a/developer/Technical Documentation/TestAutomation/09. CreateAppScenario.md +++ b/developer/Technical Documentation/TestAutomation/09. CreateAppScenario.md @@ -42,7 +42,7 @@ Afterwards the agreements are signed via a POST request: POST: /api/apps/appreleaseprocess/consent/{appId}/agreementConsents - sign the agreements ``` -The necessary documents of the types "CONFORMITY_APPROVAL_BUSINESS_APPS" and "APP_IMAGE" are uploaded via: +The necessary documents of the types "CONFORMITY_APPROVAL_BUSINESS_APPS", "APP_LEADIMAGE" and "APP_IMAGE" are uploaded via: ``` PUT: /api/apps/AppReleaseProcess/updateappdoc/{appId}/documentType/{documentTypeId}/documents @@ -120,3 +120,11 @@ GET: api/administration/serviceaccount/user/roles ``` All roles are used for the PUT request. + +## NOTICE + +This work is licensed under the [Apache-2.0](https://www.apache.org/licenses/LICENSE-2.0). + +- SPDX-License-Identifier: Apache-2.0 +- SPDX-FileCopyrightText: 2021-2023 Contributors to the Eclipse Foundation +- Source URL: https://github.com/eclipse-tractusx/portal-assets diff --git a/developer/Technical Documentation/TestAutomation/10. ReportPortal.md b/developer/Technical Documentation/TestAutomation/10. ReportPortal.md index 534ec77a7..e7550081c 100644 --- a/developer/Technical Documentation/TestAutomation/10. ReportPortal.md +++ b/developer/Technical Documentation/TestAutomation/10. ReportPortal.md @@ -32,3 +32,11 @@ The following widgets should be configured according to the [docs](https://repor In order to fetch the test results and connect to the E2E test project, the nuget package ReportPortal.XUnit has to be added to the project. In addition, the file "ReportPortal.config.json" has to be added to the project and filled like [this](https://github.com/reportportal/agent-net-xunit#readme). + +## NOTICE + +This work is licensed under the [Apache-2.0](https://www.apache.org/licenses/LICENSE-2.0). + +- SPDX-License-Identifier: Apache-2.0 +- SPDX-FileCopyrightText: 2021-2023 Contributors to the Eclipse Foundation +- Source URL: https://github.com/eclipse-tractusx/portal-assets diff --git a/developer/Technical Documentation/Version Upgrade/portal-upgrade-details.md b/developer/Technical Documentation/Version Upgrade/portal-upgrade-details.md index 388c8fdaa..3f65a2aed 100644 --- a/developer/Technical Documentation/Version Upgrade/portal-upgrade-details.md +++ b/developer/Technical Documentation/Version Upgrade/portal-upgrade-details.md @@ -1,19 +1,49 @@ +- [Summary](#summary) + - [v1.7.0](#v170) + - [Company Service Account - FIX](#company-service-account---fix) + - [Enable OSP Provider IdPs - Update](#enable-osp-provider-idps---update) + - [Enable Application Types - NEW](#enable-application-types---new) + - [Enable Onboarding Service Provider - NEW](#enable-onboarding-service-provider---new) + - [Technical Role - UPDATE](#technical-role---update) + - [Database Constraints - FIX](#database-constraints---fix) + - [v1.6.0](#v160) + - [Company Credential Details - NEW](#company-credential-details---new) + - [Connectors - CHANGED](#connectors---changed) + - [v1.4.0](#v140) + - [Technical User Profiles - NEW](#technical-user-profiles---new) + - [License Types - NEW \& ENHANCED](#license-types---new--enhanced) + - [v1.2.0](#v120) + - [Mediatype - NEW \& ENHANCED](#mediatype---new--enhanced) + - [v1.1.0](#v110) + - [Application Checklist - ENHANCED](#application-checklist---enhanced) + - [Service Details - NEW (interim)](#service-details---new-interim) + ## Summary This document describes the portal database changes and its impact on transactional data. Depending on the impact, possible risks/impediments on upgrades as well as mitigation plans are described. Each section includes the respective change details, impact on existing data and the respective release with which the change is getting active. -
- > **_INFO:_** inside the detailed descriptions below, the definition 'migration script' refers to the term 'migrations' as it is defined by the ef-core framework: https://learn.microsoft.com/en-us/ef/core/managing-schemas/migrations -
+### v1.7.0 + +#### Company Service Account - FIX + +To fix the empty user_entity_id for company_service_accounts the following process can be created. It will than run the process which will request the user from keycloak and set the user_entity_id for the corresponding company_service_account. -#### Enable OSP Provider IdPs - Update - 1.7.0 +```sql +insert into portal.processes (id, process_type_id, lock_expiry_date, version) +values ('b6f57214-3c72-4b9b-aeb9-fe6add2d406d', 5, null, 'b6f57214-3c72-4b9b-aeb9-fe6add2d406d'); + +insert into portal.process_steps (id, process_step_type_id, process_step_status_id, date_created, date_last_changed, process_id, message) +values ('68d28f88-85fc-43a9-835a-fce0d5a9e665', 300, 1, '2023-02-21 08:15:20.479000 +00:00', null, 'b6f57214-3c72-4b9b-aeb9-fe6add2d406d', null); +``` + +#### Enable OSP Provider IdPs - Update The `identity_providers` table has been adjusted to provide the possibility to safe the owner of the idp. -image +![IdentityProvidersUpdate](/docs/static/IdentityProvidersUpdate.png) - added "Identity_Provider_Types" table which is connected to portal.identity_providers table - added inside the new table "Identity_Provider_Types" an id as well as a label. Labels are defined below: @@ -37,51 +67,45 @@ the identity_providers.owner is important to define which companies are able to - RETRIGGER_CALLBACK_OSP_APPROVED - RETRIGGER_CALLBACK_OSP_DECLINED - Migration For each existing idp data set inside the table identity_providers; the following values will get set: -* idp owner -* idp type - -Logic: -* all "KEYCLOAK_SHARED" IdPs got the idp type "3" set ("3" = "SHARED") -* all "KEYCLOAK_SHARED" IdP categories have been changed to "OIDC" -* "KEYCLOAK_OIDC" got renamed to "OIDC" -* "KEYCLOAK_SAML" got renamed to "SAML" -* all "OIDC" & "SAML" IdPs got the idp type "1" set ("1" = "owned") -* all "OIDC" and "SAML" IdPs need to have the "Customer" set as IdP owner +- idp owner +- idp type +Logic: -#### Enable Application Types - NEW - 1.7.0 +- all "KEYCLOAK_SHARED" IdPs got the idp type "3" set ("3" = "SHARED") +- all "KEYCLOAK_SHARED" IdP categories have been changed to "OIDC" +- "KEYCLOAK_OIDC" got renamed to "OIDC" +- "KEYCLOAK_SAML" got renamed to "SAML" +- all "OIDC" & "SAML" IdPs got the idp type "1" set ("1" = "owned") +- all "OIDC" and "SAML" IdPs need to have the "Customer" set as IdP owner -The `company_applications` table has been expanded. New columns `company_application_type`, `onboarding_service_provider_id` have been added to have the possibility to track which onboarding service provider started an application for a specific company. +#### Enable Application Types - NEW -image +The `company_applications` table has been expanded. New columns `company_application_type`, `onboarding_service_provider_id` have been added to have the possibility to track which onboarding service provider started an application for a specific company. -
+![CompanyApplicationTypes](/docs/static/CompanyApplicationTypes.png) "onboarding_service_provider_id" => nullable "external" => enum; 1 = "INTERNAL", 2 = "EXTERNAL" -#### Enable Onboarding Service Provider - NEW 1.7.0 +#### Enable Onboarding Service Provider - NEW -* NEW: portal.company_user_assigned_identity_providers -* NEW: portal.network_registrations -* NEW: portal.onboarding_service_provider_details -* EXTEND: portal.identity_user_statuses +- NEW: portal.company_user_assigned_identity_providers +- NEW: portal.network_registrations +- NEW: portal.onboarding_service_provider_details +- EXTEND: portal.identity_user_statuses NEW portal.company_user_assigned_identity_providers table to be able to link a user to an identity provider NEW portal.network_registrations to safe the network registrations of an onboarding service provider or operator NEW portal.onboarding_service_provider_details to safe information of the onboarding service provider such as the auth_url to authenticate the technical users as well as the callback url -
-
+#### Technical Role - UPDATE -#### Technical Role - UPDATE - 1.7.0 - -To align the portal database with the keycloak database the following SQL must be executed against the portal database. The script will replace the 'Connector User' role with the roles 'Semantic Model Management' and 'Dataspace Discovery'. As well as replace the 'App Tech User' role with 'Semantic Model Management', 'Dataspace Discovery' and 'CX Membership Info'. This results in all identity assigned roles being replaced, all technical user profile assigned roles being updated and the old roles being removed from the database. +To align the portal database with the Keycloak database the following SQL must be executed against the portal database. The script will replace the 'Connector User' role with the roles 'Semantic Model Management' and 'Dataspace Discovery'. As well as replace the 'App Tech User' role with 'Semantic Model Management', 'Dataspace Discovery' and 'CX Membership Info'. This results in all identity assigned roles being replaced, all technical user profile assigned roles being updated and the old roles being removed from the database. ```sql WITH connector_users AS ( @@ -190,7 +214,7 @@ DELETE FROM portal.user_roles WHERE user_role IN ('Connector User', 'App Tech Us ``` -#### Database Constraints - FIX - 1.7.0 +#### Database Constraints - FIX If you're running on release 1.6.0 (1.6.0-rc1 up to 1.7.0-alpha are the affected versions) and want to execute a database dump, for instance as part of a database upgrade, you should run the following script on the database to make sure that the database dump can be imported without any problems and errors. @@ -304,7 +328,9 @@ FOR EACH ROW EXECUTE PROCEDURE portal.tr_is_external_type_use_case(); ``` -#### Company Credential Details - NEW - 1.6.0 +### v1.6.0 + +#### Company Credential Details - NEW - NEW: portal.use_case_descriptions - NEW: portal.company_ssi_details @@ -326,11 +352,11 @@ New verified_credential_external_types, verified_credential_external_type_use_ca Company SSI Database Structure -drawing +![company-ssi-database](/docs/static/company-ssi-database.png) Use Case Database Structure -drawing +![use-case-database](/docs/static/use-case-database.png) - NEW: table "language_long_names" - ENHANCED: table portal.languages "long_name_de" and "long_name_en" removed @@ -341,8 +367,6 @@ Impact on existing data: As part of the migration, for all existing language stored in the table portal.languages, the short name will be used to define language.Newly created table language_long_names will have foreign key relation with languages table where long name will be stored for each corresponding short name of language table in german and english language for e.g below -
- language_long_names: | short_name | language_short_name | long_name | @@ -354,17 +378,16 @@ language_long_names: | es | de | spanisch | | es | en | spanish | -
-
- -#### Connectors - CHANGED - 1.6.0 +#### Connectors - CHANGED - REMOVED: removed table connector_client_details - REMOVED: column daps_registration_successful The DAPS was completly removed from the portal services, hence the connector_client_details table was removed, as well as the daps_registration_successful column from the connector table. -#### Technical User Profiles - NEW - 1.4.0 +### v1.4.0 + +#### Technical User Profiles - NEW > **_INFO:_** Please note: the technical user profiles will remove the interim solution of technical_user_needed within the service_details table, which was introduced in 1.1.0 @@ -372,7 +395,7 @@ The DAPS was completly removed from the portal services, hence the connector_cli - NEW: portal.technical_user_assigned_user_roles New technical_user_profiles table released to provide technical user profiles for apps and dataspace services. -New technical_user_assigned_user_roles table to assign multiple roles to a technical user proile. +New technical_user_assigned_user_roles table to assign multiple roles to a technical user profile. Until the corresponding endpoint is implemented to add technical user profiles, you can use the following script, please make sure the ids used in appTechnicalUserRole and serviceTechnicalUserRole are correct and existing in the database: @@ -394,10 +417,7 @@ Impact on existing data: As part of the migration the `technical_user_needed` flag within the `service_details` table will be removed. Therefore all existing apps and services in the offer table needs to be manually updated, if they should keep a technical user profile. See the above mentioned script as an option. -
-
- -#### License Types - NEW & ENHANCED- 1.4.0 +#### License Types - NEW & ENHANCED - NEW: table "license_types" - ENHANCED: table portal.offers "license_type_id" added @@ -407,8 +427,6 @@ New license_types table released to manage license need for app/services with a Impact on existing data: As part of the migration, for all existing offer stored in the table portal.offers, the license_type_id will be used to define license need for apps and services for respective offer where default value of license_type_id is 1 i.e COTS. -
- Supported license types: | license_type_id | license_type | @@ -416,10 +434,9 @@ Supported license types: | 1 | COTS | | 2 | FOSS | -
-
+### v1.2.0 -#### Mediatype - NEW & ENHANCED - 1.2.0 +#### Mediatype - NEW & ENHANCED - NEW: table "media_types" - ENHANCED: table portal.documents "media_type_id" added @@ -428,8 +445,6 @@ Impact on existing data: As part of the migration, for all existing documents stored in the table portal.documents, the filename extension will be used to define and store the media_type_id of the respective document inside the new table attribute. Important: check beforehand if all documents have a document type added inside the document name. If not, add the respective media type or delete the document. Additionally check if all stored documents are supported by the media types migrated in table portal.media_type. In case any other document media type is currently loaded/stored inside the table portal.documents, the migration will fail. In this case delete the document beforehand or enhance the migration script media types supported. -
- Supported media types: | media_type_id | media_type | @@ -443,14 +458,11 @@ Supported media types: | 6 | .pdf | | 7 | .json | -
- > **_INFO:_** additional media types (e.g. .pem, .ca_cert, .pkx_cer, .octet) are added in version 1.2.0 and 1.3.0 -
-
+### v1.1.0 -#### Application Checklist - ENHANCED - 1.1.0 +#### Application Checklist - ENHANCED - NEW: portal.processes - NEW: portal.process_types @@ -469,10 +481,7 @@ Existing company registration data currently under validation are automatically No manual intervention needed. For company applications currently in status "under creation" (which means not yet submitted for validation) the change has no impact, since the process_id is created as part of the registration submitted. As soon as the participant submits the registration, the new process with the process_id will apply. -
-
- -#### Service Details - NEW (interim) - 1.1.0 +#### Service Details - NEW (interim) - NEW: table "service_details" - REMOVED: table service_assigned_service_types @@ -484,15 +493,18 @@ Attributes - service_type_id (connected to portal.service_types and replacing table service_assigned_service_types) - technical_user_needed (true/false flag) -image +![ServiceDetails](/docs/static/ServiceDetails.png) Impact on existing data: Migration script existing, based on the service type which is fetched for all existing data from portal table service_assigned_service_types, the technical_user_needed attribute is set to "true" for "DATASPACE_SERVICE" services and "false" for "CONSULTANCE_SERVICE". Transactional data are automatically updated/migrated. -
- > **_INFO:_** Please note: this is an interim solution which is expected to get replaced/changed in version 1.4.0 -
-
+## NOTICE + +This work is licensed under the [Apache-2.0](https://www.apache.org/licenses/LICENSE-2.0). + +- SPDX-License-Identifier: Apache-2.0 +- SPDX-FileCopyrightText: 2021-2023 Contributors to the Eclipse Foundation +- Source URL: https://github.com/eclipse-tractusx/portal-assets diff --git a/docs/01. Onboarding/01. Registration Invite/01. Summary.md b/docs/01. Onboarding/01. Registration Invite/01. Summary.md index dd2211a9f..b07e59edc 100644 --- a/docs/01. Onboarding/01. Registration Invite/01. Summary.md +++ b/docs/01. Onboarding/01. Registration Invite/01. Summary.md @@ -17,3 +17,11 @@ To ensure that the operator can support with the invite; please share for the in
image + +## NOTICE + +This work is licensed under the [Apache-2.0](https://www.apache.org/licenses/LICENSE-2.0). + +- SPDX-License-Identifier: Apache-2.0 +- SPDX-FileCopyrightText: 2021-2023 Contributors to the Eclipse Foundation +- Source URL: https://github.com/eclipse-tractusx/portal-assets diff --git a/docs/01. Onboarding/01. Registration Invite/02. FAQ.md b/docs/01. Onboarding/01. Registration Invite/02. FAQ.md index d24967795..539ac6a16 100644 --- a/docs/01. Onboarding/01. Registration Invite/02. FAQ.md +++ b/docs/01. Onboarding/01. Registration Invite/02. FAQ.md @@ -26,3 +26,11 @@ If you go to the partner network and search for a company, check out the members

+ +## NOTICE + +This work is licensed under the [Apache-2.0](https://www.apache.org/licenses/LICENSE-2.0). + +- SPDX-License-Identifier: Apache-2.0 +- SPDX-FileCopyrightText: 2021-2023 Contributors to the Eclipse Foundation +- Source URL: https://github.com/eclipse-tractusx/portal-assets diff --git a/docs/01. Onboarding/01. Registration Invite/index.md b/docs/01. Onboarding/01. Registration Invite/index.md index 868706c8b..7153e80f3 100644 --- a/docs/01. Onboarding/01. Registration Invite/index.md +++ b/docs/01. Onboarding/01. Registration Invite/index.md @@ -1,6 +1,6 @@ ## Registration Invite -The registration inivte is currently only available for the platform / portal operator. +The registration invite is currently only available for the platform / portal operator. The operator triggers the invite email to the respective company contact person. For more details, below chapters are available: - [Summary](./01.%20Summary.md) @@ -8,3 +8,11 @@ The operator triggers the invite email to the respective company contact person.

+ +## NOTICE + +This work is licensed under the [Apache-2.0](https://www.apache.org/licenses/LICENSE-2.0). + +- SPDX-License-Identifier: Apache-2.0 +- SPDX-FileCopyrightText: 2021-2023 Contributors to the Eclipse Foundation +- Source URL: https://github.com/eclipse-tractusx/portal-assets diff --git a/docs/01. Onboarding/02. Registration/01. Login.md b/docs/01. Onboarding/02. Registration/01. Login.md index f24719adf..423d07d1a 100644 --- a/docs/01. Onboarding/02. Registration/01. Login.md +++ b/docs/01. Onboarding/02. Registration/01. Login.md @@ -24,7 +24,7 @@ After selecting the company for login; the user can login via the email and pass image
-After the successfull login; the user can directly start to proceed with the company registration form. +After the successful login; the user can directly start to proceed with the company registration form.

@@ -32,3 +32,11 @@ After the successfull login; the user can directly start to proceed with the com ### Portal Login no change / update; same design as used for the registration + +## NOTICE + +This work is licensed under the [Apache-2.0](https://www.apache.org/licenses/LICENSE-2.0). + +- SPDX-License-Identifier: Apache-2.0 +- SPDX-FileCopyrightText: 2021-2023 Contributors to the Eclipse Foundation +- Source URL: https://github.com/eclipse-tractusx/portal-assets diff --git a/docs/01. Onboarding/02. Registration/02. Add Company Data.md b/docs/01. Onboarding/02. Registration/02. Add Company Data.md index c862d8fae..ebde388e6 100644 --- a/docs/01. Onboarding/02. Registration/02. Add Company Data.md +++ b/docs/01. Onboarding/02. Registration/02. Add Company Data.md @@ -24,3 +24,11 @@ In case the manual data entering is used, the user will need to enter

+ +## NOTICE + +This work is licensed under the [Apache-2.0](https://www.apache.org/licenses/LICENSE-2.0). + +- SPDX-License-Identifier: Apache-2.0 +- SPDX-FileCopyrightText: 2021-2023 Contributors to the Eclipse Foundation +- Source URL: https://github.com/eclipse-tractusx/portal-assets diff --git a/docs/01. Onboarding/02. Registration/03. Add Additional User(s).md b/docs/01. Onboarding/02. Registration/03. Add Additional User(s).md index 7a31d7f16..15f1697f6 100644 --- a/docs/01. Onboarding/02. Registration/03. Add Additional User(s).md +++ b/docs/01. Onboarding/02. Registration/03. Add Additional User(s).md @@ -16,3 +16,11 @@ Below an example of the email send to the invited user is shared:

+ +## NOTICE + +This work is licensed under the [Apache-2.0](https://www.apache.org/licenses/LICENSE-2.0). + +- SPDX-License-Identifier: Apache-2.0 +- SPDX-FileCopyrightText: 2021-2023 Contributors to the Eclipse Foundation +- Source URL: https://github.com/eclipse-tractusx/portal-assets diff --git a/docs/01. Onboarding/02. Registration/04. Company Role & Consent.md b/docs/01. Onboarding/02. Registration/04. Company Role & Consent.md index 698676984..ca3b9be84 100644 --- a/docs/01. Onboarding/02. Registration/04. Company Role & Consent.md +++ b/docs/01. Onboarding/02. Registration/04. Company Role & Consent.md @@ -8,3 +8,11 @@ The role can get easily enhanced in future by enhancing or reducing the role ins

+ +## NOTICE + +This work is licensed under the [Apache-2.0](https://www.apache.org/licenses/LICENSE-2.0). + +- SPDX-License-Identifier: Apache-2.0 +- SPDX-FileCopyrightText: 2021-2023 Contributors to the Eclipse Foundation +- Source URL: https://github.com/eclipse-tractusx/portal-assets diff --git a/docs/01. Onboarding/02. Registration/05. Document Upload.md b/docs/01. Onboarding/02. Registration/05. Document Upload.md index 0adb33617..b667f86e4 100644 --- a/docs/01. Onboarding/02. Registration/05. Document Upload.md +++ b/docs/01. Onboarding/02. Registration/05. Document Upload.md @@ -2,10 +2,18 @@ In Step 4, the users are asked to upload the company identification.
-All documents uploaded under the same application register form are shown. If a second user has already uploaded a doc, the user will be able to see as well as delete this document as weel; as long as the users belong to the same company application. +All documents uploaded under the same application register form are shown. If a second user has already uploaded a doc, the user will be able to see as well as delete this document as well; as long as the users belong to the same company application.
image

+ +## NOTICE + +This work is licensed under the [Apache-2.0](https://www.apache.org/licenses/LICENSE-2.0). + +- SPDX-License-Identifier: Apache-2.0 +- SPDX-FileCopyrightText: 2021-2023 Contributors to the Eclipse Foundation +- Source URL: https://github.com/eclipse-tractusx/portal-assets diff --git a/docs/01. Onboarding/02. Registration/06. Verify Registration Data.md b/docs/01. Onboarding/02. Registration/06. Verify Registration Data.md index 0460ea0fd..fc0eef56e 100644 --- a/docs/01. Onboarding/02. Registration/06. Verify Registration Data.md +++ b/docs/01. Onboarding/02. Registration/06. Verify Registration Data.md @@ -11,3 +11,11 @@ With the submit of the application, the application form is getting closed and t

+ +## NOTICE + +This work is licensed under the [Apache-2.0](https://www.apache.org/licenses/LICENSE-2.0). + +- SPDX-License-Identifier: Apache-2.0 +- SPDX-FileCopyrightText: 2021-2023 Contributors to the Eclipse Foundation +- Source URL: https://github.com/eclipse-tractusx/portal-assets diff --git a/docs/01. Onboarding/02. Registration/07. FAQ.md b/docs/01. Onboarding/02. Registration/07. FAQ.md index 2b7bb7b8e..35af80fb6 100644 --- a/docs/01. Onboarding/02. Registration/07. FAQ.md +++ b/docs/01. Onboarding/02. Registration/07. FAQ.md @@ -10,7 +10,7 @@ The company registration data are used to register the company in the network an ## What will happen after the registration? -As soon as the company registration got submitted, the Catena-X operator will validate the data for correctnes and start the automatic regisration process. This includes the legal validation, the Gaia-X compliance check as well as the creation of the company account. +As soon as the company registration got submitted, the Catena-X operator will validate the data for correctness and start the automatic registration process. This includes the legal validation, the Gaia-X compliance check as well as the creation of the company account. The process can take up to 48 hours. As soon as the process is successfully processed, the user will get informed and the access to the network will be given. All details are getting shared via email.

@@ -33,3 +33,11 @@ If pausing the registration is not enough, you can also use the optional step #2 In case the registration is already submitted for validation; the company wont be able to change / adjust any company registration relevant data anymore. The registration form is officially closed and the user need to wait for the registration form validation to finish.

+ +## NOTICE + +This work is licensed under the [Apache-2.0](https://www.apache.org/licenses/LICENSE-2.0). + +- SPDX-License-Identifier: Apache-2.0 +- SPDX-FileCopyrightText: 2021-2023 Contributors to the Eclipse Foundation +- Source URL: https://github.com/eclipse-tractusx/portal-assets diff --git a/docs/01. Onboarding/02. Registration/index.md b/docs/01. Onboarding/02. Registration/index.md index 7da0d1043..6cf073926 100644 --- a/docs/01. Onboarding/02. Registration/index.md +++ b/docs/01. Onboarding/02. Registration/index.md @@ -10,3 +10,11 @@

+ +## NOTICE + +This work is licensed under the [Apache-2.0](https://www.apache.org/licenses/LICENSE-2.0). + +- SPDX-License-Identifier: Apache-2.0 +- SPDX-FileCopyrightText: 2021-2023 Contributors to the Eclipse Foundation +- Source URL: https://github.com/eclipse-tractusx/portal-assets diff --git a/docs/01. Onboarding/03. Registration Approval/02. View Company Application(s).md b/docs/01. Onboarding/03. Registration Approval/02. View Company Application(s).md index 806b600d6..59fbd84aa 100644 --- a/docs/01. Onboarding/03. Registration Approval/02. View Company Application(s).md +++ b/docs/01. Onboarding/03. Registration Approval/02. View Company Application(s).md @@ -34,3 +34,11 @@ Additionally the user can easily download the document by clicking on the docume

+ +## NOTICE + +This work is licensed under the [Apache-2.0](https://www.apache.org/licenses/LICENSE-2.0). + +- SPDX-License-Identifier: Apache-2.0 +- SPDX-FileCopyrightText: 2021-2023 Contributors to the Eclipse Foundation +- Source URL: https://github.com/eclipse-tractusx/portal-assets diff --git a/docs/01. Onboarding/03. Registration Approval/03. Registration Approval Process.md b/docs/01. Onboarding/03. Registration Approval/03. Registration Approval Process.md index f05c4c6b4..cf753eacb 100644 --- a/docs/01. Onboarding/03. Registration Approval/03. Registration Approval Process.md +++ b/docs/01. Onboarding/03. Registration Approval/03. Registration Approval Process.md @@ -67,7 +67,7 @@ The endpoint can only get triggered/executed if the application is in status "su
The administrator can decline the application if the application data are incorrect or incomplete. -The decline scenario is not reversable. The registration company will get informed about the rejection. +The decline scenario is not reversible. The registration company will get informed about the rejection.

@@ -140,7 +140,7 @@ Depending on the API response, the system will behave in the following way: ##### Details "Clearinghouse Check"
-The "Clearinghouse Check" is getting automatically triggered when following pre-requisites are fullfilled: +The "Clearinghouse Check" is getting automatically triggered when following prerequisites are met:
- application checklist status "Business_Partner_Number" = "DONE" @@ -192,7 +192,7 @@ Submitted body to clearinghouse endpoint (content is created on backend side onl ###### Step 2 - Clearinghouse response -In the asyncron call of the clearinhouse check; the portal provices an POST endpoint, which can get triggered by the clearinghouse to update the checklist status. +In the asynchronous call of the clearinghouse check; the portal provides an POST endpoint, which can get triggered by the clearinghouse to update the checklist status.
the clearinghouse need to be able to store an fail/success message. the message is supposed to get stored inside the checklist comment of the record attribute "clearing_house" @@ -217,7 +217,7 @@ The status can only get changed/updated; if the status of the application checkl ##### Details "Self-Description Creation LegalPerson"
-The "Self_Description_Legal_Person" is getting automatically triggered when following pre-requisites are fullfilled: +The "Self_Description_Legal_Person" is getting automatically triggered when following prerequisites are met:
- application checklist status "Business_Partner_Number" = "DONE" @@ -286,7 +286,7 @@ With the execution of the application activation, the system will: - set company_application time stamp - set invitation of all users to "CLOSED" - set invitation time stamp -- update user roles (portal db and keycloak) +- update user roles (portal db and Keycloak) - add bpn to user(s) - send welcome email @@ -303,7 +303,7 @@ With the execution of the application activation, the system will: ### Add/Update BPN for the registration company
-The bpn can get manually added (as an workaround) if the registration company request doesnt have a business partner number added and the registration request is in status "submitted". +The bpn can get manually added (as an workaround) if the registration company request doesn't have a business partner number added and the registration request is in status "submitted".
image
@@ -311,3 +311,11 @@ BPNs can only get added by CX Admin's. As mentioned above, the implementation is a workaround only and will get replaced by the actual bpn connection as soon as the reference implementation is available.

+ +## NOTICE + +This work is licensed under the [Apache-2.0](https://www.apache.org/licenses/LICENSE-2.0). + +- SPDX-License-Identifier: Apache-2.0 +- SPDX-FileCopyrightText: 2021-2023 Contributors to the Eclipse Foundation +- Source URL: https://github.com/eclipse-tractusx/portal-assets diff --git a/docs/01. Onboarding/03. Registration Approval/04. Decline Application.md b/docs/01. Onboarding/03. Registration Approval/04. Decline Application.md index 17705a9a5..888cf0f7b 100644 --- a/docs/01. Onboarding/03. Registration Approval/04. Decline Application.md +++ b/docs/01. Onboarding/03. Registration Approval/04. Decline Application.md @@ -10,7 +10,15 @@ To decline the application the "Cancel Application" Button is enabled for all ap > **Warning** > In the current state of implementation the checklist worker and manual process intervention such as the cancellation have no validation/check implemented where the services can validate if the other service might already run. Means; in the unlikely case that the cancellation is triggered while the activation is running in parallel; the activation might overrule the cancellation. -> The scenario is very unlikely and will get handled in an upcomming release. +> The scenario is very unlikely and will get handled in an upcoming release.

+ +## NOTICE + +This work is licensed under the [Apache-2.0](https://www.apache.org/licenses/LICENSE-2.0). + +- SPDX-License-Identifier: Apache-2.0 +- SPDX-FileCopyrightText: 2021-2023 Contributors to the Eclipse Foundation +- Source URL: https://github.com/eclipse-tractusx/portal-assets diff --git a/docs/01. Onboarding/03. Registration Approval/05. FAQ.md b/docs/01. Onboarding/03. Registration Approval/05. FAQ.md index ec6c1da5b..b7b89c5c0 100644 --- a/docs/01. Onboarding/03. Registration Approval/05. FAQ.md +++ b/docs/01. Onboarding/03. Registration Approval/05. FAQ.md @@ -15,3 +15,11 @@ As soon as the validation is finished you will get informed about the next possi

+ +## NOTICE + +This work is licensed under the [Apache-2.0](https://www.apache.org/licenses/LICENSE-2.0). + +- SPDX-License-Identifier: Apache-2.0 +- SPDX-FileCopyrightText: 2021-2023 Contributors to the Eclipse Foundation +- Source URL: https://github.com/eclipse-tractusx/portal-assets diff --git a/docs/01. Onboarding/03. Registration Approval/index.md b/docs/01. Onboarding/03. Registration Approval/index.md index 944453ff5..006f21bba 100644 --- a/docs/01. Onboarding/03. Registration Approval/index.md +++ b/docs/01. Onboarding/03. Registration Approval/index.md @@ -5,7 +5,7 @@ The registration approval board is created for the CX Admin to managed registrat Acting user: CX Admin (Operator)

-The board supports filter, serach and the actual approval / validation function of new company registration requests. +The board supports filter, search and the actual approval / validation function of new company registration requests.

image @@ -22,3 +22,11 @@ You may find details in the following sub-chapters:

+ +## NOTICE + +This work is licensed under the [Apache-2.0](https://www.apache.org/licenses/LICENSE-2.0). + +- SPDX-License-Identifier: Apache-2.0 +- SPDX-FileCopyrightText: 2021-2023 Contributors to the Eclipse Foundation +- Source URL: https://github.com/eclipse-tractusx/portal-assets diff --git a/docs/01. Onboarding/index.md b/docs/01. Onboarding/index.md index 67ec948ca..fe2493e80 100644 --- a/docs/01. Onboarding/index.md +++ b/docs/01. Onboarding/index.md @@ -1,9 +1,9 @@ ## Onboarding -The Catena-X onbaording is splitted into two section: +The Catena-X onboarding is split into two section: -- Regsitration -- Technical Onbaording +- Registration +- Technical Onboarding In this section the registration process and approval is in focus. @@ -18,3 +18,11 @@ Read more details in the following sections: - [Registration Invite](./01.%20Registration%20Invite/) - [Registration](./02.%20Registration/) - [Registration Approval](./03.%20Registration%20Approval/) + +## NOTICE + +This work is licensed under the [Apache-2.0](https://www.apache.org/licenses/LICENSE-2.0). + +- SPDX-License-Identifier: Apache-2.0 +- SPDX-FileCopyrightText: 2021-2023 Contributors to the Eclipse Foundation +- Source URL: https://github.com/eclipse-tractusx/portal-assets diff --git a/docs/02. Technical Integration/01. Connector Registration/00. Summary.md b/docs/02. Technical Integration/01. Connector Registration/00. Summary.md index e6f254428..d989b6152 100644 --- a/docs/02. Technical Integration/01. Connector Registration/00. Summary.md +++ b/docs/02. Technical Integration/01. Connector Registration/00. Summary.md @@ -13,3 +13,11 @@ no connector required Connector stakeholders are mainly app providers and data provider (active CX participants along the automotive value chain). 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) + +## NOTICE + +This work is licensed under the [Apache-2.0](https://www.apache.org/licenses/LICENSE-2.0). + +- SPDX-License-Identifier: Apache-2.0 +- SPDX-FileCopyrightText: 2021-2023 Contributors to the Eclipse Foundation +- Source URL: https://github.com/eclipse-tractusx/portal-assets diff --git a/docs/02. Technical Integration/01. Connector Registration/01. Connector Overview.md b/docs/02. Technical Integration/01. Connector Registration/01. Connector Overview.md index dc41c7bcc..c3fac5af1 100644 --- a/docs/02. Technical Integration/01. Connector Registration/01. Connector Overview.md +++ b/docs/02. Technical Integration/01. Connector Registration/01. Connector Overview.md @@ -2,7 +2,7 @@
Via the User Navigation (top right) administrators and technical users can access the "Connector Registration". -Inside the connector registration area; an overview of existing connectors (always owned connectors) with theire status are displayed. +Inside the connector registration area; an overview of existing connectors (always owned connectors) with their status are displayed.
Additionally the user can register easily new connectors.
@@ -39,3 +39,11 @@ Same as the "Onboarded Connector" section, connector status and details will be image


+ +## NOTICE + +This work is licensed under the [Apache-2.0](https://www.apache.org/licenses/LICENSE-2.0). + +- SPDX-License-Identifier: Apache-2.0 +- SPDX-FileCopyrightText: 2021-2023 Contributors to the Eclipse Foundation +- Source URL: https://github.com/eclipse-tractusx/portal-assets diff --git a/docs/02. Technical Integration/01. Connector Registration/02. Connector Registration.md b/docs/02. Technical Integration/01. Connector Registration/02. Connector Registration.md index 14be6e60c..b6bb2bb55 100644 --- a/docs/02. Technical Integration/01. Connector Registration/02. Connector Registration.md +++ b/docs/02. Technical Integration/01. Connector Registration/02. Connector Registration.md @@ -33,7 +33,7 @@ The connector registration will automatically trigger the Self-Description creat
-The connector will stay in status "PENDING" as long as the seld-description creation is ongoing. Usually the process takes around 1 minute. +The connector will stay in status "PENDING" as long as the self-description creation is ongoing. Usually the process takes around 1 minute.

@@ -80,7 +80,15 @@ Click "Confirm" as soon as all data are added.
-The connector will stay in status "PENDING" as long as the seld-description creation is ongoing. Usually the process takes around 1 minute. +The connector will stay in status "PENDING" as long as the self-description creation is ongoing. Usually the process takes around 1 minute.

+ +## NOTICE + +This work is licensed under the [Apache-2.0](https://www.apache.org/licenses/LICENSE-2.0). + +- SPDX-License-Identifier: Apache-2.0 +- SPDX-FileCopyrightText: 2021-2023 Contributors to the Eclipse Foundation +- Source URL: https://github.com/eclipse-tractusx/portal-assets diff --git a/docs/02. Technical Integration/01. Connector Registration/04. SelfDescription Retrigger.md b/docs/02. Technical Integration/01. Connector Registration/04. SelfDescription Retrigger.md index 8b6ab9751..ee813a3e0 100644 --- a/docs/02. Technical Integration/01. Connector Registration/04. SelfDescription Retrigger.md +++ b/docs/02. Technical Integration/01. Connector Registration/04. SelfDescription Retrigger.md @@ -1,3 +1,11 @@ #### Self Description Retrigger ....under development.... + +## NOTICE + +This work is licensed under the [Apache-2.0](https://www.apache.org/licenses/LICENSE-2.0). + +- SPDX-License-Identifier: Apache-2.0 +- SPDX-FileCopyrightText: 2021-2023 Contributors to the Eclipse Foundation +- Source URL: https://github.com/eclipse-tractusx/portal-assets diff --git a/docs/02. Technical Integration/01. Connector Registration/05. Delete Connector.md b/docs/02. Technical Integration/01. Connector Registration/05. Delete Connector.md index 14c5e4869..bd2035252 100644 --- a/docs/02. Technical Integration/01. Connector Registration/05. Delete Connector.md +++ b/docs/02. Technical Integration/01. Connector Registration/05. Delete Connector.md @@ -14,3 +14,11 @@ Click on the delete icon to trigger the connector registration. An overlay will

+ +## NOTICE + +This work is licensed under the [Apache-2.0](https://www.apache.org/licenses/LICENSE-2.0). + +- SPDX-License-Identifier: Apache-2.0 +- SPDX-FileCopyrightText: 2021-2023 Contributors to the Eclipse Foundation +- Source URL: https://github.com/eclipse-tractusx/portal-assets diff --git a/docs/02. Technical Integration/01. Connector Registration/06. OpenAPI.md b/docs/02. Technical Integration/01. Connector Registration/06. OpenAPI.md index b954d772c..fb14ce0ce 100644 --- a/docs/02. Technical Integration/01. Connector Registration/06. OpenAPI.md +++ b/docs/02. Technical Integration/01. Connector Registration/06. OpenAPI.md @@ -71,3 +71,11 @@ Technical user connected to the connector

+ +## NOTICE + +This work is licensed under the [Apache-2.0](https://www.apache.org/licenses/LICENSE-2.0). + +- SPDX-License-Identifier: Apache-2.0 +- SPDX-FileCopyrightText: 2021-2023 Contributors to the Eclipse Foundation +- Source URL: https://github.com/eclipse-tractusx/portal-assets diff --git a/docs/02. Technical Integration/01. Connector Registration/07. FAQ.md b/docs/02. Technical Integration/01. Connector Registration/07. FAQ.md index 13fc6267a..b0300b9b7 100644 --- a/docs/02. Technical Integration/01. Connector Registration/07. FAQ.md +++ b/docs/02. Technical Integration/01. Connector Registration/07. FAQ.md @@ -56,3 +56,11 @@ Please use the Portal to register your Connectors. The connector shall be configured to use generated keys, the DAPS server shall be set to the https://daps.beta.demo.catena-x.net Then wait for confirmation from our side. + +## NOTICE + +This work is licensed under the [Apache-2.0](https://www.apache.org/licenses/LICENSE-2.0). + +- SPDX-License-Identifier: Apache-2.0 +- SPDX-FileCopyrightText: 2021-2023 Contributors to the Eclipse Foundation +- Source URL: https://github.com/eclipse-tractusx/portal-assets diff --git a/docs/02. Technical Integration/01. Connector Registration/08. Policy Management.md b/docs/02. Technical Integration/01. Connector Registration/08. Policy Management.md index ca08711e8..3cb25a824 100644 --- a/docs/02. Technical Integration/01. Connector Registration/08. Policy Management.md +++ b/docs/02. Technical Integration/01. Connector Registration/08. Policy Management.md @@ -454,3 +454,11 @@ Partner 1 wants to create an Access Policy that Partner 2 can receive the Contra Partner 2 receives the Contract Offer in the first place. The contract negotiation, started by Partner 2 fails because he has not been identified as Dismantler and therefore does not own the Dismantler Credential. + +## NOTICE + +This work is licensed under the [Apache-2.0](https://www.apache.org/licenses/LICENSE-2.0). + +- SPDX-License-Identifier: Apache-2.0 +- SPDX-FileCopyrightText: 2021-2023 Contributors to the Eclipse Foundation +- Source URL: https://github.com/eclipse-tractusx/portal-assets diff --git a/docs/02. Technical Integration/01. Connector Registration/index.md b/docs/02. Technical Integration/01. Connector Registration/index.md index bf278c6df..124fa0df0 100644 --- a/docs/02. Technical Integration/01. Connector Registration/index.md +++ b/docs/02. Technical Integration/01. Connector Registration/index.md @@ -11,3 +11,11 @@

+ +## NOTICE + +This work is licensed under the [Apache-2.0](https://www.apache.org/licenses/LICENSE-2.0). + +- SPDX-License-Identifier: Apache-2.0 +- SPDX-FileCopyrightText: 2021-2023 Contributors to the Eclipse Foundation +- Source URL: https://github.com/eclipse-tractusx/portal-assets diff --git a/docs/02. Technical Integration/02. Identity Provider Management/01. Summary.md b/docs/02. Technical Integration/02. Identity Provider Management/01. Summary.md index 4d56cc74f..1151b5c44 100644 --- a/docs/02. Technical Integration/02. Identity Provider Management/01. Summary.md +++ b/docs/02. Technical Integration/02. Identity Provider Management/01. Summary.md @@ -6,8 +6,16 @@ The IdP Switch function is used to integrate / connect company idp's or switch b The integration of company idp's is suspected to be the most used scenario when considering the use of idp switch. Companies which want to use their own company authentication can connect their company idp with the catena-x shared idp by using user federation.
-In this scenario - authentication is delivered by the company idp and authorization is still managed inside keycloak. +In this scenario - authentication is delivered by the company idp and authorization is still managed inside Keycloak.
The biggest positive element on ownCompany idp usage is the comfort of the login, as well as the user credentials which are not shared with an operator.
+ +## NOTICE + +This work is licensed under the [Apache-2.0](https://www.apache.org/licenses/LICENSE-2.0). + +- SPDX-License-Identifier: Apache-2.0 +- SPDX-FileCopyrightText: 2021-2023 Contributors to the Eclipse Foundation +- Source URL: https://github.com/eclipse-tractusx/portal-assets diff --git a/docs/02. Technical Integration/02. Identity Provider Management/02. Company IdPs.md b/docs/02. Technical Integration/02. Identity Provider Management/02. Company IdPs.md index 9692ab1a5..61da41638 100644 --- a/docs/02. Technical Integration/02. Identity Provider Management/02. Company IdPs.md +++ b/docs/02. Technical Integration/02. Identity Provider Management/02. Company IdPs.md @@ -51,9 +51,18 @@ IdP active. Means => the IdP is enabled (enabled=true)
Connected Functions: -* [Configure Company](/docs/02.%20Technical%20Integration/02.%20Identity%20Provider%20Management/02.%20Configure%20Company%20IdP.md) -* [User Migration New IdP](/docs/02.%20Technical%20Integration/02.%20Identity%20Provider%20Management/03.%20User%20Migration.md) -* [User Migration New IdP](/docs/02.%20Technical%20Integration/02.%20Identity%20Provider%20Management/04.%20Identity%20Provider%20Deletion.md) + +- [Configure Company](/docs/02.%20Technical%20Integration/02.%20Identity%20Provider%20Management/02.%20Configure%20Company%20IdP.md) +- [User Migration New IdP](/docs/02.%20Technical%20Integration/02.%20Identity%20Provider%20Management/03.%20User%20Migration.md) +- [User Migration New IdP](/docs/02.%20Technical%20Integration/02.%20Identity%20Provider%20Management/04.%20Identity%20Provider%20Deletion.md)

+ +## NOTICE + +This work is licensed under the [Apache-2.0](https://www.apache.org/licenses/LICENSE-2.0). + +- SPDX-License-Identifier: Apache-2.0 +- SPDX-FileCopyrightText: 2021-2023 Contributors to the Eclipse Foundation +- Source URL: https://github.com/eclipse-tractusx/portal-assets diff --git a/docs/02. Technical Integration/02. Identity Provider Management/02. Configure Company IdP.md b/docs/02. Technical Integration/02. Identity Provider Management/02. Configure Company IdP.md index 8c5f26462..0219cac18 100644 --- a/docs/02. Technical Integration/02. Identity Provider Management/02. Configure Company IdP.md +++ b/docs/02. Technical Integration/02. Identity Provider Management/02. Configure Company IdP.md @@ -29,7 +29,7 @@ Details regarding the IAM architecture (applies for shared as well as own IdP us ### Register your company IdP To register your company idp, login with administration rights and open the "Identity Provider Config" via the top right user navigation. -Inside the config, you will find your current registered (enabled and disabled) identity providers - quite oftne this will only be one identity provider. As well as the option to register a new identity provider (such as you company idp). +Inside the config, you will find your current registered (enabled and disabled) identity providers - quite often this will only be one identity provider. As well as the option to register a new identity provider (such as you company idp).

@@ -41,9 +41,10 @@ Inside the config, you will find your current registered (enabled and disabled)

- Please note - for the company identity provider conenction you will need to prepare certain information to be able to connect your company IdP. Please ansure that all necessary information are available. + Please note - for the company identity provider connection you will need to prepare certain information to be able to connect your company IdP. Please ensure that all necessary information are available. + +Currently only the connection for OIDC idp's is supported. -Currenly only the connection for OIDC idp's is supported.

@@ -51,9 +52,10 @@ Currenly only the connection for OIDC idp's is supported. Click on "Add Identity Provider" to start the registration. Inside the overlay the -* idp display name - used for the login company card (users which try to login to CX will see this display name. Use a name which users can understand and know that this belongs to their company) -* identity provider type - "managed" for onboarding service provider/3rd party acting company and "own" for company owned idps -
+ +- idp display name - used for the login company card (users which try to login to CX will see this display name. Use a name which users can understand and know that this belongs to their company) +- identity provider type - "managed" for onboarding service provider/3rd party acting company and "own" for company owned IdPs +

image @@ -77,7 +79,7 @@ Those are
-if the config was sucessful, you will get asked to add your personal company idp unique identifier. In this step you will connect your exosting catena-x user account (with your already assigned roles and customized configurations) with your company IdP. To do this successfully, you need to add your company IdP unqiue ID. +if the config was successful, you will get asked to add your personal company idp unique identifier. In this step you will connect your existing catena-x user account (with your already assigned roles and customized configurations) with your company IdP. To do this successfully, you need to add your company IdP unique ID.

@@ -99,5 +101,10 @@ Please note: in this moment, your user is connected with the Catena-X Shared IdP Connected Content: [User Migration New IdP](/docs/02.%20Technical%20Integration/02.%20Identity%20Provider%20Management/03.%20User%20Migration.md) +## NOTICE +This work is licensed under the [Apache-2.0](https://www.apache.org/licenses/LICENSE-2.0). +- SPDX-License-Identifier: Apache-2.0 +- SPDX-FileCopyrightText: 2021-2023 Contributors to the Eclipse Foundation +- Source URL: https://github.com/eclipse-tractusx/portal-assets diff --git a/docs/02. Technical Integration/02. Identity Provider Management/03. User Migration.md b/docs/02. Technical Integration/02. Identity Provider Management/03. User Migration.md index 58ef81e2a..b645bc9b0 100644 --- a/docs/02. Technical Integration/02. Identity Provider Management/03. User Migration.md +++ b/docs/02. Technical Integration/02. Identity Provider Management/03. User Migration.md @@ -22,7 +22,7 @@ By clicking on the "Users" sub-navigation icon, a overlay with the user migratio
Download the list and add for each user, which is supposed to get migrated to the new IdP. -When opening the csv, add the users identity provider user id in the respective available section - see screenhot below - and upload the csv file as soon as all respective data are added. +When opening the csv, add the users identity provider user id in the respective available section - see screenshot below - and upload the csv file as soon as all respective data are added. Example below shows how to fill the csv file which got downloaded by the IT Admin. In the example 2 users are existing and supposed to get connected to the idp88. Therefor the admin adds for each user the providerUserId and providerUsername. Note: for unique identification the providerUserId is relevant, the userName is only used for reference. @@ -34,7 +34,7 @@ Therefor the admin adds for each user the providerUserId and providerUsername. N
As soon as the csv is ready, upload the file by placing it inside the dropzone area of the overlay and press "Upload User List" on the bottom. The upload includes the update of all those user connection inside the platform IdP by adding the new IdP connection to each of the users. -In case any error occurs, details of the uplaod errors will get displayed per user: +In case any error occurs, details of the upload errors will get displayed per user:

@@ -50,3 +50,11 @@ After the successful config, the new IdP can get enabled and the old IdP can get

+ +## NOTICE + +This work is licensed under the [Apache-2.0](https://www.apache.org/licenses/LICENSE-2.0). + +- SPDX-License-Identifier: Apache-2.0 +- SPDX-FileCopyrightText: 2021-2023 Contributors to the Eclipse Foundation +- Source URL: https://github.com/eclipse-tractusx/portal-assets diff --git a/docs/02. Technical Integration/02. Identity Provider Management/04. Identity Provider Deletion.md b/docs/02. Technical Integration/02. Identity Provider Management/04. Identity Provider Deletion.md index 8e9217721..948597272 100644 --- a/docs/02. Technical Integration/02. Identity Provider Management/04. Identity Provider Deletion.md +++ b/docs/02. Technical Integration/02. Identity Provider Management/04. Identity Provider Deletion.md @@ -13,3 +13,11 @@ If there are users assigned to this IdP only, those users won't be able to login

+ +## NOTICE + +This work is licensed under the [Apache-2.0](https://www.apache.org/licenses/LICENSE-2.0). + +- SPDX-License-Identifier: Apache-2.0 +- SPDX-FileCopyrightText: 2021-2023 Contributors to the Eclipse Foundation +- Source URL: https://github.com/eclipse-tractusx/portal-assets diff --git a/docs/02. Technical Integration/02. Identity Provider Management/05. Disable Identity Provider.md b/docs/02. Technical Integration/02. Identity Provider Management/05. Disable Identity Provider.md index a8550e633..7482bb542 100644 --- a/docs/02. Technical Integration/02. Identity Provider Management/05. Disable Identity Provider.md +++ b/docs/02. Technical Integration/02. Identity Provider Management/05. Disable Identity Provider.md @@ -12,3 +12,11 @@ The disablement of IdPs supports the user to delete the IdP in a later stage.

+ +## NOTICE + +This work is licensed under the [Apache-2.0](https://www.apache.org/licenses/LICENSE-2.0). + +- SPDX-License-Identifier: Apache-2.0 +- SPDX-FileCopyrightText: 2021-2023 Contributors to the Eclipse Foundation +- Source URL: https://github.com/eclipse-tractusx/portal-assets diff --git a/docs/02. Technical Integration/02. Identity Provider Management/06. FAQ.md b/docs/02. Technical Integration/02. Identity Provider Management/06. FAQ.md index 33b87cda5..00a332d0c 100644 --- a/docs/02. Technical Integration/02. Identity Provider Management/06. FAQ.md +++ b/docs/02. Technical Integration/02. Identity Provider Management/06. FAQ.md @@ -1,31 +1,44 @@ ### FAQ +
#### What do the different IDP types stand for -IdP types are defined to differenciate between the different IdP owner/managed. + +IdP types are defined to differentiate between the different IdP owner/managed.
| Type | Description | Owner | User | -|---------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------------------------------------------------------------------------|-------------------------------------------------------------------------------| -| Shared | IdP Instance/Tenant provided by the platform operator. Kind of managed IdP. | Platform Operator | Platform Customer | -| Own | Own company IdP connected via federation with the platform operator IdP. | CX Participant (Company which created the IdP connection - Platform Customer) | CX Participant (Company which created the IdP connection - Platform Customer) | +| ------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------- | ----------------------------------------------------------------------------- | +| Shared | IdP Instance/Tenant provided by the platform operator. Kind of managed IdP. | Platform Operator | Platform Customer | +| Own | Own company IdP connected via federation with the platform operator IdP. | CX Participant (Company which created the IdP connection - Platform Customer) | CX Participant (Company which created the IdP connection - Platform Customer) | | Managed | IdP managed by a 3rd party for a CX dataspace participant. E.g. an IdP of an Onboarding service provider which is managing the user logins for several OSP customers. | Onboarding Service Provider (3rd Party) | CX Particpant |

#### Can I have multiple active IdPs? + Yes, it is possible to have multiple active IdPs - however note that it might result into an extended administrative work to manage a huge number of users across multiple IdPs. IdP owners are always requested to keep the number of active IdP connections to a minimum.

#### Is SAML supported? + SAML is not supported by the CX dataspace. As per the standards OIDC is used for all interactions.

#### If I connect my company IdP with the platform IdP - which data will get logged by the platform IdP? + ---- to be added -----

+ +## NOTICE + +This work is licensed under the [Apache-2.0](https://www.apache.org/licenses/LICENSE-2.0). + +- SPDX-License-Identifier: Apache-2.0 +- SPDX-FileCopyrightText: 2021-2023 Contributors to the Eclipse Foundation +- Source URL: https://github.com/eclipse-tractusx/portal-assets diff --git a/docs/02. Technical Integration/02. Identity Provider Management/index.md b/docs/02. Technical Integration/02. Identity Provider Management/index.md index 1a98780dd..3a2bccfa3 100644 --- a/docs/02. Technical Integration/02. Identity Provider Management/index.md +++ b/docs/02. Technical Integration/02. Identity Provider Management/index.md @@ -10,3 +10,11 @@

+ +## NOTICE + +This work is licensed under the [Apache-2.0](https://www.apache.org/licenses/LICENSE-2.0). + +- SPDX-License-Identifier: Apache-2.0 +- SPDX-FileCopyrightText: 2021-2023 Contributors to the Eclipse Foundation +- Source URL: https://github.com/eclipse-tractusx/portal-assets diff --git a/docs/02. Technical Integration/03. CX Membership/01. Open API.md b/docs/02. Technical Integration/03. CX Membership/01. Open API.md index 2e49674c5..0bbe95eef 100644 --- a/docs/02. Technical Integration/03. CX Membership/01. Open API.md +++ b/docs/02. Technical Integration/03. CX Membership/01. Open API.md @@ -36,3 +36,11 @@ the string response includes all bpn's of active network members

+ +## NOTICE + +This work is licensed under the [Apache-2.0](https://www.apache.org/licenses/LICENSE-2.0). + +- SPDX-License-Identifier: Apache-2.0 +- SPDX-FileCopyrightText: 2021-2023 Contributors to the Eclipse Foundation +- Source URL: https://github.com/eclipse-tractusx/portal-assets diff --git a/docs/02. Technical Integration/03. CX Membership/index.md b/docs/02. Technical Integration/03. CX Membership/index.md index 3be5ad1db..f240bfee0 100644 --- a/docs/02. Technical Integration/03. CX Membership/index.md +++ b/docs/02. Technical Integration/03. CX Membership/index.md @@ -4,3 +4,11 @@

+ +## NOTICE + +This work is licensed under the [Apache-2.0](https://www.apache.org/licenses/LICENSE-2.0). + +- SPDX-License-Identifier: Apache-2.0 +- SPDX-FileCopyrightText: 2021-2023 Contributors to the Eclipse Foundation +- Source URL: https://github.com/eclipse-tractusx/portal-assets diff --git a/docs/02. Technical Integration/04. Dataspace Discovery/01. Open API.md b/docs/02. Technical Integration/04. Dataspace Discovery/01. Open API.md index 3a1e6b8f8..a5ff5be2f 100644 --- a/docs/02. Technical Integration/04. Dataspace Discovery/01. Open API.md +++ b/docs/02. Technical Integration/04. Dataspace Discovery/01. Open API.md @@ -65,3 +65,11 @@ In case of an empty response, no edc is found for the requested BPNs

+ +## NOTICE + +This work is licensed under the [Apache-2.0](https://www.apache.org/licenses/LICENSE-2.0). + +- SPDX-License-Identifier: Apache-2.0 +- SPDX-FileCopyrightText: 2021-2023 Contributors to the Eclipse Foundation +- Source URL: https://github.com/eclipse-tractusx/portal-assets diff --git a/docs/02. Technical Integration/04. Dataspace Discovery/index.md b/docs/02. Technical Integration/04. Dataspace Discovery/index.md index 46fddf977..f54466435 100644 --- a/docs/02. Technical Integration/04. Dataspace Discovery/index.md +++ b/docs/02. Technical Integration/04. Dataspace Discovery/index.md @@ -4,3 +4,11 @@

+ +## NOTICE + +This work is licensed under the [Apache-2.0](https://www.apache.org/licenses/LICENSE-2.0). + +- SPDX-License-Identifier: Apache-2.0 +- SPDX-FileCopyrightText: 2021-2023 Contributors to the Eclipse Foundation +- Source URL: https://github.com/eclipse-tractusx/portal-assets diff --git a/docs/02. Technical Integration/05. Company Role/Change Company Role.md b/docs/02. Technical Integration/05. Company Role/Change Company Role.md index 70eb31965..62d6b26bf 100644 --- a/docs/02. Technical Integration/05. Company Role/Change Company Role.md +++ b/docs/02. Technical Integration/05. Company Role/Change Company Role.md @@ -34,7 +34,7 @@ To update the company role, follow the following steps.
With the "Submit" selection the overlay with the change details as well as the required term & condition approval are getting displayed. -If the user approved all the necessary T&Cs the role change can get commited and will get effective in the same moment +If the user approved all the necessary T&Cs the role change can get committed and will get effective in the same moment

image @@ -42,3 +42,11 @@ If the user approved all the necessary T&Cs the role change can get commited and

+ +## NOTICE + +This work is licensed under the [Apache-2.0](https://www.apache.org/licenses/LICENSE-2.0). + +- SPDX-License-Identifier: Apache-2.0 +- SPDX-FileCopyrightText: 2021-2023 Contributors to the Eclipse Foundation +- Source URL: https://github.com/eclipse-tractusx/portal-assets diff --git a/docs/02. Technical Integration/05. Company Role/index.md b/docs/02. Technical Integration/05. Company Role/index.md index b42f8b2a3..d3ac3efba 100644 --- a/docs/02. Technical Integration/05. Company Role/index.md +++ b/docs/02. Technical Integration/05. Company Role/index.md @@ -4,3 +4,11 @@

+ +## NOTICE + +This work is licensed under the [Apache-2.0](https://www.apache.org/licenses/LICENSE-2.0). + +- SPDX-License-Identifier: Apache-2.0 +- SPDX-FileCopyrightText: 2021-2023 Contributors to the Eclipse Foundation +- Source URL: https://github.com/eclipse-tractusx/portal-assets diff --git a/docs/02. Technical Integration/index.md b/docs/02. Technical Integration/index.md index 219b103ea..d4139a0d9 100644 --- a/docs/02. Technical Integration/index.md +++ b/docs/02. Technical Integration/index.md @@ -6,3 +6,11 @@ Read more details in the following sections: - [Connector Registration](./01.%20Connector%20Registration/) - [Identity Provider Management](./02.%20Identity%20Provider%20Management/) + +## NOTICE + +This work is licensed under the [Apache-2.0](https://www.apache.org/licenses/LICENSE-2.0). + +- SPDX-License-Identifier: Apache-2.0 +- SPDX-FileCopyrightText: 2021-2023 Contributors to the Eclipse Foundation +- Source URL: https://github.com/eclipse-tractusx/portal-assets diff --git a/docs/03. User Management/01. User Account/01. Summary.md b/docs/03. User Management/01. User Account/01. Summary.md index 8be0c8fa4..0426db951 100644 --- a/docs/03. User Management/01. User Account/01. Summary.md +++ b/docs/03. User Management/01. User Account/01. Summary.md @@ -1,7 +1,15 @@ # Summary Company Administrators as well as IT Administrators of the company can create new user accounts. -With the Catena-X user account, the user can access the Catena-X Portal including the apps marketspace, direct access to subscribed company apps, semantic data models, digital twins, service offers, etc. +With the Catena-X user account, the user can access the Catena-X Portal including the apps marketplace, direct access to subscribed company apps, semantic data models, digital twins, service offers, etc.

+ +## NOTICE + +This work is licensed under the [Apache-2.0](https://www.apache.org/licenses/LICENSE-2.0). + +- SPDX-License-Identifier: Apache-2.0 +- SPDX-FileCopyrightText: 2021-2023 Contributors to the Eclipse Foundation +- Source URL: https://github.com/eclipse-tractusx/portal-assets diff --git a/docs/03. User Management/01. User Account/02. User Account.md b/docs/03. User Management/01. User Account/02. User Account.md index 61dbac3e3..53ee9525c 100644 --- a/docs/03. User Management/01. User Account/02. User Account.md +++ b/docs/03. User Management/01. User Account/02. User Account.md @@ -10,3 +10,11 @@ Only those users created under the same company account can get viewed. Users cr

+ +## NOTICE + +This work is licensed under the [Apache-2.0](https://www.apache.org/licenses/LICENSE-2.0). + +- SPDX-License-Identifier: Apache-2.0 +- SPDX-FileCopyrightText: 2021-2023 Contributors to the Eclipse Foundation +- Source URL: https://github.com/eclipse-tractusx/portal-assets diff --git a/docs/03. User Management/01. User Account/03. Create new user account (single).md b/docs/03. User Management/01. User Account/03. Create new user account (single).md index 801a22e96..d644146bc 100644 --- a/docs/03. User Management/01. User Account/03. Create new user account (single).md +++ b/docs/03. User Management/01. User Account/03. Create new user account (single).md @@ -28,3 +28,11 @@ Via an click on the link, the role descriptions can get viewed.

+ +## NOTICE + +This work is licensed under the [Apache-2.0](https://www.apache.org/licenses/LICENSE-2.0). + +- SPDX-License-Identifier: Apache-2.0 +- SPDX-FileCopyrightText: 2021-2023 Contributors to the Eclipse Foundation +- Source URL: https://github.com/eclipse-tractusx/portal-assets diff --git a/docs/03. User Management/01. User Account/04. Create new user account (bulk).md b/docs/03. User Management/01. User Account/04. Create new user account (bulk).md index cd11e220c..c5145678e 100644 --- a/docs/03. User Management/01. User Account/04. Create new user account (bulk).md +++ b/docs/03. User Management/01. User Account/04. Create new user account (bulk).md @@ -1,3 +1,11 @@ ## Create a new user account (bulk) Currently not supported + +## NOTICE + +This work is licensed under the [Apache-2.0](https://www.apache.org/licenses/LICENSE-2.0). + +- SPDX-License-Identifier: Apache-2.0 +- SPDX-FileCopyrightText: 2021-2023 Contributors to the Eclipse Foundation +- Source URL: https://github.com/eclipse-tractusx/portal-assets diff --git a/docs/03. User Management/01. User Account/05. FAQ.md b/docs/03. User Management/01. User Account/05. FAQ.md index 569bc2289..f123d2068 100644 --- a/docs/03. User Management/01. User Account/05. FAQ.md +++ b/docs/03. User Management/01. User Account/05. FAQ.md @@ -17,3 +17,11 @@ No, user deletions can't get reverted. #### If my/a user has 2 idp connections, will the user deletion delete both idp connections? Yes, even with multiple idp connections, the user deletion will work as planned. The user access will get reverted and the user account details will get deleted. + +## NOTICE + +This work is licensed under the [Apache-2.0](https://www.apache.org/licenses/LICENSE-2.0). + +- SPDX-License-Identifier: Apache-2.0 +- SPDX-FileCopyrightText: 2021-2023 Contributors to the Eclipse Foundation +- Source URL: https://github.com/eclipse-tractusx/portal-assets diff --git a/docs/03. User Management/01. User Account/index.md b/docs/03. User Management/01. User Account/index.md index 76bb87e9c..9922d8646 100644 --- a/docs/03. User Management/01. User Account/index.md +++ b/docs/03. User Management/01. User Account/index.md @@ -11,3 +11,11 @@ Read more details in the following sections:

+ +## NOTICE + +This work is licensed under the [Apache-2.0](https://www.apache.org/licenses/LICENSE-2.0). + +- SPDX-License-Identifier: Apache-2.0 +- SPDX-FileCopyrightText: 2021-2023 Contributors to the Eclipse Foundation +- Source URL: https://github.com/eclipse-tractusx/portal-assets diff --git a/docs/03. User Management/02. Modify User Account/01. Summary.md b/docs/03. User Management/02. Modify User Account/01. Summary.md index e047ea9f7..6dc8b3157 100644 --- a/docs/03. User Management/02. Modify User Account/01. Summary.md +++ b/docs/03. User Management/02. Modify User Account/01. Summary.md @@ -9,3 +9,11 @@ The "User Account Details" function is a detailed view of one user, which the co The "My User Account Details" function is a detailed view of your own user account and can get viewed by the user owner only. image + +## NOTICE + +This work is licensed under the [Apache-2.0](https://www.apache.org/licenses/LICENSE-2.0). + +- SPDX-License-Identifier: Apache-2.0 +- SPDX-FileCopyrightText: 2021-2023 Contributors to the Eclipse Foundation +- Source URL: https://github.com/eclipse-tractusx/portal-assets diff --git a/docs/03. User Management/02. Modify User Account/02. Password Reset.md b/docs/03. User Management/02. Modify User Account/02. Password Reset.md index 5d2c601da..3dcd24bb7 100644 --- a/docs/03. User Management/02. Modify User Account/02. Password Reset.md +++ b/docs/03. User Management/02. Modify User Account/02. Password Reset.md @@ -23,3 +23,11 @@ The picture below includes the service details - take user id handed over by FE - transfer the user id to the centralIdP user id (via iam_user) table - transfer centralIdP user id to sharedIdP user id + +## NOTICE + +This work is licensed under the [Apache-2.0](https://www.apache.org/licenses/LICENSE-2.0). + +- SPDX-License-Identifier: Apache-2.0 +- SPDX-FileCopyrightText: 2021-2023 Contributors to the Eclipse Foundation +- Source URL: https://github.com/eclipse-tractusx/portal-assets diff --git a/docs/03. User Management/02. Modify User Account/03. User Permissions.md b/docs/03. User Management/02. Modify User Account/03. User Permissions.md index 3a4379637..4bc5fc167 100644 --- a/docs/03. User Management/02. Modify User Account/03. User Permissions.md +++ b/docs/03. User Management/02. Modify User Account/03. User Permissions.md @@ -10,7 +10,7 @@ Normal users can only view their own user account via "my user account". ### Portal Assigned Roles -Administration users can change company users assigned portal roles by using the "User Managamenet" -> "Identity Management" -> Edit User Account by clicking on "Details" -> scroll down to section "Assigned Catena-X Portal Roles" +Administration users can change company users assigned portal roles by using the "User Management" -> "Identity Management" -> Edit User Account by clicking on "Details" -> scroll down to section "Assigned Catena-X Portal Roles"
Assigned users portal role are visible, additionally, with the necessary rights, the roles can get adjusted by clicking on "Change Portal Role" @@ -36,7 +36,7 @@ Inide the pop-up, select or unselect the respective roles and click on "Confirm" ### App Assigned Roles -To change user assigned app roles, open the "User Managamenet" -> "App Access Management" -> Click on the relevant App -> scroll down to "App Access Management" -> select the respective user inside the table/list and click on "Edit" +To change user assigned app roles, open the "User Management" -> "App Access Management" -> Click on the relevant App -> scroll down to "App Access Management" -> select the respective user inside the table/list and click on "Edit"

@@ -55,3 +55,11 @@ Select/Unselect the respective roles for the user and click confirm to submit th

+ +## NOTICE + +This work is licensed under the [Apache-2.0](https://www.apache.org/licenses/LICENSE-2.0). + +- SPDX-License-Identifier: Apache-2.0 +- SPDX-FileCopyrightText: 2021-2023 Contributors to the Eclipse Foundation +- Source URL: https://github.com/eclipse-tractusx/portal-assets diff --git a/docs/03. User Management/02. Modify User Account/04. Manage user assigned BPN.md b/docs/03. User Management/02. Modify User Account/04. Manage user assigned BPN.md index 9ae124698..507b934e4 100644 --- a/docs/03. User Management/02. Modify User Account/04. Manage user assigned BPN.md +++ b/docs/03. User Management/02. Modify User Account/04. Manage user assigned BPN.md @@ -20,3 +20,11 @@ Inside the overlay the "delete" icon can get used to delete an assigned bpn. image

+ +## NOTICE + +This work is licensed under the [Apache-2.0](https://www.apache.org/licenses/LICENSE-2.0). + +- SPDX-License-Identifier: Apache-2.0 +- SPDX-FileCopyrightText: 2021-2023 Contributors to the Eclipse Foundation +- Source URL: https://github.com/eclipse-tractusx/portal-assets diff --git a/docs/03. User Management/02. Modify User Account/05. Suspend User.md b/docs/03. User Management/02. Modify User Account/05. Suspend User.md index 69f15e3cb..1cec317a9 100644 --- a/docs/03. User Management/02. Modify User Account/05. Suspend User.md +++ b/docs/03. User Management/02. Modify User Account/05. Suspend User.md @@ -1,3 +1,11 @@ # Suspend User currently not supported + +## NOTICE + +This work is licensed under the [Apache-2.0](https://www.apache.org/licenses/LICENSE-2.0). + +- SPDX-License-Identifier: Apache-2.0 +- SPDX-FileCopyrightText: 2021-2023 Contributors to the Eclipse Foundation +- Source URL: https://github.com/eclipse-tractusx/portal-assets diff --git a/docs/03. User Management/02. Modify User Account/06. Delete User.md b/docs/03. User Management/02. Modify User Account/06. Delete User.md index 1239cf535..0a7c18a63 100644 --- a/docs/03. User Management/02. Modify User Account/06. Delete User.md +++ b/docs/03. User Management/02. Modify User Account/06. Delete User.md @@ -1,6 +1,6 @@ ## Delete User -Inside the portal, a user will be able to delete an user - the function is differentiated into 2 functions +Inside the portal, a user will be able to delete an user - the function is differentiated into two functions - Delete your own user account - Delete an user account of a user inside your organization (only available for the IT Administrator) @@ -30,3 +30,11 @@ More details to the audit logging can get found here: [Audit Log Details](/devel image

+ +## NOTICE + +This work is licensed under the [Apache-2.0](https://www.apache.org/licenses/LICENSE-2.0). + +- SPDX-License-Identifier: Apache-2.0 +- SPDX-FileCopyrightText: 2021-2023 Contributors to the Eclipse Foundation +- Source URL: https://github.com/eclipse-tractusx/portal-assets diff --git a/docs/03. User Management/02. Modify User Account/index.md b/docs/03. User Management/02. Modify User Account/index.md index 49bf7c2fc..d9c1881ed 100644 --- a/docs/03. User Management/02. Modify User Account/index.md +++ b/docs/03. User Management/02. Modify User Account/index.md @@ -16,3 +16,11 @@ Inside the user account page, a number of services/actions can get triggered.

+ +## NOTICE + +This work is licensed under the [Apache-2.0](https://www.apache.org/licenses/LICENSE-2.0). + +- SPDX-License-Identifier: Apache-2.0 +- SPDX-FileCopyrightText: 2021-2023 Contributors to the Eclipse Foundation +- Source URL: https://github.com/eclipse-tractusx/portal-assets diff --git a/docs/03. User Management/03. Technical User/01. Technical User Overview.md b/docs/03. User Management/03. Technical User/01. Technical User Overview.md index 018fcb3f5..2f1d7ea9b 100644 --- a/docs/03. User Management/03. Technical User/01. Technical User Overview.md +++ b/docs/03. User Management/03. Technical User/01. Technical User Overview.md @@ -17,3 +17,11 @@ Inside the Technical User Management page administrator users can



+ +## NOTICE + +This work is licensed under the [Apache-2.0](https://www.apache.org/licenses/LICENSE-2.0). + +- SPDX-License-Identifier: Apache-2.0 +- SPDX-FileCopyrightText: 2021-2023 Contributors to the Eclipse Foundation +- Source URL: https://github.com/eclipse-tractusx/portal-assets diff --git a/docs/03. User Management/03. Technical User/02. Create Technical User.md b/docs/03. User Management/03. Technical User/02. Create Technical User.md index ab2770af3..2190dea98 100644 --- a/docs/03. User Management/03. Technical User/02. Create Technical User.md +++ b/docs/03. User Management/03. Technical User/02. Create Technical User.md @@ -10,13 +10,14 @@ In the Catena-X dataspace, following technical users are provided to all members
#### Available technical user roles -* Identity Wallet Management (technical user to access own company wallet - request VC, request VP, store VC, etc.) -* BPDM Pool (technical user to connect to the BPDM Data Pool) -* BPDM Partner Gate (allows to view and add business partner data via the owned service gate) -* BPDM Management (View, Add and Delete business partner records from the business partner data pool) -* Dataspace Discovery (technical user for dataspace discovery endpoints) -* Offer Management (technical user to add offers; activate subscription requests and create managed connector registrations for 3rd parties) -* Registration External (Technical user to generate 3rd party registrations by onboarding service provider companies) + +- Identity Wallet Management (technical user to access own company wallet - request VC, request VP, store VC, etc.) +- BPDM Pool (technical user to connect to the BPDM Data Pool) +- BPDM Partner Gate (allows to view and add business partner data via the owned service gate) +- BPDM Management (View, Add and Delete business partner records from the business partner data pool) +- Dataspace Discovery (technical user for dataspace discovery endpoints) +- Offer Management (technical user to add offers; activate subscription requests and create managed connector registrations for 3rd parties) +- Registration External (Technical user to generate 3rd party registrations by onboarding service provider companies)

@@ -26,12 +27,12 @@ In the Catena-X dataspace, following technical users are provided to all members > depending on the user assigned company roles, not all technical user roles might ba available for technical user creations. > The table below shows available technical user roles based on the company role > -> Company Role | Technical User Profile -> --- | --- -> CX Participant | * BPDM Pool
* Dataspace Discovery
* Identity Wallet Management
* Semantic Model Management
* CX Membership Info -> App Provider | * BPDM Pool
* Dataspace Discovery
* Identity Wallet Management
* Offer Management
* Semantic Model Management
* CX Membership Info -> Service Provider | * BPDM Pool
* Dataspace Discovery
* Identity Wallet Management
* Offer Management
* Semantic Model Management
* CX Membership Info -> Onboarding Service Provider | * External Registration +> | Company Role | Technical User Profile | +> | --------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | +> | CX Participant | _ BPDM Pool
_ Dataspace Discovery
_ Identity Wallet Management
_ Semantic Model Management
\* CX Membership Info | +> | App Provider | _ BPDM Pool
_ Dataspace Discovery
_ Identity Wallet Management
_ Offer Management
_ Semantic Model Management
_ CX Membership Info | +> | Service Provider | _ BPDM Pool
_ Dataspace Discovery
_ Identity Wallet Management
_ Offer Management
_ Semantic Model Management
_ CX Membership Info | +> | Onboarding Service Provider | \* External Registration |

@@ -80,3 +81,11 @@ With the shared user_id and secret, the technical user can get used to authentic ## Further information [Technical User Creation in the name of a customer](/docs/03.%20User%20Management/03.%20Technical%20User/04.%20FAQ.md#as-a-service-or-app-provider-am-i-able-to-create-a-technical-user-in-the-name-of-my-appservice-customer) + +## NOTICE + +This work is licensed under the [Apache-2.0](https://www.apache.org/licenses/LICENSE-2.0). + +- SPDX-License-Identifier: Apache-2.0 +- SPDX-FileCopyrightText: 2021-2023 Contributors to the Eclipse Foundation +- Source URL: https://github.com/eclipse-tractusx/portal-assets diff --git a/docs/03. User Management/03. Technical User/03. Delete Technical User.md b/docs/03. User Management/03. Technical User/03. Delete Technical User.md index 280750993..8ae1866c8 100644 --- a/docs/03. User Management/03. Technical User/03. Delete Technical User.md +++ b/docs/03. User Management/03. Technical User/03. Delete Technical User.md @@ -26,3 +26,11 @@ In case of an service account linked active subscription, the deletion will not

+ +## NOTICE + +This work is licensed under the [Apache-2.0](https://www.apache.org/licenses/LICENSE-2.0). + +- SPDX-License-Identifier: Apache-2.0 +- SPDX-FileCopyrightText: 2021-2023 Contributors to the Eclipse Foundation +- Source URL: https://github.com/eclipse-tractusx/portal-assets diff --git a/docs/03. User Management/03. Technical User/04. FAQ.md b/docs/03. User Management/03. Technical User/04. FAQ.md index fa9f6e492..5bec4df6f 100644 --- a/docs/03. User Management/03. Technical User/04. FAQ.md +++ b/docs/03. User Management/03. Technical User/04. FAQ.md @@ -38,3 +38,11 @@ access token jwt

+ +## NOTICE + +This work is licensed under the [Apache-2.0](https://www.apache.org/licenses/LICENSE-2.0). + +- SPDX-License-Identifier: Apache-2.0 +- SPDX-FileCopyrightText: 2021-2023 Contributors to the Eclipse Foundation +- Source URL: https://github.com/eclipse-tractusx/portal-assets diff --git a/docs/03. User Management/03. Technical User/04. Reset Credentials.md b/docs/03. User Management/03. Technical User/04. Reset Credentials.md index 48d349a3a..29260739d 100644 --- a/docs/03. User Management/03. Technical User/04. Reset Credentials.md +++ b/docs/03. User Management/03. Technical User/04. Reset Credentials.md @@ -27,3 +27,11 @@ By clicking on the "Reset" button, the credential will get updated and automatic

+ +## NOTICE + +This work is licensed under the [Apache-2.0](https://www.apache.org/licenses/LICENSE-2.0). + +- SPDX-License-Identifier: Apache-2.0 +- SPDX-FileCopyrightText: 2021-2023 Contributors to the Eclipse Foundation +- Source URL: https://github.com/eclipse-tractusx/portal-assets diff --git a/docs/03. User Management/03. Technical User/index.md b/docs/03. User Management/03. Technical User/index.md index 8e52e5188..0dcbbf48b 100644 --- a/docs/03. User Management/03. Technical User/index.md +++ b/docs/03. User Management/03. Technical User/index.md @@ -15,3 +15,11 @@ CX Member companies can create technical users on their need(s) and map them to

+ +## NOTICE + +This work is licensed under the [Apache-2.0](https://www.apache.org/licenses/LICENSE-2.0). + +- SPDX-License-Identifier: Apache-2.0 +- SPDX-FileCopyrightText: 2021-2023 Contributors to the Eclipse Foundation +- Source URL: https://github.com/eclipse-tractusx/portal-assets diff --git a/docs/03. User Management/04. Assign App Roles/01. App Access Management Overview.md b/docs/03. User Management/04. Assign App Roles/01. App Access Management Overview.md index f1ba926cf..1a56895b1 100644 --- a/docs/03. User Management/04. Assign App Roles/01. App Access Management Overview.md +++ b/docs/03. User Management/04. Assign App Roles/01. App Access Management Overview.md @@ -10,3 +10,11 @@ The assigned role enables the user to access the application.

+ +## NOTICE + +This work is licensed under the [Apache-2.0](https://www.apache.org/licenses/LICENSE-2.0). + +- SPDX-License-Identifier: Apache-2.0 +- SPDX-FileCopyrightText: 2021-2023 Contributors to the Eclipse Foundation +- Source URL: https://github.com/eclipse-tractusx/portal-assets diff --git a/docs/03. User Management/04. Assign App Roles/02. Assign User App Role(s).md b/docs/03. User Management/04. Assign App Roles/02. Assign User App Role(s).md index c808dcc97..a762fbc7d 100644 --- a/docs/03. User Management/04. Assign App Roles/02. Assign User App Role(s).md +++ b/docs/03. User Management/04. Assign App Roles/02. Assign User App Role(s).md @@ -14,3 +14,11 @@ To enable users to access an application, minimum one application app need to ge

+ +## NOTICE + +This work is licensed under the [Apache-2.0](https://www.apache.org/licenses/LICENSE-2.0). + +- SPDX-License-Identifier: Apache-2.0 +- SPDX-FileCopyrightText: 2021-2023 Contributors to the Eclipse Foundation +- Source URL: https://github.com/eclipse-tractusx/portal-assets diff --git a/docs/03. User Management/04. Assign App Roles/03. Update Users Assigned App Role(s).md b/docs/03. User Management/04. Assign App Roles/03. Update Users Assigned App Role(s).md index edfba94c9..7f83d22c8 100644 --- a/docs/03. User Management/04. Assign App Roles/03. Update Users Assigned App Role(s).md +++ b/docs/03. User Management/04. Assign App Roles/03. Update Users Assigned App Role(s).md @@ -1,6 +1,6 @@ ## Update User Assigned App Role -User assigned app roless can get easily modified via the user role edit button. +User assigned app roles can get easily modified via the user role edit button. image @@ -9,3 +9,11 @@ With the confirmation the user role change is taking place.

+ +## NOTICE + +This work is licensed under the [Apache-2.0](https://www.apache.org/licenses/LICENSE-2.0). + +- SPDX-License-Identifier: Apache-2.0 +- SPDX-FileCopyrightText: 2021-2023 Contributors to the Eclipse Foundation +- Source URL: https://github.com/eclipse-tractusx/portal-assets diff --git a/docs/03. User Management/04. Assign App Roles/04. FAQ.md b/docs/03. User Management/04. Assign App Roles/04. FAQ.md index e69de29bb..b120a978a 100644 --- a/docs/03. User Management/04. Assign App Roles/04. FAQ.md +++ b/docs/03. User Management/04. Assign App Roles/04. FAQ.md @@ -0,0 +1,7 @@ +## NOTICE + +This work is licensed under the [Apache-2.0](https://www.apache.org/licenses/LICENSE-2.0). + +- SPDX-License-Identifier: Apache-2.0 +- SPDX-FileCopyrightText: 2021-2023 Contributors to the Eclipse Foundation +- Source URL: https://github.com/eclipse-tractusx/portal-assets diff --git a/docs/03. User Management/04. Assign App Roles/index.md b/docs/03. User Management/04. Assign App Roles/index.md index d47819b78..52889ad57 100644 --- a/docs/03. User Management/04. Assign App Roles/index.md +++ b/docs/03. User Management/04. Assign App Roles/index.md @@ -11,3 +11,11 @@ The App Access Management page include information about

+ +## NOTICE + +This work is licensed under the [Apache-2.0](https://www.apache.org/licenses/LICENSE-2.0). + +- SPDX-License-Identifier: Apache-2.0 +- SPDX-FileCopyrightText: 2021-2023 Contributors to the Eclipse Foundation +- Source URL: https://github.com/eclipse-tractusx/portal-assets diff --git a/docs/03. User Management/index.md b/docs/03. User Management/index.md index ad59bf7f5..ac0f938f9 100644 --- a/docs/03. User Management/index.md +++ b/docs/03. User Management/index.md @@ -11,3 +11,11 @@ Read more details in the following sections:

+ +## NOTICE + +This work is licensed under the [Apache-2.0](https://www.apache.org/licenses/LICENSE-2.0). + +- SPDX-License-Identifier: Apache-2.0 +- SPDX-FileCopyrightText: 2021-2023 Contributors to the Eclipse Foundation +- Source URL: https://github.com/eclipse-tractusx/portal-assets diff --git a/docs/04. App(s)/01. Marketplace/01. App Overview.md b/docs/04. App(s)/01. Marketplace/01. App Overview.md index 11948fbcd..f8100ba08 100644 --- a/docs/04. App(s)/01. Marketplace/01. App Overview.md +++ b/docs/04. App(s)/01. Marketplace/01. App Overview.md @@ -16,3 +16,11 @@ Beside the generic list, apps can get viewed in specific pre-configured views

+ +## NOTICE + +This work is licensed under the [Apache-2.0](https://www.apache.org/licenses/LICENSE-2.0). + +- SPDX-License-Identifier: Apache-2.0 +- SPDX-FileCopyrightText: 2021-2023 Contributors to the Eclipse Foundation +- Source URL: https://github.com/eclipse-tractusx/portal-assets diff --git a/docs/04. App(s)/01. Marketplace/02. App Details.md b/docs/04. App(s)/01. Marketplace/02. App Details.md index 3ef9c6431..e8b82e629 100644 --- a/docs/04. App(s)/01. Marketplace/02. App Details.md +++ b/docs/04. App(s)/01. Marketplace/02. App Details.md @@ -18,3 +18,11 @@ Inside the app details following information will be stored

+ +## NOTICE + +This work is licensed under the [Apache-2.0](https://www.apache.org/licenses/LICENSE-2.0). + +- SPDX-License-Identifier: Apache-2.0 +- SPDX-FileCopyrightText: 2021-2023 Contributors to the Eclipse Foundation +- Source URL: https://github.com/eclipse-tractusx/portal-assets diff --git a/docs/04. App(s)/01. Marketplace/03. App Favorites.md b/docs/04. App(s)/01. Marketplace/03. App Favorites.md index bae3499f0..d66b7d30e 100644 --- a/docs/04. App(s)/01. Marketplace/03. App Favorites.md +++ b/docs/04. App(s)/01. Marketplace/03. App Favorites.md @@ -12,3 +12,11 @@ Via a click on the plus button, the plus button changes to a checkmark button an

+ +## NOTICE + +This work is licensed under the [Apache-2.0](https://www.apache.org/licenses/LICENSE-2.0). + +- SPDX-License-Identifier: Apache-2.0 +- SPDX-FileCopyrightText: 2021-2023 Contributors to the Eclipse Foundation +- Source URL: https://github.com/eclipse-tractusx/portal-assets diff --git a/docs/04. App(s)/01. Marketplace/04. My Business Apps.md b/docs/04. App(s)/01. Marketplace/04. My Business Apps.md index 52a28c288..9d50478dc 100644 --- a/docs/04. App(s)/01. Marketplace/04. My Business Apps.md +++ b/docs/04. App(s)/01. Marketplace/04. My Business Apps.md @@ -33,3 +33,11 @@ This connection is a user federation which establishes trust between the app idp

+ +## NOTICE + +This work is licensed under the [Apache-2.0](https://www.apache.org/licenses/LICENSE-2.0). + +- SPDX-License-Identifier: Apache-2.0 +- SPDX-FileCopyrightText: 2021-2023 Contributors to the Eclipse Foundation +- Source URL: https://github.com/eclipse-tractusx/portal-assets diff --git a/docs/04. App(s)/01. Marketplace/05. FAQ.md b/docs/04. App(s)/01. Marketplace/05. FAQ.md index 7698c3d17..bee71d881 100644 --- a/docs/04. App(s)/01. Marketplace/05. FAQ.md +++ b/docs/04. App(s)/01. Marketplace/05. FAQ.md @@ -20,3 +20,11 @@ Yes, apps can get deactivated. Active subscriptions are not impacted by the deac

+ +## NOTICE + +This work is licensed under the [Apache-2.0](https://www.apache.org/licenses/LICENSE-2.0). + +- SPDX-License-Identifier: Apache-2.0 +- SPDX-FileCopyrightText: 2021-2023 Contributors to the Eclipse Foundation +- Source URL: https://github.com/eclipse-tractusx/portal-assets diff --git a/docs/04. App(s)/02. App Release Process/01. App Card.md b/docs/04. App(s)/02. App Release Process/01. App Card.md index 0bfee6bd5..f02db4e3b 100644 --- a/docs/04. App(s)/02. App Release Process/01. App Card.md +++ b/docs/04. App(s)/02. App Release Process/01. App Card.md @@ -69,3 +69,11 @@ Please ensure to use an image in the type of jpeg or png and with a size of maxi

+ +## NOTICE + +This work is licensed under the [Apache-2.0](https://www.apache.org/licenses/LICENSE-2.0). + +- SPDX-License-Identifier: Apache-2.0 +- SPDX-FileCopyrightText: 2021-2023 Contributors to the Eclipse Foundation +- Source URL: https://github.com/eclipse-tractusx/portal-assets diff --git a/docs/04. App(s)/02. App Release Process/02. App Detail Page.md b/docs/04. App(s)/02. App Release Process/02. App Detail Page.md index d7069e9ab..1126484ae 100644 --- a/docs/04. App(s)/02. App Release Process/02. App Detail Page.md +++ b/docs/04. App(s)/02. App Release Process/02. App Detail Page.md @@ -61,3 +61,11 @@ As part of the app release process, the app provider has to select the respectiv

+ +## NOTICE + +This work is licensed under the [Apache-2.0](https://www.apache.org/licenses/LICENSE-2.0). + +- SPDX-License-Identifier: Apache-2.0 +- SPDX-FileCopyrightText: 2021-2023 Contributors to the Eclipse Foundation +- Source URL: https://github.com/eclipse-tractusx/portal-assets diff --git a/docs/04. App(s)/02. App Release Process/03.Terms&Conditions.md b/docs/04. App(s)/02. App Release Process/03.Terms&Conditions.md index 112398172..243be3dec 100644 --- a/docs/04. App(s)/02. App Release Process/03.Terms&Conditions.md +++ b/docs/04. App(s)/02. App Release Process/03.Terms&Conditions.md @@ -10,3 +10,11 @@ Under Step 3 - the user needs to agree to the terms and conditions of the app pu

+ +## NOTICE + +This work is licensed under the [Apache-2.0](https://www.apache.org/licenses/LICENSE-2.0). + +- SPDX-License-Identifier: Apache-2.0 +- SPDX-FileCopyrightText: 2021-2023 Contributors to the Eclipse Foundation +- Source URL: https://github.com/eclipse-tractusx/portal-assets diff --git a/docs/04. App(s)/02. App Release Process/04.Technical Integration.md b/docs/04. App(s)/02. App Release Process/04.Technical Integration.md index 2591b7445..7680df868 100644 --- a/docs/04. App(s)/02. App Release Process/04.Technical Integration.md +++ b/docs/04. App(s)/02. App Release Process/04.Technical Integration.md @@ -17,3 +17,11 @@ With the technical integration feature, the user can:

+ +## NOTICE + +This work is licensed under the [Apache-2.0](https://www.apache.org/licenses/LICENSE-2.0). + +- SPDX-License-Identifier: Apache-2.0 +- SPDX-FileCopyrightText: 2021-2023 Contributors to the Eclipse Foundation +- Source URL: https://github.com/eclipse-tractusx/portal-assets diff --git a/docs/04. App(s)/02. App Release Process/05.Verify & Submit.md b/docs/04. App(s)/02. App Release Process/05.Verify & Submit.md index d8bd853d3..351f44a42 100644 --- a/docs/04. App(s)/02. App Release Process/05.Verify & Submit.md +++ b/docs/04. App(s)/02. App Release Process/05.Verify & Submit.md @@ -13,3 +13,11 @@ As soon as your entered data meet your expectations, use the "Submit" button on

+ +## NOTICE + +This work is licensed under the [Apache-2.0](https://www.apache.org/licenses/LICENSE-2.0). + +- SPDX-License-Identifier: Apache-2.0 +- SPDX-FileCopyrightText: 2021-2023 Contributors to the Eclipse Foundation +- Source URL: https://github.com/eclipse-tractusx/portal-assets diff --git a/docs/04. App(s)/02. App Release Process/App-Design_guidelines.md b/docs/04. App(s)/02. App Release Process/App-Design_guidelines.md index b93c39ab2..d9aaab9de 100644 --- a/docs/04. App(s)/02. App Release Process/App-Design_guidelines.md +++ b/docs/04. App(s)/02. App Release Process/App-Design_guidelines.md @@ -94,3 +94,11 @@ Technical solution proposal

+ +## NOTICE + +This work is licensed under the [Apache-2.0](https://www.apache.org/licenses/LICENSE-2.0). + +- SPDX-License-Identifier: Apache-2.0 +- SPDX-FileCopyrightText: 2021-2023 Contributors to the Eclipse Foundation +- Source URL: https://github.com/eclipse-tractusx/portal-assets diff --git a/docs/04. App(s)/02. App Release Process/App-Release_guidelines.md b/docs/04. App(s)/02. App Release Process/App-Release_guidelines.md index 8d5198d82..b8f9b1285 100644 --- a/docs/04. App(s)/02. App Release Process/App-Release_guidelines.md +++ b/docs/04. App(s)/02. App Release Process/App-Release_guidelines.md @@ -37,3 +37,11 @@ to be added - [ ] CX IP App Language Support - [App Design Guidelines](./App-Design_guidelines.md/) - [ ] ... - [ ] ... + +## NOTICE + +This work is licensed under the [Apache-2.0](https://www.apache.org/licenses/LICENSE-2.0). + +- SPDX-License-Identifier: Apache-2.0 +- SPDX-FileCopyrightText: 2021-2023 Contributors to the Eclipse Foundation +- Source URL: https://github.com/eclipse-tractusx/portal-assets diff --git a/docs/04. App(s)/02. App Release Process/index.md b/docs/04. App(s)/02. App Release Process/index.md index c6b9bb0a8..684389869 100644 --- a/docs/04. App(s)/02. App Release Process/index.md +++ b/docs/04. App(s)/02. App Release Process/index.md @@ -58,3 +58,11 @@ and click on

+ +## NOTICE + +This work is licensed under the [Apache-2.0](https://www.apache.org/licenses/LICENSE-2.0). + +- SPDX-License-Identifier: Apache-2.0 +- SPDX-FileCopyrightText: 2021-2023 Contributors to the Eclipse Foundation +- Source URL: https://github.com/eclipse-tractusx/portal-assets diff --git a/docs/04. App(s)/03. App Release Approval/01. App Approval Board.md b/docs/04. App(s)/03. App Release Approval/01. App Approval Board.md index 427e2bac2..931f3261e 100644 --- a/docs/04. App(s)/03. App Release Approval/01. App Approval Board.md +++ b/docs/04. App(s)/03. App Release Approval/01. App Approval Board.md @@ -26,3 +26,11 @@ The user can get to the app details or approve / decline the app release.

+ +## NOTICE + +This work is licensed under the [Apache-2.0](https://www.apache.org/licenses/LICENSE-2.0). + +- SPDX-License-Identifier: Apache-2.0 +- SPDX-FileCopyrightText: 2021-2023 Contributors to the Eclipse Foundation +- Source URL: https://github.com/eclipse-tractusx/portal-assets diff --git a/docs/04. App(s)/03. App Release Approval/02. App Details.md b/docs/04. App(s)/03. App Release Approval/02. App Details.md index ab1dddd7e..e6cf976c9 100644 --- a/docs/04. App(s)/03. App Release Approval/02. App Details.md +++ b/docs/04. App(s)/03. App Release Approval/02. App Details.md @@ -10,3 +10,11 @@ To display the details the app data get displayed by clicking on the app card on


+ +## NOTICE + +This work is licensed under the [Apache-2.0](https://www.apache.org/licenses/LICENSE-2.0). + +- SPDX-License-Identifier: Apache-2.0 +- SPDX-FileCopyrightText: 2021-2023 Contributors to the Eclipse Foundation +- Source URL: https://github.com/eclipse-tractusx/portal-assets diff --git a/docs/04. App(s)/03. App Release Approval/03. Approve App Release.md b/docs/04. App(s)/03. App Release Approval/03. Approve App Release.md index 713597131..99e032617 100644 --- a/docs/04. App(s)/03. App Release Approval/03. Approve App Release.md +++ b/docs/04. App(s)/03. App Release Approval/03. Approve App Release.md @@ -8,3 +8,11 @@ The approval is triggered by clicking on the approval icon inside the app card:

+ +## NOTICE + +This work is licensed under the [Apache-2.0](https://www.apache.org/licenses/LICENSE-2.0). + +- SPDX-License-Identifier: Apache-2.0 +- SPDX-FileCopyrightText: 2021-2023 Contributors to the Eclipse Foundation +- Source URL: https://github.com/eclipse-tractusx/portal-assets diff --git a/docs/04. App(s)/03. App Release Approval/04. Decline App Release.md b/docs/04. App(s)/03. App Release Approval/04. Decline App Release.md index d875b98bd..d3ec11d23 100644 --- a/docs/04. App(s)/03. App Release Approval/04. Decline App Release.md +++ b/docs/04. App(s)/03. App Release Approval/04. Decline App Release.md @@ -10,3 +10,11 @@ The app release decline icon can get triggered by clicking on the decline icon i

+ +## NOTICE + +This work is licensed under the [Apache-2.0](https://www.apache.org/licenses/LICENSE-2.0). + +- SPDX-License-Identifier: Apache-2.0 +- SPDX-FileCopyrightText: 2021-2023 Contributors to the Eclipse Foundation +- Source URL: https://github.com/eclipse-tractusx/portal-assets diff --git a/docs/04. App(s)/04. App Provider Management Board(s)/01. App Board.md b/docs/04. App(s)/04. App Provider Management Board(s)/01. App Board.md index 54f6dc24b..66b104f42 100644 --- a/docs/04. App(s)/04. App Provider Management Board(s)/01. App Board.md +++ b/docs/04. App(s)/04. App Provider Management Board(s)/01. App Board.md @@ -42,3 +42,11 @@ Apps which are in "Inactive" have been deactivated by the app owner and are not Additionally the "App Change Process" can get triggered from the app overview page. Details to the app change process are documented under following page App Marketplace - App Change Process

+ +## NOTICE + +This work is licensed under the [Apache-2.0](https://www.apache.org/licenses/LICENSE-2.0). + +- SPDX-License-Identifier: Apache-2.0 +- SPDX-FileCopyrightText: 2021-2023 Contributors to the Eclipse Foundation +- Source URL: https://github.com/eclipse-tractusx/portal-assets diff --git a/docs/04. App(s)/05. App Subscription/01. Subscription Request (Customer).md b/docs/04. App(s)/05. App Subscription/01. Subscription Request (Customer).md index a81c60d8d..a8adc475d 100644 --- a/docs/04. App(s)/05. App Subscription/01. Subscription Request (Customer).md +++ b/docs/04. App(s)/05. App Subscription/01. Subscription Request (Customer).md @@ -25,3 +25,11 @@ With that, the customer can manage user roles for their own users (pre-requisite

+ +## NOTICE + +This work is licensed under the [Apache-2.0](https://www.apache.org/licenses/LICENSE-2.0). + +- SPDX-License-Identifier: Apache-2.0 +- SPDX-FileCopyrightText: 2021-2023 Contributors to the Eclipse Foundation +- Source URL: https://github.com/eclipse-tractusx/portal-assets diff --git a/docs/04. App(s)/05. App Subscription/02. Overview Company Subscription (Customer).md b/docs/04. App(s)/05. App Subscription/02. Overview Company Subscription (Customer).md index 4d2e5f2b8..3832d5e45 100644 --- a/docs/04. App(s)/05. App Subscription/02. Overview Company Subscription (Customer).md +++ b/docs/04. App(s)/05. App Subscription/02. Overview Company Subscription (Customer).md @@ -3,3 +3,11 @@ Available subscriptions or outstanding/pending subscriptions are available under "My Organisation"

+ +## NOTICE + +This work is licensed under the [Apache-2.0](https://www.apache.org/licenses/LICENSE-2.0). + +- SPDX-License-Identifier: Apache-2.0 +- SPDX-FileCopyrightText: 2021-2023 Contributors to the Eclipse Foundation +- Source URL: https://github.com/eclipse-tractusx/portal-assets diff --git a/docs/04. App(s)/05. App Subscription/03. Subscription Overview (App Provider).md b/docs/04. App(s)/05. App Subscription/03. Subscription Overview (App Provider).md index df113ab92..6f92cc10c 100644 --- a/docs/04. App(s)/05. App Subscription/03. Subscription Overview (App Provider).md +++ b/docs/04. App(s)/05. App Subscription/03. Subscription Overview (App Provider).md @@ -37,3 +37,11 @@ The information shall help the provider to retrieve additional information as we

image

+ +## NOTICE + +This work is licensed under the [Apache-2.0](https://www.apache.org/licenses/LICENSE-2.0). + +- SPDX-License-Identifier: Apache-2.0 +- SPDX-FileCopyrightText: 2021-2023 Contributors to the Eclipse Foundation +- Source URL: https://github.com/eclipse-tractusx/portal-assets diff --git a/docs/04. App(s)/05. App Subscription/04. Subscription Activation (App Provider).md b/docs/04. App(s)/05. App Subscription/04. Subscription Activation (App Provider).md index e150336ba..da57444a4 100644 --- a/docs/04. App(s)/05. App Subscription/04. Subscription Activation (App Provider).md +++ b/docs/04. App(s)/05. App Subscription/04. Subscription Activation (App Provider).md @@ -42,3 +42,11 @@ With the activation, the customer will receive an automatically generated app ac

+ +## NOTICE + +This work is licensed under the [Apache-2.0](https://www.apache.org/licenses/LICENSE-2.0). + +- SPDX-License-Identifier: Apache-2.0 +- SPDX-FileCopyrightText: 2021-2023 Contributors to the Eclipse Foundation +- Source URL: https://github.com/eclipse-tractusx/portal-assets diff --git a/docs/04. App(s)/05. App Subscription/05. App Unsubscribe.md b/docs/04. App(s)/05. App Subscription/05. App Unsubscribe.md index 70fc588b4..903bfb107 100644 --- a/docs/04. App(s)/05. App Subscription/05. App Unsubscribe.md +++ b/docs/04. App(s)/05. App Subscription/05. App Unsubscribe.md @@ -8,13 +8,20 @@ The unsubscribe subscription feature is available inside the /organization page.
-By clicking on the "Unsubscribe" button, an overlay with the subscriptiond details is getting displayed. +By clicking on the "Unsubscribe" button, an overlay with the subscription details is getting displayed. With the unsubscribe confirmation the app subscription will get set to "INACTIVE". Automatically the technical user, possible linked connector as well as the IdP app instance of the customer will get deactivated. This will ensure that the integration is disconnected.
-In the current implementation level, the app prvoider itself is not getting informed about the unsubscription. +In the current implementation level, the app provider itself is not getting informed about the unsubscription.

+## NOTICE + +This work is licensed under the [Apache-2.0](https://www.apache.org/licenses/LICENSE-2.0). + +- SPDX-License-Identifier: Apache-2.0 +- SPDX-FileCopyrightText: 2021-2023 Contributors to the Eclipse Foundation +- Source URL: https://github.com/eclipse-tractusx/portal-assets diff --git a/docs/04. App(s)/05. App Subscription/05. FAQ.md b/docs/04. App(s)/05. App Subscription/05. FAQ.md index a927a09c9..c6b0a5ab4 100644 --- a/docs/04. App(s)/05. App Subscription/05. FAQ.md +++ b/docs/04. App(s)/05. App Subscription/05. FAQ.md @@ -2,7 +2,7 @@
-#### I dont have subscription rights - how can I receive the necessary rights? +#### I don't have subscription rights - how can I receive the necessary rights? Subscription rights can get shared / assigned by the company admin / company IT admin. Please contact your admin if additional rights are needed. Subscriptions can get triggered by all administrators as well as the "Purchaser" role. @@ -28,3 +28,11 @@ Company subscription can get viewed via the company details page => /organizatio

+ +## NOTICE + +This work is licensed under the [Apache-2.0](https://www.apache.org/licenses/LICENSE-2.0). + +- SPDX-License-Identifier: Apache-2.0 +- SPDX-FileCopyrightText: 2021-2023 Contributors to the Eclipse Foundation +- Source URL: https://github.com/eclipse-tractusx/portal-assets diff --git a/docs/04. App(s)/06. App Change Process/01. Summary.md b/docs/04. App(s)/06. App Change Process/01. Summary.md index 6d297ea72..e1934669f 100644 --- a/docs/04. App(s)/06. App Change Process/01. Summary.md +++ b/docs/04. App(s)/06. App Change Process/01. Summary.md @@ -48,3 +48,11 @@ Open up the sub-menu

+ +## NOTICE + +This work is licensed under the [Apache-2.0](https://www.apache.org/licenses/LICENSE-2.0). + +- SPDX-License-Identifier: Apache-2.0 +- SPDX-FileCopyrightText: 2021-2023 Contributors to the Eclipse Foundation +- Source URL: https://github.com/eclipse-tractusx/portal-assets diff --git a/docs/04. App(s)/06. App Change Process/02. Change App Lead Image.md b/docs/04. App(s)/06. App Change Process/02. Change App Lead Image.md index 0441d4d2b..4bc47f0b0 100644 --- a/docs/04. App(s)/06. App Change Process/02. Change App Lead Image.md +++ b/docs/04. App(s)/06. App Change Process/02. Change App Lead Image.md @@ -28,3 +28,11 @@ Important; the change is not reversible. However you can upload a new image when

+ +## NOTICE + +This work is licensed under the [Apache-2.0](https://www.apache.org/licenses/LICENSE-2.0). + +- SPDX-License-Identifier: Apache-2.0 +- SPDX-FileCopyrightText: 2021-2023 Contributors to the Eclipse Foundation +- Source URL: https://github.com/eclipse-tractusx/portal-assets diff --git a/docs/04. App(s)/06. App Change Process/03. Change App Description.md b/docs/04. App(s)/06. App Change Process/03. Change App Description.md index 83fd49917..159d5c152 100644 --- a/docs/04. App(s)/06. App Change Process/03. Change App Description.md +++ b/docs/04. App(s)/06. App Change Process/03. Change App Description.md @@ -32,3 +32,11 @@ Important; the change is not reversible.

+ +## NOTICE + +This work is licensed under the [Apache-2.0](https://www.apache.org/licenses/LICENSE-2.0). + +- SPDX-License-Identifier: Apache-2.0 +- SPDX-FileCopyrightText: 2021-2023 Contributors to the Eclipse Foundation +- Source URL: https://github.com/eclipse-tractusx/portal-assets diff --git a/docs/04. App(s)/06. App Change Process/04. App Deactivation.md b/docs/04. App(s)/06. App Change Process/04. App Deactivation.md index cbb2e46b2..3e9dd08b2 100644 --- a/docs/04. App(s)/06. App Change Process/04. App Deactivation.md +++ b/docs/04. App(s)/06. App Change Process/04. App Deactivation.md @@ -21,3 +21,11 @@ Important; the process is currently not reversible. The app is getting deactivat

+ +## NOTICE + +This work is licensed under the [Apache-2.0](https://www.apache.org/licenses/LICENSE-2.0). + +- SPDX-License-Identifier: Apache-2.0 +- SPDX-FileCopyrightText: 2021-2023 Contributors to the Eclipse Foundation +- Source URL: https://github.com/eclipse-tractusx/portal-assets diff --git a/docs/04. App(s)/06. App Change Process/05. Change App Tenant URL.md b/docs/04. App(s)/06. App Change Process/05. Change App Tenant URL.md index fd0521387..1be622f9c 100644 --- a/docs/04. App(s)/06. App Change Process/05. Change App Tenant URL.md +++ b/docs/04. App(s)/06. App Change Process/05. Change App Tenant URL.md @@ -24,3 +24,11 @@ The change is getting directly activated and leads to an url update inside the c

+ +## NOTICE + +This work is licensed under the [Apache-2.0](https://www.apache.org/licenses/LICENSE-2.0). + +- SPDX-License-Identifier: Apache-2.0 +- SPDX-FileCopyrightText: 2021-2023 Contributors to the Eclipse Foundation +- Source URL: https://github.com/eclipse-tractusx/portal-assets diff --git a/docs/04. App(s)/06. App Change Process/06. Change App RolesL.md b/docs/04. App(s)/06. App Change Process/06. Change App RolesL.md index 8c4954727..1750fee94 100644 --- a/docs/04. App(s)/06. App Change Process/06. Change App RolesL.md +++ b/docs/04. App(s)/06. App Change Process/06. Change App RolesL.md @@ -61,3 +61,11 @@ With an click on the "Confirm" button, the roles are saved.

+ +## NOTICE + +This work is licensed under the [Apache-2.0](https://www.apache.org/licenses/LICENSE-2.0). + +- SPDX-License-Identifier: Apache-2.0 +- SPDX-FileCopyrightText: 2021-2023 Contributors to the Eclipse Foundation +- Source URL: https://github.com/eclipse-tractusx/portal-assets diff --git a/docs/04. App(s)/07. App Provider Management/01. Open API.md b/docs/04. App(s)/07. App Provider Management/01. Open API.md index 636b648ff..e7f904750 100644 --- a/docs/04. App(s)/07. App Provider Management/01. Open API.md +++ b/docs/04. App(s)/07. App Provider Management/01. Open API.md @@ -1,6 +1,6 @@ ## Open API - Offer Autosetup -In the app/service setup scenarios OpenAPIs are offered to support the provider with automatication scenarios. +In the app/service setup scenarios OpenAPIs are offered to support the provider with automatization scenarios. To be able to run the interface, a technical user is needed which can get generated easily via the user management.
[How to create a technical user](/docs/03.%20User%20Management/03.%20Technical%20User/02.%20Create%20Technical%20User.md) @@ -120,7 +120,7 @@ API Endpoint Logic - Add app instance and client for the customer and app id in following tables - iam_client table - app_instance table -- Next, create the client in keycloak central IdP - setting +- Next, create the client in Keycloak central IdP - setting - Client ID: {client name defined by the service before} - Access Type: {public, might get auto set, please check} @@ -170,3 +170,11 @@ Response Body

+ +## NOTICE + +This work is licensed under the [Apache-2.0](https://www.apache.org/licenses/LICENSE-2.0). + +- SPDX-License-Identifier: Apache-2.0 +- SPDX-FileCopyrightText: 2021-2023 Contributors to the Eclipse Foundation +- Source URL: https://github.com/eclipse-tractusx/portal-assets diff --git a/docs/04. App(s)/index.md b/docs/04. App(s)/index.md index 7b2c10c43..ac9450d3a 100644 --- a/docs/04. App(s)/index.md +++ b/docs/04. App(s)/index.md @@ -18,3 +18,11 @@ Key Functions

+ +## NOTICE + +This work is licensed under the [Apache-2.0](https://www.apache.org/licenses/LICENSE-2.0). + +- SPDX-License-Identifier: Apache-2.0 +- SPDX-FileCopyrightText: 2021-2023 Contributors to the Eclipse Foundation +- Source URL: https://github.com/eclipse-tractusx/portal-assets diff --git a/docs/05. Service(s)/01. Service Marketplace/01. Service Marketplace.md b/docs/05. Service(s)/01. Service Marketplace/01. Service Marketplace.md index 4bdd0df59..1675e4562 100644 --- a/docs/05. Service(s)/01. Service Marketplace/01. Service Marketplace.md +++ b/docs/05. Service(s)/01. Service Marketplace/01. Service Marketplace.md @@ -19,3 +19,11 @@ Beside the generic list, services can get viewed in specific pre-configured view

+ +## NOTICE + +This work is licensed under the [Apache-2.0](https://www.apache.org/licenses/LICENSE-2.0). + +- SPDX-License-Identifier: Apache-2.0 +- SPDX-FileCopyrightText: 2021-2023 Contributors to the Eclipse Foundation +- Source URL: https://github.com/eclipse-tractusx/portal-assets diff --git a/docs/05. Service(s)/01. Service Marketplace/02. Service Details.md b/docs/05. Service(s)/01. Service Marketplace/02. Service Details.md index 77ce3c27d..a96b050d7 100644 --- a/docs/05. Service(s)/01. Service Marketplace/02. Service Details.md +++ b/docs/05. Service(s)/01. Service Marketplace/02. Service Details.md @@ -8,7 +8,7 @@ Service details include - Service Type - Service Description - Related Documents -- Subcription Request +- Subscription Request

@@ -17,3 +17,11 @@ Service details include

+ +## NOTICE + +This work is licensed under the [Apache-2.0](https://www.apache.org/licenses/LICENSE-2.0). + +- SPDX-License-Identifier: Apache-2.0 +- SPDX-FileCopyrightText: 2021-2023 Contributors to the Eclipse Foundation +- Source URL: https://github.com/eclipse-tractusx/portal-assets diff --git a/docs/05. Service(s)/01. Service Marketplace/03. FAQ.md b/docs/05. Service(s)/01. Service Marketplace/03. FAQ.md index ba87013fa..3294b0e95 100644 --- a/docs/05. Service(s)/01. Service Marketplace/03. FAQ.md +++ b/docs/05. Service(s)/01. Service Marketplace/03. FAQ.md @@ -1,3 +1,11 @@ ### FAQ currently no FAQs available + +## NOTICE + +This work is licensed under the [Apache-2.0](https://www.apache.org/licenses/LICENSE-2.0). + +- SPDX-License-Identifier: Apache-2.0 +- SPDX-FileCopyrightText: 2021-2023 Contributors to the Eclipse Foundation +- Source URL: https://github.com/eclipse-tractusx/portal-assets diff --git a/docs/05. Service(s)/02. Service Release Process/01. Service Card.md b/docs/05. Service(s)/02. Service Release Process/01. Service Card.md index e9edb60c7..0e6fffade 100644 --- a/docs/05. Service(s)/02. Service Release Process/01. Service Card.md +++ b/docs/05. Service(s)/02. Service Release Process/01. Service Card.md @@ -15,7 +15,15 @@ In the Step 1 of the publishing process, the service card details are getting fi

Please make sure that you add a well defined service name. Have a look at the service marketplace to get a feeling about suitable names and define the best name for your service. -Service images are optional. If you dont have an image handy, you can proceed without the image and upload a suitable image later (either by re-opening the service draft state in a later stage or after the service was published on the marketplace) +Service images are optional. If you don't have an image handy, you can proceed without the image and upload a suitable image later (either by re-opening the service draft state in a later stage or after the service was published on the marketplace)

+ +## NOTICE + +This work is licensed under the [Apache-2.0](https://www.apache.org/licenses/LICENSE-2.0). + +- SPDX-License-Identifier: Apache-2.0 +- SPDX-FileCopyrightText: 2021-2023 Contributors to the Eclipse Foundation +- Source URL: https://github.com/eclipse-tractusx/portal-assets diff --git a/docs/05. Service(s)/02. Service Release Process/02. Service Detail Page.md b/docs/05. Service(s)/02. Service Release Process/02. Service Detail Page.md index b452468af..8135747fa 100644 --- a/docs/05. Service(s)/02. Service Release Process/02. Service Detail Page.md +++ b/docs/05. Service(s)/02. Service Release Process/02. Service Detail Page.md @@ -35,3 +35,11 @@ The long description of the offered service is used to provide the customer an e

+ +## NOTICE + +This work is licensed under the [Apache-2.0](https://www.apache.org/licenses/LICENSE-2.0). + +- SPDX-License-Identifier: Apache-2.0 +- SPDX-FileCopyrightText: 2021-2023 Contributors to the Eclipse Foundation +- Source URL: https://github.com/eclipse-tractusx/portal-assets diff --git a/docs/05. Service(s)/02. Service Release Process/03.Terms&Conditions.md b/docs/05. Service(s)/02. Service Release Process/03.Terms&Conditions.md index 27395c82d..98fa48f0f 100644 --- a/docs/05. Service(s)/02. Service Release Process/03.Terms&Conditions.md +++ b/docs/05. Service(s)/02. Service Release Process/03.Terms&Conditions.md @@ -1,6 +1,6 @@ ### Step 3 - Terms & Conditions / Consent -Under Step 3 - the user needs to agree to the terms and conditions of the service publish rules before getting on the marketplace. This section is mandatory and displays areement documents; if any documents are linked to the relevant agreement types +Under Step 3 - the user needs to agree to the terms and conditions of the service publish rules before getting on the marketplace. This section is mandatory and displays agreement documents; if any documents are linked to the relevant agreement types
@@ -14,3 +14,11 @@ In case any documents or further details to the agreements are available, the ag

+ +## NOTICE + +This work is licensed under the [Apache-2.0](https://www.apache.org/licenses/LICENSE-2.0). + +- SPDX-License-Identifier: Apache-2.0 +- SPDX-FileCopyrightText: 2021-2023 Contributors to the Eclipse Foundation +- Source URL: https://github.com/eclipse-tractusx/portal-assets diff --git a/docs/05. Service(s)/02. Service Release Process/04.Technical Integration.md b/docs/05. Service(s)/02. Service Release Process/04.Technical Integration.md index 90fc43514..db3eed14d 100644 --- a/docs/05. Service(s)/02. Service Release Process/04.Technical Integration.md +++ b/docs/05. Service(s)/02. Service Release Process/04.Technical Integration.md @@ -1,9 +1,9 @@ ### Step 4 - Technical Integration The 'Technical Integration' is used to enable the service provider to define the technical user profile needed to run the service. Depending on the service type, the technical user profile is relevant or will be skipped. -If the service provider is planning to publish a dataspace service, such as a managed EDC, the technical user profile is needed to retrieve as part of the service subscriiption activation for a specific customer the respective technical user. The technical user will be used to connect to the Catena-X dataspace and enable the provider to run the service authorization etc. +If the service provider is planning to publish a dataspace service, such as a managed EDC, the technical user profile is needed to retrieve as part of the service subscription activation for a specific customer the respective technical user. The technical user will be used to connect to the Catena-X dataspace and enable the provider to run the service authorization etc. -For the technical integration the respetive available technical user profiles will be displayed. +For the technical integration the respective available technical user profiles will be displayed. The service provider can select one or multiple user permissions which are supposed to get assigned to the respective technical user as soon as created.
@@ -14,3 +14,11 @@ The service provider can select one or multiple user permissions which are suppo

+ +## NOTICE + +This work is licensed under the [Apache-2.0](https://www.apache.org/licenses/LICENSE-2.0). + +- SPDX-License-Identifier: Apache-2.0 +- SPDX-FileCopyrightText: 2021-2023 Contributors to the Eclipse Foundation +- Source URL: https://github.com/eclipse-tractusx/portal-assets diff --git a/docs/05. Service(s)/02. Service Release Process/05.Verify & Submit.md b/docs/05. Service(s)/02. Service Release Process/05.Verify & Submit.md index a8577bc00..02903bcb9 100644 --- a/docs/05. Service(s)/02. Service Release Process/05.Verify & Submit.md +++ b/docs/05. Service(s)/02. Service Release Process/05.Verify & Submit.md @@ -12,3 +12,11 @@ As soon as your entered data meet your expectations, use the "Submit" button on

+ +## NOTICE + +This work is licensed under the [Apache-2.0](https://www.apache.org/licenses/LICENSE-2.0). + +- SPDX-License-Identifier: Apache-2.0 +- SPDX-FileCopyrightText: 2021-2023 Contributors to the Eclipse Foundation +- Source URL: https://github.com/eclipse-tractusx/portal-assets diff --git a/docs/05. Service(s)/02. Service Release Process/06. FAQ.md b/docs/05. Service(s)/02. Service Release Process/06. FAQ.md index 4de78bb4f..21643fe85 100644 --- a/docs/05. Service(s)/02. Service Release Process/06. FAQ.md +++ b/docs/05. Service(s)/02. Service Release Process/06. FAQ.md @@ -18,3 +18,11 @@ If you have a new service offer planned, please contact the system administrator

+ +## NOTICE + +This work is licensed under the [Apache-2.0](https://www.apache.org/licenses/LICENSE-2.0). + +- SPDX-License-Identifier: Apache-2.0 +- SPDX-FileCopyrightText: 2021-2023 Contributors to the Eclipse Foundation +- Source URL: https://github.com/eclipse-tractusx/portal-assets diff --git a/docs/05. Service(s)/02. Service Release Process/index.md b/docs/05. Service(s)/02. Service Release Process/index.md index e2e98677f..4c46cda37 100644 --- a/docs/05. Service(s)/02. Service Release Process/index.md +++ b/docs/05. Service(s)/02. Service Release Process/index.md @@ -4,7 +4,7 @@ The "Service Release Publishing Process" is used to enable Service Provider to o This chapter describes the service release process. How to get there? -Access the "Service Publish Process" via the "Service Release Process" or via the "Service Management" page. Both sub-menus are available via the top menu "Servie Management". +Access the "Service Publish Process" via the "Service Release Process" or via the "Service Management" page. Both sub-menus are available via the top menu "Service Management".

@@ -30,3 +30,11 @@ and click on the action button "Register your service"

+ +## NOTICE + +This work is licensed under the [Apache-2.0](https://www.apache.org/licenses/LICENSE-2.0). + +- SPDX-License-Identifier: Apache-2.0 +- SPDX-FileCopyrightText: 2021-2023 Contributors to the Eclipse Foundation +- Source URL: https://github.com/eclipse-tractusx/portal-assets diff --git a/docs/05. Service(s)/03. Service Release Approval/01. Service Approval Board.md b/docs/05. Service(s)/03. Service Release Approval/01. Service Approval Board.md index 15923173d..f8f7211d2 100644 --- a/docs/05. Service(s)/03. Service Release Approval/01. Service Approval Board.md +++ b/docs/05. Service(s)/03. Service Release Approval/01. Service Approval Board.md @@ -26,3 +26,11 @@ The user can get to the service details or approve / decline the service release

+ +## NOTICE + +This work is licensed under the [Apache-2.0](https://www.apache.org/licenses/LICENSE-2.0). + +- SPDX-License-Identifier: Apache-2.0 +- SPDX-FileCopyrightText: 2021-2023 Contributors to the Eclipse Foundation +- Source URL: https://github.com/eclipse-tractusx/portal-assets diff --git a/docs/05. Service(s)/03. Service Release Approval/02. Service Details.md b/docs/05. Service(s)/03. Service Release Approval/02. Service Details.md index 31e9ae275..e7d3f84d1 100644 --- a/docs/05. Service(s)/03. Service Release Approval/02. Service Details.md +++ b/docs/05. Service(s)/03. Service Release Approval/02. Service Details.md @@ -10,3 +10,11 @@ image


+ +## NOTICE + +This work is licensed under the [Apache-2.0](https://www.apache.org/licenses/LICENSE-2.0). + +- SPDX-License-Identifier: Apache-2.0 +- SPDX-FileCopyrightText: 2021-2023 Contributors to the Eclipse Foundation +- Source URL: https://github.com/eclipse-tractusx/portal-assets diff --git a/docs/05. Service(s)/03. Service Release Approval/03. Approve Service Release.md b/docs/05. Service(s)/03. Service Release Approval/03. Approve Service Release.md index d245f297c..87923c15d 100644 --- a/docs/05. Service(s)/03. Service Release Approval/03. Approve Service Release.md +++ b/docs/05. Service(s)/03. Service Release Approval/03. Approve Service Release.md @@ -8,3 +8,11 @@ The approval is triggered by clicking on the approval icon inside the service ca

+ +## NOTICE + +This work is licensed under the [Apache-2.0](https://www.apache.org/licenses/LICENSE-2.0). + +- SPDX-License-Identifier: Apache-2.0 +- SPDX-FileCopyrightText: 2021-2023 Contributors to the Eclipse Foundation +- Source URL: https://github.com/eclipse-tractusx/portal-assets diff --git a/docs/05. Service(s)/03. Service Release Approval/04. Decline Service Release.md b/docs/05. Service(s)/03. Service Release Approval/04. Decline Service Release.md index dcd7a167e..de7c008e4 100644 --- a/docs/05. Service(s)/03. Service Release Approval/04. Decline Service Release.md +++ b/docs/05. Service(s)/03. Service Release Approval/04. Decline Service Release.md @@ -10,3 +10,11 @@ image to be added

+ +## NOTICE + +This work is licensed under the [Apache-2.0](https://www.apache.org/licenses/LICENSE-2.0). + +- SPDX-License-Identifier: Apache-2.0 +- SPDX-FileCopyrightText: 2021-2023 Contributors to the Eclipse Foundation +- Source URL: https://github.com/eclipse-tractusx/portal-assets diff --git a/docs/05. Service(s)/03. Service Subscription/01. Service Subscription.md b/docs/05. Service(s)/03. Service Subscription/01. Service Subscription.md index 4c70f0d9b..8956f00cc 100644 --- a/docs/05. Service(s)/03. Service Subscription/01. Service Subscription.md +++ b/docs/05. Service(s)/03. Service Subscription/01. Service Subscription.md @@ -11,3 +11,11 @@ The successful service subscription request will be visible via the subscription

+ +## NOTICE + +This work is licensed under the [Apache-2.0](https://www.apache.org/licenses/LICENSE-2.0). + +- SPDX-License-Identifier: Apache-2.0 +- SPDX-FileCopyrightText: 2021-2023 Contributors to the Eclipse Foundation +- Source URL: https://github.com/eclipse-tractusx/portal-assets diff --git a/docs/05. Service(s)/03. Service Subscription/03. Subscription Overview (Provider).md b/docs/05. Service(s)/03. Service Subscription/03. Subscription Overview (Provider).md index 2765513c0..06d0db2d8 100644 --- a/docs/05. Service(s)/03. Service Subscription/03. Subscription Overview (Provider).md +++ b/docs/05. Service(s)/03. Service Subscription/03. Subscription Overview (Provider).md @@ -6,10 +6,10 @@ The main focus / scope of the page is to enable service providers to manage thei The page includes following functions -* search -* filter -* trigger subscription activation -* view subscription details (customer, technical user details, etc.) +- search +- filter +- trigger subscription activation +- view subscription details (customer, technical user details, etc.)

@@ -27,14 +27,21 @@ The page includes following functions ## Specific Subscription Details -With an click on the details icon +With an click on the details icon image - the subscription details - such as status, technical user (if applicable), customer details, etc. will get displayed. The information shall help the provider to retrieve additional information as well as to manage the subscription.

image

+ +## NOTICE + +This work is licensed under the [Apache-2.0](https://www.apache.org/licenses/LICENSE-2.0). + +- SPDX-License-Identifier: Apache-2.0 +- SPDX-FileCopyrightText: 2021-2023 Contributors to the Eclipse Foundation +- Source URL: https://github.com/eclipse-tractusx/portal-assets diff --git a/docs/05. Service(s)/03. Service Subscription/04. Service Subscription Activation (Provider).md b/docs/05. Service(s)/03. Service Subscription/04. Service Subscription Activation (Provider).md index b85c65eb8..557c29f88 100644 --- a/docs/05. Service(s)/03. Service Subscription/04. Service Subscription Activation (Provider).md +++ b/docs/05. Service(s)/03. Service Subscription/04. Service Subscription Activation (Provider).md @@ -68,3 +68,11 @@ With the confirmation of the activation, the service subscription is set to 'act

+ +## NOTICE + +This work is licensed under the [Apache-2.0](https://www.apache.org/licenses/LICENSE-2.0). + +- SPDX-License-Identifier: Apache-2.0 +- SPDX-FileCopyrightText: 2021-2023 Contributors to the Eclipse Foundation +- Source URL: https://github.com/eclipse-tractusx/portal-assets diff --git a/docs/05. Service(s)/03. Service Subscription/04. Service Unsubscribe.md b/docs/05. Service(s)/03. Service Subscription/04. Service Unsubscribe.md index a2e493f32..b4365ac2a 100644 --- a/docs/05. Service(s)/03. Service Subscription/04. Service Unsubscribe.md +++ b/docs/05. Service(s)/03. Service Subscription/04. Service Unsubscribe.md @@ -1 +1,9 @@ -will follow soon - technical docu: [click](/developer/05.%20Service(s)/03.%20Service%20Subscription/03.%20Unsubscribe.md) +will follow soon - technical docu: [click]() + +## NOTICE + +This work is licensed under the [Apache-2.0](https://www.apache.org/licenses/LICENSE-2.0). + +- SPDX-License-Identifier: Apache-2.0 +- SPDX-FileCopyrightText: 2021-2023 Contributors to the Eclipse Foundation +- Source URL: https://github.com/eclipse-tractusx/portal-assets diff --git a/docs/05. Service(s)/03. Service Subscription/05. FAQ.md b/docs/05. Service(s)/03. Service Subscription/05. FAQ.md index b60c6b3df..9d1d84d85 100644 --- a/docs/05. Service(s)/03. Service Subscription/05. FAQ.md +++ b/docs/05. Service(s)/03. Service Subscription/05. FAQ.md @@ -8,7 +8,7 @@ The service subscription can get easily retriggered with the "Subscribe" button

-#### I dont have subscription rights - how can I receive the necessary rights? +#### I don't have subscription rights - how can I receive the necessary rights? Subscription rights can get shared / assigned by the company admin / company IT admin. Please contact your admin if additional rights are needed. Subscriptions can get triggered by all administrators as well as the "Purchaser" role. @@ -22,3 +22,11 @@ After the service request got triggered, please wait for the service provider to

+ +## NOTICE + +This work is licensed under the [Apache-2.0](https://www.apache.org/licenses/LICENSE-2.0). + +- SPDX-License-Identifier: Apache-2.0 +- SPDX-FileCopyrightText: 2021-2023 Contributors to the Eclipse Foundation +- Source URL: https://github.com/eclipse-tractusx/portal-assets diff --git a/docs/05. Service(s)/05. Service Change Process/01. Summary.md b/docs/05. Service(s)/05. Service Change Process/01. Summary.md index 7865e9c65..2f3d88194 100644 --- a/docs/05. Service(s)/05. Service Change Process/01. Summary.md +++ b/docs/05. Service(s)/05. Service Change Process/01. Summary.md @@ -10,3 +10,11 @@ Supported Service Changes:

+ +## NOTICE + +This work is licensed under the [Apache-2.0](https://www.apache.org/licenses/LICENSE-2.0). + +- SPDX-License-Identifier: Apache-2.0 +- SPDX-FileCopyrightText: 2021-2023 Contributors to the Eclipse Foundation +- Source URL: https://github.com/eclipse-tractusx/portal-assets diff --git a/docs/05. Service(s)/05. Service Change Process/02. Service Deactivation.md b/docs/05. Service(s)/05. Service Change Process/02. Service Deactivation.md index 68236e86c..5940d0b17 100644 --- a/docs/05. Service(s)/05. Service Change Process/02. Service Deactivation.md +++ b/docs/05. Service(s)/05. Service Change Process/02. Service Deactivation.md @@ -26,3 +26,11 @@ Important; the process is currently not reversible.

+ +## NOTICE + +This work is licensed under the [Apache-2.0](https://www.apache.org/licenses/LICENSE-2.0). + +- SPDX-License-Identifier: Apache-2.0 +- SPDX-FileCopyrightText: 2021-2023 Contributors to the Eclipse Foundation +- Source URL: https://github.com/eclipse-tractusx/portal-assets diff --git a/docs/05. Service(s)/index.md b/docs/05. Service(s)/index.md index 95e44535a..6e22fb01e 100644 --- a/docs/05. Service(s)/index.md +++ b/docs/05. Service(s)/index.md @@ -12,3 +12,11 @@ Key Functions

+ +## NOTICE + +This work is licensed under the [Apache-2.0](https://www.apache.org/licenses/LICENSE-2.0). + +- SPDX-License-Identifier: Apache-2.0 +- SPDX-FileCopyrightText: 2021-2023 Contributors to the Eclipse Foundation +- Source URL: https://github.com/eclipse-tractusx/portal-assets diff --git a/docs/06. Certificates/01. UseCase Participation.md b/docs/06. Certificates/01. UseCase Participation.md index 9fab8d654..5e60e0a6d 100644 --- a/docs/06. Certificates/01. UseCase Participation.md +++ b/docs/06. Certificates/01. UseCase Participation.md @@ -39,3 +39,11 @@ To view the current state of the credential request, the status is getting displ

+ +## NOTICE + +This work is licensed under the [Apache-2.0](https://www.apache.org/licenses/LICENSE-2.0). + +- SPDX-License-Identifier: Apache-2.0 +- SPDX-FileCopyrightText: 2021-2023 Contributors to the Eclipse Foundation +- Source URL: https://github.com/eclipse-tractusx/portal-assets diff --git a/docs/06. Certificates/02. Other Certificates.md b/docs/06. Certificates/02. Other Certificates.md index 355f380da..c4b6b4d55 100644 --- a/docs/06. Certificates/02. Other Certificates.md +++ b/docs/06. Certificates/02. Other Certificates.md @@ -9,7 +9,7 @@ Currently Supported:

-Accessing the company certificate credentials requestpage can be done via the user navigation +Accessing the company certificate credentials request page can be done via the user navigation
image @@ -17,7 +17,7 @@ Accessing the company certificate credentials requestpage can be done via the us
When accessing the page, an overview of already submitted, active or inactive certificates is displayed. -Via the button "Upload Certficate", new requests can get triggered. +Via the button "Upload Certificate", new requests can get triggered.
image @@ -32,7 +32,7 @@ Please note: the overlay supports the certificate selection. If only one certifi

-> **_NOTE:_** Only PDF files upto 2 MB are allowed to get uploaded. +> **_NOTE:_** Only PDF files up to 2 MB are allowed to get uploaded.

@@ -41,3 +41,11 @@ The submission will trigger a request on the operator side and needs to get appr

+ +## NOTICE + +This work is licensed under the [Apache-2.0](https://www.apache.org/licenses/LICENSE-2.0). + +- SPDX-License-Identifier: Apache-2.0 +- SPDX-FileCopyrightText: 2021-2023 Contributors to the Eclipse Foundation +- Source URL: https://github.com/eclipse-tractusx/portal-assets diff --git a/docs/06. Certificates/03. Credential Admin Board.md b/docs/06. Certificates/03. Credential Admin Board.md index 0f429980c..3077840a4 100644 --- a/docs/06. Certificates/03. Credential Admin Board.md +++ b/docs/06. Certificates/03. Credential Admin Board.md @@ -56,3 +56,11 @@ With the credential reject button, the credential request decline endpoint is tr

+ +## NOTICE + +This work is licensed under the [Apache-2.0](https://www.apache.org/licenses/LICENSE-2.0). + +- SPDX-License-Identifier: Apache-2.0 +- SPDX-FileCopyrightText: 2021-2023 Contributors to the Eclipse Foundation +- Source URL: https://github.com/eclipse-tractusx/portal-assets diff --git a/docs/06. Certificates/03. FAQ.md b/docs/06. Certificates/03. FAQ.md index b13df8a64..420713821 100644 --- a/docs/06. Certificates/03. FAQ.md +++ b/docs/06. Certificates/03. FAQ.md @@ -8,7 +8,7 @@ The "Company Certificates" page validates if the user company can upload any cer #### 2. Who validates my VC request after submission -The platform operator is getting informed of the VC request, validates it and approves or declines the request. In both scnearios the requesting user will be informed about the decision. In case of the approval, the VC is created inside the customer wallet. +The platform operator is getting informed of the VC request, validates it and approves or declines the request. In both scenarios the requesting user will be informed about the decision. In case of the approval, the VC is created inside the customer wallet.
@@ -18,3 +18,11 @@ Credential valid till dates are defined by the VC issuer. In most cases credenti The user can view the duration inside the wallet.
+ +## NOTICE + +This work is licensed under the [Apache-2.0](https://www.apache.org/licenses/LICENSE-2.0). + +- SPDX-License-Identifier: Apache-2.0 +- SPDX-FileCopyrightText: 2021-2023 Contributors to the Eclipse Foundation +- Source URL: https://github.com/eclipse-tractusx/portal-assets diff --git a/docs/06. Certificates/index.md b/docs/06. Certificates/index.md index 764d6cd8f..3024b876d 100644 --- a/docs/06. Certificates/index.md +++ b/docs/06. Certificates/index.md @@ -9,3 +9,11 @@ Content:

+ +## NOTICE + +This work is licensed under the [Apache-2.0](https://www.apache.org/licenses/LICENSE-2.0). + +- SPDX-License-Identifier: Apache-2.0 +- SPDX-FileCopyrightText: 2021-2023 Contributors to the Eclipse Foundation +- Source URL: https://github.com/eclipse-tractusx/portal-assets diff --git a/docs/06. Notifications/01. Notifications/01. Overview.md b/docs/06. Notifications/01. Notifications/01. Overview.md index baf1b19ee..da028376b 100644 --- a/docs/06. Notifications/01. Notifications/01. Overview.md +++ b/docs/06. Notifications/01. Notifications/01. Overview.md @@ -38,3 +38,11 @@ When accessing the notification details via the user icon navigation, the notifi

image

+ +## NOTICE + +This work is licensed under the [Apache-2.0](https://www.apache.org/licenses/LICENSE-2.0). + +- SPDX-License-Identifier: Apache-2.0 +- SPDX-FileCopyrightText: 2021-2023 Contributors to the Eclipse Foundation +- Source URL: https://github.com/eclipse-tractusx/portal-assets diff --git a/docs/Style-Guide/Static_Page_Template.md b/docs/Style-Guide/Static_Page_Template.md index 3916885d3..7d177e31e 100644 --- a/docs/Style-Guide/Static_Page_Template.md +++ b/docs/Style-Guide/Static_Page_Template.md @@ -1,6 +1,6 @@ ## Static Page Template(s) -The static page templates enable the users to build responsive static sites within extremly short time and in line with the CX styling guidelines. +The static page templates enable the users to build responsive static sites within extremely short time and in line with the CX styling guidelines. Below you can find an overview of all supported templates as well as the template structure. ### Templates @@ -26,7 +26,7 @@ Template Name: "TextCenterAlignedWithCardGrid" { title: 'Section Title', description: - 'description such as an introduction or explaination / subscription of the following cards - description such as an introduction or explanation / subscription of the following cards - description such as an introduction or explanation / subscription of the following cards - description such as an introduction or explanation / subscription of the following cards - description such as an introduction or explanation / subscription of the following cards', + 'description such as an introduction or explanation / subscription of the following cards - description such as an introduction or explanation / subscription of the following cards - description such as an introduction or explanation / subscription of the following cards - description such as an introduction or explanation / subscription of the following cards - description such as an introduction or explanation / subscription of the following cards', backgroundColor: '#FFFFFF', id: 'business-id', imageUrl: @@ -142,7 +142,7 @@ Template Name: "TextImageSideBySideWithCardGrid" { title: 'Section Title', description: - 'description such as an introduction or explaination / subscription of the following cards - description such as an introduction or explanation / subscription of the following cards - description such as an introduction or explanation / subscription of the following cards - description such as an introduction or explanation / subscription of the following cards - description such as an introduction or explanation / subscription of the following cards', + 'description such as an introduction or explanation / subscription of the following cards - description such as an introduction or explanation / subscription of the following cards - description such as an introduction or explanation / subscription of the following cards - description such as an introduction or explanation / subscription of the following cards - description such as an introduction or explanation / subscription of the following cards', imageUrl: 'https://cdn.pixabay.com/photo/2017/09/05/10/20/business-2717066_1280.jpg', backgroundColor: '#FFFFFF', @@ -154,7 +154,7 @@ Template Name: "TextImageSideBySideWithCardGrid" imageUrl: 'https://cdn.pixabay.com/photo/2017/09/05/10/20/business-2717066_1280.jpg', description: - 'description such as an introduction or explaination / subscription of the following cards - description such as an introduction or explanation / subscription of the following cards - description such as an introduction or explanation / subscription of the following cards - description such as an introduction or explanation / subscription of the following cards - description such as an introduction or explanation / subscription of the following cards', + 'description such as an introduction or explanation / subscription of the following cards - description such as an introduction or explanation / subscription of the following cards - description such as an introduction or explanation / subscription of the following cards - description such as an introduction or explanation / subscription of the following cards - description such as an introduction or explanation / subscription of the following cards', readMore: '/help', readMoreTitle: 'Details', backgroundColor: '#F9F9F9', @@ -164,7 +164,7 @@ Template Name: "TextImageSideBySideWithCardGrid" imageUrl: 'https://cdn.pixabay.com/photo/2017/09/05/10/20/business-2717066_1280.jpg', description: - 'description such as an introduction or explaination / subscription of the following cards - description such as an introduction or explanation / subscription of the following cards - description such as an introduction or explanation / subscription of the following cards - description such as an introduction or explanation / subscription of the following cards - description such as an introduction or explanation / subscription of the following cards', + 'description such as an introduction or explanation / subscription of the following cards - description such as an introduction or explanation / subscription of the following cards - description such as an introduction or explanation / subscription of the following cards - description such as an introduction or explanation / subscription of the following cards - description such as an introduction or explanation / subscription of the following cards', readMore: '/help', backgroundColor: '#F9F9F9', }, @@ -173,7 +173,7 @@ Template Name: "TextImageSideBySideWithCardGrid" imageUrl: 'https://cdn.pixabay.com/photo/2017/09/05/10/20/business-2717066_1280.jpg', description: - 'description such as an introduction or explaination / subscription of the following cards - description such as an introduction or explanation / subscription of the following cards - description such as an introduction or explanation / subscription of the following cards - description such as an introduction or explanation / subscription of the following cards - description such as an introduction or explanation / subscription of the following cards', + 'description such as an introduction or explanation / subscription of the following cards - description such as an introduction or explanation / subscription of the following cards - description such as an introduction or explanation / subscription of the following cards - description such as an introduction or explanation / subscription of the following cards - description such as an introduction or explanation / subscription of the following cards', readMore: '/help', readMoreTitle: 'Details', backgroundColor: '#F9F9F9', @@ -544,10 +544,18 @@ The frontend repo is needed to introduce the page, permissions to the page as we #### Enhancing an existing page -For enhancing an existing page, the asset files insidide the asset repo => /public/assets/content/de/.... need to get enhanced. +For enhancing an existing page, the asset files inside the assets repo => /public/assets/content/de/.... need to get enhanced. Please ensure that you extend all language files and not only one. By adding a new template (as mentioned above) inside the content files, the portal page will get automatically extended by the new content.

+ +## NOTICE + +This work is licensed under the [Apache-2.0](https://www.apache.org/licenses/LICENSE-2.0). + +- SPDX-License-Identifier: Apache-2.0 +- SPDX-FileCopyrightText: 2021-2023 Contributors to the Eclipse Foundation +- Source URL: https://github.com/eclipse-tractusx/portal-assets diff --git a/docs/Style-Guide/button load more.md b/docs/Style-Guide/button load more.md index 3c317e05b..0364c7257 100644 --- a/docs/Style-Guide/button load more.md +++ b/docs/Style-Guide/button load more.md @@ -15,3 +15,11 @@ Load More button component is based on the button component.

+ +## NOTICE + +This work is licensed under the [Apache-2.0](https://www.apache.org/licenses/LICENSE-2.0). + +- SPDX-License-Identifier: Apache-2.0 +- SPDX-FileCopyrightText: 2021-2023 Contributors to the Eclipse Foundation +- Source URL: https://github.com/eclipse-tractusx/portal-assets diff --git a/docs/Style-Guide/button.md b/docs/Style-Guide/button.md index ba025ad04..e3c8d91ae 100644 --- a/docs/Style-Guide/button.md +++ b/docs/Style-Guide/button.md @@ -40,3 +40,11 @@ Less popular or less important actions may be visually styled as links.

+ +## NOTICE + +This work is licensed under the [Apache-2.0](https://www.apache.org/licenses/LICENSE-2.0). + +- SPDX-License-Identifier: Apache-2.0 +- SPDX-FileCopyrightText: 2021-2023 Contributors to the Eclipse Foundation +- Source URL: https://github.com/eclipse-tractusx/portal-assets diff --git a/docs/Style-Guide/date picker.md b/docs/Style-Guide/date picker.md index 577921136..20dcfb69b 100644 --- a/docs/Style-Guide/date picker.md +++ b/docs/Style-Guide/date picker.md @@ -13,3 +13,11 @@ A date picker is used to select a specific date or date range from a calendar an

+ +## NOTICE + +This work is licensed under the [Apache-2.0](https://www.apache.org/licenses/LICENSE-2.0). + +- SPDX-License-Identifier: Apache-2.0 +- SPDX-FileCopyrightText: 2021-2023 Contributors to the Eclipse Foundation +- Source URL: https://github.com/eclipse-tractusx/portal-assets diff --git a/docs/Style-Guide/drop down.md b/docs/Style-Guide/drop down.md index 3e313ed50..161d27dda 100644 --- a/docs/Style-Guide/drop down.md +++ b/docs/Style-Guide/drop down.md @@ -19,3 +19,11 @@ A drop down list is a graphical control element, similar to a list box, that all

+ +## NOTICE + +This work is licensed under the [Apache-2.0](https://www.apache.org/licenses/LICENSE-2.0). + +- SPDX-License-Identifier: Apache-2.0 +- SPDX-FileCopyrightText: 2021-2023 Contributors to the Eclipse Foundation +- Source URL: https://github.com/eclipse-tractusx/portal-assets diff --git a/docs/Style-Guide/dropzone.md b/docs/Style-Guide/dropzone.md index 8d30f1a2e..9364a6f59 100644 --- a/docs/Style-Guide/dropzone.md +++ b/docs/Style-Guide/dropzone.md @@ -66,3 +66,11 @@ Example:

+ +## NOTICE + +This work is licensed under the [Apache-2.0](https://www.apache.org/licenses/LICENSE-2.0). + +- SPDX-License-Identifier: Apache-2.0 +- SPDX-FileCopyrightText: 2021-2023 Contributors to the Eclipse Foundation +- Source URL: https://github.com/eclipse-tractusx/portal-assets diff --git a/docs/Style-Guide/input field.md b/docs/Style-Guide/input field.md index 7af07b61c..048526c77 100644 --- a/docs/Style-Guide/input field.md +++ b/docs/Style-Guide/input field.md @@ -9,8 +9,16 @@ - always set input data patterns to validate the user input - support error handling in case of incorrect input -- enable (where necessary) - hints/tips/infomration icons +- enable (where necessary) - hints/tips/information icons - mandatory/optional data inputs should get highlighted

+ +## NOTICE + +This work is licensed under the [Apache-2.0](https://www.apache.org/licenses/LICENSE-2.0). + +- SPDX-License-Identifier: Apache-2.0 +- SPDX-FileCopyrightText: 2021-2023 Contributors to the Eclipse Foundation +- Source URL: https://github.com/eclipse-tractusx/portal-assets diff --git a/docs/Style-Guide/loading.md b/docs/Style-Guide/loading.md index 0b2f6b240..e742991b1 100644 --- a/docs/Style-Guide/loading.md +++ b/docs/Style-Guide/loading.md @@ -16,3 +16,11 @@ Button loading experience is inside the element itself by showing a loading circ

+ +## NOTICE + +This work is licensed under the [Apache-2.0](https://www.apache.org/licenses/LICENSE-2.0). + +- SPDX-License-Identifier: Apache-2.0 +- SPDX-FileCopyrightText: 2021-2023 Contributors to the Eclipse Foundation +- Source URL: https://github.com/eclipse-tractusx/portal-assets diff --git a/docs/Style-Guide/scrollbar.md b/docs/Style-Guide/scrollbar.md index 84eb2aff7..60cbf2c36 100644 --- a/docs/Style-Guide/scrollbar.md +++ b/docs/Style-Guide/scrollbar.md @@ -3,3 +3,11 @@ image
+ +## NOTICE + +This work is licensed under the [Apache-2.0](https://www.apache.org/licenses/LICENSE-2.0). + +- SPDX-License-Identifier: Apache-2.0 +- SPDX-FileCopyrightText: 2021-2023 Contributors to the Eclipse Foundation +- Source URL: https://github.com/eclipse-tractusx/portal-assets diff --git a/docs/Style-Guide/searchbar.md b/docs/Style-Guide/searchbar.md index 14076eb4d..34154e22f 100644 --- a/docs/Style-Guide/searchbar.md +++ b/docs/Style-Guide/searchbar.md @@ -19,9 +19,9 @@ A search bar can be displayed alone, or in a navigation bar or content view. Whe #### Context and usage -Use a search bar instead of a standard input field to implement the serach function. +Use a search bar instead of a standard input field to implement the search function. Implement a clear button to give the user the chance to delete the entered value. -Ensure that the user can terminate the serach with a cancel button. +Ensure that the user can terminate the search with a cancel button. #### Guidance @@ -34,3 +34,11 @@ Ensure that the user can terminate the serach with a cancel button.

+ +## NOTICE + +This work is licensed under the [Apache-2.0](https://www.apache.org/licenses/LICENSE-2.0). + +- SPDX-License-Identifier: Apache-2.0 +- SPDX-FileCopyrightText: 2021-2023 Contributors to the Eclipse Foundation +- Source URL: https://github.com/eclipse-tractusx/portal-assets diff --git a/docs/Style-Guide/toast message.md b/docs/Style-Guide/toast message.md index dada0d379..54aa0351b 100644 --- a/docs/Style-Guide/toast message.md +++ b/docs/Style-Guide/toast message.md @@ -25,3 +25,11 @@ If a user does hover on a toast message, the auto closure timer is stopped and w

+ +## NOTICE + +This work is licensed under the [Apache-2.0](https://www.apache.org/licenses/LICENSE-2.0). + +- SPDX-License-Identifier: Apache-2.0 +- SPDX-FileCopyrightText: 2021-2023 Contributors to the Eclipse Foundation +- Source URL: https://github.com/eclipse-tractusx/portal-assets diff --git a/docs/static/CompanyApplicationTypes.png.license b/docs/static/CompanyApplicationTypes.png.license new file mode 100644 index 000000000..8bbb33d7f --- /dev/null +++ b/docs/static/CompanyApplicationTypes.png.license @@ -0,0 +1,6 @@ +This work is licensed under the [CC-BY-4.0](https://creativecommons.org/licenses/by/4.0/legalcode). + +- SPDX-License-Identifier: CC-BY-4.0 +- SPDX-FileCopyrightText: Copyright (c) 2021, 2023 Contributors to the Eclipse Foundation +- Source URL: https://github.com/eclipse-tractusx/portal-assets + diff --git a/docs/static/CompanySsiDatabase.png.license b/docs/static/CompanySsiDatabase.png.license new file mode 100644 index 000000000..8bbb33d7f --- /dev/null +++ b/docs/static/CompanySsiDatabase.png.license @@ -0,0 +1,6 @@ +This work is licensed under the [CC-BY-4.0](https://creativecommons.org/licenses/by/4.0/legalcode). + +- SPDX-License-Identifier: CC-BY-4.0 +- SPDX-FileCopyrightText: Copyright (c) 2021, 2023 Contributors to the Eclipse Foundation +- Source URL: https://github.com/eclipse-tractusx/portal-assets + diff --git a/docs/static/IdentityProvidersUpdate.png.license b/docs/static/IdentityProvidersUpdate.png.license new file mode 100644 index 000000000..8bbb33d7f --- /dev/null +++ b/docs/static/IdentityProvidersUpdate.png.license @@ -0,0 +1,6 @@ +This work is licensed under the [CC-BY-4.0](https://creativecommons.org/licenses/by/4.0/legalcode). + +- SPDX-License-Identifier: CC-BY-4.0 +- SPDX-FileCopyrightText: Copyright (c) 2021, 2023 Contributors to the Eclipse Foundation +- Source URL: https://github.com/eclipse-tractusx/portal-assets + diff --git a/docs/static/ServiceDetails.png.license b/docs/static/ServiceDetails.png.license new file mode 100644 index 000000000..8bbb33d7f --- /dev/null +++ b/docs/static/ServiceDetails.png.license @@ -0,0 +1,6 @@ +This work is licensed under the [CC-BY-4.0](https://creativecommons.org/licenses/by/4.0/legalcode). + +- SPDX-License-Identifier: CC-BY-4.0 +- SPDX-FileCopyrightText: Copyright (c) 2021, 2023 Contributors to the Eclipse Foundation +- Source URL: https://github.com/eclipse-tractusx/portal-assets + diff --git a/docs/static/company-ssi-database.png.license b/docs/static/company-ssi-database.png.license new file mode 100644 index 000000000..8bbb33d7f --- /dev/null +++ b/docs/static/company-ssi-database.png.license @@ -0,0 +1,6 @@ +This work is licensed under the [CC-BY-4.0](https://creativecommons.org/licenses/by/4.0/legalcode). + +- SPDX-License-Identifier: CC-BY-4.0 +- SPDX-FileCopyrightText: Copyright (c) 2021, 2023 Contributors to the Eclipse Foundation +- Source URL: https://github.com/eclipse-tractusx/portal-assets + diff --git a/docs/static/use-case-database.png.license b/docs/static/use-case-database.png.license new file mode 100644 index 000000000..8bbb33d7f --- /dev/null +++ b/docs/static/use-case-database.png.license @@ -0,0 +1,6 @@ +This work is licensed under the [CC-BY-4.0](https://creativecommons.org/licenses/by/4.0/legalcode). + +- SPDX-License-Identifier: CC-BY-4.0 +- SPDX-FileCopyrightText: Copyright (c) 2021, 2023 Contributors to the Eclipse Foundation +- Source URL: https://github.com/eclipse-tractusx/portal-assets + diff --git a/public/assets/content/de/usecase.json b/public/assets/content/de/usecase.json index b561f6ab1..c70af894c 100644 --- a/public/assets/content/de/usecase.json +++ b/public/assets/content/de/usecase.json @@ -115,7 +115,10 @@ }, { "title": "", - "subTitles": ["Bei kritischen Qualitätsthemen wird mithilfe der Quality Investigations und Quality Alerts eine schnelle Weiterleitung von Nachrichten auf", "Basis des zuvor beschriebenen Datenaustausches und damit der konkreten Produktstrukturen („as built“) und der damit verbundenen Lieferbeziehungen ermöglicht. Dies beschleunigt die Qualitätsarbeit und reduziert Kosten entlang der gesamten Wertschöpfungskette."], + "subTitles": [ + "Bei kritischen Qualitätsthemen wird mithilfe der Quality Investigations und Quality Alerts eine schnelle Weiterleitung von Nachrichten auf", + "Basis des zuvor beschriebenen Datenaustausches und damit der konkreten Produktstrukturen („as built“) und der damit verbundenen Lieferbeziehungen ermöglicht. Dies beschleunigt die Qualitätsarbeit und reduziert Kosten entlang der gesamten Wertschöpfungskette." + ], "id": "details3-id", "backgroundColor": "#f9f9f9", "template": "TextCenterAlignedBody2" diff --git a/public/assets/content/en/usecase.json b/public/assets/content/en/usecase.json index b6dd5ff75..56c1c8d62 100644 --- a/public/assets/content/en/usecase.json +++ b/public/assets/content/en/usecase.json @@ -83,7 +83,7 @@ "imagePath": "/images/content/traceability_datamodels(en).svg", "backgroundColor": "#FFFFFF", "id": "data-model-id", - "images": ["/images/content/traceability_datamodels1(en).svg"], + "images": ["/images/content/traceability_datamodels1(en).svg"], "template": "TextImageCenterAligned" }, { @@ -115,7 +115,9 @@ }, { "title": "", - "subTitles": ["When it comes to critical quality issues, Quality Investigations and Quality Alerts enable rapid forwarding of messages based on the data exchange described above and thus the specific product structures (“as built”) and the associated supply relationships. This speeds up quality work and reduces costs along the entire value chain."], + "subTitles": [ + "When it comes to critical quality issues, Quality Investigations and Quality Alerts enable rapid forwarding of messages based on the data exchange described above and thus the specific product structures (“as built”) and the associated supply relationships. This speeds up quality work and reduces costs along the entire value chain." + ], "id": "details3-id", "backgroundColor": "#f9f9f9", "template": "TextCenterAlignedBody2" diff --git a/scripts/add_notice_footer.sh b/scripts/add_notice_footer.sh new file mode 100755 index 000000000..c29e55b94 --- /dev/null +++ b/scripts/add_notice_footer.sh @@ -0,0 +1,57 @@ +#!/bin/bash + +############################################################### +# Copyright (c) 2021, 2023 Contributors to the Eclipse Foundation +# +# See the NOTICE file(s) distributed with this work for additional +# information regarding copyright ownership. +# +# This program and the accompanying materials are made available under the +# terms of the Apache License, Version 2.0 which is available at +# https://www.apache.org/licenses/LICENSE-2.0. +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, WITHOUT +# WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the +# License for the specific language governing permissions and limitations +# under the License. +# +# SPDX-License-Identifier: Apache-2.0 +############################################################### + +print-usage() { + cat << EOF +# +# Add license notice to all md files +# +# usage: +# source ./scripts/add_notice_footer.sh +# cd path/to/your/documentation +# add-notice +# +EOF +} + +add-notice() { + notice_text='''## NOTICE + +This work is licensed under the [Apache-2.0](https://www.apache.org/licenses/LICENSE-2.0). + +- SPDX-License-Identifier: Apache-2.0 +- SPDX-FileCopyrightText: 2021-2023 Contributors to the Eclipse Foundation +- Source URL: https://github.com/eclipse-tractusx/portal-assets''' + + # Find all .md files in the directory and its subdirectories, excluding directories from the search + find . -type f -name "*.md" -print0 | while IFS= read -r -d '' file; do + last_line=$(tail -n 7 "$file") + + # Check if the last line of the file matches the notice text + if [ "$last_line" != "$notice_text" ]; then + # Append the notice text if it's not already there + echo -e "\n$notice_text" >> "$file" + echo "Notice added to $file" + fi + done +} + +print-usage \ No newline at end of file