Validate and Upload
flowchart LR
A[Fill in templates] --> B["Zip templates<br/>and files"]
B --> C{Validator}
C -- errors --> D["Fix the first<br/>errors"] --> B
C -- passes --> E[Upload]
E --> F{Status}
F -- Rejected --> D
F -- Completed --> G([Data in your<br/>workspace])
G --> H([Submit for<br/>curation])
1. Build the package
A package is a .zip containing your templates and every file they name.
- Each template appears once, in one format:
.xlsx, tab-delimited.txtor.json(R-06). - Every file named in a template (protocol documents,
.fcsfiles, results files) is in the zip (R-23). - Records that a template refers to are in this package or already in the workspace (R-08).
- Assay templates that belong together are in the same package (R-10).
- All data is for one study (R-01).
- The zip is a plain
.zip: no password, not split, not a renamed.raror.7z(R-03).
2. Validate (recommended)
The Validator runs a test upload. It checks the format and content of every file, but nothing is loaded. You get the results on the site and by email, usually within about five minutes.
Fix the first errors first
One early problem, such as a missing subject, can cause many later errors. Fix the first errors listed, then validate again. To look up a message, see Troubleshooting Errors.
3. Upload
Upload the package on the Upload page.
- Up to 512 MB per upload through the website (R-02).
- Larger packages: use IBM Aspera Connect. The ImmPort Helpdesk can help you set it up.
- Scripted uploads: see Automate with the API.
4. Check the status
Each upload has a ticket with one of three statuses:
| Status | Meaning | What to do |
|---|---|---|
| Pending | Validation and loading are still running. Large or complex packages can take a while. | Wait for the email. |
| Completed | The data is loaded into your workspace. It shows up in ImmPort within about 5 minutes of the email. | Check the database report to see what was loaded. |
| Rejected | Nothing was loaded. | Open the summary report, fix the errors and upload again. |
The email includes downloadable reports. ImmPort replaces your user-defined IDs with accessions (such as SUB123456) when it loads the data.
Changing data after upload
To change data that's already loaded, contact the ImmPort Helpdesk. The exception is study design details, which you can update yourself with the study_design_edit template.
Uploads are rejected while the study is In Curation, Awaiting Sign-off or Ready for Release (R-25). Withdraw the study to Draft first; see the Study Lifecycle.
Share your study in a data release
When the study is complete, submit it for curation in the Study Wizard. The ImmPort team curates it, the sign-off person you choose signs off its release, and the study goes public in one of ImmPort's monthly data releases. See the Study Lifecycle and the Data Release Schedule.