kris/datai
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity
8287b5e2c2
datai/datai-scenes/datai-scene-salesforce/docs/requirements/REQ-009.md
Kris 469c78cf29 feat: REQ-010-1 完成数据库表结构设计和创建，REQ-010-2 完成基础实体类和Mapper创建需求定义和架构决策 
REQ-010-1 完成内容：
- 创建 6 个数据库表设计（datai_meta_org_config、datai_meta_task、datai_meta_job_execution、datai_meta_component、datai_meta_deploy_history、datai_meta_job_log）
- 设计了合理的索引策略
- 对敏感字段进行了加密存储设计
- 表名前缀统一为 datai_meta_
- 所有表包含标准基础字段

REQ-010-2 完成内容：
- 补充用户故事和细化验收标准
- 创建架构决策记录（MyBatis Plus 注解 + XML 映射文件混合方案）
- 对比了 3 种备选方案
- 分析了决策对系统架构、开发流程、运维管理的影响
- 识别了技术风险、业务风险和实施风险
- 定义了回滚策略和验收标准

文档更新：
- 创建 0010-database-table-design.md 架构决策记录
- 创建 0011-entity-mapper-create.md 架构决策记录
- 创建 0020-database-table-design-create.md 变更记录
- 创建 20260117-database-table-design-create.md 会话记录
- 创建 20260117-database-table-design-create-retro.md 复盘报告
- 创建 011-database-table-design-create.md 提示词文档
- 更新 REQ-010-2.md 需求文档
- 更新 docs/index.md 和 CHANGELOG.md
2026-01-18 19:44:13 +08:00

2.8 KiB
Raw Blame History

name description
REQ-009 元数据拉取和部署功能实现

需求: 元数据拉取和部署功能实现

元数据 (Metadata)

  • 需求编号: REQ-009
  • 需求标题: 元数据拉取和部署功能实现
  • 需求类型: 功能需求
  • 优先级: 高
  • 状态: Draft
  • 创建日期: 2026-01-17
  • 最后更新: 2026-01-17
  • 创建人: SSOT Architect
  • 负责人: SSOT Architect

需求描述 (Description)

背景

在 Salesforce 集成项目中，需要实现元数据的拉取和部署功能，以支持不同环境间的元数据管理和同步。

问题陈述

当前系统缺少元数据拉取和部署功能，无法实现自动化的元数据管理和环境间同步。

目标

实现 Salesforce 元数据的拉取和部署功能，支持全量/增量部署、验证、单元测试以及破坏性变更，提高元数据管理效率。

用户故事 (User Story)

用户角色

系统管理员

用户目标

能够从 Salesforce 组织拉取元数据，并将元数据部署到目标 Salesforce 组织

用户价值

  • 提高元数据管理效率
  • 支持自动化的环境间元数据同步
  • 减少手动操作错误
  • 支持复杂的部署场景

用户故事格式

作为一个系统管理员， 我想要拉取和部署 Salesforce 元数据， 以便于高效管理不同环境间的元数据同步。

验收标准 (Acceptance Criteria)

功能验收标准

  • AC1: 支持从 Salesforce 组织拉取元数据
  • AC2: 支持将元数据部署到 Salesforce 组织
  • AC3: 支持全量部署模式
  • AC4: 支持增量部署模式
  • AC5: 支持部署前验证功能
  • AC6: 支持单元测试执行
  • AC7: 支持破坏性变更部署
  • AC8: 提供详细的部署结果和错误信息
  • AC9: 支持使用验证 ID 进行快速部署

非功能验收标准

  • 性能要求: 拉取和部署操作应异步处理，不阻塞请求线程
  • 安全要求: 所有 Salesforce 认证信息必须加密存储
  • 可用性要求: 系统应能够处理 Salesforce API 限制和错误

技术要求 (Technical Requirements)

技术栈

  • Java 17/21
  • Spring Boot 3.x
  • Salesforce Metadata API
  • OAuth 2.0 认证

接口要求

  • REST API
  • Salesforce Metadata SOAP API

数据库要求

  • MySQL
  • 元数据组件详情表设计
  • 作业执行记录表设计

依赖关系 (Dependencies)

前置需求

  • 无

后续需求

  • 元数据变更自动同步功能

外部依赖

  • Salesforce 组织环境
  • Salesforce Metadata API

相关文档 (Related Documents)

  • 设计文档: 待创建
  • ADR 文档: 待创建
  • 提示词文档: 待创建

变更历史 (Change History)

日期 版本 变更内容 变更人
2026-01-17 1.0.0 初始版本 SSOT Architect