メタデータ API 開発者ガイド
jTerritory2Model
Territory Management 2.0 でテリトリーモデルに関連付けられているメタデータを表します。Metadata メタデータ型を拡張し、その fullName 項目を継承します。Salesforce 組織でテリトリー管理 2.0 が有効化されている場合にのみ使用できます。
ファイルのサフィックスおよびディレクトリの場所
Territory2Model コンポーネントのサフィックスは territory2Model で、territory2Models フォルダに保存されます。
バージョン
Territory2Model コンポーネントは、API バージョン 32.0 以降で使用できます。
特別なアクセスルール
Territory2Model オブジェクトは、SOAP API に State 項目があります。状態には計画中、有効、アーカイブ済みのほか、コピー中などプロセスが進行中であることを示す他のいくつかの状態もあります。「テリトリーの管理」権限がないユーザは、有効状態のモデルのみにアクセスできます。すべてのテリトリー管理エンティティに対する deploy() コールには、「テリトリーの管理」権限が必要です。「テリトリーの管理」権限のないユーザが retrieve() を実行すると、有効状態の Territory2Model に属するエンティティのみが返されます。「テリトリーの管理」権限なしにコールを実行してもデータの一部しか取得されないためお勧めしません。
項目
| 項目名 | 項目の型 | 説明 |
|---|---|---|
| customFields | FieldValue | Territory2Model オブジェクト上で定義された、このモデルによって使用されるカスタム項目です。そのメタデータは別個に取得されます。
|
| description | string | テリトリーモデルの説明です。 |
| name | string | 必須。テリトリーモデルのユーザインターフェース表示ラベルです。 |
使用方法
- retrieve() コールは、コピー中、コピー失敗、削除中、および削除失敗の 4 つの状態のモデルを返しません。
- モデルが作成されると、最初の状態は必ず計画中になります。deploy() 操作を実行できるのは、計画中または有効状態のモデルのみです。同じ要件が、これらのモデルに関連付けられたテリトリーとルールに適用されます。たとえば、Sandbox 組織に計画中状態のモデルがあり、本番組織にアーカイブ済み状態の同じ開発者名を持つモデルがあるとします。本番組織のモデルの状態はアーカイブ済みであり、この状態ではモデルへの変更が禁止されるため、本番組織での deploy() 操作は失敗します。
- 同一の開発者名を持つテリトリーモデルがさまざまな組織にある場合に deploy() 操作を実行しようとすると、メタデータ API は新しいモデルを作成しようとしますが、状態の制限により、この操作は開発者名の競合が原因で失敗します。たとえば、Sandbox 組織に計画中状態のモデルがあり、本番組織にアーカイブ済み状態の同じ開発者名を持つモデルがあるとします。本番組織のモデルの状態はアーカイブ済みであり、この状態ではモデルへの変更が禁止されるため、本番組織での deploy() 操作は失敗します。
- テリトリーを持つモデルを削除する場合、delete() コールによってモデルの状態が削除中に変更され、モデル内のすべてのテリトリー、ルール、およびユーザの関連付けがカスケード削除されます。モデル内のテリトリーの数に応じて、削除にしばらく時間がかかる可能性があります。
- モデルが作成されると、最初の状態は必ず計画中になります。同じ開発者名を持つモデルがすでに存在する場合、すでに何らかの状態になっているため、Territory2 には State 項目を含めません。
- Territory Management 2.0 のコンポーネントは、パッケージ化や変更セットをサポートしておらず、CRUD コールでサポートされていません。
- 名前空間はロック解除されたパッケージではサポートされていません。
マニフェストファイル内のワイルドカードのサポート
このメタデータ型では、package.xml マニフェストファイル内のワイルドカード文字 * (アスタリスク) がサポートされます。マニフェストファイルの使用についての詳細は、「zip ファイルを使用したメタデータのリリースと取得」を参照してください。