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

ファイルのサフィックスおよびディレクトリの場所

CleanDataService コンポーネントのサフィックスは .cleanDataService で、cleanDataServices ディレクトリに保存されます。コンポーネントファイルの名前は、データサービスに関連付けられているオブジェクトの名前に基づいています。たとえば、コンポーネントファイル名 cleanDataServices/DataCloudCompanyMatch.cleanDataService は、取引先オブジェクトの会社名に関連付けられている DataCloudCompanyMatch と呼ばれるデータサービスコンポーネントを表します。

バージョン

CleanDataService コンポーネントは、API バージョン 44.0 以降で使用できます。

項目

項目名	データ型	説明
cleanRules	CleanRule[]	必須。データインテグレーションルールのリスト
description	string	必須。データサービスの説明。
masterLabel	string	必須。このデータサービスのマスタ表示ラベル。この値は表示されますが、データサービスの内部ラベルで翻訳されません。
matchEngine	string	必須。内部データサービス識別子に対応付けられるキー。

CleanRule

データサービスが組織のデータを追加および更新する方法を制御する情報を表します。

項目名	データ型	説明
bulkEnabled	boolean	必須。この項目が `true` に設定されている場合、データインテグレーションルールの更新時または保存時に Salesforce によってルールが既存のレコードに適用されます。
bypassTriggers	boolean	必須。この項目が `true` に設定されている場合、ルールの適用時に Salesforce によってトリガがバイパスされます。それ以外の場合は、ルールの適用後にトリガが適用されます。
bypassWorkflow	boolean	必須。この項目が `true` に設定されている場合、データインテグレーションルールの適用時に Salesforce によってワークフロールールがバイパスされます。それ以外の場合は、ルールの適用後にワークフローが適用されます。
description	string	必須。データインテグレーションルールを説明するわかりやすいテキスト。
developerName	string	必須。この名前は、アンダースコアと英数字のみを使用でき、組織内で一意にする必要があります。最初は文字であること、空白は使用しない、最後にアンダースコアを使用しない、2 つ続けてアンダースコアを使用しないという制約があります。この一意の名前により、同じ MasterLabel を持つ他のパッケージのルールと競合することを回避できます。
fieldMappings	FieldMapping[]	必須。ルールの FieldMapping エントリのリスト。
masterLabel	string	必須。このオブジェクトのマスタ表示ラベル。この表示値は、翻訳されない内部ラベルです。
matchRule	string	必須。CleanRule に関連付けられているデータサービスの一致ルールの内部ラベル。
sourceSobjectType	string	必須。CleanRule に関連付けられているデータサービスの仮想オブジェクト。存在しないオブジェクトを指定すると、エラーが発生します。
status	string	必須。データインテグレーションルールの状況。有効な値は、`Active` および `Inactive` です。
targetSobjectType	string	必須。この CleanRule で指定された追加および更新の対象となる標準オブジェクト。データサービスでサポートされていないオブジェクトを指定すると、エラーが発生します。

FieldMapping

データサービスの項目と、組織のオブジェクトの項目の対応付けを表します。

項目名	データ型	説明
developerName	string	必須。この名前は、アンダースコアと英数字のみを使用でき、組織内で一意にする必要があります。最初は文字であること、空白は使用しない、最後にアンダースコアを使用しない、2 つ続けてアンダースコアを使用しないという制約があります。この一意の名前により、MasterLabel が同じ他のパッケージの項目の対応付けと競合することを回避できます。
fieldMappingRows	FieldMappingRow[]	必須。FieldMappingRow エントリのリスト。各エントリは、データサービスの項目に対応付けられる標準オブジェクトの項目を表します。
masterLabel	string	必須。このオブジェクトのマスタ表示ラベル。この表示値は、翻訳されない内部ラベルです。
SObjectType	string	必須。この FieldMapping に関連付けられている標準オブジェクト。データサービスでサポートされていないオブジェクトを指定すると、エラーが発生します。

FieldMappingRow

CleanRule の状況を表します。

項目名	データ型	説明
fieldName	string	FieldMappingRow で表される項目の表示名。
fieldMappingFields	FieldMappingField[]	必須。FieldMappingField エントリのリスト。各エントリは、データサービスの項目に対応付けられる標準オブジェクトの項目です。
mappingOperation	string	この FieldMappingRow の値と、SObjectType で指定されたオブジェクトの対応付けられた項目を比較するときにデータサービスで適用される比較操作。この項目の値は `AutoFill` です。これは、オブジェクト項目が空白の場合にのみデータサービスによってデータが追加されることを示します。
SObjectType	string	FieldMappingRow に対応付けられる項目の標準オブジェクト。データサービスでサポートされていないオブジェクトを指定すると、エラーが発生します。

FieldMappingField

標準オブジェクトの項目を表します。FieldMappingField は、データサービスの FieldMappingRow エントリに対応付けられます。

項目名	データ型	説明
dataServiceField	string	必須。この項目に対応付けられるデータサービスの項目。
dataServiceObjectName	string	必須。この FieldMappingField に関連付けられている FieldMappingRow を含むデータサービスのオブジェクト。存在しないオブジェクトを指定すると、エラーが発生します。
priority	int	必須。項目の更新時にデータサービスで使用される、同じ項目の他の更新ルールに対する優先度を表します。有効な値は 1 ～ 100 です。

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

リード標準オブジェクトの CleanDataService コンポーネントの例を次に示します。

1<?xml version="1.0" encoding="UTF-8"?>
2<CleanDataService xmlns="http://soap.sforce.com/2006/04/metadata">
3    <cleanRules>
4        <bulkEnabled>false</bulkEnabled>
5        <bypassTriggers>false</bypassTriggers>
6        <bypassWorkflow>false</bypassWorkflow>
7        <description>Adds data info to leads</description>
8        <developerName>DataService_Leads_Enrichment</developerName>
9        <fieldMappings>
10            <SObjectType>DataServiceCompanyObject</SObjectType>
11            <developerName>DataService_Leads_Enrichment_InputMapping</developerName>
12            <fieldMappingRows>
13                <SObjectType>DataServiceCompanyObject</SObjectType>
14                <fieldMappingFields>
15                    <dataServiceField>Email</dataServiceField>
16                    <dataServiceObjectName>Lead</dataServiceObjectName>
17                    <priority>1</priority>
18                </fieldMappingFields>
19                <fieldName>Email</fieldName>
20                <mappingOperation>Autofill</mappingOperation>
21            </fieldMappingRows>
22            <fieldMappingRows>
23                <SObjectType>DataServiceCompanyObject</SObjectType>
24                <fieldMappingFields>
25                    <dataServiceField>Company</dataServiceField>
26                    <dataServiceObjectName>Lead</dataServiceObjectName>
27                    <priority>1</priority>
28                </fieldMappingFields>
29                <fieldName>Name</fieldName>
30                <mappingOperation>Autofill</mappingOperation>
31            </fieldMappingRows>
32            <masterLabel>DataServiceInputMapping</masterLabel>
33        </fieldMappings>
34        <fieldMappings>
35            <SObjectType>Lead</SObjectType>
36            <developerName>DataService_Leads_Enrichment_OutputMapping</developerName>
37            <fieldMappingRows>
38                <SObjectType>Lead</SObjectType>
39                <fieldMappingFields>
40                    <dataServiceField>EmployeesTotal</dataServiceField>
41                    <dataServiceObjectName>DataServiceCompanyObject</dataServiceObjectName>
42                    <priority>1</priority>
43                </fieldMappingFields>
44                <fieldName>NumberOfEmployees</fieldName>
45                <mappingOperation>Autofill</mappingOperation>
46            </fieldMappingRows>
47            <fieldMappingRows>
48                <SObjectType>Lead</SObjectType>
49                <fieldMappingFields>
50                    <dataServiceField>Revenue</dataServiceField>
51                    <dataServiceObjectName>DataServiceCompanyObject</dataServiceObjectName>
52                    <priority>1</priority>
53                </fieldMappingFields>
54                <fieldName>AnnualRevenue</fieldName>
55                <mappingOperation>Autofill</mappingOperation>
56            </fieldMappingRows>
57            <fieldMappingRows>
58                <SObjectType>Lead</SObjectType>
59                <fieldMappingFields>
60                    <dataServiceField>Industry</dataServiceField>
61                    <dataServiceObjectName>DataServiceCompanyObject</dataServiceObjectName>
62                    <priority>1</priority>
63                </fieldMappingFields>
64                <fieldName>Industry</fieldName>
65                <mappingOperation>Autofill</mappingOperation>
66            </fieldMappingRows>
67            <masterLabel>DataServiceOutputMapping</masterLabel>
68        </fieldMappings>
69        <masterLabel>Data Service Company Info for Leads</masterLabel>
70        <matchRule>DataServiceLeadAppendMatchRule</matchRule>
71        <sourceSobjectType>DataServiceCompanyObject</sourceSobjectType>
72        <status>Active</status>
73        <targetSobjectType>Lead</targetSobjectType>
74    </cleanRules>
75    <description>Data Service Companies for Leads</description>
76    <masterLabel>Data Service Companies for Leads</masterLabel>
77    <matchEngine>LeadEnrichmentMatchEngine</matchEngine>
78</CleanDataService>

前の定義を参照する package.xml の例を次に示します。

1<?xml version="1.0" encoding="UTF-8"?>
2<Package xmlns="http://soap.sforce.com/2006/04/metadata">
3    <types>
4        <members>DataService_Leads_Enrichment</members>
5        <name>CleanDataService</name>
6    </types>
7    <version>38.0</version>
8</Package>

使用方法

CleanDataService を使用して、データ強化サービスを表すすべてのメタデータを取得します。新しい組織でサービスを設定するには、取得したメタデータをリリースします。CleanDataService で CRUD ベースのコールは使用しないでください。

CleanDataService コンポーネントの小さな変更を行うには、Tooling API を使用してください。