メタデータ API 開発者ガイド
jMatchingRule
重複レコードを識別するために使用される一致ルールを表します。Metadata メタデータ型を拡張し、その fullName 項目を継承します。
ファイルのサフィックスおよびディレクトリの場所
MatchingRule コンポーネントのサフィックスは .matchingRule で、matchingRules フォルダに保存されます。コンポーネントのファイルの名前は、一致ルールに関連付けられている標準またはカスタムオブジェクトの名前です。
バージョン
MatchingRule は、API バージョン 33.0 以降で使用できます。
項目
| 項目名 | データ型 | 説明 |
|---|---|---|
| booleanFilter | string | 検索条件ロジックの条件を指定します。検索条件ロジックの詳細は、Salesforce ヘルプの「検索条件ロジックを最大限に活用」を参照してください。 |
| description | string | 一致ルールの説明。 |
| label | string | 必須。一致ルールの名前。 |
| matchingRuleItems | MatchingRuleItem | 一致ルールを構成する条件。 |
| ruleStatus | MatchingRuleStatus (string 型の列挙) | 必須。一致ルールの有効化状況。値は次のとおりです。
|
MatchingRuleItem
| 項目名 | データ型 | 説明 |
|---|---|---|
| blankValueBehavior | BlankValueBehavior (string 型の列挙) | 比較対象の項目が一致するとみなす場合に、空白項目がどのように影響するかを指定します。有効な値は、次のとおりです。
|
| fieldName | string | 必須。レコードと既存のレコードの間に一致とみなすだけの類似性があるかどうかを判定するときに比較する項目を示します。 |
| matchingMethod | MatchingMethod (string 型の列挙) | 必須。項目の比較方法を定義します。完全一致メソッドまたは各種のあいまい一致メソッドのいずれかを選択します。有効な値は、次のとおりです。
|
宣言的なメタデータの定義のサンプル
一致ルールの XML 定義サンプルを次に示します。一致ルールは、標準またはカスタムオブジェクトに関連付けることができます。
1<?xml version="1.0" encoding="UTF-8"?>
2<MatchingRules xmlns="http://soap.sforce.com/2006/04/metadata">
3<matchingRules>
4<fullName>AccountMatchingRule</fullName>
5<label>Matching rule for accounts</label>
6<description>this is sample rule description</description>
7<matchingRuleItems>
8<blankValueBehavior>NullNotAllowed</blankValueBehavior>
9<fieldName>BillingCity</fieldName>
10<matchingMethod>City</matchingMethod>
11</matchingRuleItems>
12
13<matchingRuleItems>
14<blankValueBehavior>NullNotAllowed</blankValueBehavior>
15<fieldName>Name</fieldName>
16<matchingMethod>CompanyName</matchingMethod>
17</matchingRuleItems>
18
19<ruleStatus>Inactive</ruleStatus>
20</matchingRules>
21</MatchingRules>次の package.xml では、名前で一致ルールを参照する方法を示します。種別名として MatchingRule を指定しています。
1<?xml version="1.0" encoding="UTF-8"?>
2<Package xmlns="http://soap.sforce.com/2006/04/metadata">
3<types>
4<members>Account.AccountMatchingRule</members>
5<name>MatchingRule</name>
6</types>
7<version>35.0</version>
8</Package>次の package.xml では、すべての一致ルールを参照する方法を示します。種別名として複数形の MatchingRules を指定し、すべてのメンバーを含めるためにワイルドカードを使用しています。
1<?xml version="1.0" encoding="UTF-8"?>
2<Package xmlns="http://soap.sforce.com/2006/04/metadata">
3<types>
4<members>*</members>
5<name>MatchingRules</name>
6</types>
7<version>35.0</version>
8</Package>