Skip to Content

Wiki source code of 2 Actors and Use Cases

Version 37.1 by Helena on 2025/05/22 09:42
Show last authors
1 {{box title="**Contents**"}}
2 {{toc/}}
3 {{/box}}
4
5 == {{id name="_Toc370963"/}}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 **Use case**
14
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 publishing (reporting), and consuming (using)
21 * Access to data, reference metadata, and structural and provisioning definitions
22
23 This document covers the first two aspects, whilst the document on the Registry logical model covers the last aspect.
24
25 == {{id name="_Toc370964"/}}2.2 Use Case Diagrams ==
26
27 === {{id name="_Toc370965"/}}2.2.1 Maintenance of Structural and Provisioning Definitions ===
28
29 [[image:1747688571909-670.png]]
30
31 **Figure 6 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 it is necessary for the structure and permitted content of the data and reference metadata 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.
36
37 All maintained artefacts are maintained by a Maintenance Agency. For convenience the Maintenance Agency 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 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 is maintained by a responsible organization (called here the Community Administrator), as it is important that the Id of the Maintenance Agency is unique.
45
46 ==== 2.2.1.3 Definitions ====
47
48 (((
49 (% style="width:972.294px" %)
50 |(% style="width:187px" %)**Actor**|(% style="width:236px" %)**Use Case**|(% style="width:547px" %)**Description**
51 |(% style="width:187px" %)(((
52 [[image:1747688634771-438.png]]
53
54 Community Administrator
55 )))|(% style="width:236px" %) |(% style="width:547px" %)Responsible organisation that administers structural definitions common to the community as a whole.
56 |(% style="width:187px" %) |(% style="width:236px" %)(((
57
58
59 Maintain Maintenance Agency Scheme
60 )))|(% style="width:547px" %)Creation and maintenance of the top-level scheme of maintenance agencies for the Community.
61 |(% style="width:187px" %)(((
62 [[image:1747688641349-114.png]]
63 Maintenance Agency
64 )))|(% style="width:236px" %) |(% style="width:547px" %)(((
65 Responsible agency for maintaining structural artefacts such as code lists, concept schemes, Data Structure Definition structural definitions, metadata structure definitions, data and metadata provisioning artefacts such as provision agreement, and submaintenance agencies.
66
67 sub roles are:
68 Structural Definitions
69 Maintenance Agency
70 Provisioning Definitions
71 Maintenance Agency
72 )))
73 )))
74
75 (((
76 (% style="width:974.294px" %)
77 |(% style="width:188px" %)(((
78 [[image:1747688686425-680.png]]
79 Structural Definitions Maintenance Agency
80 )))|(% style="width:293px" %) |(% style="width:548px" %)Responsible for maintaining structural definitions.
81 |(% style="width:188px" %) |(% style="width:293px" %)(((
82 [[image:1747895989437-570.png]]
83 Maintain Structure Definitions
84 )))|(% style="width:548px" %)The maintenance of structural definitions. This use case has sub class use cases for each of the structural artefacts that are maintained.
85 |(% style="width:188px" %) |(% style="width:293px" %)(((
86 [[image:1747896004486-873.png]]
87 Maintain Code List
88
89 [[image:1747896009533-990.png]]
90 MaintainConcepts
91
92 [[image:1747896014277-453.png]]
93 Maintain Category Scheme
94
95 [[image:1747896017685-493.png]]
96 Maintain Data Structure Definition
97 )))|(% style="width:548px" %)(((
98 Creation and maintenance of the Data Structure Definition, Metadata Structure Definition, and the supporting artefacts that they use, such as code list and  concepts
99 )))
100 )))
101
102 (((
103 (% style="width:976.294px" %)
104 |(% style="width:187px" %) |(% style="width:240px" %)(((
105 [[image:1747896022512-955.png]]
106 Maintain Metadata Structure Definition
107
108 [[image:1747896026313-659.png]]
109 Maintain Hierarchical Code Scheme
110
111 [[image:1747896030342-760.png]]
112 Maintain Reporting Taxonomy
113
114 [[image:1747896033858-560.png]]
115 Maintain Organisation Scheme
116
117 [[image:1747896037473-764.png]]
118 MaintainProcess
119
120 [[image:1747896048632-885.png]]
121 Maintain Dataflow Definition
122
123 [[image:1747896044576-648.png]]
124 Maintain Metadataflow Definition
125 )))|(% style="width:546px" %)(((
126 This includes Agency, Data Provider, Data Consumer, and Organisation Unit Scheme
127 )))
128 |(% style="width:187px" %)(((
129 [[image:1747688686425-680.png]]
130 Provisioning Definitions Maintenance Agency
131 )))|(% style="width:240px" %) |(% style="width:546px" %)Responsible for maintaining data and metadata provisioning definitions.
132 )))
133
134 **Figure 7: Table of Actors and Use Cases for Maintenance of Structural and Provisioning Definitions**
135
136 === {{id name="_Toc370966"/}}2.2.2 Publishing and Using Data and Reference Metadata ===
137
138 ==== 2.2.2.1 Use Cases ====
139
140 **Figure 8: Actors and use cases for data and metadata publishing and consuming**
141
142 ==== 2.2.2.2 Explanation of the Diagram ====
143
144 Note that in this diagram “publishing” data and reference metadata is deemed to be the same as “reporting” data and reference metadata. 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 its structure must be known. Furthermore, consuming applications may also require access to reference metadata in order to present this to the Data Consumer so that the data is better understood. As with the data, the reference metadata also needs to be formatted in accordance with a maintained structure. The Data Consumer and Metadata Consumer cannot use the data or reference metadata unless it is “published” and so there is a “data source” or “metadata source” dependency between the “uses” and “publish” use cases.
145
146 In any data and reference metadata 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 to whom, and when, or it can be more complex with 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, details of the source.
147
148 ==== 2.2.2.3 Definitions ====
149
150 (% style="width:1130.29px" %)
151 |(% colspan="1" style="width:180px" %)**Actor**|(% colspan="2" style="width:199px" %)**Use Case**|(% colspan="2" style="width:656px" %)**Description**
152 |(% colspan="1" style="width:180px" %)(((
153 [[image:1747688686425-680.png]]
154 Data Publisher
155 )))|(% colspan="2" style="width:199px" %) |(% colspan="2" style="width:656px" %)Responsible for publishing data according to a specified Data Structure Definition (data structure) definition, and relevant provisioning definitions.
156 |(% colspan="1" style="width:180px" %) |(% colspan="2" style="width:199px" %)(((
157 [[image:1747896053396-402.png]]
158 Publish Data
159 )))|(% colspan="2" style="width:656px" %)Publish a data set. This could mean a physical data set or it could mean to make the data available for access at a data source such as a database that can process a query.
160 |(% colspan="1" style="width:180px" %)(((
161 [[image:1747688686425-680.png]]
162 Data Consumer
163 )))|(% colspan="2" style="width:199px" %) |(% colspan="2" style="width:656px" %)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.
164 |(% colspan="1" style="width:180px" %) |(% colspan="2" style="width:199px" %)(((
165 [[image:1747896057633-585.png]]
166 Uses Data
167 )))|(% colspan="2" style="width:656px" %)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.
168 |(% colspan="1" style="width:180px" %)(((
169 [[image:1747688686425-680.png]]
170 Metadata Publisher
171 )))|(% colspan="2" style="width:199px" %) |(% colspan="2" style="width:656px" %)Responsible for publishing reference metadata according to a specified metadata structure definition, and relevant provisioning definitions.
172 |(% colspan="1" style="width:180px" %) |(% colspan="2" style="width:199px" %)(((
173 [[image:1747896069282-370.png]]
174 Publish Reference Metadata
175 )))|(% colspan="2" style="width:656px" %)Publish a reference metadata set. This could mean a physical metadata set or it could mean to make the reference metadata available for access at a metadata source such as a metadata repository that can process a query.
176 |(% colspan="1" style="width:180px" %)(((
177 [[image:1747688686425-680.png]]
178 Metadata Consumer
179 )))|(% colspan="2" style="width:199px" %) |(% colspan="2" style="width:656px" %)The user of the reference metadata. 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.
180 |(% colspan="1" style="width:180px" %) |(% colspan="2" style="width:199px" %)(((
181 [[image:1747896074313-782.png]]
182 Uses Reference Metadata
183 )))|(% colspan="2" style="width:656px" %)Use reference metadata that is formatted according to the structural definitions and made available according to the provisioning definitions.