Territory2
ファイルのサフィックスおよびディレクトリの場所
Territory2 コンポーネントのサフィックスは territory2 で、対応する Territory2Model のフォルダの下位にある territories フォルダに保存されます。
バージョン
Territory2 コンポーネントは、API バージョン 32.0 以降で使用できます。
特別なアクセスルール
Territory2Model オブジェクトは、SOAP API に State 項目があります。状態は計画中、有効、アーカイブ済みのほか、コピー中などプロセスが進行中であることを示すものも多数あります。「テリトリーの管理」権限のないユーザは、有効状態のモデルに属するテリトリーにのみアクセスできます。すべてのテリトリー管理エンティティに対する deploy() コールには、メタデータ API で必要な「すべてのデータの編集」権限のほかに「テリトリーの管理」権限が必要です。「テリトリーの管理」権限のないユーザが retrieve() を実行すると、有効状態の Territory2Model に属するエンティティのみが返されます。「テリトリーの管理」権限なしにコールを実行してもデータの一部しか取得されないためお勧めしません。
項目
| 項目名 | データ型 | 説明 |
|---|---|---|
| accountAccessLevel | string | このテリトリーのユーザが、このテリトリーに割り当てられている (通常ならアクセスできない) 取引先にアクセスできるかどうかを指定します。有効な値は、次のとおりです。
|
| caseAccessLevel | string | このテリトリーのユーザが、このテリトリーに割り当てられている (通常ならアクセスできない) ケースにアクセスできるかどうかを指定します。有効な値は、次のとおりです。
|
| contactAccessLevel | string | このテリトリーのユーザが、このテリトリーに割り当てられている (通常ならアクセスできない) 取引先責任者にアクセスできるかどうかを指定します。有効な値は、次のとおりです。
|
| customFields | FieldValue | Territory2 オブジェクトで定義され、このテリトリーで使用されるカスタム項目の値。このメタデータは、CustomObject で個別に取得されます。次の点に注意してください。
|
| description | string | テリトリーの説明です。 |
| name | string | 必須。テリトリーのユーザインターフェース表示ラベル。 |
| opportunityAccessLevel | string | このテリトリーのユーザが、このテリトリーに割り当てられている (通常ならアクセスできない) 商談にアクセスできるかどうかを指定します。有効な値は、次のとおりです。
|
| parentTerritory | string | テリトリーの上位テリトリーの名前。上位テリトリーを指定する場合は、開発者名を使用します。「完全修飾」名は使用しないでください。値の型を <value xsi:nil="true"/> に指定すると、値のないカスタム項目が取得されます。また、<value xsi:nil="true"/> 構文を使用して、カスタム項目の既存の値を削除することもできます。 |
| ruleAssociations | Territory2RuleAssociation | オブジェクト割り当てルールおよびテリトリーへの関連付けを表します。ルールの開発者名を使用します。 |
| territory2Type | string | 必須。テリトリーが属するテリトリー種別。 |
FieldValue
Territory2 オブジェクトのカスタム項目の値を表します。API バージョン 32.0 以降で使用できます。
| 項目名 | データ型 | 説明 |
|---|---|---|
| name | string | 必須。テリトリーのユーザインターフェース表示ラベル。 |
| value | 任意の種別 | 項目の値。null にすることもできます。項目種別は、XML で指定し、項目値によって異なります。 |
Territory2RuleAssociation
オブジェクト割り当てルールのテリトリーへの関連付けを表します。API バージョン 32.0 以降で使用できます。
| 項目名 | データ型 | 説明 |
|---|---|---|
| inherited | boolean | 必須。ルールが上位のテリトリーから継承されたルールか (true)、現在のテリトリーのローカルルールか (false) を示します。 ルールの継承は、テリトリーモデル階層内で、ルールが作成された上位テリトリーからルールの下位テリトリー (ある場合) に受け継がれます。ローカルルールは、1 つのテリトリー内で作成され、そのテリトリーにのみ影響します。 |
| ruleName | string | 必須。テリトリーに関連付けられたルールの名前。メタデータ API はルールがテリトリーと同じモデルに属すると想定するため、ruleName は完全修飾名である必要はありません。 |
宣言的なメタデータの定義のサンプル
次の例は、Territory2 コンポーネントの定義を示しています。
package.xml のサンプルを次に示します。FY13 および FY14 は、テリトリーモデルの名前を表し、異なるモデル内でルールに同一の開発名を指定できることを示しています。モデル名の代わりにワイルドカード記号 (*) を使用すると、組織内のすべてのモデルの全ルールが取得されます。
使用方法
- deploy() 操作中は、Territory2 で定義されたトリガが起動されません。
- Territory Management 2.0 のコンポーネントは、パッケージ化や変更セットをサポートしておらず、CRUD コールでサポートされていません。