メタデータ API 開発者ガイド
jRecordActionDeployment
アクション & おすすめコンポーネントとアクションランチャーコンポーネントの構成設定を表します。たとえば、表示するアクションの種別、チャネルのデフォルトのアクション、ユーザが実行時に追加できるアクションを指定するリリースを持つことができます。コンポーネントで Next Best Action のおすすめが表示される場合、リリースによって使用する戦略およびおすすめの表示方法を設定します。Metadata メタデータ型を拡張し、その fullName 項目を継承します。
ファイルのサフィックスおよびディレクトリの場所
RecordActionDeployment の値は、recordActionDeployments ディレクトリの developer_name.deployment ファイルに保存されます。
バージョン
RecordActionDeployment は、API バージョン 45.0 以降で使用できます。
項目
| 項目名 | 項目の型 | 説明 |
|---|---|---|
| channelConfigurations | RecordActionDeploymentChannel | アクション & おすすめリリースでのさまざまなチャネルの構成設定を指定します。 |
| componentName | picklist | リリースで使用されるコンポーネントの名前を指定します:
|
| deploymentContexts | RecordActionDeploymentContext | クイックアクションと Next Best Action 戦略のオブジェクトコンテキストを指定します。API バージョン 46.0 以降で利用できます。 |
| hasGuidedActions | boolean | コンポーネントで標準アクション (たとえば、フローやクイックアクション) が表示されることを指定します。API バージョン 46.0 以降で利用できます。 |
| hasOmniscripts | boolean | レコードアクションリリースに OmniScripts が含まれるか (true)、否か (false) を示します。API バージョン 56.0 以降で利用できます。デフォルト値は false です。 |
| hasRecommendations | boolean | コンポーネントで Next Best Action 戦略からのおすすめを表示することを示します。API バージョン 46.0 以降で利用できます。 |
| masterLabel | string | 必須。リリースの名前を指定します。 |
| recommendation | RecordActionRecommendation | コンポーネントでの Next Best Action のおすすめの表示方法の設定を指定します。API バージョン 46.0 以降で利用できます。 |
| selectableItems | RecordActionSelectableItem | ユーザが実行時に追加できるアクションを指定します。 |
| shouldLaunchActionOnReject | boolean | 必須。true の場合、おすすめがエージェントによって拒否されたときにフローが起動されます。API バージョン 48.0 以降で利用できます。 |
RecordActionDefaultItem
リリースのデフォルトチャネルとして指定されたアクションと属性を表します。
| 項目名 | 項目の型 | 説明 |
|---|---|---|
| action | string | 必須。アクションの API 参照名を指定します。たとえば、フローの API 参照名 (Verify_Information など)。 |
| isMandatory | boolean | アクションを必須とマークするかどうかを指定します。デフォルト値は false です。 |
| isUiRemoveHidden | boolean | 削除オプションを UI で非表示にするかどうかを指定します。デフォルト値は false です。true の場合、リストからアクションを削除する機能が UI で非表示になります。 |
| pinned | PinnedAction (string 型の列挙) | 必須。アクションが Top または Bottom に固定されるか���または固定されない (None) 化を示します。デフォルト値は None です。 |
| position | int | 必須。このレコードに関連付けられたすべてのアクションの中でのこのアクションの順序を示します。 |
| type | RecordActionType (string 型の列挙) | 必須。レコードに関連付けられたアクションの種別。有効な値は、次のとおりです。
|
RecordActionDeploymentChannel
アクション & おすすめコンポーネントで表示するチャネル固有のデフォルトを指定します。このコンポーネントでは、リストが空の場合、チャネルのデフォルトが表示されます。
| 項目名 | 項目の型 | 説明 | |
|---|---|---|---|
| channel | ChannelSource (string 型の列挙) | 必須。チャネルを指定します。有効な値は、Phone、Chat、または Default です。 | |
| channelItems | RecordActionDefaultItem | アクションをリストの上部または下部に固定表示するかどうか、アクションを必須とみなすかどうかなど、チャネルのデフォルトアクションと各アクションの属性を指定します。 | |
| isAutopopEnabled | boolean | レコードページが開いたときにリストの最初のアクションを起動するかどうかを指定します。true の場合、最初のアクションが起動されます。デフォルト値は false です。 |
RecordActionDeploymentContext
クイックアクションと Next Best Action 戦略のコンテキストを提供するオブジェクトを指定します。コンポーネントがこの種別のページに表示された場合、オブジェクト固有のクイックアクションが含まれ、オブジェクト固有の戦略を使用しておすすめが絞り込まれます。API バージョン 46.0 以降で利用できます。
| 項目名 | 項目の型 | 説明 |
|---|---|---|
| entityName | string | 必須。コンテキストとして使用するオブジェクトの API 参照名を指定します。 |
| recommendationStrategy | string | このページのデフォルトの戦略を上書きする Next Best Action 戦略の API 参照名を指定します。戦略は、RecommendationStrategy メタデータ型です。 |
RecordActionRecommendation
コンポーネントでの Next Best Action のおすすめの表示設定を指定します。API バージョン 46.0 以降で利用できます。
| 項目名 | 項目の型 | 説明 |
|---|---|---|
| defaultStrategy | string | デフォルトの Next Best Action 戦略の API 参照名を指定します。戦略は、RecommendationStrategy メタデータ型です。 |
| hasDescription | boolean | 必須。true の場合、おすすめの説明を表示します。 |
| hasImage | boolean | 必須。true の場合、おすすめの画像を表示します。 |
| hasRejectAction | boolean | 必須。true の場合、ユーザがおすすめを却下するためにクリックするボタンの表示ラベルを表示します。 |
| hasTitle | boolean | 必須。true の場合、おすすめのタイトルを表示します。 |
| maxDisplayRecommendations | int | 必須。表示するおすすめの最大数を指定します。有効な値は 1 ～ 4 です。 |
RecordActionSelectableItem
ユーザが実行時にコンポーネントに追加できるアクションのセットを表します。
| 項目名 | 項目の型 | 説明 |
|---|---|---|
| action | string | 必須。アクションの API 参照名を指定します。たとえば、フローの API 参照名 (Verify_Information など)。 |
| type | RecordActionType (string 型の列挙) | 必須。レコードに関連付けられたアクションの種別。有効な値は、次のとおりです。
|
| isFrequentAction | boolean | アクションがユーザから頻繁にアクセスされたか (true)、否か (false) を示します。バージョン 57.0 以降で利用できます。 |
| frequentActionSequenceNbr | integer | アクションランチャーに表示される、頻繁に使用するアクションに割り当てられた連番。バージョン 57.0 以降で利用できます。 |
マニフェストファイル内のワイルドカードのサポート
このメタデータ型では、package.xml マニフェストファイル内のワイルドカード文字 * (アスタリスク) がサポートされます。マニフェストファイルの使用についての詳細は、「zip ファイルを使用したメタデータのリリースと取得」を参照してください。
宣言的なメタデータの定義のサンプル
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 <isFrequentAction>true</isFrequentAction>
27 <frequentActionSequenceNbr>1</frequentActionSequenceNbr>
28 </selectableItems>
29 <selectableItems>
30 <action>Sample_Flow_2</action>
31 <type>Flow</type>
32 <isFrequentAction>false</isFrequentAction>
33 </selectableItems>
34 <hasGuidedActions>true</hasGuidedActions>
35 <hasRecommendations>true</hasRecommendations>
36 <recommendation>
37 <defaultStrategy>Sample_Global_Strategy</defaultStrategy>
38 <maxDisplayRecommendations>4</maxDisplayRecommendations>
39 <hasImage>true</hasImage>
40 <hasDescription>true</hasDescription>
41 <hasRejectAction>true</hasRejectAction>
42 <hasTitle>true</hasTitle>
43 </recommendation>
44 <deploymentContexts>
45 <entityName>Case</entityName>
46 <recommendationStrategy>Sample_Case_Strategy</recommendationStrategy>
47 </deploymentContexts>
48 <deploymentContexts>
49 <entityName>Account</entityName>
50 <recommendationStrategy>Sample_Acc_Strategy</recommendationStrategy>
51 </deploymentContexts>
52</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>