在此页:
目标用户:
CAST AI 管理员
摘要: 本页将解释如何配置工程仪表盘图块接口。
简介
工程仪表盘有一个基于“图块”或“面板”的界面,提供对数据的访问:
这些图块具有默认的表示设置,但是可以根据需求进行修改和自定义。例如:
- 图块颜色可以改变
- 图块位置可以改变
- 图块内容可以改变
- 图块大小可以改变
- 可以添加新的图块
- 可以添加白色分隔块来帮助组织块
编辑图块展示
默认的图块表示形式定义在以下文件中:
%CATALINA_HOME%\webapps\CAST-Engineering\engineering\resources\ced.json
为了修改展示,使用文本编辑器(记事本或其它类似的应用)编辑.json文件。CAST推荐:
- 创建默认.json文件的副本,如果在编辑过程中发生错误,可以使用该文件作为替换
- 首先更改现有的参数,如颜色和标题,并在开始进行大规模和更复杂的更改之前移动图块
在浏览器中查看更改
如果编辑并保存.json文件,则不需要重新启动应用服务器或应用本身:保存文件时立即发生更改。但是可能会发现这些更改在工程仪表盘中并非立即可见。这是因为.json文件被加载到浏览器的缓存中,因此CAST建议清空浏览器缓存以强制更改生效。
如果使用的是谷歌Chrome,下面的提示可以用来自动清空浏览器缓存:
- 点击F12打开页面底部的Developer Tools窗口。
- 单击Developer Tools窗口右侧的Settings图标(一个cog)。
- 勾选禁用缓存(当DevTools打开时)选项并关闭设置窗口。
- 在这种状态下,单击F12和F5刷新页面时,浏览器缓存将自动清空。
改变图块的位置
图块使用在每个图块配置中定义的列和行配置显示在工程仪表盘中。因此要移动一个图块,需要在.json文件中更改其配置。有关列和行配置的更多信息可在图块尺寸和定位中提供。
配置白色分隔图块
可以添加单个或多个白色分隔图块,以便更容易的将块组织成组。它作为一个分隔符,可以调整大小,并沿着水平和垂直轴移动。下面是一个例子。注意无法将白色图块配置为单击到其它数据:
配置
type: 图块类型 "MockTile"
color : 图块颜色,即白色或“”。
title: 图块标题,可配置(“附加信息”)
图块尺寸和定位的其它参数——参见图块尺寸和定位
示例
{ "type": "MockTile", "color": "", "parameters": {}, "col": 1, "row": 5, "sizex": 6, "sizey": 1, "max-sizex": 8, "max-sizey": 6, "title": "Additional Information", "id": "c928" }
.json的结构
.json文件分为不同的部分,每个部分对应于工程仪表盘中的一个图块。定义了各种图块(或面板),例如“开箱即用”图块规则、测量、分布图块:
{ "type": "QualityModelOverview", "color": "pink", "parameters": {}, "col": 1, "row": 1, "sizex": 2, "sizey": 2, "max-sizex": 2, "max-sizey": 2 },
.json中的可用参数
Top Riskiest Components
此图块提供了可单击的对象名称“云”——用于显示名称的字体越大、越粗,对象在指定的健康因子(例如安全性或效率)中具有的风险(以前称为PRI: 传播风险指数)值就越高。参见工程仪表盘获得更多关于风险是如何计算的信息。
单击图块中的对象名称将直接进入应用调查视图中的对象(参见工程仪表盘获得更多信息)。
配置
- 类型: 图块类型必须是风险最高的组件
- 参数
- 业务健康因子ID
- 健康因子名称指标
- nbRows(可选)要获取的项数(默认设置为10)
- 颜色: 图块颜色
- 图块尺寸和定位的其它参数——参见图块尺寸和定位
示例
{ "type": "RiskiestComponents", "parameters": { "business": "60011", "indicator": "Transferability", "nbRows":10 }, "color": "grey", "col": 5, "row": 2, "sizex": 2, "sizey": 1, "min-sizex": 2, "min-sizey": 1, "max-sizey": 5, "max-sizex": 5 }
最高风险的交易
图块提供了一个可单击的事务名称“云”——用于显示事务名称的字体越大、越粗,TRI值(TRI或事务风险指数是事务风险的指示器)在指定的健康因子范围内就越高(即健壮性、效率和安全性)。健壮性被设置为默认的健康因子,但是可以使用下拉箭头在图块本身中进行更改。
单击图块中的事务名称将直接进入事务调查视图中的事务(参见工程仪表盘获得更多信息)。
配置
- 类型:图块类型,必须是最高风险的事务
- 参数
- 业务健康因子ID
- nbRows(可选)要获取的项数(默认设置为30)
- 颜色:图块颜色
- 图块尺寸和定位的其它参数——参见图块尺寸和定位
示例
{ "type": "TopRiskiestTransactions", "parameters": { "business": "60013", "nbRows":30 }, "color": "orange", "col": 7, "row": 3, "sizex": 2, "sizey": 2, "min-sizex": 2, "min-sizey": 1, "max-sizey": 5, "max-sizex": 5 }
Top Modules with Violations or Critical Violations
此图块按每个模块中出现的严重违规次数提供了排序的模块列表。图块可以调整大小以显示模块数量的多少。单击图块中的模块将直接进入应用调查视图中的模块(参见工程仪表盘获得更多信息)。在应用调查视图中,违反质量规则的按数量列出,关键规则优先(默认情况下:按照违反的数量排序)。
请注意,根据显示的是严重违规还是所有违规(参见针对严重违规的数据过滤),内容将反映当前激活的过滤器,只显示严重违规或所有违规。
配置
- 类型: 图块类型必须是TopCriticalModules
- 参数
- 业务健康因子ID
- 颜色:图块颜色
- 图块尺寸和定位的其它参数——参见图块尺寸和定位
示例
{ "type": "TopCriticalModules", "parameters": { "business": 60017 }, "color": "violet", "col": 7, "row": 1, "sizex": 2, "sizey": 2, "min-sizex": 2, "min-sizey": 1, "max-sizex": 4, "max-sizey": 5 }
Health Factor weakness/strength tiles
请注意,根据显示的是严重违规还是所有违规(参见针对严重违规的数据过滤),内容将反映当前激活的过滤器,只显示严重违规或所有违规。
这些图块提供了给定健康因子的优点和缺点(根据技术标准)的摘要。这些图块提供:
- 缺点: 显示的项目是被认为至少有一个严重违反的技术标准。技术标准从最差(顶层)到最差(底层)进行排序。
- 优点: 在技术标准中显示的项目没有任何严重的违反(这包括没有关键质量规则的技术标准或没有违反关键规则的技术标准)。
配置
- 类型: 图块类型必须是BusinessCriteria
- 参数
- 业务健康因子ID
- 健康因子名称指标
- orderBy 优点或缺点
- 颜色: 图块颜色
- 图块尺寸和定位的其它参数——参见图块尺寸和定位
示例
{ "type": "BusinessCriteria", "parameters": { "business": "60012", "indicator": "Changeability", "orderBy":"strength" }, "color": "green", "col": 3, "row": 3, "sizex": 2, "sizey": 1, "min-sizex": 2, "min-sizey": 1, "max-sizex": 3, "max-sizey": 5 }
Top Rules with increasing / decreasing violations
此图块显示质量规则列表和每个规则的值。该值表示最近快照与以前快照之间违反质量规则次数的差异。数值越高,差值越大。可以从三个值中选择(如上例所示):
- 比率 —— 显示百分比差异(增加)
- 添加 —— 显示添加违规的确切数量
- 删除 —— 显示删除违规行为的确切数量
注意当使用“比率”选项时,在图块中显示的值可能与给定质量规则的添加或删除违规次数的值不同,因为该值是自上次快照以来违规次数之间的差值,并且需要考虑添加和删除违规。
违规计数差显示在规则的右侧,当规则是关键的时候,添加一个红点。规则是可点击的,并将指引到质量调查视图中的质量规则(参见工程仪表盘获得更多信息)。
请注意仪表盘中的默认行为是只显示严重违规(参见关键违规数据过滤)——因此,图块中的显示将反映这一点,并且只显示严重违规(带有红点)。如果禁用默认过滤器以显示所有违规,那么图块将显示关键违规和非关键违规。
配置
- 类型: 图块类型必须是NewViolationsForQualityRules
- 参数
- 业务健康因子ID
- 变化决定了要考虑的价值
- 比率(默认值),显示当前快照和以前快照之间的违规变化
- 增加显示仅关注增加的违规情况
- 删除显示仅变化关注删除违规
- 颜色: 图块颜色
- 图块尺寸和定位的其它参数——参见图块尺寸和定位
{ "type": "NewViolationsForQualityRules", "parameters": { "business": 60017, "variation":"added" }, "color": "dark-grey-red", "col": 7, "row": 2, "sizex": 2, "sizey": 2, "min-sizex": 2, "min-sizey": 1, "max-sizex": 4, "max-sizey": 5 }
引入风险
默认情况下,此图块显示了总质量指数(TQI)健康因子的两个值:
- 增加严重违规或违规>在当前快照中引入严重违规或违规的次数(即“风险”)
- 删除关键违规或违规>从当前的快照中关键违规或违规的数量
值是前一个快照和当前快照之间的比较,因此如果这是第一个快照,那么将添加关键违规或违规,但不删除关键违规或违规。还可以通过单击健康因子名称旁边的下拉箭头来更改健康因子。如果快照中不存在添加或删除的关键违规或违规行为,则图块将不显示数据,且不可单击:
请注意根据显示的是严重违规还是所有违规(参见关键违规数据过滤),内容将反映当前激活的过滤器,只显示严重违规或所有违规。
单击图块时的行为
点击图块将直接带您到健康因子质量调查视图(参见工程仪表盘 获得更多信息)然而调查质量视图只显示添加和删除违规信息。任何健康因子、技术标准或质量规则,如果添加和/或删除的违规次数为0,则不可见。有消息将反映这一点(点击放大):
配置
- 类型: 图块类型为AddedViolations
- 参数
- 业务:健康因子ID
- 颜色 : 图块颜色
- 图块尺寸和定位的其它参数——参见图块尺寸和定位
示例
{ "type": "AddedViolations", "parameters": { "business": "60017" }, "color": "orange", "col": 3, "row": 1, "sizex": 2, "sizey": 1, "min-sizex": 1, "min-sizey": 1, "max-sizey": 1, "max-sizex": 2 }
Action Plan
将显示一个默认的操作计划图块,最初显示自上次快照生成以来添加到操作计划列表中对象的总数。点击图块将直接进入操作计划。
配置
- 类型: 图块类型是ActionPlanSummary
- 参数: 无
- 颜色 : 图块颜色
- 图块尺寸和定位的其它参数——参见图块尺寸和定位
示例
{ "type": "ActionPlanSummary", "parameters": {}, "color": "blue", "col": 5, "row": 8, "sizex": 2, "sizey": 1, "min-sizex": 1, "min-sizey": 1, "max-sizex": 2, "max-sizey": 2, "id": "c934" }
Exclusions
一个默认的排除图块显示:
- 活动排除项>显示了添加到排除项列表中违规行为的数量,并生成了后续快照(因此,这些违规行为不是当前快照结果的一部分),即它们被积极排除。
- 排除计划>显示了添加到排除列表中且尚未生成快照的违规事件数量(因此违规事件仍然是当前快照结果的一部分)。生成快照后,此列表中的排除项将移动到活动排除项列表。
单击该图块将直接进入相关的排除页面,有关更多信息请参见工程仪表盘-排除。
配置
- 类型: 图块类型是ExclusionSummary
- 参数: 无
- 颜色 : 图块颜色
- 图块尺寸和定位的其它参数——参见图块尺寸和定位
示例
{ "type": "ExclusionSummary", "parameters": {}, "color": "grey-light", "col": 5, "row": 8, "sizex": 2, "sizey": 1, "min-sizex": 1, "min-sizey": 1, "max-sizex": 2, "max-sizey": 1, "id": "c9344" }
外部链接
此图块(默认不可用)提供了在图块中定义外部URL(例如其它数据仪表盘)的能力:
配置
- 类型: 图块类型必须是ExternalLink
- 参数
- 在图块中显示标题的短消息
- url下面的超链接
- 颜色: 图块颜色
- 图块尺寸和定位的其它参数——参见图块尺寸和定位
{ "type": "ExternalLink", "parameters": { "title": "Know more about CAST", "url":"http://www.castsoftware.com" }, "color": "magenta", "col": 5, "row": 3, "sizex": 1, "sizey": 1, "min-sizex": 1, "min-sizey": 1, "max-sizex": 2, "max-sizey": 1 }
图块尺寸和定位
所有图块(自定义和默认)都使用图块配置设置中的一组选项进行调整和定位。这些选项控制图块可以放大,可以缩小,图块在登录/主页上的默认大小和默认位置。终端用户可以自由移动和调整大小的图块本身使用拖拽选项——使用重置主页选项(参见工程仪表盘)将使图块恢复到本身配置的大小和位置。
大小和定位设置通过每个图块中的这些选项提供,每个解释如下:
"col": 7, "row": 2, "sizex": 2, "sizey": 2, "min-sizex": 2, "min-sizey": 1, "max-sizex": 4, "max-sizey": 5
登录/主页被划分为固定大小的列和行网格。这个网格是用来定位和大小图块如下:
示例选项 | 说明 |
---|---|
"col": 7 | 图块的左上角位于第7列中。 |
"row": 2 | 图块的左上角位于第2行。 |
"sizex": 2 | 在X轴(水平方向)上定义图块的大小,即图块使用的列数。 |
"sizey": 2 | 在Y轴(垂直方向)上定义图块的大小,即图块使用的行数。 |
"min-sizex": 2 | 定义X轴上图块的最小大小(水平方向),即列可以使用的最小列数。 |
"min-sizey": 1 | 定义Y轴上图块的最小大小(垂直方向),即列可以使用的最小行数。 |
"max-sizex": 4 | 定义X轴上图块的最大尺寸(水平方向),即列可以使用的最大列数。 |
"max-sizey": 5 | 定义Y轴(垂直方向)上图块的最大大小,即列可以使用的最大行数。 |