List

For every form configured in Form Designer, a list page is generated dynamically. The properties of the list page can be configured from the Form Designer.

Configure List

To Configure List, perform the following steps:

1. Navigate to Module > Designers > Form Designers > Controls > Advance > List.
   

2. Drag and Drop the List on the View Builder.
   

3. Hover the cursor over the List control on the View Builder and click gear icon.

   

Configuring a List consists of various properties such as General Properties, Advance, Appearance, Data Source and Security. Refer to the following to learn more about configuration.

• Properties

• Advance

• Date Source

Properties

To configure Properties, perform the following steps:

1. Configuration screen is displayed.
   

2. Enter the appropriate values in the required fields.

   

   Figure: List Properties
   
   Following sections within the Properties tab provides details about the General and Informative fields:

   Field	Description
   General
   Label	This field is pre-populated with value named List. Consumer View of List Upon Labelling the List in the Form, the consumer will be able to view as displayed in the following image. Figure: List
   Sub Title	Specify the text which you want to display just beneath the Label. You may use it to describe the purpose of the control or the way it should be used. Sub Title on Incident Form Customers can view the Sub Title details on the Form. Figure: List - Sub Title
   Informative
   Help Text	Provide a Help Text that gives the end users guidance about the Fields. For example: "Columns from Table such as Notes to Self, Message, Incident details, etc".
   Tooltip	Add a tooltip that displays when the user hovers the cursor over the List control field.

Advance

To configure Advance properties, perform the following steps:

1. Click Advance to Configure advance settings for List page.

   

   Figure: Advance
   

2. Select the required options.
   
   For more information on field set refer to the following table:

   Field	Description
   Filter
   Simple Filter	If the Application Designer enables Simple Filter, then the consumers will get the following options: Add Filters Remove Filters There would be only AND relationship applicable between filters.
   Advance Filter	If the Application Designer enables Advance Filter, then the consumers will get the following options: Add Filters Remove Filters Define “AND” / “OR” relationship between filters Group multiple filters Define “AND”/ “OR” relationship between groups Note The App Designer can select both Simple Filter and Advanced Filter – In this case, the consumer (Ex: Analyst) would get the option to select the filter type required.
   Export Options
   Export to Excel	Enable Export to Excel to allow users to Export the Current List page or All the pages on the List.
   Export to PDF	Enable Export to PDF to allow users to Export the Current List page or All the pages on the List.
   Default Records
   Default Records per Page	Select the default records that need to be displayed when the page is loaded. The values range from 5 to 100 having a step size of five values between each other. (Example: 5, 10, 15, 20, etc.)
   Pagination Type	Select the type of pagination from the following values. This is used when the number of records exceed the default records per page. Pagination View: Displays the list in the paginated format such as numbered at the bottom of the list page. Virtual Scroll: Allows the user to scroll the list page virtually.

Data Source

Data can be obtained from Two sources, API and Table. Selecting either of them will display different configuration fields.

API Data Source Fields

If API is selected as Data Source then, Data Source and Grid View Styles sections are displayed.

Figure: API Data Source Fields

To configure API Data Source for List , refer to API.

Table Data Source Fields

If Table is selected as Data Source then, Data Source and Grid View Styles, Parameters and Form sections are displayed.

Figure: Table Data Source

To configure API Data Source for List , refer to Table.

API Data Source

To configure API Data Source, perform the following steps:

1. Select API from Data Source dropdown.

   Additional fields along with Table such as Origin and Type are displayed.

   

   Figure: API Data Source
   
   The following table, describes the API dependent fields:

   API Data Source	Description
   Table	Select Table from the dropdown, the contains all source tables (Database Tables) from the selected Module.
   Origin	Select Origin from the dropdown, following are the options provided. Cross Origin Same Origin
   Type	Select Type of API from the following options: Get Post

2. Select appropriate Grid View Style options for API Data Source.
   
   The following table, describe the field controls for this section.

   Grid View Style for API Data Source	Description
   Tabular View	Enabling Tabular View will represent the list in Table format. By default, this is always selected.
   Tile View	Enabling Tile View will represent list in Tile Format.
   Default View	Select Default list view from the dropdown, following are the options: Table Tile
   Address	Enter API URL in the Address field.
   Parameters	Select Parameters from the dropdown.
   Label Field	Enter Label Field name.
   Value Field	Enter Value in the Field.

Table Data Source

To configure Table Data Source, perform the following steps:

Selecting Table will enable following sections:

• Data Source

• Grid View Styles

• Parameters

• Form

Data Source

This section will allow the Application Designer to select Transaction Table from which the data can be obtained dynamically.
Example: Table can be of Manage Incidents, My Incidents etc.

Upon selecting a Table, Field mapping columns are displayed.

Figure: Table Data Source

Following table provides details about Field Description.

Field	Description
Table	Specifies the name of the Table and this field value is populated based on the Table selected in the Data Source.
Fields	Select Column from the Table. Example: If the selected Table is Manage Incidents, then all the columns from the Table are displayed in the dropdown. Like Analyst, Analyst Email ID, Incident ID etc. Note This field supports Dot walking mechanism. For more information, refer to Dot Walking.
Alias Name	Alias Name is reflected with same as Column Name. Icon Description Add icon is used to add multiple Alias Name. Delete icon is used to delete the existing Alias Name.

Grid View Styles

Select appropriate Grid View Style options for Table Data Source.

Figure: Data Source - Grid View Styles

The following table, describe the field controls for this section.

Parameters

Configuration of parameters are done through mapping Fields to Alias Name.

Figure: Parameters - Data Source

Following table provides details about Field Description.

Field	Description
Table	Specifies the name of the Table and this field value is populated based on the Table selected in the Data Source.
Fields	Select Column from the Table. Example: If the selected Table is Manage Incidents, then all the columns from the Table are displayed in the dropdown. Like, Description, Symptom, Incident ID etc.
Alias Name	Alias Name is reflected with same as Column Name. Icon Description Add icon is used to add multiple Alias Name. Delete icon is used to delete the existing Alias Name.

Form

The Form section displays on which Form the List is applicable to based on the selected Form the properties of List applies.

Figure: Form - Data Source

The following table provides details about the Field Description:

Click Save, to complete the configuration and return to Form Builder page else click Cancel to discard the configuration.