ecl-logo Documentation
ECL`

LabelSample

LabelSample[Options]UnitOperation

generates an ExperimentSamplePreparation/ExperimentCellPreparation-compatible UnitOperation that labels a sample in a container for use in other primitives.

    
LabelSample prepares samples and assigns them labels that can be used in other downstream unit operations.
    

Experimental Principles

    Figure 1.1: The LabelSample and LabelContainer unit operations will fulfill requests for samples/containers either by using an existing sample/container, purchasing a sample/container from the ECL inventory, transferring an existing sample into a new requested container, or by making the sample via ExperimentStockSolution. The fulfilled sample or container can then be used downstream by referring to its assigned label.

Instrumentation

    Eppendorf Research Plus P200 | Model[Instrument, Pipette, "Eppendorf Research Plus P200"]

    Figure 2.1: The diagram above lists the available pipette sizes and corresponding tip types that are available in the ECL.

    pipetus | Model[Instrument, Pipette, "pipetus"]

    Figure 2.2: The above diagram lists the compatible serological tip sizes that are available at the ECL.

    Eppendorf Research Plus, 8-channel 100uL | Model[Instrument, Pipette, "Eppendorf Research Plus, 8-channel 100uL"]

    Figure 2.3: 1 to 8 samples can be transferred at the same time using the 8 channel pipette.

    Eppendorf Research Plus, 12-channel 1200uL | Model[Instrument, Pipette, "Eppendorf Research Plus, 12-channel 1200uL"]

    Figure 2.4: 1 to 12 samples can be transferred at the same time using the 12 channel pipette.

    HandEvac Handheld Aspirator, Tissue Culture | Model[Instrument, Aspirator, "HandEvac Handheld Aspirator, Tissue Culture"]

    Figure 2.5: The aspirator can be used to aspirate any volume from a sample using a single channel or 8 channels. Aspirators are currently only available in the BSC (both Microbial and Tissue Culture) and are used for cell culture applications.

    Mettler Toledo XP6 | Model[Instrument, Balance, "Mettler Toledo XP6"]

    Figure 2.6: Items are transferred through an ionizer, which floods the local environment with positive and negative ions. This removes any static electricity that has built up on items and provides a more stable and accurate mass reading.The user must explicitly specify the Micro-Balance using the option Instrument -> Model[Instrument,Balance,"id:54n6evKx08XN"] if so desired.

    Ohaus Pioneer PA124 | Model[Instrument, Balance, "Ohaus Pioneer PA124"]

    Figure 2.7: Items are transferred through an ionizer, which floods the local environment with positive and negative ions. This removes any static electricity that has built up on items and provides a more stable and accurate mass reading.

    Ohaus EX6202 | Model[Instrument, Balance, "Ohaus EX6202"]

    Figure 2.8: Items are transferred to the balance to obtain a mass reading.

    Full Benchtop Handling Station with Macro and Analytical Balance | Model[Instrument, HandlingStation, Ambient, "Full Benchtop Handling Station with Macro and Analytical Balance"]

    Figure 2.9: TODO: Update this text with better text about the benchtop handling station

    Full Benchtop Handling Station with Micro and Analytical Balance | Model[Instrument, HandlingStation, Ambient, "Full Benchtop Handling Station with Micro and Analytical Balance"]

    Figure 2.10: TODO: Update this text with better text about the benchtop handling station

    Benchtop Handling Station with Carboy Pumping Integrations | Model[Instrument, HandlingStation, Ambient, "Benchtop Handling Station with Carboy Pumping Integrations"]

    Figure 2.11: TODO: Update this text with better text about the benchtop handling station

    Fume Hood Handling Station with Analytical Balance | Model[Instrument, HandlingStation, FumeHood, "Fume Hood Handling Station with Analytical Balance"]

    Figure 2.12: Fuming samples are automatically routed to use a fume hood as the TransferEnvironment in ExperimentTransfer. Airflow velocity in the fume hood is tracked by ECL Constellation and can be viewed by inspecting the instrument object.

    Fume Hood Handling Station with Macro Balance | Model[Instrument, HandlingStation, FumeHood, "Fume Hood Handling Station with Macro Balance"]

    Figure 2.13: Fuming samples are automatically routed to use a fume hood as the TransferEnvironment in ExperimentTransfer. Airflow velocity in the fume hood is tracked by ECL Constellation and can be viewed by inspecting the instrument object.

    Fume Hood Handling Station with Schlenk Line | Model[Instrument, HandlingStation, FumeHood, "Fume Hood Handling Station with Schlenk Line"]

    Figure 2.14: Fuming samples are automatically routed to use a fume hood as the TransferEnvironment in ExperimentTransfer. Airflow velocity in the fume hood is tracked by ECL Constellation and can be viewed by inspecting the instrument object.

    Fume Hood Handling Station with Carboy Pumping Integrations | Model[Instrument, HandlingStation, FumeHood, "Fume Hood Handling Station with Carboy Pumping Integrations"]

    Figure 2.15: Fuming samples are automatically routed to use a fume hood as the TransferEnvironment in ExperimentTransfer. Airflow velocity in the fume hood is tracked by ECL Constellation and can be viewed by inspecting the instrument object.

    Fumehood with pHMeter | Model[Instrument, HandlingStation, FumeHood, "Fumehood with pHMeter"]

    Figure 2.16: Fuming samples are automatically routed to use a fume hood as the TransferEnvironment in ExperimentTransfer. Airflow velocity in the fume hood is tracked by ECL Constellation and can be viewed by inspecting the instrument object.

    Biosafety Cabinet Handling Station for Tissue Culture | Model[Instrument, HandlingStation, BiosafetyCabinet, "Biosafety Cabinet Handling Station for Tissue Culture"]

    Figure 2.17: A biosafety cabinet will be used when transfering into/out of mammalian cell samples. The BSCs at ECL is equipped with 1) a GoPro Camera for protocol streaming, 2) a scanner, a monitor, and footpedals for performing tasks hands-free. The Tissue Culture BSC is additionally equipped with an aspirator system. The Tissue Culture BSC surface is divided into a Clean Zone, a Working Zone, and a Dirty Zone. Microbial samples must be handeled in the Microbial BSC and Tissue Culture samples must be handeled in the Tissue Culture BSC (specified by the CultureHandling field in the Model[Instrument, BiosafetyCabinet])

    Biosafety Cabinet Handling Station for Microbiology | Model[Instrument, HandlingStation, BiosafetyCabinet, "Biosafety Cabinet Handling Station for Microbiology"]

    Biosafety Cabinet Handling Station with Analytical Balance | Model[Instrument, HandlingStation, BiosafetyCabinet, "Biosafety Cabinet Handling Station with Analytical Balance"]

    Figure 2.19: A biosafety cabinet will be used when transfering into/out of aseptic samples. Microbial samples are handeled in the Microbial BSC and Tissue Culture samples are handeled in the Tissue Culture BSC (specified by the CultureHandling field in the Model[Instrument, BiosafetyCabinet]). This BSC is only for general aseptic transfers not involving live cells. All aseptic transfer biosafety cabinets have a full set of micropipettes, serological pipette, sterile cooler, sterile heater, aspirator, and analytical balance.

    Nitrogen Glove Box Handling Station with Analytical Balance | Model[Instrument, HandlingStation, GloveBox, "Nitrogen Glove Box Handling Station with Analytical Balance"]

    Figure 2.20: Fuming samples are automatically routed to use a fume hood as the TransferEnvironment in ExperimentTransfer. Airflow velocity in the fume hood is tracked by ECL Constellation and can be viewed by inspecting the instrument object.

    Main Lab Portable Heater | Model[Instrument, PortableHeater, "Main Lab Portable Heater"]

    Figure 2.21: Containers are placed in the main compartment of the portable heater. The portable heater is filled with lab armor beads to ensure that the entire container is heated to the correct temperature.

    ICECO GO20 Portable Refrigerator | Model[Instrument, PortableCooler, "ICECO GO20 Portable Refrigerator"]

    Figure 2.22: Containers are placed in the main compartment of the portable cooler. The portable cooler is filled with lab armor beads to ensure that the entire container is chilled to the correct temperature.

Experiment Options

    General

    Label

    The label of the samples that are to be prepared.
    Default Value: Null
    Pattern Description: A string or Null.
    Programmatic Pattern: _String
    Index Matches to: Label

    Restricted

    Indicates whether the sample should be restricted from automatic use is any of your team's experiments that request the sample's models. (Restricted samples can only be used in experiments when specifically provided as input to the experiment functions by a team member). Setting the option to Null means the sample should be untouched. Setting the option to True or False will set the Restricted field of the sample to that value respectively.
    Default Value: Null
    Pattern Description: True or False or Null.
    Programmatic Pattern: (Null | BooleanP) | Null
    Index Matches to: Label

    Sample

    The sample that should be labeled by this primitive.
    Default Value: Automatic
    Default Calculation: Automatically set from the Container, if that option is specified.
    Pattern Description: Container with Well Position or Sample Model or Sample Object.
    Programmatic Pattern: (ObjectP[{Model[Sample]}] | (ObjectP[{Object[Sample]}] | _String) | {Alternatives @@ Flatten[AllWells[NumberOfWells -> 384]] | LocationPositionP, ObjectP[{Object[Container]}] | _String}) | Automatic
    Index Matches to: Label

    Container

    The container object of the sample that is to be labeled.
    Default Value: Automatic
    Default Calculation: Automatically resolves to an Object[Container] if an Object[Sample] is specified. Otherwise, automatically resolves to a Model[Container] on any existing samples that can be used to fulfill the Model[Sample] request or based on the container that the default product for the Model[Sample] comes in.
    Pattern Description: Existing Container or Single Container Model.
    Programmatic Pattern: ((ObjectP[Object[Container]] | _String) | ObjectP[Model[Container]]) | Automatic
    Index Matches to: Label

    Well

    The well of the container that the Object[Sample] is already in.
    Default Value: Automatic
    Default Calculation: Automatically resolves from the Sample if it is an Object[Sample].
    Pattern Description: A string that matches the pattern: WellPositionP.
    Programmatic Pattern: WellPositionP | Automatic
    Index Matches to: Label

    ContainerLabel

    The label to assign to the container that is used for the sample.
    Default Value: Null
    Pattern Description: A string or Null.
    Programmatic Pattern: (Null | _String) | Null
    Index Matches to: Label

    Amount

    The requested amount of the Model[Sample] to put in the specified Container.
    Default Value: Automatic
    Default Calculation: Automatically set based on the usage of the sample label in other primitives.
    Pattern Description: Count or Mass or Volume or Null.
    Programmatic Pattern: ((Null | (GreaterP[0*Milligram] | GreaterP[0*Milliliter] | GreaterEqualP[1, 1])) | Automatic) | Null
    Index Matches to: Label

    ExactAmount

    Indicates that an Object[Sample] with the exact Amount specified (+/- Tolerance) should be picked in the lab. If set to False, existing samples with an amount greater than or equal to the amount requested can be used. ExactAmount should be set to True if you are depending on the sample having an exact volume/mass/count in the lab. However, if you're just transferring out of this sample and don't care about its exact volume, setting ExactAmount->False will save time in the lab (the exact amount doesn't need to first be aliquotted out).
    Default Value: Automatic
    Default Calculation: Automatically set to True if the sample has FixedAmounts or if the user has manually specified the Amount option.
    Pattern Description: True or False or Null.
    Programmatic Pattern: ((Null | BooleanP) | Automatic) | Null
    Index Matches to: Label

    Tolerance

    The allowed tolerance when preparing the specified Amount of sample. This option can only be set if ExactAmount is set to True.
    Default Value: Automatic
    Default Calculation: Automatically set to 1% of the requested Amount if ExactAmount is set to True.
    Pattern Description: Count or Mass or Percent Tolerance or Volume or Null.
    Programmatic Pattern: ((Null | (GreaterP[0*Milligram] | GreaterP[0*Milliliter] | GreaterEqualP[1, 1] | RangeP[0*Percent, 100*Percent])) | Automatic) | Null
    Index Matches to: Label

    Density

    Indicates the known density of the sample being labeled at room temperature. By setting upfront, this allows ECL to skip measuring the density later.
    Default Value: Null
    Pattern Description: Greater than 0 grams per milliliter or Null.
    Programmatic Pattern: (Null | GreaterP[(0*Gram)/Milliliter]) | Null
    Index Matches to: Label

    Preparation

    Indicates if this unit operation is carried out primarily robotically or manually. Manual unit operations are executed by a laboratory operator and robotic unit operations are executed by a liquid handling work cell.
    Default Value: Automatic
    Pattern Description: Manual or Robotic.
    Programmatic Pattern: PreparationMethodP | Automatic

    Health & Safety

    SampleModel

    Specifies the model of the given sample. This option should only be used if you want to override the default Model[Sample] of your labeled sample.
    Default Value: Null
    Pattern Description: An object of type or subtype Model[Sample] or Null.
    Programmatic Pattern: (Null | ObjectP[Model[Sample]]) | Null
    Index Matches to: Label

    Composition

    Specifies molecular composition of this sample. This option should only be used if you want to override the automatically calculated Composition of your labeled sample.
    Default Value: Null
    Pattern Description: List of one or more {Amount, Identity Model} entries or Null.
    Programmatic Pattern: (Null | {{(GreaterP[0*Molar] | GreaterP[0*(Gram/Liter)] | RangeP[0*VolumePercent, 100*VolumePercent] | RangeP[0*MassPercent, 100*MassPercent] | RangeP[0*PercentConfluency, 100*PercentConfluency] | GreaterP[0*(Cell/Liter)] | GreaterP[0*(CFU/Liter)] | GreaterP[0*OD600] | GreaterP[0*Colony]) | Null, ObjectP[List @@ IdentityModelTypeP] | Null}..}) | Null
    Index Matches to: Label

    Acid

    Indicates if this entity forms strongly acidic solutions when dissolved in water (typically pKa <= 4) and requires secondary containment during storage.
    Default Value: Automatic
    Default Calculation: If modifying an existing object, automatically set to match the field value of Acid.
    Pattern Description: True or False or Null.
    Programmatic Pattern: ((Null | BooleanP) | Automatic) | Null
    Index Matches to: Label

    Anhydrous

    Indicates if this sample does not contain water.
    Default Value: Automatic
    Default Calculation: If creating a new object, Automatic resolves to Null. For existing objects, Automatic resolves to the current field value.
    Pattern Description: True or False or Null.
    Programmatic Pattern: ((Null | BooleanP) | Automatic) | Null
    Index Matches to: Label

    AsepticHandling

    Indicates if aseptic techniques are followed for this sample. Aseptic techniques include sanitization, autoclaving, sterile filtration, mixing exclusively sterile components, and transferring in a biosafety cabinet during experimentation and storage.
    Default Value: Automatic
    Default Calculation: If creating a new object, Automatic resolves to Null. For existing objects, Automatic resolves to the current field value.
    Pattern Description: True or False or Null.
    Programmatic Pattern: ((Null | BooleanP) | Automatic) | Null
    Index Matches to: Label

    AutoclaveUnsafe

    Indicates if this sample cannot be safely autoclaved.
    Default Value: Automatic
    Default Calculation: If creating a new object, Automatic resolves to Null. For existing objects, Automatic resolves to the current field value.
    Pattern Description: True or False or Null.
    Programmatic Pattern: ((Null | BooleanP) | Automatic) | Null
    Index Matches to: Label

    Base

    Indicates if this entity forms strongly basic solutions when dissolved in water (typically pKaH >= 11) and requires secondary containment during storage.
    Default Value: Automatic
    Default Calculation: If modifying an existing object, automatically set to match the field value of Base.
    Pattern Description: True or False or Null.
    Programmatic Pattern: ((Null | BooleanP) | Automatic) | Null
    Index Matches to: Label

    BiosafetyLevel

    The Biosafety classification of this entity.
    Default Value: Automatic
    Default Calculation: If modifying an existing object, automatically set to match the field value of BiosafetyLevel.
    Pattern Description: BSL-1, BSL-2, BSL-3, or BSL-4 or Null.
    Programmatic Pattern: ((Null | BiosafetyLevelP) | Automatic) | Null
    Index Matches to: Label

    CellType

    The primary types of cells that are contained within this sample.
    Default Value: Automatic
    Default Calculation: If creating a new object, Automatic resolves to Null. For existing objects, Automatic resolves to the current field value.
    Pattern Description: Mammalian, Plant, Insect, Fungal, Yeast, or Bacterial or Null.
    Programmatic Pattern: ((Null | CellTypeP) | Automatic) | Null
    Index Matches to: Label

    CultureAdhesion

    The type of cell culture that is currently being performed to grow these cells.
    Default Value: Automatic
    Default Calculation: If creating a new object, Automatic resolves to Null. For existing objects, Automatic resolves to the current field value.
    Pattern Description: Adherent, Suspension, or SolidMedia or Null.
    Programmatic Pattern: ((Null | CultureAdhesionP) | Automatic) | Null
    Index Matches to: Label

    DOTHazardClass

    The Department of Transportation hazard classification of this entity.
    Default Value: Automatic
    Default Calculation: If modifying an existing object, automatically set to match the field value of DOTHazardClass.
    Pattern Description: Class 0, Class 1 Division 1.1 Mass Explosion Hazard, Class 1 Division 1.2 Projection Hazard, Class 1 Division 1.3 Fire, Blast, or Projection Hazard, Class 1 Division 1.4 Limited Explosion, Class 1 Division 1.5 Insensitive Mass Explosion Hazard, Class 1 Division 1.6 Insensitive No Mass Explosion Hazard, Class 2 Division 2.1 Flammable Gas Hazard, Class 2 Division 2.2 Non-Flammable Gas Hazard, Class 2 Division 2.3 Toxic Gas Hazard, Class 3 Flammable Liquids Hazard, Class 4 Division 4.1 Flammable Solid Hazard, Class 4 Division 4.2 Spontaneously Combustible Hazard, Class 4 Division 4.3 Dangerous when Wet Hazard, Class 5 Division 5.1 Oxidizers Hazard, Class 5 Division 5.2 Organic Peroxides Hazard, Class 6 Division 6.1 Toxic Substances Hazard, Class 6 Division 6.2 Infectious Substances Hazard, Class 7 Division 7 Radioactive Material Hazard, Class 8 Division 8 Corrosives Hazard, or Class 9 Miscellaneous Dangerous Goods Hazard or Null.
    Programmatic Pattern: ((Null | DOTHazardClassP) | Automatic) | Null
    Index Matches to: Label

    DoubleGloveRequired

    Indicates if working with samples of this entity requires wearing two pairs of gloves.
    Default Value: Automatic
    Default Calculation: If modifying an existing object, automatically set to match the field value of DoubleGloveRequired.
    Pattern Description: True or False or Null.
    Programmatic Pattern: ((Null | BooleanP) | Automatic) | Null
    Index Matches to: Label

    DrainDisposal

    Indicates if pure samples of this entity may be safely disposed down a standard drain.
    Default Value: Automatic
    Default Calculation: If modifying an existing object, automatically set to match the field value of DrainDisposal.
    Pattern Description: True or False or Null.
    Programmatic Pattern: ((Null | BooleanP) | Automatic) | Null
    Index Matches to: Label

    ExpirationDate

    Date after which this sample is considered expired and users will be warned about using it in protocols.
    Default Value: Automatic
    Default Calculation: If creating a new object, Automatic resolves to Null. For existing objects, Automatic resolves to the current field value.
    Pattern Description: A valid date or Null.
    Programmatic Pattern: ((Null | _?DateObjectQ) | Automatic) | Null
    Index Matches to: Label

    ExpirationHazard

    Indicates if pure samples of this entity become hazardous once they are expired and must be automatically disposed of when they pass their expiration date.
    Default Value: Automatic
    Default Calculation: If modifying an existing object, automatically set to match the field value of ExpirationHazard.
    Pattern Description: True or False or Null.
    Programmatic Pattern: ((Null | BooleanP) | Automatic) | Null
    Index Matches to: Label

    Flammable

    Indicates if pure samples of this entity are easily set aflame under standard conditions. This corresponds to NFPA rating of 3 or greater.
    Default Value: Automatic
    Default Calculation: If modifying an existing object, automatically set to match the field value of Flammable.
    Pattern Description: True or False or Null.
    Programmatic Pattern: ((Null | BooleanP) | Automatic) | Null
    Index Matches to: Label

    Fuming

    Indicates if pure samples of this entity emit fumes spontaneously when exposed to air.
    Default Value: Automatic
    Default Calculation: If modifying an existing object, automatically set to match the field value of Fuming.
    Pattern Description: True or False or Null.
    Programmatic Pattern: ((Null | BooleanP) | Automatic) | Null
    Index Matches to: Label

    InertHandling

    Indicates if this sample must be handled in a glove box.
    Default Value: Automatic
    Default Calculation: If creating a new object, Automatic resolves to Null. For existing objects, Automatic resolves to the current field value.
    Pattern Description: True or False or Null.
    Programmatic Pattern: ((Null | BooleanP) | Automatic) | Null
    Index Matches to: Label

    MSDSFile

    A PDF file of the MSDS (Materials Safety Data Sheet) of this entity.
    Default Value: Automatic
    Default Calculation: For existing objects, automatically set to match the field value of MSDSFile.
    Pattern Description: Declare Non-Hazardous or EmeraldCloudFile or File Path or URL or Null.
    Programmatic Pattern: ((Null | (NotApplicable | URLP | FilePathP | ObjectP[Object[EmeraldCloudFile]])) | Automatic) | Null
    Index Matches to: Label

    NFPA

    The National Fire Protection Association (NFPA) 704 hazard diamond classification for the entity. The NFPA diamond standard is maintained by the United States National Fire Protection Association and summarizes, clockwise from top, Fire Hazard, Reactivity, Specific Hazard and Health Hazard of a substance.
    Default Value: Automatic
    Default Calculation: If modifying an existing object, automatically set to match the field value of NFPA.
    Pattern Description: {Health, Flammability, Reactivity, Special} or Null.
    Programmatic Pattern: ((Null | {0 | 1 | 2 | 3 | 4, 0 | 1 | 2 | 3 | 4, 0 | 1 | 2 | 3 | 4, DuplicateFreeListableP[Oxidizer | WaterReactive | Aspyxiant | Corrosive | Acid | Bio | Poisonous | Radioactive | Cryogenic | Null] | {}}) | Automatic) | Null
    Index Matches to: Label

    NucleicAcidFree

    Indicates if this sample is presently considered to be not contaminated with DNA and RNA.
    Default Value: Automatic
    Default Calculation: If creating a new object, Automatic resolves to Null. For existing objects, Automatic resolves to the current field value.
    Pattern Description: True or False or Null.
    Programmatic Pattern: ((Null | BooleanP) | Automatic) | Null
    Index Matches to: Label

    ParticularlyHazardousSubstance

    Indicates if exposure to samples of this entity has the potential to cause serious and lasting harm. A substance is considered particularly harmful if it is categorized by any of the following GHS classifications (as found on a MSDS): Reproductive Toxicity (H340, H360, H362), Acute Toxicity (H300, H310, H330, H370, H371, H372, H373), Carcinogenicity (H350). Note that PHS designation primarily describes toxicity hazard and doesn't include other types of hazard such as water reactivity or being pyrophoric.
    Default Value: Automatic
    Default Calculation: If modifying an existing object, automatically set to match the field value of ParticularlyHazardousSubstance.
    Pattern Description: True or False or Null.
    Programmatic Pattern: ((Null | BooleanP) | Automatic) | Null
    Index Matches to: Label

    Pungent

    Indicates if pure samples of this entity have a strong odor.
    Default Value: Automatic
    Default Calculation: If modifying an existing object, automatically set to match the field value of Pungent.
    Pattern Description: True or False or Null.
    Programmatic Pattern: ((Null | BooleanP) | Automatic) | Null
    Index Matches to: Label

    PyrogenFree

    Indicates if this sample is presently considered to be not contaminated with endotoxin.
    Default Value: Automatic
    Default Calculation: If creating a new object, Automatic resolves to Null. For existing objects, Automatic resolves to the current field value.
    Pattern Description: True or False or Null.
    Programmatic Pattern: ((Null | BooleanP) | Automatic) | Null
    Index Matches to: Label

    Pyrophoric

    Indicates if pure samples of this entity can ignite spontaneously upon exposure to air.
    Default Value: Automatic
    Default Calculation: If modifying an existing object, automatically set to match the field value of Pyrophoric.
    Pattern Description: True or False or Null.
    Programmatic Pattern: ((Null | BooleanP) | Automatic) | Null
    Index Matches to: Label

    Radioactive

    Indicates if pure samples of this entity emit substantial ionizing radiation.
    Default Value: Automatic
    Default Calculation: If modifying an existing object, automatically set to match the field value of Radioactive.
    Pattern Description: True or False or Null.
    Programmatic Pattern: ((Null | BooleanP) | Automatic) | Null
    Index Matches to: Label

    RNaseFree

    Indicates that this sample is free of any RNases.
    Default Value: Automatic
    Default Calculation: If creating a new object, Automatic resolves to Null. For existing objects, Automatic resolves to the current field value.
    Pattern Description: True or False or Null.
    Programmatic Pattern: ((Null | BooleanP) | Automatic) | Null
    Index Matches to: Label

    SampleHandling

    The method by which this sample should be manipulated in the lab when transfers out of the sample are requested.
    Default Value: Automatic
    Default Calculation: If creating a new object, Automatic resolves to Null. For existing objects, Automatic resolves to the current field value.
    Pattern Description: Liquid, Slurry, Powder, Itemized, Viscous, Paste, Brittle, Fabric, or Fixed or Null.
    Programmatic Pattern: ((Null | SampleHandlingP) | Automatic) | Null
    Index Matches to: Label

    State

    The physical state of the sample when well solvated at room temperature and pressure.
    Default Value: Automatic
    Default Calculation: If creating a new object, Automatic resolves to Null. For existing objects, Automatic resolves to the current field value.
    Pattern Description: Solid, Liquid, or Gas or Null.
    Programmatic Pattern: ((Null | (Solid | Liquid | Gas)) | Automatic) | Null
    Index Matches to: Label

    Sterile

    Indicates that this sample arrives free of both microbial contamination and any microbial cell samples from the manufacturer, or is prepared free of both microbial contamination and any microbial cell samples by employing autoclaving, sterile filtration, or mixing exclusively sterile components with aseptic techniques during experimentation and storage.
    Default Value: Automatic
    Default Calculation: If creating a new object, Automatic resolves to Null. For existing objects, Automatic resolves to the current field value.
    Pattern Description: True or False or Null.
    Programmatic Pattern: ((Null | BooleanP) | Automatic) | Null
    Index Matches to: Label

    Ventilated

    Indicates if pure samples of this entity must be handled in an enclosure where airflow is used to reduce exposure of the user to the substance and contaminated air is exhausted in a safe location. Samples may need to be ventilated if they are, for example, pungent, fuming or hazardous.
    Default Value: Automatic
    Default Calculation: If modifying an existing object, automatically set to match the field value of Ventilated.
    Pattern Description: True or False or Null.
    Programmatic Pattern: ((Null | BooleanP) | Automatic) | Null
    Index Matches to: Label

    WaterReactive

    Indicates if pure samples of this entity react spontaneously upon exposure to water.
    Default Value: Automatic
    Default Calculation: If modifying an existing object, automatically set to match the field value of WaterReactive.
    Pattern Description: True or False or Null.
    Programmatic Pattern: ((Null | BooleanP) | Automatic) | Null
    Index Matches to: Label

    Storage Information

    StorageCondition

    The condition in which this sample gets stored in when not used by an experiment.
    Default Value: Automatic
    Default Calculation: If creating a new object, Automatic resolves to Null. For existing objects, Automatic resolves to the current field value.
    Pattern Description: {AmbientStorage, EnclosedAmbientStorage, Refrigerator, Freezer, DeepFreezer, CryogenicStorage, YeastIncubation, YeastShakingIncubation, BacterialIncubation, BacterialShakingIncubation, MammalianIncubation, ViralIncubation, CrystalIncubation, AcceleratedTesting, IntermediateTesting, LongTermTesting, UVVisLightTesting} or Disposal or an object of type or subtype Model[StorageCondition] or Null.
    Programmatic Pattern: ((Null | ((SampleStorageTypeP | Disposal) | ObjectP[Model[StorageCondition]])) | Automatic) | Null
    Index Matches to: Label

    AsepticTransportContainerType

    Indicates how this sample is contained in an aseptic barrier and if it needs to be unbagged before being used in a protocol, maintenance, or qualification.
    Default Value: Automatic
    Default Calculation: If creating a new object, Automatic resolves to Null. For existing objects, Automatic resolves to the current field value.
    Pattern Description: Individual or Bulk or Null.
    Programmatic Pattern: ((Null | AsepticTransportContainerTypeP) | Automatic) | Null
    Index Matches to: Label

    Expires

    Indicates if samples of this model expire after a given amount of time.
    Default Value: Automatic
    Default Calculation: If creating a new object, Automatic resolves to Null. For existing objects, Automatic resolves to the current field value.
    Pattern Description: True or False or Null.
    Programmatic Pattern: ((Null | BooleanP) | Automatic) | Null
    Index Matches to: Label

    LightSensitive

    Indicates if the samples of this entity reacts or degrades in the presence of light and requires storage in the dark.
    Default Value: Automatic
    Default Calculation: If modifying an existing object, automatically set to match the field value of LightSensitive.
    Pattern Description: True or False or Null.
    Programmatic Pattern: ((Null | BooleanP) | Automatic) | Null
    Index Matches to: Label

    ShelfLife

    The length of time after DateCreated that samples of this model are recommended for use before they should be discarded.
    Default Value: Automatic
    Default Calculation: If creating a new object, Automatic resolves to Null. For existing objects, Automatic resolves to the current field value.
    Pattern Description: Greater than 0 days or Null.
    Programmatic Pattern: ((Null | GreaterP[0*Day]) | Automatic) | Null
    Index Matches to: Label

    TransferTemperature

    The temperature that this sample should be at before any transfers using this sample occur.
    Default Value: Automatic
    Default Calculation: If creating a new object, Automatic resolves to Null. For existing objects, Automatic resolves to the current field value.
    Pattern Description: Greater than or equal to 4 degrees Celsius and less than or equal to 90 degrees Celsius or Null.
    Programmatic Pattern: ((Null | RangeP[4*Celsius, 90*Celsius]) | Automatic) | Null
    Index Matches to: Label

    TransportTemperature

    The temperature that this sample should be heated or refrigerated while transported between instruments during experimentation.
    Default Value: Automatic
    Default Calculation: If creating a new object, Automatic resolves to Null. For existing objects, Automatic resolves to the current field value.
    Pattern Description: Greater than or equal to -86 degrees Celsius and less than or equal to 10 degrees Celsius or greater than or equal to 30 degrees Celsius and less than or equal to 105 degrees Celsius or Null.
    Programmatic Pattern: ((Null | (RangeP[-86*Celsius, 10*Celsius] | RangeP[30*Celsius, 105*Celsius])) | Automatic) | Null
    Index Matches to: Label

    UnsealedShelfLife

    The length of time after DateUnsealed that samples of this model are recommended for use before they should be discarded.
    Default Value: Automatic
    Default Calculation: If creating a new object, Automatic resolves to Null. For existing objects, Automatic resolves to the current field value.
    Pattern Description: Greater than 0 days or Null.
    Programmatic Pattern: ((Null | GreaterP[0*Day]) | Automatic) | Null
    Index Matches to: Label

    Compatibility

    GloveBoxBlowerIncompatible

    Indicates that the glove box blower must be turned off to prevent damage to the catalyst in the glove box that is used to remove traces of water and oxygen, when manipulating this sample inside of the glove box.
    Default Value: Automatic
    Default Calculation: If creating a new object, Automatic resolves to Null. For existing objects, Automatic resolves to the current field value.
    Pattern Description: True or False or Null.
    Programmatic Pattern: ((Null | BooleanP) | Automatic) | Null
    Index Matches to: Label

    GloveBoxIncompatible

    Indicates if this sample cannot be used inside of the glove box due high volatility and/or detrimental reactivity with the catalyst in the glove box that is used to remove traces of water and oxygen. Sulfur and sulfur compounds (such as H2S, RSH, COS, SO2, SO3), halides, halogen (Freon), alcohols, hydrazine, phosphene, arsine, arsenate, mercury, and saturation with water may deactivate the catalyst.
    Default Value: Automatic
    Default Calculation: If creating a new object, Automatic resolves to Null. For existing objects, Automatic resolves to the current field value.
    Pattern Description: True or False or Null.
    Programmatic Pattern: ((Null | BooleanP) | Automatic) | Null
    Index Matches to: Label

    IncompatibleMaterials

    A list of materials that would be damaged if wetted by samples of this entity.
    Default Value: Automatic
    Default Calculation: If modifying an existing object, automatically set to match the field value of IncompatibleMaterials.
    Pattern Description: List of one or more None, ABS, PLA, Acrylic, AmorphousFluoropolymer, CPVC, CTFE, Cycloolefine, COC, Delrin, ECTFE, EPDM, ETFE, EVA, FEP, FFKM, HDPE, Hypalon, LDPE, NaturalRubber, NBR, Neoprene, Nitrile, Noryl, Nylon, PEEK, PEI, Perlast, PharmaPure, Polycarbonate, Polyester, Polyethylene, Polyisoprene, Polyolefin, Polyoxymethylene, Polypropylene, Polysulfone, Polystyrene, Polyurethane, PVC, PCTFE, PETG, PF, PFA, PPS, PTFE, PVDF, SEBS, Silicone, Styrofoam, SyntheticRubber, TFM, TPE, Tygon, UVPlastic, UVXPO, Viton, Aluminum, Alloy, AnodisedAluminum, Brass, Bronze, CarbonSteel, CastIron, Chrome, Copper, Elgiloy, Gold, Hastelloy, Lead, Magnesium, Molybdenum, MP35N, MP35NHPS, Nickel, Niobium, Platinum, Silver, Steel, StainlessSteel, Titanium, Tungsten, Zinc, Cellulose, Cotton, Polyethylene, Polypropylene, PTFE, wwPTFE, Nylon, PES, PLUS, PVDF, GlassFiber, GHP, UHMWPE, EPDM, DuraporePVDF, GxF, ZebaDesaltingResin, NickelResin, AgaroseResin, CobaltResin, Silica, HLB, AnoporeAlumina, Silica, Alumina, ResinParticlesWithLatexMicroBeads, CrossLinkedDextranBeads, CrossLinkedPolystyrene, AerisCoreShell, KinetexCoreShell, CrossLinkedAgarose, Vydac218MS, JordiGel, Styrene, SilicaCompositeTWIN, BEH, CSH, HSS, CarboPacPA1, CarboPacPA10, BEH, AluminiumOxide, ZirconiumOxide, Ceramic, Epoxy, EpoxyResin, GlassyCarbon, BorosilicateGlass, Glass, OpticalGlass, Graphite, Porcelain, Oxidizer, Cardboard, Wood, Agate, Quartz, UVQuartz, ESQuartz, FusedQuartz, IRQuartz, Ruby, Sapphire, Silicon, Viton, or VacuumMeltedStainlessSteel entries or Null.
    Programmatic Pattern: ((Null | {Flatten[None | MaterialP]..}) | Automatic) | Null
    Index Matches to: Label

    LiquidHandlerIncompatible

    Indicates if pure samples of this entity cannot be reliably aspirated or dispensed on an automated liquid handling robot. Substances may be incompatible if they have a low boiling point, readily producing vapor, are highly viscous or are chemically incompatible with all tip types.
    Default Value: Automatic
    Default Calculation: If modifying an existing object, automatically set to match the field value of LiquidHandlerIncompatible.
    Pattern Description: True or False or Null.
    Programmatic Pattern: ((Null | BooleanP) | Automatic) | Null
    Index Matches to: Label

    PipettingMethod

    The default parameters describing how pure samples of this entity should be manipulated by pipette, such as aspiration and dispensing rates. These parameters may be overridden when creating experiments.
    Default Value: Automatic
    Default Calculation: If modifying an existing object, automatically set to match the field value of PipettingMethod.
    Pattern Description: An object of type or subtype Model[Method, Pipetting] or Null.
    Programmatic Pattern: ((Null | ObjectP[Model[Method, Pipetting]]) | Automatic) | Null
    Index Matches to: Label

    UltrasonicIncompatible

    Indicates if volume measurements of pure samples of this entity cannot be performed via the ultrasonic distance method due to vapors interfering with the reading.
    Default Value: Automatic
    Default Calculation: If modifying an existing object, automatically set to match the field value of UltrasonicIncompatible.
    Pattern Description: True or False or Null.
    Programmatic Pattern: ((Null | BooleanP) | Automatic) | Null
    Index Matches to: Label

Example Calls

    Basic Examples

    Label a Milli-Q water sample in a 50mL tube, then use that sample in a transfer:
    Request that 20mL of 15 mM ammonium acetate is made in a 50mL tube. Then, mix that sample:
    Several samples can be requested in the same unit operation:
    Override the safety information for a sample that is coming out of the Transfer unit operation:
    If the Container option isn't specified, it will automatically be set to the smallest Preferred Container that can hold the requested amount of sample:
    The ExactAmount option is an advanced option that indicates that a sample with a precise Amount must be used for the experiment. If this option is set to False, a sample with MORE than the requested Amount of volume/mass/count can be used by LabelSample (ex. one already exists in inventory) - this can save time in the lab by reducing unnecessary transfers. When the Amount option is set explicitly by the user, the ExactAmount option is always automatically set to True. The criteria of what counts as an "exact match" can also be controlled using the Tolerance option. The following LabelSample unit operation will request for a water sample in a 50mL tube that contains 5mL +/- 10 uL.

Preferred Input Containers

    LabelSample can prepare samples in any container supported by the ECL. However, it is recommended to use an ECL preferred container to maximize compatibility with other downstream unit operations.

Warnings and Errors

    Messages
Last modified on Tue 6 Jan 2026 09:22:28