# Guide to the Interactive Data Submission Platform

# Quick guide


1. **Configure your submission**: select what type of data you want to submit 

   ==(⚠️ you cannot mix different data types in one submission)==
2. **Submit the metadata**: drag & drop or select your *.csv* or *.tsv* metadata file to submit it. Templates are available for you to download [below](https://clinbiokb.sib.swiss/doc/interactive-data-submission-platform-5rIwHEcmmO#h-metadata-template-download).
3. **Review metadata**: If your metadata contains errors or warning you can edit and correct them within the portal

   
   1. Validate metadata: if you edited any metadata fields click the validate button to re-validate the changes
4. **Match sequencing files**: drag & drop or select your sequencing files, or a folder containing the files. The platform automatically match file names to one of the sample identifiers provided in the metadata. The mapping parameter can be selected among *isolate_identifier, reporting_lab_order_id, or collecting_lab_order_id*.
5. **Review your submission** - and submit
6. In case of file transfer interruptions, a retry option for the files that failed is provided

# Metadata template download

The metadata columns are explained in detail on the [metadata reference page](/doc/metadata-reference-YgkEblNBzD).

## SPSP bacteria (last updated 07.09.2026)

* Assisted template in excel format and .csv export

[metadata_template_bacteria.xlsx 61778](https://clinbiokb.sib.swiss/api/files.get?sig=eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJrZXkiOiJ1cGxvYWRzLzU2MWQxMTBkLWJiOGYtNGY4Ni04OWJlLWU3ZDFjOTBkMTIzYy8yZTI0ZjJjNy1hMDY2LTRkZDEtOWYzNC0wZGQ5OWJlYjExNWEvbWV0YWRhdGFfdGVtcGxhdGVfYmFjdGVyaWEueGxzeCIsInR5cGUiOiJhdHRhY2htZW50IiwiaWF0IjoxNzk0OTQzODAwLCJleHAiOjE3OTUwMzAyMDB9.9W16FYMif2b5FfOgrvbX9uklI7NuOfzPLjvIFAqljRU)

* Barebones .csv template

[metadata_template_bacteria.csv 478](https://clinbiokb.sib.swiss/api/files.get?sig=eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJrZXkiOiJ1cGxvYWRzLzU2MWQxMTBkLWJiOGYtNGY4Ni04OWJlLWU3ZDFjOTBkMTIzYy8yNGEzMjA0ZC1hZGZhLTQ0MDYtYTI3MS04YjM4NzMyZGJiYWQvbWV0YWRhdGFfdGVtcGxhdGVfYmFjdGVyaWEuY3N2IiwidHlwZSI6ImF0dGFjaG1lbnQiLCJpYXQiOjE3OTQ5NDM4MDAsImV4cCI6MTc5NTAzMDIwMH0.9Gy08Pu1s0ou-XfXIWRn-jzc51QQiIAG4WogFvrFE0Y)

# Detailed guide 

## Configure your submission

 ![](https://clinbiokb.sib.swiss/api/files.get?sig=eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJrZXkiOiJ1cGxvYWRzL2IzMDJlY2ViLWViY2YtNDJmZS1iY2I1LWNjZmY0ODhmZWFiYi8wYmM1ZWJkNi04MzYxLTRjY2EtYWYyYi04NzBhZmRmMDYzZDgvcG9ydGFsX2xhbmRpbmdfcGFnZS5wbmciLCJ0eXBlIjoiYXR0YWNobWVudCIsImlhdCI6MTc5NDk0MzgwMCwiZXhwIjoxNzk1MDMwMjAwfQ.xsawlcDMci9cjoHmFw1m1qQR1A-tgbni9T0WI4UH5_I " =940x637")


:::warning
You can only submit one data type at a time

:::

The first step in your data submission consists of defining the type of data you are submitting to SPSP. We currently offer the ability to submit: 

* **short-read** data (for example from Illumina sequencers), depending on your sequencing modality you can then select if you are only submitting **single-end** or **paired-end** reads. 
  * Accepted file types: *.fastq*
* **long-read** data coming from Oxford Nanopore sequencers and flow cells of the R10 generation and above. 
  * Accepted file types: *.fastq* and *.bam*
* **assemblies** as .fasta files. This requires providing metadata detailing assembly and sequencing technology.
  * Accepted file types: *.fasta*

Click on **Next** to move to the validation of the metadata.

## Submit the metadata

 ![](https://clinbiokb.sib.swiss/api/files.get?sig=eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJrZXkiOiJ1cGxvYWRzL2IzMDJlY2ViLWViY2YtNDJmZS1iY2I1LWNjZmY0ODhmZWFiYi8xNGUxNzI5Yi0zZTkwLTQzODUtOGMzNS1hOWQwNWNjOWQyM2MvaW1wb3J0X21ldGFkYXRhLnBuZyIsInR5cGUiOiJhdHRhY2htZW50IiwiaWF0IjoxNzk0OTQzODAwLCJleHAiOjE3OTUwMzAyMDB9.CfpDVfHIt1Np-9h0EIkFhiV4fIBitFLFKG-E3shUu-E " =936x587")

This page allows you to upload your metadata in either a *.csv* or *.tsv* table format. An excel template  can be downloaded in the [section above on this page](https://clinbiokb.sib.swiss/doc/interactive-data-submission-platform-5rIwHEcmmO#h-metadata-template-download). For information on the metadata columns, visit the  [metadata reference](/doc/metadata-reference-YgkEblNBzD) page.

The template allows you, once completed, to export the metadata as a clean *.csv* or *.tsv* file accepted by SPSP.


:::warning
The SPSP submission portal only accepts *.tsv* or *.csv* metadata files, not excel *.xlsx* files

:::

Drag & drop, or select the metadata file to submit it. This step will check the structure of the file and show you a summary of the number of samples, validate that all mandatory columns are present and display any additional columns that will not be included in the next step.

 ![](https://clinbiokb.sib.swiss/api/files.get?sig=eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJrZXkiOiJ1cGxvYWRzL2IzMDJlY2ViLWViY2YtNDJmZS1iY2I1LWNjZmY0ODhmZWFiYi8zZjhjY2JmZi05NjAwLTRiODUtOGU2NC02YjZkMzE2ZjE4MjUvbWV0YWRhdGFfaW1wb3J0ZWQucG5nIiwidHlwZSI6ImF0dGFjaG1lbnQiLCJpYXQiOjE3OTQ5NDM4MDAsImV4cCI6MTc5NTAzMDIwMH0.99iEARxfaGIFbyv5YAFII8Z4WfnO-GVwSsu2fniD9U4 " =937x604")

If everything looks correct to you, click **Next**. The data are then locally encrypted on your computer and submitted to SPSP for validation.

## Review the metadata

 ![](https://clinbiokb.sib.swiss/api/files.get?sig=eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJrZXkiOiJ1cGxvYWRzL2IzMDJlY2ViLWViY2YtNDJmZS1iY2I1LWNjZmY0ODhmZWFiYi9jZmQ2MWQyNi02MTkzLTRiNWItOWQyNy03ZWM5M2U3NzgwZTMvbWV0YWRhdGFfZXJyb3JzLnBuZyIsInR5cGUiOiJhdHRhY2htZW50IiwiaWF0IjoxNzk0OTQzODAwLCJleHAiOjE3OTUwMzAyMDB9.j-uYAdURhfRsdr43LxadVmAu9fDHBPR9vv-nZvyKCIs " =953x605")

For reviewing the metadata four views are available: All, Blocking errors, Needs review, and No issues. 

You can directly edit any metadata fields directly in the tables. Always remember to click the **validate metadata** button after editing any fields to make sure the edits are validated and taken into consideration for the next steps of the submission.

### View All Samples

This view shows you a full table view of your metadata with all samples and columns independent of their status. You can use the download button in the top right above the table to download a full .csv of your metadata in case you want to save a copy of the metadata after performing any edits in any of the views.

### View Blocking Errors

If the validation detects any errors in your metadata, this view highlights the fields and columns in your metadata that contains an error. By hovering over a field, a tooltip appears describing the error for that particular field. By double clicking the field you can directly edit its value. Always remember to click the **validate metadata** button after editing any fields to make sure that the error was resolved.


:::warning
The interface allows you to continue even when blocking errors are present. Beware that any sample with a blocking error is not included in the next step and will not be submitted.

:::

### View Needs Review

The needs review view highlights samples and columns that are not mandatory, but that we still recommend you to complete. The same editing tools are available to you here as for the other views. By clicking the **validate metadata** button after editing values, the fields are revalidated and if everything is ok, the sample will move on to the no issues view.


:::warning
If you introduced a blocking error by editing in this view, the sample in questions will appear in the blocking errors view and prevent its submission until fixed

:::

### View No Issues

This view shows all the columns for samples that have no mistakes or missing recommended values.

Once you resolved all the potential problems with the metadata or you want to move on with the subset of samples that doesn’t contain any errors, click **Next**.

## Submit sequence files

 ![](https://clinbiokb.sib.swiss/api/files.get?sig=eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJrZXkiOiJ1cGxvYWRzL2IzMDJlY2ViLWViY2YtNDJmZS1iY2I1LWNjZmY0ODhmZWFiYi8zN2RkMzAzZC0xNjdjLTRjOWMtOTM4Ny0zMWY1ZmI3YjgzZmYvaW1wb3J0X2ZpbGVzLnBuZyIsInR5cGUiOiJhdHRhY2htZW50IiwiaWF0IjoxNzk0OTQzODAwLCJleHAiOjE3OTUwMzAyMDB9.BKRDOCtjVyty9AbNW4UJwNSW0mGgpf5AA6JttBZTiww " =935x517")

Drag & drop or click and select all of the sequence files, or a folder of files that you want to upload. You will then automatically move on to the file matching page.

 ![](https://clinbiokb.sib.swiss/api/files.get?sig=eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJrZXkiOiJ1cGxvYWRzL2IzMDJlY2ViLWViY2YtNDJmZS1iY2I1LWNjZmY0ODhmZWFiYi85ZTVmMjc1My1lODZhLTQ1YjAtYTUxYS1mNmVkMjM0YTc4ZjgvbWFwX2ZpbGVzLnBuZyIsInR5cGUiOiJhdHRhY2htZW50IiwiaWF0IjoxNzk0OTQzODAwLCJleHAiOjE3OTUwMzAyMDB9.vuwmgexWFh6kKLiHOQaq2Q2M8qNeV0_En0_WCF9iyQk " =950x647")

The selected files are matched to each sample based on the sequencing filenames, which should contain one of the IDs provided in the metadata. The mapping parameter can be selected among *isolate_identifier, reporting_lab_order_id, or collecting_lab_order_id* using the dropdown menu.

In paired-end workflows, `_R1` and `_R2` in the file name are used to identify forward and reverse reads.

The files are then automatically matched to the corresponding samples from the metadata. In the case that there is no common ID in the filename, you can match the files to the corresponding samples manually. 

When you're ready to upload the files to SPSP, click **Next**.

 ![](https://clinbiokb.sib.swiss/api/files.get?sig=eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJrZXkiOiJ1cGxvYWRzL2IzMDJlY2ViLWViY2YtNDJmZS1iY2I1LWNjZmY0ODhmZWFiYi8zMmYxZGIwZi1iM2VjLTRhOGYtOWFlOS0zYTcyMGZlZWMzZDMvbWFudWFsX21hcHBpbmcucG5nIiwidHlwZSI6ImF0dGFjaG1lbnQiLCJpYXQiOjE3OTQ5NDM4MDAsImV4cCI6MTc5NTAzMDIwMH0.juQqgbdB7FnrEPY1RQHUX2_QCaUQQOAQl-AxHge6CII " =949x650")

## Upload to SPSP

 ![](https://clinbiokb.sib.swiss/api/files.get?sig=eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJrZXkiOiJ1cGxvYWRzL2IzMDJlY2ViLWViY2YtNDJmZS1iY2I1LWNjZmY0ODhmZWFiYi83OTdkOWE4ZC01MjY5LTQyN2MtYWVlYy1hOTc3Njg2MjcxMmIvdXBsb2FkX2RhdGEucG5nIiwidHlwZSI6ImF0dGFjaG1lbnQiLCJpYXQiOjE3OTQ5NDM4MDAsImV4cCI6MTc5NTAzMDIwMH0.WLmhN7n4wsfz9rKr_hFa3SBXfrd3gzhn_tpd4Evb7XE " =952x758")

On the final page of the submission workflow you are shown a summary of the samples to be uploaded. When you click **submit** the data will be encrypted directly on your computer and uploaded to SPSP. 


:::warning
Please remain on this screen until the upload is finished. A warning will be displayed and if you attempt to navigate away from the page and require validation to do so. If you navigate away from the page your upload will be aborted. 

:::

In case of network interruption or loss of connection a file may fail to upload. After the submission has been completed any file that did not transfer properly will be listed in an error tab where you can retry the upload of the affected files.

---

**Documents**

- [Guide to the Interactive Data Submission Platform](https://clinbiokb.sib.swiss/s/spsp-documentation/doc/guide-to-the-interactive-data-submission-platform-5rIwHEcmmO)
- [Metadata Reference](https://clinbiokb.sib.swiss/s/spsp-documentation/doc/metadata-reference-YgkEblNBzD)
- [ENA submission mechanism](https://clinbiokb.sib.swiss/s/spsp-documentation/doc/ena-submission-mechanism-glEuHa3Hz3)
- [Metadata Templates](https://clinbiokb.sib.swiss/s/spsp-documentation/doc/metadata-templates-DMs02BVrZr)
- [SPSP Sequencing Purposes](https://clinbiokb.sib.swiss/s/spsp-documentation/doc/spsp-sequencing-purposes-QkOjhP8k37)