Record List by ForeignKey

Exhibit a list of records linked to the current record through a ForeignKey or ForeignKeys column


The "Record List by ForeignKey" widget is designed to exhibit a list of records linked to the current record through a ForeignKey or ForeignKeys column. Users have the flexibility to customize the displayed fields, enabling a personalized view of relevant information. Not only does this widget allow users to update the values of existing records seamlessly, but it also empowers them to create new records that reference the current record via the ForeignKey or ForeignKeys column.

Use cases

  • Display list of contacts associated to an account.

Explore this resource to find comparisons between this widget and other similar widgets.


For the widget to operate, users must configure both the table and the column that references the current record. Once this configuration is set up, the widget will automatically display a list of records. Additionally, users have the flexibility to customize which fields are shown and specify the fields used for scanning, providing a tailored and user-controlled display of information.

  • Table - Select a table that has columns referred to this record as the value of ForeignKey or ForeignKeys.

  • Column - the ForeignKey or ForeignKeys column referenced to this record. When the table changes, the column options changes automatically.

  • Column (Quantity) - Choose the quantity field requiring a numerical value. Once selected, conducting multiple scans will increment the item quantity.

  • Fields - other fields to display. On default, the name of the record will be displayed.

  • Fields scannable - Please provide a list of fields that can be included through barcode/QR code scanning. Limit to ForeignKey columns only. The scannable fields can not be the ForeignKey that referenced to this record.


The widget interface displays a list of records from a specific table and column that refer to the current record.

Add records

Add blank record

You can add a new record directly linked to the current record by clicking "Add [Table Name]". This form is identical to the one for adding a record.

Add records in bulk

You can add multiple records simultaneously using the "Add records in bulk". Learn more.

Import records

To import lists of records in bulk, click "Import records". Imported records will be assigned directly to the current record.

Add records via scan

Labii has introduced a new feature to streamline the process of adding records. Users can now add records by simply scanning barcodes or QR codes, which proves especially useful during experiments where samples need to be documented for consumption or usage purposes. Instead of manually adding each sample, users can easily scan the barcode or QR code associated with the samples.

To enable this feature, you must first set up the scannable fields in the settings. Please note that only ForeignKey columns are scannable, and you can define these fields under the scannable fields settings.

When you are ready to scan, click on the Scan dropdown and choose the specific field you want to scan. The widget will then be activated and ready to receive signals from the barcode or QR code scanner. It's important to mention that the feature supports scanners and does not support camera.

Once you scan a code, the results will be displayed in a list format. In case of any errors or mistakes, you have the option to remove the scanned results individually by clicking on the Remove button.

Once all the relevant results have been scanned, click on the Submit button to initiate the record creation process.

After completing the initial record creation, you may find it necessary to update other values. This can be achieved by clicking on the edit icon or by using the bulk edit option available under the list view. This ensures that all necessary information is accurately recorded and documented.

In summary, Labii now supports effortless record addition via barcode or QR code scanning, simplifying the data entry process, especially in experiments involving sample tracking and documentation.

Update field value

With Edit permissions, you have the ability to update one or multiple fields of the displayed records by clicking the edit icon next to the respective field.

Open list view

Utilize the "Open List View" button to present the records in a list view, where you can access various functions such as export, bulk edit, bulk print, and more.


Occasionally, the list may be refreshed in alternative locations, and you can select the Reload button to update the record list.

Execute workflows

If one or more workflows are chosen in the settings, a list of workflows will appear, and you can initiate each workflow by clicking the "Execute Workflow" button.

Last updated