Skip to Content

Wiki source code of 2 Actors and Use Cases

Version 26.2 by Helena on 2025/05/16 23:09
Show last authors
1 {{box title="**Contents**"}}
2 {{toc/}}
3 {{/box}}
4
5 == 2.1 Introduction ==
6
7 In order to develop the data models it is necessary to understand the functions to be supported resulting from the requirements definition. These are defined in a use case model. The use case model comprises actors and use cases and these are defined below.
8
9 (% class="wikigeneratedid" id="HActor" %)
10 **Actor**
11 “//An actor defines a coherent set of roles that users of the system can play when interacting with it. An actor instance can be played by either an individual or an external system//”
12
13 (% class="wikigeneratedid" id="HUsecase" %)
14 **Use case**
15 “//A use case defines a set of use-case instances, where each instance is a sequence of actions a system performs that yields an observable result of value to a particular actor”//
16
17 The overall intent of the model is to support data and metadata reporting, dissemination, and exchange in the field of aggregated statistical data and related metadata. In order to achieve this, the model needs to support three fundamental aspects of this process:
18
19 * Maintenance of structural and provisioning definitions
20 * Data and [[reference metadata>>doc:xwiki:Glossary.Reference metadata.WebHome]] publishing (reporting), and consuming (using)
21 * Access to data, [[reference metadata>>doc:xwiki:Glossary.Reference metadata.WebHome]], and structural and provisioning definitions. This document covers the first two aspects, whilst the document on the Registry logical model covers the last aspect.
22
23 == 2.2 Use Case Diagrams ==
24
25 === 2.2.1 Maintenance of Structural and Provisioning Definitions ===
26
27 ==== 2.2.1.1 Use cases ====
28
29 [[image:SDMX 3-0-0 SECTION 2 FINAL-1.0 (1)_en_eeba1ab9.png||height="418" width="718"]]
30
31 **Figure 7 Use cases for maintaining data and metadata structural and provisioning definitions**
32
33 ==== 2.2.1.2 Explanation of the Diagram ====
34
35 In order for applications to publish and consume data and [[reference metadata>>doc:xwiki:Glossary.Reference metadata.WebHome]] it is necessary for the structure and permitted content of the data and [[reference metadata>>doc:xwiki:Glossary.Reference metadata.WebHome]] to be defined and made available to the applications, as well as definitions that support the actual process of publishing and consuming. This is the responsibility of a [[Maintenance Agency>>doc:xwiki:Glossary.Maintenance agency.WebHome]].
36
37 All maintained [[artefacts>>doc:xwiki:Glossary.Artefact.WebHome]] are maintained by a [[Maintenance Agency>>doc:xwiki:Glossary.Maintenance agency.WebHome]]. For convenience the [[Maintenance Agency>>doc:xwiki:Glossary.Maintenance agency.WebHome]] actor is sub divided into two actor roles:
38
39 * maintaining structural definitions
40 * maintaining provisioning definitions
41
42 Whilst both these functions may be carried out by the same person, or at least by the same maintaining organization, the purpose of the definitions is different and so the roles have been differentiated: structural definitions define the format and permitted content of data and [[reference metadata>>doc:xwiki:Glossary.Reference metadata.WebHome]] when reported or disseminated, whilst provisioning definitions support the process of reporting and dissemination (who reports what to whom, and when).
43
44 In a community-based scenario where at least the structural definitions may be shared, it is important that the scheme of [[maintenance agencies>>doc:xwiki:Glossary.Maintenance agency.WebHome]] is maintained by a responsible organization (called here the Community Administrator), as it is important that the Id of the [[Maintenance Agency>>doc:xwiki:Glossary.Maintenance agency.WebHome]] is unique.
45
46 ==== 2.2.1.3 Definitions ====
47
48 (% style="width:970.039px" %)
49 |(% style="width:296px" %)**Actor**|(% style="width:277px" %)**Use Case**|(% style="width:393px" %)**Description**
50 |(% style="width:296px" %)(((
51 [[image:1747293238479-455.png||height="53" width="50"]]
52
53 Community Administrator
54 )))|(% style="width:277px" %) |(% style="width:393px" %)Responsible organisation that administers structural definitions common to the community as a whole.
55 |(% style="width:296px" %)(((
56
57 )))|(% style="width:277px" %)(((
58 [[image:SDMX 3-0-0 SECTION 2 FINAL-1.0 (1)_en_2e1da8dc.gif||alt="Shape3" height="31" width="60"]]
59
60 Maintain Maintenance
61 Agency Scheme
62 )))|(% style="width:393px" %)Creation and maintenance of the top-(% style="color:#2ecc71" %)level(%%) scheme of [[maintenance agencies>>doc:xwiki:Glossary.Maintenance agency.WebHome]] for the Community.
63 |(% style="width:296px" %)(((
64 [[image:1747293251023-197.png||height="50" width="47"]]
65
66 [[Maintenance Agency>>doc:xwiki:Glossary.Maintenance agency.WebHome]]
67 )))|(% style="width:277px" %) |(% style="width:393px" %)(((
68 Responsible agency for maintaining structural [[artefacts>>doc:xwiki:Glossary.Artefact.WebHome]] such as [[code lists>>doc:xwiki:Glossary.Code list.WebHome]], [[concept schemes>>doc:xwiki:Glossary.Concept scheme.WebHome]], [[Data Structure Definition>>doc:xwiki:Glossary.Data structure definition.WebHome]] structural definitions, [[metadata structure definitions>>doc:xwiki:Glossary.Metadata structure definition.WebHome]], data and metadata provisioning [[artefacts>>doc:xwiki:Glossary.Artefact.WebHome]] such as [[provision agreement>>doc:xwiki:Glossary.Provision agreement.WebHome]], and submaintenance agencies.
69
70 sub roles are:
71 Structural Definitions
72 [[Maintenance Agency>>doc:xwiki:Glossary.Maintenance agency.WebHome]]
73 Provisioning Definitions
74 [[Maintenance Agency>>doc:xwiki:Glossary.Maintenance agency.WebHome]]
75 )))
76 |(% style="width:296px" %)(((
77 [[image:1747293348663-554.png||height="48" width="45"]]
78
79 Structural Definitions
80 [[Maintenance Agency>>doc:xwiki:Glossary.Maintenance agency.WebHome]]
81 )))|(% style="width:277px" %) |(% style="width:393px" %)Responsible for maintaining structural definitions.
82 |(% style="width:296px" %) |(% style="width:277px" %)(((
83
84
85 [[image:SDMX%203-0-0%20SECTION%202%20FINAL-1.0%20%281%29_en_2e1da8dc.gif]]
86
87 Maintain Structure Definitions
88 )))|(% style="width:393px" %)The maintenance of structural definitions. This use case has sub class use cases for each of the structural [[artefacts>>doc:xwiki:Glossary.Artefact.WebHome]] that are maintained.
89 | |(% style="width:280px" %)(((
90 [[image:SDMX 3-0-0 SECTION 2 FINAL-1.0 (1)_en_2e1da8dc.gif||alt="Shape7" height="31" width="60"]]
91
92 Maintain [[Code>>doc:xwiki:Glossary.Code.WebHome]]
93
94 List
95
96 [[image:SDMX%203-0-0%20SECTION%202%20FINAL-1.0%20%281%29_en_2e1da8dc.gif]]
97
98 MaintainConcepts
99
100 [[image:SDMX%203-0-0%20SECTION%202%20FINAL-1.0%20%281%29_en_2e1da8dc.gif]]
101
102 Maintain Category
103
104 Scheme
105
106 [[image:SDMX%203-0-0%20SECTION%202%20FINAL-1.0%20%281%29_en_2e1da8dc.gif]]
107
108 Maintain Data
109 Structure Definition
110
111 [[image:SDMX%203-0-0%20SECTION%202%20FINAL-1.0%20%281%29_en_2e1da8dc.gif]]
112
113 Maintain Metadata
114 Structure Definition
115
116 [[image:SDMX 3-0-0 SECTION 2 FINAL-1.0 (1)_en_2e1da8dc.gif||alt="Shape12" height="31" width="60"]]
117
118 Maintain Hierarchical
119 [[Code>>doc:xwiki:Glossary.Code.WebHome]] Scheme
120 )))|(% style="width:392px" %)(((
121 Creation and maintenance of the [[Data Structure Definition>>doc:xwiki:Glossary.Data structure definition.WebHome]], [[Metadata Structure Definition>>doc:xwiki:Glossary.Metadata structure definition.WebHome]], and the supporting [[artefacts>>doc:xwiki:Glossary.Artefact.WebHome]] that they use, such as [[code list>>doc:xwiki:Glossary.Code list.WebHome]] and (% style="color:#2ecc71" %)concepts
122 )))
123 | |(% style="width:280px" %)(((
124 [[image:SDMX 3-0-0 SECTION 2 FINAL-1.0 (1)_en_2e1da8dc.gif||alt="Shape13" height="31" width="60"]]
125
126 Maintain Reporting
127
128 Taxonomy
129
130 [[image:SDMX%203-0-0%20SECTION%202%20FINAL-1.0%20%281%29_en_2e1da8dc.gif]]
131
132 Maintain Organisation Scheme
133
134 [[image:SDMX%203-0-0%20SECTION%202%20FINAL-1.0%20%281%29_en_2e1da8dc.gif]]
135
136 MaintainProcess
137
138 [[image:SDMX 3-0-0 SECTION 2 FINAL-1.0 (1)_en_2e1da8dc.gif||alt="Shape16" height="31" width="60"]]
139
140 Maintain [[Dataflow>>doc:xwiki:Glossary.Dataflow.WebHome]] Definition
141
142 [[image:SDMX 3-0-0 SECTION 2 FINAL-1.0 (1)_en_2e1da8dc.gif||alt="Shape17" height="31" width="60"]]
143
144 Maintain [[Metadataflow>>doc:xwiki:Glossary.Metadataflow.WebHome]] Definition
145 )))|(% style="width:392px" %)This includes Agency, [[Data Provider>>doc:xwiki:Glossary.Data provider.WebHome]], [[Data Consumer>>doc:xwiki:Glossary.Data consumer.WebHome]], and Organisation Unit Scheme
146 |(((
147 [[image:1747293348663-554.png||height="51" width="48"]]
148
149 Provisioning Definitions
150 [[Maintenance Agency>>doc:xwiki:Glossary.Maintenance agency.WebHome]]
151 )))|(% style="width:280px" %) |(% style="width:392px" %)Responsible for maintaining data and metadata provisioning definitions.
152 | |(% style="width:280px" %)(((
153
154
155 [[image:SDMX%203-0-0%20SECTION%202%20FINAL-1.0%20%281%29_en_2e1da8dc.gif]]
156
157 Maintain [[Provision Agreement>>doc:xwiki:Glossary.Provision agreement.WebHome]]
158 )))|(% style="width:392px" %)The maintenance of provisioning definitions.
159
160 **Figure 8: Table of Actors and Use Cases for Maintenance of Structural and Provisioning Definitions**
161
162 === 2.2.2 Publishing and Using Data and Reference Metadata ===
163
164 ==== 2.2.2.1 Use Cases ====
165
166 [[image:SDMX 3-0-0 SECTION 2 FINAL-1.0 (1)_en_ba4e50bb.png||height="492" width="633"]]
167
168 **Figure 9: Actors and use cases for data and metadata publishing and consuming**
169
170 ==== 2.2.2.2 Explanation of the Diagram ====
171
172 Note that in this diagram “publishing” data and [[reference metadata>>doc:xwiki:Glossary.Reference metadata.WebHome]] is deemed to be the same as “reporting” data and [[reference metadata>>doc:xwiki:Glossary.Reference metadata.WebHome]]. In some cases the act of making the data available fulfils both functions. Aggregated data is published and in order for the Data Publisher to do this and in order for consuming applications to process the data and [[reference metadata>>doc:xwiki:Glossary.Reference metadata.WebHome]] its structure must be known. Furthermore, consuming applications may also require access to [[reference metadata>>doc:xwiki:Glossary.Reference metadata.WebHome]] in order to present this to the [[Data Consumer>>doc:xwiki:Glossary.Data consumer.WebHome]] so that the data is better understood.
173
174 As with the data, the [[reference metadata>>doc:xwiki:Glossary.Reference metadata.WebHome]] also needs to be formatted in accordance with a maintained structure. The [[Data Consumer>>doc:xwiki:Glossary.Data consumer.WebHome]] and Metadata Consumer cannot use the data or [[reference metadata>>doc:xwiki:Glossary.Reference metadata.WebHome]] unless it is “published” and so there is a “[[data source>>doc:xwiki:Glossary.Data source.WebHome]]” or “metadata source” dependency between the “uses” and “publish” use cases.
175
176 In any data and [[reference metadata>>doc:xwiki:Glossary.Reference metadata.WebHome]] publishing and consuming scenario both the publishing and the consuming applications will need access to maintained Provisioning Definitions. These definitions may be as simple as who provides what data and [[reference metadata>>doc:xwiki:Glossary.Reference metadata.WebHome]] to whom, and when, or it can be more complex with (% style="color: rgb(46, 204, 113); color: rgb(46, 204, 113)" %)constraints(%%) on the data and metadata that can be provided by a particular publisher, and, in a data sharing scenario where data and metadata are “pulled” from [[data sources>>doc:xwiki:Glossary.Data source.WebHome]], details of the source.
177
178 ==== 2.2.2.3 Definitions ====
179
180 (((
181 (% style="width:822.039px" %)
182 |**Actor**|**Use Case**|(% style="width:509px" %)**Description**
183 |(((
184 [[image:1747293238479-455.png]]
185
186 Data Publisher
187 )))| |(% style="width:509px" %)(((
188 Responsible for publishing data according to a specified [[Data Structure Definition>>doc:xwiki:Glossary.Data structure definition.WebHome]] (data structure) definition, and relevant provisioning definitions.
189 )))
190 | |(((
191 [[image:SDMX%203-0-0%20SECTION%202%20FINAL-1.0%20%281%29_en_2e1da8dc.gif]]
192
193 Publish Data
194 )))|(% style="width:509px" %)Publish a [[data set>>doc:xwiki:Glossary.Data set.WebHome]]. This could mean a physical [[data set>>doc:xwiki:Glossary.Data set.WebHome]] or it could mean to make the data available for access at a [[data source>>doc:xwiki:Glossary.Data source.WebHome]] such as a database that can process a query.
195 |(((
196 [[image:1747293238479-455.png]]
197
198 Data Consumer
199 )))| |(% style="width:509px" %)The user of the data. It may be a human consumer accessing via a user interface, or it could be an application such as a statistical production system.
200 | |(((
201 [[image:SDMX%203-0-0%20SECTION%202%20FINAL-1.0%20%281%29_en_2e1da8dc.gif]]
202
203 Uses Data
204 )))|(% style="width:509px" %)Use data that is formatted according to the structural definitions and made available according to the provisioning definitions. Data are often linked to metadata that may reside in a different location and be published and maintained independently.
205 |(((
206 [[image:1747293238479-455.png]]
207
208 Metadata Publisher
209 )))| |(% style="width:509px" %)Responsible for publishing [[reference metadata>>doc:xwiki:Glossary.Reference metadata.WebHome]] according to a specified [[metadata structure definition>>doc:xwiki:Glossary.Metadata structure definition.WebHome]], and relevant provisioning definitions.
210 | |(((
211 [[image:SDMX%203-0-0%20SECTION%202%20FINAL-1.0%20%281%29_en_2e1da8dc.gif]]
212
213 Publish Reference
214
215 Metadata
216 )))|(% style="width:509px" %)Publish a [[reference metadata>>doc:xwiki:Glossary.Reference metadata.WebHome]] set. This could mean a physical [[metadata set>>doc:xwiki:Glossary.Metadata set.WebHome]] or it could mean to make the [[reference metadata>>doc:xwiki:Glossary.Reference metadata.WebHome]] available for access at a metadata source such as a [[metadata repository>>doc:xwiki:Glossary.Metadata repository.WebHome]] that can process a query.
217 |(((
218 [[image:1747293238479-455.png]]
219
220 Metadata Consumer
221 )))| |(% style="width:509px" %)The user of the [[reference metadata>>doc:xwiki:Glossary.Reference metadata.WebHome]]. It may be a human consumer accessing via a user interface, or it could be an application such as a statistical production or dissemination system.
222 | |(((
223 [[image:SDMX%203-0-0%20SECTION%202%20FINAL-1.0%20%281%29_en_2e1da8dc.gif]]
224
225 Uses [[Reference Metadata>>doc:xwiki:Glossary.Reference metadata.WebHome]]
226 )))|(% style="width:509px" %)Use [[reference metadata>>doc:xwiki:Glossary.Reference metadata.WebHome]] that is formatted according to the structural definitions and made available according to the provisioning definitions.
227 )))