From ca62f5de867cc99d36177e28a5ad623aadd2bb8e Mon Sep 17 00:00:00 2001 From: LiuLiang <83030246@qq.com> Date: Thu, 4 Jun 2026 18:52:39 +0800 Subject: [PATCH] =?UTF-8?q?=E6=9B=B4=E6=96=B0=E7=9B=AE=E5=BD=95?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- .../基础平台/功能模块/08-基础配置管理.md | 470 ++---------------- .../基础平台/功能模块/10-操作日志.md | 4 +- .../基础平台/功能模块/基础配置/01-平台运行配置.md | 52 ++ .../功能模块/基础配置/02-登录与安全配置.md | 55 ++ .../功能模块/基础配置/03-门户与应用容器配置.md | 46 ++ .../基础平台/功能模块/基础配置/04-客户级配置.md | 51 ++ .../功能模块/基础配置/05-应用级接入配置.md | 46 ++ .../功能模块/基础配置/06-消息与通知配置.md | 41 ++ .../基础平台/功能模块/基础配置/07-对象存储配置.md | 69 +++ .../基础平台/功能模块/基础配置/08-短信发送配置.md | 95 ++++ .../功能模块/基础配置/09-审计与日志配置.md | 42 ++ .../基础平台/功能模块/基础配置/10-基础开关配置.md | 46 ++ .../基础平台/功能模块/基础配置/11-配置项管理.md | 71 +++ .../基础平台/功能模块/基础配置/12-配置版本记录.md | 32 ++ .../基础平台/功能模块/基础配置/README.md | 18 + 15 files changed, 699 insertions(+), 439 deletions(-) create mode 100644 40-平台与架构/基础平台/功能模块/基础配置/01-平台运行配置.md create mode 100644 40-平台与架构/基础平台/功能模块/基础配置/02-登录与安全配置.md create mode 100644 40-平台与架构/基础平台/功能模块/基础配置/03-门户与应用容器配置.md create mode 100644 40-平台与架构/基础平台/功能模块/基础配置/04-客户级配置.md create mode 100644 40-平台与架构/基础平台/功能模块/基础配置/05-应用级接入配置.md create mode 100644 40-平台与架构/基础平台/功能模块/基础配置/06-消息与通知配置.md create mode 100644 40-平台与架构/基础平台/功能模块/基础配置/07-对象存储配置.md create mode 100644 40-平台与架构/基础平台/功能模块/基础配置/08-短信发送配置.md create mode 100644 40-平台与架构/基础平台/功能模块/基础配置/09-审计与日志配置.md create mode 100644 40-平台与架构/基础平台/功能模块/基础配置/10-基础开关配置.md create mode 100644 40-平台与架构/基础平台/功能模块/基础配置/11-配置项管理.md create mode 100644 40-平台与架构/基础平台/功能模块/基础配置/12-配置版本记录.md create mode 100644 40-平台与架构/基础平台/功能模块/基础配置/README.md diff --git a/40-平台与架构/基础平台/功能模块/08-基础配置管理.md b/40-平台与架构/基础平台/功能模块/08-基础配置管理.md index 16db45f..0156c69 100644 --- a/40-平台与架构/基础平台/功能模块/08-基础配置管理.md +++ b/40-平台与架构/基础平台/功能模块/08-基础配置管理.md @@ -31,131 +31,26 @@ - 回滚配置版本 - 查看配置操作记录 -## 5.8.3 推荐基础配置清单 +## 5.8.3 配置项目目录 -基础配置 1.0 建议按“先支撑基础平台运行,再支撑客户差异化,再支撑应用接入”的顺序建设。 +基础配置管理按配置场景拆分为独立文档。总览文档只保留模块边界、通用规则、入口结构、使用导航和统一验收标准;各配置项目的字段、控件和页面规则详见子文档。 -### 5.8.3.1 平台运行配置 +配置项目目录:[基础配置](./基础配置/README.md) -平台运行配置用于维护基础平台自身运行参数,由平台管理员维护。 - -推荐配置: - -| 配置名称 | 配置说明 | 配置层级 | 1.0 建议 | -| --- | --- | --- | --- | -| 平台名称 | 门户头部展示的平台名称 | 平台级 | 必须 | -| 平台 Logo | 门户头部展示的 Logo 地址或资源标识 | 平台级 | 必须 | -| 默认语言 | 用户未设置语言时的默认语言 | 平台级 | 必须 | -| 默认主题 | 用户未设置主题时的默认主题 | 平台级 | 必须 | -| 默认分页条数 | 列表页默认分页大小 | 平台级 | 必须 | -| 文件上传大小限制 | 基础平台通用上传文件大小限制 | 平台级 | 建议 | -| 导出文件有效期 | 导出文件可下载的有效时间 | 平台级 | 建议 | -| 系统维护公告 | 平台维护、升级、停机提示内容 | 平台级 | 建议 | - -### 5.8.3.2 登录与安全配置 - -登录与安全配置用于支撑统一登录、账号安全、Token 有效期和密码策略。 - -推荐配置: - -| 配置名称 | 配置说明 | 配置层级 | 1.0 建议 | -| --- | --- | --- | --- | -| Token 有效期 | 用户登录后 Token 的有效时间 | 平台级 | 必须 | -| Token 刷新有效期 | Token 可被刷新的最大时间范围 | 平台级 | 必须 | -| 登录失败锁定次数 | 连续登录失败达到次数后锁定账号 | 平台级 | 必须 | -| 登录失败锁定时长 | 账号被锁定后的自动解锁时长 | 平台级 | 必须 | -| 初始密码生成规则 | 系统生成初始密码的规则 | 平台级 | 必须 | -| 密码复杂度规则 | 密码长度、字符类型等要求 | 平台级 | 必须 | -| 首次登录修改密码 | 新建平台账号首次登录是否强制改密 | 平台级 / 客户级 | 必须 | -| 密码有效期 | 密码到期后是否要求修改 | 平台级 / 客户级 | 建议 | -| 第三方账号绑定开关 | 是否允许绑定微信、企微、钉钉、飞书等第三方账号 | 平台级 / 客户级 | 建议 | - -### 5.8.3.3 门户与应用容器配置 - -门户与应用容器配置用于支撑统一门户、菜单聚合、Tab 和 iframe 应用容器。 - -推荐配置: - -| 配置名称 | 配置说明 | 配置层级 | 1.0 建议 | -| --- | --- | --- | --- | -| 默认首页 | 用户登录后默认打开的页面 | 平台级 / 客户级 | 必须 | -| 常用菜单数量 | 头部常用菜单最多展示数量 | 平台级 | 建议 | -| 最大打开 Tab 数 | 用户最多可同时打开的页面 Tab 数 | 平台级 | 必须 | -| iframe Token 同步开关 | 是否向 iframe 应用同步 Token 状态 | 平台级 | 必须 | -| iframe 页面超时处理 | iframe 应用无响应或 Token 失效时的处理方式 | 平台级 | 建议 | -| 菜单折叠默认状态 | 左侧菜单默认展开或折叠 | 平台级 / 用户级 | 建议 | - -### 5.8.3.4 客户级基础配置 - -客户级基础配置用于支持不同客户在基础平台中的差异化设置。 - -推荐配置: - -| 配置名称 | 配置说明 | 配置层级 | 1.0 建议 | -| --- | --- | --- | --- | -| 客户显示名称 | 门户展示的客户名称或简称 | 客户级 | 必须 | -| 客户默认行业 | 客户所属行业默认值 | 客户级 | 必须 | -| 客户默认语言 | 当前客户用户默认语言 | 客户级 | 建议 | -| 客户默认主题 | 当前客户用户默认主题 | 客户级 | 建议 | -| 手机号唯一策略 | 手机号在客户内唯一或平台内唯一 | 客户级 | 必须 | -| 是否允许多组织归属 | 用户是否允许归属于多个组织 | 客户级 | 必须 | -| 是否允许客户自维护角色 | 客户管理员是否可新增和编辑自定义角色 | 客户级 | 必须 | -| 是否允许客户自维护组织 | 客户管理员是否可维护组织架构 | 客户级 | 建议 | - -### 5.8.3.5 应用级接入配置 - -应用级接入配置用于支撑业务应用接入基础平台后的通用控制。 - -推荐配置: - -| 配置名称 | 配置说明 | 配置层级 | 1.0 建议 | -| --- | --- | --- | --- | -| 应用启用开关 | 应用是否允许被访问 | 应用级 | 必须 | -| 应用默认打开方式 | iframe 嵌入或外部跳转 | 应用级 | 必须 | -| 应用菜单缓存时长 | 应用菜单授权结果缓存时间 | 应用级 | 建议 | -| 应用权限刷新策略 | 权限变更后应用获取最新权限的策略 | 应用级 | 建议 | -| 应用 Token 校验策略 | 应用访问时是否每次校验 Token | 应用级 | 必须 | - -### 5.8.3.6 消息与通知配置 - -消息与通知配置用于支撑基础平台消息、待办和系统通知。 - -推荐配置: - -| 配置名称 | 配置说明 | 配置层级 | 1.0 建议 | -| --- | --- | --- | --- | -| 系统消息开关 | 是否启用基础平台系统消息 | 平台级 | 建议 | -| 待办提醒开关 | 是否启用待办提醒 | 平台级 / 客户级 | 建议 | -| 消息保留天数 | 系统消息保留时长 | 平台级 | 建议 | -| 未读消息提醒间隔 | 门户轮询或刷新未读消息的间隔 | 平台级 | 可延后 | - -### 5.8.3.7 审计与日志配置 - -审计与日志配置用于支撑操作日志和安全审计。 - -推荐配置: - -| 配置名称 | 配置说明 | 配置层级 | 1.0 建议 | -| --- | --- | --- | --- | -| 操作日志保留天数 | 操作日志可查询和保留时间 | 平台级 | 必须 | -| 登录日志保留天数 | 登录日志可查询和保留时间 | 平台级 | 必须 | -| 敏感操作二次确认 | 停用客户、停用用户、重置密码等是否二次确认 | 平台级 | 必须 | -| 敏感字段脱敏开关 | 手机号、账号标识等字段是否脱敏展示 | 平台级 / 客户级 | 必须 | - -### 5.8.3.8 基础业务开关 - -基础业务开关用于控制基础平台自身功能是否启用。 - -推荐配置: - -| 配置名称 | 配置说明 | 配置层级 | 1.0 建议 | -| --- | --- | --- | --- | -| 是否启用客户管理 | 控制客户管理功能是否开放 | 平台级 | 必须 | -| 是否启用应用管理 | 控制应用管理功能是否开放 | 平台级 | 必须 | -| 是否启用组织管理 | 控制组织管理功能是否开放 | 平台级 | 必须 | -| 是否启用角色管理 | 控制角色管理功能是否开放 | 平台级 | 必须 | -| 是否启用第三方登录 | 控制第三方登录入口是否开放 | 平台级 | 可延后 | -| 是否启用外部协同接入 | 控制 2.0 外部协同能力是否开放 | 平台级 | 可延后 | +| 编号 | 配置项目 | 独立文档 | +| --- | --- | --- | +| 5.8.3.1 | 平台运行配置 | [01-平台运行配置.md](./基础配置/01-平台运行配置.md) | +| 5.8.3.2 | 登录与安全配置 | [02-登录与安全配置.md](./基础配置/02-登录与安全配置.md) | +| 5.8.3.3 | 门户与应用容器配置 | [03-门户与应用容器配置.md](./基础配置/03-门户与应用容器配置.md) | +| 5.8.3.4 | 客户级配置 | [04-客户级配置.md](./基础配置/04-客户级配置.md) | +| 5.8.3.5 | 应用级接入配置 | [05-应用级接入配置.md](./基础配置/05-应用级接入配置.md) | +| 5.8.3.6 | 消息与通知配置 | [06-消息与通知配置.md](./基础配置/06-消息与通知配置.md) | +| 5.8.3.7 | 对象存储配置 | [07-对象存储配置.md](./基础配置/07-对象存储配置.md) | +| 5.8.3.8 | 短信发送配置 | [08-短信发送配置.md](./基础配置/08-短信发送配置.md) | +| 5.8.3.9 | 审计与日志配置 | [09-审计与日志配置.md](./基础配置/09-审计与日志配置.md) | +| 5.8.3.10 | 基础开关配置 | [10-基础开关配置.md](./基础配置/10-基础开关配置.md) | +| 5.8.3.11 | 配置项管理 | [11-配置项管理.md](./基础配置/11-配置项管理.md) | +| 5.8.3.12 | 配置版本记录 | [12-配置版本记录.md](./基础配置/12-配置版本记录.md) | ## 5.8.4 不建议纳入基础配置的内容 @@ -179,7 +74,7 @@ | --- | --- | --- | | 配置名称 | 配置项展示名称 | 是 | | 配置编码 | 配置项唯一编码 | 是 | -| 配置分类 | 平台运行、登录安全、门户容器、客户配置、应用配置、消息通知、审计日志、业务开关 | 是 | +| 配置分类 | 平台运行、登录安全、门户容器、客户配置、应用配置、消息通知、对象存储、短信发送、审计日志、业务开关 | 是 | | 配置层级 | 平台级、客户级、应用级 | 是 | | 所属客户 | 客户级配置所属客户 | 条件必填 | | 所属应用 | 应用级配置所属应用 | 条件必填 | @@ -212,6 +107,8 @@ | 登录安全 | TOKEN_EXPIRE_MINUTES | | 登录安全 | PASSWORD_COMPLEXITY_RULE | | 门户容器 | MAX_OPEN_TAB_COUNT | +| 对象存储 | OBJECT_STORAGE_PROVIDER | +| 短信发送 | SMS_PROVIDER | | 审计日志 | OPERATION_LOG_RETENTION_DAYS | | 基础开关 | ENABLE_THIRD_PARTY_LOGIN | @@ -230,9 +127,7 @@ - 配置回滚时,需要生成新的配置版本,不直接覆盖历史版本。 - 配置变更、启用、停用、回滚需要记录操作日志。 -## 5.8.7 界面设计 - -### 5.8.7.1 功能入口与访问权限 +## 5.8.7 界面入口与访问权限 基础配置管理作为基础平台管理功能,建议放置在基础平台左侧菜单,并按配置场景拆分页面: @@ -245,6 +140,8 @@ ├── 客户级配置 ├── 应用级接入配置 ├── 消息与通知配置 + ├── 对象存储配置 + ├── 短信发送配置 ├── 审计与日志配置 ├── 基础开关配置 └── 配置项管理 @@ -266,316 +163,6 @@ - 常用配置应优先进入场景化页面,不应要求使用者记忆配置编码。 - 复杂结构化配置可在配置项管理中维护,但需要控制权限和操作审计。 -### 5.8.7.2 平台运行配置页 - -平台运行配置页用于维护平台展示和通用运行参数。 - -展示方式: - -- 采用分组表单展示。 -- 分组包括:平台展示、通用列表、文件与导出、系统公告。 -- 页面底部固定操作按钮:取消、保存。 - -表单字段: - -| 字段 | 控件类型 | 值来源 / 录入方式 | 说明 | -| --- | --- | --- | --- | -| 平台名称 | 文本输入框 | 人工录入 | 门户头部展示名称 | -| 平台 Logo | 图片上传 / 资源选择器 | 上传或选择平台资源 | 门户头部展示 Logo | -| 默认语言 | 下拉框 | 语言字典 | 用户未设置语言时使用 | -| 默认主题 | 下拉框 | 主题字典 | 用户未设置主题时使用 | -| 默认分页条数 | 数字输入框 | 人工录入 | 列表页默认分页大小 | -| 文件上传大小限制 | 数字输入框 + 单位选择 | 人工录入 | 通用上传限制 | -| 导出文件有效期 | 数字输入框 + 单位选择 | 人工录入 | 导出文件可下载时长 | -| 系统维护公告 | 多行文本框 | 人工录入 | 可为空 | -| 启用状态 | Switch | 人工选择 | 控制该组配置是否启用 | - -页面规则: - -- 平台名称、默认语言、默认主题、默认分页条数为必填。 -- 保存后生成配置版本。 -- 修改平台展示类配置后,用户刷新门户时生效。 - -### 5.8.7.3 登录与安全配置页 - -登录与安全配置页用于维护统一登录、Token、账号密码和第三方账号绑定相关参数。 - -展示方式: - -- 采用分组表单展示。 -- 分组包括:Token 策略、登录失败策略、密码策略、第三方账号策略。 -- 页面底部固定操作按钮:取消、保存。 - -表单字段: - -| 字段 | 控件类型 | 值来源 / 录入方式 | 说明 | -| --- | --- | --- | --- | -| Token 有效期 | 数字输入框 + 单位选择 | 人工录入 | 必填 | -| Token 刷新有效期 | 数字输入框 + 单位选择 | 人工录入 | 必填 | -| 登录失败锁定次数 | 数字输入框 | 人工录入 | 必填 | -| 登录失败锁定时长 | 数字输入框 + 单位选择 | 人工录入 | 必填 | -| 初始密码生成规则 | 下拉框 / 表单组合 | 平台预置规则 | 必填 | -| 密码最小长度 | 数字输入框 | 人工录入 | 必填 | -| 密码复杂度要求 | Checkbox 组 | 大写字母、小写字母、数字、特殊字符 | 必填 | -| 首次登录修改密码 | Switch | 人工选择 | 默认开启 | -| 密码有效期 | 数字输入框 + 单位选择 | 人工录入 | 可为空 | -| 允许第三方账号绑定 | Switch | 人工选择 | 控制微信、企微、钉钉、飞书绑定能力 | - -页面规则: - -- Token 刷新有效期应大于 Token 有效期。 -- 登录失败锁定次数必须大于 0。 -- 密码复杂度保存前需要校验规则完整性。 -- 影响登录安全的配置保存时需要二次确认。 - -### 5.8.7.4 门户与应用容器配置页 - -门户与应用容器配置页用于维护统一门户、Tab、菜单和 iframe 容器参数。 - -展示方式: - -- 采用分组表单展示。 -- 分组包括:首页与菜单、Tab 管理、iframe 容器。 - -表单字段: - -| 字段 | 控件类型 | 值来源 / 录入方式 | 说明 | -| --- | --- | --- | --- | -| 默认首页 | 页面选择器 / 菜单选择器 | 基础平台页面或已启用菜单 | 用户登录后默认打开页面 | -| 常用菜单数量 | 数字输入框 | 人工录入 | 头部常用菜单最多展示数量 | -| 最大打开 Tab 数 | 数字输入框 | 人工录入 | 必填 | -| 菜单折叠默认状态 | 单选框 | 展开、折叠 | 默认展开 | -| iframe Token 同步开关 | Switch | 人工选择 | 必须开启 | -| iframe 页面超时处理 | 下拉框 | 提示重试、关闭页签、跳转错误页 | 必填 | - -页面规则: - -- 最大打开 Tab 数必须大于 0。 -- iframe Token 同步开关关闭时,需要提示会影响业务应用访问。 -- 默认首页必须是用户有权限访问的页面或菜单。 - -### 5.8.7.5 客户级配置页 - -客户级配置页用于维护某个客户在基础平台中的差异化设置。 - -展示方式: - -- 顶部为客户选择器。 -- 下方为分组表单。 -- 客户管理员进入时默认当前客户,不展示客户选择器。 - -表单字段: - -| 字段 | 控件类型 | 值来源 / 录入方式 | 说明 | -| --- | --- | --- | --- | -| 所属客户 | 客户选择器 / 只读文本 | 客户管理中已启用客户 | 平台用户选择;客户管理员只读当前客户 | -| 客户显示名称 | 文本输入框 | 默认取客户简称 | 可覆盖门户展示名称 | -| 客户默认语言 | 下拉框 | 语言字典 | 可为空,空则使用平台默认语言 | -| 客户默认主题 | 下拉框 | 主题字典 | 可为空,空则使用平台默认主题 | -| 手机号唯一策略 | 单选框 | 客户内唯一、平台内唯一 | 1.0 默认客户内唯一 | -| 允许多组织归属 | Switch | 人工选择 | 控制用户是否可归属多个组织 | -| 允许客户自维护角色 | Switch | 人工选择 | 控制客户管理员是否可维护自定义角色 | -| 允许客户自维护组织 | Switch | 人工选择 | 控制客户管理员是否可维护组织 | - -页面规则: - -- 所属客户必填。 -- 手机号唯一策略变更时,需要提示对新增用户和账号校验的影响。 -- 客户级配置仅影响当前客户。 - -### 5.8.7.6 应用级接入配置页 - -应用级接入配置页用于维护业务应用接入基础平台后的通用访问控制参数。 - -展示方式: - -- 顶部为应用选择器。 -- 下方为分组表单。 -- 产品管理员进入时默认展示其负责应用范围。 - -表单字段: - -| 字段 | 控件类型 | 值来源 / 录入方式 | 说明 | -| --- | --- | --- | --- | -| 所属应用 | 应用选择器 / 只读文本 | 应用管理中已启用应用 | 必填 | -| 应用启用开关 | Switch | 人工选择 | 控制应用是否允许被访问 | -| 应用默认打开方式 | 单选框 | iframe 嵌入、外部跳转 | 1.0 默认 iframe 嵌入 | -| 应用菜单缓存时长 | 数字输入框 + 单位选择 | 人工录入 | 可为空 | -| 应用权限刷新策略 | 下拉框 | 每次获取、定时刷新、重新登录刷新 | 必填 | -| 应用 Token 校验策略 | 下拉框 | 每次访问校验、关键访问校验 | 必填 | - -页面规则: - -- 所属应用必填。 -- 应用启用开关关闭后,所有客户用户不可访问该应用。 -- 应用默认打开方式需与应用管理中的应用入口类型保持一致。 - -### 5.8.7.7 消息与通知配置页 - -消息与通知配置页用于维护基础平台消息、待办和通知提醒参数。 - -展示方式: - -- 采用分组表单展示。 -- 分组包括:系统消息、待办提醒、消息保留。 - -表单字段: - -| 字段 | 控件类型 | 值来源 / 录入方式 | 说明 | -| --- | --- | --- | --- | -| 系统消息开关 | Switch | 人工选择 | 控制系统消息能力 | -| 待办提醒开关 | Switch | 人工选择 | 控制待办提醒能力 | -| 消息保留天数 | 数字输入框 | 人工录入 | 必填 | -| 未读消息提醒间隔 | 数字输入框 + 单位选择 | 人工录入 | 可为空 | - -页面规则: - -- 消息保留天数必须大于 0。 -- 关闭系统消息开关时,需要提示消息提醒不可用。 - -### 5.8.7.8 审计与日志配置页 - -审计与日志配置页用于维护操作日志、登录日志和敏感操作控制参数。 - -展示方式: - -- 采用分组表单展示。 -- 分组包括:日志保留、敏感操作、字段脱敏。 - -表单字段: - -| 字段 | 控件类型 | 值来源 / 录入方式 | 说明 | -| --- | --- | --- | --- | -| 操作日志保留天数 | 数字输入框 | 人工录入 | 必填 | -| 登录日志保留天数 | 数字输入框 | 人工录入 | 必填 | -| 敏感操作二次确认 | Switch | 人工选择 | 默认开启 | -| 敏感字段脱敏开关 | Switch | 人工选择 | 默认开启 | -| 脱敏字段范围 | Checkbox 组 | 手机号、登录标识、客户联系人、备注 | 脱敏开启时展示 | - -页面规则: - -- 日志保留天数必须大于 0。 -- 关闭敏感操作二次确认或敏感字段脱敏时,需要二次确认。 - -### 5.8.7.9 基础开关配置页 - -基础开关配置页用于维护基础平台自身功能模块的启停开关。 - -展示方式: - -- 采用开关列表展示。 -- 每个开关一行,展示功能名称、编码、状态、说明和操作。 - -列表字段: - -| 字段 | 说明 | -| --- | --- | -| 功能名称 | 开关控制的功能模块名称 | -| 功能编码 | 开关编码 | -| 启用状态 | 启用、停用 | -| 影响范围 | 该开关影响的菜单或能力 | -| 备注 | 开关说明 | -| 操作 | 启用、停用、查看版本 | - -页面规则: - -- 停用客户管理、应用管理、组织管理、角色管理等核心开关时,需要二次确认。 -- 停用功能后,对应菜单不可见,对应操作不可用。 -- 开关变更需要生成配置版本并记录操作日志。 - -### 5.8.7.10 配置项管理页 - -配置项管理页用于维护底层配置项定义和少量结构化配置,是场景化配置页面之外的兜底管理能力。 - -展示方式: - -- 查询区域 + 数据表格。 -- 新增 / 编辑采用抽屉表单。 -- 抽屉包含基础信息和配置值编辑区。 -- 抽屉底部固定操作按钮:取消、保存。 - -适用场景: - -- 新增尚未纳入场景化页面的配置项。 -- 查看配置编码、版本、状态、配置值预览。 -- 维护少量结构化 JSON 配置。 -- 查看版本记录并回滚。 - -查询条件: - -| 查询项 | 控件类型 | 值来源 / 录入方式 | 说明 | -| --- | --- | --- | --- | -| 配置名称 | 文本输入框 | 人工录入 | 支持模糊查询 | -| 配置编码 | 文本输入框 | 人工录入 | 支持精确或模糊查询 | -| 配置分类 | 下拉框 | 配置分类字典 | 可为空 | -| 配置层级 | 下拉框 | 平台级、客户级、应用级 | 可为空 | -| 所属客户 | 客户选择器 | 客户管理中已启用客户 | 客户级配置使用 | -| 所属应用 | 应用选择器 | 应用管理中已启用应用 | 应用级配置使用 | -| 启用状态 | 下拉框 | 全部、启用、停用 | 默认全部 | -| 查询 | 按钮 | 用户点击 | 作为查询区域最后一个表单元素 | - -列表字段: - -| 字段 | 说明 | -| --- | --- | -| 配置名称 | 配置项展示名称 | -| 配置编码 | 配置项唯一编码 | -| 配置分类 | 配置所属分类 | -| 配置层级 | 平台级、客户级、应用级 | -| 版本 | 当前版本号 | -| 启用状态 | 启用、停用 | -| 配置值预览 | 配置值摘要展示 | -| 操作 | 查看、编辑、启用、停用、版本记录 | - -抽屉基础信息字段: - -| 字段 | 控件类型 | 值来源 / 录入方式 | 说明 | -| --- | --- | --- | --- | -| 配置名称 | 文本输入框 | 人工录入 | 必填 | -| 配置编码 | 文本输入框 | 人工录入 | 必填,编辑时只读 | -| 配置分类 | 下拉框 | 配置分类字典 | 必填 | -| 配置层级 | 下拉框 | 平台级、客户级、应用级 | 必填 | -| 所属客户 | 客户选择器 | 客户管理中已启用客户 | 客户级配置必填 | -| 所属应用 | 应用选择器 | 应用管理中已启用应用 | 应用级配置必填 | -| 配置值类型 | 下拉框 | JSON、文本、数字、布尔、枚举 | 必填 | -| 启用状态 | Switch | 人工选择 | 默认启用 | -| 版本 | 只读文本 | 当前配置版本 | 系统自动带入 | -| 备注 | 多行文本框 | 人工录入 | 选填 | - -配置值编辑区: - -- JSON 类型支持 JSON 编辑器。 -- 简单配置支持键值对模式。 -- 保存前需要完成配置值格式校验。 -- 配置值较长时,列表页只展示配置值预览,详情页展示完整配置值。 - -### 5.8.7.11 配置版本记录页 / 弹窗 - -版本记录用于查看配置历史版本和执行回滚。 - -展示方式: - -- 数据表格。 -- 回滚操作需要二次确认。 - -列表字段: - -| 字段 | 说明 | -| --- | --- | -| 版本号 | 配置历史版本 | -| 配置值预览 | 该版本配置值摘要 | -| 变更人 | 执行变更的用户 | -| 变更时间 | 配置变更时间 | -| 变更说明 | 变更原因或备注 | -| 操作 | 查看、回滚 | - -页面规则: - -- 只能回滚到历史有效版本。 -- 回滚不会删除历史版本。 -- 回滚后生成新的版本号。 -- 回滚需要记录操作日志。 - ## 5.8.8 使用导航 ### 5.8.8.1 维护场景化配置 @@ -589,7 +176,7 @@ 操作步骤: 1. 进入基础配置管理。 -2. 选择平台运行配置、登录与安全配置、门户与应用容器配置、客户级配置、应用级接入配置、消息与通知配置、审计与日志配置或基础开关配置。 +2. 选择平台运行配置、登录与安全配置、门户与应用容器配置、客户级配置、应用级接入配置、消息与通知配置、对象存储配置、短信发送配置、审计与日志配置或基础开关配置。 3. 按页面表单维护对应配置。 4. 点击保存。 5. 系统校验配置值、版本号和权限范围。 @@ -687,7 +274,14 @@ ## 5.8.9 验收标准 - 基础配置管理按配置场景拆分页面展示。 -- 可维护平台运行配置、登录与安全配置、门户与应用容器配置、客户级配置、应用级接入配置、消息与通知配置、审计与日志配置、基础开关配置。 +- 可维护平台运行配置、登录与安全配置、门户与应用容器配置、客户级配置、应用级接入配置、消息与通知配置、对象存储配置、短信发送配置、审计与日志配置、基础开关配置。 +- 对象存储配置支持阿里云 OSS、腾讯云 COS、华为云 COS/OBS、MinIO、RustFS。 +- 对象存储启用前必须完成连接测试。 +- 对象存储 SecretKey 等敏感字段不得明文回显。 +- 短信发送配置支持阿里云、腾讯云、华为云。 +- 短信发送配置支持按模板场景维护短信模板。 +- 同一短信模板场景同一时间只能启用一个模板。 +- 短信发送 SecretKey、验证码等敏感信息不得写入操作日志。 - 场景化配置页面采用业务化表单,不要求用户直接编辑 JSON。 - 配置项管理可查询平台级、客户级、应用级配置。 - 配置项管理可新增、编辑、启用、停用配置。 diff --git a/40-平台与架构/基础平台/功能模块/10-操作日志.md b/40-平台与架构/基础平台/功能模块/10-操作日志.md index f0af8dd..65d9c19 100644 --- a/40-平台与架构/基础平台/功能模块/10-操作日志.md +++ b/40-平台与架构/基础平台/功能模块/10-操作日志.md @@ -122,13 +122,15 @@ | 操作类型 | 触发场景 | 是否必须 | | --- | --- | --- | -| 场景化配置变更 | 修改平台运行、登录安全、门户容器、客户级、应用级等配置 | 是 | +| 场景化配置变更 | 修改平台运行、登录安全、门户容器、客户级、应用级、对象存储、短信发送等配置 | 是 | | 新增配置项 | 在配置项管理中新建配置项 | 是 | | 编辑配置项 | 修改配置项基础信息或配置值 | 是 | | 启用 / 停用配置项 | 配置项启用或停用 | 是 | | 配置版本回滚 | 回滚到历史配置版本 | 是 | | 基础开关变更 | 启用或停用基础平台功能开关 | 是 | +说明:对象存储和短信发送配置涉及 AccessKey、SecretKey、验证码等敏感信息,操作日志只能记录配置项名称、服务商、变更类型、启停状态和脱敏摘要,不得记录密钥、验证码、Token 等明文内容。 + ### 5.10.3.8 消息与待办类 以下消息与待办操作必须记录: diff --git a/40-平台与架构/基础平台/功能模块/基础配置/01-平台运行配置.md b/40-平台与架构/基础平台/功能模块/基础配置/01-平台运行配置.md new file mode 100644 index 0000000..9195b46 --- /dev/null +++ b/40-平台与架构/基础平台/功能模块/基础配置/01-平台运行配置.md @@ -0,0 +1,52 @@ +# 平台运行配置 + +本文档为《基础配置管理》下的独立配置页面设计,用于描述该配置项目的配置清单、界面设计、业务规则和验收关注点。 + +上级文档:[基础配置管理](../08-基础配置管理.md) + +## 配置清单 + +平台运行配置用于维护基础平台自身运行参数,由平台管理员维护。 + +推荐配置: + +| 配置名称 | 配置说明 | 配置层级 | 1.0 建议 | +| --- | --- | --- | --- | +| 平台名称 | 门户头部展示的平台名称 | 平台级 | 必须 | +| 平台 Logo | 门户头部展示的 Logo 地址或资源标识 | 平台级 | 必须 | +| 默认语言 | 用户未设置语言时的默认语言 | 平台级 | 必须 | +| 默认主题 | 用户未设置主题时的默认主题 | 平台级 | 必须 | +| 默认分页条数 | 列表页默认分页大小 | 平台级 | 必须 | +| 文件上传大小限制 | 基础平台通用上传文件大小限制 | 平台级 | 建议 | +| 导出文件有效期 | 导出文件可下载的有效时间 | 平台级 | 建议 | +| 系统维护公告 | 平台维护、升级、停机提示内容 | 平台级 | 建议 | + +## 界面设计 + +平台运行配置页用于维护平台展示和通用运行参数。 + +展示方式: + +- 采用分组表单展示。 +- 分组包括:平台展示、通用列表、文件与导出、系统公告。 +- 页面底部固定操作按钮:取消、保存。 + +表单字段: + +| 字段 | 控件类型 | 值来源 / 录入方式 | 说明 | +| --- | --- | --- | --- | +| 平台名称 | 文本输入框 | 人工录入 | 门户头部展示名称 | +| 平台 Logo | 图片上传 / 资源选择器 | 上传或选择平台资源 | 门户头部展示 Logo | +| 默认语言 | 下拉框 | 语言字典 | 用户未设置语言时使用 | +| 默认主题 | 下拉框 | 主题字典 | 用户未设置主题时使用 | +| 默认分页条数 | 数字输入框 | 人工录入 | 列表页默认分页大小 | +| 文件上传大小限制 | 数字输入框 + 单位选择 | 人工录入 | 通用上传限制 | +| 导出文件有效期 | 数字输入框 + 单位选择 | 人工录入 | 导出文件可下载时长 | +| 系统维护公告 | 多行文本框 | 人工录入 | 可为空 | +| 启用状态 | Switch | 人工选择 | 控制该组配置是否启用 | + +页面规则: + +- 平台名称、默认语言、默认主题、默认分页条数为必填。 +- 保存后生成配置版本。 +- 修改平台展示类配置后,用户刷新门户时生效。 diff --git a/40-平台与架构/基础平台/功能模块/基础配置/02-登录与安全配置.md b/40-平台与架构/基础平台/功能模块/基础配置/02-登录与安全配置.md new file mode 100644 index 0000000..924755a --- /dev/null +++ b/40-平台与架构/基础平台/功能模块/基础配置/02-登录与安全配置.md @@ -0,0 +1,55 @@ +# 登录与安全配置 + +本文档为《基础配置管理》下的独立配置页面设计,用于描述该配置项目的配置清单、界面设计、业务规则和验收关注点。 + +上级文档:[基础配置管理](../08-基础配置管理.md) + +## 配置清单 + +登录与安全配置用于支撑统一登录、账号安全、Token 有效期和密码策略。 + +推荐配置: + +| 配置名称 | 配置说明 | 配置层级 | 1.0 建议 | +| --- | --- | --- | --- | +| Token 有效期 | 用户登录后 Token 的有效时间 | 平台级 | 必须 | +| Token 刷新有效期 | Token 可被刷新的最大时间范围 | 平台级 | 必须 | +| 登录失败锁定次数 | 连续登录失败达到次数后锁定账号 | 平台级 | 必须 | +| 登录失败锁定时长 | 账号被锁定后的自动解锁时长 | 平台级 | 必须 | +| 初始密码生成规则 | 系统生成初始密码的规则 | 平台级 | 必须 | +| 密码复杂度规则 | 密码长度、字符类型等要求 | 平台级 | 必须 | +| 首次登录修改密码 | 新建平台账号首次登录是否强制改密 | 平台级 / 客户级 | 必须 | +| 密码有效期 | 密码到期后是否要求修改 | 平台级 / 客户级 | 建议 | +| 第三方账号绑定开关 | 是否允许绑定微信、企微、钉钉、飞书等第三方账号 | 平台级 / 客户级 | 建议 | + +## 界面设计 + +登录与安全配置页用于维护统一登录、Token、账号密码和第三方账号绑定相关参数。 + +展示方式: + +- 采用分组表单展示。 +- 分组包括:Token 策略、登录失败策略、密码策略、第三方账号策略。 +- 页面底部固定操作按钮:取消、保存。 + +表单字段: + +| 字段 | 控件类型 | 值来源 / 录入方式 | 说明 | +| --- | --- | --- | --- | +| Token 有效期 | 数字输入框 + 单位选择 | 人工录入 | 必填 | +| Token 刷新有效期 | 数字输入框 + 单位选择 | 人工录入 | 必填 | +| 登录失败锁定次数 | 数字输入框 | 人工录入 | 必填 | +| 登录失败锁定时长 | 数字输入框 + 单位选择 | 人工录入 | 必填 | +| 初始密码生成规则 | 下拉框 / 表单组合 | 平台预置规则 | 必填 | +| 密码最小长度 | 数字输入框 | 人工录入 | 必填 | +| 密码复杂度要求 | Checkbox 组 | 大写字母、小写字母、数字、特殊字符 | 必填 | +| 首次登录修改密码 | Switch | 人工选择 | 默认开启 | +| 密码有效期 | 数字输入框 + 单位选择 | 人工录入 | 可为空 | +| 允许第三方账号绑定 | Switch | 人工选择 | 控制微信、企微、钉钉、飞书绑定能力 | + +页面规则: + +- Token 刷新有效期应大于 Token 有效期。 +- 登录失败锁定次数必须大于 0。 +- 密码复杂度保存前需要校验规则完整性。 +- 影响登录安全的配置保存时需要二次确认。 diff --git a/40-平台与架构/基础平台/功能模块/基础配置/03-门户与应用容器配置.md b/40-平台与架构/基础平台/功能模块/基础配置/03-门户与应用容器配置.md new file mode 100644 index 0000000..98caccc --- /dev/null +++ b/40-平台与架构/基础平台/功能模块/基础配置/03-门户与应用容器配置.md @@ -0,0 +1,46 @@ +# 门户与应用容器配置 + +本文档为《基础配置管理》下的独立配置页面设计,用于描述该配置项目的配置清单、界面设计、业务规则和验收关注点。 + +上级文档:[基础配置管理](../08-基础配置管理.md) + +## 配置清单 + +门户与应用容器配置用于支撑统一门户、菜单聚合、Tab 和 iframe 应用容器。 + +推荐配置: + +| 配置名称 | 配置说明 | 配置层级 | 1.0 建议 | +| --- | --- | --- | --- | +| 默认首页 | 用户登录后默认打开的页面 | 平台级 / 客户级 | 必须 | +| 常用菜单数量 | 头部常用菜单最多展示数量 | 平台级 | 建议 | +| 最大打开 Tab 数 | 用户最多可同时打开的页面 Tab 数 | 平台级 | 必须 | +| iframe Token 同步开关 | 是否向 iframe 应用同步 Token 状态 | 平台级 | 必须 | +| iframe 页面超时处理 | iframe 应用无响应或 Token 失效时的处理方式 | 平台级 | 建议 | +| 菜单折叠默认状态 | 左侧菜单默认展开或折叠 | 平台级 / 用户级 | 建议 | + +## 界面设计 + +门户与应用容器配置页用于维护统一门户、Tab、菜单和 iframe 容器参数。 + +展示方式: + +- 采用分组表单展示。 +- 分组包括:首页与菜单、Tab 管理、iframe 容器。 + +表单字段: + +| 字段 | 控件类型 | 值来源 / 录入方式 | 说明 | +| --- | --- | --- | --- | +| 默认首页 | 页面选择器 / 菜单选择器 | 基础平台页面或已启用菜单 | 用户登录后默认打开页面 | +| 常用菜单数量 | 数字输入框 | 人工录入 | 头部常用菜单最多展示数量 | +| 最大打开 Tab 数 | 数字输入框 | 人工录入 | 必填 | +| 菜单折叠默认状态 | 单选框 | 展开、折叠 | 默认展开 | +| iframe Token 同步开关 | Switch | 人工选择 | 必须开启 | +| iframe 页面超时处理 | 下拉框 | 提示重试、关闭页签、跳转错误页 | 必填 | + +页面规则: + +- 最大打开 Tab 数必须大于 0。 +- iframe Token 同步开关关闭时,需要提示会影响业务应用访问。 +- 默认首页必须是用户有权限访问的页面或菜单。 diff --git a/40-平台与架构/基础平台/功能模块/基础配置/04-客户级配置.md b/40-平台与架构/基础平台/功能模块/基础配置/04-客户级配置.md new file mode 100644 index 0000000..2e8ba74 --- /dev/null +++ b/40-平台与架构/基础平台/功能模块/基础配置/04-客户级配置.md @@ -0,0 +1,51 @@ +# 客户级配置 + +本文档为《基础配置管理》下的独立配置页面设计,用于描述该配置项目的配置清单、界面设计、业务规则和验收关注点。 + +上级文档:[基础配置管理](../08-基础配置管理.md) + +## 配置清单 + +客户级基础配置用于支持不同客户在基础平台中的差异化设置。 + +推荐配置: + +| 配置名称 | 配置说明 | 配置层级 | 1.0 建议 | +| --- | --- | --- | --- | +| 客户显示名称 | 门户展示的客户名称或简称 | 客户级 | 必须 | +| 客户默认行业 | 客户所属行业默认值 | 客户级 | 必须 | +| 客户默认语言 | 当前客户用户默认语言 | 客户级 | 建议 | +| 客户默认主题 | 当前客户用户默认主题 | 客户级 | 建议 | +| 手机号唯一策略 | 手机号在客户内唯一或平台内唯一 | 客户级 | 必须 | +| 是否允许多组织归属 | 用户是否允许归属于多个组织 | 客户级 | 必须 | +| 是否允许客户自维护角色 | 客户管理员是否可新增和编辑自定义角色 | 客户级 | 必须 | +| 是否允许客户自维护组织 | 客户管理员是否可维护组织架构 | 客户级 | 建议 | + +## 界面设计 + +客户级配置页用于维护某个客户在基础平台中的差异化设置。 + +展示方式: + +- 顶部为客户选择器。 +- 下方为分组表单。 +- 客户管理员进入时默认当前客户,不展示客户选择器。 + +表单字段: + +| 字段 | 控件类型 | 值来源 / 录入方式 | 说明 | +| --- | --- | --- | --- | +| 所属客户 | 客户选择器 / 只读文本 | 客户管理中已启用客户 | 平台用户选择;客户管理员只读当前客户 | +| 客户显示名称 | 文本输入框 | 默认取客户简称 | 可覆盖门户展示名称 | +| 客户默认语言 | 下拉框 | 语言字典 | 可为空,空则使用平台默认语言 | +| 客户默认主题 | 下拉框 | 主题字典 | 可为空,空则使用平台默认主题 | +| 手机号唯一策略 | 单选框 | 客户内唯一、平台内唯一 | 1.0 默认客户内唯一 | +| 允许多组织归属 | Switch | 人工选择 | 控制用户是否可归属多个组织 | +| 允许客户自维护角色 | Switch | 人工选择 | 控制客户管理员是否可维护自定义角色 | +| 允许客户自维护组织 | Switch | 人工选择 | 控制客户管理员是否可维护组织 | + +页面规则: + +- 所属客户必填。 +- 手机号唯一策略变更时,需要提示对新增用户和账号校验的影响。 +- 客户级配置仅影响当前客户。 diff --git a/40-平台与架构/基础平台/功能模块/基础配置/05-应用级接入配置.md b/40-平台与架构/基础平台/功能模块/基础配置/05-应用级接入配置.md new file mode 100644 index 0000000..4eb9283 --- /dev/null +++ b/40-平台与架构/基础平台/功能模块/基础配置/05-应用级接入配置.md @@ -0,0 +1,46 @@ +# 应用级接入配置 + +本文档为《基础配置管理》下的独立配置页面设计,用于描述该配置项目的配置清单、界面设计、业务规则和验收关注点。 + +上级文档:[基础配置管理](../08-基础配置管理.md) + +## 配置清单 + +应用级接入配置用于支撑业务应用接入基础平台后的通用控制。 + +推荐配置: + +| 配置名称 | 配置说明 | 配置层级 | 1.0 建议 | +| --- | --- | --- | --- | +| 应用启用开关 | 应用是否允许被访问 | 应用级 | 必须 | +| 应用默认打开方式 | iframe 嵌入或外部跳转 | 应用级 | 必须 | +| 应用菜单缓存时长 | 应用菜单授权结果缓存时间 | 应用级 | 建议 | +| 应用权限刷新策略 | 权限变更后应用获取最新权限的策略 | 应用级 | 建议 | +| 应用 Token 校验策略 | 应用访问时是否每次校验 Token | 应用级 | 必须 | + +## 界面设计 + +应用级接入配置页用于维护业务应用接入基础平台后的通用访问控制参数。 + +展示方式: + +- 顶部为应用选择器。 +- 下方为分组表单。 +- 产品管理员进入时默认展示其负责应用范围。 + +表单字段: + +| 字段 | 控件类型 | 值来源 / 录入方式 | 说明 | +| --- | --- | --- | --- | +| 所属应用 | 应用选择器 / 只读文本 | 应用管理中已启用应用 | 必填 | +| 应用启用开关 | Switch | 人工选择 | 控制应用是否允许被访问 | +| 应用默认打开方式 | 单选框 | iframe 嵌入、外部跳转 | 1.0 默认 iframe 嵌入 | +| 应用菜单缓存时长 | 数字输入框 + 单位选择 | 人工录入 | 可为空 | +| 应用权限刷新策略 | 下拉框 | 每次获取、定时刷新、重新登录刷新 | 必填 | +| 应用 Token 校验策略 | 下拉框 | 每次访问校验、关键访问校验 | 必填 | + +页面规则: + +- 所属应用必填。 +- 应用启用开关关闭后,所有客户用户不可访问该应用。 +- 应用默认打开方式需与应用管理中的应用入口类型保持一致。 diff --git a/40-平台与架构/基础平台/功能模块/基础配置/06-消息与通知配置.md b/40-平台与架构/基础平台/功能模块/基础配置/06-消息与通知配置.md new file mode 100644 index 0000000..6e522ae --- /dev/null +++ b/40-平台与架构/基础平台/功能模块/基础配置/06-消息与通知配置.md @@ -0,0 +1,41 @@ +# 消息与通知配置 + +本文档为《基础配置管理》下的独立配置页面设计,用于描述该配置项目的配置清单、界面设计、业务规则和验收关注点。 + +上级文档:[基础配置管理](../08-基础配置管理.md) + +## 配置清单 + +消息与通知配置用于支撑基础平台消息、待办和系统通知。 + +推荐配置: + +| 配置名称 | 配置说明 | 配置层级 | 1.0 建议 | +| --- | --- | --- | --- | +| 系统消息开关 | 是否启用基础平台系统消息 | 平台级 | 建议 | +| 待办提醒开关 | 是否启用待办提醒 | 平台级 / 客户级 | 建议 | +| 消息保留天数 | 系统消息保留时长 | 平台级 | 建议 | +| 未读消息提醒间隔 | 门户轮询或刷新未读消息的间隔 | 平台级 | 可延后 | + +## 界面设计 + +消息与通知配置页用于维护基础平台消息、待办和通知提醒参数。 + +展示方式: + +- 采用分组表单展示。 +- 分组包括:系统消息、待办提醒、消息保留。 + +表单字段: + +| 字段 | 控件类型 | 值来源 / 录入方式 | 说明 | +| --- | --- | --- | --- | +| 系统消息开关 | Switch | 人工选择 | 控制系统消息能力 | +| 待办提醒开关 | Switch | 人工选择 | 控制待办提醒能力 | +| 消息保留天数 | 数字输入框 | 人工录入 | 必填 | +| 未读消息提醒间隔 | 数字输入框 + 单位选择 | 人工录入 | 可为空 | + +页面规则: + +- 消息保留天数必须大于 0。 +- 关闭系统消息开关时,需要提示消息提醒不可用。 diff --git a/40-平台与架构/基础平台/功能模块/基础配置/07-对象存储配置.md b/40-平台与架构/基础平台/功能模块/基础配置/07-对象存储配置.md new file mode 100644 index 0000000..9780017 --- /dev/null +++ b/40-平台与架构/基础平台/功能模块/基础配置/07-对象存储配置.md @@ -0,0 +1,69 @@ +# 对象存储配置 + +本文档为《基础配置管理》下的独立配置页面设计,用于描述该配置项目的配置清单、界面设计、业务规则和验收关注点。 + +上级文档:[基础配置管理](../08-基础配置管理.md) + +## 配置清单 + +对象存储配置用于维护基础平台文件上传、导出文件、图片资源、附件等通用文件存储服务。 + +推荐配置: + +| 配置名称 | 配置说明 | 配置层级 | 1.0 建议 | +| --- | --- | --- | --- | +| 对象存储启用开关 | 是否启用对象存储能力 | 平台级 | 必须 | +| 存储服务商 | 当前使用的对象存储服务商 | 平台级 | 必须 | +| 访问地址 | 对象存储 Endpoint 或服务地址 | 平台级 | 必须 | +| 存储桶名称 | 文件存储使用的 Bucket | 平台级 | 必须 | +| 访问凭证 | AccessKey、SecretKey 等连接凭证 | 平台级 | 必须 | +| 默认访问域名 | 文件访问使用的默认域名 | 平台级 | 建议 | +| 文件路径前缀 | 基础平台文件存储路径前缀 | 平台级 | 建议 | +| 公有读开关 | 是否允许文件公开访问 | 平台级 | 建议 | +| 配置连通性测试 | 保存前或保存后测试对象存储是否可用 | 平台级 | 必须 | + +支持的对象存储服务商: + +| 服务商 | 说明 | +| --- | --- | +| 阿里云 OSS | 阿里云对象存储 | +| 腾讯云 COS | 腾讯云对象存储 | +| 华为云 COS/OBS | 华为云对象存储,实际产品命名以云厂商接口为准 | +| MinIO | 私有化对象存储 | +| RustFS | 私有化对象存储 | + +## 界面设计 + +对象存储配置页用于维护基础平台通用文件存储服务参数。 + +展示方式: + +- 采用分组表单展示。 +- 分组包括:服务商配置、连接参数、访问控制、连通性测试。 +- 页面底部固定操作按钮:取消、保存、测试连接。 + +表单字段: + +| 字段 | 控件类型 | 值来源 / 录入方式 | 说明 | +| --- | --- | --- | --- | +| 对象存储启用开关 | Switch | 人工选择 | 控制对象存储能力是否启用 | +| 存储服务商 | 下拉框 | 阿里云 OSS、腾讯云 COS、华为云 COS/OBS、MinIO、RustFS | 必填 | +| Endpoint / 服务地址 | 文本输入框 | 人工录入 | 必填 | +| Region | 文本输入框 / 下拉框 | 服务商区域或人工录入 | 公有云建议填写 | +| Bucket | 文本输入框 | 人工录入 | 必填 | +| AccessKey | 文本输入框 | 人工录入 | 必填,敏感字段 | +| SecretKey | 密码输入框 | 人工录入 | 必填,敏感字段 | +| 默认访问域名 | 文本输入框 | 人工录入 | 选填 | +| 文件路径前缀 | 文本输入框 | 人工录入 | 选填 | +| 公有读开关 | Switch | 人工选择 | 控制上传文件是否允许公开访问 | +| HTTPS 访问开关 | Switch | 人工选择 | 控制文件访问地址是否默认使用 HTTPS | +| 备注 | 多行文本框 | 人工录入 | 选填 | + +页面规则: + +- 存储服务商、Endpoint / 服务地址、Bucket、AccessKey、SecretKey 为必填。 +- SecretKey 保存后不在页面明文回显,仅展示脱敏结果。 +- 切换存储服务商时,需要提示不同服务商参数可能不兼容。 +- 保存前建议先执行测试连接;测试失败时允许保存草稿但不允许启用。 +- 启用对象存储配置前,必须通过连接测试。 +- 停用对象存储配置时,需要提示文件上传、导出文件、图片资源等能力可能不可用。 diff --git a/40-平台与架构/基础平台/功能模块/基础配置/08-短信发送配置.md b/40-平台与架构/基础平台/功能模块/基础配置/08-短信发送配置.md new file mode 100644 index 0000000..64b7b1d --- /dev/null +++ b/40-平台与架构/基础平台/功能模块/基础配置/08-短信发送配置.md @@ -0,0 +1,95 @@ +# 短信发送配置 + +本文档为《基础配置管理》下的独立配置页面设计,用于描述该配置项目的配置清单、界面设计、业务规则和验收关注点。 + +上级文档:[基础配置管理](../08-基础配置管理.md) + +## 配置清单 + +短信发送配置用于维护基础平台登录验证、账号通知、安全提醒等短信发送能力。 + +推荐配置: + +| 配置名称 | 配置说明 | 配置层级 | 1.0 建议 | +| --- | --- | --- | --- | +| 短信启用开关 | 是否启用短信发送能力 | 平台级 | 必须 | +| 短信服务商 | 当前使用的短信服务商 | 平台级 | 必须 | +| 访问凭证 | AccessKey、SecretKey 等调用凭证 | 平台级 | 必须 | +| 短信签名 | 短信服务商审核通过的签名 | 平台级 | 必须 | +| 默认区域 | 短信服务区域或 Region | 平台级 | 建议 | +| 发送频控 | 单手机号、单账号或单 IP 的发送频率限制 | 平台级 | 必须 | +| 短信模板 | 不同短信场景对应的模板编码和模板参数 | 平台级 | 必须 | +| 配置连通性测试 | 保存前或保存后测试短信服务是否可用 | 平台级 | 建议 | + +支持的短信服务商: + +| 服务商 | 说明 | +| --- | --- | +| 阿里云 | 阿里云短信服务 | +| 腾讯云 | 腾讯云短信服务 | +| 华为云 | 华为云短信服务 | + +首版建议支持的短信模板场景: + +| 模板场景 | 说明 | +| --- | --- | +| 登录验证码 | 用户短信验证码登录或二次验证 | +| 绑定手机号验证码 | 用户绑定或更换手机号 | +| 重置密码验证码 | 用户重置平台账号密码 | +| 账号开通通知 | 创建用户或账号后发送通知 | +| 安全提醒 | 异地登录、密码变更等安全提醒 | + +## 界面设计 + +短信发送配置页用于维护短信服务商、短信签名、发送频控和短信模板。 + +展示方式: + +- 采用上下结构展示。 +- 上方为短信服务商配置表单。 +- 下方为短信模板配置页签 / 表格。 +- 页面底部固定操作按钮:取消、保存、测试发送。 + +表单字段: + +| 字段 | 控件类型 | 值来源 / 录入方式 | 说明 | +| --- | --- | --- | --- | +| 短信启用开关 | Switch | 人工选择 | 控制短信发送能力是否启用 | +| 短信服务商 | 下拉框 | 阿里云、腾讯云、华为云 | 必填 | +| Region | 文本输入框 / 下拉框 | 服务商区域或人工录入 | 建议填写 | +| AccessKey | 文本输入框 | 人工录入 | 必填,敏感字段 | +| SecretKey | 密码输入框 | 人工录入 | 必填,敏感字段 | +| 短信签名 | 文本输入框 | 人工录入 | 必填 | +| 单手机号发送间隔 | 数字输入框 + 单位选择 | 人工录入 | 建议配置 | +| 单手机号日发送上限 | 数字输入框 | 人工录入 | 建议配置 | +| 单 IP 日发送上限 | 数字输入框 | 人工录入 | 可选 | +| 备注 | 多行文本框 | 人工录入 | 选填 | + +短信模板配置展示方式: + +- 表格。 +- 支持新增、编辑、启用、停用、删除模板。 +- 新增 / 编辑模板采用弹窗表单。 + +短信模板字段: + +| 字段 | 控件类型 | 值来源 / 录入方式 | 说明 | +| --- | --- | --- | --- | +| 模板场景 | 下拉框 | 登录验证码、绑定手机号验证码、重置密码验证码、账号开通通知、安全提醒 | 必填 | +| 模板名称 | 文本输入框 | 人工录入 | 必填 | +| 服务商模板编号 | 文本输入框 | 人工录入 | 必填,服务商审核通过的模板编号 | +| 模板内容预览 | 多行文本框 | 人工录入 / 服务商模板内容复制 | 选填,仅用于查看 | +| 模板参数 | 标签输入 / 表格 | 人工录入 | 例如 code、userName、expireMinutes | +| 启用状态 | Switch | 人工选择 | 默认启用 | +| 备注 | 多行文本框 | 人工录入 | 选填 | + +页面规则: + +- 短信服务商、AccessKey、SecretKey、短信签名为必填。 +- SecretKey 保存后不在页面明文回显,仅展示脱敏结果。 +- 每个模板场景同一时间只能启用一个模板。 +- 启用短信发送配置前,至少需要维护一个启用短信模板。 +- 登录验证码、绑定手机号验证码、重置密码验证码属于验证码类模板,必须配置发送频控。 +- 测试发送需要输入测试手机号和模板场景。 +- 测试发送必须记录操作日志,但日志中不得记录验证码、SecretKey 等敏感内容。 +- 停用短信发送配置时,需要提示短信验证码登录、手机号绑定、密码重置等能力可能不可用。 diff --git a/40-平台与架构/基础平台/功能模块/基础配置/09-审计与日志配置.md b/40-平台与架构/基础平台/功能模块/基础配置/09-审计与日志配置.md new file mode 100644 index 0000000..010cd8b --- /dev/null +++ b/40-平台与架构/基础平台/功能模块/基础配置/09-审计与日志配置.md @@ -0,0 +1,42 @@ +# 审计与日志配置 + +本文档为《基础配置管理》下的独立配置页面设计,用于描述该配置项目的配置清单、界面设计、业务规则和验收关注点。 + +上级文档:[基础配置管理](../08-基础配置管理.md) + +## 配置清单 + +审计与日志配置用于支撑操作日志和安全审计。 + +推荐配置: + +| 配置名称 | 配置说明 | 配置层级 | 1.0 建议 | +| --- | --- | --- | --- | +| 操作日志保留天数 | 操作日志可查询和保留时间 | 平台级 | 必须 | +| 登录日志保留天数 | 登录日志可查询和保留时间 | 平台级 | 必须 | +| 敏感操作二次确认 | 停用客户、停用用户、重置密码等是否二次确认 | 平台级 | 必须 | +| 敏感字段脱敏开关 | 手机号、账号标识等字段是否脱敏展示 | 平台级 / 客户级 | 必须 | + +## 界面设计 + +审计与日志配置页用于维护操作日志、登录日志和敏感操作控制参数。 + +展示方式: + +- 采用分组表单展示。 +- 分组包括:日志保留、敏感操作、字段脱敏。 + +表单字段: + +| 字段 | 控件类型 | 值来源 / 录入方式 | 说明 | +| --- | --- | --- | --- | +| 操作日志保留天数 | 数字输入框 | 人工录入 | 必填 | +| 登录日志保留天数 | 数字输入框 | 人工录入 | 必填 | +| 敏感操作二次确认 | Switch | 人工选择 | 默认开启 | +| 敏感字段脱敏开关 | Switch | 人工选择 | 默认开启 | +| 脱敏字段范围 | Checkbox 组 | 手机号、登录标识、客户联系人、备注 | 脱敏开启时展示 | + +页面规则: + +- 日志保留天数必须大于 0。 +- 关闭敏感操作二次确认或敏感字段脱敏时,需要二次确认。 diff --git a/40-平台与架构/基础平台/功能模块/基础配置/10-基础开关配置.md b/40-平台与架构/基础平台/功能模块/基础配置/10-基础开关配置.md new file mode 100644 index 0000000..8be2020 --- /dev/null +++ b/40-平台与架构/基础平台/功能模块/基础配置/10-基础开关配置.md @@ -0,0 +1,46 @@ +# 基础开关配置 + +本文档为《基础配置管理》下的独立配置页面设计,用于描述该配置项目的配置清单、界面设计、业务规则和验收关注点。 + +上级文档:[基础配置管理](../08-基础配置管理.md) + +## 配置清单 + +基础业务开关用于控制基础平台自身功能是否启用。 + +推荐配置: + +| 配置名称 | 配置说明 | 配置层级 | 1.0 建议 | +| --- | --- | --- | --- | +| 是否启用客户管理 | 控制客户管理功能是否开放 | 平台级 | 必须 | +| 是否启用应用管理 | 控制应用管理功能是否开放 | 平台级 | 必须 | +| 是否启用组织管理 | 控制组织管理功能是否开放 | 平台级 | 必须 | +| 是否启用角色管理 | 控制角色管理功能是否开放 | 平台级 | 必须 | +| 是否启用第三方登录 | 控制第三方登录入口是否开放 | 平台级 | 可延后 | +| 是否启用外部协同接入 | 控制 2.0 外部协同能力是否开放 | 平台级 | 可延后 | + +## 界面设计 + +基础开关配置页用于维护基础平台自身功能模块的启停开关。 + +展示方式: + +- 采用开关列表展示。 +- 每个开关一行,展示功能名称、编码、状态、说明和操作。 + +列表字段: + +| 字段 | 说明 | +| --- | --- | +| 功能名称 | 开关控制的功能模块名称 | +| 功能编码 | 开关编码 | +| 启用状态 | 启用、停用 | +| 影响范围 | 该开关影响的菜单或能力 | +| 备注 | 开关说明 | +| 操作 | 启用、停用、查看版本 | + +页面规则: + +- 停用客户管理、应用管理、组织管理、角色管理等核心开关时,需要二次确认。 +- 停用功能后,对应菜单不可见,对应操作不可用。 +- 开关变更需要生成配置版本并记录操作日志。 diff --git a/40-平台与架构/基础平台/功能模块/基础配置/11-配置项管理.md b/40-平台与架构/基础平台/功能模块/基础配置/11-配置项管理.md new file mode 100644 index 0000000..0866fb1 --- /dev/null +++ b/40-平台与架构/基础平台/功能模块/基础配置/11-配置项管理.md @@ -0,0 +1,71 @@ +# 配置项管理 + +本文档为《基础配置管理》下的独立配置页面设计,用于描述该配置项目的配置清单、界面设计、业务规则和验收关注点。 + +上级文档:[基础配置管理](../08-基础配置管理.md) + +## 界面设计 + +配置项管理页用于维护底层配置项定义和少量结构化配置,是场景化配置页面之外的兜底管理能力。 + +展示方式: + +- 查询区域 + 数据表格。 +- 新增 / 编辑采用抽屉表单。 +- 抽屉包含基础信息和配置值编辑区。 +- 抽屉底部固定操作按钮:取消、保存。 + +适用场景: + +- 新增尚未纳入场景化页面的配置项。 +- 查看配置编码、版本、状态、配置值预览。 +- 维护少量结构化 JSON 配置。 +- 查看版本记录并回滚。 + +查询条件: + +| 查询项 | 控件类型 | 值来源 / 录入方式 | 说明 | +| --- | --- | --- | --- | +| 配置名称 | 文本输入框 | 人工录入 | 支持模糊查询 | +| 配置编码 | 文本输入框 | 人工录入 | 支持精确或模糊查询 | +| 配置分类 | 下拉框 | 配置分类字典 | 可为空 | +| 配置层级 | 下拉框 | 平台级、客户级、应用级 | 可为空 | +| 所属客户 | 客户选择器 | 客户管理中已启用客户 | 客户级配置使用 | +| 所属应用 | 应用选择器 | 应用管理中已启用应用 | 应用级配置使用 | +| 启用状态 | 下拉框 | 全部、启用、停用 | 默认全部 | +| 查询 | 按钮 | 用户点击 | 作为查询区域最后一个表单元素 | + +列表字段: + +| 字段 | 说明 | +| --- | --- | +| 配置名称 | 配置项展示名称 | +| 配置编码 | 配置项唯一编码 | +| 配置分类 | 配置所属分类 | +| 配置层级 | 平台级、客户级、应用级 | +| 版本 | 当前版本号 | +| 启用状态 | 启用、停用 | +| 配置值预览 | 配置值摘要展示 | +| 操作 | 查看、编辑、启用、停用、版本记录 | + +抽屉基础信息字段: + +| 字段 | 控件类型 | 值来源 / 录入方式 | 说明 | +| --- | --- | --- | --- | +| 配置名称 | 文本输入框 | 人工录入 | 必填 | +| 配置编码 | 文本输入框 | 人工录入 | 必填,编辑时只读 | +| 配置分类 | 下拉框 | 配置分类字典 | 必填 | +| 配置层级 | 下拉框 | 平台级、客户级、应用级 | 必填 | +| 所属客户 | 客户选择器 | 客户管理中已启用客户 | 客户级配置必填 | +| 所属应用 | 应用选择器 | 应用管理中已启用应用 | 应用级配置必填 | +| 配置值类型 | 下拉框 | JSON、文本、数字、布尔、枚举 | 必填 | +| 启用状态 | Switch | 人工选择 | 默认启用 | +| 版本 | 只读文本 | 当前配置版本 | 系统自动带入 | +| 备注 | 多行文本框 | 人工录入 | 选填 | + +配置值编辑区: + +- JSON 类型支持 JSON 编辑器。 +- 简单配置支持键值对模式。 +- 保存前需要完成配置值格式校验。 +- 配置值较长时,列表页只展示配置值预览,详情页展示完整配置值。 diff --git a/40-平台与架构/基础平台/功能模块/基础配置/12-配置版本记录.md b/40-平台与架构/基础平台/功能模块/基础配置/12-配置版本记录.md new file mode 100644 index 0000000..f14a58b --- /dev/null +++ b/40-平台与架构/基础平台/功能模块/基础配置/12-配置版本记录.md @@ -0,0 +1,32 @@ +# 配置版本记录 + +本文档为《基础配置管理》下的独立配置页面设计,用于描述该配置项目的配置清单、界面设计、业务规则和验收关注点。 + +上级文档:[基础配置管理](../08-基础配置管理.md) + +## 界面设计 + +版本记录用于查看配置历史版本和执行回滚。 + +展示方式: + +- 数据表格。 +- 回滚操作需要二次确认。 + +列表字段: + +| 字段 | 说明 | +| --- | --- | +| 版本号 | 配置历史版本 | +| 配置值预览 | 该版本配置值摘要 | +| 变更人 | 执行变更的用户 | +| 变更时间 | 配置变更时间 | +| 变更说明 | 变更原因或备注 | +| 操作 | 查看、回滚 | + +页面规则: + +- 只能回滚到历史有效版本。 +- 回滚不会删除历史版本。 +- 回滚后生成新的版本号。 +- 回滚需要记录操作日志。 diff --git a/40-平台与架构/基础平台/功能模块/基础配置/README.md b/40-平台与架构/基础平台/功能模块/基础配置/README.md new file mode 100644 index 0000000..2b299ae --- /dev/null +++ b/40-平台与架构/基础平台/功能模块/基础配置/README.md @@ -0,0 +1,18 @@ +# 基础配置 + +本目录用于承接《基础配置管理》中各配置项目的独立设计文档。每个配置项目独立成文档,便于研发拆分任务、测试编写用例、产品进行范围控制。 + +| 配置项目 | 文档 | +| --- | --- | +| 平台运行配置 | [01-平台运行配置](./01-平台运行配置.md) | +| 登录与安全配置 | [02-登录与安全配置](./02-登录与安全配置.md) | +| 门户与应用容器配置 | [03-门户与应用容器配置](./03-门户与应用容器配置.md) | +| 客户级配置 | [04-客户级配置](./04-客户级配置.md) | +| 应用级接入配置 | [05-应用级接入配置](./05-应用级接入配置.md) | +| 消息与通知配置 | [06-消息与通知配置](./06-消息与通知配置.md) | +| 对象存储配置 | [07-对象存储配置](./07-对象存储配置.md) | +| 短信发送配置 | [08-短信发送配置](./08-短信发送配置.md) | +| 审计与日志配置 | [09-审计与日志配置](./09-审计与日志配置.md) | +| 基础开关配置 | [10-基础开关配置](./10-基础开关配置.md) | +| 配置项管理 | [11-配置项管理](./11-配置项管理.md) | +| 配置版本记录 | [12-配置版本记录](./12-配置版本记录.md) |