【kintoneプラグイン】ルックアップforフィールドV マニュアル
この記事では、kintone用プラグイン「ルックアップforフィールドV」のインストールと利用方法について説明します。インストール手順はYouTubeにも動画で解説していますので、あわせてご覧ください。
プラグインの入手
プラグインの入手には登録が必要です。以下の記事に埋め込まれたフォームから必要事項を記入して、登録完了メールを受け取ってください。登録完了メールの本文にプラグインが保存されたURLが載っているので、URLをクリックしてプラグインのファイルをダウンロードしてください。
プラグインのインストール
プラグインをインストールしたいkintoneアプリを開き、画面右上の歯車アイコンのメニューアイテム「kintoneシステム管理」を選択します。
kintoneシステム管理画面の左下のメニュー「プラグイン」を選択します。
プラグイン画面で、左上の「読み込む」ボタンを押します。
表示された「プラグインの読み込み」ダイアログの「参照」ボタンを押して、先ほどダウンロードしたプラグインのzipファイル(展開しなくても大丈夫ですよ!zipファイルのままで結構です)を選択し、下の「読み込む」ボタンを押します。
プラグイン画面に「ルックアップforフィールドV」が表示されたらアップロードは成功です。プラグインをインストールしたアプリに戻りましょう。
アプリの設定
プラグイン設定の前に、必要フィールドを3つ、アプリ内で追加しましょう。
1. チェックボックス
→ONにしたイベントをトリガーとして、ダイアログが表示されます。名前は何でも構いません。✓のような記号でもいいですよ。
2. ルックアップ
→ルックアップ先レコード選択画面を高機能なデータグリッドに差し替えます。名前は何でも構いません。
3. スペース
→スペースフィールドの要素IDに「sp_lookup_search」と入れてください。
スペースの設定
配置する場所はどこでもよいので、スペースのコンポーネントを置いた後、それに「sp_lookup_search」と要素IDを設定してください。
プラグインの設定
プラグインをインストールしたいアプリを選択し、歯車アイコン(の、右側の下矢印プルダウンアイコン)から「カスタマイズ/サービス連携」→「プラグイン」を選択します。
プラグイン画面の左側、「+追加する」リンクをクリックしてください。
プラグインの追加画面で「ルックアップforフィールドV」の左側のチェックボックスをクリックして、画面右下の「追加」ボタンを押してください。
アプリに戻ると、アラートが表示されますが、設定後にアプリの更新をしましょう。今は画面右上の歯車アイコンから「プラグイン」画面へ移動します。
アプリの設定画面で「アプリを更新」ボタンをクリックした後、またプラグイン画面へ戻って、プラグインの歯車アイコンをクリックしてください。
プラグインの設定画面では、必須項目(赤のアスタリスクが付いた項目)を設定します。
ライセンスキー
体験版申し込み時のメールに書かれたライセンスキーを入力します。
タブ
アプリ内のルックアップフィールド名が表示されます。最大5つまで設定可能です。アプリに5つ以上のルックアップフィールドがある場合、画面上部から数えて5つまでが表示されます。
プラグインを適用するルックアップ
対象となるアプリ内のルックアップが選択されています(この項目は読み取り専用です)。
プラグインを起動するチェックボックス
上の手順で設置したチェックボックスが選択肢として表示されます。
表示するフィールド
データグリッド内で表示するフィールドを指定します。右側の「+」「ー」ボタンで表示フィールドの増減ができます。
ソートするフィールド
データグリッドの初期表示時、最初にどのカラムがソートされている状態で表示されているかを設定します。
1ページに表示するレコード数
1画面で表示するレコード数を選びます。
設定終了後、「Save」ボタンを押したら、またアプリを更新してください。ここからはダイアログ表示のラッシュです。面倒ですが、がんばって!
↓
すると、画面上部にダイアログが表示されます。「アプリの設定」リンクをクリックしてください。
↓
↓
↓
↓
お疲れ様でした!面倒でしたね。これでプラグインの設定は完了です。
プラグインの使用方法
「ルックアップforフィールドV」のダイアログは以下の画像のように表示されます。kintoneの標準ルックアップ先レコード選択ダイアログとの大きな違いは、カラムごとに検索条件を設定できること、そしてページネーションができることです。
次からは、それぞれの機能について説明していきます。
レコードの選択
レコード(行)をクリックすることで選択します。ルックアップforテーブルVプラグインと異なり、複数レコードの同時選択はできません。
レコードの選択が終わった後に「OK」ボタンを押すと、選択したレコードがフィールド上に反映されます。
フィルタリング
フィルターには、文字列、数値、日付の3つの種類があります。カラムの型により適切なフィルターがヘッダに表示されます。
文字列検索
対象フィールドのヘッダの2行目に表示されているテキスト入力ボックスに直接文字列を入力する方法が一番早いフィルタの操作です。
しかしこの方法は、フィルターの種類としては「を含む」のみなので、他のフィルター条件で検索したい場合は、以下の操作でフィルターの種類を選んでください。
文字列フィールドのヘッダに表示されている漏斗アイコンをクリックすると、メニューが表示されます。
セレクトボックスから以下のメニューアイテムのうち1つを選びます。
その下の入力ボックスから、検索したい文字列を入力します。
最後に「適用」ボタンを押すと、フィルターが実行されます。
メニューを閉じる場合は、メニュー以外のどこかをクリックしてください。入力した日付やフィルター条件を消したい場合は、「リセット」ボタンを押してください。
文字列フィルタには、以下の種類があります。
・を含む
入力した文字列が含まれるレコードを抽出します。
・を含まない
入力した文字列が含まれないレコードを抽出します。
・等しい
入力した文字列と完全に一致するレコードを抽出します。
・等しくない
入力した文字列と完全に一致しないレコードを抽出します。
・で始まる
入力した文字列で始まるレコードを抽出します。
・で終わる
入力した文字列で終わるレコードを抽出します。
・空白
何も入力されていないレコードのみ抽出します。
・空白ではない
空白以外のレコードのみ抽出します。
数値検索
対象フィールドのヘッダの2行目に表示されているテキスト入力ボックスに直接数値を入力する方法が一番早いフィルタの操作です。(*1)
(*1. 数値の場合は、エンターキーで確定します。)
しかしこの方法は、フィルターの種類は「= 等しい」だけなので、他のフィルター条件で検索したい場合は、以下の操作でフィルターの種類を選んでください。
文字列フィールドのヘッダに表示されている漏斗アイコンをクリックすると、メニューが表示されます。
セレクトボックスから以下のメニューアイテムのうち1つを選びます。
その下の入力ボックスから、検索したい文字列を入力します。
最後に「適用」ボタンを押すと、フィルターが実行されます。
メニューを閉じる場合は、メニュー以外のどこかをクリックしてください。入力した日付やフィルター条件を消したい場合は、「リセット」ボタンを押してください。
フィルタには以下のような種類があります。
・指定値を含む範囲
入力した2つの値の間の値を持つレコードを抽出します。これには入力したそれぞれの値も含みます。
・= 等しい
入力した値と同じレコードのみ抽出します。
・≠ 等しくない
入力した値以外のレコードのみ抽出します。
・< より前
入力値より小さい値のレコードを抽出します。入力値は含みません。
・> より後
入力値より大きい値のレコードを抽出します。入力値は含みません。
・≦ 以前
入力値より小さい値のレコードを抽出します。入力値を含みます。
・≧ 以降
入力値より大きい値のレコードを抽出します。入力値を含みます。
日付検索
対象フィールドのヘッダの2行目に表示されているテキスト入力ボックスに直接数値を入力する方法が一番早いフィルタの操作です。
しかしこの方法は、フィルターの種類は「= 等しい」だけなので、他のフィルター条件で検索したい場合は、以下の操作でフィルターの種類を選んでください。
日付フィールドのヘッダに表示されている漏斗アイコンをクリックすると、メニューが表示されます。
セレクトボックスから以下のメニューアイテムのうち1つを選びます。
その下の日付ボックスから、対象となる日を指定します。
右側のカレンダーアイコンをクリックすると、カレンダーが表示されます。
キーボードから日付を直接入力したい場合は、年/月/日 のいずれかをクリックして、キーボードから数値を入力してください。矢印キーの左右で隣の入力エリアにフォーカスが移ります。最後に「適用」ボタンを押すと、フィルターが実行されます。メニューを閉じる場合は、メニュー以外のどこかをクリックしてください。
入力した日付やフィルター条件を消したい場合は、「リセット」ボタンを押してください。
日付検索フィルターには以下の種類があります。
・指定日を含む範囲
下に表示されている2つの日付入力欄に、開始日と終了日を入力します。表示される範囲には、開始日と終了日が含まれます。例)開始日=2023/5/1、終了日=2023/5/31 とした場合は、2023/5/1から2023/5/31までの日付を含むレコードが抽出されます。
・= 等しい
入力した日付と同じレコードのみ抽出します。
・≠ 等しくない
入力した日付以外の日付を持つレコードのみ抽出します。
・< より前
入力した日付の前日以前のレコードを抽出します。入力日は含みません。
・> より後
入力した日付の翌日以降のレコードを抽出します。入力日は含みません。
・≦ 以前
入力日と、その前日以前のレコードを抽出します。入力日を含みます。
・≧ 以降
入力日と、その翌日以降のレコードを抽出します。入力日を含みます。
・空白
対象となるフィールドから、空白(日付が保存されていない)レコードのみ抽出します。このフィルターを動作させるには、年/月/日 のフィールドに適当な値を入力する必要があります(この手順は今後、修正される予定です)。
・空白ではない
対象となるフィールドから、空白以外のレコードを抽出します。このフィルターを動作させるには、年/月/日 のフィールドに適当な値を入力する必要があります(この手順は今後、修正される予定です)。
複数のフィルタ条件
フィルタ検索には、複数のフィルタ条件を指定することができます。
まずひとつ目のフィルタ条件を入力すると、ANDとORのラジオボタンが表示されますので、どちらかを選択後、ふたつ目の条件を指定します。
ページング
ダイアログの右下に表示されている矢印ボタンを使って、次のページ・前のページへ移動します。
1度に表示する項目数は、プラグインの設定画面で「1ページに表示する件数」で調整できます。
ソート
プラグインの設定画面でデフォルトのソートフィールド・順番を設定できる他、ダイアログ上でカラムのヘッダをクリックすることでもソートが可能です。
・ソート順
ヘッダのカラムを一度押すと昇順、もう一度押すと降順
・複数カラムのソート
既に1つのカラムがソートされている状態で、Shiftキーを押しながら別のカラムをクリックすると、そのカラムにもソートが指定されます。ソートの順番はカラムに番号が表示され、最初にソートを指定したカラムが1、その次が2…と表示されます。
制限事項
ルックアップ参照先アプリに閲覧権限が必要です。
ユーザーは、ルックアップ参照先アプリ(関連付けるアプリ)に閲覧権限が必要です。閲覧権限が設定されていないとレコードが表示されず、コンソールに以下のエラーが表示されます。
ルックアップ参照先アプリの「アプリの設定→アプリのアクセス権」画面から、利用中のユーザーに「レコード閲覧」にチェックが入っていることを確認してください。
KintoneRestAPIError: [403] [CB_NO02] 権限がありません。 (SR1TzUss3gyFNPis5XXO)
ルックアップ参照先アプリのフィールドを重複禁止にしておく必要があります。
このプラグインは、ルックアップの検索結果が1件の場合のみ、自動取得できます。したがって、検索結果と一致するレコードが複数ある場合、正確な自動取得ができません。
※コピー元のフィールドを「値の重複を禁止する」に設定することで、回避できます。
ダイアログ表示項目に、自動で追加されるフィールドがあります。
ルックアップの設定内「コピー元のフィールド」として選択されているフィールドは、プラグイン設定内「表示するフィールド」で非選択項目であってもダイアログの先頭列に表示されます。
例: ルックアップの設定内「コピー元のフィールド」に会社名を選択し、プラグイン設定内「表示するフィールド」に会社名・担当者名を選択している場合、ダイアログには、会社名・会社名・担当者名が表示され、同じフィールドが2列重複して表示されます。
ダイアログの表示が期待通りにならない場合、こちらの制限事項をご確認ください。
フィールドコード変更時は再設定が必要です。
プラグイン設定後にプラグインを適用するチェックボックス、ルックアップのフィールドコードを変更した場合は、プラグインの再設定が必要です。
選択できないフィールドの形式があります。
プラグイン設定画面の「表示するフィールド」設定項目では、ルックアップ参照先アプリのフィールドのうち、以下の形式は選択できません。
・添付ファイル FILE
・リッチエディター RICH_TEXT
・テーブル SUBTABLE
・関連レコード一覧 REFERENCE_TABLE
・カテゴリー CATEGORY
・ステータス STATUS
・作業者 STATUS_ASSIGNEE
・フォームを装飾するフィールド(ラベル、スペース、罫線、グループ)
紐付けられるルックアップフィールドは1アプリに5つまでです。
このプラグインと紐付けられるルックアップフィールドは、1アプリにつき5つまでです。
アプリに5つ以上のルックアップフィールドがある場合、画面上部から数えて5つまでが表示されます。
6つ目を指定したい場合、上から5つに収まるようにアプリの設定から表示順番を変更してください。例えば、上から6つ目を指定する場合は、5つ目と入れ替えてください。
お問い合わせ
当プラグインの不明点、質問などがありましたら kintone-contact@vips.co.jp までお問い合わせください。その他、kintoneやローコード・ノーコードツールのシステム開発はヴィップシステム株式会社公式Webサイトからお問い合わせください。
記事作成
kintone推進チーム
使用画像
UnsplashのLuisa Brimbleが撮影した写真