このセクションの記事

[toc]

 

概要

このページでは、ViewFramerを利用して複数のkintoneアプリからデータを抽出し、帳票を出力する実装方法を紹介します。 
複数アプリのデータを柔軟に組み合わせ、リストビュー上の複数レコードを明細行として帳票出力する方法を学びます。

💡
補足

ViewFramerの概要については、「ViewFramerとは」をご覧ください。

 

準備の流れ

ViewFramerを使用した帳票出力には、以下のステップで準備が必要です。

  1. OPROARTS Liveにてテンプレート作成
  2. ViewFramerにて認証設定を定義
  3. ViewFramerにてビューを定義
  4. ViewFramerにてマッピングを定義
  5. kintoneのボタン作成および配置後、出力

 

1. OPROARTS Liveにてテンプレート作成

帳票のレイアウトのひな形（テンプレート）を用意する必要があります。

テンプレートは、デザインツール「OPROARTS Live」で作成します。

PDF用のテンプレートは、デザイナー画面上で作成するか、既存のExcelシートを読み込む方法があります。

ここでは、デザイナー上で作成する方法を説明しますが、1から作成するのではなく、サンプルを使用します。

帳票デザイン後に、帳票上の項目とフィールドを紐づける「マッピング」作業を行います。

 

2. ViewFramerにて認証設定を定義

ViewFramerにログイン後、kintoneへログインし、帳票に使用するアプリのAPIトークンを登録します。 
本記事では、複数アプリ「案件管理」、「顧客管理」、「活動履歴」を利用しますので、下記kintone側の定義を3回繰り返します。

⚠️
注意

kintone、ViewFramerそれぞれに定義項目がありますので注意してください。 
帳票にて利用するアプリ全てに対して定義が必要です。

kintone側の定義

  1. kintoneへログインし、帳票にて利用するアプリより「設定」を開きます。

     

  2. 「設定」タブより「APIトークン」を開きます。

     

  3. 「生成する」ボタンをクリックしレコードを生成し「保存」します。

    この時、「レコードの閲覧」「レコードの編集」にチェックしてください。同時にレコードIDをコピーします。


     

  4. 保存後、アプリ設定画面より「アプリを更新」します。

     

ViewFramer側の定義

ViewFramerの認証設定に戻り、帳票にて利用するアプリの「トークン」に生成したレコードのIDを設定し「保存」します。

💡
補足

複数アプリを利用する場合は、各アプリに対して上記の手順を繰り返してください。

 

3. ViewFramerにてビューを定義

ViewFramer上でビューを作成します。一つのビューの中で、複数のアプリをリレーションすることができます。

ビューの作成

  1. ViewFramerへログインします。

  2. 「ビュー」タブより「新規」を選択します。

 

基本設定

ビュー定義内の「基本設定」にて「ビュー名」（任意）を指定します。

 

リレーション設定

ビュー定義内の「リレーション設定」で以下項目を指定します。

💡
補足

ViewFramerの画面上ではkintoneの「アプリ」を「オブジェクト」と表記している箇所があります。

項目 説明
主オブジェクト 起点となるアプリを選択し、ショートネームを入力します。 
この例では「案件管理」を指定しています。
関連オブジェクト 起点となるアプリに関連付けるアプリを指定します。 
この例では「顧客管理」「活動履歴」を指定しています。
結合条件 各「項目名」「演算子」「オブジェクト」「項目名」について、参照項目とアプリを結びつける条件を指定します。

リレーションを追加する際には「＋」ボタンをクリックし追加します。 
全ての設定終了後、「次へ」をクリックします。

 

出力項目設定

ビュー定義内の「出力項目設定」で以下項目を指定します。

  • 取得元オブジェクトを指定します。
  • 「項目ビルダー」でkintoneの項目を指定します。（「全項目を追加」も可能です）

💡
補足

OPROARTS Liveにて作成したテンプレート上で定義されているフィールド名と同じにしておけば、後で自動マッピングが可能になります。

 

出力条件設定

ビュー定義内の「出力条件設定」ではレコードの抽出条件を指定することができます。 
必要に応じて条件を設定してください。

全ての設定終了後、「保存」をクリックします。

 

4. ViewFramerにてマッピングを定義

「マッピング」は、ViewFramer呼び出し時に実行される単位です。 
kintoneのボタンからは、ViewFramerのマッピング名を指定する形になります。

複数のビューをヘッダーや明細として割り当てたり、OPROARTS Liveで作成したテンプレート上の項目とのマッピングを行ったりします。 
詳細な設定手順については、「ViewFramerガイド」の20ページ以降をご参照ください。

 

5. kintoneのボタン作成および配置後、出力

テンプレートとViewFramerの定義を用意できたら、あとはkintone上にボタンを配置すれば完了です。 
設定手順については、「ViewFramerガイド」の25ページ以降を参照ください。

実際にkintoneから呼び出すと、複数のアプリから取得したデータを、リストとしてまとめて出力することができます。

 

💡
補足

ViewFramerはPDF以外の様々な形式で帳票を作成できます。 
また、帳票だけでなく、BIやD3Workerにも連携することが可能です。

 

関連記事