メタデータ API 開発者ガイド
jPathAssistant
PathAssistant を使用する場合、次の点に注意してください。
- __Master__ レコードタイプなど、各オブジェクトのレコードタイプごとに作成できるパスは 1 つのみです。
- リッチテキストのガイダンス情報は、トランスレーションワークベンチから取得したり、トランスレーションワークベンチにリリースしたりできません。
- PathAssistant を取得またはリリースするために、設定をオンにする必要はありません。
ファイルのサフィックスおよびディレクトリの場所
PathAssistant コンポーネントのサフィックスは .pathAssistant で、pathAssistants フォルダに保存されます。
バージョン
PathAssistant コンポーネントは、API バージョン 34.0 以降で使用できます。
項目
| 項目名 | データ型 | 説明 |
|---|---|---|
| active | boolean | パスが有効か (true)、有効でないか (false) を示します。 |
| entityName | string | 必須。エンティティ名。これは Opportunity、Lead、Quote 用にハードコードされています。カスタムオブジェクトの場合、この項目を指定する必要があり、カスタムオブジェクト名を指定する必要があります。この項目は更新できません。 |
| fieldName | string | 必須。項目名。これは StageName および Status 用にハードコードされています。カスタムオブジェクトの場合、この項目を指定する必要があり、パスのステップを決定する選択リスト項目の名前を指定する必要があります。この項目は更新できません。 |
| masterLabel | string | 必須。パスのマスタ表示ラベル。 |
| pathAssistantSteps | PathAssistantStep[] | 項目およびガイダンス情報で設定されたすべてのステップのリスト。.xml ファイルにステップがない場合、存在しないのではなく、設定されていないことを意味します。 |
| recordTypeName | string | 必須。パスに関連付けられたレコードタイプの名前。この項目は更新できません。 |
PathAssistantStep
パスのステップまたはフェーズを表します。
| 項目名 | データ型 | 説明 |
|---|---|---|
| fieldNames | string | このステップに表示される entityName のすべての項目。 |
| info | string | このステップに表示されるガイダンス情報。 |
| picklistValueName | string | 必須。ステップに関連付けられた選択リスト値。 |
宣言的なメタデータの定義のサンプル
PathAssistant コンポーネントの例を次に示します。
1<?xml version="1.0" encoding="UTF-8"?>
2<PathAssistant xmlns="http://soap.sforce.com/2006/04/metadata">
3 <active>true</active>
4 <entityName>Opportunity</entityName>
5 <fieldName>StageName</fieldName>
6 <masterLabel>Test Path</masterLabel>
7 <pathAssistantSteps>
8 <fieldNames>Amount</fieldNames>
9 <fieldNames>CloseDate</fieldNames>
10 <info>Some Text</info>
11 <picklistValueName>Id. Decision Makers</picklistValueName>
12 </pathAssistantSteps>
13 <pathAssistantSteps>
14 <fieldNames>Amount</fieldNames>
15 <fieldNames>CloseDate</fieldNames>
16 <info>Some Text</info>
17 <picklistValueName>Proposal/Price Quote</picklistValueName>
18 </pathAssistantSteps>
19 <recordTypeName>Test_Record_Type</recordTypeName>
20</PathAssistant>前の定義を参照する package.xml の例を次に示します。
1<?xml version="1.0" encoding="UTF-8"?>
2<Package xmlns="http://soap.sforce.com/2006/04/metadata">
3 <types>
4 <members>Opportunity.Test_Busines_Process</members>
5 <name>BusinessProcess</name>
6 </types>
7 <types>
8 <members>Opportunity.StageName</members>
9 <members>Lead.LeadSource</members>
10 <members>Opportunity.Type</members>
11 <name>CustomField</name>
12 </types>
13 <types>
14 <members>Test_Path</members>
15 <name>PathAssistant</name>
16 </types>
17 <types>
18 <members>Opportunity.Test_Record_Type</members>
19 <name>RecordType</name>
20 </types>
21 <types>
22 <members>PathAssistant</members>
23 <name>Settings</name>
24 </types>
25 <version>39.0</version>
26</Package>