This page has moved, please click here to continue Reporting-Use Cases

PIMS SRS > Use Case Suite > Reporting Use Cases

Release Information

Project: PIMS
Internal Release Number: 0.1
Related Documents:

Default Aspects of All Use Cases

Direct Actors:
User: end-user in any role
System: The PIMS system being built
Admin: Web-site administrator, has authority to perform security-critical operations.
Scientist: Post-graduate or post-doctoral wet lab scientist
Senior Scientist: Post-doctoral scientist
Group leader: someone with authority to add users to a group, usually a senior scientist.
Technician: Technical staff
Experimenter: Scientist, or technician sometimes PI
PI: head of lab
When actors are not listed, assume User is doing it.
Items beginning with "see" indicate that System has presented a new screen.
Stakeholders: Project Owners and other members
Prereq: User is logged in except for UC-Log in
TIP: See detailed tips in the guidelines for writing use cases.

Use cases


Target management
UC-Add new target
UC-Edit target
UC-View target status
UC-Add details of a citation to a target
UC-Find citations relating to a target

Bioinformatics
UC-Target selection
UC-BLAST sequence
UC-Genomic DNA available
UC-cDNA available
UC-Is target registered
UC-Align sequences
UC-Predict TM helices
UC-Design primers
UC-Order primers

Sample Tracking
UC-Create sample
UC-Edit sample
UC-Track sample
UC-Sample discard
UC-Move sample
UC-Generate barcode
UC-Scan barcode
UC-View current experiment outputs
UC-View location

Reagent management
UC-Add reagent
UC-Edit reagent
UC-New container
UC-View reagents

Experiment/Protocol management
UC-Create protocol
UC-Edit protocol
UC-View protocol
UC-New experiment
UC-Update experiment
UC-Add next experiment
UC-Remove experiment
UC-Create screening solutions
UC-New crystalization plate
UC-View experiment
UC-New multi-well experiment
UC-Screen conditions

Project management
UC-Create project
UC-Add target to project
UC-Add user to project

Logging in and out
UC-Log in
UC-Log out

User account management
UC-Reg new user
UC-New passwd
UC-Edit profile
UC-View profile

Data Access Rights management
UC-new-owner
UC-new-group
UC-add-user
UC-remove-user
UC-add-permission
UC-remove-permission
UC-add-create
UC-remove-create
UC-new-condition
UC-set-condition

Reporting
UC-Print protocol
UC-Print experiment
UC-Audit trail

Interfacing to laboratory instruments
UC-Robot-input
UC-Robot-input-series
UC-Robot-control
UC-Robot-generate
UC-Robot-convert

Data mining and visualisation
UC-Search PIMS

Installation and upgrading
UC-Config site
UC-Submit form

Mobile data collection


Workflow tools


Scheduling

UC-Print protocol: Print a copy of a protocol

Summary: An experimenter may wish to print a copy of a protocol.
Importance: Desired
Priority: Desired
Use Frequency: Sometimes
Direct Actors: Experimenter
Prereq:
User must belong to a user group with appropriate access rights
Main Success Scenario:
  1. perform UC-View protocol View a protocol steps 1-3
  2. click to "print"
  3. see protocol reformatted for printing
  4. click to confirm
  5. system instructs printer to print document
Notes and Questions
  • the format of the printed protocol will need to be meaningful to an experimenter, may require examples to serve as templates

UC-Print experiment: Print the details of an experiment

Summary: An experimenter may wish to print selected experiment details. This may be for publication or reporting purposes
Importance: Desired
Priority: Desired
Use Frequency: Sometimes
Direct Actors: Experimenter
Prereq:
User must belong to a user group with appropriate access rights
Main Success Scenario:
  1. perform UC-View experiment: View the details of an experiment steps 1-3
  2. select details to print and click to continue
  3. see experiment details reformatted for printing
  4. click to confirm
  5. system instructs printer to print document
Notes and Questions
  • the format of the printed experiment will need to be meaningful to an experimenter

UC-Audit trail: Generate a sample audit trail

Summary: An experimenter may wish produce an audit trail for a particular sample in PIMS. This might be to keep track of reagent use.
The trail should include user-selectable details such as "the sequence log of activity, various actions taken, the researcher names, time and date and approval or rejection of data"
Importance: Expected
Priority: Expected
Use Frequency: Sometimes
Direct Actors: Experimenter
Prereq:
User must belong to a user group with appropriate access rights
Main Success Scenario:
  1. visit "SAMPLE" page
  2. click to select sample to "trail"
  3. see "sample's" view page
  4. select fields to trail and click to create report
  5. see "sample's" audit trail
Alternative 3a
Scenario Extensions:
    Wrong sample selected
    1. see "wrong"sample's view page
    2. perform UC-Audit trail: Generate a sample audit trail steps 2-5
Alternative 1a
Scenario Extensions:
    Sample has a barcode
    1. perform UC-Scan barcode: Scan a barcode steps 2-4 to identify reagent with its barcode
Notes and Questions
  • how will the report be formatted?
  • save report and/or print options
  • this should be a more detailed version of UC-Track sample
  • can an audit trail be generated for a container such as a 96-well plate?

UC-name: USE CASE NAME

Summary: 1-3 SENTENCES
Importance: Essential | Expected | Desired | Optional
Priority: Essential | Expected | Desired | Optional
Use Frequency: Always | Often | Sometimes | Rarely | Once
Direct Actors: ACTOR1, ACTOR2, ACTOR3
Prereq:
PRECONDITION
Main Success Scenario:
  1. STEP
  2. STEP
  3. STEP
Alternative "index"
Scenario Extensions:
    BRANCH CONDITION
    1. ALTERNATIVE STEP
    2. ALTERNATIVE STEP
    3. ALTERNATIVE STEP
Variations
TODO: Check for words of wisdom and discuss ways to improve this template.
Company Proprietary
Copyright © 2003-2004 Jason Robbins. All rights reserved. License terms. Retain this copyright statement whenever this file is used as a template.