Tables

Overview

Tables serve as individual modules to manage the research data for a particular category. Labii uses a table to keep track of one particular type of data. For instance, an experiment table can be used to keep track of all experimental notes. Depending on your research needs, you can add an unlimited number of tables to manage any type of data you require.

info

These changes can only be made by Administrators.

Watch the embedded media

List of tables

You can manage a list of tables by clicking Settings at the side menu and then select Tables.

Search tables

You can search tables by typing a keyword into the search bar in the table list view, and then clicking Search. The search results can always be cleared by clicking the Clear button.

Filter tables

With the Filter function, you can limit the number of teams displayed. You can do that by clicking Active tables and then selecting a filter from the dropdown. Here are a list of filters:

• All tables. Filter to display all tables.
• Active tables. Filter to display the active tables.
• Archived tables. Filter to display the archived tables.

Table detail

Click a table name to view the detail of the table.

The detailed view of a table comes with 5 tabs:

• Detail - the detail fields of the table.
• Columns - the columns of the table. Learn more here.
• Sections - the sections of the table. Learn more here.
• Filters - the filters of the table. Learn more here.

Table fields

Here is the list of fields for a particular table:

• Overview
  • sid - The SID of the table. Automatically generated by Labii. This ID cannot be changed once it has been created.
  • updated_by
  • date_updated
  • date_created
• Detail
  • name_singular (required) - Table name, in a singular format. Letters and Numbers only, no blanks.
  • name_plural (required) - Table name, in plural format. Letters and Numbers only, no blanks.
  • name_system - This name is used to identify system-specific tables and is automatically generated by Labii.
  • icon (required) - Table table icon.
  • order - The order to display the table
• Unique ID
  • unique_code (Required) - The abbreviation term of a table name. The code must be at least 2 characters long and contain only uppercase letters. The unique_code is used to generate the unique identifications (UID) of records.
  • UID_format - You have the option to personalize the UID by specifying your preferred UID format, which by default consists of '{Unique Code}{RID}'.
  • should_support_custom_uid - If true, users must supply their unique identifier (UID) for each record. This works well for reagents where you prefer to utilize the vendor's barcode as the UID.
    Notes: Users must guarantee the uniqueness of the provided UID, as failure to do so will result in the newly created record replacing the existing one.
• Name and Description
  • name_display_name - The display name of the 'Name' field.
  • name_help_text - The description of the 'Name' field.
  • name_display_format - The format of the 'Name' field for the name serializer.
    This field support variables. Discover additional information about the array of supportive variables on https://docs.labii.com/api/variables.
    Note: Providing a value for this field will override the default name. Use {{NAME}} to include the original name.
  • description_display_name - The display name of the 'Description' field.
  • description_help_text - The description of the 'Description' field.
• List view
  • default_list_view - Default tab view when opening the list view.
  • fields_to_display - Select fields to display in the list view.
  • ordering - The ordering to display records in the list view.
  • default_filters - Select the default filters to be included in the list view.
• Detail view
  • default_detail_view - Default tab view when opening a record.
  • fields_to_display_for_detail - Select fields to display in the detail view.
  • should_enable_section_complete_action - If enabled, each section of a record will include a 'Complete' button. Once a section is marked as complete, it will become read-only.
• Form view
  • default_add_query - The query meant for adding to the form. Use this function to restrict changes to the append query in the add form. This field support variables. Discover additional information about the array of supportive variables on https://docs.labii.com/api/variables
• Permissions
  • teams_can_add - Choose one or more teams to have add permission to this table. If you don't choose any team, all teams will have add permission to this table.
  • should_limit_edit_to_owner - If true, only the owner can edit their records, regardless of the permission settings at the project level.
  • required_certifications - Please indicate the necessary certifications needed to add or modify entries in this table. If multiple certifications are required, please list them separated by commas.
• Settings
  • minimum_number_of_signers - Number of signatories required. This number is set so that the document can only be signed when a minimum number of signers has been added. It defaults to 0.
  • printer_header - Customize the header of the print page for the table. Use HTML code for formatting. If provided, the header from organization setting will be replaced. This field support variables. Discover additional information about the array of supportive variables on https://docs.labii.com/api/variables
• metadata - the list of metadata with labels and values
• is_archived - Checking this box will archive the table. Archived tables are not available for use. Make sure no other column/section uses the table, it might break your system if one is archived. The Files table is always required and should not be archived.

Add table

A new table can be added with the following methods:

• Add a new table at the table list view:
  1. Settings -> Tables
  2. Click "Add Table" and select "Add blank table"
  3. Fill in the required fields and click "Submit"

Add table from a template

Labii ELN & LIMS is a complicated system and requires specific training to get everything right. We are simplifying the configuration progress with table templates.

• Settings -> Tables
• Click "Add Table" and select "Add table from template"
• Choose a template
• Fill in the required fields and click "Submit"
• The newly created table will also create the corresponding columns, sections, filters, workflows at the same time

info

Please always use a table template when creating a new table.

Duplicate table

To create a table similar to the table already created:

• Settings -> Tables
• Click a table name
• Click "...Actions"
• Select "Duplicate" from the dropdown menu.
• Change the following fields and click submit:
  • Table Name Singular
  • Table Name Plural
  • Unique code

Import tables

If you already have a list of tables and you would like to create in batch, use the "Import tables" function. To do that:

1. Prepare a sheet with the following fields.
2. Download/Save it as *.tsv
3. Settings -> Tables
4. Click the "...Actions"
5. In the dropdown, select "Import"
6. Select the file you just prepared, click Submit
7. Match each field based on your document header
8. Click Submit button to import
9. Verify the final results

icon	name_singular	name_plural	description	unique_code	should_add_from_form	default_view	order
cloud	test	tests	This is a test	TT	true	overview	1

Export tables

You can also export a list of tables for later use. To do that:

1. Settings -> Tables
2. Click the "...Actions"
3. In the dropdown, select "Export current page". Only the tables visible on the current page will be exported.
4. Select "Export all pages". This will download all tables and all fields.

Export table as JSON

You can export the full configuration of a table, including its columns, sections and filters, as a single JSON file. This is useful for backing up a table configuration or reviewing it before making changes in batch. To do that:

1. Settings -> Tables
2. Click a table name
3. Click "...Actions"
4. Select "Export as JSON" from the dropdown menu.
5. A file named {name_plural}_{sid}.json will be downloaded.

The JSON file has the following structure:

{
	"table": {},
	"columns": [],
	"sections": [],
	"filters": []
}

info

System-generated fields (for example, updated_by, date_created, date_updated, change_permission) and fields with empty values are not included in the export. For the table itself, organization-specific fields such as organization, application, order and groups are also excluded.

Update table from JSON

You can update a table, together with its columns, sections and filters, in one step by submitting a JSON document in the format produced by Export table as JSON. To do that:

1. Settings -> Tables
2. Click a table name
3. Click "...Actions"
4. Select "Update from JSON" from the dropdown menu.
5. Paste the JSON into the form and click "Submit".
6. A progress bar shows each item as it is saved.

The items are saved as follows:

• table - The current table is always updated with the provided fields.
• columns, sections, filters - An item with a sid updates the existing record with that SID. An item without a sid is created as a new record in the current table.

info

• Only fields included in the JSON are changed. Columns, sections and filters that are not listed in the JSON are left unchanged; they are not deleted.
• If some items fail to save, the remaining items are still saved and the errors are listed under the form for each failed item.
• You need edit permission on the table to use this function.

tip

A common workflow is to export the table as JSON, edit the file, and then use "Update from JSON" to apply the changes. To add a new column, section or filter, add an item without a sid.

System tables

The system tables are the tables with name_system setup and reserved with one particular function. Here is a list of system tables:

• file - The files table to store the uploaded files
• workflow - The workflow table to store the workflow details
• step - The workflow steps

info

The fields of the system tables can not be changed.