"widget"

安装指南 > Codebeamer 安装指南 > Codebeamer 配置 > 应用程序配置 > "widget"

"widget"

用于针对所有用户禁用在仪表板上自动加载小组件内容。这有助于系统管理员通过管理资源密集型小组件来优化服务器性能和稳定性。

示例

"widget": {
"disabledWidgetIds": "5b0a2082-5153-448d-a5bc-89f1ce1520c2,2bfa4f61-f284-4950-aa79-73901f1ebc53",
"disabledWidgetTypes": "com.intland.codebeamer.dashboard.component.widgets.project.MyReviewsWidget,com.intland.codebeamer.dashboard.component.widgets.project.BurnDownChartWidget"
},

特性

特性名称	说明	类型
"disabledWidgetIds"	不能自动加载的小组件 ID 阵列。	array of strings
"disabledWidgetTypes"	不能自动加载的小组件类型阵列。	array of strings

附加信息

如果此配置按其 ID 或类型定位小组件，仪表板上的小组件内容会变为“单击此处加载小组件”消息：

用户可通过单击“单击此处加载小组件”占位符消息来加载小组件内容。

也可以在用户级别设置小组件内容自动加载。有关详情，请参阅禁用小组件的内容。

查找小组件 ID 或小组件类型

系统管理员可以通过以下方法标识小组件 ID 或类型：

从 cb.txt 服务器日志文件查找与慢速请求关联的小组件信息

与导致请求缓慢的小组件相关的信息将记录在服务器日志文件中。要验证小组件是否会导致 Codebeamer 实例出现性能问题，并获取小组件信息，请执行以下操作：

1. 下载 Codebeamer 服务器日志文件。

2. 打开 cb.txt 文件。

3. 查找将小组件与慢速请求相关联的行。

◦ 小部件信息显示如下：

WARN SlowRequests - 1. Request-344 /dashboard/widget.spr?dashboardId=1011=dd88a32e-9162-47f7-b567-ea067796e7a4==false=1713525290241 user: bond elapsed: 130 secs. started: 2024-04-19 13:14:59,596 [http-nio-8080-exec-1] [Timer-0] [328] {}

▪ 在上述示例中，小组件 ID 为 dd88a32e-9162-47f7-b567-ea067796e7a4。

查找与页面刷新关联的小组件信息

如果要获取特定仪表板上小组件的相关信息，请执行以下操作：

1. 导航到小组件所在的仪表板。

2. 按 F5 刷新浏览器页面。

3. 下载 Codebeamer 服务器日志文件。

4. 打开 cb.txt 文件。

5. 查找按 F5 键后立即记录的行。

◦ 小部件信息显示如下：

INFO support.dashboard.DashboardControllerSupport - Rendering widget with type com.intland.codebeamer.dashboard.component.widgets.project.MyReviewsWidget on dashboard 3354 (widget id: 5b0a2082-5153-448d-a5bc-89f1ce1520c2) [catalina-exec-26] [309] {Req#=859, Sess#=64c..b9b, serverId=server}

▪ 在上述示例中，小组件类型为 com.intland.codebeamer.dashboard.component.widgets.project.MyReviewsWidget，其小组件 ID 为 5b0a2082-5153-448d-a5bc-89f1ce1520c2。

从 repository/doc 文件夹查找小组件信息

每个仪表板都会将数据存储在服务器的文件系统中。要在仪表板上查找与小组件相关的信息，请执行以下操作：

1. 通过浏览器打开仪表板页面，其中包含要标识的小组件。

2. 在工具栏的左上方区域找到仪表板 ID。

◦ 此 ID 是一个前面带有 # 符号的数字。例如：#12345。

3. 按照如何访问构件的物理内容中的说明，在运行查询时，将仪表板 ID 用作 artifact_id。

4. 找到名为 1 的文件后，使用文本编辑器打开该文件。

5. 在 JSON 对象中，使用 "title" 值来标识目标小组件。

◦ 小组件 ID 显示为 "id"，小组件类型显示为 "typeName"：

[...]
},
"id": "c448433e-dc96-45d5-8b8e-437b2d5ad4d9",
"color": "",
"defaultTitleKey": "dashboard.burnDownChart.widget.name",
"headerHidden": false,
"pinned": false,
"pinnedLayout": null,
"savedVersion": "1.0.0",
"title": "Burn Down Chart",
"typeName": "com.intland.codebeamer.dashboard.component.widgets.project.BurnDownChartWidget",
"version": "1.0.0"
},
[...]

▪ 在上述示例中，小组件标题为 Burn Down Chart，小组件 ID 为 c448433e-dc96-45d5-8b8e-437b2d5ad4d9，小组件类型为 com.intland.codebeamer.dashboard.component.widgets.project.BurnDownChartWidget。