Create a business data connectivity model

  • Article

Applies to: yesVisual Studio noVisual Studio for Mac

Note

This article applies to Visual Studio 2017. If you're looking for the latest Visual Studio documentation, see Visual Studio documentation. We recommend upgrading to the latest version of Visual Studio. Download it here

You can create a Business Data Connectivity (BDC) model or customize an existing BDC model by using Visual Studio. Each SharePoint project can contain only one model. For more information, see Integrate business data into SharePoint.

Create a new model

To create a new model, create a Business Data Connectivity Model project or add a Business Data Connectivity Model item to an Empty SharePoint Project.

Note

You must have Microsoft SharePoint Server installed on your computer.

Visual Studio adds a folder to the project. This folder has the name that you specify for the Business Data Connectivity Model item in the Add New Item dialog box. If you create a new Business Data Connectivity Model project, Visual Studio names the folder BdcModel1.

Visual Studio adds the following files to the new folder:

File Description
Model Definition File Contains XML that defines the entities, methods, Line of Business (LOB) system objects, and other metadata that describes the model.

Modify the metadata in this file by using the BDC Designer, BDC Explorer, BDC Method Details window, and Properties window.
Entity Service Code File Contains methods that retrieve, update, and delete instances of the default entity.

To define the properties of an entity, edit the entity code file. For more information, see How to: Add an entity to a model.

To retrieve, update, and delete instances of an entity, add code to the entity service code file. For more information, see Designing a business data connectivity model.

When you compile the project, Visual Studio creates an assembly. Ensure that you do not add other items to the project that add code to the project assembly (For example: a Sequential Workflow item or a Web Part item). The code for that item will not run when you deploy the solution because the solution package does not copy the assembly to the global assembly cache. The solution package deploys the assembly to the BDC database in SharePoint only.

Note

Visual Studio copies the assembly to both locations on your local computer when you debug the project.

Add an existing model

You can import a model that was created by using other tools such as SharePoint Designer. You might choose to import an existing model to your project in the following situations:

  • To customize a model that is already deployed to a SharePoint server farm.

  • To package and deploy an existing model to multiple SharePoint server farms.

    In either case, the LOB systems defined in the model that you import are not affected and will continue to work as expected. To add an existing model to a SharePoint project, use the Visual Studio Add Existing Item dialog box. For more information, see How to: Add an existing BDC model file to a SharePoint project.

    You can add a LOB system of type .NET Framework assembly to the imported model by selecting an option in the Add .NET assembly LobSystem. This enables you to write custom code and use a designer to define the metadata for the imported model.

Title Description
How to: Create a BDC model Shows you how to create a new BDC model.
How to: Add an existing BDC model file to a SharePoint project Shows you how to import an existing model into a SharePoint project.
How to: Use a resource file to specify localized names, properties, and permissions Describes how to provide strings that are merged with model metadata when the model is consumed by a Web Part or Web Page.
How to: Include a custom assembly in a BDC feature Shows you how to include a custom assembly in the feature.