全局管理器(承载的控件)

 

发布日期: 2016年11月

适用于: Dynamics 365 (online),Dynamics 365 (on-premises),Dynamics CRM 2013,Dynamics CRM 2015,Dynamics CRM 2016

全局管理器 托管控件类型为 Unified Service Desk 的核心,且 Unified Service Desk 要求托管控件的实例。 此托管控件在应用程序启动时,加载并读取 Microsoft Dynamics 365 中的所有 Unified Service Desk 配置数据,介绍窗口导航规则,向工具栏组件和代理脚本提供数据,并管理会话数据。 仅可加载 全局管理器 托管控件类型的单个实例。

重要

Unified Service Desk、New EnvironmentCRM Web ClientInteractive Service Hub 的三个示例应用程序包都预配置了全局管理器托管控件类型的相应实例。 有关示例应用程序的信息,请参阅 TechNet:使用 Package Deployer 将示例 Unified Service Desk 应用程序部署到 CRM 服务器

除了提供说明 Unified Service Desk 中大部分功能外,全局管理器 托管控件类型也在系统中提供多语言,以便可本地化多语言应用程序中 UI 字符串和消息。 有关详细信息,请参阅为您的代理应用程序添加多语言支持。 它也提供搜索提供商,此经设计通过配置为通用且可调整的。

本主题内容

创建全局管理器托管控件

预定义的 UII 操作

预定义事件

创建全局管理器托管控件

在创建新的承载控件时,“新的承载控件”屏幕中的字段基于要创建的承载控件的类型而变化。 本节提供有关特定字段的信息,其对于 全局管理器 托管控件类型是唯一的。 有关创建承载控件的详细信息,请参阅 创建或编辑承载的控件

全局管理器托管控件

新托管控件屏幕中Unified Service Desk 区域下,从 USD 组件类型 下拉列表选择全局管理器。 另外,确保您将此托管控件的“排序顺序”的值设置为“2”,以确保在使用连接管理器托管控件与 Dynamics 365 建立连接,代理应用程序立即对其进行加载。 有关其他 通用 字段的详细信息,请参阅 创建或编辑承载的控件

在保存记录之后,语言服务 区域变得可用,在该区域添加用于为代理应用程序的 UI 添加本地化字段的资源。 有关如何添加语言资源的详细信息,请参阅 为您的代理应用程序添加多语言支持

预定义的 UII 操作

全局管理器提供一系列允许通过 web 服务对 Dynamics 365 记录数据进行操作的预定义操作。 这些可配置期间执行在 Dynamics 365 中的高级功能时使用。

以下预定义UII动作对于 全局管理器 托管控件类型:

审核

将审核条目添加到 Unified Service Desk 审核日志。 有关详细信息,请参阅 Technet:在 Unified Service Desk 中配置审核

参数

说明

客户

审核项名称。 您必须在“选项”区域(“设置” >“Unified Service Desk” > 选项(如何进入?))下添加一个选项,并将值设置为“1”。

操作​​

表示正在被审核的操作的字符串。

TargetApplication

表示用于审核的目标应用程序的字符串。

CustomerId

表示客户客户 ID 的字符串。

ContextId

表示上下文 ID 的字符串。

ApplicationId

用于审核的承载控件的 GUID。

AgentState

代表代理状态的字符串

ActionData

这是将输出到审核项的数据。 如果未显式提供此参数,则将使用此操作调用定义的“数据”字段中的所有其余子项。

CallDoAction

在其他托管控件上调用一个操作。

参数

说明

面板

如果为指定应用程序,则此为查找活动应用程序的面板。

操作

此为调用托管控件的动作。

数据

此为传递至操作的数据参数。

应用程序

这是要执行操作调用的托管控件名称。 如果已指定,则忽略“面板”参数。

ClearAppBar

移除客户端应用程中指定的托管控件。

参数

说明

ApplicationName

要移动的承载控件的名称。 如果不提供此参数,将移动客户端应用程序主窗口。

ClearEntityList

清除累积的搜索结果列表,并始终在调用“DoSearch”操作之前调用。

参数

说明

global

True 如果希望清除与全局会话相关联的搜索结果。 当将搜索结果储存在全局会话中时应小心,因为系统不自动清除这些结果。 在这种情况下,您必须在“DoSearch”操作之前调用“ClearEntityList”操作。

关闭

关闭托管控件。 不像 CloseActive 操作,如果此选项卡上显示多个页面,则它将在代理应用程序的选项卡上显示将要关闭的所有页面。

CloseActive

在指定面板上关闭可用的托管控件。

参数

说明

该动作调用中首行应包含面板名称以定位活动的应用程序。 如果未指定参数,则假定为 MainPanel。

CopyToClipboard

将文章 URL 复制或追加到剪贴板。

参数

说明

data

要复制的数据。 此外,还可以使用替换参数。 例如:data=[[$context.title]]

追加

指示是否将数据追加到剪贴板。 设置 truefalse。 例如:append=false。

CopyToContext

将一值或一系列至复制到上下文变量。 使用会话可序列化上下文变量。 此操作执行一系列 name=value 对。 该名称为上下文变量的名称。

CopyLogicalEntityToContext

将整个数据参数部分的值复制到该上下文。

参数

说明

LogicalName

从中复制值的数据参数类型或部分。

CloseActivity

在 Dynamics 365 中关闭活动记录。

参数

说明

ID

待关闭活动记录的 GUID。

LogicalName

待关闭活动的逻辑名称。

StatusCode

最终状态代码的名称在活动结束后显示。

StateCode

最终状态代码的名称显示在活动结束后的。

例如,关闭电话联络活动,您必须指定以下内容:

Id=<GUID of the phone activity record>
LogicalName=phonecall
statuscode=Received
statecode=Completed

关闭活动记录后,$返回 系统替换参数将以布尔值填充,以指示此操作成功与否。

CreateEntity

在 Dynamics 365 中创建新记录。

参数

说明

LogicalName

待创建实体的逻辑名称

参数列表中各续行包含一系列定义填充创建其他字段的 Name=Value 对。

实体引用可描述如下:

Param=EntityReference(“logicalname”, “id”)

OptionSetValue 可指定如下:

Param=OptionSetValue(value)

Boolean 可描述如下:

Param=Boolean(value)

PartyList (与电子邮件连用)可描述如下:

Param=PartyList(email[“test@test.com”], er[“contact”, guid])

可使用 emailer 条目的数量分别代表电子邮件地址和实体引用。

如字符串值的其他值可指定如下:

Param=value

一旦创建记录,使用新创记录的 GUID 填充 $Return 值。

CreateSession

创建会话。

DeleteEntity

在 Dynamics 365 中删除记录。

参数

说明

ID

待删除值的 ID。 此必须为待删除记录的 GUID。

LogicalName

待删除实体的逻辑名称。

DoRoute

可用于通过模拟特定托管控件的弹出窗口检测您的窗口导航规则。 它可用于生产,以根据需要触发窗口导航规则。

参数

说明

名称

实体 ID 为 queueItem 的目标

实体

在弹出窗口中打开的实体的逻辑名称。

id

将在弹出窗口中打开的实体的 ID。

框架

据说自该框架发生弹出的框架。

DoSearch

在 Unified Service Desk 中使用 FetchXML 调用 Dynamics 365 Web 服务(定义为实体搜索)。有关定义实体搜索的详细信息,请参阅 使用 Unified Service Desk 中的实体搜索搜索数据

参数

说明

name

实体搜索的名称将被用于搜索记录。

global

True 如果希望清除与全局会话相关联的搜索结果。 当将搜索结果储存在全局会话中时应小心,因为系统不自动清除这些结果。 在这种情况下,您必须在调用此操作之前调用“ClearEntityList”操作。

maxcount

在此调用的 EntityList 结果中存储的最大记录数量。

备注

默认情况下,结果集的页面计数(每页的记录数)设置为 50。 这意味着,如果返回超过 50 条记录,它就会显示在该页中。 如果要为 DoSearch 操作指定不同的页面计数值,请在EntitySearchPageCount 选项中指定新值。详细信息:TechNet:管理 Unified Service Desk 的选项

当您调用 DoSearch 操作时,$Return 替换参数将在 EntityList 中找到的记录数显示为此次搜索的结果。详细信息:$返回

DisplayMessage

向用户显示消息框。

参数

说明

文本

这是消息框中显示的文本。 如果未指定此参数,将使用任何剩余文本(剩余参数)或空字符串。

标题

这是消息框中显示的标题。 如果未指定标题,将使用“Dynamics 365 消息”。

ExecuteOnDataAvailable

延迟子操作执行,直到指定的替换参数集可用为止。 可以指定超时值来限制等待替换参数可用的时间量。 如果不指定超时值,将无限期等待或直到会话结束。详细信息:博客:如何使用特殊操作 ExecuteOnTimeout、ExecuteOnDataAvailable、ExecuteOnExpressionTrue

参数

说明

毫秒

时间(毫秒)指示此操作过期并被取消前等待的时间。 其余参数应包含需要在子操作可以执行前存在的替换参数。

数据参数示例:

milliseconds=5000
[[account.Id]]
[[incident.Id]]

重要

此操作适用于任何托管控件类型。 默认情况下,当您创建托管控件类型时,此操作不显示。 要使用托管控件类型实例的 ExecuteOnDataAvailable 操作,必须明确将称为 ExecuteOnDataAvailable 的 UII 操作添加到各自的托管控件实例。详细信息:添加一个 UII 操作至托管控件

ExecuteOnTimeout

延迟子操作执行,直到经过指定的时间。 需要超时值来指示什么时候应运行子操作。详细信息:博客:如何使用特殊操作 ExecuteOnTimeout、ExecuteOnDataAvailable、ExecuteOnExpressionTrue

参数

说明

毫秒

时间(毫秒)指示在执行子操作前等待的时间。

数据参数示例:

milliseconds=5000

重要

此操作适用于任何托管控件类型。 默认情况下,当您创建托管控件类型时,此操作不显示。 要使用托管控件类型实例的 ExecuteOnTimeout 操作,必须明确将称为 ExecuteOnTimeout 的 UII 操作添加到各自的托管控件实例。详细信息:添加一个 UII 操作至托管控件

ExecuteOnExpressionTrue

延迟子操作执行,直到指定的 JavaScript 表达式返回 true。 可以指定超时值来限制在过期前等待的时间量。 如果不指定超时值,将无限期等待或直到会话结束。详细信息:博客:如何使用特殊操作 ExecuteOnTimeout、ExecuteOnDataAvailable、ExecuteOnExpressionTrue

参数

说明

毫秒

时间(毫秒)指示此操作过期并被取消前等待的时间。 其余的参数是用于评估的 JavaScript 表达式。 当该表达式是 true,子操作将执行。

数据参数示例:

milliseconds=5000
function IsAccountLoaded()
{
return “[[account.Id]$+]” != “”;
}
IsAccountLoaded();

重要

此操作适用于任何托管控件类型。 默认情况下,当您创建托管控件类型时,此操作不显示。 要使用托管控件类型实例的 ExecuteOnExpressionTrue 操作,必须明确将称为 ExecuteOnExpressionTrue 的 UII 操作添加到各自的托管控件实例。详细信息:添加一个 UII 操作至托管控件

ExecuteScriptlet

执行指定的 scriptlet。

参数

说明

指定 scriptlet 的名称可以在数据字段中执行。

FireEvent

触发托管控件的用户自定义事件。

参数

说明

名称

用户自定义事件的名称。

所有后续名称=值成为事件的参数。 有关创建用户自定义事件的详细信息,请参阅 创建用户自定义事件

获得模板

检索已合并电子邮件模板的内容。

参数

说明

名称

要检索模板的名称。

id

与合并操作模板关联的实体的 ID。

InvokeCTI

模拟 CTI 事件

参数

说明

type

这是 CTI 事件的类型,例如电话联络和聊天。

appname

此弹出模拟要使用的桌面管理器名称。

ani

自动号码识别 (ANI) 或呼叫方电话号码。

dnis

DNIS 或拨号号码。

所有剩余参数将作为参数传递到 CTI 事件处理器。

LaunchURL

在 Unified Service Desk 应用程序外部使用 Internet Explorer 启动 URL。 必须将该 URL 指定为“数据”字段中的一个参数。

LookupQueueItem

在系统中查找 queueitem 并获取信息。

参数

说明

ID

实体 ID 为 queueItem 的目标

EntityType

ID 字段中提及的实体的类型或逻辑名称。

生成的 queueitem 详细信息将放置于 queueitem 替换参数中,并可在以后参考。

MoveApplicationToPanel

将托管控件移动至客户端应用程序中的指定面板。

参数

说明

应用程序

要移动托管控件的名称。

面板

目标面板的名称。

MoveToPanel

在运行时在面板之间移动托管控件。

参数

说明

应用程序

要移动的承载控件的名称。

面板

承载的控件的目标面板。

New_CRM_Page

为正在创建的指定实体的新 Dynamics 365 记录创建新页面,并将该页面视为指定托管控件的弹出窗口。 对窗口导航规则进行评估以确定创建实体记录页面显示的位置。

参数

说明

LogicalName

用于创建新实例的实体的逻辑名称。

备注

其余的参数由 name=value 对组成。 在为指定实体创建新记录的表单中,这些为额外的预填充值。 有关使用此操作的详细信息,请参阅 演练 7:在代理应用程序中配置代理脚本 中的步骤 4。

Open_CRM_Page

打开指定实体的现存实例,由 ID 指定,并将页面视为指定托管控件的弹出窗口。 对窗口导航规则进行评估以确定弹出窗口显示的位置。

参数

说明

LogicalName

打开实体的逻辑名称

ID

要打开实体记录的 ID。

暂停

暂停操作的执行,而不阻止消息处理。 此操作不同于待定指定时间的不同当前线程 (Thread.Sleep),因为此操作允许继续处理。 在您等待 Web 操作完成后,此操作会有用。

参数

说明

毫秒

暂停的毫秒数。

弹出窗口

从托管控件弹出 URL 并对其运行窗口导航规则以发送该弹出到适当的位置。

参数

说明

url

使用此作为从显示控件请求弹出的 URL 以从该托管控件发送一个弹出。

框架

该弹出源自的框架。

RealignWindow

在监视器上的指定位置显示托管控件。 您最多可在两台监视器上显示托管控件。 此操作适用于配置为置于 USDFloatingPanel 或 USDFloatingToolPanel 面板类型上的托管控件实例。

参数

说明

screen

指定要显示托管控件的屏幕。 有效值为 1 或 2。 如果不指定此参数,则默认情况下将传递 1。

left

指定目标监视器屏幕左侧应显示托管控件的位置(以百分比为单位)。 有效值为 0 到 100。 如果不指定此参数,则默认情况下将传递 0。

top

指定目标监视器屏幕上方应显示托管控件的位置(以百分比为单位)。 有效值为 0 到 100。 如果不指定此参数,则默认情况下将传递 0。

width

指定目标监视器上的托管控件窗口的宽度(以百分比为单位)。 有效值为 1 到 100。 如果不指定此参数,则默认情况下将传递 100。

height

指定目标监视器上的托管控件窗口的高度(以百分比为单位)。 有效值为 1 到 100。 如果不指定此参数,则默认情况下将传递 100。

ReadSettings

$设置 替换参数中读取之前保存的设置。

参数

说明

readfromcache

如果要读取这些设置的本地缓存版本,则为 True。 否则为 False 或缺失。

RedoScreenPop

再次弹出最后一个屏幕。 在到达会话限制且弹出失败,或您关闭会话但要求更多工作的情况下,这可能有用。 此操作要求无参数。

ResetLocalCache

在 Unified Service Desk 中重置配置缓存。 下次启动 Unified Service Desk 时,它将从服务器下载配置。 用户必须有运行此操作的 msdyusd_usersettings 实体写入访问权限。

RouteToQueue

将实体路由到 Dynamics 365 中的队列。

参数

说明

目标

目标队列 ID。 这与 destinationqueuename 参数相互排斥

destinationqueuename

此为路由实体的队列名称。

entitytype

此为待路由的实体的逻辑名称。

entityid

此为放入队列中的实体的 GUID/ID。

SaveAll

在允许显示多个页面的托管控件中保存所有窗体(“允许多个页面” = 是)。 如果托管控件仅允许显示单页(“允许多个页面” = 否),这与“保存”操作 等效。

SaveSetting

存储用户特定设置。

参数

说明

名称

设置的名称。 这将在 $设置 替换参数中显示。

待保存设置的值。

SetTheme

应用一个主题,以修改用户界面组件的布局或外观。详细信息:自定义应用程序的外观

参数

说明

清除

True 如果要在应用指定主体之前完全清除当前主体。 如果此参数为错误的或未指定,则新主题信息将与当前主题合并。

其余参数(删除其他参数后留下的参数)应包含待用主体的名称。 它应为 XAML 文件(重命名为 XML 并作为 Web 资源上载)Web 资源名称、来自匿名访问服务器的 URL 或代表此主题的原始 XAML。

SetAppBar

停靠托管控制到客户端应用程序主窗口的指定边缘。

参数

说明

ApplicationName

要停靠的托管控件的名称。 如果指定此参数,将停靠承载此的父窗口托管控件。

宽度

停靠窗口的宽度(以像素为单位)。 如果未指定,则使用窗口的当前宽度。

高度

停靠窗口的高度(以像素为单位)。 如果未指定,则使用窗口的当前高度。

边缘

停靠的边缘。 如果不指定任何内容,则假设“顶部”。 指定以下值之一:“顶部”、“底部”、“左”或“右”。

SetEventTimer

将事件计时器设置为启动。

参数

说明

名称

事件计时器的名称。

SetSize

设置托管控件的宽度和高度。 在画板布局中使用“自动”时,这尤其有用。

参数

说明

宽度

托管控件的宽度。

高度

托管控件的高度。

SetWindowProperty

设置客户端应用程序主窗口的窗口状态。

参数

说明

WindowState

以下值之一:“最大化”、“最小化”或“正常”。

ShellExecute

此操作旨在启动 URL 或命令行。 请注意,用户必须有权执行该应用程序。

参数

说明

唯一的参数为待执行的应用程序的命令行或 URL。

ShowAbout

显示包含大量信息的 Unified Service Desk 对话框,这些信息包括当前用户名、Dynamics 365 服务器和用户连接到的组织、Unified Service Desk 客户端应用程序的版本号以及支持网站 URL。

ShowTab

在代理应用程序中选项卡(托管控件)上设置焦点。

参数

说明

操作调用中的首行应包含显示在前台的托管控件的名称。 请勿使用托管控件的显示名称。 有关使用此操作的详细信息,请参阅 演练 2:在代理应用程序中显示外部网页 的步骤 4。

StopEventTimer

停止事件计时器。

参数

说明

名称

要停止的事件计时器的名称。

翻译

您可以使用 Microsoft 翻译人员 执行语言翻译。

参数

说明

这是要翻译的文本。 此值可为多行支持转义。

一些有效的示例:

value=$Escaped("my string<br>new line\\\"my text\\\"")
value=[[myapp.myparam]^]
value=$Escaped([[myapp.myparam]$])

有关这些替换密钥的详细信息,请参阅 使用替换参数配置 Unified Service Desk

fromlanguage

原始翻译语言的名称。 如果为空,翻译之前系统将尝试检测要翻译指定值的语言。 有关有效语言值的列表,请参阅 翻译人员语言代码

tolanguage

翻译语言的名称。 有关有效语言值的列表,请参阅 翻译人员语言代码

clientId

从翻译服务 Microsoft Azure 获取的客户端 ID。 有关在 Azure 中注册的信息,请参阅 https://datamarket.azure.com

clientsecret

从翻译服务 Microsoft Azure 获取的客户端密钥。 有关在 Azure 中注册的信息,请参阅 https://datamarket.azure.com

翻译的值显示在 $返回 替换参数。

UpdateEntity

在 Dynamics 365 中更新记录。

参数

说明

ID

待更新值的 ID。 此必须为待更新记录的 GUID。

LogicalName

更新实体的逻辑名称

参数列表中各续行包含一些列将定义填充更新其他字段的 Name=Value 对。

实体引用可描述如下:

Param=EntityReference(“logicalname”, “id”)

OptionSetValue 的引用可指定如下:

Param=OptionSetValue(value)

Boolean 的引用可描述如下:

Param=Boolean(value)

PartyList (与电子邮件连用)可描述如下:

Param=PartyList(email[“test@test.com”], er[“contact”, guid])

可使用电子邮件和 er 条目的数量分别代表电子邮件地址和实体引用。

如字符串值的其他值可指定如下:

Param=value

处理

此操作相当于从队列中选择队列项并单击功能区上的 WorkOn 按钮。 将队列项标记为由特定代理操作。

参数

说明

ID

这是 queueitem 的 ID。 关于如何获取目标实体 ID 的详细信息,请参阅 LookupQueueItem。

操作​​

可选参数,允许管理员指定希望删除 WorkOn 属性以将其返回到队列。

有效值包括:

删除 - 删除 WorkOn 属性,且将项目返回队列以供继续使用。

预定义事件

这些是与托管控件有关的预定义事件。

DesktopReady

已完成所有桌面初始化且已建立与 Dynamics 365 的连接时,在启动时发生。 此事件只会触发一次,且通常使用此事件设置主题和执行其他启动操作。

SessionActivated

此在会话关闭时发生。

参数

说明

SessionId

当前可用会话的 ID。

IsGlobal

表明该事件是否适用于全局会话。 返回 True 或 False.

激活​​

设置为 True。

SessionClosed

此会话关闭时发生。

参数

说明

SessionId

关闭会话的 ID。

IsGlobal

表明该事件是否适用于全局会话。 返回 True 或 False.

SessionDeactivated

停用会话时发生。

参数

说明

SessionId

停用会话的 ID。

IsGlobal

表明该事件是否适用于全局会话。 返回 True 或 False.

激活​​

设置为 False。

SessionNew

在创建新会话时发生。

参数

说明

SessionId

新创建会话的 ID。

IsGlobal

如果新会话是全局会话,则返回 True。 否则,返回 False。

另请参阅

UII 操作
事件
查看为托管控件预定义的操作和事件
嵌入视图的操作和事件帮助
统一服务台配置演练
托管控件类型和操作/事件引用
TechNet:Microsoft Dynamics CRM Unified Service Desk 管理指南

Unified Service Desk 2.0

© 2017 Microsoft。 保留所有权利。 版权