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

Jump to bottom

feature(devDocu)/checklist worker autosetup #130

Draft
wants to merge 3 commits into
base: main
Choose a base branch
from
Draft

feature(devDocu)/checklist worker autosetup #130

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
3bf5b34
feature(devDocu)/checklist worker autosetup
jjeroch Mar 24, 2023
e86ec03
Update Offer-Autosetup.md
jjeroch Mar 24, 2023
141f4cd
Update Offer-Autosetup.md
jjeroch Mar 27, 2023
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
11 changes: 11 additions & 0 deletions developer/Technical Documentation/Interface Contracts/Offer-Autosetup.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -165,5 +165,16 @@ Response Body
<br>
<br>

## Checklist Worker

| Process Step | Description | Success Scenario | Error (process_step status FAILED) | Auto Retrigger? | Manual Retrigger? | Possible Following Steps |
|---|---|---|---|---|---|---|
| 100<br>Trigger Provider | Subscription Record creation in "PENDING" <br>Portal triggers the Offer Provider URL (if provider url is stored) | If the provider endpoint is responding with 20x <br>the process step will get set to "DONE" and "SKIPPED" if no URL is available | ?? | Yes, in case of an 5xx | Yes, in case of an 400 (wrong content) 404 (wrong url) | Multi Instance: #101 <br> Single Instance: #103 |
| 101<br>Start Autosetup | Provider is triggering the portal autosetup endpoint with necessary offer details<br>the step will trigger the portal internal autosetup jobs (102, 103, 104, 105) | The process step is set to "DONE" <br>with successful endpoint request body (which is getting stored in a temp table) | - | - | Step stays on "TO_DO" till the endpoint got successfully triggered (content is correct) | Apps: #102 <br>Services: #104 |
| 102<br>OfferSubscription Client Creation | Created app client in Keycloak and DB, additionally app instance is getting created | The process step is set to "DONE" <br>after all records are 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 | #104 <br>#105 |
| 103<br>Single Instance Subscription Details Creation | Single Instance Subscription Details Creation | The process step is set to "DONE" <br>as soon as the url and instance is linked | | - | - | #105 |
| 104<br>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" <br>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<br>Activate Subscription | Subscription record activation, notification creation and send email. | The process step is set to "DONE" <br>after xxx | xxx | Yes, in case of an 5xx for the email - auto "TO_DO" | - | Multi Instance: #106 <br> Single Instance: - |
| 106<br>Trigger Provider Callback | Trigger provider callback url to share client and utech user. | The process step is set to "DONE" <br>after xxx | xxx | Yes, in case of an 5xx | Yes, in case of an 4xx | - |