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

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

重要

親種別

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

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

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

バージョン

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

特別なアクセスルール

このメタデータ型を使用するには、Health Cloud の顧客でなければなりません。

項目

項目名	説明
contextObject	項目の型 string 説明必須。このオブジェクトリレーション設定のコンテキストを提供するオブジェクト。
contextObjectRecordType	項目の型 string 説明この設定のコンテキストオブジェクトのレコードタイプ (該当する場合)。
directRelationshipField	項目の型 string 説明コンテキストオブジェクトを照合する関連オブジェクトの子リレーション項目 (直接リレーションの場合)。
indirectObjectContextField	項目の型 string 説明コンテキストオブジェクトを照合する連結オブジェクトの項目 (間接リレーションの場合)。
indirectObjectRelatedField	項目の型 string 説明関連オブジェクトを照合する連結オブジェクトの項目 (間接リレーションの場合)。
indirectRelationshipObject	項目の型 string 説明関連オブジェクトとそのコンテキストオブジェクト間のリレーションを表す連結オブジェクト (間接リレーションの場合)。
isActive	項目の型 boolean 説明設定が有効か (`true`)、否か (`false`) を示します。
masterLabel	項目の型 string 説明必須。 UIObjectRelationConfig の表示ラベル。UI では、この項目は [UI オブジェクトリレーション設定] です。
relatedObject	項目の型 string 説明必須。このオブジェクトリレーション設定で表示されるデータが含まれるオブジェクト。
relatedObjectRecordType	項目の型 string 説明この設定の関連オブジェクトのレコードタイプ。
relationshipType	項目の型 ObjectRelationshipType (string 型の列挙) 説明必須。関連オブジェクトとコンテキストオブジェクト間のリレーション種別を示す文字列。有効な値は、次のとおりです。 `Direct` `Indirect` `InverseDirect` `Self`
UIObjectRelationFieldConfigs	項目の型 UIObjectRelationFieldConfig[] 説明コンテンツの特定行にあるオブジェクトリレーション項目の設定を提供します。

UIObjectRelationFieldConfig

特定のオブジェクトリレーション設定のコンテンツの単一行の設定を表します。

項目名	説明
displayLabel	項目の型 string 説明必須。この種別の各オブジェクトリレーションに表示される、この項目のユーザ定義の表示ラベルが含まれる文字列。
queryText	項目の型 string 説明必須。この項目のコンテンツを生成するためのテンプレートクエリ。大文字と小文字の区別はありません。
rowOrder	項目の型 int 説明必須。オブジェクトリレーション UI のこの項目の上から下への表示順序を決定します。

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

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

1<?xml version="1.0" encoding="UTF-8"?>
2 <UIObjectRelationConfig xmlns="http://soap.sforce.com/2006/04/metadata">
3     <UIObjectRelationFieldConfigs>
4         <displayLabel>Address:</displayLabel>
5         <queryText>{
6     "startNode": {
7         "initialObject": "RelatedObject"
8     },
9     "traversalNodes": [],
10     "fieldNode": {
11         "fieldEnumOrId": "ShippingAddress"
12     }
13 }</queryText>
14         <rowOrder>1</rowOrder>
15     </UIObjectRelationFieldConfigs>
16     <UIObjectRelationFieldConfigs>
17         <displayLabel>Phone:</displayLabel>
18         <queryText>{
19     "startNode": {
20         "initialObject": "RelatedObject"
21     },
22     "traversalNodes": [],
23     "fieldNode": {
24         "fieldEnumOrId": "Phone"
25     }
26 }</queryText>
27         <rowOrder>2</rowOrder>
28     </UIObjectRelationFieldConfigs>
29     <UIObjectRelationFieldConfigs>
30         <displayLabel>Fax:</displayLabel>
31         <queryText>{
32     "startNode": {
33         "initialObject": "RelatedObject"
34     },
35     "traversalNodes": [],
36     "fieldNode": {
37         "fieldEnumOrId": "Fax"
38     }
39 }</queryText>
40         <rowOrder>3</rowOrder>
41     </UIObjectRelationFieldConfigs>
42     <UIObjectRelationFieldConfigs>
43         <displayLabel>Parent Organization:</displayLabel>
44         <queryText>{
45     "startNode": {
46         "initialObject": "RelatedObject"
47     },
48     "traversalNodes": [
49         {
50             "destinationObjectEnumOrId": "Account",
51             "fieldEnumOrId": "ParentId",
52             "traversalDirection": "parent"
53         }
54     ],
55     "fieldNode": {
56         "fieldEnumOrId": "Name"
57     }
58 }</queryText>
59         <rowOrder>4</rowOrder>
60     </UIObjectRelationFieldConfigs>
61     <contextObject>Contact</contextObject>
62     <directRelationshipField>AccountId</directRelationshipField>
63     <isActive>true</isActive>
64     <masterLabel>Sample Primary Account Configuration</masterLabel>
65     <relatedObject>Account</relatedObject>
66     <relationshipType>Direct</relationshipType>
67     <indirectObjectRelatedField></indirectObjectRelatedField>
68     <indirectObjectContextField></indirectObjectContextField>
69     <contextObjectRecordType></contextObjectRecordType>
70     <indirectRelationshipObject></indirectRelationshipObject>
71     <relatedObjectRecordType></relatedObjectRecordType>
72 </UIObjectRelationConfig>

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

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>UIObjectRelationConfig</name>
6  </types>
7    <version>54.0</version>
8</Package>

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

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