プラグイン設定画面

¶プラグインを設定するアプリ

プラグインをインストールして設定するアプリは、データフロー処理を起動するアプリです。

たとえば、顧客管理アプリにレコードが追加されたことを契機に取引先台帳や請求データを更新する場合、プラグインは顧客管理アプリに設定します。

「データを出力したいアプリ」ではなく、「処理を起動するアプリ」にプラグインを設定します。起動アプリを誤ると、想定したタイミングでジョブが実行されません。

¶画面構成と基本操作

データフロープラグインの設定画面を開くと、設定済みのジョブとデータフローの一覧が表示されます。各ジョブ配下に複数のデータフローを持たせられるようになっており、処理の責務ごとにフローを分けて管理できます。例えば1つ目のジョブで顧客台帳を整備し、2つ目のジョブで請求データを作成する、といった構成にできます。

¶ジョブの追加

「ジョブ追加」ボタンをクリックすると、ジョブを追加するためのダイアログが開きます。

「ジョブを作成」または「ジョブを作成してフロー追加」ボタンを押すとジョブが作成されます。
「ジョブを作成してフロー追加」ボタンを押すとフローエディターが表示されてそのままフローの作成を開始できます。

¶ジョブの操作

ジョブが作成されると、ジョブ一覧にジョブが追加されます。「ジョブ操作」列のメニューから、ジョブの編集や削除が行えます。

¶データフローの追加

「データフローを追加」ボタンをクリックすると、データフローの追加ダイアログが表示されます。
新規のフローを追加するか、既存のフローをコピーして追加するかを選択できます。

「既存のフローをコピーして追加」を選択した場合、ドロップダウンにコピー元にできるデータフローの一覧が表示されます。
ジョブの実行契機カテゴリーが一覧画面のボタン押下の場合、同じ一覧画面のボタン押下カテゴリーのジョブのデータフローのみコピー元として選択できます。ジョブの実行契機カテゴリーがイベント（詳細画面のボタン押下含む）の場合、すべてのジョブのデータフローをコピー元として選択できます。

「フロー追加」ボタンをクリックすると、データフローエディターに遷移し、データフローを編集できます。

ジョブの実行契機カテゴリーがイベント（詳細画面のボタン押下含む）で、コピー元のデータフローのジョブの実行契機カテゴリーが一覧画面のボタン押下の場合、アプリ入力の「使用するレコードの選択」は引き継がれないため、再度設定する必要があります。

¶データフローの操作

「データフロー操作」列のメニューから、データフローの編集や削除が行えます。

¶データフローの状態

データフローの状態をアイコンで表示します。

アイコン	説明
	データフローの設定が正常で実行可能です。
	データフローの設定に不備があるため実行できません。データフローエディターを開き、設定を修正してください。
	データフローの状態が不明です。データフローエディターを開き、状態を確定させてください。

「状態」はデータフローエディターで最後にフローを保存した時点の検証結果が表示されます。ジョブ設定画面を表示した時点で再検証されるものではありません。フローの保存後に参照先アプリの設定を変更などした場合は、データフローエディターを開いて内容と検証結果を確認し、改めて保存してください。
また、「設定をファイルからインポート」ボタンによりインポートされたフローの状態は「不明」になります。同様にデータフローエディターを開いて内容と検証結果を確認し、改めて保存してください。

¶プラグイン設定関連ボタン

設定画面下部にプラグイン全体の設定に関するボタンが表示されます。

¶「保存する」ボタン

プラグインの設定を kintone に保存し、プラグイン設定画面を抜けます。

¶「キャンセル」ボタン

プラグインの設定を保存せず、プラグインの設定画面を抜けます。

¶「設定をカスタマイズに保存する」ボタン

プラグインの設定をアプリのJavaScriptカスタマイズとして保存します。
カスタマイズとして保存することにより、アプリテンプレートにプラグイン設定を含めることができます。

「設定をカスタマイズに保存する」ボタンでカスタマイズとして保存しても kintone のプラグイン設定としては保存されません。

本プラグインでは、アプリIDを設定に持つため、カスタマイズとして設定を保存したアプリテンプレートを同一または別ドメインで展開して「設定をカスタマイズから読み込む」を実行しても、正常に動作しません。設定を別のアプリに適用する場合は、「設定をファイルにエクスポート」「設定をファイルからインポート」ボタンを使用して設定のエクスポートとインポートを実施してください。

¶「設定をカスタマイズから読み込む」ボタン

アプリのJavaScriptカスタマイズとして保存された設定を読み込み、プラグインの設定を更新します。

¶「設定をファイルにエクスポート」ボタン

プラグインの設定をファイルにエクスポートします。エクスポートするジョブ設定を選択することが可能です。

¶「設定をファイルからインポート」ボタン

プラグインの設定をファイルからインポートします。インポートするジョブ設定を選択することが可能です。
また、設定中のアプリIDをインポート先の環境に合わせて編集することができます。
インポートしたジョブ設定を現在のジョブ設定に追加するか、上書きするかを選択できます。

インポートされたデータフローの状態は「不明」となります。データフローエディターで開き、フローを保存することにより状態が「正常」または「エラー」に確定します。

インポートが正常に行われた場合でも、kintone には設定が保存されていません。「保存する」ボタンで設定を保存してください。

¶データフローエディター

ジョブ内のデータフローを開くと、データフローエディターが表示されます。エディターでは、様々な処理を設定によって行うプロセッサーをノードとして配置し、キャンバス上で処理順をつなぎ、右側の詳細設定パネルで各プロセッサーの設定を行います。

¶ツールバー

キャンバス上のツールバーには、データフローの編集を補助する操作がまとまっています。

• 元に戻す、やり直しで、フローエディター上の直前の編集操作を戻したり再適用したりできます。詳細設定パネルでの入力や変更は対象外です。
• 表示位置を中央へ移動して、作成中のフロー全体を見つけやすくできます。
• キャンバス を最大化して、広い画面でデータフローを編集できます。
• 拡大・縮小で、エディターのキャンバス表示倍率を調整できます。

• フロー検証では、プロセッサー同士の結線によってレーンが複数ある場合や、設定に矛盾がある場合のエラーを確認できます。正常な場合は緑色の表示で「フローは正常です」とポップアップ表示され、エラーがある場合は赤い注意アイコンからポップオーバーでエラー内容を確認できます。

• 複数のプロセッサーを選択して、左揃え、右揃え、中央揃えに整列できます。
• 3つ以上のプロセッサーを選択して、横方向または縦方向に均等配置できます。
• ポインターモードとハンドモードを切り替えられます。ポインターモードではプロセッサーや線の選択・編集を行い、ハンドモードではキャンバスの移動を中心に操作します。
• プロセッサーを上下左右に整列して、処理の流れを見やすくします。

¶詳細設定パネル

プロセッサーを選択すると、画面右側の詳細設定パネルに設定項目が表示されます。設定項目はプロセッサーごとに異なります。

設定項目については各プロセッサーを参照してください。

¶プレビューパネル

画面下部のプレビュー領域では、選択中プロセッサーまでの処理結果を確認できます。詳細設定パネルで設定を変更すると、リアルタイムで処理結果が表示されます。アプリ入力が取得するレコード数は最大500件です。他のプロセッサーを経由することで、プレビューに表示されるレコード数は増減します。

フィールドの表示オプションとしてラベルのみ表示とフル表示を切り替えられます。

• ラベルのみ表示: フィールドのラベルのみヘッダに表示します。
• フル表示: フィールドのラベルとフィールドコードとフィールドタイプをヘッダに表示します。

プレビューで件数や値を確認しながらプロセッサーを調整すると、実行前に設定ミスを見つけやすくなります。

プレビューではアプリ入力が取得するレコード数が最大500件のため、すべてのレコードを取得していない場合があります。そのため、グループ集計プロセッサーの集計値が実際の処理結果と異なる場合があります。また、アプリ出力プロセッサーの保存先レコードIDはダミーデータが設定されます。

¶メモ

ツールバーの鉛筆マークから、キャンバス上にメモを配置できます。

メモは、処理ロジックには影響しない作業用メモです。キャンバス上に配置して、設計意図、確認事項、未決事項、運用メモを残せます。

メモはリッチテキスト編集に対応し、太字、イタリック、打ち消し線、フォントサイズ調整、背景色の変更ができます。ジョブやプロセッサーより背面に配置されるため、処理の流れを隠しにくい設計です。

メモは連結性チェックや開始点・終了点チェックの対象外です。メモに線を接続しても処理ロジックには含まれません。

¶キーボード・マウス操作

データフローエディターでは、マウスやキーボードを使用した以下の操作に対応しています。

拡大・縮小、元に戻す、やり直しの操作は、Mac環境では Ctrl キーの代わりに ⌘（Command）キーも使用できます。