PDF帳票出力は、お手持ちのPDFをテンプレートとしてアップロードし、レコードの値を差し込んで見積書・請求書などの帳票を出力するプラグインです。このマニュアルでは、設定項目のリファレンスと、動作仕様・制限事項・トラブルシューティングを説明します。
| プラグインID | pdf-report |
|---|---|
| 対象バージョン | v1.7.0(配布中の最新版) |
| カテゴリ | 帳票・自動化 |
| 説明 | テンプレートPDFにレコードの値を差し込んで帳票を出力します。 |
| 対応環境 | kintone スタンダードコース(デスクトップ版UI)。最新版の Chrome / Edge / Safari / Firefox に対応。 |
|---|---|
| 動作画面 | レコード詳細画面(出力ボタン)。添付ファイル欄への保存にはレコードの編集権限が必要です。 |
| テンプレート | PDFファイル(複数登録可)。差し込みは通常フィールドとサブテーブル明細行に対応。日本語フォント(Noto Sans JP)を同梱。 |
| 生成処理 | PDFの生成はすべてブラウザ内で行われます。レコードデータが帳票生成のために外部サーバーへ送られることはありません。 |
プラグイン設定の全項目です。「項目」は設定データ(エクスポートファイルの config)のキーを表し、[] は配列の要素を意味します。設定画面での入力項目と1対1に対応します。この構造の正式な定義はJSON Schema(catalog.json の configSchema)として公開しています。
| 項目 | 型 | 必須 | 説明・制約 |
|---|---|---|---|
version | 整数 | 任意 | 設定形式のバージョン 固定値: 1 |
templates | 配列 | 必須 | 帳票テンプレート 1件以上 |
templates[].name | 文字列 | 任意 | テンプレート名 |
templates[].pdf | オブジェクト | 任意 | テンプレートPDF |
templates[].pdf.base64 | 文字列 | 任意 | PDFファイル本体(base64) |
templates[].items | 配列 | 任意 | 配置アイテム(フィールド・固定テキスト等) |
templates[].tables | 配列 | 任意 | テーブル領域 |
templates[].output | オブジェクト | 任意 | 出力設定(ファイル名・添付先など) |
プラグイン設定画面の上部にある「設定のインポート / エクスポート」から、現在の設定をJSONファイルとして書き出し(エクスポート)、別のアプリで読み込み(インポート)できます。検証用アプリから本番アプリへの設定コピーや、バックアップ・復元にご利用ください。
エクスポートファイルは次の形式(封筒形式)です。config の中身が設定本体で、その構造は上の設定項目リファレンスのとおりです。
{
"kintauros": "config/v1",
"plugin": "<プラグインID>",
"pluginName": "<プラグイン名>",
"pluginVersion": "<バージョン>",
"exportedAt": "<書き出し日時(ISO 8601)>",
"sourceApp": "<書き出し元アプリID>",
"config": { ... 設定本体 ... }
}
各プラグインは共通ランタイム window.KINTAUROS を搭載しており、ブラウザの開発者コンソールから設定の読み取り・検証・保存ができます。設定の保存(save: true)はkintoneの制約上、プラグイン設定画面でのみ成功します。
KINTAUROS.config.plugins() // このページのKINTAUROSプラグインID一覧
KINTAUROS.config.describeAll() // 同居プラグインすべての設定サマリ
KINTAUROS.config.of('<プラグインID>').schema() // 設定のJSON Schema
KINTAUROS.config.of('<プラグインID>').export() // 現在の設定(封筒つき)
KINTAUROS.config.of('<プラグインID>').validate(x) // 保存せず検証
KINTAUROS.config.of('<プラグインID>').diff(x) // 現在の設定との差分
await KINTAUROS.config.of('<プラグインID>').import(x, { save: true }) // 検証して保存(設定画面のみ)
登録が1件だけのページでは of(...) を省略できます(例: KINTAUROS.config.export())。
PDF帳票出力を含むKINTAUROSプラグインは、エラー発生時にブラウザのコンソールへ統一形式のログを出力します。人間向けの1行に続けて、機械可読なJSON(code / plugin / version / appId / message / doc)を出力し、doc には該当エラーの解説ページのURLが入ります。
[KINTAUROS <プラグインID>@<バージョン>] E001: 設定されたフィールドが見つかりません: ...
{"kintauros":{"code":"E001","plugin":"...","version":"...","appId":"...","message":"...","doc":"https://kintauros.com/docs/errors/E001"}}
各エラーコードの意味と対処はエラーコード一覧を参照してください。また、プラグイン設定画面の「サポート用情報をコピー」から、環境・バージョン・ライセンス状態・直近のエラーを含む診断情報をコピーできます(レコードの内容や個人情報は含まれません)。お問い合わせの際はこの情報を添えてください。
解決しない場合はお問い合わせからご連絡ください。その際、プラグイン設定画面の「サポート用情報をコピー」でコピーした診断情報を添えていただくと、調査がスムーズです。
最終更新: 2026-08-14 / 対象バージョン: v1.7.0