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

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

重要

親種別

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

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

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

バージョン

ActionableListDefinition コンポーネントは、API バージョン 57.0 以降で利用できます。

項目

項目名	説明
actionableListDatasetColumns	項目の型 ActionableListDatasetColumn[] 説明アクション可能リストに関連付けられたデータセットの列を保存するオブジェクト。
actionableListMemberStatuses	項目の型 ActionableListMemberStatus[] 説明個々のアクション可能リストメンバーの状況と対応する状況アイコンの詳細を保存するオブジェクト。
batchCalcJobDefinition	項目の型 string 説明アクション可能リストの作成に関連付けられた一括計算ジョブ定義。この項目はリレーション項目です。
datasetName	項目の型 string 説明アクション可能リストに関連付けられたデータセットの名前。
edgeMart	項目の型 string 説明アクション可能リストに関連付けられた edgemart データセット。API バージョン 58.0 以降で利用できます。
isActive	項目の型 boolean 説明アクション可能リスト定義が有効であるか (`true`)、否か (`false`) を示します。デフォルト値は `false` です。
masterLabel	項目の型 string 説明必須。アクション可能リスト定義のマスター表示ラベル。
objectName	項目の型 string 説明必須。アクション可能リストを作成する対象となるオブジェクト。可能な値は、導入された API バ��ジョンごとに異なります。これらの値は、特に断りのない限り、導入以降のすべてのバージョンで使用できます。使用可能な値は次のとおりです。 API バージョン 60.0 以降: `PersonLifeEvent` API バージョン 60.0 以降 (Insurance Managed Package): `Claim` `InsurancePolicy` `Quote` API バージョン 59.0 以降で Health Cloud を使用する場合: `CareFacilityBed` `CareRequest` `CareRequestItem` `CareServiceVisit` `CareServiceVisitPlan` `ClinicalServiceRequest` API バージョン 59.0 以降で Loyalty Cloud を使用する場合: `LoyaltyProgramMember` API バージョン 59.0 以降: `Case` API バージョン 58.0 以降で Automotive Cloud を使用する場合: `Vehicle` API バージョン 58.0 以降: `Asset` `Lead` `Opportunity` API バージョン 57.0 以降: `Account` `Contact`

ActionableListDatasetColumn

アクション可能リストに関連付けられたデータセットの列に関する情報を表します。

表 1. 項目
項目名	説明
dataDomain	項目の型 DatasetColumnDataType (string 型の列挙) 説明データセット列のデータ型に対応付けられているデータドメイン。使用可能な値は次のとおりです。 `Dates` `Dimensions` `Measures`
dataType	項目の型 DatatableDataType (string 型の列挙) プロパティ Create、Filter、Group、Nillable、Restricted picklist、Sort、Update 説明アクション可能リストのデータセット列のデータ型。API バージョン 58.0 以降で利用できます。使用可能な値は次のとおりです。 `Boolean` `Currency` `Date` `DateTime` `Email` `Location` `Number` `Percent` `Phone` `Text` `Url`
displayOrder	項目の型 int プロパティ Create、Filter、Group、Nillable、Sort、Update 説明アクション可能リストのデータセット列を表示する順序。API バージョン 58.0 以降で利用できます。
isDefault	項目の型 boolean 説明データセット列がアクション可能リストにデフォルトで追加されるか (`true`)、否か (`false`) を示します。デフォルト値は `false` です。
isGroupedByListDefObj	項目の型 boolean 説明データセット列が、アクション可能リスト定義で指定されたオブジェクトによってグループ化されるか (`true`)、否か (`false`) を示します。API バージョン 59.0 以降で利用できます。
IsTypeAheadSearchEnabled	項目の型 boolean 説明検索条件の先行入力検索が有効化されているか (`true`)、否か (`false`) を示します。API バージョン 60.0 以降で利用できます。
objectName	項目の型 string 説明データセット列に関連付けられたオブジェクトの名前。使用可能な値は次のとおりです。 API バージョン 60.0 以降: `PersonLifeEvent` API バージョン 60.0 以降 (Insurance Managed Package): `Claim` `InsurancePolicy` `Quote` API バージョン 59.0 以降で Health Cloud を使用する場合: `CareFacilityBed` `CareRequest` `CareRequestItem` `CareServiceVisit` `CareServiceVisitPlan` `ClinicalServiceRequest` API バージョン 59.0 以降で Loyalty Cloud を使用する場合: `LoyaltyProgramMember` API バージョン 59.0 以降: `Case` API バージョン 58.0 以降で Automotive Cloud を使用する場合: `Vehicle` API バージョン 58.0 以降: `Asset` `Lead` `Opportunity` API バージョン 57.0 以降: `Account` `Contact`
sourceColumnApiName	項目の型 string 説明ソースデータセットの列の API 参照名。
sourceFieldName	項目の型 string 説明アクション可能リストデータセットを作成する対象となるオブジェクトの項目の名前。

ActionableListMemberStatus

個々のアクション可能リストメンバーの状況と対応する状況アイコンの詳細を表します。

表 2. 項目
項目名	説明
iconName	項目の型 string 説明状況に関連付けられたアイコンの名前。
status	項目の型 string 説明アクション可能メンバーの状況。

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

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

1<?xml version="1.0" encoding="UTF-8"?>
2<ActionableListDefinition
3	xmlns="http://soap.sforce.com/2006/04/metadata">
4	<actionableListDatasetColumns>
5		<isDefault>true</isDefault>
6		<sourceFieldName>NewColumn1</sourceFieldName>
7	</actionableListDatasetColumns>
8	<actionableListDatasetColumns>
9		<sourceColumnApiName>ApiName</sourceColumnApiName>
10		<dataDomain>Dimensions</dataDomain>
11		<isDefault>false</isDefault>
12		<sourceFieldName>NewColumn2</sourceFieldName>
13		<objectName>Account</objectName>
14		<displayOrder>1</displayOrder>
15		<dataType>Text</dataType>
16	</actionableListDatasetColumns>
17	<actionableListMemberStatuses>
18		<iconName>NewMember1</iconName>
19		<status>Active</status>
20	</actionableListMemberStatuses>
21	<isActive>true</isActive>
22	<masterLabel>NewMember2</masterLabel>
23	<objectName>Account</objectName>
24	<isProtected>true</isProtected>
25	<batchCalcJobDefinition>Test1</batchCalcJobDefinition>
26	<datasetName>AccountDef</datasetName>
27</ActionableListDefinition>

前の定義を参照する 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>ActionableListDefinition</name>
6   </types>
7   <version>60.0</version>
8</Package>

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

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