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

Metadata メタデータ型を拡張し、その fullName 項目を継承します。

メタデータ API を使用して、組織から別の組織にカテゴリ変更をリリースすると、XML ファイルで指定されていないカテゴリとレコードカテゴリが完全に削除されます。Salesforce では、Sandbox から本番組織に変更をリリースするのではなく、[設定] から [クイック検索] ボックスに「データカテゴリ」と入力し、[データカテゴリ] を選択して、組織内のデータカテゴリとレコードの関連付けを手動で作成することをお勧めします。詳細は、「使用方法」を参照してください。

警告

データカテゴリグループでは次を行えます。

データの分類と絞り込み。
ユーザー間でのデータの共有。

各データカテゴリグループには、階層的にまとめることのできる項目またはデータカテゴリが含まれます。

下の例は、Geography データカテゴリグループとそのデータカテゴリを示します。

1Geography
2    Worldwide
3        North America
4            United States of America
5            Canada
6            Mexico
7        Europe
8        Asia

データカテゴリグループ、データカテゴリ、親カテゴリ、およびサブカテゴリについての詳細は、Salesforce オンラインヘルプの「データカテゴリの操作」を参照してください。

メモ

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

ファイルのサフィックスは、.datacategorygroup です。各データカテゴリグループに 1 つのファイルがあり、対応するパッケージディレクトリの datacategorygroups フォルダーに保存されます。

バージョン

��ータカテゴリグループは API バージョン 18.0 以降で使用できます。

項目

このメタデータ型には、次の項目が含まれます。

項目名	項目の型	説明
active	boolean	必須。カテゴリグループの状況。このカテゴリグループが有効であるか (`true`)、否か (`false`) を示します。
dataCategory	DataCategory	必須。データカテゴリグループ内の最上位レベルのカテゴリ。
description	string	データカテゴリグループの説明。
fullName	string	必須。データカテゴリグループの一意の名前。データカテゴリグループを作成するとき、fullName 項目とファイル名 (サフィックスを含まない) が一致している必要があります。fullName には、アンダースコアと英数字のみを使用できます。一意であること、最初は文字であること、空白は使用しない、最後にアンダースコアを使用しない、2 つ続けてアンダースコアを使用しないという制約があります。この項目は、Metadata コンポーネントから継承されています。
label	string	必須。Salesforce のオブジェクトを表す表示ラベル。
objectUsage	ObjectUsage	データカテゴリグループと関連付けられたオブジェクト。

DataCategory

データカテゴリグループの項目 (またはデータカテゴリ) を表します。データカテゴリは、他のデータカテゴリのリストを再帰的に含めることができます。

項目名	項目の型	説明
dataCategory	DataCategory[]	サブデータカテゴリの再帰的リスト。たとえば、一大陸内の国のリストです。各データカテゴリグループに最大 100 個のカテゴリを作成し、各データカテゴリグループ階層に最大 5 つのレベルを設定できます。
label	string	必須。Salesforce ユーザーインターフェースでのデータカテゴリの表示ラベル。
name	string	必須。API アクセスの一意の識別子として使用されるデータカテゴリの開発者名。名前には、英数字、およびアンダースコア (_) 文字のみを使用できます。また、最初は文字とし、最後にアンダースコアを使用したり、連続した 2 つのアンダースコア文字を含めたりすることはできません。この項目の値は一度定義されると、後で変更できません。重要組織にすでに存在するカテゴリグループをリリースすると、XML ファイルで定義されていないカテゴリは、組織から完全に削除されます。詳細は、「使用方法」を参照してください。警告

ObjectUsage

データカテゴリグループに関連付けることができるオブジェクトを表します。この関連付けによって、データカテゴリを使用したオブジェクトの分類および絞り込みが可能になります。

項目名	項目の型	説明
object	string[]	データカテゴリグループに関連付けることができるオブジェクト名のリスト。有効な値は、次のとおりです。 `KnowledgeArticleVersion` — 記事を関連付けます。データカテゴリグループの記事への関連付けについての詳細は、Salesforce オンラインヘルプの「記事のデフォルトのカテゴリグループ割り当ての変更」を参照してください。 `Question` — 質問を関連付けます。`Question` オブジェクトを最大 1 つのカテゴリグループに関連付けることができます。組織にすでに存在するカテゴリグループをリリースすると、XML ファイルで定義されていないオブジェクトの関連付けは、組織から完全に削除されます。組織のカテゴリグループに関連付けられたすべてのレコードを必ず XML ファイルで指定するようにしてください。詳細は、「使用方法」を参照してください。警告

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

これは、Geography データカテゴリグループとそのデータカテゴリの定義のサンプルです。

1<?xml version="1.0" encoding="UTF-8"?>
2<DataCategoryGroup xmlns="http://soap.sforce.com/2006/04/metadata">
3   <label>Geography</label>
4   <description>Geography structure of service center locations</description>
5   <fullName>geo</fullName>
6
7   <dataCategory> <name>WW</name> <label>Worldwide</label>
8      <dataCategory> <name>AMER</name> <label>North America</label>
9         <dataCategory>
10             <name>USA</name>
11             <label>United States of America</label>
12         </dataCategory> 
13         <dataCategory>
14             <name>CAN</name>
15             <label>Canada</label>
16         </dataCategory>
17         <dataCategory>
18             <name>MEX</name>
19             <label>Mexico</label>
20         </dataCategory>
21      </dataCategory> 
22      <dataCategory> <name>EMEA</name> <label>Europe, Middle East, Africa</label> 
23         <dataCategory>
24             <name>FR</name>
25             <label>France</label>
26         </dataCategory> 
27         <dataCategory>
28             <name>SP</name>
29             <label>Spain</label>
30        </dataCategory>
31         <dataCategory>
32            <name>UK</name>
33            <label>United-Kingdom</label>
34         </dataCategory>
35      </dataCategory>
36      <dataCategory>
37          <name>APAC</name>
38          <label>Asia</label>
39      </dataCategory>
40   </dataCategory>
41
42   <objectUsage>
43      <object>KnowledgeArticleVersion </object>
44   <objectUsage>
45</DataCategoryGroup>

使用方法

カテゴリグループ XML ファイルをリリースするとき、メタデータ API は、対象の組織にそのカテゴリグループが存在するかどうかを確認します。カテゴリグループが存在しない場合は作成されます。カテゴリグループがすでに存在する場合、メタデータ API は次を実行します。

XML ファイルで定義されている新しいカテゴリまたはオブジェクトを追加する。
XML ファイルで定義されていないすべてのカテゴリを削除する。削除されるカテゴリに関連付けられたレコードは、その親カテゴリに再度関連付けられます。
XML ファイルで定義されていないオブジェクトの関連付けをすべて削除する。
カテゴリが XML ファイルに指定された階層位置とは異なる位置に存在する場合、そのカテゴリを移動する。
カテゴリが新しい親カテゴリに移動すると、新しい親カテゴリの表示を許可されていないユーザーは再配置されたカテゴリを表示できません。
メモ

カテゴリの削除、カテゴリの再位置付けとそれがレコードカテゴリと表示設定に与える影響についての詳細は、Salesforce オンラインヘルプの「データカテゴリの削除」および「データカテゴリの変更および配置」を参照してください。

メモ

メタデータ API を使用して、組織から別の組織にカテゴリ変更をリリースすると、XML ファイルで指定されていないカテゴリとレコードカテゴリが完全に削除されます。Salesforce では、Sandbox から本番組織に変更をリリースするのではなく、[設定] から [クイック検索] ボックスに「データカテゴリ」と入力し、[データカテゴリ] を選択して、組織内のデータカテゴリとレコードの関連付けを手動で作成することをお勧めします。

次の例では、Geography データカテゴリグループの階層の XML 表現を、このデータカテゴリグループがすでに定義されている組織にリリースするとどのようになるかを説明します。組織には、US カテゴリが含まれますが、XML ファイルには、同じ階層位置に USA カテゴリが含まれます。メタデータ API リリースプロセスは、組織から US カテゴリを削除し、すべてのレコードの関連付けを US から親 AMER カテゴリに移動します。また、USA カテゴリを AMER の下に追加します。以前に US のカテゴリに分類されていたすべてのレコードは、AMER カテゴリに関連付けられます。

組織内ではカテゴリ「US」、XML ファイルではカテゴリ「USA」を使用する、「場所」カテゴリグループ

次の例では、データカテゴリグループのカテゴリを削除または移動し、その XML 表現を Sandbox から、このデータカテゴリグループをすでに定義している本番組織にリリースするとどのようになるかを説明しています。階層 1 は、Sandbox 組織の最初のデータカテゴリグループを示します。階層 2 では、EU カテゴリを EMEA の下に追加し、FR、SP、および UK を EU の下に移動しています。階層 3 では、FR を削除し、そのレコードをその新しい親 EU に関連付けています。最後に、変更を Sandbox から本番組織にリリースします。

メタデータ API は、Sandbox 組織に適用される変更の順序を識別しません。変更をある組織から別の組織にリリースするだけです。リリース中、最初に FR カテゴリの削除を検出し、本番組織からそのカテゴリを削除します。次に、すべてのレコードの関連付けを FR から、本番組織でその親である EMEA に移動します。メタデータ API は、EU カテゴリを追加し、SP と UK をその下に移動します。両方の組織のカテゴリグループの階層は同��のように見えますが、本番組織のレコードカテゴリは Sandbox 組織とは異なります。最初に階層 1 で FR に関連付けられていたレコードは、Sandbox 組織では EU に関連付けられますが、本番組織では EMEA に関連付けられています。

マニフェストファイル内のワイルドカードのサポート

このメタデータ型では、package.xml マニフェストファイル内のワイルドカード文字 * (アスタリスク) がサポートされます。マニフェストファイルの使用についての詳細は、「zip ファイルを使用したメタデータのリリースと取得」を参照してください。