Skip to content

Commit 39925fe

Browse files
docs: create documentation for SD Factory skip toogle (#396)
eclipse-tractusx/sig-release#796
1 parent df9ab78 commit 39925fe

File tree

2 files changed

+132
-0
lines changed

2 files changed

+132
-0
lines changed
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,115 @@
1+
# Disable Clearinghouse connectivity for Self-Description (SD) functionalities
2+
3+
## Application Checklist Level
4+
5+
```mermaid
6+
flowchart TD
7+
AA[Application Checklist Level]
8+
AB{"clearinghouseConnectDisabled"}
9+
AC["SELF_DESCRIPTION_LP = SKIPPED"]
10+
AD{"Await Self Description Response"}
11+
AE[REGISTRATION_VERIFICATION = DONE]
12+
AF[BUSINESS_PARTNER_NUMBER = DONE]
13+
AG[IDENTITY_WALLET = DONE]
14+
AGA[BPNL_CREDENTIAL = DONE]
15+
AGB[MEMBERSHIP_CREDENTIAL = DONE]
16+
AH[CLEARING_HOUSE = DONE]
17+
AI[SELF_DESCRIPTION_LP = TODO]
18+
AJ["Call SD Factory"]
19+
AK["SELF_DESCRIPTION_LP = FAILED"]
20+
AL[APPLICATION_ACTIVATION = TODO]
21+
AM[APPLICATION_ACTIVATION = DONE]
22+
23+
AA --> AE
24+
AE --> AF
25+
AF --> AG
26+
AG --> AGA
27+
AGA --> AGB
28+
AGB --> AH
29+
AH --> AI
30+
AI --> AB
31+
AB -->|FALSE| AJ
32+
AB -->|TRUE|AC
33+
AJ --> AD
34+
AD -->|FAILURE|AK
35+
AK -->|"Retrigger Call to SD Factory Processstep (legal person)"|AI
36+
AC --> AL
37+
AD --> |APPROVED| AL
38+
AL --> AM
39+
```
40+
41+
## Create Connector
42+
43+
```mermaid
44+
flowchart TD
45+
BA[Create Connector]
46+
BB{"clearinghouseConnectDisabled"}
47+
BD{"Legal Person SD available (self_description_document_id)" }
48+
BF["Error 409: provider company {CompanyId} has no self description document"]
49+
BI[Call SD Factory]
50+
BK["Create connector (STATUS = PENDING)"]
51+
BL["Await Self Description Response"]
52+
BM["Store SD with connector"]
53+
BN[Set connector STATUS = ACTIVE]
54+
55+
BA --> BB
56+
BB -->|TRUE|BN
57+
BB -->|FALSE|BD
58+
BD -->|TRUE|BK
59+
BK --> BI
60+
BI --> BL
61+
BD -->|FALSE|BF
62+
BL --> BM
63+
BM --> BN
64+
```
65+
66+
## Trigger - Create Company SD Document
67+
68+
```mermaid
69+
flowchart TD
70+
CA[Company SD Document Retrigger]
71+
CB["Select Company without SD (SD Step Status = SKIPPED or DONE)"]
72+
CC[Call SD Factory]
73+
CD[Store SD with Company]
74+
CE[SELF_DESCRIPTION_COMPANY_CREATION = DONE]
75+
CF{Company SD available}
76+
CG[SELF_DESCRIPTION_COMPANY_CREATION =FAILED]
77+
CH[SELF_DESCRIPTION_COMPANY_CREATION = DONE]
78+
CA --> CB
79+
CB -->|Company does exist| CC
80+
CB -->|Company does not exist|CH
81+
CC --> CF
82+
CF -->|SUCCESS|CE
83+
CF -->|FAILURE|CG
84+
CE --> CD
85+
86+
```
87+
88+
## Trigger - Create Connector SD Document
89+
90+
```mermaid
91+
flowchart TD
92+
DA[Connector SD Document Recreate]
93+
DB["Select Connector(Status=Active & Without Connector SD Document & With Company SD Document)"]
94+
DC[Call SD Factory]
95+
DD[Store SD with Connector]
96+
DE[SELF_DESCRIPTION_COMPANY_CREATION = DONE]
97+
DF{Connector SD available}
98+
DG[SELF_DESCRIPTION_COMPANY_CREATION = FAILED]
99+
DH[SELF_DESCRIPTION_COMPANY_CREATION = DONE]
100+
DA --> DB
101+
DB -->|Connector does exist| DC
102+
DB -->|Connector does not exist|DH
103+
DC --> DF
104+
DF -->|SUCCESS|DE
105+
DE --> DD
106+
DF -->|FAILURE|DG
107+
```
108+
109+
## NOTICE
110+
111+
This work is licensed under the [Apache-2.0](https://www.apache.org/licenses/LICENSE-2.0).
112+
113+
- SPDX-License-Identifier: Apache-2.0
114+
- SPDX-FileCopyrightText: 2024 Contributors to the Eclipse Foundation
115+
- Source URL: https://github.com/eclipse-tractusx/portal-assets
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
1+
# Summary
2+
3+
This feature arises from the current portal's implementation, which mandates the clearinghouse compliance process for creating signed documents for the legal person.
4+
5+
The result is a high dependency in the registration flow on the clearinghouse connection. To ensure a smooth procedure in case of the unavailability of this interface, the toggle was implemented.
6+
7+
This enables the process to be finished, and the customer to proceed with their journey without sacrificing the details in the long run. Due to the implementation of a retrigger process, the data quality is ensured, and the skipped SD information is recreated at a later stage.
8+
9+
- [Use Case Diagrams](../10.%20Disable%20Clearinghouse%20SD/Use-Case-Diagrams.md)
10+
11+
## NOTICE
12+
13+
This work is licensed under the [Apache-2.0](https://www.apache.org/licenses/LICENSE-2.0).
14+
15+
- SPDX-License-Identifier: Apache-2.0
16+
- SPDX-FileCopyrightText: 2024 Contributors to the Eclipse Foundation
17+
- Source URL: https://github.com/eclipse-tractusx/portal-assets

0 commit comments

Comments
 (0)