ForeignKey

Establishes a link to another record, enabling a direct association between related data sets.

Specs

Label	Value
Version	2.1.0 (updated on 2024-12-14)
Developer	Labii Inc.
Type	Column
Support Configuration	Yes
Support Readonly view	Yes
Support Edit view	Yes
Support Form view	Yes
Support Default value	Yes
Support Import	Yes
Allow multiple	Yes

Overview

The ForeignKey widget in Labii establishes a link to another record, enabling a direct association between related data sets. This widget facilitates the creation of a connection to a single additional record, offering a seamless and clickable link to access the linked data. Through this functionality, users can establish clear relationships between different sets of information, fostering efficient navigation and exploration within the Labii platform.

Use case

1. Use this widget to define the storage of samples.

2. Use this widget to define the account of contacts.

Configuration

The widget will function without additional setup. However, the configuration options empower you to impose additional restrictions on the tables to which the linked data can be associated. Leave it empty to include all tables.

• Tables - Select one or more tables to link. To allow records from all tables, leave it empty.

• Query - Further queries to narrow the results. To exclude archived records, use is_archived=false.

Examples:

{
    "query":"is_archived=false&cell__column__sid=FILO0a40x560b4HMRW27bg&cell__data__icontains={{jmps0a40x560dclqvAFKPU:data.sid}}",
    "tables":[{"sid":"9beh0a40x12507afkpuzEJ","name":"contacts"}]
}

Views

See the interface of the widget in the following views.

Readonly view

Readonly view display the values of the column.

Edit view

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

The widget allows users to add a new record if it does not already exist. To add a new record, click the “Add XXX” button. This will open a form to collect the necessary information for the record. Once the record is added, the page will redirect back to the original view.

Form view

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

The Form view is same as the Edit view.

Data

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

Data format

JSON object with the keys of sid and name.

{"sid": "", "name": ""}

Default value

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

Default value shall be the name or uid of a record.

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 shall be the name or uid of a record.