bitrix-documentgenerator について
Bitrix24 エディション(クラウドおよびオンプレミス)向けのドキュメント生成リファレンススキルです。テンプレート、カスタムデータプロバイダー、生成、アクセス確認、保存、非同期 PDF 変換を扱います。
主な機能
- 01テンプレートのプレースホルダー、修飾子、表、画像
- 02カスタムエンティティデータプロバイダー
- 03DOCX と PDF の生成ガイド
- 04テンプレートとドキュメントのアクセス確認
- 05保存、削除、生成イベント
活用シーン
- 01Bitrix モジュールでのテンプレート作成
- 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 対応