Changeset 10738 for main/eko-disco-specs/trunk/data.rst

Timestamp:

11 Nov 2013, 17:49:19 (11 years ago)

Author:

uli

Message:

Fill at least some text into empty data items, remove some which might not be needed.

File:

• main/eko-disco-specs/trunk/data.rst (modified) (8 diffs)

main/eko-disco-specs/trunk/data.rst

@@ -66 +66 @@
 one).
 
-Connected to: :ref:`label-contact-data` (|n0|:1)
+Connected to: :ref:`label-contact-data` (|n0|:1),
+:ref:`label-timestamp` (1:|m0|).
 
 Used in the following use cases:
@@ -128 +129 @@
 --------
 
-Beneficiary of a contract
+Beneficiary of one or more :ref:`label-contract`\ s.
+
+Customers are added to the system by initial import (migration phase),
+being created by staff or can self-register themselves to the system.
+
+Customers have to provide :ref:`label-contact-data` and get
+:ref:`label-login-credentials` to login to the system.
+
+Once logged in, customers get a 'My Eko-Disco' page where they can
+
+- see their current orders
+
+- watch their consumption
+
+- order more services
+
+- handle contractual problems
+
+- get help if problems arise
+
+- retrieve bills.
+
+- reset their passwords if forgotten.
+
+Customers can order :ref:`label-service`\ s and pay these (kinds of
+payment depend on the type of service/good ordered and the available
+payment methods).
+
+Customers and their data can be managed by customers themselves (for
+instance when postal addresses change), and by staff members.
+
+Connected to: :ref:`label-contract` (1:|n0|),
+:ref:`label-contact-data` (1:1), :ref:`label-login-credentials` (1:1).
+
+
+.. _label-location:
+
+Location
+--------
+
+A real-world location. Used for instance for meters to store
+information about their place. Different to
+:ref:`label-contact-address`\ es, locations can also be less formal,
+for instance describing a location in words.
+
+Connected to: :ref:`label-meter` (1:1)
 
 
@@ -136 +182 @@
 -----------------
 
+A set of username/password assigned to system users. Passwords are
+stored inside the system using strong cryptographic hash functions.
+
+Passwords can be reset on request.
+
+Connected to: :ref:`label-customer`
+
 
 .. _label-meter:
@@ -142 +195 @@
 -----
 
-
-.. _label-meter-status:
-
-Meter Status
-------------
+A meter measures power consumption. It has a place where it is
+installed and might be connected to one or several contracts. For a
+given time a meter can be connected to one or zero contracts.
+
+Each meter has to provide a :ref:`label-location` that tells, where it
+is installed.
+
+Meters also contain a history of meter values
+(:ref:`label-meter-value`), which is basically a list of meter values
+at a given time.
+
+Connected to: :ref:`label-contract` (|n0|:\ |m0|),
+:ref:`label-meter-value` (1:|m0|), :ref:`label-location` (1:n)
 
 
@@ -154 +215 @@
 -----------
 
-
-.. _label-meter-reader:
-
-Meter Reader
-------------
-
-
-.. _label-point-of-consumption:
-
-Point of Consumption
---------------------
+The value of a :ref:`label-meter` at a certain point in time
+(providing a :ref:`label-timestamp`) authorized by some
+:ref:`label-user` or device.
+
+It serves mainly for computing power consumption of
+:ref:`label-customer`\ s.
+
+When a new meter value is added to the system (the respective
+:ref:`label-meter` is 'updated'), the system also registers how the
+the new value was entered, i.e. by whom and when.
+
+The system will be prepared to collect meter values in two ways:
+
+a) (push-method): by being fed with respective data by authorized
+   users (staff members)
+
+b) (pull-method): by polling dedicated hardware that provides the
+   neccessary interface (automatic remote-reading).
+
+The second choice requires appropriate hardware to be in place, which
+in detail is not part of this specs. The system will, however, be
+prepared to collect meter data from external devices.
+
+Connected to: :ref:`label-meter` (|n0|:1), :ref:`label-timestamp` (1:1),
+:ref:`label-user`.
 
 
@@ -171 +246 @@
 Report
 ------
+
+Administrative report or list to give overviews over current state of
+business. Includes lists of customers sorted by various categories
+(type of contract, amount of fees paid, etc.), lists of services
+sorted by various categories, etc.
+
+Reports are generated as PDF documents and are available for download
+by authorized :ref:`label-user`\ s.
+
+Connected to: (almost everything else)
 
 
@@ -194 +279 @@
 
 
-
 .. _label-timestamp:
 
 Timestamp
 ---------
+
+A timestamp can be a calendar date or a calendar date plus some day
+time.
+
+The system will internally use UTC-based timestamps only to minimize
+ambiguities. In menus, frontends, etc. timestamps are displayed in
+local Lagos time.
+
+Connected to: :ref:`label-meter-value` (1:1),
+:ref:`label-contact-email` (1:1)
 
 
@@ -222 +316 @@
 
 
+.. _label-user:
+
+User
+----
+
+A system user.
+
+Users can have :ref:`label-user-role`\ s managed by the
+system. Real-world staff members and customers are different to the
+system as they will have different roles. Also anonymous users are
+accepted by the system to provide marketing pages, service offers,
+etc.
+
+Each user has one set of :ref:`label-login-credentials` to authenticate
+against the system.
+
+Users can be blocked or removed from the system.
+
+Connected to: :ref:`label-login-credentials`.
+
+
+.. _label-user-role:
+
+User Role
+---------
+
+A role assigned to a group of :ref:`label-user`\ s.
+
+Connected to: :ref:`label-user` (1:|n0|).
+
+
 .. [#] Relation types: (1:1): One-to-one, (1:n): One-to-many, (n:1):
        many-to-one, (n:m): many-to-many. ``n`` and ``m`` mean some