Consumption

Calculating and tracking remaining volumes of samples or reagents

Specs

Label	Value
Version	4.5.0 (updated on 2025-04-14)
Developer	Labii Inc.
Type	Column
Support Configuration	Yes
Support Readonly view	Yes
Support Edit view	No
Support Form view	No
Support Default value	No
Support Import	No
Allow multiple	Yes

Overview

Consumption Widget is a cutting-edge tool designed to streamline your laboratory operations. This innovative widget offers a seamless solution for calculating and tracking remaining volumes of samples or reagents. With its intuitive interface, researchers can effortlessly input initial volumes, record consumption data, and instantly view the real-time remaining quantities. The Labii Consumption Widget not only enhances accuracy but also saves valuable time, ensuring that your lab maintains optimal inventory levels and prevents unexpected shortages, ultimately boosting efficiency and productivity in your research endeavors. Say goodbye to manual calculations and hello to precision and convenience with the Labii Consumption Widget.

The consumption widget eliminates the hassle of manually converting values between different units. By configuring the conversion factor within the widget's settings, it can seamlessly perform automatic unit conversions.

Use case

• Use this widget to display the remaining volume of a sample or reagent.

• Use this widget to display the total of checkin or checkout quantity.

• Use this widget to calculate the total amount of invoice from invoice items.

Configuration

The remaining volume of a sample or reagent can be determined using the following formula within the consumption widget:

$$Remaining Volume (v) = Total Volume (V) - Sum(Consumption)$$

Therefore, it is necessary to pre-configure the total volume column in the consumption table.

• Column (Quantity) - Choose the column for total quantity. If this column is left blank, the returned value will be the sum of all consumption values.

• Column (Unit) - Choose the column for quantity unit.

• Table (Consumption) - Select a table designated for recording consumption data.

• Column (Source) of the Consumption table - Select the column in the consumption table that is associated with the current record.

• Column (Amount) of the Consumption table - Choose the column in the consumption table that records the amount or volume of the record used.

• Column (Unit) of the Consumption table - Choose the column in the consumption table that records the unit of the amount.

• Conversions - Specify the conversion factors for every unit utilized, ensuring inclusion of all units within the quantity unit. If a unit is not provided, a factor of 1 will be utilized.

• Threshold - Configure the threshold value as either a specific number or a percentage to trigger a warning when the remaining volume falls at or below it. For instance, setting it to '10' will trigger a warning when the remaining volume reaches or falls below 10, while setting it to '10%' will raise a warning when the remaining volume is equal to or less than 10% of the total volume.

• Query - Further refine the displayed records by adding supplementary query criteria.

• Stop condition - The formula will stop calculation when the condition is met. It must return a true or false value. This field does not support other column data, you can only use the variable data to reference the current record data.

• Should auto update when readonly - If checked, this widget will perform a live calculation when readonly.

Example

Below is the widget configuration for performing calculations using data from the consumption table.

{
    "unit": {
        "sid": "xxx",
        "name": "unit"
    },
    "amount": {
        "sid": "xxx",
        "name": "amount"
    },
    "format": {
        "decimals": "2",
        "thousand": ","
    },
    "source": {
        "sid": "xxx",
        "name": "source"
    },
    "quantity": {
        "sid": "xxx",
        "name": "quantity"
    },
    "threshold": "10%",
    "consumption": {
        "sid": "xxx",
        "name": "consumption"
    },
    "conversions": [
        {
            "unit": "µL",
            "factor": 1
        },
        {
            "unit": "mL",
            "factor": 1000
        },
        {
            "unit": "L",
            "factor": 1000000
        },
        {
            "unit": "µg",
            "factor": 1
        },
        {
            "unit": "mg",
            "factor": 1000
        },
        {
            "unit": "g",
            "factor": 1000000
        },
        {
            "unit": "kg",
            "factor": 1000000000
        },
        {
            "unit": "Each (EA)",
            "factor": 1
        },
        {
            "unit": "Dozen (DZ)",
            "factor": 1
        },
        {
            "unit": "Gross (GR or GRO)",
            "factor": 1
        },
        {
            "unit": "Pair (PR)",
            "factor": 1
        },
        {
            "unit": "Case (CS or CA)",
            "factor": 1
        },
        {
            "unit": "Pack (PK)",
            "factor": 1
        },
        {
            "unit": "Bundle (BDL)",
            "factor": 1
        },
        {
            "unit": "Carton (CTN)",
            "factor": 1
        },
        {
            "unit": "Set (SET)",
            "factor": 1
        },
        {
            "unit": "Roll (RL)",
            "factor": 1
        }
    ],
    "quantity_unit": {
        "sid": "xxx",
        "name": "unit"
    }
}

Here is the widget configuration responsible for calculating the total stock checkins.

{
    "unit": {
        "sid": "xxx",
        "name": "unit"
    },
    "amount": {
        "sid": "xxx",
        "name": "quantity"
    },
    "format": {
        "decimals": "2",
        "thousand": ","
    },
    "source": {
        "sid": "xxx",
        "name": "stock"
    },
    "consumption": {
        "sid": "xxx",
        "name": "checkin"
    },
    "conversions": [
        {
            "unit": "µL",
            "factor": 1
        },
        {
            "unit": "mL",
            "factor": 1000
        },
        {
            "unit": "L",
            "factor": 1000000
        },
        {
            "unit": "µg",
            "factor": 1
        },
        {
            "unit": "mg",
            "factor": 1000
        },
        {
            "unit": "g",
            "factor": 1000000
        },
        {
            "unit": "kg",
            "factor": 1000000000
        },
        {
            "unit": "Each (EA)",
            "factor": 1
        },
        {
            "unit": "Dozen (DZ)",
            "factor": 1
        },
        {
            "unit": "Gross (GR or GRO)",
            "factor": 1
        },
        {
            "unit": "Pair (PR)",
            "factor": 1
        },
        {
            "unit": "Case (CS or CA)",
            "factor": 1
        },
        {
            "unit": "Pack (PK)",
            "factor": 1
        },
        {
            "unit": "Bundle (BDL)",
            "factor": 1
        },
        {
            "unit": "Carton (CTN)",
            "factor": 1
        },
        {
            "unit": "Set (SET)",
            "factor": 1
        },
        {
            "unit": "Roll (RL)",
            "factor": 1
        }
    ],
    "quantity_unit": {
        "sid": "xxx",
        "name": "unit"
    }
}

Views

See the interface of the widget in the following views.

Readonly view

Readonly view display the values of the column.

In the readonly view, a warning message will be shown when the remaining volume is equal to or less than the specified threshold.

Edit view

The Edit view is the interface that allows you to modify the value.

Edit view is not supported for this widget.

Form view

The Form view is the field integrated into the add form for collecting values when creating a new record.

Form view is not supported for this widget.

Data

Each widget in Labii stores data in a unique manner; refer below to understand how data from this widget is stored.

Data format

{
    "value": number,
    "is_low": bool
}

Default value

The Default Value field within the column allows you to specify the default value when a record is created.

Default value is not supported for this widget.

Import value

The Import Value is the value you need to include in your Excel table for it to be imported into Labii.

Import value is not supported for this widget.

Notes

You can utilize the "is_low" key generated by the widget to sort through a list of samples that are running low and require ordering.

The widget exclusively operates within the Frontend. This means that if you have generated samples through importing and have never opened the detailed view of those samples, the column created with the consumption widget will remain empty. Consequently, the filtering results may not be entirely accurate. To rectify these errors, you can enable the "Edit View" option in the list view to update the consumption calculations in bulk.