specs/routes/R_TBLE

Table Editor

Overview

The Table Editor allows the user to view and edit a Tulip Table as well as view, create, edit, and deactivate its fields and records.

Tulip Tables are database tables that can be used in apps to provide real-time synchronized access to records. Changes to records through apps, the Table Editor, or any other interface are immediately propagated to all connected clients.

The contents of a Tulip Table can be exported from the Table Editor in the form of a CSV file containing rows for each record.

Model/Page Connections

Tulip Table

Edit

  • A user can edit the name and description of a Tulip Table by selecting the "Edit Table Info" option in the overflow menu of the subheader, “...”.
  • A user can edit the fields and records of a table from this page.

View

  • A user can view the name of a Tulip Table in the subheader in the top left of the page.
  • A user can view the description of a Tulip Table by clicking on a button with an "i" icon to the right of the table name.
  • A user can view the fields and records of a Tulip table in the body of the page.

Table Field

Create

  • A user can create table fields by clicking the plus ("+") icon at the top of the main table view, to the right of any existing fields. A menu opens that allows the user to specify the new field's data type and label.
  • A user can create a field in a different Table by creating a Linked Record field. After pressing the "+" icon to create a new field, the user can select "Linked Record" and then will be allowed to choose the same Table or a separate table, and then create a new field in that Table before pressing "Save".

Edit

  • A user can edit the label of a field by clicking the caret to the right of the field's header cell, and selecting the "Edit field" option in the dropdown menu.
  • A user can edit the description of a field by clicking the caret to the right of the field's header cell, and selecting the "Edit description" option in the dropdown menu.

View

  • A user can view the fields of a table in the header row of the table view, located below the page's subheader and above the list of records. Each header cell shows an icon representing the data type of the field to the left, the label of the field next to the type icon, and if a description is present, an "i" icon that displays the description when hovered over.
  • A user can view deactivated fields by selecting the "View Archived Fields" option in the overflow menu of the subheader, “...”. These are fields that have been deactivated since the table was initially created.
  • A user can view metadata fields (e.g. date created, date updated) by selecting the "View Metadata Fields" option in the overflow menu of the subheader.

Archive

  • A user can archive a field by clicking the caret to the right of the field's header cell, and selecting the "Archive Field" option in the dropdown menu.
  • A user can restore archived fields by selecting the "View Archived Fields" option in the overflow menu of the subheader, and clicking a field's "Restore" button.

Table Record

Create

  • A user can create table records by clicking the "Create Record" button in the subheader.
  • A user can create up to 10,000 records at a time by importing a CSV. Each row in the CSV will be one new record. In order to import rows from a CSV, the user must click the "..." menu in the top right of the screen and then choose the "Import data from CSV file" option. This functionality is only available for Cloud customers.

Edit

  • A user can edit table records by clicking on a cell of a table record.
  • A user can edit multiple table records at once by uploading a CSV where the ID value of each row matches an existing row within the Table. This allows the user to update all values of a row except the ID in bulk. In order to mass update rows via a CSV, the user must click the "..." menu in the top right of the screen and then choose the "Import data from CSV file" option. This functionality is only available for Cloud customers.

View

  • A user can view table records in a table view in the body of the page. Each row contains the data for a record.
  • A user can view multiple pages of records by clicking on the numbered pagination buttons at the bottom of the page.
  • A user can sort the table view by clicking the caret to the right of a field's header cell, and selecting one of the "Sort..." options in the dropdown menu.
  • Text wrapping for the table can be toggled from the "..." menu

Delete

  • A user can delete table records by clicking on a cell of a table record, and then clicking the "Delete" button in the bottom left of the resulting menu. They can be viewed at any time in the Record History Widget

Table Query

Create

  • A user can create a new Table Query by selecting the "Queries" button in the top right of the page and then pressing "Create New Query".

View

  • A user can view all existing Table Queries by selecting the "Queries" button in the top right of the page and then viewing the list of all existing queries.

Table Aggregation

Create

  • A user can create a new Table Aggregation by selecting the "Aggregations" button in the top right of the page and then pressing "Edit" in the bottom right of the resulting modal. After that, they must enter a name, choose a calculation type and select a field.

Edit

  • A user can edit an existing Table Aggregation by pressing "Edit" in the Table Aggregations modal. Then, they can modify the name, calculation type and field of any existing Aggregation.

Deactivate

  • A user can deactivate an existing Table Aggregation by pressing "Edit" in the Table Aggregations modal. Then, they can press the trash icon to remove the aggregation from the list.

View

  • A user can view all existing Table Aggregation by selecting the "Aggregations" button in the top right of the page and then viewing the list of all aggregations that are attached to the Table.

User

View

  • A user can view and search through a list of users when selecting a user value for a record being edited.

Pages

This page can be accessed from the following pages:

User Permissions

Table editing, table field creation/editing/deletion, and table record creation/editing/deletion may be restricted based on the user's role.

Tests

IDName
QA-T83Table Management : 04 - Edit a table's name and description
QA-T84Table Management : 05 - Add columns to a table
QA-T85Table Management : 06 - Edit a table column
QA-T86Table Management : 07 - Edit a table column description
QA-T87Table Management : 08 - Delete a table column
QA-T88Table Management : 09 - Restore a deleted table column
QA-T89Table Management : 10 - Reorder table columns
QA-T90Table Management : 11 - Resize table columns
QA-T92Table Management : 12 - Create table records from the table detail page
QA-T93Table Management : 13 - Sort table records by column in table view
QA-T94Table Management : 14 - Load multiple pages of table records in table view
QA-T104Record Placeholders : 03 - View the table for a record placeholder
QA-T133Record Placeholders : 07 - Delete Table Record
QA-T245Embedded Tables : 05 - Handle deleted fields in embedded tables
QA-T397Table Links : 01 - Creating Table Links
QA-T398Table Links : 02 - Linking Records via Details Page
QA-T399Table Links : 03 - Linking Records via App Triggers
QA-T400Table Links : 04 - Deleting Linking Columns
QA-T464Tables CSV Import : 01 - Import to table
QA-T466Tables CSV Import : 02 - Import feature data handling
QA-T467Tables CSV Import : 03 - Import from export
QA-T570Table Queries : 01 - Create, Edit, Delete a Query
QA-T571Table Queries : 02 - Query Configuration
QA-T572Table Queries : 03 - Create, Edit, Delete an Aggregation
QA-T573Table Queries : 04 - Aggregation Configuration
QA-T700Table Queries : 02 / Query for an Archived Field
QA-T701Record Placeholders : 07 / Attempting to Delete a Loaded Table Record
QA-T702Table Management : 05 / Table Columns must be named
QA-T703Table Queries : 07 - Unique value aggregation
QA-T705Table Management : 06 / Table Columns labels cannot be blank and ID cannot be edited
QA-T715Table Management : 04 / Cannot leave table name blank on edit
QA-T716Table Management : 12 / Table Record Data Validation
QA-T721Table Queries : 03 / Can't edit a saved Aggregation without clicking 'Edit'

Requirements

IDRequirement
PLAT-8946 (806)All records shall be Enduring, ie. store, managed and unalterable for the full retention period.