# PDF帳票出力 詳細マニュアル | 設定リファレンス・トラブルシューティング - KINTAUROS

> kintoneプラグイン「PDF帳票出力」の詳細マニュアル。全設定項目のリファレンス(意味・制約値)、動作条件・制限事項、エラーコード別のトラブルシューティングを掲載。対象バージョン: v1.7.0。

元ページ: https://kintauros.com/plugins/pdf-report/manual/

PDF帳票出力は、お手持ちのPDFをテンプレートとしてアップロードし、レコードの値を差し込んで見積書・請求書などの帳票を出力するプラグインです。このマニュアルでは、設定項目のリファレンスと、動作仕様・制限事項・トラブルシューティングを説明します。

機能紹介・画面イメージ・導入手順は[プラグイン紹介ページ](https://kintauros.com/plugins/pdf-report/)を、ダウンロードは[ダウンロードページ](https://kintauros.com/download/)をご覧ください。このマニュアルは[Markdown版](index.md)でも提供しており、全プラグインのメタ情報と設定スキーマは機械可読な[catalog.json](https://kintauros.com/catalog.json)から取得できます。

## 基本情報

- **プラグイン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](https://kintauros.com/catalog.json) の configSchema)として公開しています。

- **項目**: 型 / 必須 / 説明・制約

- **version**: 整数 / 任意 / 設定形式のバージョン / 固定値: 1

- **templates**: 配列 / 必須 / 帳票テンプレート / 1件以上

- **templates[].name**: 文字列 / 任意 / テンプレート名

- **templates[].pdf**: オブジェクト / 任意 / テンプレートPDF

- **templates[].pdf.base64**: 文字列 / 任意 / PDFファイル本体(base64)

- **templates[].items**: 配列 / 任意 / 配置アイテム(フィールド・固定テキスト等)

- **templates[].tables**: 配列 / 任意 / テーブル領域

- **templates[].output**: オブジェクト / 任意 / 出力設定(ファイル名・添付先など)

## 設定のポイント

- テンプレートPDFは設定内にbase64形式で埋め込まれます。このため設定のエクスポートファイルにはテンプレートPDF本体も含まれ、ファイルサイズが大きくなることがあります。

- 差し込み枠の座標系はPDFポイントです。設定画面のプレビュー上でドラッグして配置・サイズ変更するのが基本操作で、座標を手で編集する必要はありません。

- テンプレートPDFのファイルサイズには上限があります。上限を超えるPDFを選ぶと設定画面で警告が表示されるので、画像の圧縮などでサイズを下げてください。

- 設定画面の「テスト出力」で、保存前に差し込み結果を確認できます。

## 動作仕様

- レコード詳細画面の出力ボタンを押すと、テンプレートを選んでその場でPDFを生成します。生成されたPDFはダウンロードのほか、設定に応じてレコードの添付ファイルフィールドへ自動保存できます。

- サブテーブルの明細行は、指定した行送りで繰り返し差し込まれます。

- 1つのアプリに複数のテンプレートを登録でき、出力時に選択できます。

## 制限事項・既知の仕様

- モバイルアプリの画面では動作しません(デスクトップ版UIのみ)。

- 添付ファイルフィールドへの保存には、実行するユーザーにそのレコードの編集権限が必要です。権限がない場合、保存はエラーになります。

- テンプレートPDFは設定に埋め込まれるため、テンプレートの数・サイズが大きいほど設定の保存・読み込みに時間がかかります。

## 設定のインポート / エクスポート

プラグイン設定画面の上部にある「設定のインポート / エクスポート」から、現在の設定をJSONファイルとして書き出し(エクスポート)、別のアプリで読み込み(インポート)できます。検証用アプリから本番アプリへの設定コピーや、バックアップ・復元にご利用ください。

- インポートは取り込む内容の差分を確認してから「設定画面に反映」し、最後に「保存」を押して確定します(反映しただけでは保存されません)。

- 読み込んだファイルはブラウザ内で処理され、KINTAUROSのサーバーには送信されません。

- 別のアプリの設定を取り込んだ場合、このアプリに存在しないフィールドは警告として一覧表示されるので、反映後に該当箇所を選び直してください。

エクスポートファイルは次の形式(封筒形式)です。config の中身が設定本体で、その構造は上の設定項目リファレンスのとおりです。

```
{
  "kintauros": "config/v1",
  "plugin": "<プラグインID>",
  "pluginName": "<プラグイン名>",
  "pluginVersion": "<バージョン>",
  "exportedAt": "<書き出し日時(ISO 8601)>",
  "sourceApp": "<書き出し元アプリID>",
  "config": { ... 設定本体 ... }
}
```

### AIエージェント向け: ブラウザコンソールAPI

各プラグインは共通ランタイム 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をアップロードできない・「サイズ上限」の警告が出る**

テンプレートPDFのサイズが上限を超えています。PDF内の画像を圧縮する、不要なページを削除するなどでファイルサイズを下げて再度アップロードしてください。

**添付ファイルフィールドへの保存に失敗する**

実行したユーザーに対象レコードの編集権限があるか確認してください。編集権限がないユーザーはPDFのダウンロードはできますが、添付ファイル欄への保存はできません。

**設定の保存に失敗する(E103)**

テンプレートPDFが大きすぎて設定サイズの上限を超えている可能性があります。テンプレートの数を減らすか、PDFのファイルサイズを下げてから保存し直してください。

**出力したPDFで文字が化ける・欠ける**

本プラグインは日本語フォント(Noto Sans JP)を同梱しており、通常の日本語・英数字は問題なく出力できます。差し込み枠の幅が狭いと文字が収まらないことがあるため、プレビューで枠のサイズとフォントサイズを調整してください。

## エラーコードと診断情報

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"}}
```

各エラーコードの意味と対処は[エラーコード一覧](https://kintauros.com/docs/errors/)を参照してください。また、プラグイン設定画面の「サポート用情報をコピー」から、環境・バージョン・ライセンス状態・直近のエラーを含む診断情報をコピーできます(レコードの内容や個人情報は含まれません)。お問い合わせの際はこの情報を添えてください。

## ライセンスについて

- 初回利用時は、プラグイン設定画面の「利用開始」ボタンから60日間の無料トライアルを開始できます(カード登録不要)。

- トライアル・契約の期限が切れるとプラグインの動作は停止し、画面に案内が表示されます。[料金プラン](https://kintauros.com/#pricing)から契約すると同じ設定のまま再開できます。

- ライセンス確認のための外部通信で送信されるのは、kintoneドメイン名・プラグインID・バージョンのみです。レコードの内容や個人情報が外部に送信されることはありません。

- ライセンスサーバーに一時的に接続できない場合も、プラグインは一定期間動作を継続する設計です。

## サポート

解決しない場合は[お問い合わせ](https://kintauros.com/contact/)からご連絡ください。その際、プラグイン設定画面の「サポート用情報をコピー」でコピーした診断情報を添えていただくと、調査がスムーズです。

最終更新: 2026-08-14 / 対象バージョン: v1.7.0