メタデータ API 開発者ガイド
jRecordActionDeployment
ガイド付きアクションリストの設定が含まれるリリースを表します。各リリースでは、チャネルのデフォルトとユーザが実行時に追加できるアクションを指定します。Metadata メタデータ型を拡張し、その fullName 項目を継承します。
ファイルのサフィックスおよびディレクトリの場所
RecordActionDeployment の値は、recordActionDeployments ディレクトリの developer_name.deployment ファイルに保存されます。
バージョン
RecordActionDeployment は、API バージョン 45.0 以降で使用できます。
項目
| 項目名 | 項目の型 | 説明 |
|---|---|---|
| channelConfigurations | RecordActionDeploymentChannel | ガイド付きアクションリストのリリースでのさまざまなチャネルの設定を指定します。 |
| masterLabel | string | 必須。リリースの名前を指定します。 |
| selectableItems | RecordActionSelectableItem | ユーザが実行時にガイド付きアクションリストに追加できるアクションを指定します。 |
RecordActionDeploymentChannel
ガイド付きアクションリストコンポーネントのデフォルトチャネルを指定します。このコンポーネントでは、リストが空の場合、デフォルトチャネルが表示されます。
| 項目名 | 項目の型 | 説明 |
|---|---|---|
| channel | ChannelSource (string 型の列挙) | 必須。チャネルを指定します。有効な値は、Phone、Chat、または Other です。 |
| channelItems | RecordActionDefaultItem | アクションをリストの上部または下部に固定表示するかどうか、アクションを必須とみなすかどうかなど、チャネルのデフォルトアクションと各アクションの属性を指定します。 |
| isAutopopEnabled | boolean | レコードページが開いたときにリストの最初のガイド付きアクションを起動するかどうかを指定します。true の場合、最初のアクションが起動されます。デフォルト値は、false です。 |
RecordActionDefaultItem
リリースのデフォルトチャネルとして指定されたアクションと属性を表します。
| 項目名 | 項目の型 | 説明 |
|---|---|---|
| action | string | 必須。アクションの API 参照名を指定します。たとえば、フローの API 参照名 (Verify_Information など)。 |
| isMandatory | boolean | アクションを必須とマークするかどうかを指定します。デフォルト値は、false です。 |
| isUiRemoveHidden | boolean | ガイド付きアクションを削除する機能を UI で非表示にするかどうかを指定します。デフォルト値は false です。true の場合、アクションを削除する機能が UI で非表示になります。 |
| position | int | 必須。このレコードに関連付けられたすべてのアクションの中でのこのガイド付きアクションの順序を示します。 |
| pinned | PinnedAction (string 型の列挙) | 必須。アクションが領域に固定されるかどうかを示します。有効な値は、Top、Bottom、または None です。デフォルト値は None (固定しない) です。 |
| type | RecordActionType (string 型の列挙) | 必須。レコードに関連付けられたガイド付きアクションの種別。サポートされる唯一の値かつデフォルトは Flow です。 |
RecordActionSelectableItem
ガイド付きアクションリストコンポーネントのデフォルトチャネルを指定します。このコンポーネントでは、リストが空の場合にのみ、デフォルトチャネルが表示されます。
| 項目名 | 項目の型 | 説明 |
|---|---|---|
| action | string | 必須。アクションの API 参照名を指定します。たとえば、フローの API 参照名 (Verify_Information など)。 |
| type | RecordActionType (string 型の列挙) | 必須。レコードに関連付けられたガイド付きアクションの種別。サポートされる唯一の値かつデフォルトは Flow です。 |
宣言的なメタデータの定義のサンプル
recordActionDeployment ファイルのサンプルを次に示します。
1<RecordActionDeployment xmlns="http://soap.sforce.com/2006/04/metadata">
2 <channelConfigurations>
3 <channel>Phone</channel>
4 <channelItems>
5 <action>Sample_Flow</action>
6 <isMandatory>false</isMandatory>
7 <isUiRemoveHidden>false</isUiRemoveHidden>
8 <position>1</position>
9 <pinned>Top</pinned>
10 <type>Flow</type>
11 </channelItems>
12 <channelItems>
13 <action>Another_Sample_Flow</action>
14 <isMandatory>false</isMandatory>
15 <isUiRemoveHidden>true</isUiRemoveHidden>
16 <position>2</position>
17 <pinned>Top</pinned>
18 <type>Flow</type>
19 </channelItems>
20 <isAutopopEnabled>true</isAutopopEnabled>
21 </channelConfigurations>
22 <masterLabel>Sample Deployment</masterLabel>
23 <selectableItems>
24 <action>Sample_Flow</action>
25 <type>Flow</type>
26 </selectableItems>
27 <selectableItems>
28 <action>Sample_Flow_2</action>
29 <type>Flow</type>
30 </selectableItems>
31</RecordActionDeployment>前の定義を参照する package.xml の例を次に示します。
1<?xml version="1.0" encoding="UTF-8"?>
2<Package xmlns="http://soap.sforce.com/2006/04/metadata">
3 <fullName>SecondTest</fullName>
4 <types>
5 <members>Sample_Flow</members>
6 <members>Another_Sample_Flow</members>
7 <members>Sample_Flow_2</members>
8 <name>Flow</name>
9 </types>
10 <types>
11 <members>SampleDeployment</members>
12 <name>RecordActionDeployment</name>
13 </types>
14 <version>45.0</version>
15</Package>