datai/datai-scenes/datai-scene-salesforce/docs/index.md

236 lines
14 KiB
Markdown
Raw Normal View History

# 单一真源文档中心
## 项目概述
本文件是 Salesforce 集成项目的单一真源入口,包含所有项目相关文档的链接清单。
## 文档目录
### 【视觉看板】
- **架构图**: [Authentication.canvas](../Authentication.canvas) - 项目架构视觉化展示,包含认证、集成、通用和配置模块的详细结构
### 1. 需求文档
- **目录**: [requirements/](requirements/)
- **描述**: 包含项目的功能需求、非功能需求和验收标准
- **需求文档**:
- [PartnerAPI源org实现](./requirements/2026-01-28-001-PartnerAPI源org实现.md) - 进行中(子需求 001-01 已完成001-02 已完成001-03 已完成001-04 已完成001-05 已完成001-06 已完成阶段 8 - 高
- [ApexAPI源org实现](./requirements/2026-01-28-002-ApexAPI源org实现.md) - 进行中 - 高
- [MetadataAPI源org实现](./requirements/2026-01-28-003-MetadataAPI源org实现.md) - 进行中 - 高
- [ToolingAPI源org实现](./requirements/2026-01-28-004-ToolingAPI源org实现.md) - 进行中 - 高
### 2. 设计文档
- **目录**: [design/](design/)
- **描述**: 包含系统架构设计、模块设计和接口设计
- **设计文档**:
- [认证和会话管理-设计](./design/2026-01-29-001-01-认证和会话管理-设计.md) - 已完成(代码已实现)
- [CRUD操作-设计](./design/2026-01-30-002-CRUD操作-设计.md) - 已完成(代码已实现)
- [批量操作-设计](./design/2026-01-30-003-批量操作-设计.md) - 已完成(代码已实现)
- [查询功能-设计](./design/2026-01-30-004-查询功能-设计.md) - 已完成(代码已实现)
- [描述功能-设计](./design/2026-02-02-005-描述功能-设计.md) - 已完成(代码已实现)
- [高级功能-设计](./design/2026-02-02-006-高级功能-设计.md) - 已完成(代码已实现)
- [连接管理-设计](./design/2026-01-28-004-01-连接管理-设计.md) - 已完成(代码已实现)
2026-02-03 16:32:38 +08:00
- [元数据操作-设计](./design/2026-01-28-004-02-元数据操作-设计.md) - 进行中Tooling API 元数据操作)
- [开发工具功能-设计](./design/2026-01-28-004-03-开发工具功能-设计.md) - 进行中Tooling API 开发工具功能)
- [AI和智能功能-设计](./design/2026-01-28-004-04-AI和智能功能-设计.md) - 进行中Tooling API AI和智能功能
- [动作和自动化功能-设计](./design/2026-01-28-004-05-动作和自动化功能-设计.md) - 进行中Tooling API 动作和自动化功能)
- [访问和安全功能-设计](./design/2026-01-28-004-06-访问和安全功能-设计.md) - 已完成Tooling API 访问和安全功能)
- [高级功能-设计](./design/2026-02-03-004-07-高级功能-设计.md) - 已完成Tooling API 高级功能)
- [SOQL查询功能-设计](./design/2026-02-03-004-08-SOQL查询功能-设计.md) - 已完成Tooling API SOQL查询功能
### 3. 提示词 (Prompt)
- **目录**: [prompts/](prompts/)
- **描述**: 包含各需求的专用代码生成提示词
- **提示词文档**:
### 3. 架构决策
- **目录**: [decisions/](decisions/)
- **描述**: 包含架构决策记录 (ADR),记录重要的架构决策过程
- **ADR文档**:
- [认证和会话管理技术选型](./decisions/2026-01-29-001-01-ADR-认证和会话管理技术选型.md) - 已接受
- [连接管理技术选型](./decisions/2026-01-28-004-01-ADR-连接管理技术选型.md) - 已接受Tooling API 连接管理)
2026-02-03 16:32:38 +08:00
- [元数据操作技术选型](./decisions/2026-01-28-004-02-ADR-元数据操作技术选型.md) - 已接受Tooling API 元数据操作)
- [开发工具功能技术选型](./decisions/2026-01-28-004-03-ADR-开发工具功能技术选型.md) - 已接受Tooling API 开发工具功能)
- [AI和智能功能技术选型](./decisions/2026-01-28-004-04-ADR-AI和智能功能技术选型.md) - 已接受Tooling API AI和智能功能
- [动作和自动化功能技术选型](./decisions/2026-01-28-004-05-ADR-动作和自动化功能技术选型.md) - 已接受Tooling API 动作和自动化功能)
- [访问和安全功能技术选型](./decisions/2026-02-03-004-06-ADR-访问和安全功能技术选型.md) - 已接受Tooling API 访问和安全功能)
- [高级功能技术选型](./decisions/2026-02-03-004-07-ADR-高级功能技术选型.md) - 已接受Tooling API 高级功能)
- [SOQL查询功能技术选型](./decisions/2026-02-03-004-08-ADR-SOQL查询功能技术选型.md) - 已接受Tooling API SOQL查询功能
- [CRUD操作技术选型](./decisions/2026-01-30-002-ADR-CRUD操作技术选型.md) - 已接受
- [批量操作技术选型](./decisions/2026-01-30-003-ADR-批量操作技术选型.md) - 已接受
- [查询功能技术选型](./decisions/2026-01-30-004-ADR-查询功能技术选型.md) - 已接受
- [描述功能技术选型](./decisions/2026-02-02-005-ADR-描述功能技术选型.md) - 已接受
- [高级功能技术选型](./decisions/2026-02-02-006-ADR-高级功能技术选型.md) - 已接受
### 4. 提示词库
- **目录**: [prompts/](prompts/)
- **描述**: 包含 AI 提示词模板和最佳实践
- **模板**: [0000-template.md](prompts/0000-template.md)
- **提示词文件**:
- [认证和会话管理提示词](./prompts/2026-01-29-001-01-prompt-认证和会话管理.md) - 认证和会话管理的执行提示词
- [连接管理提示词](./prompts/2026-01-28-004-01-prompt-连接管理.md) - Tooling API 连接管理的执行提示词
2026-02-03 16:32:38 +08:00
- [元数据操作提示词](./prompts/2026-01-28-004-02-prompt-元数据操作.md) - Tooling API 元数据操作的执行提示词
- [开发工具功能提示词](./prompts/2026-01-28-004-03-prompt-开发工具功能.md) - Tooling API 开发工具功能的执行提示词
- [AI和智能功能提示词](./prompts/2026-01-28-004-04-prompt-AI和智能功能.md) - Tooling API AI和智能功能的执行提示词
- [动作和自动化功能提示词](./prompts/2026-01-28-004-05-prompt-动作和自动化功能.md) - Tooling API 动作和自动化功能的执行提示词
- [访问和安全功能提示词](./prompts/2026-02-03-004-06-prompt-访问和安全功能.md) - Tooling API 访问和安全功能的执行提示词
- [高级功能提示词](./prompts/2026-02-03-004-07-prompt-高级功能.md) - Tooling API 高级功能的执行提示词
- [CRUD操作提示词](./prompts/2026-01-30-002-prompt-CRUD操作.md) - CRUD操作的执行提示词
- [批量操作提示词](./prompts/2026-01-30-003-prompt-批量操作.md) - 批量操作的执行提示词
- [查询功能提示词](./prompts/2026-01-30-004-prompt-查询功能.md) - 查询功能的执行提示词
- [描述功能提示词](./prompts/2026-02-02-005-prompt-描述功能.md) - 描述功能的执行提示词
- [高级功能提示词](./prompts/2026-02-02-006-prompt-高级功能.md) - 高级功能的执行提示词
2026-02-03 16:32:38 +08:00
- [SOQL查询功能提示词](./prompts/2026-02-03-004-08-prompt-SOQL查询功能.md) - Tooling API SOQL查询功能的执行提示词
### 5. 会话记录
- **目录**: [sessions/](sessions/)
- **描述**: 记录每个需求的完整执行过程
- **会话文件**:
### 5. 技能文档
- **目录**: [skill/](skill/)
- **描述**: 包含项目开发所需的技能文档,指导 AI 完成特定开发任务
- **技能文档**:
### 6. 会话记录
- **目录**: [sessions/](sessions/)
- **描述**: 包含每次重要操作的会话记录
- **会话记录**:
- [会话记录 004](./sessions/2026-01-28-004-session.md) - Tooling API 源 org 实现会话记录
### 6. 迭代复盘
- **目录**: [retros/](retros/)
- **描述**: 包含每个迭代的复盘报告
- **复盘报告**:
- [认证和会话管理复盘](./retros/2026-01-30-001-retro.md) - 认证和会话管理功能开发复盘
- [CRUD操作复盘](./retros/2026-01-30-002-retro.md) - CRUD操作功能开发复盘
- [批量操作复盘](./retros/2026-01-30-003-retro.md) - 批量操作功能开发复盘
- [查询功能复盘](./retros/2026-01-30-004-retro.md) - 查询功能开发复盘
- [描述功能复盘](./retros/2026-02-02-005-retro.md) - 描述功能开发复盘
- [高级功能复盘](./retros/2026-02-02-006-retro.md) - 高级功能开发复盘
- [连接管理复盘](./retros/2026-01-28-004-retro.md) - Tooling API 连接管理功能开发复盘
### 7. 变更日志
- **目录**: [changelog/](changelog/)
- **描述**: 包含详细的变更记录
- **变更记录文档**:
- [认证和会话管理变更日志](./changelog/2026-01-30-001-changelog.md) - 实现认证和会话管理功能
- [CRUD操作变更日志](./changelog/2026-01-30-002-changelog.md) - 实现 CRUD 操作功能
- [批量操作变更日志](./changelog/2026-01-30-003-changelog.md) - 实现批量操作功能
- [查询功能变更日志](./changelog/2026-01-30-004-changelog.md) - 实现查询功能SOQL 查询、QueryAll、QueryMore、SOSL 搜索)
- [描述功能变更日志](./changelog/2026-02-02-005-changelog.md) - 实现描述功能DescribeGlobal、DescribeSObject、DescribeSObjects、DescribeLayout、DescribeTabs、DescribeQuickActions
- [高级功能变更日志](./changelog/2026-02-02-006-changelog.md) - 实现高级功能ConvertLead、EmptyRecycleBin、ProcessSubmitRequest、GetUserInfo、GetServerTimestamp
- [连接管理变更日志](./changelog/2026-01-28-004-01-changelog.md) - 实现 Tooling API 连接管理功能
### 8. 分析报告
- **目录**: [./](.)
- **描述**: 包含项目需求的分析报告
- **分析报告文档**:
2026-01-26 10:19:48 +08:00
### 8. SQL 脚本
- **目录**: [sql/](sql/)
- **描述**: 包含数据库表结构创建和变更的 SQL 脚本
- **SQL 脚本**:
2026-02-03 16:32:38 +08:00
- [元数据操作日志表-SQL脚本](./sql/2026-01-28-004-02-元数据操作日志表.sql) - 创建 Tooling API 元数据操作日志表
- [开发工具功能日志表-SQL脚本](./sql/2026-01-28-004-03-开发工具功能日志表.sql) - 创建 Tooling API 开发工具操作日志表
- [AI操作日志表-SQL脚本](./sql/2026-01-28-004-04-AI操作日志表.sql) - 创建 Tooling API AI 操作日志表
- [动作和自动化操作日志表-SQL脚本](./sql/2026-01-28-004-05-动作和自动化操作日志表.sql) - 创建 Tooling API 动作和自动化操作日志表
- [访问和安全操作日志表-SQL脚本](./sql/2026-02-03-004-06-访问和安全操作日志表.sql) - 创建 Tooling API 访问和安全操作日志表
- [高级功能操作日志表-SQL脚本](./sql/2026-02-03-004-07-高级功能操作日志表.sql) - 创建 Tooling API 高级功能操作日志表
- [SOQL查询功能操作日志表-SQL脚本](./sql/2026-02-03-004-08-SOQL查询功能操作日志表.sql) - 创建 Tooling API SOQL查询功能操作日志表
2026-01-26 10:19:48 +08:00
### 9. 接口文档
- **目录**: [api-docs/](api-docs/)
feat: 添加定时任务功能和文档 - 新增 4 个定时任务类: - ObjectSyncTask: 对象自动同步任务 - ObjectInsertTask: 对象自动插入任务 - ObjectUpdateTask: 对象自动更新任务 - MetadataChangeAutoSyncTask: 元数据变更自动同步任务 - 新增 2 个多对象操作接口: - insertMultipleObjectDataToTarget: 批量插入对象数据到目标系统 - updateMultipleObjectDataToTarget: 批量更新对象数据到目标系统 - 新增完整的定时任务文档: - task/index.md: 定时任务文档索引 - ObjectSyncTask.md: 对象自动同步任务文档 - ObjectInsertTask.md: 对象自动插入任务文档 - ObjectUpdateTask.md: 对象自动更新任务文档 - MetadataChangeAutoSyncTask.md: 元数据变更自动同步任务文档 - RateLimitResetTask.md: 每日限流重置任务文档 - 新增 API 文档索引:api-docs/index.md - 更新唯一真源文档中心:docs/index.md - 新增完整的项目文档: - REQ-005.md: 定时任务自动同步、插入和更新对象数据需求 - REQ-006.md: 元数据变更自动同步本地数据库需求 - 0005-scheduled-tasks-implementation.md: 定时任务架构决策 - 0006-metadata-change-auto-sync.md: 元数据变更自动同步架构决策 - 005-scheduled-tasks-implementation.md: 定时任务实现提示词 - 006-metadata-change-auto-sync.md: 元数据变更自动同步实现提示词 - 20260116-scheduled-tasks-implementation.md: 定时任务实现会话记录 - 20260116-metadata-change-auto-sync.md: 元数据变更自动同步实现会话记录 - 20260116-scheduled-tasks-implementation-retro.md: 定时任务实现复盘 - 20260116-metadata-change-auto-sync-retro.md: 元数据变更自动同步实现复盘 - 0015-scheduled-tasks-implementation.md: 定时任务变更记录 - 0016-metadata-change-auto-sync.md: 元数据变更自动同步变更记录 - 更新 CHANGELOG.md 和 README.md
2026-01-16 16:38:35 +08:00
- **描述**: 包含提供给前端调用的接口文档和定时任务文档
- **模块索引**:
- [认证和会话管理 API 文档](./api-docs/2026-01-30-001-api.md) - 认证和会话管理接口文档
- [CRUD操作 API 文档](./api-docs/2026-01-30-002-api.md) - CRUD操作接口文档
- [批量操作 API 文档](./api-docs/2026-01-30-003-api.md) - 批量操作接口文档
- [查询功能 API 文档](./api-docs/2026-01-30-004-api.md) - 查询功能接口文档SOQL 查询、QueryAll、QueryMore、SOSL 搜索)
- [描述功能 API 文档](./api-docs/2026-02-02-005-api.md) - 描述功能接口文档DescribeGlobal、DescribeSObject、DescribeSObjects、DescribeLayout、DescribeTabs、DescribeQuickActions
- [高级功能 API 文档](./api-docs/2026-02-02-006-api.md) - 高级功能 API
- [连接管理 API 文档](./api-docs/2026-01-28-004-api.md) - Tooling API 连接管理接口文档
### 9. SQL文件
- **目录**: [sql/](sql/)
- **描述**: 包含数据库结构和初始化SQL文件
- **SQL文件**:
### 10. 参考代码
- **目录**: [reference-code/](reference-code/)
- **描述**: 包含项目参考代码和示例实现
- **参考代码**:
- **Salesforce SOAP API Java 客户端**: [com/docs/](reference-code/com/docs/) - Salesforce 官方 WSDL 对应的 Java 源代码参考文档
- [index.md](reference-code/com/docs/index.md) - Salesforce SOAP API Java 客户端参考文档(唯一真源)
- [apex-module.md](reference-code/com/docs/apex-module.md) - Apex SOAP API 模块说明
- [metadata-module.md](reference-code/com/docs/metadata-module.md) - Metadata API 模块说明
- [tooling-module.md](reference-code/com/docs/tooling-module.md) - Tooling API 模块说明
- [partner-module.md](reference-code/com/docs/partner-module.md) - Partner API 模块说明
- **data-dump**: [data-dump/](reference-code/data-dump/) - 数据导出参考代码
- [CommonServiceImpl.java](reference-code/data-dump/CommonServiceImpl.java) - Salesforce 数据插入逻辑参考
- [DataImportNewServiceImpl.java](reference-code/data-dump/DataImportNewServiceImpl.java) - 数据导入服务实现参考
### 11. 实施方案
- **目录**: [implementation/](implementation/)
- **描述**: 包含项目实施方案和部署说明
- **实施方案**:
### 12. 图片资源
## 协作基线文件
- **README.md**: [../README.md](../README.md) - 项目目标和真源入口
- **CONTRIBUTING.md**: [../CONTRIBUTING.md](../CONTRIBUTING.md) - 协作规则
- **CHANGELOG.md**: [../CHANGELOG.md](../CHANGELOG.md) - 变更摘要
## 变更日志
## 代码提交记录
2026-02-03 16:32:38 +08:00
- 2026-01-28: feat: [004-01] 实现 Tooling API 连接管理功能 - 本地(远程推送失败,认证问题)
## 复盘文档
## 会话记录
- [会话记录 - PartnerAPI源org实现](./sessions/2026-01-28-001-session.md) - 认证和会话管理、CRUD操作、批量操作、查询功能、描述功能已完成
## 导航说明
- 本文件是项目文档的唯一入口,所有文档变更必须在此添加链接
- 文档间引用必须使用相对路径链接
- 新文档必须使用相应目录中的模板文件
## 最后更新