Lists
Overview
A List is a custom table with a user-defined schema. The List can be used to persist custom automation data. Our Buddies can retrieve, insert, update, and delete the data inside List.
You can create a list inside Control Room based on your custom needs. Control Room provides a UI approach to define the Schema for your List. Every other List could be uniquely identified using their names.
Enabling Lists Feature
The Lists feature will not be activated inside your Control Room by default. Administrators need to activate the Lists feature to view, create and manage your custom lists.
tip
The lists feature is already 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 Control Room from the Lists page by following the steps provided below:
- Click on Grid-Menu >
button
- Type in a name for this list.
- Optionally, type in a description for this list for future reference
- Click on
to add a column into this list
- Click on Create
note
It is mandatory to add at least one 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 |
Description | Describe this column |
note
You cannot delete a primary key column once a list has been created.
Column Types
Currently, the following column types are supported by the Lists.
Column Type | Description |
---|---|
Sequence Number | Use this type to automatically generate unique integer values in a specific sequence |
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 upto 256 characters |
Text Area | Stores a text value of upto 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 max 12 digits |
Stores an email id |
Sharing a List
The List owner can share a List inside Control Room with other users. Lists could be shared across users with the following permission types:
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 both Schema and data of the List. The Owner can also share the List with other users. By default, the User who created the List inside Control Room would be the Owner of that list |
You can share the List by performing the following steps:
- Login to Control Room
- Go to the Lists page
- Select the List to be shared
- Right-click and select 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
Viewing a List Schema
You can view the Schema of an existing list by following the steps below:
- Login to Control Room
- Go to Assets > Lists
- Select the List
- Right-click and select View > Schema
Viewing a List Data
You can view the data stored inside an existing list by following the steps below:
- Login to Control Room
- Go to Assets > Lists
- Select the List
- Right-click and select View > Data
Editing a List Schema
You can edit the Schema of an existing list by following the steps below:
note
You need to have either Editor or Owner permissions to edit the Schema of an existing list.
- Login to Control Room
- Go to Assets > Lists
- Select the List
- Right-click and select Edit > Schema
- Modify the Schema either by changing the details of existing columns or by adding new columns
- Click on Save
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 Control Room
- Go to the Lists page
- Select the List for which ownership needs to be transferred
- Right-click and select Share option
- Change the permission to Owner for the User to whom the ownership needs to be transferred
- Allot new permission to the User from the ownership was removed. Alternately, 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 Control Room
- Go to Assets > Lists
- Select the List
- Right-click and select Delete
- Confirm your operation by clicking on Delete