ecl-logo Documentation

Object[Inventory]

An object representing instructions for keeping products or stock solutions in stock.

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[Inventory, _String]
    Pattern Description: The object reference of this object.

    Type

    Type of this Object.
    Format: Single
    Class: Expression
    Programmatic Pattern: Object[Inventory]
    Pattern Description: Object[Inventory]

    Notebook

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

    Author

    The user who generated this inventory entry.
    Format: Single
    Class: Link
    Programmatic Pattern: _Link
    Relation: Object[User]

    Site

    The ECL site at which this inventory automatically keeps samples in stock.
    Format: Single
    Class: Link
    Programmatic Pattern: _Link

Inventory

    StockedInventory

    The products or models that automatically reordered by this inventory object if amounts are below the specified thresholds.
    Format: Multiple
    Class: Link
    Programmatic Pattern: _Link

    Status

    Indicates if this inventory object is currently actively keeping samples in stock.
    Format: Single
    Class: Expression
    Programmatic Pattern: Active | Inactive

    HistoricalRestockings

    All protocols or orders that have been automatically generated by this inventory object.
    Format: Multiple
    Class: Link
    Programmatic Pattern: _Link

    OutstandingRestockings

    All protocols or orders that have been automatically generated by this inventory object that have not yet been completed or received.
    Format: Multiple
    Class: Link
    Programmatic Pattern: _Link

    StockingMethod

    Indicates if this inventory keeps track of how much to keep in stock in the lab by the number of currently-stocked containers or the total amount of the model stocked.
    Format: Single
    Class: Expression
    Programmatic Pattern: NumberOfStockedContainers | TotalAmount

    CurrentAmount

    The amount of sample currently in stock in the lab that has not already been requested by a confirmed or running protocol.
    Format: Single
    Class: VariableUnit
    Programmatic Pattern: GreaterEqualP[0 Gram] | GreaterEqualP[0 Milliliter] | GreaterEqualP[0 Unit, 1 Unit]

    ReorderThreshold

    Indicates the point below which CurrentAmount + OutstandingAmount must fall for a new order to be triggered.
    Format: Single
    Class: VariableUnit
    Programmatic Pattern: GreaterEqualP[0 Gram] | GreaterEqualP[0 Milliliter] | GreaterEqualP[0 Unit, 1 Unit]

    OutstandingAmount

    The amount of sample that has been ordered but has not yet been received and made available in the lab.
    Format: Single
    Class: VariableUnit
    Programmatic Pattern: GreaterEqualP[0 Gram] | GreaterEqualP[0 Milliliter] | GreaterEqualP[0 Unit, 1 Unit]

    ReorderAmount

    Indicates the amount that will be automatically ordered if CurrentAmount + OutstandingAmount falls below ReorderThreshold. If StockingMethod -> NumberOfStockedContainers and this is a StockSolution, the number of stock solution to prepare using the stock solution's formula volume.
    Format: Single
    Class: VariableUnit
    Programmatic Pattern: GreaterEqualP[0 Gram] | GreaterEqualP[0 Milliliter] | GreaterEqualP[0 Unit, 1 Unit]

Storage Information

    Expires

    Indicates if samples kept in stock by this inventory expire after a given amount of time.
    Format: Single
    Class: Boolean
    Programmatic Pattern: BooleanP

    ShelfLife

    The length of time after arrival that samples kept in stock by this inventory are recommended for use before they should be discarded.
    Format: Single
    Class: Real
    Unit: 1 day
    Programmatic Pattern: GreaterP[0 Day]

    UnsealedShelfLife

    The length of time after opening that samples kept in stock by this inventory are recommended for use before they should be discarded.
    Format: Single
    Class: Real
    Unit: 1 day
    Programmatic Pattern: GreaterP[0 Day]

Operating Limits

    MaxNumberOfUses

    The number of times the items kept in stock by this inventory can be used before needing to be discarded and/or replaced.
    Format: Single
    Class: Integer
    Programmatic Pattern: GreaterEqualP[0, 1]

    MaxNumberOfHours

    The length of time for which the items kept in stock by this inventory can be actively used before needing to be discarded and/or replaced.
    Format: Single
    Class: Real
    Unit: 1 hour
    Programmatic Pattern: GreaterP[0 Hour]
Last modified on Mon 26 Sep 2022 15:43:46