Skip to content

Commit 60d3602

Browse files
authored
chore: add minor corrections to use case description (#1)
1 parent f1c93e2 commit 60d3602

File tree

6 files changed

+223
-170
lines changed

6 files changed

+223
-170
lines changed
2.78 KB
Loading
973 Bytes
Loading
1.94 KB
Loading
2.33 KB
Loading

docs/files/figs/diagrams.drawio

Lines changed: 164 additions & 115 deletions
Large diffs are not rendered by default.

docs/use-case.md

Lines changed: 59 additions & 55 deletions
Original file line numberDiff line numberDiff line change
@@ -6,13 +6,13 @@ This demonstrator showcases the sharing of certificate data with dataspace techn
66

77
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.
88

9-
## Roles
9+
### Roles
1010

1111
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.
1212

13-
_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._
13+
_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._
1414

15-
### Cloud Service Provider
15+
#### Cloud Service Provider
1616

1717
The CSP provides the infrastructure and dataspace technologies as a service.
1818

@@ -26,7 +26,7 @@ The CSP provides the infrastructure and dataspace technologies as a service.
2626

2727
_Table 1. User stories of the CSP_
2828

29-
### Managed Service Provider
29+
#### Managed Service Provider
3030

3131
The MSP provides services such as dataspace onboarding or data sharing.
3232

@@ -38,7 +38,19 @@ The MSP provides services such as dataspace onboarding or data sharing.
3838

3939
_Table 2. User stories of the MSP_
4040

41-
### Dataspace Core Service Provider
41+
#### Company (SME)
42+
43+
A company wants to connect to their business partners and share data.
44+
45+
| # | Title | As a | I want | So that |
46+
|-------|----------------|------|--------------------------------------------------------------------------|-------------------------------------------------------------------------|
47+
| US-11 | Registration | SME | to register to a dataspace | so that I can interact with my business partners |
48+
| 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 |
49+
| US-13 | Compliance | SME | to upload use case data | so that I comply with requirements from my business partners |
50+
51+
_Table 3. User stories of the SME_
52+
53+
#### Dataspace Core Service Provider
4254

4355
The DCSP provide core services of a dataspace / ecosystem.
4456

@@ -49,36 +61,22 @@ _Note: In the Catena-X ecosystem, this is the Core Service Provider._
4961
| US-09 | Registration | DCSP | to register a new organization into the dataspace | it can participate in the ecosystem |
5062
| US-10 | Conformity | DCSP | to validate and verify company data during onboarding | only verified organizations are granted access to the network |
5163

52-
_Table 3. User stories of the DCSP_
53-
54-
### Company (SME)
55-
56-
A company wants to connect to their business partners and share data.
57-
58-
| # | Title | As a | I want | So that |
59-
|-------|----------------|------|--------------------------------------------------------------------------|-------------------------------------------------------------------------|
60-
| US-11 | Registration | SME | to register to a dataspace | so that I can interact with my business partners |
61-
| 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 |
62-
| US-13 | Compliance | SME | to upload use case data | so that I comply with requirements from my business partners |
63-
64-
_Table 4. User stories of the SME_
64+
_Table 4. User stories of the DCSP_
6565

66-
## Process
66+
### Processes
6767

6868
_Note: We do not describe business processes in the following, e.g., population and processing of sales pipelines._
6969

70-
### Pre-processes
70+
#### Pre-processes
7171

7272
- Provisioning of a service offering (e.g., dataspace (technologies) as a service, onboarding to a dataspace)
7373
- Technical onboarding of the MSP (e.g., namespace creation in CSP infrastructure, tenant creation, access to interfaces)
7474
- Technical onboarding of the SME (e.g., tenant creation in CSP infrastructure, access to interfaces)
7575

76-
77-
78-
### Dataspace onboarding
76+
#### Dataspace onboarding
7977

8078
An SME wants to join a dataspace. The MSP service is used for this purpose.
81-
_(Note: The MSP could be an Onboarding Service Provider in the Catena-X ecosystem.)_
79+
_Note: The MSP could be an Onboarding Service Provider in the Catena-X ecosystem._
8280

8381
![Onboarding sequence](files/figs/diagrams-onboarding.png)
8482

@@ -95,67 +93,73 @@ _Table 5. Steps for the dataspace onboarding process_
9593

9694
[//]: # (Questions: Will the MSP be the CX Onboarding Service Provider?)
9795

98-
### Data sharing
96+
#### Data sharing
9997

100-
In the following scenario descriptions, the SME is the central actor. The counterparty can be any partner company that the SME interacts with.
98+
In this use case, the SME is the central actor. The counterparty can be any partner company that the SME interacts with.
10199

102-
#### Push scenario
100+
_PULL_
103101

104-
In this scenario, the certificate receiver is the data provider and the certificate provider is the data consumer.
102+
In this scenario, the certificate provider is the data provider and the certificate receiver is the data consumer.
105103

106-
![Push scenario](files/figs/diagrams-scenario-push.png)
104+
![Pull scenario](files/figs/diagrams-scenario-pull.png)
107105

108-
_Figure 2. Simplified push sequence_
106+
_Figure 2. Simplified pull sequence. The offering is a dataset that describes the API for downloading certificate data._
109107

110108
| # | What | Who |
111109
|---|------------------------------------------------|----------------|
112-
| 1 | Create data offer for certificate management | Provider |
113-
| 2 | Discover data offer for certificate management | Consumer (SME) |
114-
| 3 | Establish connection _(negotiate agreement)_ | Consumer (SME) |
115-
| 4 | Upload certificate data | Consumer (SME) |
110+
| 1 | Create data offer for certificate management | Provider (SME) |
111+
| 2 | Discover data offer for certificate management | Consumer |
112+
| 3 | Establish connection _(negotiate agreement)_ | Consumer |
113+
| 4 | Download certificate data | Consumer |
116114

117-
_Table 6. Steps for providing certificate data on request_
115+
_Table 6. Steps for providing certificate data_
118116

119-
#### Pull scenario
117+
_PUSH (Alternative)_
120118

121-
In this scenario, the certificate provider is the data provider and the certificate receiver is the data consumer.
119+
In this scenario, the certificate receiver is the data provider and the certificate provider is the data consumer.
120+
_Note: This scenario is not covered by the demo._
122121

123-
![Pull scenario](files/figs/diagrams-scenario-pull.png)
122+
![Push scenario](files/figs/diagrams-scenario-push.png)
124123

125-
_Figure 3. Simplified pull sequence_
124+
_Figure 3. Simplified push sequence. The offering is a dataset that describes the API for pushing certificate data._
126125

127126
| # | What | Who |
128127
|---|------------------------------------------------|----------------|
129-
| 1 | Create data offer for certificate management | Provider (SME) |
130-
| 2 | Discover data offer for certificate management | Consumer |
131-
| 3 | Establish connection _(negotiate agreement)_ | Consumer |
132-
| 4 | Download certificate data | Consumer |
128+
| 1 | Create data offer for certificate management | Provider |
129+
| 2 | Discover data offer for certificate management | Consumer (SME) |
130+
| 3 | Establish connection _(negotiate agreement)_ | Consumer (SME) |
131+
| 4 | Upload certificate data | Consumer (SME) |
132+
133+
_Table 7. Steps for providing certificate data on request_
133134

134-
_Table 7. Steps for providing certificate data_
135135

136136
## Overall Technical Components
137137

138-
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).
138+
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.
139139

140140
We focus on four basic interactions:
141141

142-
1. The SME uses the End-User API to manage their certificates.
143-
2. The EDC tenant is connected to a partner's EDC in the dataspace for data sharing (provisioning & consumption).
144-
3. The MPS tenant has a connection to the EDC tenant for configuration purposes (e.g., initiate setup, onboarding information).
145-
4. The MSP tenant realizes the technical onboarding flow.
142+
1. The SME uses the End-User API for **certificate management**.
143+
2. The EDC tenant is connected to a partner's EDC in the dataspace for **data sharing** (provisioning & consumption).
144+
3. The MPS tenant has a connection to the EDC tenant for **configuration** purposes (e.g., initiate setup, onboarding information).
145+
4. The MSP tenant realizes the technical **onboarding** to the dataspace.
146146

147-
_Please note that the technical setup of namespaces and tenants in the CSP infrastructure is not further detailed in this picture._
147+
_Note: The technical setup of namespaces and tenants in the CSP infrastructure is not further detailed in this picture._
148148

149149
![Demo components](files/figs/diagrams-components.png)
150150

151-
_Figure 3. Simplified technical setup of components_
151+
_Figure 4. Simplified technical setup of components_
152152

153-
Description of interfaces:
153+
Description of services:
154154

155-
- The CSP provides an infrastructure (EDC-V namespace) incl. an EDC Tenant (Connector, Identity Hub) and an End-User API to manage certificates.
156-
- The CSP provides an API and UI to manage the infrastructure.
155+
- The CSP provides an infrastructure (**EDC namespace**) incl. an EDC tenant (Connector, Identity Hub) and an End-User API to manage certificates.
156+
- The CSP provides an API to manage the infrastructure.
157157
- The CSP provides a UI to access the MSP tenant.
158158
- The MSP tenant integrates into the EDC namespace.
159159
- The MSP tenant implements the API to register companies to the dataspace.
160160
- The EDC tenant provides an API to share data.
161-
- The EDC tenant implements the API to share data.
161+
- The EDC tenant implements the API to share data.
162+
163+
## User Journey
164+
165+
_To be added (screenshots)_

0 commit comments

Comments
 (0)