Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: add missing retrigger steps #386

Merged
merged 3 commits into from
Sep 16, 2024
Merged

docs: add missing retrigger steps #386

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
3136ece
docs: adjust process worker documentation
Phil91 Aug 9, 2024
71290d2
docs: adjust dim pronunciation
Phil91 Aug 12, 2024
94ae4a9
docs: add missing retrigger steps and urls
Phil91 Aug 13, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 4 additions & 4 deletions ...01. Registration/04. Registration Approval/03. Registration Approval Process.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -137,7 +137,7 @@ In case of a failed process step, the error code (if any) is recorded for the ch
#### Details "Manual Validation"

<br>
Associated Process Steps: VERIFY_REGISTRATION
Associated Process Steps: MANUAL_VERIFY_REGISTRATION
<br>
The "manual validation" checklist item is covering the company application validation by the operator. In this step, the application gets manually checked and 'approved' or 'declined'.
Depending on the decision the checklist item "Registration_Verification" is set to DONE or FAILED.
Expand Down Expand Up @@ -399,7 +399,7 @@ If for some reason the call to the identity wallet fails, a new process item "RE
#### Details "Clearinghouse Check"

<br>
Associated Process Steps: START_CLEARING_HOUSE, END_CLEARING_HOUSE
Associated Process Steps: START_CLEARING_HOUSE, AWAIT_CLEARING_HOUSE_RESPONSE
<br>
<br>
The "Clearinghouse Check" is getting automatically triggered when the following pre-requisites are fulfilled:
Expand All @@ -418,7 +418,7 @@ The interface is an asynchronous interface - due to this the application checkli

###### Step 1 - Send company data to clearinghouse

The checklist worker checks for the existence of the "START_CLEARING_HOUSE" process item in state "TODO", when existing the process will automatically get the DID from the Identity Wallet for the company and send the company data displayed below to the clearinghouse endpoint. A new process item "END_CLEARING_HOUSE" is created. And the status of the "CLEARING_HOUSE" checklist item is set to "IN_PROGRESS"
The checklist worker checks for the existence of the "START_CLEARING_HOUSE" process item in state "TODO", when existing the process will automatically get the DID from the Identity Wallet for the company and send the company data displayed below to the clearinghouse endpoint. A new process item "AWAIT_CLEARING_HOUSE_RESPONSE" is created. And the status of the "CLEARING_HOUSE" checklist item is set to "IN_PROGRESS"

{
"participantDetails": {
Expand Down Expand Up @@ -645,7 +645,7 @@ Response Body
"status": "e.g. TO_DO",
"details": "string",
"retriggerableProcessSteps": [
"e.g. VERIFY_REGISTRATION"
"e.g. MANUAL_VERIFY_REGISTRATION"
]
}

Expand Down
2 changes: 1 addition & 1 deletion ...veloper/04. Apps/05. App Subscription/01.App Subscription Request Management.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -182,7 +182,7 @@ GET: /api/apps/{appId}/subscription/{subscriptionId}/provider
],
"tenantUrl": "string",
"appInstanceId": "{iam_clients.client_client_id}",
"processStepTypeId": "VERIFY_REGISTRATION"
"processStepTypeId": "MANUAL_VERIFY_REGISTRATION"
}
```

Expand Down
84 changes: 37 additions & 47 deletions docs/developer/09. Process Workers/01. application_checklist.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ The application checklist process handles the registration process for a new com

```mermaid
flowchart TD
A[VERIFY_REGISTRATION]
A[MANUAL_VERIFY_REGISTRATION]
B(CREATE_BUSINESS_PARTNER_NUMBER_PUSH)
C(CREATE_BUSINESS_PARTNER_NUMBER_PULL)
D(CREATE_BUSINESS_PARTNER_NUMBER_MANUAL)
Expand All @@ -16,22 +16,22 @@ flowchart TD
H(AWAIT_DIM_RESPONSE)
I(VALIDATE_DID_DOCUMENT)
J(REQUEST_BPN_CREDENTIAL)
K(STORED_BPN_CREDENTIAL)
K(AWAIT_BPN_CREDENTIAL_RESPONSE)
L(REQUEST_MEMBERSHIP_CREDENTIAL)
M(STORED_MEMBERSHIP_CREDENTIAL)
M(AWAIT_MEMBERSHIP_CREDENTIAL_RESPONSE)
N(TRANSMIT_BPN_DID)
O(START_CLEARING_HOUSE)
P(END_CLEARING_HOUSE)
P(AWAIT_CLEARING_HOUSE_RESPONSE)
Q(START_SELF_DESCRIPTION_LP)
R(FINISH_SELF_DESCRIPTION_LP)
S(ACTIVATE_APPLICATION)
B -->C
A -->|if CREATE_BUSINESS_PARTNER_NUMBER_MANUAL \n or CREATE_BUSINESS_PARTNER_NUMBER_PULL is done \n and DIM wallet = false| E
C -->|if VERIFY_REGISTRATION is done \n and DIM wallet = false| E
D -->|if VERIFY_REGISTRATION is done \n and DIM wallet = false| E
C -->|if MANUAL_VERIFY_REGISTRATION is done \n and DIM wallet = false| E
D -->|if MANUAL_VERIFY_REGISTRATION is done \n and DIM wallet = false| E
A -->|if CREATE_BUSINESS_PARTNER_NUMBER_MANUAL \n or CREATE_BUSINESS_PARTNER_NUMBER_PULL is done \n and DIM wallet = true| G
C -->|if VERIFY_REGISTRATION is done \n and DIM wallet = true| G
D -->|if VERIFY_REGISTRATION is done \n and DIM wallet = true| G
C -->|if MANUAL_VERIFY_REGISTRATION is done \n and DIM wallet = true| G
D -->|if MANUAL_VERIFY_REGISTRATION is done \n and DIM wallet = true| G
G --> H
H --> I
I --> N
Expand All @@ -53,7 +53,7 @@ The process worker communicates with the DIM (Decentralized Identity Management)

## Process Steps

### VERIFY_REGISTRATION
### MANUAL_VERIFY_REGISTRATION

The process step `CREATE_DIM_TECHNICAL_USER` is not triggered by the process worker it self, it will be processed either when the registration is approved via the endpoint `POST: api/administration/registration/application/{applicationId}/approve` or via the decline endpoint `POST: api/administration/registration/application/{applicationId}/decline`.

Expand Down Expand Up @@ -93,25 +93,25 @@ The process step `TRANSMIT_BPN_DID` retrieves the bpn and did. It than transmits

The process step `REQUEST_BPN_CREDENTIAL` gets the necessary data for the bpn credential creation and calls the issuer component to request the bpn credential. it will post a callback url for the issuer component to do the callback with the status of the credential creation.

### STORED_BPN_CREDENTIAL
### AWAIT_BPN_CREDENTIAL_RESPONSE

The process step `STORED_BPN_CREDENTIAL` is only triggered via api `POST: api/administration/registration/issuer/bpncredential`, the issuer component sends an response to the credential creation regarding its success or error. If the creation was successful the process continues as displayed above. If it fails the process step is failed.
The process step `AWAIT_BPN_CREDENTIAL_RESPONSE` is only triggered via api `POST: api/administration/registration/issuer/bpncredential`, the issuer component sends an response to the credential creation regarding its success or error. If the creation was successful the process continues as displayed above. If it fails the process step is failed.

### REQUEST_MEMBERSHIP_CREDENTIAL

The process step `REQUEST_MEMBERSHIP_CREDENTIAL` gets the necessary data for the membership credential creation and calls the issuer component to request the membership credential. it will post a callback url for the issuer component to do the callback with the status of the credential creation.

### STORED_MEMBERSHIP_CREDENTIAL
### AWAIT_MEMBERSHIP_CREDENTIAL_RESPONSE

The process step `STORED_MEMBERSHIP_CREDENTIAL` is only triggered via api `POST: api/administration/registration/issuer/membershipcredential`, the issuer component sends an response to the credential creation regarding its success or error. If the creation was successful the process continues as displayed above. If it fails the process step is failed.
The process step `AWAIT_MEMBERSHIP_CREDENTIAL_RESPONSE` is only triggered via api `POST: api/administration/registration/issuer/membershipcredential`, the issuer component sends an response to the credential creation regarding its success or error. If the creation was successful the process continues as displayed above. If it fails the process step is failed.

### START_CLEARING_HOUSE

The process step `START_CLEARING_HOUSE` retrieves the company did. If the wallet was created via the DIM middle layer the did is retrieved from the database, if the wallet was created via the miw the did is retrieved via the `/api/wallets` endpoint of the miw. Than all necessary data for the `POST: /api/v1/validation` endpoint are retrieved from the database and the call to clearinghouse is executed.

### END_CLEARING_HOUSE
### AWAIT_CLEARING_HOUSE_RESPONSE

The process step `END_CLEARING_HOUSE` is only triggered via the api `POST api/administration/registration/clearinghouse`. The clearinghouse sends an status to the portal with either the successful validation or an `decline` status. If the status is `DECLINE` the process will be set to failed, otherwise the process continues.
The process step `AWAIT_CLEARING_HOUSE_RESPONSE` is only triggered via the api `POST api/administration/registration/clearinghouse`. The clearinghouse sends an status to the portal with either the successful validation or an `decline` status. If the status is `DECLINE` the process will be set to failed, otherwise the process continues.

### START_SELF_DESCRIPTION_LP

Expand All @@ -127,38 +127,28 @@ In the process step `ACTIVATE_APPLICATION` the users of the onboarded company wi

## Retrigger

| Step Name | Retrigger Possible | Retrigger Endpoint |
| -------------------------------------- | ------------------ | --------------------------------------------------------------------------------------- |
| VERIFY_REGISTRATION | NO | |
| CREATE_BUSINESS_PARTNER_NUMBER_PUSH | YES | api/administration/registration/application/{applicationId}/trigger-bpn |
| CREATE_BUSINESS_PARTNER_NUMBER_PULL | YES | api/administration/registration/application/{applicationId}/trigger-bpn |
| CREATE_BUSINESS_PARTNER_NUMBER_MANUAL | NO | |
| CREATE_IDENTITY_WALLET | YES | api/administration/registration/application/{applicationId}/trigger-identity-wallet |
| RETRIGGER_IDENTITY_WALLET | NO | |
| START_CLEARING_HOUSE | YES | api/administration/registration/application/{applicationId}/retrigger-clearinghouse |
| RETRIGGER_CLEARING_HOUSE | NO | |
| END_CLEARING_HOUSE | NO | |
| START_SELF_DESCRIPTION_LP | YES | api/administration/registration/application/{applicationId}/trigger-self-description |
| RETRIGGER_SELF_DESCRIPTION_LP | NO | |
| ACTIVATE_APPLICATION | NO | |
| RETRIGGER_BUSINESS_PARTNER_NUMBER_PUSH | NO | |
| RETRIGGER_BUSINESS_PARTNER_NUMBER_PULL | NO | |
| OVERRIDE_BUSINESS_PARTNER_NUMBER | NO | |
| TRIGGER_OVERRIDE_CLEARING_HOUSE | NO | |
| START_OVERRIDE_CLEARING_HOUSE | YES | api/administration/registration/application/{applicationId}/override-clearinghouse |
| FINISH_SELF_DESCRIPTION_LP | NO | |
| DECLINE_APPLICATION | NO | |
| CREATE_DIM_WALLET | YES | api/administration/registration/application/{applicationId}/retrigger-create-DIM-wallet |
| AWAIT_DIM_RESPONSE | NO | |
| RETRIGGER_CREATE_DIM_WALLET | NO | |
| VALIDATE_DID_DOCUMENT | YES | api/administration/registration/application/{applicationId}/retrigger-validate-did |
| RETRIGGER_VALIDATE_DID_DOCUMENT | NO | |
| REQUEST_BPN_CREDENTIAL | NO | |
| STORED_BPN_CREDENTIAL | NO | |
| REQUEST_MEMBERSHIP_CREDENTIAL | NO | |
| STORED_MEMBERSHIP_CREDENTIAL | NO | |
| TRANSMIT_BPN_DID | YES | missing |
| RETRIGGER_TRANSMIT_DID_BPN | NO | |
| Step Name | Retrigger Step | Retrigger Endpoint |
| ------------------------------------- | --------------------------------------- | ------------------------------------------------------------------------------------------- |
| MANUAL_VERIFY_REGISTRATION | N/A | |
| CREATE_BUSINESS_PARTNER_NUMBER_PUSH | RETRIGGER_BUSINESS_PARTNER_NUMBER_PUSH | api/administration/registration/application/{applicationId}/trigger-bpn |
| CREATE_BUSINESS_PARTNER_NUMBER_PULL | RETRIGGER_BUSINESS_PARTNER_NUMBER_PULL | api/administration/registration/application/{applicationId}/trigger-bpn |
| CREATE_BUSINESS_PARTNER_NUMBER_MANUAL | N/A | |
| CREATE_IDENTITY_WALLET | RETRIGGER_IDENTITY_WALLET | api/administration/registration/application/{applicationId}/trigger-identity-wallet |
| START_CLEARING_HOUSE | RETRIGGER_CLEARING_HOUSE | api/administration/registration/application/{applicationId}/retrigger-clearinghouse |
| AWAIT_CLEARING_HOUSE_RESPONSE | N/A | |
| START_SELF_DESCRIPTION_LP | RETRIGGER_SELF_DESCRIPTION_LP | api/administration/registration/application/{applicationId}/trigger-self-description |
| ACTIVATE_APPLICATION | N/A | |
| START_OVERRIDE_CLEARING_HOUSE | RETRIGGER_OVERRIDE_CLEARING_HOUSE | api/administration/registration/application/{applicationId}/override-clearinghouse |
| FINISH_SELF_DESCRIPTION_LP | N/A | |
| DECLINE_APPLICATION | N/A | |
| CREATE_DIM_WALLET | RETRIGGER_CREATE_DIM_WALLET | api/administration/registration/application/{applicationId}/retrigger-create-DIM-wallet |
| AWAIT_DIM_RESPONSE | N/A | |
| VALIDATE_DID_DOCUMENT | RETRIGGER_VALIDATE_DID_DOCUMENT | api/administration/registration/application/{applicationId}/retrigger-validate-did |
| REQUEST_BPN_CREDENTIAL | RETRIGGER_REQUEST_BPN_CREDENTIAL | api/administration/registration/application/{applicationId}/retrigger-bpn-credential |
| AWAIT_BPN_CREDENTIAL_RESPONSE | N/A | |
| REQUEST_MEMBERSHIP_CREDENTIAL | RETRIGGER_REQUEST_MEMBERSHIP_CREDENTIAL | api/administration/registration/application/{applicationId}/retrigger-membership-credential |
| AWAIT_MEMBERSHIP_CREDENTIAL_RESPONSE | N/A | |
| TRANSMIT_BPN_DID | RETRIGGER_TRANSMIT_DID_BPN | api/administration/registration/application/{applicationId}/retrigger-transmit-bpn-did |

## NOTICE

Expand Down
Loading