v2.0.2
確認や通知の出し方を見直しました。
改善
- 確認やエラーの表示を、ブラウザのポップアップから画面内の表示に変更しました。保存時の入力エラーは保存ボタンの上にまとめて表示されます
- ボタンや通知の色合いを kintone の画面に合わせました
| プラグインID | pdf-report |
|---|---|
| 対象バージョン | v2.0.2(配布中の最新版) |
| カテゴリ | 帳票 |
| 説明 | テンプレートのPDF・Excelにレコードの値を差し込んで帳票を出力します。 |
| 対応環境 | kintone スタンダードコース(デスクトップ版UI)。最新版の Chrome / Edge / Safari / Firefox に対応。 |
|---|---|
| 動作画面 | レコード詳細画面(出力ボタン)。添付ファイル欄への保存にはレコードの編集権限が必要です。 |
| テンプレート | PDFファイル、Excelファイル(.xlsx / .xlsm。.xls は対象外)。複数登録可。差し込みは通常フィールドとサブテーブル明細行に対応。PDF用の日本語フォント(Noto Sans JP)を同梱。 |
| テンプレートの保存先 | kintoneの中だけです。「このアプリ」(プラグイン設定。すべての帳票の合計で250KBまで)か「保管用アプリ」(1ファイル20MBまで)を選べます。 |
| 生成処理 | 帳票の生成はすべてブラウザ内で行われます。テンプレートも出力した帳票もkintoneの外には送りません。 |
プラグイン設定の全項目です。「項目」は設定データ(エクスポートファイルの config)のキーを表し、[] は配列の要素を意味します。設定画面での入力項目と1対1に対応します。この構造の正式な定義はJSON Schema(catalog.json の configSchema)として公開しています。
| 項目 | 型 | 必須 | 説明・制約 |
|---|---|---|---|
version | 整数 | 必須 | 設定形式のバージョン(2 以外は未設定として扱う) 固定値: 2 |
storage | - | 任意 | テンプレート保管アプリ(null = このプラグインの設定に保存) |
templates | 配列 | 必須 | 帳票テンプレート 1件以上 |
templates[].id | 文字列 | 必須 | テンプレートの ID |
templates[].name | 文字列 | 必須 | 帳票名(詳細画面のメニューに出る) |
templates[].format | - | 必須 | 形式(ファイルの拡張子で決まる) 値: pdf | xlsx |
templates[].file | オブジェクト | 任意 | テンプレートのファイル |
templates[].file.name | 文字列 | 任意 | 元のファイル名 |
templates[].file.size | 整数 | 任意 | 元のファイルの大きさ(バイト) |
templates[].file.sha256 | 文字列 | 任意 | ファイルのハッシュ(保管アプリでの差し替えの検知) |
templates[].file.ext | - | 任意 | 拡張子 値: pdf | xlsx | xlsm |
templates[].file.base64 | 文字列 | 任意 | 設定内に置く場合のファイル本体(Excel は出力するシートだけに絞ったもの) |
templates[].file.record | 文字列 | 任意 | 保管アプリに置く場合のレコード番号 |
templates[].pdf | オブジェクト | 任意 | PDF の情報 |
templates[].pdf.pageCount | 整数 | 任意 | ページ数 |
templates[].pdf.pages | 配列 | 任意 | 各ページの大きさ({ w, h } pt) |
templates[].xlsx | オブジェクト | 任意 | Excel の情報 |
templates[].xlsx.sheets | 配列 | 任意 | 元のファイルのシート({ name }) |
templates[].xlsx.outputSheets | 配列(文字列) | 任意 | 出力するシート(これ以外は出力時に消す) |
templates[].xlsx.macro | 真偽値 | 任意 | マクロ付き(.xlsm) |
templates[].items | 配列 | 任意 | PDF の配置アイテム({ id, fieldCode, fieldType, page, x, y, w, h, fontSize, align, valign, format }) |
templates[].tables | 配列 | 任意 | PDF のテーブル領域({ id, fieldCode, page, startY, rowHeight, maxRowsPerPage, overflow, valign, columns[{ subFieldCode, x, w, align, fontSize, format }] }) |
templates[].cells | 配列 | 任意 | Excel の割り当て |
templates[].cells[].id | 文字列 | 必須 | - |
templates[].cells[].kind | - | 必須 | 値 / テーブル(固定行) 値: value | table |
templates[].cells[].sheet | 文字列 | 必須 | シート名 |
templates[].cells[].range | 文字列 | 任意 | セル範囲(例: B3:F3。結合セルは左上に書く) |
templates[].cells[].fieldCode | 文字列 | 任意 | フィールドコード |
templates[].cells[].template | 文字列 | 任意 | 差し込み文字列(例: 〒{郵便番号} {住所}。この項目があればフィールドの代わりに書く) |
templates[].cells[].dateFormat | 文字列 | 任意 | 日付の表示形式(Excel の書式) |
templates[].cells[].dateAs | - | 任意 | 日付を文字列で書く 値: text |
templates[].cells[].tableCode | 文字列 | 任意 | テーブルのフィールドコード |
templates[].cells[].rows | 文字列 | 任意 | テーブルの行の範囲(例: 20:44。列の range の行と揃える) |
templates[].cells[].columns | 配列 | 任意 | テーブルの列({ range: 明細の行の範囲, fieldCode: 列のコード | '$row'(行番号), dateFormat?, dateAs? }) |
templates[].output | オブジェクト | 任意 | 出力設定 |
templates[].output.fileNameTemplate | 文字列 | 任意 | ファイル名({フィールドコード}・{$id}。拡張子は形式に合わせて付く) |
templates[].output.download | 真偽値 | 任意 | ブラウザでダウンロードする |
templates[].output.attachFieldCode | 文字列 | 任意 | 保存する添付ファイルフィールド(空 = 保存しない) |
プラグイン設定画面の上部にある「設定のインポート / エクスポート」から、現在の設定を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())。
帳票出力を含む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-11-20 / 対象バージョン: v2.0.2