# 上下文参数

# 什么是上下文参数

  • 上下文参数可以让开发者通过在扩展页面的入口地址或者其他配置拼接相应的参数来获取上下文信息,有业务对象级、项目级和系统级三大类,对应三大类扩展页面。

  • TAPD调用插件的handler函数时,会传递相关上下文参数。

# 如何获取

  • url参数解析

    页面扩展支持使用url直接接入已经开发完成的第三方页面,可以通过在url中添加上下文变量,向页面传递TAPD信息。 页面扩展分为三类:业务对象级、系统级、项目级。

    假设你的入口地址是 https://demo.woa.com/path ,则:

    • 获取当前访问的用户ID:https://demo.woa.com/path?user_id=$system.user.id$
    • 获取当前访问的项目ID:https://demo.woa.com/path?project_id=$workspace.id$

    页面配置:

    页面配置url参数解析

  • 前端JS SDK读取上下文参数 目前支持npm的方式使用TAPD OPEN JS SDK

    npm i @tencent/tapd-open-js-sdk@latest
    
    1

    获取TAPD提供的上下文参数(只在页面被TAPD嵌入的情况下有效)

    // 初始化JS-SDK
    this.sdk = SDK();
    // 获取扩展点上下文数据
    const entranceData = await this.sdk.context.getEntranceData();
    
    1
    2
    3
    4

    js sdk 获取上下文参数

  • handler被调用时接收上下文参数

    TAPD在调用handler时,会根据场景传递相关上下文参数(项目级、系统级、业务对象级),具体请查看每个模块关于上下文参数的说明,您也可以在开发阶段直接打印handler接收的参数,查阅上下文。

    handler被调用时接收上下文参数

# 业务对象级

# 业务对象通用上下文参数

参数名称 参数描述
object.type 业务对象类型,值范围:story,bug,task,iteration
object.id 业务对象 ID

# story 上下文参数

参数名称 参数描述
object.name 标题
object.short_id 短id
object.workitem_type_id 需求类型id
object.creator 创建人
object.created 创建时间
object.modified 编辑时间
object.parent_id 父需求id
object.children_id 子需求id,用|号分割
object.ancestor_id 祖先业务对象id
object.path 祖先需求到本需求的所有需求id,用::符号连接
object.workspace_id 项目id
object.status 状态英文名
object.priority 优先级
object.owner 处理人
object.cc 抄送人
object.begin 开始时间
object.due 预计结束时间
object.source -
object.iteration_id 迭代id
object.module 模块
object.completed 完成时间
object.templated_id 创建模板
object.business_value 业务价值
object.size -
object.effort 预估工时
object.effort_completed 完成工时
object.exceed 超出工时
object.remain 剩余工时
object.progress 进度
object.release_id -
object.feature -
object.developer 开发人员
object.test_focus 测试重点
object.category_id 分类
object.version 版本
object.confidential -
object.created_from -
object.label 标签
object.custom_field_one 自定义字段一(可能会有)
object.custom_field_two 自定义字段二(可能会有)
object.custom_field_9 自定义字段九(可能会有),大于八用阿拉伯数字

# bug 上下文参数

参数名称 参数描述
object.title 标题
object.short_id 短id
object.project_id 项目id
object.module 模块
object.milestone -
object.reporter 创建人
object.deadline 解决期限
object.created 创建时间
object.resolved 解决时间
object.closed 关闭时间
object.modified 最后修改时间
object.lastmodify 最后修改人
object.auditer 审核人
object.de 开发人员
object.te 测试人员
object.confirmer 验证人
object.current_owner 处理人
object.participator 参与人
object.closer 关闭人
object.status -
object.resolution 解决方法
object.priority 优先级
object.severity 严重程度
object.platform 软件平台
object.os 操作系统
object.testmode 测试方式
object.testtype 测试类型
object.testphase 测试阶段
object.source 缺陷根源
object.frequency 重现规律
object.cc 抄送人
object.estimate 预计解决时间
object.flows -
object.version_report 发现版本
object.version_test 验证版本
object.version_fix 合入版本
object.version_close 关闭版本
object.regression_number -
object.issue_id -
object.created_from -
object.baseline_find 发现基线
object.baseline_join 合入基线
object.baseline_close 关闭基线
object.baseline_test 验证基线
object.story_id -
object.originphase 发现阶段
object.sourcephase 引入阶段
object.bugtype 缺陷类型
object.feature -
object.in_progress_time 接受处理时间
object.verify_time 验证时间
object.reject_time 拒绝时间
object.reopen_time 重新打开时间
object.audit_time -
object.suspend_time -
object.assigned_time 分配时间
object.iteration_id 迭代
object.template_id 创建模板
object.begin 预计开始
object.due 预计结束
object.release_id -
object.fixer 修复人
object.label 标签
object.effort 预估工时
object.effort_completed 完成工时
object.exceed 超出工时
object.remain 剩余工时
object.size 规模
object.custom_field_one 自定义字段一(可能会有)
object.custom_field_two 自定义字段二(可能会有)
object.custom_field_6 自定义字段六(可能会有),大于五用阿拉伯数字

# task 上下文参数

参数名称 参数描述
object.name 标题
object.short_id 任务短id
object.creator 创建人
object.created 创建时间
object.modified 最后修改时间
object.workspace_id -
object.status 状态
object.priority 优先级
object.owner 处理人
object.cc 抄送人
object.begin 预计开始
object.due 预计结束
object.story_id 需求
object.iteration_id -
object.completed 完成时间
object.effort 预估工时
object.effort_completed 完成工时
object.exceed 超出工时
object.remain 剩余工时
object.progress 进度
object.has_attachment -
object.label -
object.release_id -
object.custom_field_one 任务的自定义字段一(可能会有)
object.custom_field_two 任务的自定义字段二(可能会有)
object.custom_field_9 任务的自定义字段九(可能会有),大于八用阿拉伯数字

# iteration 上下文参数

参数名称 参数描述
object.name 标题
object.release_id -
object.workspace_id -
object.startdate -
object.enddate -
object.creator -
object.created -
object.modified -
object.completed -
object.status -
object.custom_field_1 迭代的自定义字段一(可能会有)
object.custom_field_2 迭代的自定义字段二(可能会有)

# 项目级

项目级上下文参数支持所有项目级扩展页面、业务对象级扩展页面

参数名称 参数描述
workspace.id 当前所在项目id
workspace.name 当前所在项目名称
workspace.pretty_name 当前所在项目英文名称
workspace.parent_id 当前所在项目父项目id
workspace.created 当前所在项目创建时间
workspace.creator 当前所在项目创建人
workspace.status 当前所在项目状态

# 系统级

系统级上下文参数支持所有扩展页面

参数名称 参数描述
system.user.id 当前登录用户id
system.user.nick 当前登录用户nick
system.user.name 当前登录用户名字
system.user.name_pinyin 当前登录用户拼音名
system.user.enabled 当前登录用户状态
system.user.status_name 当前登录用户是否在职
system.user.bu_id 当前登录用户bu_id
system.user.bu_name 当前登录用户bu_name
system.user.dept_id 当前登录用户dept_id
system.user.dept_name 当前登录用户dept_name
system.user.group_id 当前登录用户group_id
system.user.group_name 当前登录用户group_name
system.user.group_names 当前登录用户group_names
system.user.post_name 当前登录用户post_name
上次更新: 2025-04-17 17:12:10