设计业务数据连接模型
通过将实体和方法添加到模型文件中为业务数据连接 (BDC) 服务开发模型。 实体描述数据字段的集合。 例如,实体可以表示数据库中的表。 方法执行添加、删除或更新由实体表示的数据等任务。 有关详细信息,请参阅将业务数据集成到 SharePoint。
添加实体
可通过将一个实体从 Visual Studio 的“工具箱”拖到或复制到 BDC 设计器上来添加实体 。 有关详细信息,请参阅如何:向模型添加实体。
定义类中实体的字段。 例如,可以将名为 Address
的字段添加到 Customer
类。 你可以向项目添加新的类或使用通过对象关系设计器(O/R 设计器)等其他工具创建的现有类。 实体的名称和表示实体的类的名称不必匹配。 在模型中定义方法时,将类与实体关联。
添加方法
当用户在基于模型的列表或 Web 部件中查看、添加、更新或删除信息时,BDC 服务会调用模型中的方法。 针对用户可执行的每个任务,必须向模型添加一个方法。 通过从“BDC 方法详细信息”窗口选择五种基本方法类型中的任意一种来创建方法。 下表描述了 BDC 模型的五种基本方法。
方法 | 说明 |
---|---|
Finder | 返回实体实例的集合。 当用户打开列表或 Web 部件时调用。 有关详细信息,请参阅如何:添加 Finder 方法。 |
特定的 Finder | 返回特定的实体实例。 当用户查看列表中特定项的详细信息时调用。 有关详细信息,请参阅如何:添加 Specific Finder 方法。 |
创建者 | 向实体的数据源添加新数据。 当用户在基于模型的列表的功能区上选择“新建项”按钮时调用。 有关详细信息,请参阅如何:添加 Creator 方法。 |
更新者 | 修改列表中的数据。 当用户更新列表中的信息时调用。 有关详细信息,请参阅如何:添加 Updater 方法。 |
删除者 | 删除数据。 当用户从列表中删除项时调用。 有关详细信息,请参阅如何:添加 Deleter 方法。 |
定义方法参数
创建方法时,Visual Studio 添加适用于方法类型的输入和输出参数。 这些参数只是占位符。 在大多数情况下,必须修改参数,以便它们传入或返回正确的数据类型。 例如,默认情况下,Finder 方法返回字符串。 在大多数情况下,需要修改 Finder 方法的返回参数,以便它返回实体的集合。 可以通过修改参数的类型描述符来实现此目的。 类型描述符是描述参数的数据类型的特性集合。 有关详细信息,请参阅如何:定义参数的类型描述符。
使用 Visual Studio,可在模型中的参数之间复制类型描述符。 例如,你可以为 GetCustomer
方法的返回参数定义一个名为 CustomerTD
的类型描述符。 可以在 BDC 资源管理器中复制 CustomerTD
类型描述符,然后将该类型描述符粘贴到 CreateCustomer
方法的输入参数。 这样,就不必多次定义同一类型描述符。
方法实例
创建方法时,Visual Studio 添加默认的方法实例。 方法实例是对方法的引用,加上参数的默认值。 单个方法可以有多个方法实例。 每个实例都是方法签名和一组默认值的组合。 有关详细信息,请参阅如何:定义参数的类型描述符。
运行项目时,方法实例将显示在 SharePoint 列表上方的下拉列表中。 用户可以选择方法实例来查看数据。
若要向方法实例添加默认值,必须直接修改模型的 XML。 有关详细信息,请参阅 DefaultValue。
添加筛选器描述符
模型的使用者可能想要检索与某些条件匹配的实体实例。 若要启用此功能,可以将筛选器描述符添加到方法。 筛选器描述符使模型使用者可以通过在执行方法之前将值传递给方法来筛选方法结果集。 有关详细信息,请参阅如何:向操作中添加筛选器参数以限制来自外部系统的实例。
SharePoint 提供了多个功能,使用户能够提供筛选器值。 例如,业务数据 Web 部件提供筛选器文本框。 用户可通过在该文本框中输入值来限制列表中的数据。 若要详细了解如何将筛选器描述符添加到方法,请参阅如何:向 Finder 方法添加筛选器描述符。
筛选器描述符属性
必须设置筛选器描述符的“关联类型描述符”、“名称”和“类型”属性的值 。 所有其他属性都可选。
“关联类型描述符”属性将筛选器描述符与输入参数关联。 当用户提供筛选器值时,BDC 服务会使用输入参数将该值传递到该方法中。
“类型”属性描述你想要使用的筛选模式。 在 SharePoint 中,选择的筛选模式会影响在用户界面 (UI) 中显示的文本。 例如,对于“比较运算符”筛选模式,文本“等于”显示为业务数据 Web 部件上方的控件。 有关每种筛选模式的详细信息,请参阅 BDC 支持的筛选器的类型。
有关筛选器描述符属性的详细信息,请参阅 FilterDescriptor。
提供默认值
在某些情况下,用户可能不会提供筛选器值。 可以通过向方法实例添加默认值或在方法代码中设置默认值来提供默认值。 有关如何向方法实例添加默认值的详细信息,请参阅 MethodInstance。 有关如何在方法代码中设置输入参数的默认值的示例,请参阅如何:向 Finder 方法添加筛选器描述符。
验证模型
可以在开发过程中验证模型。 Visual Studio 识别可能会阻止模型按预期运行的问题。 这些问题在 Visual Studio 的“错误列表”中显示。
可通过打开 BDC 设计器的快捷菜单,然后选择“验证”来验证模型。 如果模型包含任何错误,这些错误将显示在“错误列表”中。 你可以通过双击列表中的错误,快速将光标移至包含错误的代码。 或者,你可以反复选择 F8 或 Shift + F8 键,向前或向后浏览列表中的错误 。
当以某种方式违反了模型规则时,可能会发生验证错误。 例如,如果类型描述符的 IsCollection 属性设置为 true,但不存在子类型描述符,则会出现验证错误 。 可能必须参考 BDC 模型的规则,以理解出现在 Visual Studio 的“错误列表”中的错误。 有关 BDC 模型规则的详细信息,请参阅 BDCMetadata 架构。
调试包含模型的解决方案
可以像在 Visual Studio 中调试任何代码一样调试你的代码。 若要调试代码,请在代码中的任何位置设置断点,然后启动调试器。 Visual Studio 打开 SharePoint 站点。 在 SharePoint 中,创建使用业务数据的列表或 Web 部件。 然后,可以逐步执行代码。 有关调试 SharePoint 项目的详细信息,请参阅 SharePoint 解决方案疑难解答。
你还可以调试添加到项目的自定义程序集中的代码。 但是,若要调试自定义程序集中的代码,必须将该程序集添加到解决方案包。 有关详细信息,请查阅如何:添加和删除附加程序集。
有关将自定义程序集添加到项目中的详细信息,请查阅如何:在 BDC 功能中引入自定义程序集。
配置 BDC 安全性
在调试解决方案之前,可能必须在 SharePoint 中修改安全设置。 若要修改这些设置,请打开 SharePoint 2010 管理中心网站中的业务数据连接服务应用程序。 在“设置元数据存储权限”对话框中,添加用户帐户,然后选择以下任一选项:
任务 | 选项 |
---|---|
将模型部署到 BDC 服务。 | 编辑 |
通过使用模型中的外部内容类型(实体)创建列表和 Web 部件。 | 在客户端中可选 |
创建、读取、更新和删除实体数据。 | 执行 |
有关这些设置的详细信息,请参阅业务数据连接服务管理。
你还可以为单个模型或外部内容类型设置安全权限。 有关如何设置模型的安全权限的详细信息,请参阅 BDC 模型管理。 有关如何设置外部内容类型的安全权限的详细信息,请参阅外部内容类型管理。
注意
使用这些设置调试本地 SharePoint 服务器上的解决方案。 有关如何在生产 SharePoint 服务器上配置 BDC 相关的安全性设置的详细信息,请参阅业务数据连接服务安全性概述。
收回损坏的模型
当您第一次启动调试器时,Visual Studio 会将整个模型部署到 SharePoint。 此后的每一次,Visual Studio 都会在 SharePoint 中使用你在部署之间进行的任何更改来更新模型。
在某些情况下,你可能希望 Visual Studio 从 SharePoint 完全收回模型。 例如,模型可能会损坏。 若要将模型重新部署至 SharePoint,请将模型的“增量更新”属性设置为 False,然后启动调试器 。 选择在“BDC 资源管理器”中代表模型的节点时,“增量更新”属性将出现在“属性”窗口 。 默认情况下,模型的名称为 BdcModel1。
更改模型中实体的标识符名称
如果在部署模型后更改标识符的名称,可能会收到部署错误。 无法通过将模型的“增量更新”属性设置为 False 来解决此错误 。 必须手动收回模型,然后再次部署解决方案。 有关详细信息,请参阅对 SharePoint 解决方案进行故障排除。 可以通过在最初部署模型之前将“增量更新”属性设置为 False 来避免此错误 。
查找 BDC 模型元素的文档
Visual Studio 为创建的每个实体、方法或其他项向模型添加 XML 元素。 元素特性将作为属性出现在“属性”窗口中。 有关 Visual Studio 在你设计模型时生成的元素和特性的信息,请参阅 BDCMetadata 架构。
相关主题
Title | 说明 |
---|---|
BDC 模型设计工具概述 | 介绍可用于直观地为 BDC 设计模型的工具。 |
如何:将实体添加到模型 | 演示如何向模型添加外部内容类型或实体。 |
如何:添加 Finder 方法 | 演示如何添加使用户能够查看列表或 Web 部件中的实体列表的方法。 |
如何:添加 Specific Finder 方法 | 演示如何添加使用户能够查看特定实体详细信息的方法。 |
如何:添加 Creator 方法 | 演示如何添加一个方法,使用户能够直接从列表或 Web 部件向数据源添加记录。 |
如何:添加 Deleter 方法 | 演示如何添加一个方法,使用户能够通过使用列表或 Web 部件用户界面 (UI) 中的选项从数据源中删除数据。 |
如何:添加 Updater 方法 | 演示如何添加一个方法,使用户能够直接从列表或 Web 部件更改数据源中的数据记录。 |
如何:将参数添加到方法 | 演示如何在 Visual Studio 中使用“方法详细信息”窗口,向方法添加输入和返回参数。 |
如何:定义参数的类型描述符 | 演示如何在模型中定义参数数据类型。 |
如何:定义方法实例 | 演示如何创建 BDC 执行的方法的实例。 |
如何:将筛选器描述符添加到 Finder 方法 | 演示如何使用户能够限制 Finder 方法返回的实例数量。 |
创建实体之间的关联 | 描述如何定义模型中实体之间的关系。 业务数据 Web 部件、外部列表和自定义应用程序可以在用户界面 (UI) 中显示这些数据关系。 |
如何:创建实体之间的关联 | 演示如何定义模型中实体之间的关系。 |
演练:使用业务数据在 SharePoint 中创建外部列表 | 提供分步说明,说明如何创建和测试在 SharePoint 外部列表中显示联系人的模型。 |
将业务数据集成到 SharePoint 中 | 概述如何为 BDC 服务创建和设计模型。 |