List Builder
List builders provide an intuitive way to access data stored within Blackbaud CRM and help end users manage list of records for their day to day activities. List Builder's are similar to data lists in that they display rows of data within a grid. The SDK enables developers to provide an easy way for end users to flexibly access data without the need for the user to go through ad-hoc query to produce a data list.
An SDK developer can define a list builder using a QueryViewSpec and then place the list builder on a page. It is the query view that retrieves the data for the list builder. The query view utilizes a table valued function to pull the data.
Place on a Page
List builders are placed within a section on a page. For details, see Place a List Builder on a Page.
Figure: List builders are displayed within a page.
Actions
Actions can be defined within the page section to provide follow up actions on items within the list. The actions can navigate to other pages, open data forms, perform record operations, etc. For details, see Define Actions for Items within the List.
Figure: List builders enable follow up actions for the items within the list.
Actions can be performed on single records or multiple records. To perform an action on multiple records, check multiple rows followed by selecting the appropriate action above the list. For details, see Actions and AllowMultiSelect.
Figure: Select multiple rows and perform the action
Columns
With list builders the user can choose which columns you wish to display.
In version 3.0, the ListBuilder element's AllowColumnConfiguration attribute can prohibit the user from adding or removing columns from the list.
With list builders the user can arrange columns. By dragging and dropping column before or after another column in the list. Below, the user is moving the Gender column before the Age column.
In version 3.0, the ListBuilder element's AllowColumnConfiguration attribute can prohibit the user from dragging and reordering columns.
Filters
The data within the list can be filtered by selecting the filter icon next to a column header, providing filtering criteria, and applying the filter. In the figure below, the user is filtering the list for everyone who is above the age of 70.
Figure: Filter the Age column
Save and Open Lists
Lists can be saved by selecting the Save list button and providing a Name and Description. See Save a List for details. After a list is saved, it can be reopened by selecting the Open list button. No SDK-level action or configuration is required to achieve this functionality.
Lists can be easily exported to Microsoft Excel by selecting the appropriate excel icon. See Export Lists for details. No SDK level action or configuration is required to achieve this functionality.
Search box
The data in the list can be searched via the Search box.
Code Samples and Videos
A food bank list builder code sample can be found within the catalog project's Blackbaud.CustomFx.FoodBank.Catalog\ListBuilder\Final\FoodBankListBuilder.Query.xml spec file. Be sure to download and review the sample within the latest food bank source code.
List Builder code samples can be found within the kitchen sink which is included as a sample when the SDK is installed. For related videos see: Blackbaud Infinity List Builder Videos and Blackbaud Infinity What's New - Kitchen Sink Videos
Additional Information