使用“JIRA 搜索对象”活动

使用“搜索对象”活动从 JIRA 访存与 Issue、User、UsersOverMultiProject、AssignableUser 和 UsersWithPermissions 的搜索字符串匹配的记录。针对 Issue 的搜索活动将获得定制字段数据。

关于此任务

使用此任务来通过设置查询参数在 JIRA 实例中搜索对象。对此活动的调用是同步调用,其中会将输入数据发送到该活动以进行处理并将响应发送回到编排。

过程

  1. 在活动编排中,打开活动选项卡,然后展开 JIRA 文件夹内容。
  2. 搜索对象活动图标拖至编排上。选择该活动。 这样会显示“JIRA 搜索对象”核对表
  3. 在核对表中,单击摘要
  4. 复审活动名称字段的内容,并进行所需的更改。
  5. 在核对表中,单击选取端点
  6. 单击浏览,然后使用 Project Explorer 对话框来选择相关的 JIRA 端点。
  7. 可选:您可以通过单击新建并指定所需的连接详细信息来创建端点。单击确定以保存并使用此配置的端点。
  8. 要对所选端点配置进行所需的更改,请单击编辑以在单独的窗口中访问相应选项。您所作的任何更改都会对活动编排中端点的所有使用产生全局影响。
  9. 在核对表中,单击配置
  10. 单击浏览以选择对象类型。 这样会显示浏览 JIRA 窗口。
  11. 浏览 JIRA 中,您可以从对象类型列表中选择对象类型。单击确定
  12. 在“核对表”中,单击重试。复审缺省设置并进行所需的更改。
    注: 有关更多信息,请参阅为 JIRA REST API 活动指定重试选项
  13. 核对表中选择映射输入。 从检索对象活动的所选对象生成的 XML 模式将显示为至活动面板中请求输入参数下的节点。
  14. 创建活动的编排变量与输入参数之间的映射。
    注: 在运行时必须为输入结构的任何必要元素都提供值。可以通过为元素指定缺省值或通过将元素与输入节点链接来提供值。在运行时期间,如果没有为必要元素提供值,那么活动会抛出由 Web 管理控制台报告的异常。如果在运行时没有为可选输入参数提供值,那么在运行时期间不会抛出异常。
  15. 核对表中选择映射输出。 所生成用于保存活动的响应的 XML 模式将显示为自活动面板中响应输出参数下的节点。
  16. 创建输出参数与编排变量之间的映射。 查询参数

    以下是搜索对象的查询参数:

    表 1. 用于所有“搜索对象”的通用查询参数
    字段名 描述
    startAt 要返回的第一条记录的索引(以 0 为准)
    maxResults 要返回的最大用户数(缺省值为 50)。允许的最大值为 1000。如果指定高于这一数目的值,那么搜索结果将被截断。
    表 2. 用于 Issue 对象的查询参数
    字段名 描述
    validateQuery 此参数用于验证 JQL 查询
    responseFields 要为每个 issue 返回的字段的列表。缺省情况下,将返回所有可浏览字段。
    条件 条件中已定义字段、运算符、值和逻辑运算符。 可通过扩展条件节点的出现次数来指定多个条件。
    字段 应指定条件中所使用的标准字段名称。
    运算符 将应用的运算符。(例如,有效运算符有 =、!=、<、>、<=、>=、~、!~、IN、NOT IN、IS 和 IS NOT)
    搜索中使用的字段的值
    逻辑运算符 所应用的逻辑运算符(例如,有效的逻辑运算符有 AND、OR、NOT 和 ORDER BY)
    排序依据 “排序依据”中已定义字段及顺序。可通过扩展排序依据节点的出现次数来指定多项排序依据
    字段 用于按顺序显示字段的标准字段名称
    顺序 顺序有 ASC 和 DESC
    表 3. 用于“用户对象”的通用查询参数
    字段名 描述
    includeActive 此参数用于包含活动用户
    includeInActive 此参数用于包含不活动用户
    表 4. 用于“UserWithPermission 对象”的通用查询参数
    字段名 描述
    permissions 用户必须对返回的项目或问题所具有的许可权的逗号分隔列表
    注: 连接器不支持枚举,因此用户必须在查询参数中输入数据。

结果

您已配置“JIRA 搜索对象”活动。