Multi-Entity Evaluation Submissions

In its first incarnation, Evaluation Submissions were limited to single entities.   For applications requiring multiple files in a submission, users were required to 'zip' the files together, upload the file to a FileEntity, and submit the entity.  This caused problems for the cases in which each component file required its own metadata, preview or wiki in Synapse.  (The precipitating case comes from the HPN challenge, in which component files are graph representations for which graph visualization previews are requested.)  The solution is to allow the submission of a list of entities rather than only a single entity.  Additionally, the Synapse should support the case in which a user chooses a Folder and then submits the collection of entities which are direct or indirect children of the Folder.    The missing pieces are enumerated below:

Entity list submission (PLFM-2074)

The Submission schema must be changed so that rather than containing a single entity ID, version, and entity bundle, it contains an array of these. Along with the Submission object, a  request to the submission service includes the entity's e-tag as a request parameter.  This must be extended to include the e-tags of all submitted entities.  (Perhaps these e-tags can be added to the Submission schema.)    The submission service must obtain a lock on each listed entity, then copy the metadata to the entity bundle array.

Descendent service (PLFM-2075)

Synapse must expose a service to return the EntityHeaders for the entities which are descendents of a given (Project or Folder) entity.  The result must be consistent with the current system state, unlike the current descendent query which is 'eventually consistent.'

Folder upload x 3 clients (SWC-739, SYNR-549, SYNR-550)

Each client must allow the user to select a folder, then upload the folder plus its descendent hierarchy to create an isomorphic tree of Folders and Files in Synapse.

Folder submission x 3 clients (SWC-740, SYNR-551, SYNR-552)

Each of our supported clients must provide a command to submit a Folder.  The client will use the descendent service to get the child entities and the Entity list submission service to submit them.

Multi-File Submission retrieval x 2 clients (SYNR-553, SYNR-554)

Each analytic client must extend "synGetSubmission" to retrieve the multiple files associated with a Submission.

Related Tasks

The file services are to be extended to create previews for standard Cytoscape files, including SIF and EDA file types. (PLFM-2076)

The web client is to generate real-time previews of SIF/EDA file pairs in the entity page for each file, by identifying its peer in the same container (Project or Folder) by file name.  (SWC-737)

Existing scoring harnesses, such as the HPN scoring harness, must be updated to download multiple files for a submission, rather than expecting a single .zip file.