doc/trackers.md

   1 # Trackers
   2
   3 ## Structure
   4
   5 Here is a (old) global overview of the structure of trackers. The aim is
   6 to give to the developer a bird's-eye view of objects relationship and
   7 underlying database structure.
   8
   9 ![Overview of tracker structure](./images/tracker-structure.png)
  10
  11 ## Creating a new field
  12
  13 Here are important points to be checked while developing a new field.
  14 This applies also for new types of bind for list fields. Please note
  15 that some points may be irrelevant for some type of fields.
  16
  17 -   Setup acceptance criteria in test suite
  18 -   Tracker Field Structure
  19     -   Specific properties?
  20     -   Field can be switch to another type (only sb/msb)
  21     -   Shared Fields
  22     -   Import/Export XML
  23     -   Field is duplicated on tracker inheritance (both tracker and
  24         project creation)
  25     -   Definition is given through REST (representations)
  26     -   Migrate field from TV3 (if not done)
  27     -   Does new field can be used for burndown?
  28     -   Can the field be required?
  29     -   What level of permissions this field supports?
  30 -   Artifacts
  31     -   Export/import CSV
  32     -   What does 'None' mean for this field?
  33     -   Default value
  34     -   Field is involved in notifications
  35     -   New value is sent in notifications
  36     -   Diff of the field appears in changesets
  37     -   New value is Copyed on Artifact copy
  38     -   New value can be used in semantic
  39     -   New value can be updated on masschanges
  40     -   On an artifact with artifact links, on creating directly a child
  41         the field can be used
  42 -   Reports
  43     -   Field is searchable through criteria
  44     -   Field is displayed as a column in table
  45     -   Field is used to sort
  46     -   Field is used for aggregates
  47     -   Field is used to build charts
  48     -   Field is used to build cardwall
  49 -   Angular
  50     -   Create/ edit modal
  51     -   Cardwall edit in place
  52     -   Card field in planning v2
  53     -   Card field in kanban + filter + highlight
  54     -   Does field can be directly updated in Cardwall
  55     -   Modal edit Release
  56     -   Modal add a Task
  57 -   User documentation is accurate