From 108c037fd3e9f17dcd61e39df9cd4f3c5191efff Mon Sep 17 00:00:00 2001 From: MHauer <168809208+MaximilianHauer@users.noreply.github.com> Date: Thu, 11 Jul 2024 07:05:22 +0200 Subject: [PATCH 1/7] Update Onboarding Service Provider (OSP).md updated guide link in section "find & access osps" --- docs/user/00. Personas/Onboarding Service Provider (OSP).md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/user/00. Personas/Onboarding Service Provider (OSP).md b/docs/user/00. Personas/Onboarding Service Provider (OSP).md index e29d1f85f..423acec48 100644 --- a/docs/user/00. Personas/Onboarding Service Provider (OSP).md +++ b/docs/user/00. Personas/Onboarding Service Provider (OSP).md @@ -20,7 +20,7 @@ The purpose of OSPs is to enable a faster growth of the the network on the one h ### Find & Access OSPs The first step is to find an OSP. You're existing partners, that happen to be OSPs for Catena-X might inform you about their status as OSPs and offer you the opportunitity to become a participant in the Catena-X network. Alternatively you can find the list provided by the association, that lists all available OSPs. The individual onboarding process depends on the OSPs individual implementation. That might ie. be a registration form or a semi automatic process handled by your OSP. Ideally you get in contact with them and discuss the available options in order to figure out the availale/best ways to proceed. -As soon as you registered with you OSP, please follow this [guide](docs/user/01.%20Onboarding/OSPDrivenOnboarding.md). +As soon as you registered with you OSP, please follow this [guide](docs/user/01.%20Onboarding/04.%20OSP/01.%20Onboarding%20with%20an%20OSP.md). ## NOTICE From ca4a2eb2cac21a9d3105f727e2a70122e35ac654 Mon Sep 17 00:00:00 2001 From: Maximilian Hauer <168809208+MaximilianHauer@users.noreply.github.com> Date: Mon, 16 Sep 2024 20:26:02 +0200 Subject: [PATCH 2/7] docs: reorder pages + adding activity diagram - added activity diagram created by julia - reordered pages --- .../01. Registration Flow Activity Diagram.md | 87 +++++++++++++++++++ ...n Portal.md => 02. Registration Portal.md} | 0 ...ternal.md => 03. Registration External.md} | 0 3 files changed, 87 insertions(+) create mode 100644 docs/developer/01. Registration/01. Registration Process/01. Registration Flow Activity Diagram.md rename docs/developer/01. Registration/01. Registration Process/{01. Registration Portal.md => 02. Registration Portal.md} (100%) rename docs/developer/01. Registration/01. Registration Process/{02. Registration External.md => 03. Registration External.md} (100%) diff --git a/docs/developer/01. Registration/01. Registration Process/01. Registration Flow Activity Diagram.md b/docs/developer/01. Registration/01. Registration Process/01. Registration Flow Activity Diagram.md new file mode 100644 index 000000000..55925624b --- /dev/null +++ b/docs/developer/01. Registration/01. Registration Process/01. Registration Flow Activity Diagram.md @@ -0,0 +1,87 @@ +```mermaid +flowchart TD + + Start((Start)) -->|Success| VerifyReg[VERIFY_REGISTRATION] + + VerifyReg[VERIFY_REGISTRATION] -->|Success| CreateBPNNPush[CREATE_BUSINESS_PARTNER_NUMBER_PUSH] + + CreateBPNNPush -->|Success| CreateBPNNManual[CREATE_BUSINESS_PARTNER_NUMBER_MANUAL] + + CreateBPNNManual -->|Success| CreateBPNNPull[CREATE_BUSINESS_PARTNER_NUMBER_PULL] + + CreateBPNNPull -->|Success| CreateDimWallet[CREATE_DIM_WALLET] + + CreateDimWallet -->|Success| AwaitDimResponse[AWAIT_DIM_RESPONSE] + + subgraph AwaitDimResponse + + ValidateSchema[Validate DID Document Schema] + + PublishPublic[Publish DID Document Publicly] + + end + + AwaitDimResponse -->|Success| ValidateDidDoc[VALIDATE_DID_DOCUMENT] + + ValidateDidDoc -->|Success| TransmitBPNDID[TRANSMIT_BPN_DID] + + subgraph TransmitBPNDID + + StoreDIDLocBPNL[Store DID Document Location with BPNL in BDRS Service] + + end + + TransmitBPNDID -->|Success| RequestBPNCred[REQUEST_BPN_CREDENTIAL] + + RequestBPNCred -->|Success| StoredBPNCred[STORED_BPN_CREDENTIAL] + + StoredBPNCred -->|Success| RequestMemCred[REQUEST_MEMBERSHIP_CREDENTIAL] + + subgraph RequestMemCred + + InterfaceIssuer[Interface to Issuer Component] + + IssueWithWallet[Issuance with Wallet] + + end + + RequestMemCred -->|Success| StoredMemCred[STORED_MEMBERSHIP_CREDENTIAL] + + StoredMemCred -->|Success| StartClearing[START_CLEARING_HOUSE] + + StartClearing -->|Success| EndClearing[END_CLEARING_HOUSE] + + EndClearing -->|Validation Error| TriggerOverride[TRIGGER_OVERRIDE_CLEARING_HOUSE] + + EndClearing -->|No Error| StartSelfDescLP[START_SELF_DESCRIPTION_LP] + + StartSelfDescLP -->|Success| EndSelfDescLP[END_SELF_DESCRIPTION_LP] + + EndSelfDescLP -->|Failure| RetriggerSelfDescLP[RETRIGGER_SELF_DESCRIPTION_LP] + + EndSelfDescLP -->|Success| Finish(APPLICATION_ACTIVATION) + + TriggerOverride -->|Success| StartSelfDescLP + + RetriggerSelfDescLP -->|Success| Finish + + VerifyReg --> DeclineReg[Decline Registration]:::declineProcess --> Declined((DECLINED)) + + CreateBPNNPush -->|Failure| DeclineReg + CreateBPNNManual -->|Failure| DeclineReg + CreateBPNNPull -->|Failure| DeclineReg + CreateDimWallet -->|Failure| DeclineReg + AwaitDimResponse -->|Failure| DeclineReg + ValidateDidDoc -->|Failure| DeclineReg + TransmitBPNDID -->|Failure| DeclineReg + RequestBPNCred -->|Failure| DeclineReg + StoredBPNCred -->|Failure| DeclineReg + RequestMemCred -->|Failure| DeclineReg + StoredMemCred -->|Failure| DeclineReg + StartClearing -->|Failure| DeclineReg + EndClearing -->|Failure| DeclineReg + StartSelfDescLP -->|Failure| DeclineReg + EndSelfDescLP -->|Failure| DeclineReg + TriggerOverride -->|Failure| DeclineReg + RetriggerSelfDescLP -->|Failure| DeclineReg +``` \ No newline at end of file diff --git a/docs/developer/01. Registration/01. Registration Process/01. Registration Portal.md b/docs/developer/01. Registration/01. Registration Process/02. Registration Portal.md similarity index 100% rename from docs/developer/01. Registration/01. Registration Process/01. Registration Portal.md rename to docs/developer/01. Registration/01. Registration Process/02. Registration Portal.md diff --git a/docs/developer/01. Registration/01. Registration Process/02. Registration External.md b/docs/developer/01. Registration/01. Registration Process/03. Registration External.md similarity index 100% rename from docs/developer/01. Registration/01. Registration Process/02. Registration External.md rename to docs/developer/01. Registration/01. Registration Process/03. Registration External.md From c5ec30cc98fbaccd608bb402b48b318fd5c40930 Mon Sep 17 00:00:00 2001 From: Maximilian Hauer <168809208+MaximilianHauer@users.noreply.github.com> Date: Mon, 16 Sep 2024 20:29:40 +0200 Subject: [PATCH 3/7] docs: added notice section --- .../01. Registration Flow Activity Diagram.md | 15 ++++++++++++++- 1 file changed, 14 insertions(+), 1 deletion(-) diff --git a/docs/developer/01. Registration/01. Registration Process/01. Registration Flow Activity Diagram.md b/docs/developer/01. Registration/01. Registration Process/01. Registration Flow Activity Diagram.md index 55925624b..a06092401 100644 --- a/docs/developer/01. Registration/01. Registration Process/01. Registration Flow Activity Diagram.md +++ b/docs/developer/01. Registration/01. Registration Process/01. Registration Flow Activity Diagram.md @@ -1,4 +1,9 @@ +# Registration Flow - Activity Diagram + +## Activity Diagram + ```mermaid + flowchart TD Start((Start)) -->|Success| VerifyReg[VERIFY_REGISTRATION] @@ -84,4 +89,12 @@ flowchart TD EndSelfDescLP -->|Failure| DeclineReg TriggerOverride -->|Failure| DeclineReg RetriggerSelfDescLP -->|Failure| DeclineReg -``` \ No newline at end of file +``` + +## NOTICE + +This work is licensed under the [Apache-2.0](https://www.apache.org/licenses/LICENSE-2.0). + +- SPDX-License-Identifier: Apache-2.0 +- SPDX-FileCopyrightText: 2024 Contributors to the Eclipse Foundation +- Source URL: https://github.com/eclipse-tractusx/portal-assets From 947b5b26e7eb88a6bcef5deead68d4958aa57662 Mon Sep 17 00:00:00 2001 From: Maximilian Hauer <168809208+MaximilianHauer@users.noreply.github.com> Date: Mon, 16 Sep 2024 20:44:52 +0200 Subject: [PATCH 4/7] Revert "Update Onboarding Service Provider (OSP).md" This reverts commit 108c037fd3e9f17dcd61e39df9cd4f3c5191efff. --- docs/user/00. Personas/Onboarding Service Provider (OSP).md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/user/00. Personas/Onboarding Service Provider (OSP).md b/docs/user/00. Personas/Onboarding Service Provider (OSP).md index 423acec48..e29d1f85f 100644 --- a/docs/user/00. Personas/Onboarding Service Provider (OSP).md +++ b/docs/user/00. Personas/Onboarding Service Provider (OSP).md @@ -20,7 +20,7 @@ The purpose of OSPs is to enable a faster growth of the the network on the one h ### Find & Access OSPs The first step is to find an OSP. You're existing partners, that happen to be OSPs for Catena-X might inform you about their status as OSPs and offer you the opportunitity to become a participant in the Catena-X network. Alternatively you can find the list provided by the association, that lists all available OSPs. The individual onboarding process depends on the OSPs individual implementation. That might ie. be a registration form or a semi automatic process handled by your OSP. Ideally you get in contact with them and discuss the available options in order to figure out the availale/best ways to proceed. -As soon as you registered with you OSP, please follow this [guide](docs/user/01.%20Onboarding/04.%20OSP/01.%20Onboarding%20with%20an%20OSP.md). +As soon as you registered with you OSP, please follow this [guide](docs/user/01.%20Onboarding/OSPDrivenOnboarding.md). ## NOTICE From 0d1500b9c82db9f72627c4443d86e09b089d21de Mon Sep 17 00:00:00 2001 From: Maximilian Hauer <168809208+MaximilianHauer@users.noreply.github.com> Date: Wed, 25 Sep 2024 08:56:09 +0200 Subject: [PATCH 5/7] docs: replaced failure with error --- .../01. Registration Flow Activity Diagram.md | 40 +++++++++---------- 1 file changed, 20 insertions(+), 20 deletions(-) diff --git a/docs/developer/01. Registration/01. Registration Process/01. Registration Flow Activity Diagram.md b/docs/developer/01. Registration/01. Registration Process/01. Registration Flow Activity Diagram.md index a06092401..1678f184b 100644 --- a/docs/developer/01. Registration/01. Registration Process/01. Registration Flow Activity Diagram.md +++ b/docs/developer/01. Registration/01. Registration Process/01. Registration Flow Activity Diagram.md @@ -62,7 +62,7 @@ flowchart TD StartSelfDescLP -->|Success| EndSelfDescLP[END_SELF_DESCRIPTION_LP] - EndSelfDescLP -->|Failure| RetriggerSelfDescLP[RETRIGGER_SELF_DESCRIPTION_LP] + EndSelfDescLP -->|Error| RetriggerSelfDescLP[RETRIGGER_SELF_DESCRIPTION_LP] EndSelfDescLP -->|Success| Finish(APPLICATION_ACTIVATION) @@ -70,25 +70,25 @@ flowchart TD RetriggerSelfDescLP -->|Success| Finish - VerifyReg --> DeclineReg[Decline Registration]:::declineProcess --> Declined((DECLINED)) - - CreateBPNNPush -->|Failure| DeclineReg - CreateBPNNManual -->|Failure| DeclineReg - CreateBPNNPull -->|Failure| DeclineReg - CreateDimWallet -->|Failure| DeclineReg - AwaitDimResponse -->|Failure| DeclineReg - ValidateDidDoc -->|Failure| DeclineReg - TransmitBPNDID -->|Failure| DeclineReg - RequestBPNCred -->|Failure| DeclineReg - StoredBPNCred -->|Failure| DeclineReg - RequestMemCred -->|Failure| DeclineReg - StoredMemCred -->|Failure| DeclineReg - StartClearing -->|Failure| DeclineReg - EndClearing -->|Failure| DeclineReg - StartSelfDescLP -->|Failure| DeclineReg - EndSelfDescLP -->|Failure| DeclineReg - TriggerOverride -->|Failure| DeclineReg - RetriggerSelfDescLP -->|Failure| DeclineReg + VerifyReg --> DeclineReg["Decline Registration (retrigger possible )"]:::declineProcess --> Declined((DECLINED)) + + CreateBPNNPush -->|Error| DeclineReg + CreateBPNNManual -->|Error| DeclineReg + CreateBPNNPull -->|Error| DeclineReg + CreateDimWallet -->|Error| DeclineReg + AwaitDimResponse -->|Error| DeclineReg + ValidateDidDoc -->|Error| DeclineReg + TransmitBPNDID -->|Error| DeclineReg + RequestBPNCred -->|Error| DeclineReg + StoredBPNCred -->|Error| DeclineReg + RequestMemCred -->|Error| DeclineReg + StoredMemCred -->|Error| DeclineReg + StartClearing -->|Error| DeclineReg + EndClearing -->|Error| DeclineReg + StartSelfDescLP -->|Error| DeclineReg + EndSelfDescLP -->|Error| DeclineReg + TriggerOverride -->|Error| DeclineReg + RetriggerSelfDescLP -->|Error| DeclineReg ``` ## NOTICE From 4d46569f5885d0d5897e5dc77bb7a983f8efd316 Mon Sep 17 00:00:00 2001 From: Maximilian Hauer <168809208+MaximilianHauer@users.noreply.github.com> Date: Wed, 25 Sep 2024 08:57:55 +0200 Subject: [PATCH 6/7] docs: removed spaces --- .../01. Registration Flow Activity Diagram.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/developer/01. Registration/01. Registration Process/01. Registration Flow Activity Diagram.md b/docs/developer/01. Registration/01. Registration Process/01. Registration Flow Activity Diagram.md index 1678f184b..93d36d577 100644 --- a/docs/developer/01. Registration/01. Registration Process/01. Registration Flow Activity Diagram.md +++ b/docs/developer/01. Registration/01. Registration Process/01. Registration Flow Activity Diagram.md @@ -70,7 +70,7 @@ flowchart TD RetriggerSelfDescLP -->|Success| Finish - VerifyReg --> DeclineReg["Decline Registration (retrigger possible )"]:::declineProcess --> Declined((DECLINED)) + VerifyReg --> DeclineReg["Decline Registration (retrigger possible)"]:::declineProcess --> Declined((DECLINED)) CreateBPNNPush -->|Error| DeclineReg CreateBPNNManual -->|Error| DeclineReg From ea1c9251fdf3c15b841cc2f8bfdbf414fb92927f Mon Sep 17 00:00:00 2001 From: Maximilian Hauer <168809208+MaximilianHauer@users.noreply.github.com> Date: Wed, 25 Sep 2024 08:58:52 +0200 Subject: [PATCH 7/7] docs: removed (retrigger possible) --- .../01. Registration Flow Activity Diagram.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/developer/01. Registration/01. Registration Process/01. Registration Flow Activity Diagram.md b/docs/developer/01. Registration/01. Registration Process/01. Registration Flow Activity Diagram.md index 93d36d577..5139f0df1 100644 --- a/docs/developer/01. Registration/01. Registration Process/01. Registration Flow Activity Diagram.md +++ b/docs/developer/01. Registration/01. Registration Process/01. Registration Flow Activity Diagram.md @@ -70,7 +70,7 @@ flowchart TD RetriggerSelfDescLP -->|Success| Finish - VerifyReg --> DeclineReg["Decline Registration (retrigger possible)"]:::declineProcess --> Declined((DECLINED)) + VerifyReg --> DeclineReg["Decline Registration"]:::declineProcess --> Declined((DECLINED)) CreateBPNNPush -->|Error| DeclineReg CreateBPNNManual -->|Error| DeclineReg