From 407a30cdc18647652885e7c60a60bc3c9c61be2c Mon Sep 17 00:00:00 2001 From: Fabian Gruen Date: Fri, 23 Feb 2024 15:05:25 +0100 Subject: [PATCH] chore: update mermaid files --- docs/mermaid/DataModel_v6.mmd | 99 +++++++++++++++++++ ...pdm => keycloak_integration_with_bpdm.mmd} | 0 docs/mermaid/mermaid_edc_integration.md | 22 ----- docs/mermaid/mermaid_edc_integration.mmd | 20 ++++ 4 files changed, 119 insertions(+), 22 deletions(-) create mode 100644 docs/mermaid/DataModel_v6.mmd rename docs/mermaid/{keycloak_integration_with_bpdm => keycloak_integration_with_bpdm.mmd} (100%) delete mode 100644 docs/mermaid/mermaid_edc_integration.md create mode 100644 docs/mermaid/mermaid_edc_integration.mmd diff --git a/docs/mermaid/DataModel_v6.mmd b/docs/mermaid/DataModel_v6.mmd new file mode 100644 index 00000000..fc71a672 --- /dev/null +++ b/docs/mermaid/DataModel_v6.mmd @@ -0,0 +1,99 @@ +classDiagram +%%CompanyUser + class CompanyUser { + name: String+ + email: String+ + company: String+ + } +%%Country + class Country { + country: String+ + iso2: String + iso3: String + continent: String + } +%%DataSource + class DataSource { + dataSourceName: String+ + type: Type+ + yearPublished: Integer+ + fileName: String + createDate: Instant + } +%%Range + class Range { + range: RangeType+ + value: Integer+ + description: String + } +%%File + class File { + fileName: String+ + content: Blob + createDate: Instant + createdBy: String + version: Float + } + +%%Region + class Region { + name: String+ + type: Type + description: String + } +%% Report + class Report { + reportName: String + companyUserName: String + company: String + type: Type + createDate: Instant + createdBy: String + } +%% DataSourceValue + class DataSourceValue { + country: String+ + iso2: String + iso3: String + continent: String + score: Float + } +%% RangeType + class RangeType { + enum + MAX() + Between() + Min() + } +%% Type + class Type { + enum + Global() + Company() + Custom() + } +%% RegionValue + class RegionValue { + country String + iso2 String + iso3 String + continent String + } +%% ReportValues + class ReportValues { + name String + value String + } + +%% Relations + CompanyUser --o DataSource + CompanyUser --o Range + CompanyUser "1" --o "1..*" File + CompanyUser --o Region + DataSource --o DataSourceValue + DataSource ..o "1..*" Type + Range ..> RangeType + Region ..> Type + Region --o "1..*" RegionValue + Report ..> Type + Report --o "1..*" ReportValues diff --git a/docs/mermaid/keycloak_integration_with_bpdm b/docs/mermaid/keycloak_integration_with_bpdm.mmd similarity index 100% rename from docs/mermaid/keycloak_integration_with_bpdm rename to docs/mermaid/keycloak_integration_with_bpdm.mmd diff --git a/docs/mermaid/mermaid_edc_integration.md b/docs/mermaid/mermaid_edc_integration.md deleted file mode 100644 index 62db5e28..00000000 --- a/docs/mermaid/mermaid_edc_integration.md +++ /dev/null @@ -1,22 +0,0 @@ - - -graph TD -%% Scenario 1: Data Provision -subgraph S1["Scenario 1: Data Provision"] -OtherEDCSystems[("Other EDC Systems")]:::otherStyle -->|consumes data from| EDCProviderCR[("Country Risk EDC Provider")]:::providerStyle -EDCProviderCR -->|requests data from| CRApp[("Country Risk Application")]:::appStyle -end - - %% Scenario 2: Data Consumption - subgraph S2["Scenario 2: Data Consumption"] - CRApp2[("Country Risk Application")]:::appStyle -->|consumes data from| EDCC[("Country Risk EDC Consumer")]:::consumerStyle - EDCC -->|requests data from| EDCGateProvider[("EDC Gate Provider")]:::gateStyle - EDCGateProvider -->|requests data from| BPDM[("BPDM Application")]:::bpdmStyle - end - - classDef appStyle fill:#ffcccc,stroke:#333,stroke-width:4px; - classDef providerStyle fill:#ccffcc,stroke:#333,stroke-width:4px; - classDef consumerStyle fill:#ccccff,stroke:#333,stroke-width:4px; - classDef otherStyle fill:#fff0b3,stroke:#333,stroke-width:4px; - classDef gateStyle fill:#f0b3ff,stroke:#333,stroke-width:4px; - classDef bpdmStyle fill:#ffffb3,stroke:#333,stroke-width:4px; diff --git a/docs/mermaid/mermaid_edc_integration.mmd b/docs/mermaid/mermaid_edc_integration.mmd new file mode 100644 index 00000000..44abe01f --- /dev/null +++ b/docs/mermaid/mermaid_edc_integration.mmd @@ -0,0 +1,20 @@ +graph TD + %% Scenario 1: Data Provision + subgraph S1["Scenario 1: Data Provision"] + OtherEDCSystems[("Other EDC Systems")]:::otherStyle -->|consumes data from| EDCProviderCR[("Country Risk EDC Provider")]:::providerStyle + EDCProviderCR -->|requests data from| CRApp[("Country Risk Application")]:::appStyle + end + + %% Scenario 2: Data Consumption + subgraph S2["Scenario 2: Data Consumption"] + CRApp2[("Country Risk Application")]:::appStyle -->|consumes data from| EDCC[("Country Risk EDC Consumer")]:::consumerStyle + EDCC -->|requests data from| EDCGateProvider[("EDC Gate Provider")]:::gateStyle + EDCGateProvider -->|requests data from| BPDM[("BPDM Application")]:::bpdmStyle + end + + classDef appStyle fill:#ffcccc,stroke:#333,stroke-width:4px; + classDef providerStyle fill:#ccffcc,stroke:#333,stroke-width:4px; + classDef consumerStyle fill:#ccccff,stroke:#333,stroke-width:4px; + classDef otherStyle fill:#fff0b3,stroke:#333,stroke-width:4px; + classDef gateStyle fill:#f0b3ff,stroke:#333,stroke-width:4px; + classDef bpdmStyle fill:#ffffb3,stroke:#333,stroke-width:4px; \ No newline at end of file