Files
AIclinicalresearch/docs/03-业务模块/Redcap/README.md
HaHafeng 5523ef36ea feat(admin): Complete Phase 3.5.1-3.5.4 Prompt Management System (83%)
Summary:
- Implement Prompt management infrastructure and core services
- Build admin portal frontend with light theme
- Integrate CodeMirror 6 editor for non-technical users

Phase 3.5.1: Infrastructure Setup
- Create capability_schema for Prompt storage
- Add prompt_templates and prompt_versions tables
- Add prompt:view/edit/debug/publish permissions
- Migrate RVW prompts to database (RVW_EDITORIAL, RVW_METHODOLOGY)

Phase 3.5.2: PromptService Core
- Implement gray preview logic (DRAFT for debuggers, ACTIVE for users)
- Module-level debug control (setDebugMode)
- Handlebars template rendering
- Variable extraction and validation (extractVariables, validateVariables)
- Three-level disaster recovery (database -> cache -> hardcoded fallback)

Phase 3.5.3: Management API
- 8 RESTful endpoints (/api/admin/prompts/*)
- Permission control (PROMPT_ENGINEER can edit, SUPER_ADMIN can publish)

Phase 3.5.4: Frontend Management UI
- Build admin portal architecture (AdminLayout, OrgLayout)
- Add route system (/admin/*, /org/*)
- Implement PromptListPage (filter, search, debug switch)
- Implement PromptEditor (CodeMirror 6 simplified for clinical users)
- Implement PromptEditorPage (edit, save, publish, test, version history)

Technical Details:
- Backend: 6 files, ~2044 lines (prompt.service.ts 596 lines)
- Frontend: 9 files, ~1735 lines (PromptEditorPage.tsx 399 lines)
- CodeMirror 6: Line numbers, auto-wrap, variable highlight, search, undo/redo
- Chinese-friendly: 15px font, 1.8 line-height, system fonts

Next Step: Phase 3.5.5 - Integrate RVW module with PromptService

Tested: Backend API tests passed (8/8), Frontend pending user testing
Status: Ready for Phase 3.5.5 RVW integration
2026-01-11 21:25:16 +08:00

155 lines
4.4 KiB
Markdown
Raw Blame History

This file contains ambiguous Unicode characters
This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.
# REDCap模块文档
**版本:** v1.0
**最后更新:** 2026-01-02
**模块状态:** 🟢 本地环境已部署API开发中
---
## 🚀 快速开始
### 我想部署REDCap
👉 **[10-REDCap_Docker部署操作手册.md](./01-部署与配置/10-REDCap_Docker部署操作手册.md)** ⭐
这是最核心的文档!包含:
- ✅ 从0到1的完整部署流程
- ✅ Docker文件复用说明
- ✅ 常见问题与解决方案
- ✅ 适用于本地/ECS/医院环境
**30分钟完成部署**
---
### 我遇到问题了
👉 **[13-部署问题排查手册.md](./01-部署与配置/13-部署问题排查手册.md)** 🔧
基于实际踩坑经验,包含:
- ERR_CONTENT_DECODING_FAILED解决方案
- 登录失败CRLF污染解决方案
- Base URL配置错误修复
- MySQL连接问题排查
---
## 📚 完整文档目录
### [00-模块概览](./00-模块概览/)
- [00-REDCap模块文档导航.md](./00-模块概览/00-REDCap模块文档导航.md) - 完整文档索引
- [02-REDCap对接总体方案.md](./00-模块概览/02-REDCap对接总体方案.md) - 技术架构设计
- [03-REDCap对接风险评估与技术挑战分析.md](./00-模块概览/03-REDCap对接风险评估与技术挑战分析.md) - 风险评估
- [04-生产环境部署决策报告_ECS_vs_SAE.md](./00-模块概览/04-生产环境部署决策报告_ECS_vs_SAE.md) - ECS vs SAE对比
### [01-部署与配置](./01-部署与配置/) ⭐
- **[10-REDCap_Docker部署操作手册.md](./01-部署与配置/10-REDCap_Docker部署操作手册.md)** - 核心部署文档
- [13-部署问题排查手册.md](./01-部署与配置/13-部署问题排查手册.md) - 问题解决记录
### [02-系统配置与运维](./02-系统配置与运维/)
- 🚧 20-REDCap系统配置手册.md规划中
- 🚧 21-REDCap日常运维手册.md规划中
- 🚧 22-REDCap升级指南.md规划中
### [03-API对接与开发](./03-API对接与开发/)
- [33-REDCap二次开发深度指南.md](./03-API对接与开发/33-REDCap二次开发深度指南.md) - External Modules开发
- 🚧 30-REDCap_API使用指南.md开发中
- 🚧 31-IIT_Manager与REDCap对接设计.md开发中
- 🚧 32-REDCap_API_Adapter开发指南.md开发中
### [04-参考资料](./04-参考资料/)
- 旧版文档存档
---
## 📊 当前进度
| 阶段 | 状态 | 完成日期 |
|------|------|----------|
| 技术调研 | ✅ 完成 | 2025-12 |
| 部署方案设计 | ✅ 完成 | 2026-01-01 |
| **本地环境部署** | ✅ **完成** | **2026-01-02** |
| API Adapter开发 | ⏳ 进行中 | 预计2026-01-03 |
| 生产环境部署 | 📅 计划中 | 待定 |
**访问地址:** http://localhost:8080/
**管理员账户:** Admin / Admin123!
---
## 🎯 REDCap在IIT Manager中的角色
```
IIT Manager Agent (企业微信)
REDCap API Adapter
REDCap系统 (EDC)
研究数据采集与管理
```
**核心功能:**
- 📋 电子数据采集EDC
- 📊 数据字典管理
- 🔍 数据质量控制
- 📈 报表与导出
- 👥 用户权限管理
---
## 🛠️ Docker配置文件位置
**所有Docker配置文件都在**
```
AIclinicalresearch/redcap-docker-dev/
├── Dockerfile.redcap ✅ 100%可复用
├── docker-compose.yml ⚠️ 需微调
├── docker-compose.prod.yml ⚠️ 需修改数据库配置
├── docker-entrypoint.sh ✅ 100%可复用
├── config/
│ ├── apache/redcap.conf ⚠️ 需修改域名
│ ├── php/php.ini ✅ 100%可复用
│ └── database.php ❌ 必须根据环境定制
├── scripts/ 可选辅助脚本
└── .gitattributes ✅ 100%可复用
```
详见:[10-REDCap_Docker部署操作手册.md](./01-部署与配置/10-REDCap_Docker部署操作手册.md)
---
## 📞 获取帮助
- **部署问题**:查看 [13-部署问题排查手册.md](./01-部署与配置/13-部署问题排查手册.md)
- **REDCap官方**https://projectredcap.org/
- **技术支持**查看相关文档或提Issue
---
## 🔄 最近更新
| 日期 | 更新内容 |
|------|----------|
| 2026-01-02 | ✅ 完成本地Docker环境部署 |
| 2026-01-02 | ✅ 创建REDCap Docker部署操作手册 |
| 2026-01-02 | ✅ 创建部署问题排查手册 |
| 2026-01-02 | ✅ 重组文档体系 |
---
**准备好开始了吗?** 👉 [开始部署](./01-部署与配置/10-REDCap_Docker部署操作手册.md)