演练:使用插件注册工具注册插件
发布日期: 2017年1月
适用于: Dynamics 365 (online),Dynamics 365 (on-premises),Dynamics CRM 2016,Dynamics CRM Online
本演练演示如何通过使用 SDK 中提供的 Plug-in Registration 工具来注册插件。 要注册的插件是示例:创建基本插件主题中的 FollowupPlugin。
插件将会在 account 实体、CreateRequest 消息、后期事件和沙盒中进行注册。 也可以在用户帐户具有系统定制员或系统管理员角色的任何 Microsoft Dynamics 365(在线或本地) 部署中注册插件。
开始本演练之前,必须完成以下必备条件:
获取位于 SDK 的 Tools\PluginRegistration 文件夹中的 PluginRegistration.exe 工具。下载 Microsoft Dynamics CRM SDK 包。
在 Microsoft Dynamics 365 服务器上获取系统用户帐户。
您的用户帐户必须具有系统定制员或系统管理员角色。 请参阅“如何在 Microsoft Dynamics 365 中使用基于角色的安全性控制对实体的访问权限”。
连接到 Microsoft Dynamics 365 服务器
运行 Plug-in Registration 工具。
单击“创建新连接”。
在“登录”对话中,选择与您要用其注册插件的 Microsoft Dynamics 365 服务器相对应的部署类型单选按钮。 “本地”单选按钮包括 IFD 部署,“联机”按钮针对 Microsoft Dynamics 365 (online) 的 Windows Live 提供商,“Office 365”按钮针对 Microsoft Dynamics 365 (online) 的 Microsoft Online Services 提供商。
联机部署的登录窗口
内部部署的登录窗口
如果您选中“始终显示可用组织的列表”,在您单击“登录”后,将呈现您所属的组织的列表。 这使您能够选择要用其注册插件的组。 否则,使用您的默认组织。
输入有关服务器和登录帐户的指示信息,然后单击“登录”。
您应看到注册插件或自定义工作流活动程序集和服务端点的折叠列表。Microsoft Dynamics 365 需要活动源和 Microsoft.Crm.ObjectModel 程序集才可以正常运行,从而使工具防止您修改它们。 在显示有关列表项的“属性”“详细信息”选项卡窗格中,选择结果列表中的该项。
应用程序主窗口
注册插件程序集
选择组选项卡使其激活。
在选项卡的工具栏中,单击“注册”,然后选择“注册新程序集”。
在“注册新程序集”对话框中,单击“步骤#1”字段右侧的省略号[…]按钮。
在“打开”对话框中,导航到已编译的 SamplePlugin.dll 程序集所在位置。 默认位置为 SDK\SampleCode\CS\Plug-ins\bin\Debug。 选择该程序集,然后单击“打开”。
在“步骤#2”部分,展开“SamplePlugins”程序集,以查看该程序集中的所有插件。 只选择(检查)“Microsoft.Crm.Sdk.示例.FollowupPlugin”插件。
在“步骤#3”部分,选择“沙盒”选项。
在“步骤#4”部分,选择“数据库”选项。
注册程序集对话
单击“注册所选插件”。 您可以关闭任何开启的对话框。
在树视图中显示的注册插件
提示
您是否看到“登录”区域中显示的一则错误,并且该登录包含以下信息?
<Message>Action failed for assembly 'SamplePlugins, Version=0.0.0.0, Culture=neutral, PublicKeyToken=829f574d80e89132': Deployment/Scalegroup does not allow running external code.</Message>
如果是,您必须重新启用服务器上的自定义代码,然后重试。 有关详细信息,请参阅启用或禁用自定义代码执行。
SamplePlugins.dll 程序集和 FollowupPlugin 插件现在已注册并部署到服务器。 如果您使用工具注册自定义工作流活动程序集,则下一节的注册步骤不适用。
为事件注册插件步骤
在注册插件&自定义工作流活动树视图中,展开“(程序集)SamplePlugins”节点并选择一个注册插件。
导航到工具栏中“注册”菜单,然后单击“注册新步骤”。
备注
当在事件执行管道中处理事件时,将会注册要执行的插件。 每个事件都具有阶段名称和编号,以指示该事件在管道中的位置是在核心平台操作前还是后。 “步骤”指的是用于配置何时如何执行插件的 SDK 消息处理步骤实体。
如下图所示,完成“注册新步骤”对话框。
注册新步骤对话
单击“注册新步骤”。
展开“(程序集)SamplePlugins”节点以查看您所创建的插件和步骤节点。 现在可以关闭工具,但是您可能希望使其保持打开状态,直到测试完插件并取消注册程序集。
备注
若要取消注册步骤、插件或程序集,请在树中选择其节点,然后在工具栏中单击“取消注册”。 若要修改程序集或步骤注册,请在树视图中双击程序集或步骤节点。 或者,您也可以选择节点并单击工具栏中的“更新”。
现在,已针对客户创建事件在沙盒中注册要在核心操作执行之后执行的插件。 由于后续任务活动的创建工作并不急于完成,因此将插件注册为异步运行。 在创建客户之后,插件将在下次异步服务处理其队列时执行。
测试插件
在注册插件之后,您也可以通过以下过程测试其执行情况。
针对已为其注册插件程序集的同一组织打开 Microsoft Dynamics 365 Web 应用程序。
移动到工作区,选择“客户”,然后单击“新建”。
在“客户名称”框中,键入客户名称(如Adventure Works Cycle),然后单击“保存&关闭”。
双击“客户”网格中的窗体名称以打开该窗体。
单击“活动”以显示客户相关活动的列表。 您应看到插件所创建的名为“Send email to the new customer“的活动。
如果将插件注册为异步运行,并且未选择“注册新步骤”窗体中的“如果 StatusCode = Successful,删除 AsyncOperation”选项,则会出现一个名为“FollowupPlugin: Create of account”的新系统作业。 若要查看相关的系统作业,请单击“设置”,然后单击“系统作业”。 双击先前提到的系统作业。
如果需要,现在可以取消注册步骤、插件和程序集。 您可能还希望删除所创建的系统作业和帐户。
另请参阅
插件开发
演练:配置脱机插件的程序集安全性
注册和部署插件
事件执行管道
插件隔离、信任和统计信息
支持的插件消息和实体
Microsoft Dynamics 365
© 2017 Microsoft。 保留所有权利。 版权