= Use Cases =
[[TOC]]

== User Stories ==

=== During the Event ===

During an event (or disaster) following are the key workflows:
1. [wiki:BluePrint/ShaRe/UseCases#Createanewevent Creating a new Event] (e.g. SW Floods and Landslides 2017)
2. [wiki:BluePrint/ShaRe/UseCases#Creatingandeditingneeds Creating and Editing Needs]
3. [wiki:BluePrint/ShaRe/UseCases#Committingtoneeds Committing to Needs]
4. [wiki:BluePrint/ShaRe/UseCases#Enteringandediting4wupdates Entering and Editing 4W Updates]
5. [wiki:BluePrint/ShaRe/UseCases#enteringsituationalupdates Entering Situational Updates]

==== Creating a new Event ====
An event (or disaster) is created in the platform is created in the system when the real-life situation has resulted in organisations reporting needs and response activities. This event allows needs/activities and other related information to be attributed to that particular event.

1. The System Administrator (UN RCO)
   a. Creates a new event under the “More”>”Disasters” option
      i. Enters the title for the overall event
      i. Can select a “disaster type”
      i. Can provide a “start” date (onset)
      i. Can include the affected districts
      i. Saves the record
   b. Can enter “Situational Updates” to show the event on the Homepage
 
==== Creating and Editing Needs ====

''In the HCT Phase, HCT members/Response agencies supply needs information through both periodic updates and in ad-hoc, as-required manner.''

A need is a requirement (of items including food, clothing, skills, cash for work etc.) caused by an immediate or prolonged disaster. 

In ShaRe Hub, each need is entered as a “row”. Each row is determined by the location (DS Division, GN Division), affected people and required response (“item”). The overall form as a whole reflects the “Group” of needs as determined by the location (Province and District).

The user organisation:

1. Logs into the platform
2. Selects “Needs” - “Create” from the menu bar
3. Needs Entry form is opened:
   a. Enters the relevant information into the first fields (Disaster/Province/District/Date if different to date that the entry is occuring/Summary of Needs/Issue-Cause) ''note: Organisation is automatically filled with the user’s organisation as determined at registration.''
   b. Enters one or more “needs entries” (one needs entry per row as defined by differences in location, number or type of affected people, and the required response (“items”)
   c. Completes any other relevant fields in the field (uploading of documents such as Letters of Request from authorities, showing government verification and contact details on the ground, delivery addresses)
   d. Saves the entry and is taken to the Needs Summary Table.
4. To edit a need, the user:
   a. Opens the Needs Summary Table
   b. Selects “Edit” button in the column to the left of the appropriate row
   c. Selects the pencil icon on the right side to edit the row
''Note: Only the organisation that created a need and the system administrator can edit a need.''



==== Committing to Needs ====


Organisations can commit to deliver some or all of the items required, and/or reach some or all of the people affected within that overall need.

The user organisation:

1. Logs into the platform 
2. Selects “Needs - View”, opening the Needs Summary Table
   a. The user selects the “Commit” button next to the desired need in the table
   b. Opens commitment form (activities/4W entry form) with the relevant information automatically copied from the needs form into the same fields in the commitment form:
      i. Disaster
     ii. Location data
    iii. Summary of Needs
     iv. Issue/Cause
      v. The specific row of the need that is being committed to. 
   c. The user selects the “edit” option on the right of the need information (row)
      i. The user changes the values of fields related to the response commitment they desire to make. These include:
         1. People Affected / Number 
         2. Item Category / Item / Unit / Quantity
         3. Any other relevant information above or below the needs row (including contact details, addresses for delivery etc)
      ii. Note:
        a. If the user commits to the total amount of people/items in the needs entry, then the need is “Fully committed”.
        b. If the user commits to a smaller amount of the people/items in the needs entry, then the need is “Partially committed”. Other users can commit to these needs to fill the gaps. 
        c. Users can cancel their commitments if required, and the system will revise the figures accordingly.
        d. Users can mark the response as “complete” once the real-life need is met. For commitments with multiple organisations responding, this requires communication with the organisation that entered the need before marking the need as “complete”.	

==== Entering and Editing 4W Activities ====

In the HCT Phase, HCT members/Response agencies supply information on activities through both periodic updates and in ad-hoc, as-required manner.

Entering 4W activities uses the same form as making a commitment; however, the 4W activity is entered without an associated “need” within the platform and so does not have pre-inputted data in the form.

The user organisation:

1. Logs into the platform
2. Selects “4W” - “Create” from the menu bar
3. 4W Activity Entry form is opened:
   a. Enters the relevant information into the first fields (Disaster/Implementing Partners/Donors/Province/District/Date if different to date that the entry is occuring/Summary of Needs/Activities) ''note: Organisation is automatically filled with the user’s organisation as determined at registration.''
   b. Enters one or more “Activity entries” (one activity entry per row as defined by differences in location, number or type of beneficiaries, and the response conducted)
   c. Completes any other relevant fields in the field (uploading of documents such as Letters of Request from authorities, contact details on the ground, delivery addresses)
   d. Saves the entry and is taken to the 4W Activities SummaryTable.
4. To edit a 4W Activity, the user:
   a. Opens the 4W Activities Summary Table
   b. Selects “Edit” button in the column to the left of the appropriate row
   c. Selects the pencil icon on the right side to edit the row
''Note: Only the organisation that created an activity and the system administrator can edit a need.''

=== Entering Situational Update ===
'''RCO to update'''

=== Before the Disaster ===

==== Registering an HCT Organization ====
    
1. Registering (creating) a user profile
2. Registering an organisation

=== Registering (creating) a user profile ===

The new user:

1. Opens the ShaReHub Platform in their browser
2. Clicks on “Register” on the top-right of the page
3. Completes the required fields (First Name/Last Name/Email/Password/Language/Organisation/Register as staff or volunteer
4. Selects “Register” button at bottom of the page
5. The user is then taken to the homepage, from which they can log-in.


''Note: If the user’s organisation does not have a profile created in ShaRe Hub, the user must contact the administrator (humanitarian.lk@one.un.org) to have the organisation profile created.'' 

''Note: The user will not immediately have user permissions and must have these approved by the system administrator (humanitarian.lk@one.un.org).'' 

''Note: The “Profile” section consists of 13 tabs for the user to complete, containing information on qualifications, skills, contact details and other areas. The area is not compulsory to complete for platform use, but allows for users to register further information that may help in mobilising and coordinating response.''

=== Registering an Organisation ===
''Note: The general practice is the same for all users. However, this guidance has been written considering the initial user group of HCT agencies.''

The new user:

1. Logs into the ShaRe Hub

'''RCO TO COMPLETE'''


== Use Case Diagrams ==

To refresh on the actors refer to the section on [wiki:BluePrint/ShaRe#Stakeholders Stakeholders]. 
=== Import 4W updates (HCT Orgs) ===
1. A single form can present features to:
   a. download a 4W sheet with login user's Org specific data for a selected event
   a. upload the 4W spreadsheet with updated data

[[Image(http://eden.sahanafoundation.org/raw-attachment/wiki/BluePrint/ShaRe/UseCases/Upload_4W.png)]]
=== Call Center (EOC) hotline service ===
1. Anonymous user calls the ShaRe hotline to report a request
1. Authorized Request Logger receives a request for aid
   a. if 
      i. anonymous user - records all contact information to ensure its not a prank call
      i. known (trusted) or from own organization, then contact details unnecessary
   a. it is logged using the request type specific form
   a. includes identifying predefined item kits/packages and request site (location)
1. Upon submission of the request, the system prompts Request Logger to 
   a. select designated Request Approvers from the area
   a. submit an email and/or SMS requesting for verification and validation
1. Approver confirms the request to be authentic
   a. clicks on approval URL in the Email or SMS
   a. log into the system to click approve
1. Upon approval the request is confirmed and made visible for processing (i.e. commit and deliver)

[[Image(http://eden.sahanafoundation.org/raw-attachment/wiki/BluePrint/ShaRe/UseCases/Request_Aid.png)]]
=== Commit to request, supply and verify delivery ===
1. Org Admin defines the 
   a. supply items, kits, and packages
   a. locations for collecting the items (i.e. drop-off or assembly point)
1. Donor (Supplier) filters through list of requests to 
   a. search for specific request (i.e. by location or category)
   a. commit to the request and specifies the items (goods & service) and quantities
   a. arranges for gathering and delivering the items to the requested location
1. Upon delivery and receipt of all items, the Requester updates the status = complete

[[Image(http://eden.sahanafoundation.org/raw-attachment/wiki/BluePrint/ShaRe/UseCases/Supply_Aid.png)]]
=== Publish Sitreps ===

1. Rapporteur has permissions to create, read, update, or delete a sitrep
   a. access the Sitrep form to create new or edit existing)
      i. if new - relate to event (e.g floods 2017)
   a. add/edit content with sections for
      i. title (headline)
      i. paragraphs (with markups)
      i. reference URL(s)
   a. uploads
      i. multiple photos
      i. multiple documents (PDF, DOC, XSL, ...)
   a. select a location to relate the sitrep to (e.g. an Lx name - province, district, ... or a specific location)
   a. select an organization or default to Rapporteur's organization
   a. submit form to publish sitrep
      i. profile - create or update the styled html page
      i. email headline and link to the profile (attach PDF file)
      i. twitter - push headline with link to profile page
      i. RSS - update the RSS feed
1. Anonymous user (i.e. anyone)
   a. access the sitrep through the menu
   a. selects either the list view or map view (i.e. hide or show map)
   a. see a summary of the stirep with more ... option
   a. clicks on more to navigate to profile page to read entire sitrep
   a. clicks on download control to receive a PDF copy of the sitrep

[[Image(http://eden.sahanafoundation.org/raw-attachment/wiki/BluePrint/ShaRe/UseCases/Publish_Sitreps.png)]]

=== Registering and Managing Users ===

'''Optional processes:'''
1. SHARE registration system
   a. offers a form for users to register their name, organization, contact details (phone & email mandatory)
   a. system generate a random 4 digit code -
      i. is sent via SMS to registering user
      i. user enters code to authenticate their phone
      i. without phone authentication user cannot be granted permissions

[[Image(http://eden.sahanafoundation.org/raw-attachment/wiki/BluePrint/ShaRe/UseCases/Register_Users2.png)]]


=== and a Another ===