SharePoint 2013 BCS: Create External Content Type Based on Stored Procedure

  • Article

Introduction

We have a requirement wherein we will be using External Content Type (BCS) using a Stored Procedure.

  • The stored procedure has parameters.
  • We have to set up Read List and Read Item parameters

Objective

The objective of this exercise is to write a Stored Procedure that returns a list of SharePoint History from the SharePoint Test database and displays these results by using the Business Data List web part. We will also see how we can use various filters (ID for our example) to limit the result set returned by the stored procedure.

Steps

Create External Content Type

In this step, we will use SharePoint Designer to create an External Content Type from the stored procedure created in the previous step.

  1. Browse to the “SharePoint – 80? site in your development environment.

  2. On the Site Actions drop-down, click Edit in SharePoint Designer.

  3. In the Navigation pane, click External Content Types.

  4. In the New group of the ribbon, click External Content Type.

  5. In the External Content Type Information group, edit each of the parameters as below and leave the remaining to their default settings.

    Property

    Value

    Name

    SharePoint History

    Display Name

    SharePoint History

    Namespace

    SharePointTest

    Version

    1.0.0.0

  6. Next to External System, click Click here to discover external data sources and…

    http://www.enjoysharepoint.com/photo/sharepoint-2013-external-content-type.png

  7.  In the Data Source explorer, expand the SharePoint Test to find the stored procedure sp_Sharepoint_History under the Routines node.

    http://www.enjoysharepoint.com/photo/create-external-content-type-sharepoint-2013.png

  8. Right click on sp_Sharepoint_History to open a pop-up menu and click New Read List Operation.

  9.  Click the Next > button at the bottom of the Read List dialog.

  10.  On the Input Parameters page, click @ID in the Data Source Elements pane.

  11.  In the Properties pane, edit the values as below. Then, click Click to Add against the Filter property.

  12.  In the Filter Configuration dialog, select New Filter. Edit the properties as below leaving the rest to their default. Then click OK.

    Property

    Value

    New Filter

    ID

    Filter Type

    Comparison

    Operation

    Equals

    http://www.enjoysharepoint.com/photo/create-external-content-type-sharepoint-2013-2.png

  13.  Click the Next> button at the bottom of the Read List dialog.

  14.  On the Return Parameters page, click ID in the Data Source Elements pane.

  15.  In the Properties pane, check the box for Map to Identifier and Show In Picker.

    http://www.enjoysharepoint.com/photo/sharepoint-2013-exteral-content-type-bcs.jpg

  16.  Click the Finish button.

  17.  Click the Save button in the Quick Access Toolbar to commit the changes.

  18.  Navigate to your SharePoint 2013 site.

  19.  From this page select the Site Actions | Edit Page.

  20.  Click on Add a Web Part, in the left web part zone.

  21.  From the web parts selection menu, select Business Data in the Categories section and then from the list of web parts select Business Data List and click add.

    http://www.enjoysharepoint.com/photo/sharepoint-2013-exteral-content-type-bcs-1.jpg

  22.  From the web part’s action menu, click on Edit Web Part to open the tool pane for this web part.

  23.  In the Business Data List section of the edit pane, click on the picker icon next to Type field to bring up the External Content Type Picker dialog form.

    http://www.enjoysharepoint.com/photo/create-external-content-type-sharepoint-2013-3.png

  24.  In the dialog form, select the content type created in the previous steps and click OK.

    http://www.enjoysharepoint.com/photo/create-external-content-type-sharepoint-2013-4.png

  25.  For the View Property, select Default (SharePoint History Read List) in the drop down.

    http://www.enjoysharepoint.com/photo/create-external-content-type-sharepoint-2013-5.png

  26.  Then click OK in the web part’s tool pane.

 Final O/P

http://www.enjoysharepoint.com/photo/create-external-content-type-sharepoint-2013-6.png

Now we have seen how to configure the External Content Type and Business data List Web Part to make BCS looks like SharePoint List.