diff --git a/docs/files/figs/diagrams-components.png b/docs/files/figs/diagrams-components.png index 9f5e37e..7d52d63 100644 Binary files a/docs/files/figs/diagrams-components.png and b/docs/files/figs/diagrams-components.png differ diff --git a/docs/files/figs/diagrams-onboarding.png b/docs/files/figs/diagrams-onboarding.png index aefd9ad..984b200 100644 Binary files a/docs/files/figs/diagrams-onboarding.png and b/docs/files/figs/diagrams-onboarding.png differ diff --git a/docs/files/figs/diagrams-scenario-pull.png b/docs/files/figs/diagrams-scenario-pull.png index dc83a85..a9fc9d1 100644 Binary files a/docs/files/figs/diagrams-scenario-pull.png and b/docs/files/figs/diagrams-scenario-pull.png differ diff --git a/docs/files/figs/diagrams-scenario-push.png b/docs/files/figs/diagrams-scenario-push.png index 466f308..ecc4998 100644 Binary files a/docs/files/figs/diagrams-scenario-push.png and b/docs/files/figs/diagrams-scenario-push.png differ diff --git a/docs/files/figs/diagrams.drawio b/docs/files/figs/diagrams.drawio index c9a2ca3..6627b5f 100644 --- a/docs/files/figs/diagrams.drawio +++ b/docs/files/figs/diagrams.drawio @@ -1,6 +1,6 @@ - + - + @@ -313,46 +313,65 @@ - + - + - + - + - - + + + + + + + + + + + + + + + + - + + + - - + + + + + @@ -396,53 +415,10 @@ - + - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - @@ -766,11 +742,73 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + - + @@ -786,7 +824,7 @@ - + @@ -797,9 +835,9 @@ - + - + @@ -808,7 +846,7 @@ - + @@ -817,7 +855,7 @@ - + @@ -828,7 +866,7 @@ - + @@ -840,7 +878,7 @@ - + @@ -855,51 +893,51 @@ - + - + - + - - + + - + - + - + - + - + - + - + - + @@ -908,51 +946,51 @@ - + - + - + - + - + - + - + - + - + - + - + - + - + @@ -961,21 +999,21 @@ - + - + - + - + - + @@ -985,18 +1023,18 @@ - + - + - + - + @@ -1005,21 +1043,21 @@ - + - + - + - + - + @@ -1029,21 +1067,21 @@ - + - + - + - + - + @@ -1052,21 +1090,21 @@ - + - + - + - + - + @@ -1076,14 +1114,25 @@ - + - + + + + + + + + + + + + diff --git a/docs/use-case.md b/docs/use-case.md index d0d878d..17069a3 100644 --- a/docs/use-case.md +++ b/docs/use-case.md @@ -6,13 +6,13 @@ This demonstrator showcases the sharing of certificate data with dataspace techn Business transaction require company certificates. Companies can issue, request, accept, or reject certificates by using dataspace technologies, enabling interoperable and trusted certificate sharing and reducing fragmentation across multiple systems. -## Roles +### Roles The use case involves four _abstract_ roles: the Cloud Service Provider (CSP), the Managed Service Provider (MSP), the Dataspace Core Service Provider (DCSP), and the SME. -_Please note that the specific characteristics of the personas involved depend on the respective use case and dataspace. See [here](requirements.md#personas) for end-user personas. The following set of user stories do not include any acceptance criteria._ +_Note: The specific characteristics of the personas involved depend on the respective use case and dataspace. See [here](requirements.md#personas) for end-user personas. The following set of user stories do not include any acceptance criteria._ -### Cloud Service Provider +#### Cloud Service Provider The CSP provides the infrastructure and dataspace technologies as a service. @@ -26,7 +26,7 @@ The CSP provides the infrastructure and dataspace technologies as a service. _Table 1. User stories of the CSP_ -### Managed Service Provider +#### Managed Service Provider The MSP provides services such as dataspace onboarding or data sharing. @@ -38,7 +38,19 @@ The MSP provides services such as dataspace onboarding or data sharing. _Table 2. User stories of the MSP_ -### Dataspace Core Service Provider +#### Company (SME) + +A company wants to connect to their business partners and share data. + +| # | Title | As a | I want | So that | +|-------|----------------|------|--------------------------------------------------------------------------|-------------------------------------------------------------------------| +| US-11 | Registration | SME | to register to a dataspace | so that I can interact with my business partners | +| US-12 | Data discovery | SME | to search and discover datasets across multiple data sources and regions | I can find relevant data quickly without manual hopping between systems | +| US-13 | Compliance | SME | to upload use case data | so that I comply with requirements from my business partners | + +_Table 3. User stories of the SME_ + +#### Dataspace Core Service Provider The DCSP provide core services of a dataspace / ecosystem. @@ -49,36 +61,22 @@ _Note: In the Catena-X ecosystem, this is the Core Service Provider._ | US-09 | Registration | DCSP | to register a new organization into the dataspace | it can participate in the ecosystem | | US-10 | Conformity | DCSP | to validate and verify company data during onboarding | only verified organizations are granted access to the network | -_Table 3. User stories of the DCSP_ - -### Company (SME) - -A company wants to connect to their business partners and share data. - -| # | Title | As a | I want | So that | -|-------|----------------|------|--------------------------------------------------------------------------|-------------------------------------------------------------------------| -| US-11 | Registration | SME | to register to a dataspace | so that I can interact with my business partners | -| US-12 | Data discovery | SME | to search and discover datasets across multiple data sources and regions | I can find relevant data quickly without manual hopping between systems | -| US-13 | Compliance | SME | to upload use case data | so that I comply with requirements from my business partners | - -_Table 4. User stories of the SME_ +_Table 4. User stories of the DCSP_ -## Process +### Processes _Note: We do not describe business processes in the following, e.g., population and processing of sales pipelines._ -### Pre-processes +#### Pre-processes - Provisioning of a service offering (e.g., dataspace (technologies) as a service, onboarding to a dataspace) - Technical onboarding of the MSP (e.g., namespace creation in CSP infrastructure, tenant creation, access to interfaces) - Technical onboarding of the SME (e.g., tenant creation in CSP infrastructure, access to interfaces) - - -### Dataspace onboarding +#### Dataspace onboarding An SME wants to join a dataspace. The MSP service is used for this purpose. -_(Note: The MSP could be an Onboarding Service Provider in the Catena-X ecosystem.)_ +_Note: The MSP could be an Onboarding Service Provider in the Catena-X ecosystem._ ![Onboarding sequence](files/figs/diagrams-onboarding.png) @@ -95,67 +93,71 @@ _Table 5. Steps for the dataspace onboarding process_ [//]: # (Questions: Will the MSP be the CX Onboarding Service Provider?) -### Data sharing +#### Data sharing -In the following scenario descriptions, the SME is the central actor. The counterparty can be any partner company that the SME interacts with. +In this use case, the SME is the central actor. The counterparty can be any partner company that the SME interacts with. -#### Push scenario +_PULL_ -In this scenario, the certificate receiver is the data provider and the certificate provider is the data consumer. +In this scenario, the certificate provider is the data provider and the certificate receiver is the data consumer. -![Push scenario](files/figs/diagrams-scenario-push.png) +![Pull scenario](files/figs/diagrams-scenario-pull.png) -_Figure 2. Simplified push sequence_ +_Figure 2. Simplified pull sequence. The offering is a dataset that describes the API for downloading certificate data._ | # | What | Who | |---|------------------------------------------------|----------------| -| 1 | Create data offer for certificate management | Provider | -| 2 | Discover data offer for certificate management | Consumer (SME) | -| 3 | Establish connection _(negotiate agreement)_ | Consumer (SME) | -| 4 | Upload certificate data | Consumer (SME) | +| 1 | Create data offer for certificate management | Provider (SME) | +| 2 | Discover data offer for certificate management | Consumer | +| 3 | Establish connection _(negotiate agreement)_ | Consumer | +| 4 | Download certificate data | Consumer | -_Table 6. Steps for providing certificate data on request_ +_Table 6. Steps for providing certificate data_ -#### Pull scenario +_PUSH (Alternative)_ -In this scenario, the certificate provider is the data provider and the certificate receiver is the data consumer. +In this scenario, the certificate receiver is the data provider and the certificate provider is the data consumer. -![Pull scenario](files/figs/diagrams-scenario-pull.png) +![Push scenario](files/figs/diagrams-scenario-push.png) -_Figure 3. Simplified pull sequence_ +_Figure 3. Simplified push sequence. The offering is a dataset that describes the API for pushing certificate data._ | # | What | Who | |---|------------------------------------------------|----------------| -| 1 | Create data offer for certificate management | Provider (SME) | -| 2 | Discover data offer for certificate management | Consumer | -| 3 | Establish connection _(negotiate agreement)_ | Consumer | -| 4 | Download certificate data | Consumer | +| 1 | Create data offer for certificate management | Provider | +| 2 | Discover data offer for certificate management | Consumer (SME) | +| 3 | Establish connection _(negotiate agreement)_ | Consumer (SME) | +| 4 | Upload certificate data | Consumer (SME) | -_Table 7. Steps for providing certificate data_ +_Table 7. Steps for providing certificate data on request_ ## Overall Technical Components -The _abstract_ technical setup for the use case is separated into two environments: the dataspace and the CSP infrastructure, as depicted in Figure 3. Both the MSP and the SME have access to the infrastructure via provided (graphical interfaces). +The _abstract_ technical setup for the use case is separated into two environments: the _dataspace_ and the _CSP infrastructure_, as depicted in Figure 3. Both the MSP and the SME have access to the infrastructure via provided (graphical) interfaces. We focus on four basic interactions: -1. The SME uses the End-User API to manage their certificates. -2. The EDC tenant is connected to a partner's EDC in the dataspace for data sharing (provisioning & consumption). -3. The MPS tenant has a connection to the EDC tenant for configuration purposes (e.g., initiate setup, onboarding information). -4. The MSP tenant realizes the technical onboarding flow. +1. The SME uses the End-User API for **certificate management**. +2. The EDC tenant is connected to a partner's EDC in the dataspace for **data sharing** (provisioning & consumption). +3. The MPS tenant has a connection to the EDC tenant for **configuration** purposes (e.g., initiate setup, onboarding information). +4. The MSP tenant realizes the technical **onboarding** to the dataspace. -_Please note that the technical setup of namespaces and tenants in the CSP infrastructure is not further detailed in this picture._ +_Note: The technical setup of namespaces and tenants in the CSP infrastructure is not further detailed in this picture._ ![Demo components](files/figs/diagrams-components.png) -_Figure 3. Simplified technical setup of components_ +_Figure 4. Simplified technical setup of components_ -Description of interfaces: +Description of services: -- The CSP provides an infrastructure (EDC-V namespace) incl. an EDC Tenant (Connector, Identity Hub) and an End-User API to manage certificates. -- The CSP provides an API and UI to manage the infrastructure. +- The CSP provides an infrastructure (**EDC namespace**) incl. an EDC tenant (Connector, Identity Hub) and an End-User API to manage certificates. +- The CSP provides an API to manage the infrastructure. - The CSP provides a UI to access the MSP tenant. - The MSP tenant integrates into the EDC namespace. - The MSP tenant implements the API to register companies to the dataspace. - The EDC tenant provides an API to share data. -- The EDC tenant implements the API to share data. \ No newline at end of file +- The EDC tenant implements the API to share data. + +## User Journey + +_To be added (screenshots)_ \ No newline at end of file