使用“Sage CRM 查询对象”活动

使用“查询对象”活动在 Sage CRM 的指定对象类型上执行 SData 查询。

关于此任务

使用此任务在 Sage CRM 实例中的指定对象类型上执行 SData 查询。对此活动的调用是同步调用,其中会将输入数据发送到该活动以进行处理并将响应发送回到编排。

过程

  1. 右键单击“编排”部分,然后选择新编排。
  2. 将新创建的 Sage CRM 端点拖至编排上,然后选择查询对象活动。
  3. 这会将查询对象活动添加到编排。选择该活动。 这样会显示“Sage CRM 查询对象”核对表
  4. 在核对表中,单击配置
  5. 输入带有“?”的有效查询参数作为值的占位符。要配置多个查询参数,请使用“&”隔开每个查询参数。以下是一些查询示例:
    select=?&where=?
    startIndex=?&count=?
    orderBy=?
    select=?&where=?orderBy=?
      where=Lead_UpdatedDate lt @2016-01-10@

    请注意查询字符串不得以“?”开头.

  6. 单击浏览以选择对象类型。这样会显示浏览 Sage CRM 窗口。
  7. 浏览 Sage CRM 中,您可以从对象类型列表中选择对象类型。单击确定
  8. 核对表中选择映射输入。 从查询对象活动的所选对象生成的 XML 模式将显示为至活动面板中请求输入参数下的节点。
  9. 核对表中,单击重试。复审缺省设置并进行所需的更改。
    注: 有关更多信息,请参阅为 Sage CRM REST API 活动指定重试选项
  10. 创建活动的编排变量与输入参数之间的映射。
    注: 在运行时必须为输入结构的任何必要元素都提供值。可以通过为元素指定缺省值或通过将元素与输入节点链接来提供值。在运行时期间,如果没有为必要元素提供值,那么活动会抛出由 Web 管理控制台报告的异常。如果在运行时没有为可选输入参数提供值,那么在运行时期间不会抛出异常。
  11. 核对表中选择映射输出。 所生成用于保存活动的响应的 XML 模式将显示为自活动面板中响应输出参数下的节点。
  12. 创建输出参数与编排变量之间的映射。

    查询参数:

    表 1. 用于“查询对象”的通用查询参数
    字段名 描述
    startIndex API 调用的结果应从其开始的记录的起始索引
    count 将在响应中显示的对象的计数。
    where 指定过滤条件。仅返回与 where 参数中指定的条件匹配的资源。
    orderBy 指定排序条件。按此参数中指定的属性名称的升序或降序对集合进行排序。
    select 选择有效内容中将返回的属性。此参数使客户能够请求在有效内容中返回属性的特定列表。它会对所返回信息的宽度和深度进行精确控制。

    以上至少一个查询参数应具有映射值/缺省值以便活动成功执行。

结果

您已配置“Sage CRM 查询对象”活动。
注:

此活动用于访存指定类型的多条记录。例如,输入响应将为 single,这适用于单次检索所有 API 调用以访存多个对象。