メタデータ API 開発者ガイド
jHistoryRetentionPolicy
項目履歴データを保持するためのポリシーを表します。ポリシーを設定することで、Salesforce に項目履歴を保持する月数とアーカイブに項目履歴を保持する年数を指定できます。
このコンポーネントは、「項目履歴の保持」権限を持つユーザのみが使用できます。
宣言的なメタデータファイルのサフィックスおよびディレクトリの場所
項目履歴の保持ポリシーは、標準オブジェクトまたはカスタムオブジェクトの一部として定義されます。オブジェクトの項目履歴の保持ポリシーは、個別に設定できます。詳細は、「CustomObject」を参照してください。
項目
| 項目名 | データ型 | 説明 |
|---|---|---|
| archiveAfterMonths | int | 必須。項目履歴データがアーカイブされる前に Salesforce に保持する月数。最小 1 か月、最大 18 か月に設定できます。数値が設定されていない場合、デフォルトは 18 か月です (つまり、Salesforce では、アーカイブする前にデータが 18 か月間保持されます)。 |
| archiveRetentionYears | int | 必須。アーカイブにデータを保持する年数。最小 0 年、最大 10 年に設定できます。数値が設定されていない場合、デフォルトは 10 年です。 |
| description | string | 履歴保持のテキストによる説明。 |
| gracePeriodDays | int | データがアーカイブされる前の archiveAfterMonths 期間後の余分の日数。gracePeriodDays 期間は、データの初回のアーカイブにのみ適用されます。これは、初回のアーカイブ操作ではすべてのデータがコピーされるため、前回のアーカイブ操作以降に変更されたデータのみがコピーされる後続のアーカイブ操作より時間がかかるためです。gracePeriodDays には、初回のアーカイブ操作を行う前にシステム管理者が組織を準備するための余分な時間が含まれます。最小 0 日、最大 10 日に設定できます。数値が設定されていない場合、デフォルトは 1 日です。 |
宣言的なメタデータの定義のサンプル
次のサンプルでは、カスタムオブジェクトの履歴保持ポリシーの定義を示します。
1<?xml version="1.0" encoding="UTF-8"?>
2<CustomObject xmlns="http://soap.sforce.com/2006/04/metadata">
3 <historyRetentionPolicy>
4 <archiveAfterMonths>6</archiveAfterMonths>
5 <archiveRetentionYears>5</archiveRetentionYears>
6 <description>My field history retention</description>
7 </historyRetentionPolicy>
8 <fields>
9 <fullName>AccountSource</fullName>
10...
11</CustomObject>