背景
-
当前现状：BMC Web界面打开“联机帮助”时，仅展示固定的单一文档，无法区分不同硬件形态。
-
改进目标：实现根据当前设备的刀片类型（Platform ID / Board ID），动态匹配并展示对应的联机帮助文档。
关联ISSUE
无
整体方案
-
接口扩展：在产品仓中定制北向接口
/UI/Rest/GenericInfo，新增只读属性OnlineHelpIdentifierPrefix。 -
标识生成：该属性值由产品仓在编译/构建阶段根据具体产品形态硬编码生成，格式为
{platform_id}_{board_id}。 -
文档打包与路由：
-
将所有类型的联机帮助文档打包进入最终软件包。
-
在设备内部按
board_id区分存储路径。 -
Web前端通过调用接口获取
OnlineHelpIdentifierPrefix，解析出board_id，从而定位并加载对应的帮助文档路径。
-
详细描述
接口定义
-
接口路径：
GET /UI/Rest/GenericInfo -
操作权限：ReadOnly（只读）
-
新增属性：
-
名称：
OnlineHelpIdentifierPrefix -
类型：String
-
说明：用于标识当前设备刀片类型，作为联机帮助文档的索引键。
-
取值规则：由产品仓定制，格式为
{platform_id}_{board_id}。 -
默认值：若未配置，返回空字符串或不存在该字段。
-
使用示例：
于产品仓中定制该接口，在响应体中新增属性OnlineHelpIdentifierPrefix
格式为字符串，取值为 {platform_id}_{board_id}
示例：
"OnlineHelpIdentifierPrefix": "02_04"
代表当前设备的刀片类型，由产品仓根据产品定制区分写死，不通过资源协作接口属性获取
| 属性值 | Platform ID | Board ID | 含义说明 |
|---|---|---|---|
02_02 |
02 | 02 | 对应特定刀片类型 A |
02_04 |
02 | 04 | 对应特定刀片类型 B |
02_05 |
02 | 05 | 对应特定刀片类型 C |
02_06 |
02 | 06 | 对应特定刀片类型 D |
02_07 |
02 | 07 | 对应特定刀片类型 E |
回显说明：
回显中新增OnlineHelpIdentifierPrefix属性
联机帮助文档全部打包入软件包，并在设备内部按照board_id区分定制路径进行存储。北向接口可以获取到board_id后，根据borad_id匹配对应的联机帮助文档路径，最终达到根据刀片类型打开不同的联机帮助文档的目的。
评审结论
结论：通过 (Approved)
同意在 Web REST 接口 /UI/Rest/GenericInfo 的响应体中新增以下属性：
| 属性名称 | 类型 | 权限 | 说明 | 约束条件 |
|---|---|---|---|---|
OnlineHelpIdentifierPrefix |
String | ReadOnly | 联机帮助文档索引标识 | 由产品仓定制写死，视产品形态决定 |
- 默认行为：若产品未配置此属性，上层解析视为空，保持原有逻辑或默认行为。
遗留问题
无