ecl-logo Documentation

Object[Transaction, ShipToUser]

Objects for tracking the transactions of experimental materials from ECL facilities

Organizational Information

    Name

    Name of this Object.
    Format: Single
    Class: String
    Programmatic Pattern: _String
    Pattern Description: A string.

    ID

    ID of this Object.
    Format: Single
    Class: String
    Programmatic Pattern: _String
    Pattern Description: The ID of this object.

    Object

    Object of this Object.
    Format: Single
    Class: Expression
    Programmatic Pattern: Object[Transaction, ShipToUser, _String]
    Pattern Description: The object reference of this object.

    Type

    Type of this Object.
    Format: Single
    Class: Expression
    Programmatic Pattern: Object[Transaction, ShipToUser]
    Pattern Description: Object[Transaction, ShipToUser]

    Notebook

    Notebook this object belongs to.
    Format: Single
    Class: Link
    Programmatic Pattern: _Link
    Pattern Description: An object of that matches ObjectP[Object[LaboratoryNotebook]].

    Creator

    User who created this transaction.
    Format: Single
    Class: Link
    Programmatic Pattern: _Link

    DateShipped

    Date that the items were shipped from the Source to the Destination.
    Format: Single
    Class: Date
    Programmatic Pattern: _?DateObjectQ

    DateExpected

    Date that the items are expected to reach their destination.
    Format: Single
    Class: Date
    Programmatic Pattern: _?DateObjectQ

    DateDelivered

    Date that the items arrived at their destination.
    Format: Single
    Class: Date
    Programmatic Pattern: _?DateObjectQ

    DateCanceled

    Date that the transaction was canceled.
    Format: Single
    Class: Date
    Programmatic Pattern: _?DateObjectQ

    Status

    An indication of whether the transaction has shipped or is pending or if it has encountered troubleshooting.
    Format: Single
    Class: Expression
    Programmatic Pattern: ReturningStatusP

    SamplesIn

    The samples given as input to this transaction.
    Format: Multiple
    Class: Link
    Programmatic Pattern: _Link

    ContainersIn

    The containers of the input samples for this transaction.
    Format: Multiple
    Class: Link
    Programmatic Pattern: _Link

    SamplesOut

    The samples (either the samples in or the aliquoted samples) shipped from ECL to the user in this transaction.
    Format: Multiple
    Class: Link
    Programmatic Pattern: _Link

    ContainersOut

    The containers shipped from ECL to the user in this transaction.
    Format: Multiple
    Class: Link
    Programmatic Pattern: _Link

Shipping Information

    Destination

    The site where objects from this transaction will be shipped.
    Format: Single
    Class: Link
    Programmatic Pattern: _Link

    Source

    The site or supplier where samples from this transaction are shipped from.
    Format: Single
    Class: Link
    Programmatic Pattern: _Link

    Shipper

    The shipping company used to deliver the items of this transaction to their final destination.
    Format: Single
    Class: Link
    Programmatic Pattern: _Link

    TrackingNumbers

    Tracking numbers provided by the shipping company for the transaction.
    Format: Multiple
    Class: String
    Programmatic Pattern: _String

    ColdPacking

    Indicates that the transaction includes samples that must be shipped cold.
    Format: Single
    Class: Expression
    Programmatic Pattern: ColdPackingP

    ShippingSpeed

    The delivery speed selected with the shipper of this transaction.
    Format: Single
    Class: Expression
    Programmatic Pattern: ShippingSpeedP

    Orders

    The order that recorded the ordering detail of the samples directly shipped to the user upon purchase.
    Format: Single
    Class: Link
    Programmatic Pattern: _Link

    ShippingPreparation

    The maintenance that prepared the samples in this transaction for shipment.
    Format: Single
    Class: Link
    Programmatic Pattern: _Link

    ShippingContainers

    The packages containing the samples that are shipped by this transaction.
    Format: Multiple
    Class: Link
    Programmatic Pattern: _Link

    SecondaryContainers

    Any bags used as secondary containment for samples that are shipped in this transaction.
    Format: Multiple
    Class: Link
    Programmatic Pattern: _Link

    PlateSeals

    Any plate seals used to seal plates for more secure shipment in this transaction.
    Format: Multiple
    Class: Link
    Programmatic Pattern: _Link

    Ice

    If this transaction specifies ColdPacking as Ice, the ice packs used to keep the samples cold during shipment.
    Format: Multiple
    Class: Link
    Programmatic Pattern: _Link

    DryIce

    If this transaction specifies ColdPacking as DryIce, the dry ice used to keep the samples cold during shipment.
    Format: Multiple
    Class: Link
    Programmatic Pattern: _Link

    Padding

    If this transaction specifies ColdPacking as Null, the padding used to protect the samples during shipment.
    Format: Multiple
    Class: Link
    Programmatic Pattern: _Link

    DryIceMasses

    For each member of ShippingContainers, the mass of dry ice used to keep the samples in that container cold during shipment.
    Format: Multiple
    Class: Real
    Unit: 1 gram
    Programmatic Pattern: GreaterEqualP[0 Gram]

    PaddingMasses

    For each member of ShippingContainers, the mass of padding material used to protect the samples in that container during shipment.
    Format: Multiple
    Class: Real
    Unit: 1 gram
    Programmatic Pattern: GreaterEqualP[0 Gram]

    PackageWeightData

    The weight of the packages shipped by this transactions.
    Format: Multiple
    Class: Link
    Programmatic Pattern: _Link

    ShippingLabels

    For each member of ShippingContainers, the shipping labels affixed to the package.
    Format: Multiple
    Class: Link
    Programmatic Pattern: _Link

Analysis & Reports

    Receipt

    The receipt report associated with the transaction containing paperwork including confirmation emails, packing slips, etc.
    Format: Single
    Class: Link
    Programmatic Pattern: _Link

    SupplierProvidedDocumentation

    Digital scans of physical documents from an external supplier which arrive with received objects.
    Format: Multiple
    Class: Link
    Programmatic Pattern: _Link

Troubleshooting

    Troubleshooting

    Indicates that this transaction is currently in troubleshooting.
    Format: Single
    Class: Boolean
    Programmatic Pattern: BooleanP

    TroubleshootingReports

    Troubleshooting reports associated with the fulfillment of this transaction.
    Format: Multiple
    Class: Link
    Programmatic Pattern: _Link

Storage Information

    StoragePrice

    The total monthly price for warehousing all user owned items associated with this transaction in an ECL facility under the storage conditions specified by each item.
    Format: Single
    Class: Real
    Unit: 1 US dollar per month
    Programmatic Pattern: USD Hold[GreaterEqualP[0 -----]] Month

    StoredObjects

    List of all physical items associated with this transaction that are currently being warehoused in an ECL facility.
    Format: Multiple
    Class: Link
    Programmatic Pattern: _Link

    DateLastUsed

    Date any physical items associated with this transaction were last handled in the lab.
    Format: Single
    Class: Date
    Programmatic Pattern: _?DateObjectQ

Option Handling

    ResolvedOptions

    The final options used as parameters for this protocol, after automatic options are resolved.
    Format: Single
    Class: Compressed
    Programmatic Pattern: {_Rule...}

    UnresolvedOptions

    The verbatim options originally input by the protocol author to generate this protocol, often with some options set to Automatic.
    Format: Single
    Class: Compressed
    Programmatic Pattern: {_Rule...}

Aliquoting

    AliquotSamples

    Samples corresponding to aliquots of SamplesIn generated during sample preparation and intended for use in this transaction.
    Format: Multiple
    Class: Link
    Programmatic Pattern: _Link
    Relation: Object[Sample]

    AliquotContainers

    Containers that hold AliquotSamples generated during sample preparation and intended for use in this transaction.
    Format: Multiple
    Class: Link
    Programmatic Pattern: _Link

    AliquotVolumes

    For each member of SamplesIn, the amount of sample transferred from the initial sample into an aliquot sample which is used in lieu of the initial sample for the transaction.
    Format: Multiple
    Class: Real
    Unit: 1 microliter
    Programmatic Pattern: GreaterP[0 Micro Liter]

    TargetConcentrations

    For each member of SamplesIn, the final concentration of analyte in the aliquot sample which is used in lieu of the initial sample for the transaction.
    Format: Multiple
    Class: Expression
    Programmatic Pattern: Milligram Hold[GreaterP[0 Micro Molar] | GreaterP[0 ----------]] Milliliter

    ShipmentVolumes

    For each member of SamplesIn, the total volume of the aliquot sample that is in this transaction. This includes the aliquot volume from the initial sample plus any buffer that was added for dilution.
    Format: Multiple
    Class: Real
    Unit: 1 microliter
    Programmatic Pattern: GreaterEqualP[0 Micro Liter]

    ConcentratedBuffer

    The concentrated buffer source which is added to each of the AliquotSamples to obtain 1x buffer concentration after dilution of the AliquotSamples which are used in lieu of the SamplesIn for the transaction.
    Format: Single
    Class: Link
    Programmatic Pattern: _Link

    BufferDilutionFactor

    The dilution factor by which the concentrated buffer is diluted in preparing the AliquotSamples to obtain a 1x buffer concentration after dilution of the AliquotSamples which are used in lieu of the SamplesIn for the transaction.
    Format: Single
    Class: Integer
    Programmatic Pattern: GreaterP[0]

    BufferDiluent

    The diluent used to dilute the concentration of the concentrated buffer in preparing the AliquotSamples which are used in lieu of the SamplesIn for the transaction.
    Format: Single
    Class: Link
    Programmatic Pattern: _Link

    ShipmentBuffer

    The final desired buffer for the AliquotSamples which are used in lieu of the SamplesIn for the transaction.
    Format: Single
    Class: Link
    Programmatic Pattern: _Link

    SamplePreparationProtocols

    The protocols used to prepare any AliquotSamples in this transaction.
    Format: Multiple
    Class: Link
    Programmatic Pattern: _Link

    AliquotSamplePreparation

    For each member of AliquotSamples, parameters describing how aliquots should be drawn from the input samples after initial sample preparation in order to create new aliquot samples upon which aliquot preparation and the experiment should proceed.
    Format: Multiple

    [Aliquot]

      Header: Aliquot
      Class: Boolean

    [AliquotAmount]

      Header: AliquotAmount
      Class: Expression

    [TargetConcentration]

      Header: TargetConcentration
      Class: Expression

    [AssayVolume]

      Header: AssayVolume
      Class: Real
      Unit: 1 milliliter

    [AliquotContainer]

      Header: AliquotContainer
      Class: Expression

    [AssayBuffer]

    [BufferDiluent]

    [BufferDilutionFactor]

      Header: BufferDilutionFactor
      Class: Real

    [ConcentratedBuffer]

    [DestinationWell]

      Header: DestinationWell
      Class: Expression

    [TargetConcentrationAnalyte]

      Header: TargetConcentrationAnalyte
      Class: Expression

    [AliquotSampleLabel]

      Header: AliquotSampleLabel
      Class: String

    ConsolidateAliquots

    Indicates if identical aliquots should be consolidated in a single sample.
    Format: Single
    Class: Expression
    Programmatic Pattern: BooleanP

    AliquotPreparation

    Indicates if the aliquoting should occur manually or on a robotic liquid handler.
    Format: Single
    Class: Expression
    Programmatic Pattern: PreparationMethodP

Pricing Information

    ShippingPrice

    The price associated with preparing this transaction for shipment and the shipping price for this transaction.
    Format: Single
    Class: Real
    Unit: 1 US dollar
    Programmatic Pattern: GreaterEqualP[0 USD]
Last modified on Mon 26 Sep 2022 15:43:53