この文章は Salesforce 機械翻訳システムを使用して翻訳されました。詳細はこちらをご参照ください。

Territory2Model

Territory Management 2.0 でテリトリーモデルに関連付けられているメタデータを表します。Metadata メタデータ型を拡張し、その fullName 項目を継承します。Salesforce 組織で Territory Management 2.0 が有効化されている場合にのみ使用できます。

ファイルのサフィックスおよびディレクトリの場所

Territory2Model コンポーネントのサフィックスは territory2Model で、territory2Models フォルダに保存されます。

バージョン

Territory2Model コンポーネントは、API バージョン 32.0 以降で使用できます。

特別なアクセスルール

Territory2Model オブジェクトは、SOAP API に State 項目があります。状態は計画中、有効、アーカイブ済みのほか、コピー中などプロセスが進行中であることを示すものも多数あります。「テリトリーの管理」権限がないユーザは、有効状態のモデルのみにアクセスできます。すべてのテリトリー管理エンティティに対する deploy() コールには、メタデータ API で必要な「すべてのデータの編集」権限のほかに「テリトリーの管理」権限が必要です。「テリトリーの管理」権限のないユーザが retrieve() を実行すると、有効状態の Territory2Model に属するエンティティのみが返されます。「テリトリーの管理」権限なしにコールを実行してもデータの一部しか取得されないためお勧めしません。

項目

項目名	データ型	説明
customFields	FieldValue	Territory2Model オブジェクト上で定義された、このモデルによって使用されるカスタム項目です。そのメタデータは別個に取得されます。 Territory2 オブジェクトおよび Territory2Model オブジェクトは、ロングテキストエリア項目、リッチテキストエリア項目、およびテキストで暗号化されたカスタム項目の値を処理しません。項目は、その API 名を使用して参照されます。地理位置情報のような複合項目種別は、いくつかの要素で構成される列項目として表示されます。たとえば、nnn_Latitude__s、nnn_Longitude__s などで構成され、「nnn」は項目名、サフィックスは地理位置情報コンポーネントです。必須カスタム項目の値は、`deploy()` 操作中に適用されます。
description	string	テリトリーモデルの説明です。
name	string	必須。テリトリーモデルのユーザインターフェース表示ラベルです。

宣言的なメタデータの定義のサンプル

次の例は、Territory2Model コンポーネントの定義を示します。

1<?xml version="1.0" encoding="UTF-8"?>
2    <Territory2Model xmlns="http://soap.sforce.com/2006/04/metadata" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
3    <name>FY13</name>
4    <description>Geographic allocation</description>
5    <customFields>
6        <name>Activation_DateTime__c</name>
7        <value xsi:type="xsd:dateTime">2014-07-16T05:05:00.000Z</value>
8    </customFields>
9    <customFields>
10        <name>AutoNumber__c</name>
11        <value xsi:type="xsd:string">M# 000001</value>
12    </customFields>
13    <customFields>
14        <name>DeactivationDate__c</name>
15        <value xsi:type="xsd:date">2016-07-12</value>
16    </customFields>
17    <customFields>
18        <name>External_Id__c</name>
19        <value xsi:nil="true"/>
20    </customFields>
21</Territory2Model>

使用方法

retrieve() コールは、コピー中、コピー失敗、削除中、および削除失敗の 4 つの状態のモデルを返しません。
モデルが作成されると、最初の状態は必ず計画中になります。deploy() 操作を実行できるのは、計画中または有効状態のモデルのみです。同じ要件が、これらのモデルに関連付けられたテリトリーとルールに適用されます。たとえば、Sandbox 組織に計画中状態のモデルがあり、本番組織にアーカイブ済み状態の同じ開発者名を持つモデルがあるとします。このモデルの状態がアーカイブ済みであり、この状態はモデルへの変更を禁止するため、本番組織での deploy() 操作は失敗します。
同一の開発者名を持つさまざまな組織にテリトリーモデルがあり、deploy() 操作を実行しようとしている場合、メタデータ API は新しいモデルを作成しようとしますが、状態の制限により、この操作は開発者名の競合が原因で失敗します。たとえば、Sandbox 組織に計画中状態のモデルがあり、本番組織にアーカイブ済み状態の同じ開発者名を持つモデルがあるとします。このモデルの状態がアーカイブ済みであり、この状態はモデルへの変更を禁止するため、本番組織での deploy() 操作は失敗します。
テリトリーを持つモデルを削除する場合、delete() コールによってモデルの状態が削除中に変更され、モデル内のすべてのテリトリー、ルール、およびユーザの関連付けがカスケード削除されます。モデル内のテリトリーの数に応じて、削除にしばらく時間がかかることがあります。
モデルが作成されると、最初の状態は必ず計画中になります。同じ開発者名を持つモデルがすでに存在する場合、すでに何らかの状態になっているため、Territory2 には State 項目を含めません。
Territory Management 2.0 のコンポーネントは、パッケージ化や変更セットをサポートしておらず、CRUD コールでサポートされていません。

メタデータ API 開発者ガイド