From 57da583b50ddf321c38ea7b6d4d804d0137b563e Mon Sep 17 00:00:00 2001 From: jjeroch <94133633+jjeroch@users.noreply.github.com> Date: Wed, 29 Mar 2023 09:32:25 +0200 Subject: [PATCH 01/10] feature(migration): migration script --- developer/portal-upgrade-details.md | 50 +++++++++++++++++++++++++++++ 1 file changed, 50 insertions(+) create mode 100644 developer/portal-upgrade-details.md diff --git a/developer/portal-upgrade-details.md b/developer/portal-upgrade-details.md new file mode 100644 index 000000000..28c9be6b4 --- /dev/null +++ b/developer/portal-upgrade-details.md @@ -0,0 +1,50 @@ +## Summary + +With the version 1.3.0, a couple of breaking changes got introduced which result into migration/db impact. +In the document below, the impact got described including description of the change, possible issues, mitigation/solutions + +
+
+ +#### Service Details - NEW (interim) - 1.3.0 + +* NEW: table "service_details" + +New service_detail table released to manage technical user need for services with a true/false flag. +Attributes +* service_id +* service_type_id (connected to portal.service_types) +* technical_user_needed (true/false flag) + +image + +Impact on existing data: +Migration script existing, based on the service type, the technical_user_needed attribute is set to "true" for "DATASPACE_SERVICE" services and "false" for "CONSULTANCE_SERVICE" + +
+
+ +#### Mediatype - NEW & ENHANCED - 1.3.0 + +* NEW: table "media_types" +* ENHANCED: table portal.documents "media_type_id" added + +Impact on existing data: +As part of the migration, the existing file ending/type available in documents.name will be used to set the media_type_id. Important: check beforehand if all documents have a document type added inside the document name. If not, add the document type or delete the document. +Additionally check if all stored documents are supported by the types migrated in table porta.media_type. In case any other document type is currently loaded/stored, the migration will fail. In this case dleete the document beforehand or enhance the migration script media types supported. + +
+
+ +#### Application Checklist - ENHANCED - 1.2.0 + +* NEW: portal.processes +* NEW: portal.process_types +* ENHANCED: table company_applications "checklist_process_id" added +* ENHANCED: table process_steps "process_id" added +* REMOVED: removed table application_assigned_process_steps + +Impact on existing data: +Existing company registration will automatically get enhanced with the respective attributes. No manual intervention needed. Active + + From b17619a9e1f13f8172fa9bdcf5a683301c6aea3b Mon Sep 17 00:00:00 2001 From: jjeroch <94133633+jjeroch@users.noreply.github.com> Date: Wed, 29 Mar 2023 10:22:24 +0200 Subject: [PATCH 02/10] Update portal-upgrade-details.md --- developer/portal-upgrade-details.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/developer/portal-upgrade-details.md b/developer/portal-upgrade-details.md index 28c9be6b4..0291d4550 100644 --- a/developer/portal-upgrade-details.md +++ b/developer/portal-upgrade-details.md @@ -31,7 +31,7 @@ Migration script existing, based on the service type, the technical_user_needed Impact on existing data: As part of the migration, the existing file ending/type available in documents.name will be used to set the media_type_id. Important: check beforehand if all documents have a document type added inside the document name. If not, add the document type or delete the document. -Additionally check if all stored documents are supported by the types migrated in table porta.media_type. In case any other document type is currently loaded/stored, the migration will fail. In this case dleete the document beforehand or enhance the migration script media types supported. +Additionally check if all stored documents are supported by the types migrated in table porta.media_type. In case any other document type is currently loaded/stored, the migration will fail. In this case delete the document beforehand or enhance the migration script media types supported.

From b077760c3ac6012c5c69d0528da0c91ddd6e84e5 Mon Sep 17 00:00:00 2001 From: jjeroch <94133633+jjeroch@users.noreply.github.com> Date: Wed, 29 Mar 2023 10:25:12 +0200 Subject: [PATCH 03/10] Rename developer/portal-upgrade-details.md to developer/Technical Documentation/Version Upgrade/portal-upgrade-details.md --- .../Version Upgrade}/portal-upgrade-details.md | 0 1 file changed, 0 insertions(+), 0 deletions(-) rename developer/{ => Technical Documentation/Version Upgrade}/portal-upgrade-details.md (100%) diff --git a/developer/portal-upgrade-details.md b/developer/Technical Documentation/Version Upgrade/portal-upgrade-details.md similarity index 100% rename from developer/portal-upgrade-details.md rename to developer/Technical Documentation/Version Upgrade/portal-upgrade-details.md From 1550ad076d2c49e1aa5b18549cd070c9abc286f5 Mon Sep 17 00:00:00 2001 From: jjeroch <94133633+jjeroch@users.noreply.github.com> Date: Wed, 29 Mar 2023 12:23:48 +0200 Subject: [PATCH 04/10] Update portal-upgrade-details.md --- .../Version Upgrade/portal-upgrade-details.md | 60 ++++++++++++------- 1 file changed, 39 insertions(+), 21 deletions(-) diff --git a/developer/Technical Documentation/Version Upgrade/portal-upgrade-details.md b/developer/Technical Documentation/Version Upgrade/portal-upgrade-details.md index 0291d4550..9a1141bc0 100644 --- a/developer/Technical Documentation/Version Upgrade/portal-upgrade-details.md +++ b/developer/Technical Documentation/Version Upgrade/portal-upgrade-details.md @@ -1,25 +1,7 @@ ## Summary -With the version 1.3.0, a couple of breaking changes got introduced which result into migration/db impact. -In the document below, the impact got described including description of the change, possible issues, mitigation/solutions - -
-
- -#### Service Details - NEW (interim) - 1.3.0 - -* NEW: table "service_details" - -New service_detail table released to manage technical user need for services with a true/false flag. -Attributes -* service_id -* service_type_id (connected to portal.service_types) -* technical_user_needed (true/false flag) - -image - -Impact on existing data: -Migration script existing, based on the service type, the technical_user_needed attribute is set to "true" for "DATASPACE_SERVICE" services and "false" for "CONSULTANCE_SERVICE" +The file describes portal database changes and impact on transactional data. Depending on the impact, possible risks/impediments on upgrades as well as mitigation plans are described. +Each section includes the respective change details, impact on existing data and the respective release with which the change is getting active.

@@ -45,6 +27,42 @@ Additionally check if all stored documents are supported by the types migrated i * REMOVED: removed table application_assigned_process_steps Impact on existing data: -Existing company registration will automatically get enhanced with the respective attributes. No manual intervention needed. Active +?? Existing company registration data currently under validation are automatically expanded with the respective attribute values for the new tables/attributes ?? +* processes +* process_types +* checklist_process_id +* process_id + +No manual intervention needed. +For company applications currently in status "under creation" (means not yet submitted for validation) the change has no impact, since the process_id is created as part of the registration submitted. As soon as the participant submits the registration, the new process with the process_id will apply. + +
+
+ +#### Service Details - NEW (interim) - 1.1.0 + +* NEW: table "service_details" +* REMOVED: table service_assigned_service_types + +New service_detail table released to manage technical user need for services with a true/false flag. +Attributes +* service_id +* service_type_id (connected to portal.service_types and replacing table service_assigned_service_types) +* technical_user_needed (true/false flag) + +image + +Impact on existing data: +Migration script existing, based on the service type which is fetched for all existing data from portal table service_assigned_service_types, the technical_user_needed attribute is set to "true" for "DATASPACE_SERVICE" services and "false" for "CONSULTANCE_SERVICE". +Transactional data are automatically updated/migrated. + +Migration script existing, based on the service type which is fetched for all existing data from portal table service_assigned_service_types, the technical_user_needed attribute is set to "true" for "DATASPACE_SERVICE" services and "false" for "CONSULTANCE_SERVICE". +```dif +Please note, thats an interim solution only an expected to get replaced again in version 1.4.0 +``` + +
+
+ From 54b2c92d6aeeb53d911e5ef5f69c8547b86ce860 Mon Sep 17 00:00:00 2001 From: Evelyn Gurschler Date: Tue, 11 Apr 2023 15:49:50 +0200 Subject: [PATCH 05/10] docs(upgrade): improve readability --- .../Version Upgrade/portal-upgrade-details.md | 15 +++++---------- 1 file changed, 5 insertions(+), 10 deletions(-) diff --git a/developer/Technical Documentation/Version Upgrade/portal-upgrade-details.md b/developer/Technical Documentation/Version Upgrade/portal-upgrade-details.md index 9a1141bc0..d1eb31c30 100644 --- a/developer/Technical Documentation/Version Upgrade/portal-upgrade-details.md +++ b/developer/Technical Documentation/Version Upgrade/portal-upgrade-details.md @@ -1,6 +1,6 @@ ## Summary -The file describes portal database changes and impact on transactional data. Depending on the impact, possible risks/impediments on upgrades as well as mitigation plans are described. +This document describes the portal database changes and its impact on transactional data. Depending on the impact, possible risks/impediments on upgrades as well as mitigation plans are described. Each section includes the respective change details, impact on existing data and the respective release with which the change is getting active.
@@ -13,7 +13,7 @@ Each section includes the respective change details, impact on existing data and Impact on existing data: As part of the migration, the existing file ending/type available in documents.name will be used to set the media_type_id. Important: check beforehand if all documents have a document type added inside the document name. If not, add the document type or delete the document. -Additionally check if all stored documents are supported by the types migrated in table porta.media_type. In case any other document type is currently loaded/stored, the migration will fail. In this case delete the document beforehand or enhance the migration script media types supported. +Additionally check if all stored documents are supported by the types migrated in table portal.media_type. In case any other document type is currently loaded/stored, the migration will fail. In this case delete the document beforehand or enhance the migration script media types supported.

@@ -34,7 +34,7 @@ Impact on existing data: * process_id No manual intervention needed. -For company applications currently in status "under creation" (means not yet submitted for validation) the change has no impact, since the process_id is created as part of the registration submitted. As soon as the participant submits the registration, the new process with the process_id will apply. +For company applications currently in status "under creation" (which means not yet submitted for validation) the change has no impact, since the process_id is created as part of the registration submitted. As soon as the participant submits the registration, the new process with the process_id will apply.

@@ -46,7 +46,7 @@ For company applications currently in status "under creation" (means not yet sub New service_detail table released to manage technical user need for services with a true/false flag. Attributes -* service_id +* service_id * service_type_id (connected to portal.service_types and replacing table service_assigned_service_types) * technical_user_needed (true/false flag) @@ -58,11 +58,6 @@ Transactional data are automatically updated/migrated. Migration script existing, based on the service type which is fetched for all existing data from portal table service_assigned_service_types, the technical_user_needed attribute is set to "true" for "DATASPACE_SERVICE" services and "false" for "CONSULTANCE_SERVICE". - ```dif -Please note, thats an interim solution only an expected to get replaced again in version 1.4.0 +Please note, that it's an interim solution, which is expected to get replaced again in version 1.4.0 ``` - -
-
- From 3322e78f65c511c49c8cbd4bcf1f20fa7cc115a4 Mon Sep 17 00:00:00 2001 From: jjeroch <94133633+jjeroch@users.noreply.github.com> Date: Mon, 17 Apr 2023 09:18:22 +0200 Subject: [PATCH 06/10] Update portal-upgrade-details.md --- .../Version Upgrade/portal-upgrade-details.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/developer/Technical Documentation/Version Upgrade/portal-upgrade-details.md b/developer/Technical Documentation/Version Upgrade/portal-upgrade-details.md index d1eb31c30..c132eb64d 100644 --- a/developer/Technical Documentation/Version Upgrade/portal-upgrade-details.md +++ b/developer/Technical Documentation/Version Upgrade/portal-upgrade-details.md @@ -27,7 +27,7 @@ Additionally check if all stored documents are supported by the types migrated i * REMOVED: removed table application_assigned_process_steps Impact on existing data: -?? Existing company registration data currently under validation are automatically expanded with the respective attribute values for the new tables/attributes ?? +Existing company registration data currently under validation are automatically expanded with the respective attribute values for the new tables/attributes * processes * process_types * checklist_process_id From 9a5de79f493a7d4b1bb3223b5f39c015a76f2890 Mon Sep 17 00:00:00 2001 From: jjeroch <94133633+jjeroch@users.noreply.github.com> Date: Mon, 17 Apr 2023 11:00:05 +0200 Subject: [PATCH 07/10] Update portal-upgrade-details.md --- .../Version Upgrade/portal-upgrade-details.md | 18 +++++++++++++----- 1 file changed, 13 insertions(+), 5 deletions(-) diff --git a/developer/Technical Documentation/Version Upgrade/portal-upgrade-details.md b/developer/Technical Documentation/Version Upgrade/portal-upgrade-details.md index c132eb64d..dcb04bc94 100644 --- a/developer/Technical Documentation/Version Upgrade/portal-upgrade-details.md +++ b/developer/Technical Documentation/Version Upgrade/portal-upgrade-details.md @@ -3,10 +3,15 @@ This document describes the portal database changes and its impact on transactional data. Depending on the impact, possible risks/impediments on upgrades as well as mitigation plans are described. Each section includes the respective change details, impact on existing data and the respective release with which the change is getting active. +
+ +> **_INFO:_** inside the detailed descriptions below, the definition 'migration script' refers to the term 'migrations' as it is defined by the ef-core framework: https://learn.microsoft.com/en-us/ef/core/managing-schemas/migrations + +

-#### Mediatype - NEW & ENHANCED - 1.3.0 +#### Mediatype - NEW & ENHANCED - 1.2.0 * NEW: table "media_types" * ENHANCED: table portal.documents "media_type_id" added @@ -18,7 +23,7 @@ Additionally check if all stored documents are supported by the types migrated i

-#### Application Checklist - ENHANCED - 1.2.0 +#### Application Checklist - ENHANCED - 1.1.0 * NEW: portal.processes * NEW: portal.process_types @@ -58,6 +63,9 @@ Transactional data are automatically updated/migrated. Migration script existing, based on the service type which is fetched for all existing data from portal table service_assigned_service_types, the technical_user_needed attribute is set to "true" for "DATASPACE_SERVICE" services and "false" for "CONSULTANCE_SERVICE". -```dif -Please note, that it's an interim solution, which is expected to get replaced again in version 1.4.0 -``` +
+ +> **_INFO:_** Please note: this is an interim solution which is expected to get replaced/changed in version 1.4.0 + +
+
From 466611c25b4749016f79e5a60a9f4722b0606f3d Mon Sep 17 00:00:00 2001 From: jjeroch <94133633+jjeroch@users.noreply.github.com> Date: Mon, 17 Apr 2023 11:08:51 +0200 Subject: [PATCH 08/10] Update portal-upgrade-details.md --- .../Version Upgrade/portal-upgrade-details.md | 21 ++++++++++++++++++- 1 file changed, 20 insertions(+), 1 deletion(-) diff --git a/developer/Technical Documentation/Version Upgrade/portal-upgrade-details.md b/developer/Technical Documentation/Version Upgrade/portal-upgrade-details.md index dcb04bc94..9f0210745 100644 --- a/developer/Technical Documentation/Version Upgrade/portal-upgrade-details.md +++ b/developer/Technical Documentation/Version Upgrade/portal-upgrade-details.md @@ -17,9 +17,28 @@ Each section includes the respective change details, impact on existing data and * ENHANCED: table portal.documents "media_type_id" added Impact on existing data: -As part of the migration, the existing file ending/type available in documents.name will be used to set the media_type_id. Important: check beforehand if all documents have a document type added inside the document name. If not, add the document type or delete the document. +As part of the migration, for all existing documents stored in the table portal.documents, the filename extension will be used to define and store the media_type_id of the respective document inside the new table attribute. Important: check beforehand if all documents have a document type added inside the document name. If not, add the document type or delete the document. Additionally check if all stored documents are supported by the types migrated in table portal.media_type. In case any other document type is currently loaded/stored, the migration will fail. In this case delete the document beforehand or enhance the migration script media types supported. +
+ +Supported document types: + +media_type_id | media_type +--- | --- +1 | .jpg +1 | .jpeg +2 | .gif +3 | .png +4 | .svg +5 | .tif +6 | .pdf +7 | .json +8 | .pem +9 | .ca_cert +10 | .pkx_cer +11 | .octet +

From 85730fd10720ad41ab0bf0bccf07980fd4b5d0ec Mon Sep 17 00:00:00 2001 From: jjeroch <94133633+jjeroch@users.noreply.github.com> Date: Mon, 17 Apr 2023 11:29:01 +0200 Subject: [PATCH 09/10] Update portal-upgrade-details.md --- .../Version Upgrade/portal-upgrade-details.md | 15 ++++++++------- 1 file changed, 8 insertions(+), 7 deletions(-) diff --git a/developer/Technical Documentation/Version Upgrade/portal-upgrade-details.md b/developer/Technical Documentation/Version Upgrade/portal-upgrade-details.md index 9f0210745..df298051d 100644 --- a/developer/Technical Documentation/Version Upgrade/portal-upgrade-details.md +++ b/developer/Technical Documentation/Version Upgrade/portal-upgrade-details.md @@ -17,12 +17,12 @@ Each section includes the respective change details, impact on existing data and * ENHANCED: table portal.documents "media_type_id" added Impact on existing data: -As part of the migration, for all existing documents stored in the table portal.documents, the filename extension will be used to define and store the media_type_id of the respective document inside the new table attribute. Important: check beforehand if all documents have a document type added inside the document name. If not, add the document type or delete the document. -Additionally check if all stored documents are supported by the types migrated in table portal.media_type. In case any other document type is currently loaded/stored, the migration will fail. In this case delete the document beforehand or enhance the migration script media types supported. +As part of the migration, for all existing documents stored in the table portal.documents, the filename extension will be used to define and store the media_type_id of the respective document inside the new table attribute. Important: check beforehand if all documents have a document type added inside the document name. If not, add the respective media type or delete the document. +Additionally check if all stored documents are supported by the media types migrated in table portal.media_type. In case any other document media type is currently loaded/stored inside the table portal.documents, the migration will fail. In this case delete the document beforehand or enhance the migration script media types supported.
-Supported document types: +Supported media types: media_type_id | media_type --- | --- @@ -34,10 +34,11 @@ media_type_id | media_type 5 | .tif 6 | .pdf 7 | .json -8 | .pem -9 | .ca_cert -10 | .pkx_cer -11 | .octet + +
+ +> **_INFO:_** additional media types (e.g. .pem, .ca_cert, .pkx_cer, .octet) are added in version 1.2.0 and 1.3.0 +

From 71976d143e28940feb97b8b5bccac0756d4ef46d Mon Sep 17 00:00:00 2001 From: jjeroch <94133633+jjeroch@users.noreply.github.com> Date: Thu, 27 Apr 2023 07:43:28 +0200 Subject: [PATCH 10/10] Update portal-upgrade-details.md --- .../Version Upgrade/portal-upgrade-details.md | 2 -- 1 file changed, 2 deletions(-) diff --git a/developer/Technical Documentation/Version Upgrade/portal-upgrade-details.md b/developer/Technical Documentation/Version Upgrade/portal-upgrade-details.md index df298051d..22962ccf8 100644 --- a/developer/Technical Documentation/Version Upgrade/portal-upgrade-details.md +++ b/developer/Technical Documentation/Version Upgrade/portal-upgrade-details.md @@ -81,8 +81,6 @@ Impact on existing data: Migration script existing, based on the service type which is fetched for all existing data from portal table service_assigned_service_types, the technical_user_needed attribute is set to "true" for "DATASPACE_SERVICE" services and "false" for "CONSULTANCE_SERVICE". Transactional data are automatically updated/migrated. -Migration script existing, based on the service type which is fetched for all existing data from portal table service_assigned_service_types, the technical_user_needed attribute is set to "true" for "DATASPACE_SERVICE" services and "false" for "CONSULTANCE_SERVICE". -
> **_INFO:_** Please note: this is an interim solution which is expected to get replaced/changed in version 1.4.0