Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Team Use Case and Design.pptx

toc 

Updates

Results of 1/15 discussion:

- defer 'optOut' feature

- DO send submission receipt notification to all users on submission list

- Allow submission permission to be restricted to the Team leader (aka 'captain' or 'admin') (later we decided not to add this restriction)

...

Specific Requirements

  • To register a Team for a Challenge one must (1) be a registered Challenge participant, AND (2) be an administrator (captain) of the Team.
  • Provide a service which accepts a user ID and returns a list of teams on whose behalf the user may submit, taking into account any restrictions.
  • Send submission receipt notification to all contributors.
  • Add an administrative service to add a contributor to a Submission.  This allows someone who neglected to sign-up for the challenge but who contributed to a Submission to be given credit by Challenge Administration.
  • Defer 'optOut' feature (allowing a user to 'drop off' a submission created by a teammate)
  • When retrieving a TeamState, a hash of the object should be returned.  The client submits the hash with the Submission and the server throws an exception if the hash is out of date.  This ensures that the Team State at the time of submission is the same as that which the user saw.

...

  • Need a service to register a Team based on an Evaluation ID (in contrast to registering based on a Challenge ID).

Add an "isAdmin" parameter to the "GET /user/{id}/team" service. This is subsumed by the 'get submission teams' service.

Add a service to list a user's teams which either (1) are registered for the Challenge, or (2) the user is an administrator on. This is subsumed by the 'get submission teams' service.

...


Submission

...

Results of 1/19 discussion:

Need a service to return the participants in the Challenge, optionally filtered by whether they are in some Team, annotated by whether they are the admin on the Team.

 

Team Registration Rule:

To register a Team for a Challenge one must (1) be a registered Challenge participant, AND (2) be an administrator (captain) of the Team.

 

...

restriction rule:

Each Submission has a submitter, an optional Team ID and a list of contributors (other user IDs).  A submission is accepted if either:

...

B. It is a valid Team Submission, i.e. (1) it has a Team ID of a registered Team, (2) the Team hasn't exceeded its per-round submission limit, (3) all contributors are registered for the challenge and are on the specified Team at the time of submission, and (4) neither the submitter nor any contributor has made an individual Submission or was the submitter of or contributor to a Team Submission having a different Team ID in the current round. 

Given a User and a Challenge, need a service to return a paginated list of teams which the user is on and which either (1) they are an admin or (2) the team is already registered for the challenge.  More Generally we need a list of Teams either (1) on whose behalf the user is eligible to submit or (2) on whose behalf the user WOULD be eligible to submit if the Team has been registered for the Challenge, and which the User CAN register for the Challenge.

 

 

Design Approach

1) A Challenge is a Project with some extra metadata.  Implement this as a new object which a Project can 'own', and on which CRUD operations can be done independently from the Project.

...

- Portal list submissions for which user may opt out.

 

Response to User Protests:

...

Investigation:  We retrieve the submissions for the given round and count up the user's contributions.  (This can be done automatically and the results populated in a Table visible in a dynamic view.)Reply:  You were included as a submitter in submission(s) made by the following user(s) on the given date(s):  xxxxx.

Objects

Entity Relationship Diagram

...