看板嵌出

最近更新时间:2024-07-15 09:41:01

我的收藏
看板嵌出功能支持将页面或项目看板嵌出到第三方系统里,便于供第三方系统用户查看。

嵌出功能前置条件:
当前版本为基础版或专业版;
被嵌出的页面需要先发布后嵌出;
当前用户为企业管理员/项目管理员;
如需携带页面参数,则需要购买专业版。

通过本文档,您将了解:
如何嵌出整个看板;
如何设置默认展示页面。


看板嵌出设置

用户可通过如下步骤完成嵌出设置:
1. 进入项目 > 看板;单击嵌出图标;



2. 在嵌出配置中,选择“当前看板”:



如需要使嵌出的地址失效,则可关闭嵌出,一旦关闭,用户再访问嵌出地址,则会报“页面无法访问”;
如期望对嵌出的页面进行鉴权访问,则可以开启嵌出校验,开启校验后,需要通过 token 来获得相应的权限,详见创建嵌出报表 Token申请延长 Token 可用时间接口
对于未开启嵌出校验,则该嵌出链接将可能被泄露,建议非公开数据务必打开嵌出校验。
如期望有效期内才可以被访问,则可设定有效期,一旦开启有效期,则用户在非有效期内访问会报“超出有效期范围”。
注意:
项目看板的嵌出针对整个看板的,即任何页面对项目看板的设置都是同步的;如其他人在该项目下任意一个页面关闭了项目看板的嵌出,则之前设置的将被覆盖!
3. 单击更新设置,使设置生效。

设置看板默认展示页

在嵌出的看板里,如需要设置默认打开进入某个页面,则可以通过 menuId 来指定默认页。
1. 获得看板嵌出地址:如上面配置看板嵌出;
/*本例中,假设已获得嵌出链接如下,请记得修改projectId/menuId及token值 */
https://tcbi.qq.com/page/embed?authType=weak&menuId=1234455&projectId=111&scope=panel&token=1165dd48-be27-4cbd-97be-e5b5cf5bae25&canvasType=GRID
2. 获取 menuId:浏览看板,点击页面,在 url 里获取 menuId,如下图:



3. 修改嵌出链接:将获取到的 menuId 替换原来的 menuId。
https://tcbi.qq.com/page/embed?authType=weak&menuId=6a143c9bc1bb1ac190e280f4210c0a07&projectId=111&scope=panel&token=1165dd48-be27-4cbd-97be-e5b5cf5bae25&canvasType=GRID