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

可能な場合は、Equality の会社の値に一致するように、含めない用語を変更しました。顧客の実装に対する影響を回避するために、一部の用語は変更されていません。

重要

親種別

Metadata メタデータ型を拡張し、その fullName 項目を継承します。

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

RelationshipGraphDefinition コンポーネントのサフィックスは .relationshipGraphDefinition で、relationshipGraphDefinitions フォルダーに保存されます。

バージョン

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

特別なアクセスルール

このオブジェクトにアクセスするには、Financial Services Cloud 権限セットライセンスが必要です。

項目

項目名	説明
isActive	項目の型 boolean 説明必須。リレーショングラフを使用できるか (`true`)、否か (`false`) を示します。デフォルト値は、`true` です。この項目は API バージョン 55.0 では参照のみです。メモ
isTemplate	項目の型 boolean 説明必須。このリレーションシップグラフをテンプレートとして設定できるか (`true`)、否か (`false`) を示します。デフォルト値は、`false` です。UI では、この項目は [テンプレートとして設定] と表示されます。
masterLabel	項目の型 string 説明必須。 RelationshipGraphDefinition のわかりやすい名前で、RelationshipGraphDefinition の作成時に定義されます。UI では、この項目は [表示ラベル] と表示されます。
relationshipGraphDefVersions	項目の型 RelationshipGraphDefVersion[] 説明リレーショングラフ定義に関連付けられたグラフのバージョンのリストを表します。

RelationshipGraphDefVersion

リレーショングラフ定義に関連付けられたグラフのバージョンのリスト。

項目名	説明
graphDefinition	項目の型 string 説明必須。リレーショングラフの作成に必要な、親ノード、子リレーション、検索条件と並べ替え項目、グラフ UI 要素などの一連のプロパティを指定します。
graphType	項目の型 string 説明必須。グラフの種別を指定します。API バージョン 55.0 では、`HorizontalHierarchy` グラフ種別のみがサポートされています。

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

RelationshipGraphDefinition コンポーネントの例を次に示します。

1<?xml version="1.0" encoding="UTF-8"?>
2<RelationshipGraphDefinition xmlns="http://soap.sforce.com/2006/04/metadata">
3     <isActive>false</isActive>
4     <isTemplate>true</isTemplate>
5     <masterLabel>Account Graph</masterLabel>
6     <relationshipGraphDefVersions>
7         <graphDefinition>{
8   "graph" : {
9     "rootNode" : {
10       "object" : {
11         "entity" : "Account"
12       },
13       "configurationType" : "Primary",
14       "sortFields" : [ {
15         "field" : {
16           "field" : "LastModifiedDate",
17           "whichEntity" : "TARGET"
18         },
19         "order" : "DESC"
20       } ],
21       "nodeUiConfig" : {
22         "fieldsToDisplay" : [ ],
23         "showFieldLabels" : true,
24         "actions" : { }
25       },
26       "childRelationships" : [ {
27         "OneToMany" : {
28           "targetObjectNode" : {
29             "object" : {
30               "entity" : "Contact"
31             },
32             "configurationType" :"Custom",
33             "sortFields" : [ {
34               "field" : {
35                 "field" : "LastModifiedDate",
36                 "whichEntity" : "TARGET"
37               },
38               "order" : "DESC"
39             } ],
40             "nodeUiConfig" : {
41               "fieldsToDisplay" : [ {
42                 "field" : "Name",
43                 "whichEntity" : "TARGET"
44               }, {
45                 "field" : "Phone",
46                 "whichEntity" :"TARGET"
47               } ],
48               "showFieldLabels" : true,
49               "actions" : {
50                 "containerActions" : [ {
51                   "action" : "New"
52                 } ],
53                 "recordActions" : [ {
54                   "action" : "Edit"
55                 }, {
56                   "action" : "Delete"
57                 } ]
58               }
59             },
60             "childRelationships" : [ ]
61           },
62           "relationshipUiConfig" : { },
63           "filter" : {
64             "filterCriteria" : [ {
65               "field" : {
66                 "field" : "Name",
67                 "whichEntity" : "TARGET"
68               },
69               "operator" : "eq",
70               "value" : "Salesforce"
71             } ],
72             "booleanFilter" : "1"
73           },
74           "targetObjectField" : {
75             "field" : "AccountId",
76             "whichEntity" : "TARGET"
77           }
78         }
79       } ]
80     },
81     "globalUiConfig" : {
82       "borderColor" : "Green2",
83       "borderThickness" : "2px";,
84       "colorShading" : "Black",
85       "fieldLayout" : "Vertically Stacked",
86       "recordContainerExpansion" : true,
87       "recordExpansion" : true
88     }
89   }
90 }</graphDefinition>
91         <graphType>HorizontalHierarchy</graphType>
92     </relationshipGraphDefVersions>
93</RelationshipGraphDefinition>

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

1<?xml version="1.0" encoding="UTF-8"?>
2<Package xmlns="http://soap.sforce.com/2006/04/metadata">
3   <fullName>Package1</fullName>
4   <types>
5       <members>*</members>
6       <name>RelationshipGraphDefinition</name>
7   </types>
8   <version>55.0</version>
9</Package>

マニフェストファイル内のワイルドカードのサポート

このメタデータ型では、package.xml マニフェストファイル内のワイルドカード文字 * (アスタリスク) がサポートされます。マニフェストファイルの使用についての詳細は、「zip ファイルを使用したメタデータのリリースと取得」を参照してください。