NIH | National Cancer Institute | NCI Wiki  

Contents of this Page

Link dataset fields to CDEs

Use Case Number

Init1pm24.pm15.1

Brief Description

From caIntegrator, the user should be able to query the metadata repository to link dataset fields to CDEs.  The data element description should be able to be imported, as well as unique identifiers/links to the CDE.  It would be convenient if caIntegrator could query the metadata registry to all possible matches to all dataset fields and present them in batch to the user.

Actor(s) for this particular use case

Metadata Specialist.

Pre-condition
The state of the system before the user interacts with it

A dataset has been created in caIntegrator.

Post condition
The state of the system after the user interacts with it

All semantically equivalent CDE's have been mapped.

Steps to take
The step-by-step description of how users will interact with the system to achieve a specific business goal or function

  1. The Metadata Specialist selects the dataset to link CDEs for
  2. caIntegrator queries the metadata repository based on the annotated description of each field in the dataset
  3. For each field that matches a semantically equivalent CDE (as determined by manual inspection by the Metadata Specialist) the Metadata Specialist selects the CDE.
  4. The CDE information (annotation) and unique identifier/link is imported into caIntegrator
  5. The Metadata Specialist completes the import

Alternate Flow
Things which would prevent the normal flow of the use case

It is possible this flow is repeated later when new CDEs may be available for linking.

Priority
The priority of implementing the use case: High, Medium or Low

Medium.

Associated Links
The brief user stories, each describing the user interacts with the system for the one function only of the use case. There would potentially be a number of user stories that make up the use case.

Fit criterion/Acceptance Criterion 
How would actor describe the acceptable usage scenarios for the software or service that meets the actor's requirement?

Further analysis may be needed to determine how a CDE is searched for.

Export annotations for loading

Use Case Number

Init1pm24.pm15.2

Brief Description

For those dataset fields that do not semantically match a CDE in the metadata repository, the user can export a file that has the field annotations that can be used to create new CDEs.  Furthermore, it may be possible for the user to export a full XMI (or other file) that describes the dataset in an object-oriented way.

Actor(s) for this particular use case

Metadata Specialist

Pre-condition
The state of the system before the user interacts with it

A dataset has been created in caIntegrator and an attempt has been made to match CDEs (see above).

Post condition
The state of the system after the user interacts with it

A file describing the dataset fields is created.

Steps to take
The step-by-step description of how users will interact with the system to achieve a specific business goal or function

  1. The Metadata Specialist selects the dataset fields to export
  2. The Metadata Specialist exports the fields to a standards-based file
  3. The file can be used for created new CDEs

Alternate Flow
Things which would prevent the normal flow of the use case

None.

Priority
The priority of implementing the use case: High, Medium or Low

Low.

Associated Links
The brief user stories, each describing the user interacts with the system for the one function only of the use case. There would potentially be a number of user stories that make up the use case.

Fit criterion/Acceptance Criterion 
How would actor describe the acceptable usage scenarios for the software or service that meets the actor's requirement? 

The resulting file should be standards-based and reusable by the metadata repository in a loading scenario.


  • No labels