メタデータ API 開発者ガイド
jHistoryRetentionPolicy
項目履歴データをアーカイブするためのポリシーを表します。ポリシーを設定するときは、項目履歴がアーカイブされる前に Salesforce に保持する月数を指定します。デフォルトでは、[項目監査履歴] が有効であるときは、すべての項目履歴が保持されます。
このコンポーネントは、「項目履歴の保持」権限を持つユーザのみが使用できます。
宣言的なメタデータファイルのサフィックスおよびディレクトリの場所
項目履歴の保持ポリシーは、標準オブジェクトまたはカスタムオブジェクトの一部として定義されます。オブジェクトの項目履歴の保持ポリシーは、個別に設定できます。詳細は、「CustomObject」を参照してください。
項目
| 項目名 | 項目の型 | 説明 |
|---|---|---|
| archiveAfterMonths | int | 必須。項目履歴データがアーカイブされる前に Salesforce に保持する月数。最小 1 か月、最大 18 か月に設定できます。数値が設定されていない場合、デフォルトは 18 か月です。(つまり、Salesforce では、アーカイブする前にデータが 18 か月間保持されます)。 |
| archiveRetentionYears | int | アーカイブのデータを手動で削除するまでの年数。この項目は、データの手動削除に関する備忘録として使用します。[項目監査履歴] が有効になっている場合、デフォルトでは項目履歴データは自動的に削除されません。 |
| description | string | 履歴保持のテキストによる説明。 |
| gracePeriodDays | int | データがアーカイブされる前の archiveAfterMonths 期間後の余分の日数。gracePeriodDays 期間は、データの初回のアーカイブにのみ適用されます。これは、初回のアーカイブ操作ではすべてのデータがコピーされるため、前回のアーカイブ操作以降に変更されたデータのみがコピーされる後続のアーカイブ操作より時間がかかるためです。gracePeriodDays には、初回のアーカイブ操作を行う前にシステム管理者が組織を準備するための余分な時間が含まれます。最小 0 日、最大 10 日に設定できます。数値が設定されていない場合、デフォルトは 1 日です。 |