ルックアップ項目きっかけ処理

概要

ルックアップ項目きっかけ処理を設定すると、項目の選択肢を動的に変更できます。選択リスト（ドロップダウン）の種類の項目において、ユーザーが入力した内容に合わせて選択肢の候補を絞り込んで表示することが可能です。選択肢には、外部サービスから最新の値を取得して表示させることも可能です。活用例としては、以下のようなものがあります。

ある項目の選択肢に、外部サービスからリアルタイムで取得した最新の値を表示させたいとします。このような場合、ルックアップ項目きっかけ処理を設定すると、簡単に処理を設定できます（メニュークリックきっかけ処理やフォーム変更きっかけ処理でも同様の処理を設定できますが、よりスムーズに設定できます）。
たとえば、項目の値が3,000件超あり、一気に取得して読み込もうとすると、画面が適切に動かなくなるとします。このような場合、ルックアップ項目きっかけ処理を使用すると、実行時にすべての選択肢を表示するのではなく、ユーザーが入力した内容に合致する選択肢のみを表示することができます。

ルックアップ項目きっかけ処理を有効にする方法

該当の項目オブジェクト内でパラメーター「lookup」の値を「true」に設定します。なお、「triggerLength」では、何文字入力されたらルックアップ項目きっかけ処理を実行するかについての値を指定します。

ルックアップ項目きっかけ処理の実行タイミング

ルックアップ項目きっかけ処理は、ユーザーによって項目にテキスト（文字列）が入力されると実行されます。入力テキストには、最小文字数を設定することもできます。これにより、ユーザーが最小文字数分のテキストを入力したタイミングで、ルックアップ項目きっかけ処理を実行できます。

ルックアップ項目きっかけ処理の設定

ルックアップ項目きっかけ処理では、次のパラメーターを取得して使用できます。

form	ユーザーがフォームで入力した内容
user	独自メニューの実行者の情報
entity	独自メニューの実行対象の情報
target	選択肢を表示する項目の情報
network	独自メニューが実行されたネットワークの情報

ルックアップ項目きっかけ処理の出力値（レスポンス）として指定する内容

パラメーター名	値の種類／内容	説明
options	JSON形式の配列（上限：1000）	項目に追加する新しい配列（値のリスト）です。
info	テキスト（上限：250文字）	入力内容に合致する結果が得られなかった場合に表示するメッセージです。
lookup	値： true、false 初期値： true	結果を取得した後、パラメーター「lookup」の値を「false」に変更すると、それ以降の検索を中止できます。

表1

たとえば、複数選択項目の選択肢を取得する処理を実行するとします。この場合、取得後に検索を無効にするコードの設定例は以下のとおりです。

{ "lookup":false,
"options":[
{
"id":"4000000009065",
"label":"Zoho Payments"
},
{
"id":"4000000009079",
"label":"Zoho Projects"
}
] }

入力内容に合致する選択肢が見つからない場合にメッセージを表示するコードの設定例は以下のとおりです。

{

"info":"時間をおいて、もう一度お試しください。" }

結果：

以下の場合、ルックアップ項目きっかけ処理は実行されません。

項目オブジェクト内でパラメーター「lookup」の値が「true」に設定されているが、ルックアップ項目きっかけ処理が実行されていない。
ルックアップ項目きっかけ処理を実行しているが、項目オブジェクト内でパラメーター「lookup」の値が「false」に設定されている。