| 1 | Use Case: Reading a Meter |
|---|
| 2 | *********************************************************************** |
|---|
| 3 | |
|---|
| 4 | .. Description of a use case |
|---|
| 5 | .. The description must be formulated as seen from system (not: actors) |
|---|
| 6 | .. Describes those changes an (outside) actor can notice |
|---|
| 7 | .. Short and abstract as possible, as long as necessary. |
|---|
| 8 | .. Each use case must have at least one actor involved |
|---|
| 9 | .. Each use case must have a trigger and a result |
|---|
| 10 | |
|---|
| 11 | |
|---|
| 12 | Short Description |
|---|
| 13 | ----------------------------------------------------------------------- |
|---|
| 14 | |
|---|
| 15 | A meter is read and the read values are stored in system. |
|---|
| 16 | |
|---|
| 17 | |
|---|
| 18 | Actor(s) |
|---|
| 19 | ----------------------------------------------------------------------- |
|---|
| 20 | |
|---|
| 21 | meter reader, web portal |
|---|
| 22 | |
|---|
| 23 | |
|---|
| 24 | Trigger(s) |
|---|
| 25 | ----------------------------------------------------------------------- |
|---|
| 26 | |
|---|
| 27 | a read-meter form is requested from portal |
|---|
| 28 | |
|---|
| 29 | |
|---|
| 30 | Result(s) |
|---|
| 31 | ----------------------------------------------------------------------- |
|---|
| 32 | |
|---|
| 33 | The new meter values are stored in database. |
|---|
| 34 | |
|---|
| 35 | |
|---|
| 36 | Incoming Data |
|---|
| 37 | ----------------------------------------------------------------------- |
|---|
| 38 | |
|---|
| 39 | username, password, meter id, amount, datetime of reading |
|---|
| 40 | |
|---|
| 41 | |
|---|
| 42 | Outgoing Data |
|---|
| 43 | ----------------------------------------------------------------------- |
|---|
| 44 | |
|---|
| 45 | login form, meter form, success message |
|---|
| 46 | |
|---|
| 47 | |
|---|
| 48 | Precondition(s) |
|---|
| 49 | ----------------------------------------------------------------------- |
|---|
| 50 | |
|---|
| 51 | The system is running |
|---|
| 52 | |
|---|
| 53 | |
|---|
| 54 | Postcondition(s) |
|---|
| 55 | ----------------------------------------------------------------------- |
|---|
| 56 | |
|---|
| 57 | The system is running |
|---|
| 58 | |
|---|
| 59 | |
|---|
| 60 | Invariant(s) |
|---|
| 61 | ----------------------------------------------------------------------- |
|---|
| 62 | |
|---|
| 63 | |
|---|
| 64 | |
|---|
| 65 | |
|---|
| 66 | Essential Steps |
|---|
| 67 | ----------------------------------------------------------------------- |
|---|
| 68 | |
|---|
| 69 | * authenticate meter reader |
|---|
| 70 | * get meter id, meter value, datetime |
|---|
| 71 | * check input values: |
|---|
| 72 | |
|---|
| 73 | * does the meter id exist? |
|---|
| 74 | * if not, ask and add a new one |
|---|
| 75 | * value >= old value? |
|---|
| 76 | |
|---|
| 77 | * add new reading in database |
|---|
| 78 | * output success message |
|---|
| 79 | |
|---|
| 80 | |
|---|
| 81 | Open Issues |
|---|
| 82 | ----------------------------------------------------------------------- |
|---|
| 83 | |
|---|
| 84 | Meter data input can also be performed by some automatic system: |
|---|
| 85 | |
|---|
| 86 | - automatic meters send their data automatically (how does these |
|---|
| 87 | data look like and where is it stored?) |
|---|
| 88 | |
|---|
| 89 | - a smartphone/tablet app might deliver the data by photograph/OCR |
|---|
| 90 | |
|---|
| 91 | These input devices need an API to deliver data or they require some |
|---|
| 92 | API to be able to input data into the system. |
|---|
| 93 | |
|---|
| 94 | |
|---|
| 95 | Change Log |
|---|
| 96 | ----------------------------------------------------------------------- |
|---|
| 97 | |
|---|
| 98 | +------------+----------+------------+--------------------------------+ |
|---|
| 99 | | Timestamp | Who | New Status | What | |
|---|
| 100 | +------------+----------+------------+--------------------------------+ |
|---|
| 101 | | 2013-09-04 | uli | init | initial specs | |
|---|
| 102 | +------------+----------+------------+--------------------------------+ |
|---|
| 103 | |
|---|
| 104 | |
|---|
| 105 | Remarks |
|---|
| 106 | ----------------------------------------------------------------------- |
|---|
| 107 | |
|---|
| 108 | |
|---|
| 109 | .. raw:: latex |
|---|
| 110 | |
|---|
| 111 | \pagebreak[2] |
|---|
