NIH | National Cancer Institute | NCI Wiki  

Contents of this Page

Init1pm11.1 - Import Analysis Model

Use Case Number

Init1pm11.1

Brief Description

The first step in working with a DAM is to import the DAM into your modeling tool so that you can further refine it for your specific needs.

Actor(s) for this particular use case

Information Modeler

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

DAM is registered in a metadata repository

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

The DAM is available within the Information Modeler's UML modeling tool and represented by classes, attributes, and associations.  T

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. Information Modeler opens modeling tool
  2. Information Modeler searches metadata repository for the desired DAM
  3. Information Modeler imports the DAM into his modeling tool

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

An alternate flow to this use case is that the Information Modeler imports the DAM from another information model (which may be refined rather than the vanilla DAM).  Therefore, it may be desirable for Information Modelers to register refined DAMs themselves to be shared with others.

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

High

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.

Init1pm11 - LS DAM refinement and utilization

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

The Information Modeler must be able to import a DAM into his UML modeling tool, it must be represented fully (so that it can be refined), and it must be able to be derived into an implementation model.

Init1pm11.2 - Refine Analysis Model

Use Case Number

Init1pm11.2

Brief Description

The second step in working with a DAM is to refine it by identifying those classes, attributes, and associations that will not be reused.  These should be marked up in the UML in some fashion as to indicate that they are not included in the information model.

Actor(s) for this particular use case

Information Modeler

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

The DAM has been imported in the model (see use Init1pm11.1 above)

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

The DAM has been refined within the Information Modeler's information model (in UML).

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 Information Modeler refines enumerations
    1. The Information Modeler specifies which enumerations are omitted
    2. The Information Modeler specifies which enumerated values are omitted
  2. The Information Modeler refines classes
    1. The Information Modeler specifies which attributes are omitted
    2. The Information Modeler specifies which classes are omitted
  3. The Information Modeler refines associations
    1. The Information Modeler specifies which associations are omitted
  4. The Information Modeler annotates any special considerations, rules, mappings, etc.

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

The steps above do not preclude the creation of ECCF documents or other mappings/specification documents.  However, this use case does ease the creation of such documents because the DAM is derived directly from the metadata repository (meaning it has the appropriate level of specification/documentation already) and the refinements are made in conformance with the metadata repository conventions.

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

High

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.

Init1pm11 - LS DAM refinement and utilization


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

The DAM should be localized using the conventions of the UML modeling tool.  That is, it is highly desirable that user actions be constrained by what will be conformant when the DAM is registered and shared, as well as when the DAM is used to create an implementation model.

Init1pm11.3 - Derive Implementation Model

Use Case Number

Init1pm11.3

Brief Description

The third step in working with a DAM is to derive an implementation model based upon the DAM.  The Information Modeler imports the refined DAM into his implementation model package and adds the necessary specificity such that it can be implemented.

Actor(s) for this particular use case

Information Modeler

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

The DAM has been refined in the Information Modelers UML modeling tool using the necessary metadata repository conventions.

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

An implementation model is created that has the necessary information for semantic annotation and registration, as well as the necessary information for generating a DAM mapping document.

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 Information Modeler imports the refined DAM into his  implementation space/package.
  2. The Information Modeler refines the imported entities
    1. The Information Modeler modifies the names of classes, attributes, and association endpoints
    2. The Information Modeler updates the multiplicities of associations
    3. The Information Modeler updates the datatype of each attribute
    4. The Information Modeler updates enumerations
  3. The Information Modeler adds additional modeling entities, including classes, attributes, associations, and enumerations

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

The Information Modeler updates an existing implementation model that has previously been derived from a DAM.

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

High

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.

Init1pm11 - LS DAM refinement and utilization

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

  1. The resulting implementation model has necessary annotations to generate a mapping document that includes modifications to derived DAM entities and additional model entities

Init1pm11.4 - Generate Mapping Document

Use Case Number

Init1pm11.4

Brief Description

The next step in the DAM process is to create a document that describes the changes and additions to the DAM.  This includes name changes, excluded classes/attributes, and added classes/attributes.

Actor(s) for this particular use case

Information Modeler

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

A DAM-derived implementation model exists in the Information Modeler's UML modeling tool with all required annotations to generate a mapping document.

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

A mapping document is generated.

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

  • The Information Modeler selects the implementation model and DAM
  • The Information Modeler performs the steps directly from his UML modeling tool to generate a mapping document

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

High

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.

Init1pm11 - LS DAM refinement and utilization

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

None.

Init1pm11.5 - Register DAM-derived Implementation Model

Use Case Number

Init1pm11.5

Brief Description

The final step in the DAM process is to register a DAM-derived implementation model.  This use case is important because it is important to share in the metadata repository the relationship of the implementation model to the original DAM, and, if possible, to the derived DAM.

Actor(s) for this particular use case

Information Modeler

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

A refined DAM and completed DAM-derived implementation model exists in the Information Modelers UML tool.

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

The refined DAM and implementation model are registered in the metadata repository.

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 Information Modeler selects the refined DAM and completes the steps necessary to register it in the metadata repository.
  2. The Information Modeler selects the implementation model and completes the steps necessary to register it in the metadata repository.

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

High

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.

Init1pm11 - LS DAM refinement and utilization

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

The relationships between the original DAM, the derived DAM, and the implementation model are captured in the metadata repository.


  • No labels