mcpField
B
bitrix-documentgenerator

bitrix-documentgenerator

github.com/bxmaximum文档处理4778 次安装2 周前更新
代码仓库

关于 bitrix-documentgenerator

面向 Bitrix24 版本(云端和本地部署)的文档生成参考 Skill,介绍模板、自定义数据提供器、文档生成、访问检查、存储及异步 PDF 转换。

主要功能

  1. 01模板占位符、修饰符、表格和图像
  2. 02自定义实体数据提供器
  3. 03DOCX 与 PDF 生成指导
  4. 04模板和文档访问检查
  5. 05存储、删除与生成事件

适用场景

  1. 01在 Bitrix 模块中创建模板
  2. 02根据自定义实体数据生成文档
  3. 03处理异步 PDF 转换

安装

复制下面的命令,在终端中运行。

$npx skills add https://github.com/bxmaximum/bitrix-framework-skills --skill bitrix-documentgenerator

安装后在 Claude Code 中输入/bitrix-documentgenerator确认已加载。

包含的文件

除 SKILL.md 外,安装时一起下载的参考资料和脚本。

rules/
access-rest.md
generation.md
providers.md
templates.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