Example Implementation Template

 The following is a template for the creation of an example implementation. Each use case step can be linked to one or more example implementations. A particular example implementation may be used to address multiple use case steps if the processes are generalized sufficiently.

Use Case Step

<Provide the name and link to the Use Case Step that this example covers>

 

Preconditions

(list of conditions that MUST be met in order to be able to successfully execute this process)

 

 

Data inputs

 

 

Actors

(the people, organization, computer systems - hardware and software, and building blocks that participate in the activity)

 

 

Normal Course (what happens if the event is triggered and the preconditions have been met)

Provide a step-by-step description of the normal flow of this implementation:

  1. Description of the first thing that happens, including information on data that is entered and/or returned by different actors in the system

    1. Link to Cucumber test file (or embedded cucumber test) that describes the interaction

    2. List of APIs that are needed from each BB and link to the API documentation

    3. List of any data structures that are needed and link to the data structures documentation

  2. Description of the second thing that happens, including information on data that is entered and/or returned by different actors in the system

    1. Link to Cucumber test file (or embedded cucumber test) that describes the interaction

    2. List of APIs that are needed from each BB and link to the API documentation

    3. List of any data structures that are needed and link to the data structures documentation

 

Alternative Course

(links to other use cases in case there are different ways how to solve the same use case)

Description of alternate paths or flows that may be needed for this example implementation. These alternates should include links to test files, APIs, and data structures as well

 

Data output

 

 

Post-Conditions (the success criteria)

 

 

Exceptions

(error situations)

List of error conditions that may be encountered during the normal or alternative flows. Each error condition should provide information on what data will be returned and guidance on how error conditions should be handled by various actors.

 

Related BBs

(working groups related to this implementation example)

Identity BB

Consent BB

Registration BB

Digital Registries BB

Payment BB

 

Sequence Diagram

 

Links to Code

Provide any links to relevant code that has been developed for automated tests or example implementations