From 3bf5b3495d45747c736c94f16420d83e0606371e Mon Sep 17 00:00:00 2001 From: jjeroch <94133633+jjeroch@users.noreply.github.com> Date: Fri, 24 Mar 2023 14:20:59 +0100 Subject: [PATCH 1/3] feature(devDocu)/checklist worker autosetup --- .../Interface Contracts/Offer-Autosetup.md | 11 +++++++++++ 1 file changed, 11 insertions(+) diff --git a/developer/Technical Documentation/Interface Contracts/Offer-Autosetup.md b/developer/Technical Documentation/Interface Contracts/Offer-Autosetup.md index 69f222e68..34145ed09 100644 --- a/developer/Technical Documentation/Interface Contracts/Offer-Autosetup.md +++ b/developer/Technical Documentation/Interface Contracts/Offer-Autosetup.md @@ -165,5 +165,16 @@ Response Body

+## Checklist Worker + +| Process Step | Description | Success Scenario | Error (process_step status FAILED) | Auto Retrigger? | Manual Retrigger? | Possible Following Steps | +|---|---|---|---|---|---|---| +| 100
Trigger Provider | Portal triggers the Offer Provider URL (if provider url is stored) | If the provider endpoint is responding with 20x
the process step will get set to "DONE" | ?? | Yes, in case of an 5xx | Yes, in case of an 4xx
(new, in the ticket I asked to autoretrigger, but maybe thats not possible) | #101 | +| 101
Start Autosetup | Provider is triggering the portal autosetup endpoint with necessary offer details
the step will trigger the portal internal autosetup jobs (102, 103, 104, 105) | The process step is set to "DONE"
with successful endpoint request body | In case anything mandatory of the request body is missing | - | As long as the step is in statsu "TO_DO" the provider can retrigger the endpoint | Apps: #102
Services: #104 | +| 102
OfferSubscription Client Creation | Created app client in Keycloak and DB, additionally app instance is getting created | The process step is set to "DONE"
after all records are created | Status "FAILED" if job was running on fail | Yes, in case of an 5xx | Yes, in case of an 4xx | #104
#105 | +| 103
Single Instance Subscription Details Creation | Single Instance Subscription Details Creation | The process step is set to "DONE"
after subscription record got successfully created - Status "PENDING" | | Yes, in case of an 5xx (db issue) | - | #105 | +| 104
xxx | Technical User creation in keycloak and metadata storage in portal db | The process step is set to "DONE"
after technical user ot successfully created | xxx | Yes, in case of an 5xx | Yes, in case of an 4xx | #105 | +| 105
xxx | Subscription record activation, notification creation and send email. | The process step is set to "DONE"
after xxx | xxx | Yes, in case of an 5xx | Yes, in case of an 4xx | Multi Instance: #106
Single Instance: - | +| 106
Trigger Provider Callback | Trigger provider callback url to share client and utech user. | The process step is set to "DONE"
after xxx | xxx | Yes, in case of an 5xx | Yes, in case of an 4xx | - | From e86ec0333127a6eff35d0569ba74891dd9fdf0a9 Mon Sep 17 00:00:00 2001 From: jjeroch <94133633+jjeroch@users.noreply.github.com> Date: Fri, 24 Mar 2023 17:06:30 +0100 Subject: [PATCH 2/3] Update Offer-Autosetup.md --- .../Interface Contracts/Offer-Autosetup.md | 12 ++++++------ 1 file changed, 6 insertions(+), 6 deletions(-) diff --git a/developer/Technical Documentation/Interface Contracts/Offer-Autosetup.md b/developer/Technical Documentation/Interface Contracts/Offer-Autosetup.md index 34145ed09..58ff898a3 100644 --- a/developer/Technical Documentation/Interface Contracts/Offer-Autosetup.md +++ b/developer/Technical Documentation/Interface Contracts/Offer-Autosetup.md @@ -169,12 +169,12 @@ Response Body | Process Step | Description | Success Scenario | Error (process_step status FAILED) | Auto Retrigger? | Manual Retrigger? | Possible Following Steps | |---|---|---|---|---|---|---| -| 100
Trigger Provider | Portal triggers the Offer Provider URL (if provider url is stored) | If the provider endpoint is responding with 20x
the process step will get set to "DONE" | ?? | Yes, in case of an 5xx | Yes, in case of an 4xx
(new, in the ticket I asked to autoretrigger, but maybe thats not possible) | #101 | -| 101
Start Autosetup | Provider is triggering the portal autosetup endpoint with necessary offer details
the step will trigger the portal internal autosetup jobs (102, 103, 104, 105) | The process step is set to "DONE"
with successful endpoint request body | In case anything mandatory of the request body is missing | - | As long as the step is in statsu "TO_DO" the provider can retrigger the endpoint | Apps: #102
Services: #104 | -| 102
OfferSubscription Client Creation | Created app client in Keycloak and DB, additionally app instance is getting created | The process step is set to "DONE"
after all records are created | Status "FAILED" if job was running on fail | Yes, in case of an 5xx | Yes, in case of an 4xx | #104
#105 | -| 103
Single Instance Subscription Details Creation | Single Instance Subscription Details Creation | The process step is set to "DONE"
after subscription record got successfully created - Status "PENDING" | | Yes, in case of an 5xx (db issue) | - | #105 | -| 104
xxx | Technical User creation in keycloak and metadata storage in portal db | The process step is set to "DONE"
after technical user ot successfully created | xxx | Yes, in case of an 5xx | Yes, in case of an 4xx | #105 | -| 105
xxx | Subscription record activation, notification creation and send email. | The process step is set to "DONE"
after xxx | xxx | Yes, in case of an 5xx | Yes, in case of an 4xx | Multi Instance: #106
Single Instance: - | +| 100
Trigger Provider | Subscription Record creation in "PENDING"
Portal triggers the Offer Provider URL (if provider url is stored) | If the provider endpoint is responding with 20x
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
Single Instance: #103 | +| 101
Start Autosetup | Provider is triggering the portal autosetup endpoint with necessary offer details
the step will trigger the portal internal autosetup jobs (102, 103, 104, 105) | The process step is set to "DONE"
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
Services: #104 | +| 102
OfferSubscription Client Creation | Created app client in Keycloak and DB, additionally app instance is getting created | The process step is set to "DONE"
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
#105 | +| 103
Single Instance Subscription Details Creation | Single Instance Subscription Details Creation | The process step is set to "DONE"
as soon as the url and instance is linked | | - | - | #105 | +| 104
xxx | 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
xxx | 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 utech user. | The process step is set to "DONE"
after xxx | xxx | Yes, in case of an 5xx | Yes, in case of an 4xx | - | From 141f4cd94aa4b98c1fdb5072910133fce9b9f63d Mon Sep 17 00:00:00 2001 From: jjeroch <94133633+jjeroch@users.noreply.github.com> Date: Mon, 27 Mar 2023 09:27:25 +0200 Subject: [PATCH 3/3] Update Offer-Autosetup.md --- .../Interface Contracts/Offer-Autosetup.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/developer/Technical Documentation/Interface Contracts/Offer-Autosetup.md b/developer/Technical Documentation/Interface Contracts/Offer-Autosetup.md index 58ff898a3..9541cca3a 100644 --- a/developer/Technical Documentation/Interface Contracts/Offer-Autosetup.md +++ b/developer/Technical Documentation/Interface Contracts/Offer-Autosetup.md @@ -173,8 +173,8 @@ Response Body | 101
Start Autosetup | Provider is triggering the portal autosetup endpoint with necessary offer details
the step will trigger the portal internal autosetup jobs (102, 103, 104, 105) | The process step is set to "DONE"
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
Services: #104 | | 102
OfferSubscription Client Creation | Created app client in Keycloak and DB, additionally app instance is getting created | The process step is set to "DONE"
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
#105 | | 103
Single Instance Subscription Details Creation | Single Instance Subscription Details Creation | The process step is set to "DONE"
as soon as the url and instance is linked | | - | - | #105 | -| 104
xxx | 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
xxx | 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: - | +| 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 utech user. | The process step is set to "DONE"
after xxx | xxx | Yes, in case of an 5xx | Yes, in case of an 4xx | - |