Select your user interface:

Explore a Data List Spec

Data lists are composed of four main elements:

  • A stored procedure that returns a result set

  • A context definition that defines the type of record the list is based

  • An optional set of parameters that the stored procedure accepts

  • A set of output field metadata for how to render the results of the stored procedure

You will notice the spec contains SPDataList, Context, Parameters, and Output elements. Let’s view a typical Data List Spec that comes with the Widget Catalog project as part of the SDK. The figure below displays a sample data list named WidgetParts.DataList.XML that can be found within the samples section of the SDK.

A typical data list
User interface for Widget Parts data list
User interface for Widget Parts data list

Within SPDataList, you will find the CreateProcedureSQL child element that includes a stored procedure that more than likely narrows the result set based on a parameter or context. The context may be defined by the Context element that indicates the record type of the context and the stored procedure parameter that provides the context ID for the data list to filter on. Within the user interface, you can provide filtering capabilities on the data list. Filters are made possible by the Parameters element where you provide form field metadata to describe the field ID and the data type of the filter. The Output element contains a list of OutputField child elements that define the fields the data list displays. Within the OutputField element, the FieldID attribute corresponds with a field name returned by the stored procedure.