连接到BCS服务并获取实体——BCS对象模型

本文中我们将讨论如何通过编程的方式连接到BCS服务并获取已经部署的BCS外部内容类型的基本信息。 

我们将创建一个Visual Studio 2010新增的可视化WebPart 。包括一个很简单的用户界面。在该WebPart的代码中我们将使用BCS对象模型。

步骤 

1）打开Visual Studio 2010并创建一个Visual Web Part项目。

2）在设计视图中编辑用户界面 ，从工具箱中添加一个literal控件。我们将使用这个简单的用户界面和literal控件稍后来显示一些信息。

3）下一步我们需要添加到Microsoft BusinessData程序集的引用。在解决方案资源管理器重右击引用，并选择添加引用。

4）在添加引用对话框中，转到浏览标签，浏览到C:\Program Files\Common Files\Microsoft Shared\Web Server Extensions\14\ISAPI。添加Microsoft.BusinessData程序集。

5）查看该可视化Web部件对应的用户控件的代码视图 （VisualWebPart1UserControl.ascx.cs）并添加下列命名空间。

using Microsoft.SharePoint; 
using Microsoft.SharePoint.BusinessData; 
using Microsoft.SharePoint.BusinessData.SharedService; 
using Microsoft.BusinessData.MetadataModel; 
using Microsoft.BusinessData.Runtime; 
using Microsoft.SharePoint.Administration;

6）添加下列方法到Page_Load方法后面。

private void GetExternalContentTypesAndLobSystems()
{ 
    //获取BCS服务的引用
    BdcService service = SPFarm.Local.Servers.GetValue<BdcService>();

    //获取元数据目录
    IMetadataCatalog catalog = service.GetDatabaseBackedMetadataCatalog(SPServiceContext.Current);

    //为literal控件指定一些抬头
    Literal1.Text = "<h1>Lob Systems and Entities ... </h1> " + "</br>";
    
    //从元数据目录中获取所有的外部内容类型
    foreach (IEntity ect in catalog.GetEntities("*"))
    {
        //添加外部内容类型的名称和相应的核心业务系统名称到literal控件
        Literal1.Text += ect.Name + "," + ect.GetLobSystem().Name + "</br>";
    }
}

我们加了一些注释在代码里，可以帮助你理解我们都借助哪些对象来获得外部内容类型的清单。下面我们将进行详细解释。在上面用到的方法往往有很多重载，这里我们只解释我们例子中用到的部分。

首先我们需要引用BdcService对象，这需要借助SPFarm对象的Services属性。

 BdcService service = SPFarm.Local.Servers.GetValue<BdcService>();

接下来，我们需要获取MetaData元数据目录，它包含了我们已经部署的所有外部内容类型。这需要借助于BdcService对象的GetDatabaseBackedMetadataCatalog方法， 该方法需要一个服务上下文作为参数。由于我们的代码最终是在可视化WebPart中执行，因此我们可以利用网页当前服务上下文。

 IMetadataCatalog catalog = service.GetDatabaseBackedMetadataCatalog(SPServiceContext.Current);

当我们获得元数据目录的引用后，我们就可以获取已部署外部内容类型的相关信息了。IMetaDataCatalog接口包含一个GetEntities方法，该方法需要一个通配符参数作为输入参数，然后就可以根据该参数返回一个可枚举的IEntity类型的对象集合。 我们用了"*"参数来获取所有的外部内容类型。

 foreach (IEntity ect in catalog.GetEntities("*"))

当我们得到一个IEntity对象后，我们就可以使用Name属性，以及调用GetLobSystem()方法来获取该外部内容类型对应的核心业务系统 。

 Literal1.Text += ect.Name + "," + ect.GetLobSystem().Name + "</br>" ;

7）从可视化WebPart对应的用户控件的Page_Load方法中调用新添加的方法。

protected void Page_Load(object sender, EventArgs e) 
{ 
    GetExternalContentTypesAndLobSystems(); 
}

8）现在，当所有事情都完成后，CTRL+F5编译并部署该可视化WebPart。

9）打开你的SharePoint站点，点击顶部功能区上的页面标签，并点击编辑按钮。

10）当页面处于编辑模式后，点击功能区中的插入标签，并点击Web部件按钮。

11）在分类一节中点击Custom组，你就能看到VisualWebPart1了。将其添加到页面中。

12）当WebPart被添加到页面后，它将执行Page_Load方法，调用我们的GetExternalContentTypesAndLobSystems方法。相应的外部内容类型和业务系统名称就显示出来了。 

 

在后面的文章中，我们将深入更多的细节，借助BCS数据用C#代码来做一些更酷的事情。 

参考资料

connect to bdcservice and getentities – bcs object model