Changeset 10738 for main


Ignore:
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:
1 edited

Legend:

Unmodified
Added
Removed
  • main/eko-disco-specs/trunk/data.rst

    r10737 r10738  
    6666one).
    6767
    68 Connected to: :ref:`label-contact-data` (|n0|:1)
     68Connected to: :ref:`label-contact-data` (|n0|:1),
     69:ref:`label-timestamp` (1:|m0|).
    6970
    7071Used in the following use cases:
     
    128129--------
    129130
    130 Beneficiary of a contract
     131Beneficiary of one or more :ref:`label-contract`\ s.
     132
     133Customers are added to the system by initial import (migration phase),
     134being created by staff or can self-register themselves to the system.
     135
     136Customers have to provide :ref:`label-contact-data` and get
     137:ref:`label-login-credentials` to login to the system.
     138
     139Once logged in, customers get a 'My Eko-Disco' page where they can
     140
     141- see their current orders
     142
     143- watch their consumption
     144
     145- order more services
     146
     147- handle contractual problems
     148
     149- get help if problems arise
     150
     151- retrieve bills.
     152
     153- reset their passwords if forgotten.
     154
     155Customers can order :ref:`label-service`\ s and pay these (kinds of
     156payment depend on the type of service/good ordered and the available
     157payment methods).
     158
     159Customers and their data can be managed by customers themselves (for
     160instance when postal addresses change), and by staff members.
     161
     162Connected to: :ref:`label-contract` (1:|n0|),
     163:ref:`label-contact-data` (1:1), :ref:`label-login-credentials` (1:1).
     164
     165
     166.. _label-location:
     167
     168Location
     169--------
     170
     171A real-world location. Used for instance for meters to store
     172information about their place. Different to
     173:ref:`label-contact-address`\ es, locations can also be less formal,
     174for instance describing a location in words.
     175
     176Connected to: :ref:`label-meter` (1:1)
    131177
    132178
     
    136182-----------------
    137183
     184A set of username/password assigned to system users. Passwords are
     185stored inside the system using strong cryptographic hash functions.
     186
     187Passwords can be reset on request.
     188
     189Connected to: :ref:`label-customer`
     190
    138191
    139192.. _label-meter:
     
    142195-----
    143196
    144 
    145 .. _label-meter-status:
    146 
    147 Meter Status
    148 ------------
     197A meter measures power consumption. It has a place where it is
     198installed and might be connected to one or several contracts. For a
     199given time a meter can be connected to one or zero contracts.
     200
     201Each meter has to provide a :ref:`label-location` that tells, where it
     202is installed.
     203
     204Meters also contain a history of meter values
     205(:ref:`label-meter-value`), which is basically a list of meter values
     206at a given time.
     207
     208Connected to: :ref:`label-contract` (|n0|:\ |m0|),
     209:ref:`label-meter-value` (1:|m0|), :ref:`label-location` (1:n)
    149210
    150211
     
    154215-----------
    155216
    156 
    157 .. _label-meter-reader:
    158 
    159 Meter Reader
    160 ------------
    161 
    162 
    163 .. _label-point-of-consumption:
    164 
    165 Point of Consumption
    166 --------------------
     217The value of a :ref:`label-meter` at a certain point in time
     218(providing a :ref:`label-timestamp`) authorized by some
     219:ref:`label-user` or device.
     220
     221It serves mainly for computing power consumption of
     222:ref:`label-customer`\ s.
     223
     224When a new meter value is added to the system (the respective
     225:ref:`label-meter` is 'updated'), the system also registers how the
     226the new value was entered, i.e. by whom and when.
     227
     228The system will be prepared to collect meter values in two ways:
     229
     230a) (push-method): by being fed with respective data by authorized
     231   users (staff members)
     232
     233b) (pull-method): by polling dedicated hardware that provides the
     234   neccessary interface (automatic remote-reading).
     235
     236The second choice requires appropriate hardware to be in place, which
     237in detail is not part of this specs. The system will, however, be
     238prepared to collect meter data from external devices.
     239
     240Connected to: :ref:`label-meter` (|n0|:1), :ref:`label-timestamp` (1:1),
     241:ref:`label-user`.
    167242
    168243
     
    171246Report
    172247------
     248
     249Administrative report or list to give overviews over current state of
     250business. Includes lists of customers sorted by various categories
     251(type of contract, amount of fees paid, etc.), lists of services
     252sorted by various categories, etc.
     253
     254Reports are generated as PDF documents and are available for download
     255by authorized :ref:`label-user`\ s.
     256
     257Connected to: (almost everything else)
    173258
    174259
     
    194279
    195280
    196 
    197281.. _label-timestamp:
    198282
    199283Timestamp
    200284---------
     285
     286A timestamp can be a calendar date or a calendar date plus some day
     287time.
     288
     289The system will internally use UTC-based timestamps only to minimize
     290ambiguities. In menus, frontends, etc. timestamps are displayed in
     291local Lagos time.
     292
     293Connected to: :ref:`label-meter-value` (1:1),
     294:ref:`label-contact-email` (1:1)
    201295
    202296
     
    222316
    223317
     318.. _label-user:
     319
     320User
     321----
     322
     323A system user.
     324
     325Users can have :ref:`label-user-role`\ s managed by the
     326system. Real-world staff members and customers are different to the
     327system as they will have different roles. Also anonymous users are
     328accepted by the system to provide marketing pages, service offers,
     329etc.
     330
     331Each user has one set of :ref:`label-login-credentials` to authenticate
     332against the system.
     333
     334Users can be blocked or removed from the system.
     335
     336Connected to: :ref:`label-login-credentials`.
     337
     338
     339.. _label-user-role:
     340
     341User Role
     342---------
     343
     344A role assigned to a group of :ref:`label-user`\ s.
     345
     346Connected to: :ref:`label-user` (1:|n0|).
     347
     348
    224349.. [#] Relation types: (1:1): One-to-one, (1:n): One-to-many, (n:1):
    225350       many-to-one, (n:m): many-to-many. ``n`` and ``m`` mean some
Note: See TracChangeset for help on using the changeset viewer.