Skip to end of metadata
Go to start of metadata

You are viewing an old version of this content. View the current version.

Compare with Current View Version History

« Previous Version 20 Next »

  • The list view component represents a list of records that you created or have read or write access to and records shared with you of an object

  • One object can have multiple list views. However, one list view can show the record of a single object

List view creation

You need to provide the following information while creating a list view

  1. Label: Label is used to identify the list view at the UI. You can have multiple list views with the same label in an instance, the label of the listview can be edited if needed

  2. Name: The name is the combination of the instance prefix (the unique identifier of the instance) and the given label joined with double underscores which are used to uniquely identifies the list view within the PWR Apps platform. Hence, it is used to perform backend operations

    • For example, if the instance prefix is “inst” and the label of the listview is “List View”, then then the name of the list view will be “inst__listView”

  3. Object: You need to select the object for which you want to create the list view

  4. Sharing Settings: To manage access to the list view. The List view access can be:

    • Only Me: Only the creator of the list view can access the list view

    • Public: All the members of the instance can access the list view

    • Specific User or Profile: You can define the set of users or profiles who can access the list view

List view

  1. Icon: You can set the icon for the list view

  2. Object name: For which the list view is created

  3. List view label: Which list view is selected

  4. Number of records in the object: Total number of records in the object

  5. Table actions: Actions on the list view

  6. Search bar: To search the particular records, a search will be performed on the fields which are selected as search fields

  7. Filter: To filter the records on the list view. This will filter will be removed as soon as the page is loaded or refreshed

  8. Export: All the records from the listview can be exported in CSV, excel, or pdf format

  9. Display Fields: Object fields to be displayed in the listview

  10. Index: Show the index on the records

  11. Row Actions: Actions to be performed at the record level

  12. Page Size: Total records to be displayed on one page

  13. Pagination: To go to other pages if the record count is more. Maximum pages= (total number of records/page size)

  14. Setting: You can change the list view setting as per your requirements using the following options:

  • New: To create the new list view of the selected object

  • Clone: This will clone the selected list view will all the settings and configurations

  • Rename: Selected listview can be renamed

  • Display Fields: You can select the fields of the object to be displayed in the list view. The name field is the default display field in any listview, which can be changed

  • Search Fields: You can select the fields of the object on which you want the search to be performed. The name field is the default display field in any listview, which can be changed

  • Filter Fields: You can select the fields using which you can filter the records on the list view

  • UI Fields:

  • Filters: You can define the filters on the records to be displayed on the list view

  • Delete: To delete the list view. Only the admin or the list view creator can perform the delete operation

  • Sharing Settings: The creator of the list view can change the sharing setting even after the list view creation

  • Config: Following are the configurations of the listview

  • Attributes

    • Is List View Selectable: The user can change the list view if this is set as true

    • Is Object Selectable: The User can change the object if this is set as true

    • Table Actions: You can create multiple actions on the list view. These actions are mainly used to perform create, read, update or delete in bulk on object

    • Row Actions: You can create multiple actions at the row level on the list view. These actions are mainly used to perform ready, update or delete a single record

    • Column Actions: You can set the actions at the column level on the listview. In PWR Apps, 1st-row action is treated as the 1st column action

    • Layout For New: In the PWR Apps, one object can have multiple record layouts. Hence, you can set which record layout should get open while creating a new record

    • Layout For Edit: Similar to the Layout For New, you can set the record layout to edit the record

      • Is Same As New: Check this checkbox, If you want to keep the same layout for new and edit.

    • Offset: You can set the offset for the query on the object. If the offset is “n“ then the query will take the records “n+1” onwards

    • Limit: Number of the records to be queried at once

    • Order By: You can set the order by on the fields to records to be queried and displayed in the list view

    • Filter Section Header: Text entered in the field will be displayed as the header of the modal while applying filters

    • Config

      • Icon: You can select the icon to be displayed on the listview

      • No Icon: Icon will not be displayed if this checkbox is checked

      • Inline Edit: Records can be edited at the list view if this checkbox is checked

      • Show Index: To show the index of records on the list view

      • Show Page Size Drop Down up:

      • Is Export Supported?: All the records can be exported in CSV, excel, or pdf format

  • Events

    • You can bind the actions to all the Table, Row, and Column actions from events

    • List view comes with following default actions, which can be edited as per requirements. You can perform these actions only if you have the specific access to the object as well as the field level:

      • Table actions

        • New: To create a new record

        • Refresh: Query the records

        • Delete Selected: This is bulk action. This action will be visible only after selecting 2 or more records and deletes all the selected records

      • Row actions

        • View: This action opens record in view mode

        • Edit: This will open the record in edit mode

        • Delete: To delete the specific record

      • Colum actions

        • 1st-row action will be treated as the 1st column action

        • If any lookup type field is selected as a display field then the column action will open the parent record in view mode

        • If any email and phone type field is selected as display field the the column action will open the default mailer or dialer, repectivily

How to use a ListView on the layout designer page: 

Steps: 

  • Goto component section 

  • Search and select the List View component in the component section 

  • Drag and drop the ListView component in the Layout 

  • Select an object and List View Name

Configurations of a ListView component 

  • Object: Used to select an object  

  • List View Name: Used to select a List View name 

  • Is List View Selectable: This checkbox is used to search and select List View 

  • Is Object Selectable: This checkbox is used to search and select Object 

  • Table Actions: The user can add the Table Action by clicking on the ‘ + ‘ icon 

If the actions are standard then displayed with a Lock sign and if it is custom, displayed with a cross.

  • Row Actions: The user can add the Row Action by clicking on the ‘+ ‘ icon  

  • Column Action: User can add Column Actions 

  • Layout For New: If multiple layouts are available for a single object, then this is used to select one of them to create a new record. 

  • Layout For Edit: If multiple layouts are available for a single object, then this is used to select one of them to edit the records. 

  • Is Same as New: 

  • Offset: It is an argument used to decide the starting record from which the list of records should be displayed in the List View. 

  • Limit: It is an argument used to decide the number of records to be displayed in the List View 

  • Order By: This can be used to sort the field in ascending or descending order. 

  • Filter Section Header: 

  • Icon: An icon is a symbolic image that a user can select to display on a List View

  • No Icon: This is the checkbox used to display the icon on List View or not. If the checkbox is true, then no icon will be displayed on List View. If False then the selected icon will be displayed on List View 

  • Show Index: This is a checkbox used to display the index of records in List View. If the checkbox is true Indexes for records will be displayed and if false Indexes will not be displayed on List View

  • Show Page Size Drop Down Up: It is a checkbox used to show the page size dropdown list in up. 

  • Is Export Supported? :

  • Is Local Supported? :

 

 

 

  • No labels