Lists

Overview

A List is a custom table with a user-defined schema. Use the List to persist custom automation data. Our Buddies can retrieve, insert, update, and delete the data inside List.

You can create a list inside the Control Room based on your custom needs. Control Room provides a UI approach to define the Schema for your List. Identify each List uniquely using their names.

Enabling Lists Feature

The Lists feature will not be activated inside your Control Room by default. Administrators must activate the Lists feature to view, create, and manage custom lists.

tip

The lists feature is activated if you see the Lists item under Assets.

To enable the List, follow the steps provided below:

• Login to IntelliBuddies Control Room with Admin role
• Go to Administrator > Features
• Activate the Lists feature by clicking on the Activate button associated with the Lists entry

Managing your Lists

You can then manage Lists from the Lists page. You can reach this page by selecting Assets > Lists option from the side panel.

Creating a List

You can create a new list inside the Control Room from the Lists page by following the steps provided below:

• Click on Toolbar-Menu > button

• Type in a name for this List.

• Optionally, type in a description for this List for future reference

• By default, the List will have five columns, which are as follows:

  Column Name	Description
  Item ID	The unique ID of an item inside this List.
  Created At	The item created timestamp.
  Created By	The User who created the item.
  Modified At	The item modified timestamp.
  Modified By	The User who modified this item.

info

It creates the above fields with their Internal property set to true.

• Click on to add a column to this List
• Click on Create

note

It is mandatory to add at least one non-internal column to the List.

Column Schema

Column Schema	Description
Display Name	The display name of the column
Is Primary	Check this box if the column is a primary key
Is Null	Check this box if the column accepts a null value
Column Type	Select the column data type
Internal	Indicates whether the column is a default column(true) or a user-added column(false)
Description	Describe this column

note

You cannot delete the primary key column in the existing List. However, you can change this column's name and description. You cannot delete the internal columns in the List; you can edit only the description for internal columns.

Column Types

Currently, it supports the following column types by the Lists.

Column Type	Description
Sequence Number	Use this type to generate unique integer values in a specific sequence automatically
Integer	Stores numeric integer values
Boolean	Stores a Boolean, True or False, value
Date	Stores a Date value
DateTime	Stores a Date and Time value
Numeric	Stores a numeric decimal value
Text	Stores a text value of up to 256 characters
Text Area	Stores a text value of up to 65KB (PostgreSQL) to 2GB (SQL Server)
Url	Stores a web URL
Guid	Stores a value of type GUID (Global Unique IDentifier)
Percentage	Stores a numeric decimal value with two decimal points representing a percentage
Phone	Stores a phone number with a max of 12 digits
Email	Stores an email id

note

MSSQL allows only one identity column per table. By default, Item ID is the identity column in a list. So, for the MSSQL Control Room, you cannot add more columns of type Sequence Number. For Postgres Control Room, you can add multiple columns of type Sequence Number since Postgres allows multiple identity columns per table.

Sharing a List

The List owner can share a List inside the Control Room with other users. Users with the following permissions can share the Lists across the users:

Permission Type	Description
Viewer	Users with this permission type can view the schema and data of the list
Editor	Users with this permission type can view the schema and edit the data inside this list
Owner	User with this permission type can view and edit the List's schema and data. The Owner can also share the List with other users. By default, the User who created the List inside the Control Room would be the Owner of that list

Share the List by performing the following steps:

• Login to the Control Room
• Go to the Lists page
• Select the List to be shared
• Right-click and select the Share option
• Select the User to whom you want to share this List
• Change the permission type based on your needs. By default, a user gets Viewer permission.
• Click on Share

Editing a List Schema

Edit the schema of an existing list by following the steps below:

note

Users with the Owner permissions can edit the schema of an existing list.

• Login to the Control Room
• Go to Assets > Lists
• Select the List
• Right-click and select Schema
• Modify the Schema either by changing the details of existing columns or by adding new columns
• Click on Save

Adding new data row

You can add a new row of data to a list by following the steps below:

note

Users with either Editor or Owner permission can perform this operation to the corresponding List.

• Login to the Control Room
• Go to Assets > Lists
• Select the List
• Right-click and select Data
• Either click on the Grid-Menu > New Row button to add a data row inline in the grid
• OR Click on > and select Form from the menu to fill the data using a Form.
• Fill in the data
• Click on Save

Viewing a List Data

View the data stored inside an existing list by following the steps below:

• Login to the Control Room
• Go to Assets > Lists
• Select the List
• Right-click and select Data

Column Chooser

It hides the Internal columns by default in the list data grid. Users can make these columns visible by selecting them from the column chooser.

Users can hide internal and non-internal columns based on preferences in the list data grid. By clicking on "Save Page Settings," the selected column visibility settings are saved. The previously saved column visibility settings are automatically applied when they revisit the page.

• Login to the Control Room
• Go to Assets > Lists
• Select the List
• Right-click and select Data
• Select the column chooser icon from the data grid toolbar icons

note

Users will not be able to set values in the internal fields.

Editing a data row

You can edit the data inside the List by following the steps below:

note

Users with either Editor or Owner permission can edit the corresponding List.

• Login to the Control Room
• Go to Assets > Lists
• Select the List
• Right-click and select Data
• Either Click on Edit Icon > button to edit it inline in the grid
• OR Right-Click on the Row and select Edit In Form to edit the data in the Form
• Edit the required Data
• Click on Save

Deleting a data row

Delete a data row from a List by following the steps below:

note

Users with either Editor or Owner permission can delete the data to the corresponding List.

• Login to the Control Room
• Go to Assets > Lists
• Select the List
• Right-click and select Data
• Select the Row to be deleted
• Right-click and select Delete
• Confirm your operation by clicking on Delete

Transferring Ownership of a List

You can transfer the ownership of a list from one User to another by following the steps below:

• Login to the Control Room
• Go to the Lists page
• Select the List for which to transfer the ownership.
• Right-click and select the Share option
• Change the permission to the Owner for transferring ownership to the User.
• Allot new permission to the User from the ownership was removed. Alternatively, you can remove the User from the sharing list if not needed by clicking on the X button
• Click on Share

Deleting a List

You can delete a list from the Control Room by following the steps below:

note

Only the Owner of the List can delete a list.

• Login to the Control Room
• Go to Assets > Lists
• Select the List
• Right-click and select Delete
• Confirm your operation by clicking on Delete

Exporting List data to a file

You can export the list data into a file from the Control Room by following the steps below:

note

As of now, you can export to the following file formats:

• XLSX [Default]
• CSV
• PDF

note

You can export only the visible columns.

• Login to the Control Room
• Go to Assets > Lists
• Select the List
• Right-click and select Data
• Click on Grid-Menu > Export button to export the list data in XLSX format
• Alternately, you can click on and select the appropriate export format.

Exporting List schema

You can export the list schema as a list package from the Control Room by following the steps below:

• Login to the Control Room
• Go to Assets > Lists
• Select the List
• Right-click and select Export

or

• Login to the Control Room
• Go to Assets > Lists
• Select the List
• Right-click and select Schema
• Click the Grid-Menu > Export button to export the list schema as a list package.

List Package

The list package includes the following file:

• schema file (schema.json)

Importing List schema

You can import the list schema into the Control Room from the Lists page by following the steps provided below:

• Click on the Import button on the Toolbar-Menu.

  

• Select the list package(.nupkg) file to be imported.

• Click on OK.

You can view the imported List in the grid on the Lists page.

note

Whoever has permission to Add List can Import the List into the Control Room.

note

Unlike Postgres, MSSQL only allows one identity column per table. Therefore, you cannot import a list exported from the Postgres Control Room with multiple columns of type Sequence Number into the MSSQL Control Room.