# Record List by Column

## Specs

| Label                     | Value                         |
| ------------------------- | ----------------------------- |
| **Version**               | 0.1.0 (updated on 2023-11-13) |
| **Developer**             | Labii Inc.                    |
| **Type**                  | Section                       |
| **Support Configuration** | Yes                           |

## Overview

The "Record List by Column" widget is designed to showcase a list of records organized by the values of a [ForeignKey](https://docs.labii.com/column-widgets/form/dropdown#foreignkey) or [ForeignKeys](https://docs.labii.com/column-widgets/form/dropdown#foreignkeys) column. This widget allows users to seamlessly navigate and modify records within the displayed list, empowering them to update information effortlessly. Users have the flexibility to configure the fields they wish to be visible, tailoring the widget to their specific needs. Additionally, the widget facilitates the editing of record values directly from the interface, streamlining the data management process. Its intuitive design and interactive features make it a powerful tool for efficiently handling and manipulating records within a ForeignKey or ForeignKeys context, enhancing the overall user experience in data management scenarios.

## Use cases

* Display list of samples to be analyzed in a report.

Explore [this resource](https://docs.labii.com/widgets/section-widgets/data-display/record-list) to find comparisons between this widget and other similar widgets.

## Settings

For the widget to function, users must designate a column with either the ForeignKey or ForeignKeys widget. Once this configuration is established, the widget will showcase the values from the specified column. Users are also provided with the option to specify which fields they want to be displayed, adding a layer of customization to tailor the widget's output according to their preferences.

* **Column (ForeignKey or ForeignKeys)** - Select a ForeignKey or ForeignKeys column. The value of the column will be displayed.
* **Fields** - Fields of the table to display. The name field will always be included.

## **Interface**

The widget interface exhibits a list of records sourced from the specified ForeignKey or ForeignKeys column.

## **Change records**

To add or remove records, simply update the ForeignKey or ForeignKeys column at the Columns view.

## Add records via scan

Labii facilitates the addition of records by incorporating the scan function to streamline the process. When the source column is utilizing the ForeignKey widget, the Scan function is designed to replace the existing record seamlessly.

To add records via scanning, simply click the **Scan** button and utilize the Scanner to read the barcode or QR code.

## 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.

## Reload

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.


---

# Agent Instructions: Querying This Documentation

If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://docs.labii.com/widgets/section-widgets/data-display/record-list/record-list-by-column.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.