cx-pickerフラグメントのパラメータ

このトピックでは、cx-pickerフラグメントに設定できるパラメータを示します。このフラグメントのパラメータを設定する方法の詳細は、「ピッカーの構成」を参照してください。

cx-pickerフラグメントの必須パラメータ

パラメータ	サンプル値	説明
dynamicLayoutContext	`[[ $dynamicLayoutContext ]]`	このパラメータはデフォルトで設定され、フィールドが作成または編集ページに表示される場合は、変更する必要はありません。このフィールドが、作成または編集ページではなく、一括更新ページなどに表示されている場合は、このパラメータのデフォルト値を削除できます。
pickerLayoutId	`PickerLayout`	このパラメータは、そのレイアウトによって実行時におけるピッカーの外観が制御されるルール・セットを指し示します。デフォルト値は、カスタム・オブジェクトを含め、それぞれのオブジェクトについて事前定義されているPicker Layoutルール・セットのIDである`PickerLayout`であり、これを変更する必要はありません。カスタム・ルール・セットを作成する必要がある場合は、ルール・セットを動的表として作成し、「ラベル」フィールドと「ID」フィールドの値が同じであることを確認します。続けて、ルール・セットのIDをこのパラメータに追加します。
resource	`[[ {"name": "accounts","displayField":"OrganizationName","endpoint":"cx-custom","primaryKey":"PartyId" } ]]`	このパラメータを使用して、ターゲット・オブジェクトの名前およびエンドポイントを渡します: `name` - ターゲット・オブジェクト名 `endpoint` - ターゲット・オブジェクト・エンドポイントオプションで、次の追加属性を渡します: `displayField` - ユーザーが選択を行った後にピッカー・フィールドに表示されるフィールド値。ここで指定しない場合、ピッカーにはデフォルトで、ピッカー・レイアウトの最初のフィールドが表示されます。 `primaryKey` - primaryKeyの導出元となるフィールド。指定しない場合、オブジェクトのprimaryKeyフィールドが使用されます。必ず、ユース・ケースに適した値を使用してresourceパラメータを更新してください。たとえば、`accounts`を、動的選択リスト・フィールドの基になるオブジェクトのREST API名に置き換えます。

パラメータ

サンプル値

説明

dynamicLayoutContext

[[ $dynamicLayoutContext ]]

このパラメータはデフォルトで設定され、フィールドが作成または編集ページに表示される場合は、変更する必要はありません。

このフィールドが、作成または編集ページではなく、一括更新ページなどに表示されている場合は、このパラメータのデフォルト値を削除できます。

pickerLayoutId

PickerLayout

このパラメータは、そのレイアウトによって実行時におけるピッカーの外観が制御されるルール・セットを指し示します。

デフォルト値は、カスタム・オブジェクトを含め、それぞれのオブジェクトについて事前定義されているPicker Layoutルール・セットのIDであるPickerLayoutであり、これを変更する必要はありません。

カスタム・ルール・セットを作成する必要がある場合は、ルール・セットを動的表として作成し、「ラベル」フィールドと「ID」フィールドの値が同じであることを確認します。続けて、ルール・セットのIDをこのパラメータに追加します。

resource

[[ {"name": "accounts","displayField":"OrganizationName","endpoint":"cx-custom","primaryKey":"PartyId" } ]]

このパラメータを使用して、ターゲット・オブジェクトの名前およびエンドポイントを渡します:

name - ターゲット・オブジェクト名
endpoint - ターゲット・オブジェクト・エンドポイント

オプションで、次の追加属性を渡します:

displayField - ユーザーが選択を行った後にピッカー・フィールドに表示されるフィールド値。ここで指定しない場合、ピッカーにはデフォルトで、ピッカー・レイアウトの最初のフィールドが表示されます。
primaryKey - primaryKeyの導出元となるフィールド。指定しない場合、オブジェクトのprimaryKeyフィールドが使用されます。

必ず、ユース・ケースに適した値を使用してresourceパラメータを更新してください。たとえば、accountsを、動的選択リスト・フィールドの基になるオブジェクトのREST API名に置き換えます。

cx-pickerフラグメントのオプション・パラメータ

パラメータ	サンプル値	説明
context	表示するフィールドを変更するには、contextパラメータを`[[ {'variableName':true} ]]`に設定します。例: `[[ {'showContact':false} ]]` ユーザーがこのフィールドにテキスト値を入力できるようにするには、このプロパティをcontextパラメータに追加します: `[[ {'enablePlainText':true} ]]`	contextパラメータを使用して、ピッカーの動作を制御できます。次に例を示します: 実行時にピッカーに異なるフィールドを表示します。たとえば、このパラメータの値に基づいて、ピッカーにフィールドAまたはフィールドBのいずれかを表示できます。設定方法は、「ピッカーでの異なるフィールドの表示」を参照してください。ユーザーが実行時に、既存の値を選択するのではなく、テキスト値をフィールドに入力できるようにします。
createConfig	`[[ {'enabled':true} ]]`	ユーザーがピッカーから直接レコードを作成できるかどうかを示します。`true`または`false`を指定します。値を設定しない場合、デフォルトで、レコードの作成オプションが自動的にピッカーに表示されます。
isDefaultSavedSearchEnabled	このパラメータはチェック・ボックスです。	ピッカー・フィールドの値リストに自動的に適用されるデフォルトの保存済検索を指定する場合に、このパラメータを使用します。このチェック・ボックスはデフォルトでは選択されていません。選択されていない場合、ピッカー・フィールドの保存済検索のリストから「デフォルト検索ビュー」オプションが自動的に選択されます。アカウントおよび担当者の場合、デフォルト検索ビューは「すべてのアカウント」および「すべての担当者」です。選択されている場合、どの保存済検索が最後に選択されたかに関係なく、オブジェクトに対して有効になっているデフォルトの保存済検索が常にデフォルトの選択になります。ノート: このパラメータは、適応型検索でサポートされているオブジェクトにのみ適用できます。
label	`US Account`	UIのフィールド名をオーバーライドする場合に、このパラメータを使用します。このパラメータは、アプリケーション・コンポーザで動的選択リスト・フィールドでフィルタが定義される場合、またはqueryパラメータを使用してフィルタ条件を渡す場合(後述します)に特に有用です。たとえば、米国のアカウントのみを表示するために、単純フィルタを動的選択リスト・フィールドに追加する場合、labelパラメータを使用してフィールド名を変更できます。この例では、「アカウント」フィールドの名前を新しいフィールド名の`US Account`に変更します。
pickerNameField	`{{ $value.pickerNameField }}`	ピッカー・フィールドでユーザー入力テキストをサポートするために、このパラメータをcontextパラメータと一緒に使用します。このパラメータを`pickerNamefield`などの作成した仮想フィールドにバインドします。このフィールドに(アプリケーション・コンポーザから)単純フィルタが適用されている場合、またはqueryパラメータの値が指定されている場合は、pickerNameFieldパラメータの値は無視されます。
query	`[{"op":"$co","attribute":"OrganizationName","value":"Pinnacle"}]`	実行時にピッカーで使用できるレコードをフィルタする場合に、このパラメータを使用します。たとえば、レコードをフィルタして、名前に`Pinnacle`などの特定のキーワードが含まれているアカウントのみを表示できます。このパラメータの値はarray[object]である必要があります。 (アプリケーション・コンポーザからの)動的選択リスト・フィールドに単純フィルタが設定され、かつこのパラメータで問合せも指定されている場合、このパラメータが優先されます。このパラメータで値を渡した場合、実行時にピッカーに保存済検索のリストは表示されません。
readonly	このパラメータはチェック・ボックスです。	フィールドを読取り専用にする場合に、このパラメータを使用します。たとえば、ユーザーが初めてレコードを作成するときにのみ、フィールドを編集可能にできます。その一方で編集中はこのフィールドを読取り専用にできます。
required	このパラメータはチェック・ボックスです。	このパラメータは、dynamicLayoutContextパラメータに値が指定されていない場合にのみ適用できます。ピッカー・フィールドを必須にする場合に、このパラメータを使用します。ただし、dynamicLayoutContextパラメータに値が含まれている場合は、「フィールド」タブの「必須」チェック・ボックスを選択して、ピッカー・フィールドを必須にできます。たとえば、「Payment_c」タブ>「フィールド」サブタブ>「Account_Id_c」フィールド>「プロパティ」ペインと選択し、「必須」チェック・ボックスをクリックします。
selectedRow	`{{ $page.variables.selectedRow }}`	ピッカーで選択された行の他のフィールド値を使用する場合に、このパラメータをvalueパラメータと一緒に使用します。たとえば、ユーザーが担当者を選択した場合、ピッカーにバインドされているvalueパラメータにcontactIdが格納されます。ユーザーはこのパラメータを使用して担当者のEメール・アドレスを取得することもできます。
sortCriteria	例: `[[ [{'attribute': 'PrimaryContact.PartyName', 'direction': 'descending'}] ]]`	ピッカー・レイアウトでデフォルトのソート条件をオーバーライドする場合に、このパラメータを使用します。ユーザーが保存済検索を選択したときに、このパラメータが指定されていれば、このパラメータからソート条件が取得されます。指定されていない場合、ピッカーでは、保存済検索で定義されているソート条件が使用されます。これが定義されていない場合は、ピッカー・レイアウトの最初の列に基づいて値がソートされます。フィールドに単純フィルタが設定されている場合、queryパラメータでフィルタが定義されている場合、またはユーザーが「関連レコード」を選択した場合は、このパラメータからソート条件が取得されます(指定されている場合)。指定されていない場合は、ピッカー・レイアウトの最初の列に基づいて値がソートされます。
value	`{{ $page.variables.pickerValue }}`	dynamicLayoutContextパラメータに値が指定されていない場合に、ピッカー・フィールドで選択された値を格納するためにこのパラメータを使用します。たとえば、ページ上の担当者ピッカーに動的レイアウトが設定されていないとします。ユーザーが担当者を選択した場合、ピッカーにバインドされているvalueパラメータにcontactIdが格納されます。