Changes between Version 24 and Version 25 of BluePrintOrganisationRegistry


Ignore:
Timestamp:
03/15/11 18:11:32 (14 years ago)
Author:
Fran Boon
Comment:

--

Legend:

Unmodified
Added
Removed
Modified

  • BluePrintOrganisationRegistry

    v24 v25  
    1 = NEW! =
    2 This relates to functionality implemented in https://code.launchpad.net/~michael-howden/sahana-eden/eden. It is being documented in the Blue Prints so that the functionality can be reviewed. Once it is approved this documentation will be shifted between:
     1[[TOC]]
     2= Organisation Registry  =
     3'''Who's doing What Where and When (4W)'''
     4
     5This documentation needs to be moved between:
    36* UserGuidelinesAdmin
    47* UserGuidelinesOrganisationRegistry
    58* UserGuidelinesInventory
    69* [wiki:S3XRC/ModelExtensions/SuperEntities]
     10
     11== Introduction ==
     12"Who, What, Where"[[BR]]
     13The Organization Registry keeps track of all the relief organizations working in the disaster region. It captures not only the places where they are active, but also captures information on the range of services they are providing in each area.
     14
     15Haiti Requirements: http://wiki.sahanafoundation.org/doku.php/haiti:requirements#organization_registry
     16
     17Old PHP User Guide: http://wiki.sahanafoundation.org/doku.php?id=doc:or:english
     18
     19We should aim to be able to exchange data with UN OCHA's 3W. Information about the 3W database schema, possible import methods to OCHA, and 3W controlled vocabulary lists can be found at [wiki:BluePrint3W]
     20More work should be done to ensure that the schema is compatible with the [wiki:BluePrint3W] schema.
     21
     22== Tables ==
     23
     24This means having the following tables:
     25=== Organisation ===
     26 * Name
     27 * Acronym
     28 * Type IS_IN_SET([Government,International Governmental Organization,International NGO,Misc,National Institution,National NGO,United Nations])
     29 * Website
     30 * National Staff
     31 * International Staff
     32 * Number of Vehicles
     33 * Vehicle Types
     34 * Donation Phone (gives the org an incentive to be listed)
     35 * Logo (could be displayed on the map)
     36
     37=== Sectors ===
     38 * Name
     39 * Abbreviation
     40
     41=== Office ===
     42Instance of the Site super entity
     43 * Name
     44 * Type IS_IN_SET([Headquarters,Regional,Country,Satellite Office]) (Would "Field" be a better term than "Satellite")
     45 * Phone 1
     46 * Phone 2
     47 * Email
     48 * Fax
     49 * Address 1
     50 * Address 2 (used for Postcode)
     51 * Needs validation (checkbox) [NEW] or Validate
     52
     53=== Staff ===
     54==== To Do ====
     55 * Make S3PersonAutocompleteWidget work with the filter criteria of the field.requires (this is required to ensure only unique staff can be added to each site)
     56
     57=== Contact ===
     58Handled by the [wiki:BluePrintPersonRegistry Person Registry]?
     59 * First Name
     60 * Last Name
     61 * Title
     62
     63=== Projects (previously Activities) ===
     64The [wiki:BluePrintProjectManagement Project Management module] will be the main repository for Projects information.
     65
     66''These fields are take from a WASH (Water Health and Sanitation) Cluster form''
     67 * Organization (link to Org Table)
     68 * Location
     69 * Sector
     70 * Sub-Sector (opt)
     71 * Description
     72 * Beneficiaries (number)
     73 * Start Date
     74 * End Date
     75 * Funded (Y/N)
     76
     774x [wiki:BluePrintMany2Many Many-to-Many] tables to link them
     78 * structured like {{{t2_membership}}}
     79
     80=== Sector-to-Organisation ===
     81Many-to-Many table to link Sector to Organisations.[[BR]]
     82
     83=== Office-to-Organisation ===
     84Many-to-Many table to link Offices to Organisations.[[BR]]
     85Optional validator to limit Offices as being affiliated to just a single Organisation
     86
     87=== Contact-to-Office ===
     88Many-to-Many table to link Contacts to Offices.[[BR]]
     89Optional validator to limit Contacts as being affiliated to just a single Office
     90
     91=== Contact-to-Organisation ===
     92Many-to-Many table to link Contacts to Organisations.[[BR]]
     93Optional validator to limit Contacts as being affiliated to just a single Organisation
     94
     95
     96Q: Is it useful to be able to have a Contact be affiliated to an Organisation but not to an Office?
     97 * would the default 'HQ' be appropriate?
     98
     99Would be nice to add these functionalities:
     100 * Organigram creator from the Contacts
     101 * ID cards from the Contacts
     102Q: Wouldn't "Staff" be a better description than contact?
     103Q: Contact implies just a single person for each organization.
     104
     105== Screens ==
     106
     107This describes the screens laid out in a way matching with the workflow.
     108
     109=== Dashboard ===
     110 * Organization Dashboard (will go to the organization of the current user)
     111 * Organizations Registry
     112 * Projects
     113 * Map
     114
     115=== Organization Dashboard ===
     116 * Org. Details
     117 * Edit Org. (Restricted)
     118 * Offices
     119   * Add Office
     120 * Projects (for displayed Org.)
     121   * New Project
     122
     123=== Organization Registry ===
     124 * List of Organizations
     125 * Add New Organization
     126
     127=== Projects ===
     128 * List of all Projects
     129 * Display on Map (redirects to Map, with Project filter selected)
     130
     131=== Map ===
     132Filterable options to display:
     133 * Offices
     134 * Projects
     135
     136 * We want to be able to add Proejcts by Jurisdiction (e.g. Neighborhood for PaP)...without knowing the GIS data.
     137 * If we do have polygons for neighborhoods, these will be displayed automatically on map.
     138 * KML/GeoRSS feeds will just be GIS Centroids.
     139
     140=== Reports ===
     141  * Tabular
     142  * Map
     143  * Key is to be able to identify Gaps
    7144
    8145== Site Super Entity ==
    … …  
    77214Inventories can be added to any site instance, by adding {{{shn_show_inv_tabs(r)}}} to the rheader tabs for that site instance.
    78215
    79 = Organisation Registry  =
    80 '''Who's doing What Where and When (4W)'''
    81 
    82 == Introduction ==
    83 "Who, What, Where"[[BR]]
    84 The Organization Registry keeps track of all the relief organizations working in the disaster region. It captures not only the places where they are active, but also captures information on the range of services they are providing in each area.
    85 
    86 Haiti Requirements: http://wiki.sahanafoundation.org/doku.php/haiti:requirements#organization_registry
    87 
    88 Old PHP User Guide: http://wiki.sahanafoundation.org/doku.php?id=doc:or:english
    89 
    90 We should aim to be able to exchange data with UN OCHA's 3W. Information about the 3W database schema, possible import methods to OCHA, and 3W controlled vocabulary lists can be found at [wiki:BluePrint3W]
    91 More work should be done to ensure that the schema is compatible with the [wiki:BluePrint3W] schema.
    92 
    93 == Tables ==
    94 
    95 This means having the following tables:
    96 === Organisation ===
    97  * Name
    98  * Acronym
    99  * Type IS_IN_SET([Government,International Governmental Organization,International NGO,Misc,National Institution,National NGO,United Nations])
    100  * Website
    101  * National Staff
    102  * International Staff
    103  * Number of Vehicles
    104  * Vehicle Types
    105  * Donation Phone (gives the org an incentive to be listed)
    106  * Logo (could be displayed on the map)
    107 
    108 === Sectors ===
    109  * Name
    110  * Abbreviation
    111 
    112 === Office ===
    113 Instance of the Site super entity
    114  * Name
    115  * Type IS_IN_SET([Headquarters,Regional,Country,Satellite Office]) (Would "Field" be a better term than "Satellite")
    116  * Phone 1
    117  * Phone 2
    118  * Email
    119  * Fax
    120  * Address 1
    121  * Address 2 (used for Postcode)
    122  * Needs validation (checkbox) [NEW] or Validate
    123 
    124 === Staff ===
    125 ==== To Do ====
    126  * Make S3PersonAutocompleteWidget work with the filter criteria of the field.requires (this is required to ensure only unique staff can be added to each site)
    127 
    128 === Contact ===
    129 Handled by the [wiki:BluePrintPersonRegistry Person Registry]?
    130  * First Name
    131  * Last Name
    132  * Title
    133 
    134 === Projects (previously Activities) ===
    135 The [wiki:BluePrintProjectManagement Project Management module] will be the main repository for Projects information.
    136 
    137 ''These fields are take from a WASH (Water Health and Sanitation) Cluster form''
    138  * Organization (link to Org Table)
    139  * Location
    140  * Sector
    141  * Sub-Sector (opt)
    142  * Description
    143  * Beneficiaries (number)
    144  * Start Date
    145  * End Date
    146  * Funded (Y/N)
    147 
    148 4x [wiki:BluePrintMany2Many Many-to-Many] tables to link them
    149  * structured like {{{t2_membership}}}
    150 
    151 === Sector-to-Organisation ===
    152 Many-to-Many table to link Sector to Organisations.[[BR]]
    153 
    154 === Office-to-Organisation ===
    155 Many-to-Many table to link Offices to Organisations.[[BR]]
    156 Optional validator to limit Offices as being affiliated to just a single Organisation
    157 
    158 === Contact-to-Office ===
    159 Many-to-Many table to link Contacts to Offices.[[BR]]
    160 Optional validator to limit Contacts as being affiliated to just a single Office
    161 
    162 === Contact-to-Organisation ===
    163 Many-to-Many table to link Contacts to Organisations.[[BR]]
    164 Optional validator to limit Contacts as being affiliated to just a single Organisation
    165 
    166 
    167 Q: Is it useful to be able to have a Contact be affiliated to an Organisation but not to an Office?
    168  * would the default 'HQ' be appropriate?
    169 
    170 Would be nice to add these functionalities:
    171  * Organigram creator from the Contacts
    172  * ID cards from the Contacts
    173 Q: Wouldn't "Staff" be a better description than contact?
    174 Q: Contact implies just a single person for each organization.
    175 
    176 == Screens ==
    177 
    178 This describes the screens laid out in a way matching with the workflow.
    179 
    180 === Dashboard ===
    181  * Organization Dashboard (will go to the organization of the current user)
    182  * Organizations Registry
    183  * Projects
    184  * Map
    185 
    186 === Organization Dashboard ===
    187  * Org. Details
    188  * Edit Org. (Restricted)
    189  * Offices
    190    * Add Office
    191  * Projects (for displayed Org.)
    192    * New Project
    193 
    194 === Organization Registry ===
    195  * List of Organizations
    196  * Add New Organization
    197 
    198 === Projects ===
    199  * List of all Projects
    200  * Display on Map (redirects to Map, with Project filter selected)
    201 
    202 === Map ===
    203 Filterable options to display:
    204  * Offices
    205  * Projects
    206 
    207  * We want to be able to add Proejcts by Jurisdiction (e.g. Neighborhood for PaP)...without knowing the GIS data.
    208  * If we do have polygons for neighborhoods, these will be displayed automatically on map.
    209  * KML/GeoRSS feeds will just be GIS Centroids.
    210 
    211 === Reports ===
    212   * Tabular
    213   * Map
    214   * Key is to be able to identify Gaps
    215 
    216216----
    217217BluePrints