Archive data model

This topic describes the data model entities used for archiving.

`Policy`

The Policy entity has the following properties related to archiving:

Property	Description
`DoNotArchive`	Do not archive any of the terms for this policy. If you change this property from `true` to `false`, terms already archived are not automatically retrieved.

`PolicyTerm`

The PolicyTerm entity has the following properties related to archiving:

Property	Description
`Archived`	Value is `true` if at least one policy period associated with this policy term is archived.
`NextArchiveCheckDate`	The date to next evaluate this `PolicyTerm` for archiving. Value is `null` if archiving is to be checked at the next opportunity.
`RestoreRequests`	Array to PolicyTermRestoreRequest entity instances.

`PolicyTermRestoreRequest`

The PolicyTermRestoreRequest entity represents a request made to retrieve this term from the archive backing store and restore it to the PolicyCenter application database. This entity has the following properties related to archiving:

Property	Description
`PolicyTerm`	A foreign key to the policy term to retrieve from the archive.
`Reason`	The reason provided by the user.
`RequestingUser`	The user that initiated this request to retrieve the policy term.
`ShouldCreateActivity`	A flag that indicates whether to create an activity after processing this request.

`PolicyPeriod`

The PolicyPeriod entity has the following properties related to archiving:

Property	Description
`Archived`	This value is `true` if this policy period is archived.
`ArchiveDate`	The date on which archiving was attempted on the `PolicyPeriod`. Value is `null` if archiving has never been attempted.
`ArchiveFailure`	A foreign key to `ArchiveFailure`.
`ArchiveFailureDetails`	A foreign key to `ArchiveFailureDetails`.
`ArchiveSchemaInfo`	A foreign key to `UpgradeDatamodelInfo`, the schema version at which the `PolicyPeriod` was archived. Value is `null` if it was not archived.
`ArchiveState`	A type key that indicates the archive state of the graph. Values can be: `archived` – Graph has been archived `retrieving` – Graph is marked for retrieving
`Locked`	The row is locked and cannot be edited. It is only possible to archive a locked policy period.

`ArchiveFailure`

The ArchiveFailure entity contains a short description of the reason that archiving failed.

`ArchiveFailureDetails`

The ArchiveFailureDetails entity contains a detailed description of the reason that archiving failed.