組織ルックアッププラグイン
文字列1行または組織選択フィールドに入力された「組織コード」をもとに、組織名・説明・親組織の情報を 取得し、別の文字列フィールドへ自動入力するプラグインです。親組織が設定されている場合は親組織の 情報も1階層分だけ取得します(親のさらに親〈祖父にあたる組織〉までは遡りません)。設定したボタンを 押したとき、またはレコード保存時に反映できます。
ユースケース
申請フォームや台帳アプリなどで、担当部署の組織コードを文字列フィールドに入力するだけで、正式な組織名や説明文を別フィールドへ自動入力できます。組織名の表記ゆれを防ぎたい場合に活用できます。
組織選択フィールドで部署を選ぶと、その部署名だけでなく、直属の親組織(部の下の課であれば「部」)の名称も別フィールドへ自動入力できます。組織階層をまたいだ集計・絞り込み用の文字列フィールドとして活用できます(親のさらに親までは取得しません)。
セットアップ手順
- 「ボタン押下時」を使う場合は、アプリのフォーム編集で「スペース」フィールドを1つ配置し、要素IDを設定する(組織情報取得ボタンが表示される場所になります)。
- プラグインをアプリに追加し、設定画面を開く。
- 「+ 設定行を追加」で設定行を作成し、①元フィールド(組織コードが入力される文字列1行、または組織選択)→②発動条件(ボタン押下時/保存時)→③出力先フィールドを編集可能にするか→④転記項目(取得する項目→出力先フィールド)の順に設定して保存する。
- 保存後、アプリを更新する(kintoneのアプリ設定は保存しただけでは反映されず、更新〈デプロイ〉して初めてレコード画面に反映されます)。
元フィールドは、レコード一覧のインライン編集では常に編集できなくなります。該当する組織が見つからない場合(未入力を含む)、出力先フィールドはすべて空でクリアされます。親組織が設定されていない場合、親組織関連の項目も空になります。
セキュリティレビュー結果サマリ
kintoneセキュアコーディングガイドラインに沿って実装時にチェックしています。特に重要な点は次のとおりです。
- 組織コードから組織そのものを取得するJavaScript APIが存在しないためOrganization API(REST)を使いますが、呼び出しは必ず
kintone.api()(kintone自身への呼び出し専用の内部ラッパー)のみを使用しています。外部サーバーへの通信は一切行わず、外部ライブラリも使用していません。 - 親組織の取得は組織自身に親組織コードが設定されている場合のみ1回だけ行い、親組織のさらに親(祖父にあたる組織)を取得することは絶対にありません。この階層制御ロジックはユニットテストでモックにより確定的に検証しています。
- 設定画面でのフィールド一覧・エラーメッセージの描画、出力先フィールドへの値の書き込みは、いずれも
innerHTMLではなくtextContentやkintone標準のフィールド値レンダリングを経由しており、DOMへ構造として解釈されません。 - 保存前のバリデーションで、元フィールド・出力先フィールドの型制約(元フィールドは文字列1行/組織選択、出力先は文字列1行のみ)、ボタン押下時の設置スペース必須・重複禁止、転記項目0件・出力先の重複などの不正な設定を検出して保存させません。
- 出力先フィールド・元フィールドの編集禁止はJavaScript APIによるUIレベルの制御であり、「不正操作を防ぐ」機能ではなく「通常操作でのミスを防ぐUI上の制約」です。出力先フィールドのアクセス権(誰が閲覧できるか)はアプリ管理者が別途適切に設定してください。
詳細な確認項目・確認日は下記GitHubのチェックリストに全項目を掲載しています。
設定画面イメージ
API実行数について
このプラグインは、組織名・説明等の取得のためにOrganization API(GET /v1/organizations.json、
内部向けラッパーのkintone.api()経由)を実行します。「ボタン押下時」を選んだ設定行は
ボタンを押すたびに、「保存時」を選んだ設定行はレコード保存のたびに実行されます。組織自身に親組織
コードが設定されている場合は、親組織の取得のためにもう1回追加実行されます(最大2回。親のさらに親を
取得することはありません)。