Skip to content

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([Ask for a<br/>data release])

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 .txt or .json (R-06).
  • Every file named in a template (protocol documents, .fcs files, 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 .rar or .7z (R-03).

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.

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.

Share your study in a data release

When your study is ready to share, email the ImmPort Helpdesk. The ImmPort team runs a quality check, sends you feedback and agrees the timing with you. Studies go public in ImmPort's monthly data releases. See the Data Release Schedule.