创建自定义工作流 (Master Data Services)

2013-05-08

Master Data Services 使用业务规则创建基本工作流解决方案，如自动更新和验证数据，并根据指定的条件发送电子邮件通知。当您需要的处理比内置工作流操作提供的处理更复杂时，请使用自定义工作流。自定义工作流是您创建的 .NET 程序集。在调用您的工作流程序集时，您的代码可以执行您的情况所需要的任何操作。例如，如果您的工作流要求复杂的事件处理（如多层审批或复杂的决策树），您可以配置 Master Data Services 来启动自定义工作流，以便分析数据和确定将其发送到何处以待审批。

如何处理自定义工作流

有三个涉及处理自定义工作流的主要组件：主数据管理器 Web 应用程序、SQL Server MDS Workflow Integration Service 和工作流处理程序程序集。这些组件按如下所示处理自定义工作流：

您使用主数据管理器来验证启动工作流的实体。
主数据管理器将满足业务规则条件的成员发送到 Master Data Services 数据库中的 Service Broker 队列。
SQL Server MDS Workflow Integration Service 定期调用 Master Data Services 数据库中的存储过程。
当此存储过程发现 Service Broker 队列中的记录时，它将这些记录返回到 SQL Server MDS Workflow Integration Service。
SQL Server MDS Workflow Integration Services 将数据路由到您的工作流处理程序程序集。

注意
注意：SQL Server MDS Workflow Integration Service 旨在触发简单的过程。如果您的自定义代码需要复杂处理，请在单独的线程中或工作流进程之外完成您的处理。

为自定义工作流配置 Master Data Services

创建自定义工作流需要编写一些自定义代码，并将 Master Data Services 配置为将工作流数据传递给工作流处理程序。请按照以下步骤启用自定义工作流处理：

创建实现 Microsoft.MasterDataServices.WorkflowTypeExtender.IWorkflowTypeExtender 的 .NET 程序集。
配置 SQL Server MDS Workflow Integration Service 以连接您的 Master Data Services 数据库，并将标记与您的工作流处理程序关联。
启动 SQL Server MDS Workflow Integration Service。
在主数据管理器中创建业务规则，以启动标记了工作流处理程序名称的工作流。
将此业务规则应用到成员，以触发您的自定义工作流。

创建工作流处理程序程序集

自定义工作流为 .NET 类库程序集，用于实现 Microsoft.MasterDataServices.WorkflowTypeExtender.IWorkflowTypeExtender 接口。 SQL Server MDS Workflow Integration Service 调用 StartWorkflow 方法运行您的代码。有关实现 StartWorkflow 的示例代码，请参阅自定义工作流示例 (Master Data Services)。

按照以下步骤使用 Visual Studio 2010 创建 SQL Server MDS Workflow Integration Service 可以调用来处理自定义工作流的程序集：

在 Visual Studio 2010 中，创建使用您选择的语言的新**“类库”项目。若要创建 C# 类库，请选择 Visual C#\Windows 项目类型，并选择“类库”模板。输入您的项目名称，如 MDSWorkflowTest，然后单击“确定”**。
将引用添加到 Microsoft.MasterDataServices.WorkflowTypeExtender.dll。此程序集位于 <您的安装文件夹>\Master Data Services\WebApplication\bin。
将“using Microsoft.MasterDataServices.Core.Workflow;”添加到您的 C# 代码文件。
从类声明中的 Microsoft.MasterDataServices.WorkflowTypeExtender.IWorkflowTypeExtender 继承。该类声明应类似于：“public class WorkflowTester : IWorkflowTypeExtender”。
实现 Microsoft.MasterDataServices.WorkflowTypeExtender.IWorkflowTypeExtender 接口。 SQL Server MDS Workflow Integration Service 调用 StartWorkflow 方法来启动您的工作流。
将您的程序集复制到 SQL Server MDS Workflow Integration Service 可执行文件（名为 Microsoft.MasterDataServices.Workflow.exe）的位置（在<您的安装文件夹>\Master Data Services\WebApplication\bin 中）。

配置 SQL Server MDS Workflow Integration Service

按照如下步骤编辑 Master Data Services 配置文件以包含您的 Master Data Services 数据库的连接信息，并将标记与您的工作流处理程序程序集关联：

在 <您的安装文件夹>\Master Data Services\WebApplication\bin 中查找 Microsoft.MasterDataServices.Workflow.exe.config。
将 Master Data Services 数据库连接信息添加为“ConnectionString”设置。如果您的 SQL Server 安装使用区分大小写的排序规则，则必须以与数据集中相同的大小写输入数据库的名称。例如，完整设置标记可能类似以下形式：
```
<setting name="ConnectionString" serializeAs="String">
    <value>Server=myServer;Database=myDatabase;Integrated Security=True</value>
</setting>
```
在“ConnectionString”设置下，添加“WorkflowTypeExtenders”设置以将标记名称与您的工作流处理程序程序集关联。例如：
```
<setting name="WorkflowTypeExtenders" serializeAs="String">
    <value>TEST=MDSWorkflowTestLib.WorkflowTester, MDSWorkflowTestLib</value>
</setting>
```
<值> 标记的内部文本的格式为 <工作流标记>=<程序集限定工作流类型名称>。 <工作流标记> 是您在主数据管理器中创建业务规则时，用于定义工作流处理程序程序集的名称。 <程序集限定工作流类型名称> 是您的工作流类的命名空间限定名称、后跟一个逗号，然后是程序集的显示名称。如果您的程序集采用强名称，则还必须包括版本信息及其 PublicKeyToken。如果您已为不同类型的工作流创建了多个工作流处理程序，则可以包含多个 <设置> 标记。

注意
根据您的服务器的配置，在尝试保存 Microsoft.MasterDataServices.Workflow.exe.config 文件时，可能会显示一条“拒绝访问”错误。如果发生这种情况，则暂时禁用服务器上的用户帐户控制 (UAC)。为此，打开“控制面板”，单击“系统与安全”。在“操作中心”下，单击“更改用户帐户控制设置”。在“用户帐户控制设置”对话框中，将该图条滑动到底部以便不再通知您。重新启动您的计算机，然后重复前面的步骤以编辑您的配置文件。保存该文件之后，将您的 UAC 设置重置为默认级别。

根据您的服务器的配置，在尝试保存 Microsoft.MasterDataServices.Workflow.exe.config 文件时，可能会显示一条“拒绝访问”错误。如果发生这种情况，则暂时禁用服务器上的用户帐户控制 (UAC)。为此，打开“控制面板”，单击“系统与安全”。在“操作中心”下，单击“更改用户帐户控制设置”。在“用户帐户控制设置”对话框中，将该图条滑动到底部以便不再通知您。重新启动您的计算机，然后重复前面的步骤以编辑您的配置文件。保存该文件之后，将您的 UAC 设置重置为默认级别。

启动 SQL Server MDS Workflow Integration Service

默认情况下，不安装 SQL Server MDS Workflow Integration Service。您必须先安装此服务，才能使用它。为获得最大安全性，为该服务创建一个本地用户，并仅为该用户授予执行工作流操作所需的权限。若要创建用户，请按照以下步骤安装此服务，然后启动该服务：

使用“本地用户和组”管理器创建名为（例如，mds_workflow_service）的本地用户。
使用 SQL Server Management Studio 向 mds_workflow_service 用户授予执行 [mdm].[udpExternalActionsGet] 存储过程的权限。为此，请为 mds_workflow_service 帐户创建一个新的登录名，并在 Master Data Services 数据库中创建一个新用户，然后将此用户映射为 mds_workflow_service 登录名，为用户授予对 [mdm].[udpExternalActionsGet] 存储过程的 EXECUTE 权限。
向 mds_workflow_service 用户授予执行工作流处理程序程序集的权限。为此，将 mds_workflow_service 用户添加到工作流处理程序程序集的**“属性”的“安全性”**选项卡，然后向 mds_workflow_service 用户授予 READ 权限和 EXECUTE 权限。
向 mds_workflow_service 用户授予执行 SQL Server MDS Workflow Integration Service 可执行文件的权限。为此，将 mds_workflow_service 用户添加到 Microsoft.MasterDataServices.Workflow.exe（位于 <您的安装文件夹>\Master Data Services\WebApplication\bin 中）的**“属性”的“安全性”**选项卡中，并向 mds_workflow_service 用户授予 READ 权限和 EXECUTE 权限。
通过使用 .NET 安装实用工具（名为 InstallUtil.exe）来安装 SQL Server MDS Workflow Integration Service。 InstallUtil.exe 位于 .NET 安装文件夹中，如 C:\Windows\Microsoft.NET\Framework\v4.0.30319\。通过在提升的命令提示符中输入以下命令安装 SQL Server MDS Workflow Integration Service：
```
C:\Windows\Microsoft.NET\Framework\v4.0.30319\InstallUtil Microsoft.MasterDataServices.Workflow.exe
```
在安装过程中出现提示时，指定 mds_workflow_service 用户。
通过使用“服务”管理单元来启动 SQL Server MDS Workflow Integration Service。为此，在“服务”管理单元中找到 SQL Server MDS Workflow Integration Service，然后单击**“开始”**链接。

创建工作流业务规则

在应用时，使用主数据管理器来创建和发布将启动工作流的业务规则。应确保业务规则包含更改属性值的操作，以便该规则应用一次后，其计算结果为 False。例如，当 Price 属性值大于 500 且 Approved 属性值为空时，您的业务规则可能计算为 True。该规则可能包含两个操作：一个操作是将 Approved 属性值设置为“挂起”，另一个操作是启动工作流。或者，您可能要创建一个使用“已更改”条件的规则，并将您的属性添加到更改跟踪组。有关业务规则的详细信息，请参阅业务规则 (Master Data Services)。

按照以下步骤在主数据管理器中创建用于启动自定义工作流的业务规则：

在主数据管理器的业务规则编辑器中，在指定业务规则的条件之后，将**“启动工作流”操作从“外部操作”列表拖动到 THEN 窗格的“操作”**标签。
在**“编辑操作”窗格中的“工作流类型”**框中，键入标识您的工作流处理程序程序集的标记。这是您在您的程序集的配置文件中指定的标记，例如 TEST。
或者，您可以选中**“包含成员数据”**复选框。选中此复选框可以在 XML 中包括传递到工作流处理程序的的属性名称和值。
在**“工作流站点”**框中，键入网站的名称。对于您的自定义工作流，此方法不适用，但可用于添加的内容。
在**“工作流名称”**框中，键入来自 Visual Studio 的工作流的名称。对于您的自定义工作流，此方法不适用，但可用于添加的内容。
保存并发布业务规则。

应用业务规则以启动工作流

将此业务规则应用于您的数据，以启动工作流。为此，使用主数据管理器以编辑包含要验证的成员的实体。单击**“应用业务规则”**。为了响应此业务规则，主数据管理器将填充 Master Data Services 数据库的 Service Broker 队列。当 SQL Server MDS Workflow Integration Service 检查该队列时，它将数据发送到指定的工作流处理程序程序集并清除该队列。工作流处理程序程序集执行已编码到队列中的任何操作。

排除自定义工作流故障

如果工作流处理程序程序集不接收数据，则可以尝试调试 SQL Server MDS Workflow Integration Service 或查看 Service Broker 队列。

调试 SQL Server MDS Workflow Integration Service

若要调试 SQL Server Workflow Integration Service，请执行以下步骤：

使用“服务”管理单元以停止服务。
打开命令提示符，导航到此服务的位置，通过输入 Microsoft.MasterDataServices.Workflow.exe -console 在控制台中运行此服务。
在主数据管理器中，更新您的成员，并再次应用业务规则。控制台窗口中将显示详细日志。

查看 Service Broker 队列

包含作为工作流一部分传递的主数据的 Service Broker 队列为：mdm.microsoft/mdm/queue/externalaction。队列位于 Master Data Services 数据库的 Service Broker 节点下的 SQL Management Studio 的**“对象资源管理器”**中。请注意，如果此服务已正确清除队列，则此队列将为空。

请参阅

概念

自定义工作流示例 (Master Data Services)

自定义工作流 XML 说明 (Master Data Services)

通过