| 1 | .. _label-data-entities: |
|---|
| 2 | |
|---|
| 3 | Data Entities |
|---|
| 4 | ============= |
|---|
| 5 | |
|---|
| 6 | These are the data entities the new system is supposed to model. Each |
|---|
| 7 | of these entities should be addable, editable, and removable as |
|---|
| 8 | covered in more detail in :ref:`label-use-cases`. |
|---|
| 9 | |
|---|
| 10 | For each entity we give a short description to tell what it means, |
|---|
| 11 | what its purpose is and in what regards (and how) it should be handled |
|---|
| 12 | by the system. Again the more detailed actions on these entities |
|---|
| 13 | provided by the system are described in the :ref:`label-use-cases` |
|---|
| 14 | section. |
|---|
| 15 | |
|---|
| 16 | The data entities are sorted alphabetically, not by importance or |
|---|
| 17 | similar. Used description terms should link to other respective |
|---|
| 18 | entities/terms where possible. |
|---|
| 19 | |
|---|
| 20 | Each data entitiy description provides a list of use cases and other |
|---|
| 21 | data entities connected. Connections to other data entities contain a |
|---|
| 22 | relationship telling how many instances of the described entity are |
|---|
| 23 | connected to how many instances of the related entity [#]_. |
|---|
| 24 | |
|---|
| 25 | .. _label-account: |
|---|
| 26 | |
|---|
| 27 | Account |
|---|
| 28 | ------- |
|---|
| 29 | |
|---|
| 30 | A customer account contains the assets/debts of a :ref:`customer |
|---|
| 31 | <label-customer>`. It is *not* a system account (see |
|---|
| 32 | :ref:`label-login-credentials` for that) but a virtual financial |
|---|
| 33 | account kept by the system. Basically it tells, how much money a |
|---|
| 34 | certain :ref:`customer <label-customer>` owes or is eligible for. Each |
|---|
| 35 | account is connected to exactly one customer. |
|---|
| 36 | |
|---|
| 37 | Connected to: :ref:`label-customer` (1:1), :ref:`label-payment` (1:n), |
|---|
| 38 | :ref:`label-consumption` (1:n) |
|---|
| 39 | |
|---|
| 40 | Used in the following use cases: :ref:`label-uc-account-add` |
|---|
| 41 | |
|---|
| 42 | |
|---|
| 43 | .. _label-contact-address: |
|---|
| 44 | |
|---|
| 45 | Contact Address |
|---|
| 46 | --------------- |
|---|
| 47 | |
|---|
| 48 | A postal address. |
|---|
| 49 | |
|---|
| 50 | Connected to: :ref:`label-contact-data` (n:1) |
|---|
| 51 | |
|---|
| 52 | Used in the following use cases: |
|---|
| 53 | |
|---|
| 54 | |
|---|
| 55 | .. _label-contact-data: |
|---|
| 56 | |
|---|
| 57 | Contact Data |
|---|
| 58 | ------------ |
|---|
| 59 | |
|---|
| 60 | The data neccessary to contact some customer, staff person or similar |
|---|
| 61 | entity. Contact data might contain several addresses, phone numbers, |
|---|
| 62 | emails, etc. |
|---|
| 63 | |
|---|
| 64 | Connected to: :ref:`label-customer` (1:1), |
|---|
| 65 | :ref:`label-contact-address` (n:1) |
|---|
| 66 | |
|---|
| 67 | Used in the following use cases: |
|---|
| 68 | |
|---|
| 69 | |
|---|
| 70 | .. _label-contract: |
|---|
| 71 | |
|---|
| 72 | Contract |
|---|
| 73 | -------- |
|---|
| 74 | |
|---|
| 75 | .. _label-contract-types: |
|---|
| 76 | |
|---|
| 77 | Contract Types |
|---|
| 78 | -------------- |
|---|
| 79 | |
|---|
| 80 | .. _label-contract-termination: |
|---|
| 81 | |
|---|
| 82 | Contract Termination |
|---|
| 83 | -------------------- |
|---|
| 84 | |
|---|
| 85 | .. _label-consumption: |
|---|
| 86 | |
|---|
| 87 | Consumption |
|---|
| 88 | ----------- |
|---|
| 89 | |
|---|
| 90 | .. _label-customer: |
|---|
| 91 | |
|---|
| 92 | Customer |
|---|
| 93 | -------- |
|---|
| 94 | |
|---|
| 95 | Beneficiary of a contract |
|---|
| 96 | |
|---|
| 97 | .. _label-login-credentials: |
|---|
| 98 | |
|---|
| 99 | Login Credentials |
|---|
| 100 | ----------------- |
|---|
| 101 | |
|---|
| 102 | .. _label-meter: |
|---|
| 103 | |
|---|
| 104 | Meter |
|---|
| 105 | ----- |
|---|
| 106 | |
|---|
| 107 | .. _label-meter-status: |
|---|
| 108 | |
|---|
| 109 | Meter Status |
|---|
| 110 | ------------ |
|---|
| 111 | |
|---|
| 112 | .. _label-meter-value: |
|---|
| 113 | |
|---|
| 114 | Meter Value |
|---|
| 115 | ----------- |
|---|
| 116 | |
|---|
| 117 | .. _label-meter-reader: |
|---|
| 118 | |
|---|
| 119 | Meter Reader |
|---|
| 120 | ------------ |
|---|
| 121 | |
|---|
| 122 | .. _label-payment: |
|---|
| 123 | |
|---|
| 124 | Payment |
|---|
| 125 | ------- |
|---|
| 126 | |
|---|
| 127 | .. _label-point-of-consumption: |
|---|
| 128 | |
|---|
| 129 | Point of Consumption |
|---|
| 130 | -------------------- |
|---|
| 131 | |
|---|
| 132 | .. _label-report: |
|---|
| 133 | |
|---|
| 134 | Report |
|---|
| 135 | ------ |
|---|
| 136 | |
|---|
| 137 | .. _label-timestamp: |
|---|
| 138 | |
|---|
| 139 | Timestamp |
|---|
| 140 | --------- |
|---|
| 141 | |
|---|
| 142 | .. [#] Relation types: (1:1): One-to-one, (1:n): One-to-many, (n:1): |
|---|
| 143 | many-to-one, (n:m): many-to-many. |
|---|
