198 lines
8.3 KiB
Markdown
198 lines
8.3 KiB
Markdown
# Requirements - 元数据任务定义管理
|
||
|
||
## 需求信息
|
||
|
||
- **需求名称**: 元数据任务定义管理
|
||
- **需求类型**: 功能需求
|
||
- **需求编号**: REQ-010-4
|
||
- **父需求**: REQ-010
|
||
- **创建日期**: 2026-01-17
|
||
- **需求版本**: v1.0.0
|
||
- **需求提出人**: 系统管理员
|
||
- **需求状态**: 已完成
|
||
|
||
## 输入引用
|
||
|
||
引用相关的 docs 文档链接：
|
||
|
||
- [REQ-010.md](REQ-010.md) - Salesforce元数据拉取和部署主需求文档
|
||
- [REQ-010-1.md](REQ-010-1.md) - 数据库表结构设计和创建
|
||
- [REQ-010-2.md](REQ-010-2.md) - 基础实体类和Mapper创建
|
||
- [REQ-010-3.md](REQ-010-3.md) - Salesforce组织配置管理
|
||
- [010-metadata-retrieve-deploy-sub-requirements.md](010-metadata-retrieve-deploy-sub-requirements.md) - REQ-010子需求拆分文档
|
||
- [metadata-module.md](../reference-code/com/docs/metadata-module.md) - Salesforce Metadata API 模块说明（唯一真源）
|
||
- [file/index.md](../api-docs/file/index.md) - 文件模块 API 文档索引（唯一真源）
|
||
|
||
## Context Maps
|
||
|
||
强制列出本次需求依赖的 Canvas 文件：
|
||
|
||
- [Authentication.canvas](../Authentication.canvas) - 项目架构视觉化展示
|
||
- **相关节点**: [集成任务](node_integration_task) - 处理Salesforce的定时同步任务
|
||
|
||
## 需求目标
|
||
|
||
提供元数据任务定义的CRUD管理功能，支持配置拉取规则、package.xml内容、API版本、调度类型等。
|
||
|
||
## 需求描述
|
||
|
||
### 概述
|
||
|
||
本需求旨在提供元数据任务定义的完整管理功能，包括任务的增删改查、package.xml内容配置、API版本选择、调度类型选择、Cron表达式配置、任务验证等。
|
||
|
||
### 详细需求
|
||
|
||
#### 1. 任务定义CRUD功能
|
||
|
||
- **需求描述**: 实现任务定义的增删改查功能
|
||
- **优先级**: 高
|
||
- **验收标准**:
|
||
- 能够成功创建元数据任务
|
||
- 能够成功编辑元数据任务
|
||
- 能够成功删除元数据任务
|
||
- 能够查询元数据任务列表
|
||
- 支持分页查询
|
||
- 支持条件查询（按任务名称、任务类型、组织配置ID、激活状态等）
|
||
- 支持批量删除
|
||
- 支持导出功能
|
||
- API接口符合RESTful规范
|
||
- **依赖关系**: 依赖于REQ-010-1, REQ-010-2, REQ-010-3
|
||
- **实现建议**: 使用MyBatis Plus的BaseMapper实现CRUD，使用@Valid注解进行参数验证
|
||
|
||
#### 2. package.xml内容配置
|
||
|
||
- **需求描述**: 实现package.xml内容配置，支持可视化编辑
|
||
- **优先级**: 高
|
||
- **验收标准**:
|
||
- package.xml内容配置成功
|
||
- package.xml格式符合Salesforce Metadata API规范
|
||
- 支持多种元数据类型配置
|
||
- 支持通配符配置
|
||
- package.xml验证功能正常工作
|
||
- 支持package.xml的存储和读取
|
||
- **依赖关系**: 依赖于任务定义CRUD功能
|
||
- **实现建议**: 使用XML解析库处理package.xml，实现可视化编辑器，直接存储XML字符串到数据库
|
||
|
||
#### 3. Destructive Changes XML配置
|
||
|
||
- **需求描述**: 实现Destructive Changes XML内容配置，支持删除元数据组件
|
||
- **优先级**: 高
|
||
- **验收标准**:
|
||
- Destructive Changes XML内容配置成功
|
||
- Destructive Changes XML格式符合Salesforce Metadata API规范
|
||
- 支持多种元数据类型删除配置
|
||
- 支持通配符配置
|
||
- Destructive Changes XML验证功能正常工作
|
||
- 支持Destructive Changes XML的存储和读取
|
||
- 仅在部署任务中使用
|
||
- **依赖关系**: 依赖于任务定义CRUD功能
|
||
- **实现建议**: 使用XML解析库处理Destructive Changes XML，实现可视化编辑器，直接存储XML字符串到数据库
|
||
|
||
#### 4. 运行选项配置
|
||
|
||
- **需求描述**: 实现运行选项配置，支持部署时的各种选项设置
|
||
- **优先级**: 高
|
||
- **验收标准**:
|
||
- 运行选项配置成功
|
||
- 支持checkOnly选项（仅验证不部署）
|
||
- 支持testLevel选项（测试级别配置）
|
||
- 支持runTests选项（运行特定测试）
|
||
- 支持其他部署选项配置
|
||
- 运行选项验证功能正常工作
|
||
- 支持运行选项的存储和读取
|
||
- 仅在部署任务中使用
|
||
- **依赖关系**: 依赖于任务定义CRUD功能
|
||
- **实现建议**: 使用JSON格式存储运行选项，实现可视化配置界面
|
||
|
||
#### 5. Cron表达式配置
|
||
|
||
- **需求描述**: 实现Cron表达式配置和验证，支持定时任务调度
|
||
- **优先级**: 高
|
||
- **验收标准**:
|
||
- 支持Cron表达式配置
|
||
- Cron表达式验证正确
|
||
- Cron表达式解析正确
|
||
- Cron表达式预览功能正常工作（显示下次执行时间）
|
||
- 支持任务激活状态管理（isActive）
|
||
- 当isActive为true时，Cron表达式生效
|
||
- 当isActive为false时，任务不执行
|
||
- **依赖关系**: 依赖于任务定义CRUD功能
|
||
- **实现建议**: 使用Cron表达式解析库验证Cron表达式，实现Cron表达式预览功能，使用isActive字段控制任务执行
|
||
|
||
#### 6. 任务验证功能
|
||
|
||
- **需求描述**: 实现任务验证功能，验证package.xml、Destructive Changes XML和调度配置
|
||
- **优先级**: 高
|
||
- **验收标准**:
|
||
- 任务验证功能正常工作
|
||
- package.xml格式验证正确
|
||
- Destructive Changes XML格式验证正确
|
||
- Cron表达式验证正确
|
||
- 运行选项验证正确
|
||
- 验证失败返回详细错误信息
|
||
- 验证成功返回验证通过信息
|
||
- **依赖关系**: 依赖于package.xml内容配置、Destructive Changes XML配置、Cron表达式配置和运行选项配置
|
||
- **实现建议**: 使用XML解析库验证XML格式，使用Cron表达式解析库验证Cron表达式，使用JSON解析库验证运行选项
|
||
|
||
## 约束
|
||
|
||
- **技术栈限制**: 必须基于现有的Spring Boot 3 + Vue 3技术栈
|
||
- **架构约束**: 必须遵循Authentication.canvas中定义的架构和调用关系
|
||
- **模块约束**: 必须在datai-salesforce-metadata模块下实现
|
||
- **数据库约束**: 必须使用MyBatis Plus作为持久层框架
|
||
- **文档约束**: 必须遵循REQ-010中定义的验收标准
|
||
- **依赖约束**: 必须依赖于REQ-010-1, REQ-010-2, REQ-010-3
|
||
- **数据模型约束**: 必须使用datai_meta_task表，包含taskName、taskType、orgConfigId、packageXml、destructiveChangesXml、runOptions、scheduleCron、isActive、deptId等字段
|
||
- **API设计约束**: 必须提供RESTful API接口，包括/list、/export、/{id}、POST、PUT、DELETE/{ids}等接口
|
||
- **权限约束**: 必须使用@PreAuthorize注解进行权限控制，权限标识为metadata:task:*
|
||
|
||
## Rule Set
|
||
|
||
"请严格参考 @Authentication.canvas 中的状态机转移逻辑，不要自行发挥。"
|
||
|
||
**具体规则**：
|
||
- 必须使用Canvas中定义的类名和方法名
|
||
- 必须遵循Canvas中定义的调用关系
|
||
- 必须参考Canvas中的流程图逻辑
|
||
|
||
## 验收标准
|
||
|
||
- **功能完整性**: 所有CRUD功能能够正常工作，package.xml配置成功
|
||
- **代码规范性**: 代码符合项目编码规范，有清晰的注释
|
||
- **用户体验**: 操作界面友好易用，提供清晰的错误信息
|
||
- **可维护性**: 代码结构清晰，易于扩展和维护
|
||
|
||
## 风险
|
||
|
||
- **package.xml验证风险**: package.xml格式验证复杂可能导致验证不准确
|
||
- **Destructive Changes XML验证风险**: Destructive Changes XML格式验证复杂可能导致验证不准确，错误的删除配置可能导致数据丢失
|
||
- **Cron表达式解析风险**: Cron表达式解析错误可能导致任务调度失败
|
||
- **运行选项配置风险**: 运行选项配置错误可能导致部署失败或测试不通过
|
||
- **任务验证风险**: 任务验证逻辑复杂可能导致验证不准确
|
||
- **多任务管理风险**: 多任务管理复杂可能导致任务冲突
|
||
- **XML存储风险**: XML字符串存储可能占用较多数据库空间
|
||
- **任务激活状态风险**: isActive字段配置错误可能导致任务意外执行或不执行
|
||
|
||
## 需求变更记录
|
||
|
||
| 日期 | 变更内容 | 变更原因 | 变更人 | 审核人 | 状态 |
|
||
|------|---------|---------|--------|--------|------|
|
||
| 2026-01-17 | 创建需求文档 | 初始需求 | 系统管理员 | - | 待审核 |
|
||
| 2026-01-18 | 完成需求实现 | 完成6个阶段的开发流程 | Datai Team | - | 已完成 |
|
||
|
||
## 相关人员
|
||
|
||
- **需求提出人**: 系统管理员 - 联系方式
|
||
- **需求负责人**: 系统管理员 - 联系方式
|
||
- **技术负责人**: 开发工程师 - 联系方式
|
||
- **测试负责人**: 测试工程师 - 联系方式
|
||
- **其他相关人员**: - 联系方式
|
||
|
||
## 评审信息
|
||
|
||
- **评审日期**: -
|
||
- **评审人员**: -
|
||
- **评审结果**: -
|
||
- **评审意见**: -
|
||
- **修改建议**: -
|