controlsamples

Name	controlSamples.txt
JSON File Name	controlSamples.json
Type	combined
Schema Version	3.37
Description	The control sample template defines and annotates the control samples included in MBAA assays. Control samples are not assumed to be of biologic origin. This template requires that the control sample be always new, while the experiment can be new or pre-defined. The control sample is the key to the templates and must be unique within the template.
Download	⬇️ controlSamples.xlsx ⬇️ controlSamples.txt ⬇️ controlSamples.json This top-level schema references companion files (e.g. controlSamples.Datum.json) in the same json-templates folder — download the all_templates.zip to get them all together.

Reading this table: see How to read the template documentation for what Required / Conditionally required / Optional mean and how to read the Type & Constraints column.

Template Column	Requirement	Type & Constraints	Description
Control Sample ID	Required	Text, max 100 characters JSON: controlSampleId (string)	The control sample user defined ID is an identifier chosen by the data provider. This ID may be referenced by other data records (e.g. MBAA results). The user defined ID is not shared. The identifier should be unique to the ImmPort workspace to which the data will be uploaded.
Source	Conditionally required when you are defining a new Control Sample in this row (rather than referencing an existing one)	Text, max 100 characters JSON: source (string)	The manufacturer or lab where the control sample was obtained.
Catalog ID	Conditionally required when you are defining a new Control Sample in this row (rather than referencing an existing one)	Text, max 100 characters JSON: catalogId (string)	The manufacturer or source lab's identifier.
Dilution Factor	Conditionally required when you are defining a new Control Sample in this row (rather than referencing an existing one)	Text, max 100 characters JSON: dilutionFactor (string)	The dilution factor indicates how much a sample was diluted before it was assayed. Please enter a number.
Assay ID	Conditionally required when you are defining a new Control Sample in this row (rather than referencing an existing one)	Text, max 100 characters JSON: assayId (string)	The assay ID represents the plate or array ID where standard curves, control samples, and experiment samples were collected and assayed. This ID will be used to link standard curves, control samples, and experiment samples results.
Assay Group ID	Optional	Text, max 100 characters JSON: assayGroupId (string)	The assay group ID represents a collection of plates or arrays. This ID may be used to link collections of standard curves, control samples, and experiment samples results.
ImmPort Template?	Conditionally required when you are defining a new Control Sample in this row (rather than referencing an existing one)	Controlled vocabulary — value must be one of lk_yes_no JSON: immportTemplate (enum)	The format of the result file depends on the assay type. ImmPort supports results templates (MBAA_Results.txt) for some of the commonly used immunological assay methods. These template facilitate the sharing and re-use of results data in a standard format. If the result file is the ImmPort results template (strongly recommended by NIAID DAIT), choose 'Yes' from the drop down list and do not include a file name in the "Result File Name" column. If the result file is not an ImmPort results template, choose 'No' from the drop down list and include a file name in the "Result File Name" column. The format of the result file depends on the assay type. ImmPort supports results templates (MBAA_Results.txt) for some of the commonly used immunological assay methods. These templates facilitate the sharing and re-use of results data in a standard format. If the result file is the ImmPort results template (strongly recommended by NIAID DAIT), choose 'Yes' from the drop down list and do not include a file name in the "Result File Name" column. If the result file is not an ImmPort results template, choose 'No' from the drop down list and include a file name in the "Result File Name" column.
Result File Name	Optional	JSON: resultFileName (string)	This is expected to be the MBAA_Results.txt ImmPort template. The file size name limit is 240 characters. Enter the file name (including file extension) that contains assay results for the control sample. The file size name limit is 240 characters.
Lot Number	Optional	Text, max 100 characters JSON: lotNumber (string)	The lot number is helpful to understand possible batch specific differences in assay results. The lot number is often provided by a reagent source when the reagent is replenished over time.
Additional Result File Names	Optional	JSON: additionalResultFileNames (array)	HIPC recommends including bead level result files if they are available. Separate file names by a semi-colon (;). The file size name limit is 240 characters. HIPC recommends including bead level result files if they are available. The file size name limit is 240 characters.
Experiment ID	Required	Text, max 100 characters JSON: experimentId (string)	The experiment identifier must be stored in ImmPort or in the experiments.txt template. Please enter either an experiment user defined ID or ImmPort accession.
Study ID	Conditionally required when you are defining a new Experiment in this row (rather than referencing an existing one)	Text, max 15 characters Reference — must already exist (in this package or the workspace) as a study JSON: studyId (string)	An experiment may be linked to a single study. Please enter either a study user defined ID or ImmPort accession.
Protocol ID(s)	Conditionally required when you are defining a new Experiment in this row (rather than referencing an existing one)	Text, max 15 characters Reference — must already exist (in this package or the workspace) as a protocol JSON: protocolIds (array)	Please enter either a protocol user defined ID or ImmPort accession for a protocol that describes how the sample was derived and prepared. One or more identifiers can be entered per sample. Separate identifiers by semicolon (;). Please enter either a protocol user defined ID or ImmPort accession.
Name	Conditionally required when you are defining a new Experiment in this row (rather than referencing an existing one)	Text, max 500 characters JSON: name (string)	The experiment name is not referenced by other data records. The experiment name is an alternate identifier that is visible when the sample is shared.
Description	Optional	Text, max 4000 characters JSON: description (string)	The experiment description is used to describe details of the experiment not captured in other columns.
Measurement Technique	Conditionally required when you are defining a new Experiment in this row (rather than referencing an existing one)	Text, max 50 characters Controlled vocabulary — value must be one of lk_exp_measurement_tech JSON: measurementTechnique (enum)	The measurement technique describes the assay method. Choose from a drop down list.