Restore doc and data_model

README.md

+# Onboarding
+
+Orchestrates the onboarding workflow of a Participant into a Data Space.
+
+
+## Logical Data Model
+
+![image](docs/logical_data_model.png)
\ No newline at end of file

docs/logical_data_model.mmd

 classDiagram
-    Comment "0..n" -- "1"  OnboardingRequest
-    Document "0..n" -- "1" OnboardingRequest
+    Document "1" -- "0..n" ValidationRuleExecution
     DocumentTemplate "1" -- "0..n" Document
-    OnboardingRequest "0..n" -- "1" OnboardingProcedureTemplate
-    OnboardingRequest "0..n" -- "1" OnboardingStatus
-    OnboardingRequest "1" -- "1" OnboardingApplicant
-    OnboardingRequest "1" -- "1" ParticipantType
-    MimeType "1" -- "0..n"  DocumentTemplate
+    DocumentTemplate "1" -- "0..n" OnboardingProcedureTemplateDocumentTemplate
+    DocumentTemplate "1" -- "0..n" ValidationRule
     MimeType "1" -- "0..n" Document
-    ParticipantType "1" -- "1" OnboardingProcedureTemplate
-    EventLog "0..n" -- "1" OnboardingRequest
-    OnboardingProcedureTemplateDocumentTemplate "0..n" -- "1" DocumentTemplate
-    OnboardingProcedureTemplateDocumentTemplate "0..n" -- "1" OnboardingProcedureTemplate
+    MimeType "1" -- "0..n" DocumentTemplate
+    OnboardingApplicant "1" -- "0..n" OnboardingRequest
+    OnboardingProcedureTemplate "1" -- "0..n" OnboardingProcedureTemplateDocumentTemplate
+    OnboardingProcedureTemplate "1" -- "0..n" OnboardingRequest
+    OnboardingProcedureTemplate "1" -- "0..n" ValidationRule
+    OnboardingRequest "1" -- "0..n" Comment
+    OnboardingRequest "1" -- "0..n" Document
+    OnboardingRequest "1" -- "0..n" ValidationRuleExecution
+    OnboardingStatus "1" -- "0..n" OnboardingRequest
+    ValidationRule "1" -- "0..n" ValidationRule
+    ValidationRule "1" -- "0..n" ValidationRuleExecution
+    ValidationRuleExecution "1" -- "0..n" ValidationRuleExecutionRemark
 
     class Comment {
         +uuid id
@@ -22,35 +26,38 @@ classDiagram
         +timestamp update_timestamp
     }
 
-
-    class OnboardingApplicant {
-        +uuid id
-        +string username
-        +string firstname
-        +string lastname
-        +string email
-    }
-
     class Document {
         +uuid id
         +uuid document_template_id
         +uuid onboarding_request_id
-        +uuid mime_type_id
         +string description
-        +string filename
-        +int filesize
-        +blob content
+        +bytea content
         +timestamp creation_timestamp
         +timestamp update_timestamp
+        +string filename
+        +int filesize
+        +uuid mime_type_id
     }
 
     class DocumentTemplate {
         +uuid id
         +string description
-        +bool mandatory
-        +int mime_type_id
+        +boolean mandatory
+        +uuid mime_type_id
         +timestamp creation_timestamp
         +timestamp update_timestamp
+        +string name
+    }
+
+    class EventLog {
+        +uuid id
+        +uuid onboarding_request_id
+        +uuid initiator_user_id
+        +string initiator_service
+        +string event_type
+        +jsonb event_details
+        +uuid entity_id
+        +timestamp without time zone creation_timestamp
     }
 
     class MimeType {
@@ -59,27 +66,22 @@ classDiagram
         +string description
     }
 
-    class OnboardingProcedureTemplate {
+    class OnboardingApplicant {
         +uuid id
-        +int participant_type_id
-        +string description
-        +int expiration_timeframe
-        +timestamp creation_timestamp
-        +timestamp update_timestamp
+        +string username
+        +string firstname
+        +string lastname
+        +string email
     }
 
-    class OnboardingRequest {
+    class OnboardingProcedureTemplate {
         +uuid id
-        +uuid onboarding_procedure_template_id
-        +int onboarding_status_id
-        +string onboarding_applicant_id
-        +int expiration_timeframe
-        +timestamp last_participant_update_timestamp
-        +uuid participant_id
         +uuid participant_type_id
-        +string organization
         +timestamp creation_timestamp
         +timestamp update_timestamp
+        +int expiration_timeframe
+        +string description
+        +string expiration_timeframe_timeunit
     }
 
     class OnboardingProcedureTemplateDocumentTemplate {
@@ -87,6 +89,22 @@ classDiagram
         +uuid document_template_id
     }
 
+    class OnboardingRequest {
+        +uuid id
+        +uuid onboarding_procedure_template_id
+        +uuid onboarding_status_id
+        +timestamp creation_timestamp
+        +timestamp update_timestamp
+        +int expiration_timeframe
+        +uuid participant_id
+        +string rejection_cause
+        +uuid onboarding_applicant_id
+        +string organization
+        +uuid participant_type_id
+        +timestamp last_status_update_timestamp
+        +string expiration_timeframe_timeunit
+    }
+
     class OnboardingStatus {
         +uuid id
         +string value
@@ -99,13 +117,39 @@ classDiagram
         +string label
     }
 
-    class EventLog {
+    class ValidationRule {
         +uuid id
+        +string name
+        +string description
+        +timestamp valid_since
+        +timestamp zone valid_to
+        +boolean active
+        +string type
+        +boolean auto_approval
+        +boolean required
+        +string content_validation_uri
+        +timestamp creation_timestamp
+        +timestamp update_timestamp
+        +uuid document_template_id
+        +uuid onboarding_procedure_template_id
+        +string strategy
+        +uuid parent_id
+    }
+
+    class ValidationRuleExecution {
+        +uuid id
+        +uuid validation_rule_id
+        +uuid document_id
         +uuid onboarding_request_id
-        +uuid initiator_user_id
-        string initiator_service
-        string event_type
-        +jsonb event_details
-        +uuid entity_id
+        +timestamp execution_start_date
+        +timestamp execution_end_date
+        +string status
         +timestamp creation_timestamp
+        +timestamp update_timestamp
+    }
+
+    class ValidationRuleExecutionRemark {
+        +uuid id
+        +uuid execution_id
+        +jsonb remark
     }