メタデータ API 開発者ガイド
jLeadConfigSettings
リードの変換方法と表示方法、および使用可能なアクションを制御するリードの構成設定を表します。Metadata メタデータ型を拡張し、その fullName 項目を継承します。
パッケージマニフェストでは、「Settings」の名前を使用してすべての組織設定メタデータ型にアクセスします。詳細は「設定」を参照してください。
ファイルのサフィックスおよびディレクトリの場所
LeadConfigSettings の値は、settings フォルダの LeadConfig.settings ファイルに保存されます。.settings ファイルは、各設定コンポーネントに設定ファイルが 1 つしかないため、他の名前つきのコンポーネントとは異なります。
バージョン
LeadConfigSettings は、API バージョン 47.0 以降で使用できます。
項目
| 項目名 | 項目の型 | 説明 |
|---|---|---|
| doesEnableLeadConvertDefaultSubjectBlankTaskCreation | boolean | リードの変換中に件名のない ToDo を作成するかどうかを設定します。true の場合、デフォルトの件名項目に値がないときに ToDo が作成されます。false の場合、件名のある ToDo のみが作成されます。 |
| doesHideOpportunityInConvertLeadWindow | boolean | リードの変換中に、[リードの取引の開始] ウィンドウで [商談] セクションを非表示にします。 デフォルト値は false です。 |
| doesPreserveLeadStatus | boolean | 組織でレコードタイプを使用している場合、変換中にリードの状況は新しい所有者のレコードタイプのリードの状況値に変更されます。変換中にリードの状況値を保持するには、doesPreserveLeadStatus を true に設定します。 レコードタイプを使用する組織は、異なるレコードタイプに対して異なるリードの状況値を許可するリードプロセスを作成できます。doesPreserveLeadStatus が false の場合、新しい所有者のレコードタイプに異なるリードのデフォルト状況値があると、リードの変換中にリードの状況が変更される可能性があります。 デフォルト値は true です。 |
| doesSelectNoOpportunityOnConvertLead | boolean | リードが変換されるときに商談が作成されないようにします。 デフォルト値は false です。 |
| doesTrackHistory | boolean | リードの項目履歴管理を有効にします。項目履歴管理が有効になっている場合、ユーザは追跡する項目を選択できます。 デフォルト値は false です。 |
| enableConversionsOnMobile | boolean | ユーザがモバイルデバイスでリードを変換できるようにします。[リードの取引の開始] アクションを使用して、評価済みリードを取引先責任者に変換します。 デフォルト値は true です。 |
| enableOrgWideMergeAndDelete | boolean | ユーザがリードをマージおよび削除できるようにします。ユーザは、「公開/参照・更新・所有権の移行」権限も所有している必要があります。 デフォルト値は false です。 |
| shouldLeadConvertRequireValidation | boolean | リードの変換時に入力規則を適用します。 デフォルト値は true です。 |
宣言的なメタデータの定義のサンプル
次に、LeadConfigSettings 型の例を示します。
1<?xml version="1.0" encoding="UTF-8"?>
2<LeadConfigSettings xmlns="http://soap.sforce.com/2006/04/metadata">
3
4 <doesEnableLeadConvertDefaultSubjectBlankTaskCreation>true</doesEnableLeadConvertDefaultSubjectBlankTaskCreation>
5 <enableConversionsOnMobile>true</enableConversionsOnMobile>
6 <shouldLeadConvertRequireValidation>true</shouldLeadConvertRequireValidation>
7 <enableOrgWideMergeAndDelete>false</enableOrgWideMergeAndDelete>
8 <doesPreserveLeadStatus>true</doesPreserveLeadStatus>
9 <doesSelectNoOpportunityOnConvertLead>false</doesSelectNoOpportunityOnConvertLead>
10 <doesHideOpportunityInConvertLeadWindow>false</doesHideOpportunityInConvertLeadWindow>
11 <doesTrackHistory>false</doesTrackHistory>
12</LeadConfigSettings>パッケージマニフェストの例
組織の取引先設定メタデータをリリースまたは取得するために使用される、パッケージマニフェストの例を次に示します。
1<?xml version="1.0" encoding="UTF-8"?>
2<!--
3
4<Package xmlns="http://soap.sforce.com/2006/04/metadata">
5 <types>
6 <members>LeadConfig</members>
7 <name>Settings</name>
8 </types>
9 <version>47.0</version>
10</Package>