この文章は Salesforce 機械翻訳システムを使用して翻訳されました。詳細はこちらをご参照ください。

NamedFilter

ルックアップ検索条件に関連付けられたメタデータを表します。ルックアップ検索条件の定義を作成、更新、または削除するには、このメタデータ型を使用します。このコンポーネントは API バージョン 30.0 で削除されました。それより前の API バージョンでのみ使用できます。ルックアップ検索条件に関連付けられたメタデータは、CustomField コンポーネントの lookupFilter 項目によって表されるようになりました。

Metadata メタデータ型を拡張し、その fullName 項目を継承します。このメタデータ型は、標準項目のルックアップ検索条件のカスタマイズを行う場合にも使用できます。

namedFilter は、関連付けられたルックアップ項目の対象オブジェクトの子として表示されます。

メモ

宣言的なメタデータファイルのサフィックスおよびディレクトリの場所

ルックアップ検索条件は、カスタムオブジェクト定義または標準オブジェクト定義の一部として定義されます。詳細は、「CustomObject」を参照してください。

プロジェクトでこのメタデータ型のコンポーネントを取得すると、同じパッケージで取得された Profile コンポーネントおよび PermissionSet コンポーネントにこのコンポーネントが表示されるようになります。

メモ

バージョン

ルックアップ検索条件は、API バージョン 17.0 以降で使用できます。

項目

別途記載がない限り、すべての項目は作成可能、除外可能で、null にすることもできます。

項目名	データ型	説明
active	boolean	必須。ルックアップ検索条件が有効かどうかを示します。
booleanFilter	string	高度な検索条件を指定します。
description	string	この検索条件の機能の説明。
errorMessage	string	ルックアップ検索条件が失敗した場合に表示されるエラーメッセージ。
field	string	必須。ルックアップ検索条件に関連付けられたカスタム項目または標準項目の fullName。各ルックアップ検索条件に 1 つのリレーション項目を関連付けることができます。その逆も可能です。ルックアップ検索条件に関連付けられた項目の更新はできません。メモ
filterItems	FilterItems[]	必須。検索条件のセット。
infoMessage	string	ページに表示される情報メッセージ。ある項目がルックアップ検索条件で除外されている理由など、ユーザにとってわかりにくい内容を説明するために使用します。
fullName	string	Metadata から継承されるこの項目は、このメタデータ型の WSDL では定義されません。作成時、更新時、または削除時に指定する必要があります。コールにおけるこの項目の例を確認するには、「`create()`」を参照してください。この値は `null` にできません。
isOptional	boolean	必須。ルックアップ検索条件が省略可能かどうかを示します。
name	string	必須。ルックアップ検索条件の名前。ユーザインターフェースでこの項目を作成する場合、名前は自動的に割り当てられます。メタデータ API を使用してこの項目を作成する場合、name 項目を含める必要があります。
sourceObject	string	このルックアップ検索条件を使用するルックアップ項目が含まれるオブジェクト。ルックアップ検索条件がソースオブジェクトの項目を参照する場合、この項目を設定します。

ルックアップ検索条件は、追加のデータ型を使用します。詳細は、「メタデータのデータ型」を参照してください。

FilterItems

FilterItems には次のプロパティが含まれます。

項目	データ型	説明
field	string	検索条件に指定された項目を表します。
operation	FilterOperation (string 型の列挙)	この検索条件項目の絞り込み操作を表します。有効な値は、FilterOperation に列挙されています。
value	string	操作される検索条件項目の値を表します。たとえば、検索条件が `my_number_field__c > 1` である場合、`value` の値は `1` です。

FilterOperation

これは、さまざまな絞り込み操作をリストする string 型の列挙です。有効な値は、次のとおりです。

equals
notEqual
lessThan
greaterThan
lessOrEqual
greaterOrEqual
contains
notContain
startsWith
includes
excludes

宣言的なメタデータの定義のサンプル

1<?xml version="1.0" encoding="UTF-8"?>
2<CustomObject xmlns="http://soap.sforce.com/2006/04/metadata">
3....
4    <namedfilters>
5        <fullName>nf_Acc</fullName>
6        <active>true</active>
7        <booleanFilter>1 OR 2</booleanFilter>
8        <field>Account.lk__c</field>
9        <filterItems>
10            <field>Account.Phone</field>
11            <operation>notEqual</operation>
12            <value>x</value>
13        </filterItems>
14        <filterItems>
15            <field>Account.Fax</field>
16            <operation>notEqual</operation>
17            <value>y</value>
18        </filterItems>
19        <name>Acc</name>
20        <sourceObject>Account</sourceObject>
21    </namedfilters>
22....
23</CustomObject>

メタデータ API 開発者ガイド