Changeset 1933 for trunk

Timestamp:

01/17/17 13:27:52 (7 years ago)

Author:

nanardon

Message:

Add documentation about statistics

Location:

trunk/LATMOS-Accounts

Files:

• lib/LATMOS/Accounts/Bases/Sql/Stat.pm (modified) (1 diff)
• man/man8/latmos-accounts-base-sql.pod (modified) (1 diff)

trunk/LATMOS-Accounts/lib/LATMOS/Accounts/Bases/Sql/Stat.pm

@@ -32 +32 @@
     $class->SUPER::_get_attr_schema($base,
         {
-            name   => { ro => 1, inline => 1, },
             cn     => { ro => 1, inline => 1, iname => 'name' },
-            date   => { ro => 1, inline => 1, },
-            create => { ro => 1, inline => 1, },
+            description => { },
+            otype  => { },
             filter => { multiple => 1 },
+            attribute => { },
             refFilter => { multiple => 1 },
             refall => { },
-            otype  => { },
-            attribute => { },
-            description => { },
-            delay => { },
-            lastStatId => { },
+            nullValue => { },
             aggregateFunction => {
                 can_values => sub { qw(sum avg count) },
             },
-            nullValue => { },
             display => { },
+            delay => { },
+            lastStatId => { },
             needRun => {
                 ro => 1,

trunk/LATMOS-Accounts/man/man8/latmos-accounts-base-sql.pod

@@ -259 +259 @@
 The C<forward> attributes is automatically set with email address of selected
 user, user w/o email address are ignored.
+
+=head2 Statistics
+
+The application provide some statitics tools but they are only based on the
+current data inside the database and are unable to track delete data.
+
+To keep some mesurement you must use C<stat> objects to describe the data you
+want to track, and enable in L<la-sync-manager.ini> the C<Stats> module.
+
+Each attribute of C<Stat> object describe how data must but compute before being
+stored.
+
+=head3 Stat object Attributes
+
+=head4 description
+
+A label about this statistics object
+
+=head4 display
+
+IF set the statistic appear in the menu of the web interface
+
+=head4 otype
+
+The object type this stat is tracking, must be a supported object type
+
+=head4 filter
+
+One or multiple filter to limit the objects taking into account
+
+=head4 attribute
+
+The attribute fetch to compute data
+
+=head4 refFilter
+
+When the attribute reference another type of object this setting allow to
+filter to the matching referenced object.
+
+=head4 refAll
+
+When the attribute reference another type of object non exiting objects in
+the results appear as 0, otherwise they are ignored.
+
+=head4
+
+=head4 aggregateFunction
+
+An optionnal operation to do on the data:
+
+=over 4
+
+=item sum
+
+Make the sum of the result per item
+
+=item avg
+
+Make the average of the result per item
+
+=item count
+
+Count the number of item return
+
+=back
+
+=head4 delay
+
+The number of day between two run
+