Discussion #2318

MIWP-6 - Identification and documentation of use cases for Registries and Registers

Added by Christian Ansorge over 5 years ago. Updated over 5 years ago.

Status:New
Priority:Normal
Assignee:Christian Ansorge

Description

MIWP-6 - Identification and documentation of use cases for Registries and Registers

 

Scope of subtask

 

General scope

The scope of this sub task is to identify and describe use cases for registers and registries from data provider and user perspective. These use cases shall be used for the testbed and for the planned TG on Registries and Registers. 

 

Deliverables

  • Description of use cases (filled template incl. description)
  • What else? 

 

Use case description template

The use cases shall follow a common structure, for which I adopted the use case description from the Data Specification Template.

Use Case Template
Name A short name for the use case, usually describing an activity
Primary Actor The main person or system interested in the outcomes of the task
Goal The goal of the primary actor, i.e. the state or product that shall be produced by successfully executing the task
System under consideration The (computer) system that the actor interacts with for executing the use case
Importance <high/medium/low>
Description Give a short narrative description of the task
Pre-Condition What are the pre-requisites? What input is required?
Post-Condition What is the output from the use case? What are the anticipated next steps?
Flow of Events
Step 1 Description of step 1
Step 2 ...
... ...

 


Subtasks

Discussion #2330: Use case A: Search for existing codelistNewChristian Ansorge

Discussion #2332: Use Case B - Creating new codelistNewChristian Ansorge

Discussion #2333: Use Case C - Extend existing codelistNewChristian Ansorge

Discussion #2331: Use Case G: Automated propagation/dissemination of regist...New

Discussion #2334: Use Case D Search for an existing feature catalogue/uml m...NewChristian Ansorge

Discussion #2335: Use Case E Extend existing feature catalogue/uml model wi...NewChristian Ansorge

Discussion #2336: Use Case F Linking the registers/registries with the unde...NewChristian Ansorge

History

#1 Updated by Christian Ansorge over 5 years ago

Here a first use case which also represents a example for how to apply the use case categories.

 

The general motivation for Use Case A, B and C comes from the INSPIRE Directive which requires from data providers to publish their data according to the INSPIRE Data Themes and following the INSPIRE Implementing Provision on Interoperability of Spatial Data Sets and Services. Depending on the data theme the use of extendable codelists might be required. In this case the data provider first has to discover already existing codelists, created by other providers, to decide for either direct reuse, adoption or newly creation of codelists.

 

Use Case A is therefore focusing on the discovery of codelists registered within a registry federation. This builds on the assumption that codelists has already been created by other users and the data provider aims at reusing them in the first place.  

 

Use Case A - Search for existing codelist
Name Search for existing codelist
Primary Actor INSPIRE Data Provider
Goal To provide INSPIRE Data with reusable and semanticly fitting description (codelist values)
System under consideration WFS and/or predefined dataset; Registry federation
Importance high
Description A data provider wants to provide a dataset according to the INSPIRE data specifications which requires a extendible codelist. For that purpose the provider accesses the registry federation to discover codelist extensions (including their values) published and used by other provider before. 
Pre-Condition Registry federation is operative; Codelists of interest have been published
Post-Condition Code lists best fitting to actual content has been discovered and data provider refers to it from it's data set

 

Use Case A - Flow of Events
Step 1

Data provider enters search request in a registry entry point  

Step 2 Search request is being distributed within the registry federation and processed
Step 3 Search results are returned to the user
Step 4 Data provider evaluates results and take decision if they fit for purpose (reuse of existing codelists) or not (creation of new codelist) 

 

#2 Updated by Christian Ansorge over 5 years ago

  • Description updated (diff)

#3 Updated by Christian Ansorge over 5 years ago

Use Case B builds on the already finished search process which let the data provider conclude that a new codelist has to be created to serve the purpose. The goal of this use case is to register a new code list within the registry federation which is referable for the creating data provider but also for other users.

 

Use Case B - Creating new codelist

Name Creating new codelist
Primary Actor INSPIRE Data Provider
Goal The create a new codelist within a register and to reference to it
System under consideration WFS and/or predefined dataset; Registry federation and Registry entry point
Importance high
Description A data provider cannot reuse a existing codelist within the registry but has to register a new one. For that purpose the provider accesses a registry entry point to publish his codelist, link it with other codelists and to refer to it. 
Pre-Condition Registry federation is operative; No suitable codelists discoverable (Use Case A)
Post-Condition Data provider refers within data sets to newly created codelist 

 

Use Case B - Flow of Events
Step 1

User enters registry entry point

Step 2 New codelist is created within a registry of the federation
Step 3 Codelist is linked with other codelists or registers within the registry federation
Step 4 Data provider receives identification and location of the newly created codelist
Step 5 Data provider refers within data sets to newly created codelist 

#4 Updated by Christian Ansorge over 5 years ago

Use Case C builds on the already finished search process which identified codelists which still needs adoptions to fit for purpose. The goal of this use case is to register a extended or updated code list within the registry federation which is referable for the creating data provider but also for other users.

 

Use Case C - Extend existing codelist

Name Extend existing codelist
Primary Actor INSPIRE Data Provider
Goal Update or extend an existing codelist within a register.
System under consideration WFS and/or predefined dataset; Registry federation
Importance high
Description A data provider can reuse an existing codelist within the registry but still has to update or extend it. For that purpose the provider accesses a registry entry point to extend the codelist, link it with other codelists and to refer to it from its data sets. 
Pre-Condition Registry federation is operative; Suitable codelists discoverable (Use Case A)
Post-Condition Data provider refers within it's data sets to newly extended codelist 

 

Use Case C - Flow of Events
Step 1

Data provider enters registry entry point

Step 2 Codelist is identified and accessed within a registry of the federation
Step 3 Codelist is extended or updated
Step 4 Extended or updated codelist is stored within the registry
Step 5 Data Provider receives identification and location of updated or extended codelist
Step 6 Data provider refers within it's data sets to newly extended codelist 

#5 Updated by Christian Ansorge over 5 years ago

  • Description updated (diff)

#6 Updated by Christian Ansorge over 5 years ago

  • Description updated (diff)

#7 Updated by Christian Ansorge over 5 years ago

  • Description updated (diff)

#8 Updated by Martin Tuchyna over 5 years ago

Some initial potential candidates:

D. Search for feature catalogue/uml model item
E. Extend existing feature catalogue/uml model with the new item
F. Linking the registers/registries with the underlying UML models
G. Linking the registers/registries with the ETL based tool (eg.HALE) - validation&testing
H. Visualisation of the extensions via registers/registries [e.g. via INSPIRE Re3gistry]

 

Use Case D Search for an existing feature catalogue/uml model item
Name Search for an existing feature catalogue/uml model item
Primary Actor INSPIRE Data Provider, User
Goal

1.For Data provider: To provide unique reference and further information about existing  feature catalogue/uml model item with reusable and semanticly fitting description (feature object, attributes, association, constraint values)

2. For data user: Provides easy interface to search any INSPIRE UML model item (including federated extensions) and access detailed information.

System under consideration

1. Human grafical user interface (GUI): Registry GUI (e.g. detail of spatial object with attributes), HTML snapshots of UML model (e.g. those generated from Enterprise architects)

2. Machine readable interface: Registry service, WFS and/or predefined dataset; Registry federation, RDF

Importance high
Description A data provider wants to provide a dataset according to the INSPIRE data specifications which requires spatial object/ an attribute or association defined in extended part of the INSPIRE UML model. For that purpose the provider accesses the registry federation to discover UML model extensions (including their values) published and used by other provider before. 
Pre-Condition Registry federation is operative; National, domain specific extentions of the INSPIRE UML model have been published.
Post-Condition Relevant extensions of the INSPIRE UML model has been discovered and data provider refers to it from it's data set.

 

Use Case D - Flow of Events

Step 1

Data provider enters search request in a registry entry point  

Step 2 Search request is being distributed within the registry federation and processed
Step 3 Search results are returned to the user
Step 4 Data provider evaluates results and take decision if they fit for purpose (reuse of existing extended INSPIRE UML model item) or not (creation of new INSPIRE UML model domain/national extension item) 

 

Use Case E Extend existing feature catalogue/uml model with the new item
Name Extend existing feature catalogue/uml model with the new item
Primary Actor INSPIRE Data Provider
Goal To provide the possibility to create new INSPIRE UML model domain/national extension item based on the rules from the INSPIRE generic interoperabilty framework dossier as well as conditions of Implementing rules and guidlines.
System under consideration

* Systems for the domain/national UML models managements. (e.g. SVN, Enterprise architect)

* Systems for presenting and harvesting of the registers built on top of the underlying UML models. (e.g.Registers, Registries)

Importance high
Description

A data provider wants to provide a dataset according to the INSPIRE data specifications which requires spatial object/ an attribute or association defined in extended part of the INSPIRE UML model. As the structure of this dataset meets the possibilites and requirements fullfiling publishing via extended part of the INSPIRE UML model data publisher needs to document and publish this extension somewhere.

In order to do that, relevant part of the extension have to be documented and made available via national/domain specific register/registry dereferencable manner (in case someone else would like to re-use such extension in the future).

Pre-Condition

Registry federation is operative; There is possibility to register new INSPIRE UML model item as national or domain specific extentions of the INSPIRE UML model.

Clear rules for versioning are established.

Post-Condition Data publisher is able to publish dataset based on the INSPIRE requirements at the same time meeting INSPIRE, national/domain extension requirements/recomendations.

 

Use Case E - Flow of Events

Step 1

Data provider register new INSPIRE UML model item as national or domain specific extentions of the INSPIRE UML model.

Step 2 This extension is aproved and published respecting INSPIRE legal requirements and technical recomendations.
Step 3 Dataset is published according this INSPIRE extension.
Step 4 In case this extension is relevant also for another data publishers, they can simply refer to this extension, when publishing their dataset.

 

 

Use Case F Linking the registers/registries with the underlying UML models

Name Linking the registers/registries with the underlying UML models
Primary Actor INSPIRE Data Provider
Goal

Provide simple pipeline/methodology/tools to ensure live link between UML models and registers/registries publishing their content. In case underlying UML models are changed this change should be easily reflected into the register/s and their systems.

System under consideration

* Systems for the domain/national UML models managements. (e.g. SVN, Enterprise architect)

* Systems for presenting and harvesting of the registers built on top of the underlying UML models. (e.g.Registers, Registries)

Importance high
Description

Considering the current nature and environment where INSPIRE UML model is maintained, this should contain guidance, how to link existing national and domain exchange UML models to registers/registries as well as how to establishing the links towards INSPIRE UML model available via SVN repository in case of INSPIRE national and domain extensions.

Pre-Condition Existence of national and domain specific UML models
Post-Condition Availabiltiy of the national and domain specific UML models, or INSPIRE model extensions content via Register/s, or Registires.

 

Use Case F - Flow of Events

Step 1

Data provider would like to provide more efficient human and machine readable interface to national or domain specific UML model or extension of INSPIRE UML model.

Step 2 Data provider is following the instructions, methodology or using the tools/s allowing provision of the  national or domain specific UML model or extension of INSPIRE UML model.
Step 3 The link between the model and register/registry is established and able to reflect the changes in the UML model based on agreed versioning.

 

Remaing  will come asap.

#9 Updated by Magnus Karge over 5 years ago

Here are the use cases I discussed with some colleagues at the NMA (NB! some overlap with the input provided by Christian and Martin).

  • Populate the register initially
    • Gml dictionary, skos/rdf as input formats
    • Generate register content directly from UML information models
  • Add additional codes to existing code lists
  • Modify existing codes/mark codes as deleted (for example change status from valid to not valid at a certain point of time - a code that is not valid anymore but should be kept in the list for use in historical datasets)
  • Requests for:
    • Single code information
    • Subsets of a code list’s content (give me all codes that were valid at date x)
    • Code lists
    • Code (list) status/changelog/life cycle history
    • Free text search
  • Harvest content from other registers and extent with additional information (for example harvest EPSG codes and add information about optional/mandatory codes for national datasets)

 

Register content (besides code lists):

  • Organizations
  • Application schemas
  • Data product specifications

 

Other things mentioned during internal discussions at the NMA:

  • Which interface to use? (CSW?)
  • The TG document should give recommendations for how dynamic code lists should be referenced in static UML models

#10 Updated by Christian Ansorge over 5 years ago

Dear colleagues,

Thank you for your feedback so far.

For some of the usecases I am not sure if they are self explaining without further details. I would suggest that we use the next telconf on MIWP-6 to discuss the use cases including the feedback we got so far and decide how we take the next steps.

I can only encourage the other contributors of this task to take a look and provide us feedback. Thank you very much in advance! :-)

Cheers & Thanks

Chris

#11 Updated by Michael Lutz over 5 years ago

Thanks, Christian and all,

I think it would be easier to provide comments to the proposed use cases, if each of them were an issue (possibly a sub-issue of the original one).

I will do this for the first use case, maybe you can do it for the others as well.

Michael

#12 Updated by Christian Ansorge over 5 years ago

Done .. Please follow the created individual issues for each use case for further discussions.

Thanks for the contribution so far! :-)

 

 

#13 Updated by Michael Lutz over 5 years ago

  • Project changed from Re3gistry development & testing to MIWP-6: Registers

Also available in: Atom PDF