Wiki source code of 2 Actors and Use Cases

Version 9.1 by Helena K. on 2026/06/04 17:55

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 **Actor**
10
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
16 //“A use case defines a set of use-case instances, where each instance is a [[sequence>>doc:IMElements.sequence.WebHome]] of actions a system performs that yields an observable result of [[value>>doc:IMElements.value.WebHome]] to a particular actor”//
17
18 The overall intent of the model is to support data and [[metadata>>doc:IMElements.metadata.WebHome]] reporting, dissemination, and exchange in the field of aggregated statistical data and related [[metadata>>doc:IMElements.metadata.WebHome]]. In order to achieve this, the model needs to support three fundamental aspects of this process:
19
20 * Maintenance of structural and provisioning definitions
21 * Data and [[reference metadata>>doc:sdmx:Glossary 2\.1.Reference metadata.WebHome]] publishing (reporting), and consuming (using)
22 * Access to data, [[reference metadata>>doc:sdmx:Glossary 2\.1.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.
23
24 == 2.2 Use Case Diagrams ==
25
26 === 2.2.1 Maintenance of Structural and Provisioning Definitions ===
27
28 ==== 2.2.1.1 Use cases ====
29
30 [[image:1749565006514-496.png]]
31
32 **Figure 7 Use cases for maintaining data and metadata structural and provisioning definitions**
33
34 ==== 2.2.1.2 Explanation of the Diagram ====
35
36 In order for applications to publish and consume data and [[reference metadata>>doc:sdmx:Glossary 2\.1.Reference metadata.WebHome]] it is necessary for the [[structure>>doc:IMElements.structure.WebHome]] and permitted content of the data and [[reference metadata>>doc:sdmx:Glossary 2\.1.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>>doc:IMElements.responsibility.WebHome]] of a [[Maintenance Agency>>doc:sdmx:Glossary 2\.1.Maintenance agency.WebHome]].
37
38 All maintained [[artefacts>>doc:sdmx:Glossary 2\.1.Artefact.WebHome]] are maintained by a [[Maintenance Agency>>doc:sdmx:Glossary 2\.1.Maintenance agency.WebHome]]. For convenience the [[Maintenance Agency>>doc:sdmx:Glossary 2\.1.Maintenance agency.WebHome]] actor is sub divided into two actor roles:
39
40 * maintaining structural definitions
41 * maintaining provisioning definitions
42
43 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:sdmx:Glossary 2\.1.Reference metadata.WebHome]] when reported or disseminated, whilst provisioning definitions support the process of reporting and dissemination (who reports what to whom, and when).
44
45 In a community-based scenario where at least the structural definitions may be shared, it is important that the scheme of [[maintenance agencies>>doc:sdmx:Glossary 2\.1.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:sdmx:Glossary 2\.1.Maintenance agency.WebHome]] is unique.
46
47 ==== 2.2.1.3 Definitions ====
48
49 (% style="width:968.835px" %)
50 |(% style="width:205px" %)**Actor**|(% style="width:209px" %)**Use Case**|(% style="width:492px" %)**Description**
51 |(% style="width:205px" %)(((
52 [[image:1749332266428-602.png]]
53
54 Community Administrator
55 )))|(% style="width:209px" %) |(% style="width:492px" %)Responsible organisation that administers structural definitions common to the community as a whole.
56 |(% style="width:205px" %) |(% style="width:209px" %)(((
57 [[image:1749332418495-734.png]]
58
59 Maintain [[Maintenance Agency>>doc:sdmx:Glossary 2\.1.Maintenance agency.WebHome]] Scheme
60 )))|(% style="width:492px" %)Creation and maintenance of the top-level scheme of [[maintenance agencies>>doc:sdmx:Glossary 2\.1.Maintenance agency.WebHome]] for the Community.
61 |(% style="width:205px" %)(((
62 [[image:1749332281362-480.png]]
63
64 [[Maintenance Agency>>doc:sdmx:Glossary 2\.1.Maintenance agency.WebHome]]
65 )))|(% style="width:209px" %) |(% style="width:492px" %)(((
66 Responsible agency for maintaining structural [[artefacts>>doc:sdmx:Glossary 2\.1.Artefact.WebHome]] such as [[code lists>>doc:sdmx:Glossary 2\.1.Code list.WebHome]], [[concept schemes>>doc:sdmx:Glossary 2\.1.Concept scheme.WebHome]], [[Data Structure Definition>>doc:sdmx:Glossary 2\.1.Data structure definition.WebHome]] structural definitions, [[metadata structure definitions>>doc:sdmx:Glossary 2\.1.Metadata structure definition.WebHome]], data and metadata provisioning [[artefacts>>doc:sdmx:Glossary 2\.1.Artefact.WebHome]] such as [[provision agreement>>doc:sdmx:Glossary 2\.1.Provision agreement.WebHome]], and submaintenance agencies.
67
68 sub roles are:
69 Structural Definitions [[Maintenance Agency>>doc:sdmx:Glossary 2\.1.Maintenance agency.WebHome]] Provisioning Definitions [[Maintenance Agency>>doc:sdmx:Glossary 2\.1.Maintenance agency.WebHome]]
70 )))
71 |(% style="width:205px" %)(((
72 [[image:1749332303367-802.png]]
73
74 Structural Definitions [[Maintenance Agency>>doc:sdmx:Glossary 2\.1.Maintenance agency.WebHome]]
75 )))|(% style="width:209px" %) |(% style="width:492px" %)Responsible for maintaining structural definitions.
76 |(% style="width:205px" %) |(% style="width:209px" %)(((
77 [[image:1749332439969-220.png]]
78
79 Maintain [[Structure>>doc:IMElements.AnnotableArtefact.IdentifiableArtefact.NameableArtefact.VersionableArtefact.MaintainableArtefact.Structure.WebHome]] Definitions
80 )))|(% style="width:492px" %)The maintenance of structural definitions. This use case has sub class use cases for each of the structural [[artefacts>>doc:sdmx:Glossary 2\.1.Artefact.WebHome]] that are maintained.
81 |(% style="width:205px" %) |(% style="width:209px" %)(((
82 [[image:1749332464332-268.png]]
83
84 Maintain [[Code List>>doc:sdmx:Glossary 2\.1.Code list.WebHome]]
85
86 [[image:1749332472857-432.png]]
87
88 MaintainConcepts
89
90 [[image:1749332500135-878.png]]
91
92 Maintain [[Category Scheme>>doc:sdmx:Glossary 2\.1.Category scheme.WebHome]]
93
94 [[image:1749332504477-812.png]]
95
96 Maintain [[Data Structure Definition>>doc:sdmx:Glossary 2\.1.Data structure definition.WebHome]]
97
98 [[image:1749332510405-500.png]]
99
100 Maintain [[Metadata Structure Definition>>doc:sdmx:Glossary 2\.1.Metadata structure definition.WebHome]]
101
102 [[image:1749332513843-675.png]]
103
104 Maintain [[Hierarchical Code>>doc:sdmx:Glossary 2\.1.Hierarchical code.WebHome]] Scheme
105 )))|(% style="width:492px" %)Creation and maintenance of the [[Data Structure Definition>>doc:sdmx:Glossary 2\.1.Data structure definition.WebHome]], [[Metadata Structure Definition>>doc:sdmx:Glossary 2\.1.Metadata structure definition.WebHome]], and the supporting [[artefacts>>doc:sdmx:Glossary 2\.1.Artefact.WebHome]] that they use, such as [[code list>>doc:sdmx:Glossary 2\.1.Code list.WebHome]] and concepts
106 |(% style="width:205px" %) |(% style="width:209px" %)(((
107 [[image:1749332711878-606.png]]
108
109 Maintain [[Reporting Taxonomy>>doc:sdmx:Glossary 2\.1.Reporting taxonomy.WebHome]]
110
111 [[image:1749332714083-294.png]]
112
113 Maintain [[Organisation>>doc:IMElements.AnnotableArtefact.IdentifiableArtefact.NameableArtefact.Item.Organisation.WebHome]] Scheme
114
115 [[image:1749332715710-552.png]]
116
117 MaintainProcess
118
119 [[image:1749332717889-510.png]]
120
121 Maintain [[Dataflow>>doc:IMElements.AnnotableArtefact.IdentifiableArtefact.NameableArtefact.VersionableArtefact.MaintainableArtefact.StructureUsage.Dataflow.WebHome]] Definition
122
123 [[image:1749332719459-955.png]]
124
125 Maintain [[Metadataflow>>doc:IMElements.AnnotableArtefact.IdentifiableArtefact.NameableArtefact.VersionableArtefact.MaintainableArtefact.StructureUsage.Metadataflow.WebHome]] Definition
126 )))|(% style="width:492px" %)(((
127 This includes Agency, [[Data Provider>>doc:sdmx:Glossary 2\.1.Data provider.WebHome]], [[Data Consumer>>doc:sdmx:Glossary 2\.1.Data consumer.WebHome]], and [[Organisation Unit Scheme>>doc:sdmx:Glossary 2\.1.Organisation unit scheme.WebHome]]
128 )))
129 |(% style="width:205px" %)(((
130 [[image:1749332321274-765.png]]
131
132 Provisioning Definitions [[Maintenance Agency>>doc:sdmx:Glossary 2\.1.Maintenance agency.WebHome]]
133 )))|(% style="width:209px" %) |(% style="width:492px" %)Responsible for maintaining data and metadata provisioning definitions.
134 |(% style="width:205px" %) |(% style="width:209px" %)(((
135 [[image:1749332401454-279.png]]
136
137 Maintain [[Provision Agreement>>doc:sdmx:Glossary 2\.1.Provision agreement.WebHome]]
138 )))|(% style="width:492px" %)The maintenance of provisioning definitions.
139
140 **Figure 8: Table of Actors and Use Cases for Maintenance of Structural and Provisioning Definitions**
141
142 === 2.2.2 Publishing and Using Data and Reference Metadata ===
143
144 ==== 2.2.2.1 Use Cases ====
145
146 [[image:1749565058251-456.png]]
147
148 **Figure 9: Actors and use cases for data and metadata publishing and consuming**
149
150 ==== 2.2.2.2 Explanation of the Diagram ====
151
152 Note that in this diagram “publishing” data and [[reference metadata>>doc:sdmx:Glossary 2\.1.Reference metadata.WebHome]] is deemed to be the same as “reporting” data and [[reference metadata>>doc:sdmx:Glossary 2\.1.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:sdmx:Glossary 2\.1.Reference metadata.WebHome]] its [[structure>>doc:IMElements.structure.WebHome]] must be known. Furthermore, consuming applications may also require access to [[reference metadata>>doc:sdmx:Glossary 2\.1.Reference metadata.WebHome]] in order to present this to the [[Data Consumer>>doc:sdmx:Glossary 2\.1.Data consumer.WebHome]] so that the data is better understood. As with the data, the [[reference metadata>>doc:sdmx:Glossary 2\.1.Reference metadata.WebHome]] also needs to be formatted in accordance with a maintained [[structure>>doc:IMElements.structure.WebHome]]. The [[Data Consumer>>doc:sdmx:Glossary 2\.1.Data consumer.WebHome]] and Metadata Consumer cannot use the data or [[reference metadata>>doc:sdmx:Glossary 2\.1.Reference metadata.WebHome]] unless it is “published” and so there is a “[[data source>>doc:sdmx:Glossary 2\.1.Data source.WebHome]]” or “[[metadata>>doc:IMElements.metadata.WebHome]] source” dependency between the “uses” and “publish” use cases.
153
154 In any data and [[reference metadata>>doc:sdmx:Glossary 2\.1.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:sdmx:Glossary 2\.1.Reference metadata.WebHome]] to whom, and when, or it can be more complex with [[constraints>>doc:sdmx:Glossary 2\.1.Constraint.WebHome]] on the data and [[metadata>>doc:IMElements.metadata.WebHome]] that can be provided by a particular publisher, and, in a data sharing scenario where data and [[metadata>>doc:IMElements.metadata.WebHome]] are “pulled” from [[data sources>>doc:sdmx:Glossary 2\.1.Data source.WebHome]], details of the source.
155
156 ==== 2.2.2.3 Definitions ====
157
158 (% style="width:972.835px" %)
159 |(% style="width:179px" %)**Actor**|(% style="width:240px" %)**Use Case**|(% style="width:551px" %)**Description**
160 |(% style="width:179px" %)(((
161 [[image:1749332809145-933.png]]
162
163 Data Publisher
164 )))|(% style="width:240px" %) |(% style="width:551px" %)Responsible for publishing data according to a specified [[Data Structure Definition>>doc:sdmx:Glossary 2\.1.Data structure definition.WebHome]] (data structure) definition, and relevant provisioning definitions.
165 |(% style="width:179px" %) |(% style="width:240px" %)(((
166 [[image:1749332761213-807.png]]
167
168 Publish Data
169 )))|(% style="width:551px" %)Publish a [[data set>>doc:sdmx:Glossary 2\.1.Data set.WebHome]]. This could mean a physical [[data set>>doc:sdmx:Glossary 2\.1.Data set.WebHome]] or it could mean to make the data available for access at a [[data source>>doc:sdmx:Glossary 2\.1.Data source.WebHome]] such as a database that can process a query.
170 |(% style="width:179px" %)(((
171 [[image:1749332803560-738.png]]
172
173 [[Data Consumer>>doc:sdmx:Glossary 2\.1.Data consumer.WebHome]]
174 )))|(% style="width:240px" %) |(% style="width:551px" %)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.
175 |(% style="width:179px" %) |(% style="width:240px" %)(((
176 [[image:1749332768027-695.png]]
177
178 Uses Data
179 )))|(% style="width:551px" %)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.
180 |(% style="width:179px" %)(((
181 [[image:1749332800396-294.png]]
182
183 Metadata Publisher
184 )))|(% style="width:240px" %) |(% style="width:551px" %)Responsible for publishing [[reference metadata>>doc:sdmx:Glossary 2\.1.Reference metadata.WebHome]] according to a specified [[metadata structure definition>>doc:sdmx:Glossary 2\.1.Metadata structure definition.WebHome]], and relevant provisioning definitions.
185 |(% style="width:179px" %) |(% style="width:240px" %)(((
186 [[image:1749332770196-488.png]]
187
188 Publish [[Reference Metadata>>doc:sdmx:Glossary 2\.1.Reference metadata.WebHome]]
189 )))|(% style="width:551px" %)Publish a [[reference metadata>>doc:sdmx:Glossary 2\.1.Reference metadata.WebHome]] set. This could mean a physical [[metadata set>>doc:sdmx:Glossary 2\.1.Metadata set.WebHome]] or it could mean to make the [[reference metadata>>doc:sdmx:Glossary 2\.1.Reference metadata.WebHome]] available for access at a metadata source such as a [[metadata repository>>doc:sdmx:Glossary 2\.1.Metadata repository.WebHome]] that can process a query.
190 |(% style="width:179px" %)(((
191 [[image:1749332796916-810.png]]
192
193 Metadata Consumer
194
195 )))|(% style="width:240px" %) |(% style="width:551px" %)The user of the [[reference metadata>>doc:sdmx:Glossary 2\.1.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.
196 |(% style="width:179px" %) |(% style="width:240px" %)(((
197 [[image:1749332773645-193.png]]
198
199 Uses [[Reference Metadata>>doc:sdmx:Glossary 2\.1.Reference metadata.WebHome]]
200 )))|(% style="width:551px" %)Use [[reference metadata>>doc:sdmx:Glossary 2\.1.Reference metadata.WebHome]] that is formatted according to the structural definitions and made available according to the provisioning definitions.
© Semantic R&D Group, 2026