关于 bitrix-documentgenerator
面向 Bitrix24 版本(云端和本地部署)的文档生成参考 Skill,介绍模板、自定义数据提供器、文档生成、访问检查、存储及异步 PDF 转换。
主要功能
- 01模板占位符、修饰符、表格和图像
- 02自定义实体数据提供器
- 03DOCX 与 PDF 生成指导
- 04模板和文档访问检查
- 05存储、删除与生成事件
适用场景
- 01在 Bitrix 模块中创建模板
- 02根据自定义实体数据生成文档
- 03处理异步 PDF 转换
安装
复制下面的命令,在终端中运行。
$
npx skills add https:/ / github.com/ bxmaximum/ bitrix-framework-skills --skill bitrix-documentgenerator安装后在 Claude Code 中输入/bitrix-documentgenerator确认已加载。
包含的文件
除 SKILL.md 外,安装时一起下载的参考资料和脚本。
rules/access-rest.mdgeneration.mdproviders.mdtemplates.md详细介绍
Bitrix 文档生成器
基线:main 23.0+ · 已验证:documentgenerator 26.200.100,main 26.800.0
仅适用于 Bitrix24 版本(云端和本地部署):安装需要 humanresources;“Site Management”中没有此模块。生成 PDF/JPG 需要模块 transformer 和文档服务器。
| 任务 | 阅读 |
|---|---|
| 占位符、修饰符、表格、图像、通过代码创建模板 | rules/templates.md |
| 自有实体数据:提供程序类、字段、列表、注册 | rules/providers.md |
| 生成 DOCX/PDF、编号、存储、删除、事件 | rules/generation.md |
| 模块权限、角色、模板访问权限、REST、UI 组件 | rules/access-rest.md |
CRM 文档(发票、交易)使用 CRM 自己的提供程序:bitrix24-crm。
不变规则
Loader::requireModule('documentgenerator');代码位于你模块的/local/modules/下,提供程序由该模块 ID 注册。- 模板
MODULE_ID= 提供程序MODULE= 已安装的模块;否则提供程序会被静默忽略。 - 在调用
getFields()/Document::createByTemplate()前,调用Template::setSourceType(),并检查getSourceType()。 - 明确检查权限:
UserPermissions、模板访问权限、Document::hasAccess()。加载和创建操作不会检查权限;用户0可通过数据检查。 - 使用
b_documentgenerator_file.ID(FILE_ID、PDF_ID)引用文件;使用FileTable::getBFileId()转换。 - PDF 为异步生成:使用
getFile(false)生成,或跳过转换错误,并响应onDocumentTransformationComplete。
评论
支持 Markdown