工作流连接器
在 Workspace ONE Intelligence 的“工作流连接器”区域中添加并使用受管连接器和自定义连接器。工作流连接器基于我们的连接器管理系统 (CMS) 构建,可管理出站 Workspace ONE 服务和第三方集成的所有受管连接器配置和操作。它还管理所有自定义连接器配置和操作,以扩展初始自动化架构。
更多文档
有关 Freestyle 和工作流的详细信息,请参见博客文章。
受管连接器
受管连接器(本机连接器或第三方连接器)已预先植入或添加,以便您可以在工作流中使用其操作。一些预先植入的受管连接器示例包括 Hub 服务和 Intelligence。第三方受管连接器包括 Slack Web API 和 ServiceNow。自定义连接器是您自己的连接和操作,使用 REST API 进行通信。
如果您不熟悉 Intelligence,则必须按照该连接器的设置过程添加受管连接器。有关详细信息,请参见适用的集成主题。
如果在 CMS 版本(即 23.03.23 版本)之前设置连接器,则无需执行任何操作。
编辑和删除
您可以在 Workspace ONE Intelligence 中编辑或删除受管连接器。如果删除受管连接器,您仍可以选择该连接器,以便稍后添加该连接器。
- 删除 - 要删除受管连接器,必须移除关联工作流中使用的所有操作。您也可以删除关联的工作流,但删除时要小心,因为此操作无法撤消。
- 编辑 - 您可以编辑某些受管连接器详细信息,但无法编辑操作字段的默认值。
自定义连接器
使用您现有的企业系统和第三方服务将您自己的连接和操作添加到工作流。自定义连接器使用 REST API 进行通信,并使用 API 开发工具 Postman 创建标准请求。
要求
要添加自定义连接器,请导入 Postman 集合。Postman JSON 文件中的请求就是操作。导入集合后,操作便可在工作流中使用。
- 创建 Postman 集合。
- 您要连接的服务必须支持 REST API 和 JSON 内容类型。
- Workspace ONE Intelligence 需要 API 端点的访问权限。如果服务受防火墙保护,请使用Unified Access Gateway作为反向代理。有关详细信息,请访问使用 VMware Workspace ONE UEM API 配置反向代理
- 如果使用 OAuth2 进行身份验证,请提供授权详细信息,以便 Workspace ONE Intelligence 可以检索、刷新和访问服务的令牌。
- OAuth2 令牌 URL
- 客户端密钥
- 客户端 ID
- 授权类型(客户端凭据或密码)
自定义连接器示例
有关自定义连接器的示例,请参阅我们的 GitHub 存储库,其中包含一些最常用的请求操作。
使用 Postman 创建标准 REST API
Workspace ONE Intelligence 使用 Postman 标准化系统用于连接内部服务和第三方服务并与之进行交互的 REST API。会使用熟悉的 REST 模板界面创建操作,该界面支持重用保存的操作。Postman 的免费版本具有为自定义连接器创建集合所需的功能。
该应用的免费版本包含创建和导出请求集合以实现工作流的功能。
本主题概括介绍了创建和导出集合时必须执行的操作。仅供参考。有关如何配置 Postman 产品的最新说明,请参阅 Postman 学习中心。
从 https://www.getpostman.com 获取 Postman 应用。
使用自定义连接器的步骤
- 在 Postman 中创建请求集合并导出该集合。
- 在 Workspace ONE Intelligence 中添加一个自定义连接,然后导入请求。这些请求现在可用作您在工作流中使用的操作。
- 使用导入的操作配置一个自动化工作流,以便在 Workspace ONE Intelligence 中使用自定义连接自动执行任务。
步骤 1:创建 Postman 集合
使用 Postman 应用可以为自定义连接器创建标准 REST API。此内容提供了一个常规工作流,用于创建 Postman 集合并以 JSON 文件形式导出这些集合。
自定义连接器的 Postman 集合(操作)现在需要 ID 字段。每个操作的 ID 必须是唯一的。如果实例中已存在该 ID,则 Intelligence 将忽略该操作。如果在导入中使用重复的 ID,则会显示一条错误消息。
您可以将具有相同名称和描述的操作添加到集合中,但这些操作必须具有唯一的 ID。
- 添加集合。
-
在集合中添加和配置请求。
-
这些请求中提供的名称和说明将用于 Workspace ONE Intelligence 中的工作流操作。您可以稍后在 Workspace ONE Intelligence 中更改名称和说明。以下示例为 Postman 请求中的一个条目及其在 Workspace ONE Intelligence 的工作流中如何呈现为一个操作。
-
请考虑将标头添加为 Content-Type: application/json
。如果未将标头添加为内容类型 JSON,则 API 会默认为 XML,而 XML 不适用于自定义连接器。
- 将 API 所需的任何自定义标头添加到 Postman 集合中的所有请求。自定义标头的示例都是唯一的基于标头的身份验证类型,如 API 密钥或令牌。Workspace ONE Intelligence 会保留除身份验证标头以外的所有标头。并使用自定义集合中身份验证类型的配置覆盖身份验证标头。如果 Workspace ONE Intelligence 替代身份验证标头,则系统仍会向您发送唯一的基于标头的身份验证供您使用,因为您已将其添加到其他请求。
- 发送请求以对其进行验证。验证会生成响应。
- 将响应另存为文档示例。Open API 协议需要执行此步骤。
- 保存请求。
- 根据需要添加更多请求。
- 将集合导出为集合 v2.1。
- 使用文件编辑器将唯一 ID 添加到集合,并将其添加到 JSON 文件中的
"name":
条目之后。
步骤 2:在 Intelligence 中添加自定义连接器
添加自定义连接器时,将 Postman 集合 JSON 文件导入 Intelligence。
如果导入具有重复 ID 的 Postman 集合,Intelligence 显示错误 Invalid Postman JSON file
。编辑其中一个具有唯一 ID 的集合,然后将其重新导入 Intelligence。
- 在 Workspace ONE Intelligence 中,转到集成 > 工作流连接器,选择添加,然后选择添加自定义连接器。
- 对于连接器名称,输入连接的可识别名称。
- 对于基本 URL,输入服务的 URL,以便 Workspace ONE Intelligence 可以进行身份验证。服务的 URL 和自定义连接的 URL 必须匹配。
- 对于身份验证类型,选择用于访问服务的身份验证类型。Workspace ONE Intelligence 将使用此设置替代集合中的 Postman 身份验证标头。如果您的服务使用唯一的基于标头的身份验证类型,请将标头添加到 Postman 集合中的所有请求并配置基本 URL。在此方案中,Workspace ONE Intelligence 使用在 Postman 集合中配置的标头。基于标头的身份验证类型示例使用 API 密钥或令牌。
- 基本身份验证 - 向 Workspace ONE Intelligence 授予访问权限,输入凭据。
- OAuth2 身份验证 - 输入详细信息,以便 Workspace ONE Intelligence 可以检索、刷新和访问服务的令牌。
- 无身份验证 - 如果不希望 Workspace ONE Intelligence 替代身份验证标头,请选择此菜单项。
- 要导入 Postman JSON 文件,请使用 UI 中间的从您的计算机中选择链接。UI 会显示集合及其请求。这些 Postman 请求现在可用作工作流的操作。
- 从导入的操作列表中,您可以测试、编辑和删除操作。
步骤 3:添加工作流
按照 Freestyle Orchestrator 主题中概述的过程创建工作流。
编辑、删除和测试
可以在 Workspace ONE Intelligence 中编辑、删除和测试自定义连接器。您可以在多个连接器中使用操作,因此在对连接器进行编辑或删除操作之前,请考虑相应的后果。
- 删除 - 要删除连接器和关联的操作,您需要先从所有工作流中移除操作。从工作流中移除所有操作后,可以删除连接器。此操作不可撤销。
- 编辑 - 您可以随时编辑连接名称、说明和身份验证类型。要编辑操作请求详细信息,请编辑 Postman 集合,然后将其重新导入自定义连接。注意:如果您错误地编辑身份验证类型并输入凭据,则操作可能无法运行。请谨慎编辑。
- 测试 - 在 Workspace ONE Intelligence 中测试自定义连接器,以确保 Workspace ONE Intelligence 和您的服务可以进行通信。