外部操作配置

外部操作允许Journey Optimizer B2B edition中的帐户旅程直接从旅程画布与外部系统连接。 当帐户受众访问外部操作节点时,系统会向配置的外部服务进行异步出站调用,传递帐户、人员或两者的受众属性数据。 外部服务处理数据并使用回调进行响应,返回可用于指导历程执行的受众数据和元数据。

此功能支持两种历程节点类型:

  • 外部操作 — 调用外部服务并沿单个传出路径继续。 适用于​ 触发并忘记 ​集成,例如更新CRM记录或触发下游通知。
  • 外部拆分路径 — 调用外部服务并评估响应以沿几个定义的路径之一路由帐户。
NOTE
仅帐户历程支持外部操作服务。 这些节点类型不适用于人员历程。

实施概述

设置外部操作需要依次在三个角色之间进行协调:

实施外部服务 implement-service

开发人员必须创建并发布符合Adobe Journey Optimizer B2B edition外部操作服务提供程序接口的面向公众的Web服务。

NOTE
回调函数需要持有者令牌。 通过在Adobe Developer Console🔗中为您的IMS组织设置OAuth服务器到服务器凭据来检索此项。

服务启动后,将指向OpenAPI规范的URL和身份验证凭据提供给负责配置该操作的产品管理员。

配置操作 configure-action

必须先配置和激活操作,营销人员才能在历程中使用它。 操作以​ 草稿 ​状态创建,并且您的更改会自动保存。 在激活它之前,它将保持为草稿。

PREREQUISITES
在添加配置之前,请从开发人员处获取指向OpenAPI规范的URL和身份验证凭据。
要定义和激活外部操作,您必须具有​_管理B2B管理员配置_ 产品权限
  1. 转到​管理 > 配置

  2. 单击中间面板上的​外部操作

    访问外部操作配置空间 {width="800" modal="regular"}

  3. 单击右上方的​创建操作

  4. 输入外部服务的OpenAPI规范的URL,然后单击​创建

    输入服务URL {width="500"}

    外部服务必须处于活动状态并且可访问,才能成功完成此步骤。 如果存在验证错误,对话框将显示一条描述错误的消息以及解决该错误的建议。 有关详细信息,请参阅​疑难解答

  5. 成功解析URL后,查看​服务详细信息

    创建操作后,将直接从OpenAPI规范中读取服务详细信息。 创建后,无法在配置中更改这些属性。

    table 0-row-3 1-row-3 2-row-3 3-row-3
    属性 描述 OpenAPI规范属性
    名称 操作的名称 info.title
    描述 操作的描述 info.description
    URL 定义外部服务的OpenAPI规范的URL servers.url
  6. 输入外部服务(components.securitySchemes)的​ 身份验证 ​凭据。

    note
    NOTE
    显示的凭据字段取决于外部服务中定义的身份验证机制。 支持的类型包括API密钥、OAuth2和HTTP基本身份验证。

    添加身份验证凭据 {width="600" modal="regular"}

    当配置的操作处于​ 草稿 ​或​ 活动 ​状态时,您可以根据需要更改凭据。

  7. 单击​下一步

  8. 设置​ 配置 ​属性以定义操作与外部服务交换数据的方式。

    note
    NOTE
    标记为​_静态_​的属性在配置时不可更新,且基于服务定义。
    • 操作类型静态) — 支持的历程节点类型:

      • 外部操作 (enableSplitPath = false)
      • 外部操作拆分路径 (enableSplitPath = true)

      创建操作配置后,无法更改操作类型。

    • 访问器静态) — (仅限外部操作拆分路径)外部服务返回的变量可用作外部拆分路径节点中的路径条件。 (invocationPayloadDef.accessorsMetadata)

    • 历程上下文静态) — 在请求中发送的受众数据的范围(supportedEntityType):

      • 帐户 — 仅发送帐户

      • 人员 — 仅发送人员

      • 帐户中的人员 — 发送帐户和与帐户相关的人员

    • 传出字段 — 将表中的每个字段映射到XDM字段。 这些字段在请求正文中发送到外部服务。 服务定义属性: invocationPayloadDef.accountFieldsinvocationPayloadDef.fields

      映射外部操作传出字段 {width="600" modal="regular"}

    • 传入字段 — 将表中的每个字段映射到可更新的XDM字段。 这些字段从外部服务响应中填充。 服务定义属性: callbackPayloadDef.accountFieldscallbackPayloadDef.fields。 创建后可更新。

    • 标头参数 — 为请求中要作为HTTP标头传递的每一行输入一个值。 服务定义属性: invocationPayloadDef.headers

    • 超时 — 输入在请求被视为失败之前等待外部服务调用回调的分钟数。 服务定义属性: timeout

    • 全局属性 — 为每一行输入一个值,以作为静态字段包含在请求正文中。 服务定义属性: invocationPayloadDef.globalAttributes

      外部操作标头参数、超时和全局属性 {width="600" modal="regular"}

  9. 单击​ 上退箭头 ​返回列表并将操作保持在​ 草稿 ​状态。

    或者,单击​ 激活 ​以将操作配置更改为​ 活动 ​状态。 配置的外部操作必须处于活动状态才能在帐户历程中使用。

故障排除 troubleshooting

当您输入外部服务的OpenAPI规范的URL并单击​ 创建 ​时,系统会执行服务验证。 当遇到错误时,对话框会显示消息以描述错误。

外部操作URL服务验证错误消息 {width="600" modal="regular"}

NOTE
以下许多错误都需要与创建和发布面向公众的Web服务的开发人员合作才能解决。

验证错误详细信息

显示的错误
为什么会这样
要做什么
This URL is already used by another external action
此规范URL已注册到贵组织中的其他操作。
使用其他规范URL,或删除已使用该规范URL的现有操作。
An action with this name already exists
规范中的info.title与已存在的操作匹配
将规范info.title字段中的标题更改为其他唯一内容。
Duplicate operation ID found in the specification
规范中的两个或多个操作共享相同的operationId
为每个操作指定一个唯一的operationId
Field in the specification exceeds the maximum allowed length
规范中的文本字段(如标题或描述)太长。
缩短标记的字段。
The entity type value is invalid
实体类型的特定于Adobe的x-扩展具有无法识别的值
将实体类型更正为支持的值。 有关有效选项,请参阅开发人员文档
The provided document is not a valid OpenAPI specification
规范无法进行结构解析。
根据OpenAPI 3.0架构验证您的规范并修复任何问题。
Required OpenAPI field is missing
缺少标准OpenAPI必填字段(如infopaths)。
添加缺少的字段。
Required endpoint is missing from the specification
您的规范中未定义Adobe Journey Optimizer B2B edition所需的端点。
添加所需的端点。 请参阅需要端点的开发人员文档
Required extension field is missing
您的规范中不存在必需的Adobe x-扩展字段。
按照文档中的说明,添加缺少的扩展字段。
Security schemes are missing from the specification
您的规范没有在components下定义securitySchemes
定义至少一个安全方案。
Multiple authentication types are not supported
您的规范定义了多个身份验证方案。
更新您的规范以使用单一身份验证类型。
The authentication type is not supported
不支持您使用的安全方案类型(如oauth2openIdConnect)。
切换到支持的身份验证类型。 有关支持的选项,请参阅开发人员文档。
The OpenAPI version is not supported
规格级别的版本不匹配
更新您的规格以使用OpenAPI 3.0.x。
An unexpected error occurred
在您的规范中发现未分类的问题。
检查您的规格中是否有任何不寻常的情况,然后重试。 如果错误仍然存在,请联系支持人员。

向历程添加外部节点 add-journey-node

在激活操作后,营销人员可以将​ 外部操作 ​或​ 外部拆分路径 ​节点添加到任何帐户历程。 有关如何在帐户历程画布中添加和使用这些节点的信息,请参阅外部节点

recommendation-more-help
journey-optimizer-b2b-help-user