CSR配置字典之Contact类
更新时间:2025/7/29
在Gitcode上查看源码

📋 文档信息

项目内容
文档标题Contact类配置字典
版本v1.0
创建日期2025-07-29
最后更新2025-07-29
维护状态✅ 活跃维护

📋 变更历史记录

文档变更记录

版本发布日期变更类型变更内容影响范围维护人员
v1.02025-07-29初始版本创建Contact类配置字典全新文档系统管理员

🎯 类概览

Contact 类

属性
类名称Contact
功能描述联系方式对象,提供官网、技术支持、邮箱、电话等联系信息,主要用于白牌包升级和Web展示
所属SIG组interface
所属组件product_mgmt
最后更新2025-07-29
状态🟢 正常运行

📊 属性定义详表

必选属性

属性名类型默认值取值范围动态关联描述使用场景举例来源分类
OfficalWebString-String-BMC固件厂商官网信息提供联系方式"https://openubmc.cn/"CSR配置软件
SupportWebString-String-BMC固件厂商技术支持网站提供联系方式"https://openubmc.cn/"CSR配置软件
EmailString-String-BMC固件厂商联系邮箱提供联系方式"tc@public.openubmc.cn"CSR配置软件
PhoneString-String-BMC固件厂商联系电话提供联系方式""CSR配置软件
CopyrightString-String-BMC固件厂商版权信息用于Web展示版权信息"Huawei Technologies Co., Ltd. 2022-2025. All rights reserved."CSR配置软件
DefaultCopyrightString-String-BMC固件厂商默认版权信息用于恢复CSR配置的默认版权信息"Huawei Technologies Co., Ltd. 2022-2025. All rights reserved."CSR配置软件
QRCodeSupportedBoolean-Boolean-Web是否支持显示文档二维码标志位用于Web展示文档二维码trueCSR配置软件

可选属性

属性名类型默认值取值范围动态关联描述使用场景举例来源分类
KVMClientDownloadLinkString-String-独立KVM客户端下载链接信息
(由厂商提供下载链接)
提供独立KVM客户端下载链接""CSR配置软件

🔗 动态关联机制

语法规范

使用标准配置语法:

yaml
# 网站信息
OfficalWeb: "https://openubmc.cn/"
SupportWeb: "https://openubmc.cn/"

# 联系信息
Email: "tc@public.openubmc.cn"
Phone: ""

# 版权信息
Copyright: "Huawei Technologies Co., Ltd. 2022-2025. All rights reserved."
DefaultCopyright: "Huawei Technologies Co., Ltd. 2022-2025. All rights reserved."

# 功能支持
QRCodeSupported: true

# 可选配置
KVMClientDownloadLink: ""

关联说明

  • 网站信息: OfficalWeb和SupportWeb提供官网和技术支持网站
  • 联系信息: Email和Phone提供联系方式
  • 版权信息: Copyright用于Web展示版权信息,DefaultCopyright用于恢复默认设置
  • 功能支持: QRCodeSupported控制文档二维码显示功能

📂 分类标准

硬件属性

  • 定义:当前版本无硬件属性
  • 特点:所有属性都是软件管理相关
  • 示例:无

软件属性

  • 定义:由软件管理和维护的联系信息参数
  • 特点:网站信息、联系方式、版权信息等
  • 示例:所有属性都是软件属性

📝 配置示例

开源项目联系信息配置

json
{
  "Contact_OpenSource": {
    "OfficalWeb": "https://openubmc.cn/",
    "SupportWeb": "https://openubmc.cn/docs/",
    "Email": "community@openubmc.cn",
    "Phone": "",
    "Copyright": "OpenUBMC Community 2022-2025. All rights reserved.",
    "DefaultCopyright": "OpenUBMC Community 2022-2025. All rights reserved.",
    "QRCodeSupported": true,
    "KVMClientDownloadLink": ""
  }
}

🔧 使用指南

配置步骤

  1. 网站信息配置:设置OfficalWeb和SupportWeb
  2. 联系方式配置:设置Email和Phone
  3. 版权信息配置:设置Copyright和DefaultCopyright
  4. 功能支持配置:设置QRCodeSupported
  5. 可选功能配置:根据需要设置KVMClientDownloadLink
  6. 信息验证:验证所有联系信息的有效性

网站信息管理

  • OfficalWeb: 官方网站地址,用于用户了解产品信息
  • SupportWeb: 技术支持网站,用于用户获取技术支持
  • URL格式: 确保URL格式正确,包含协议(http/https)
  • 可访问性: 确保网站地址可以正常访问

联系方式管理

  • Email: 技术支持邮箱,用于用户反馈问题
  • Phone: 技术支持电话,可以为空字符串
  • 格式规范: 邮箱格式应符合标准,电话格式应包含国际区号

版权信息管理

  • Copyright: 当前版权信息,在Web界面显示
  • DefaultCopyright: 默认版权信息,用于恢复默认设置
  • 年份更新: 版权年份应及时更新
  • 法律合规: 确保版权信息符合法律要求

功能支持配置

  • QRCodeSupported: 控制Web界面是否显示文档二维码
  • 二维码功能: 用于快速访问文档和帮助信息
  • 用户体验: 提高用户获取信息的便利性

KVM客户端支持

  • KVMClientDownloadLink: KVM客户端下载链接
  • 版本兼容: 当前不支持独立KVM客户端下载

使用场景

  • 白牌包升级: 联系信息用于白牌包升级过程
  • Web展示: 版权信息和二维码在Web界面展示
  • 技术支持: 用户通过联系信息获取技术支持
  • 品牌展示: 展示产品品牌和厂商信息

注意事项

  • 信息准确性: 确保所有联系信息准确有效
  • 及时更新: 定期更新联系信息和版权信息
  • 安全考虑: 避免暴露敏感的内部联系信息
  • 国际化: 考虑不同地区的联系方式差异

故障排除

  1. 联系信息无效

    • 检查网站地址是否可以访问
    • 确认邮箱地址格式是否正确
    • 验证电话号码格式是否正确
  2. 版权信息显示异常

    • 检查Copyright字符串是否正确
    • 确认Web界面是否正确读取版权信息
    • 验证字符编码是否正确
  3. 二维码不显示

    • 检查QRCodeSupported设置是否为true
    • 确认Web界面是否支持二维码功能
    • 验证二维码生成逻辑是否正常

性能优化

  • 信息缓存: 缓存联系信息,减少重复读取
  • Web优化: 优化Web界面的信息显示效果
  • 国际化支持: 支持多语言的联系信息显示

📚 相关文档