Table of Contents

Namespace System.DataAdministration

Codeunit

Name Summary
Codeunit System.DataAdministration."Media Cleanup" Provides an interface for cleaning up Media
Codeunit System.DataAdministration."Media Cleanup Runner"
Codeunit System.DataAdministration."Data Archive" Exposes functionality to archive / save data before deleting it.
Codeunit System.DataAdministration."Environment Cleanup" Codeunit that raises an event that could be used to clean up data when copying a company to new environment.
Codeunit System.DataAdministration."Table Information Cache" Exposes functionality to manage the Table Information Cache table and the Company Size Cache table.
Codeunit System.DataAdministration."Apply Retention Policy" This codeunit provides functions to apply a retention policy.
Codeunit System.DataAdministration."Reten. Pol. Allowed Tables" This codeunit is used to manage the list of allowed tables for which retention policies can be set up. Extensions can only approve the tables they create. Extensions cannot approve tables from other extensions.
Codeunit System.DataAdministration."Retention Policy Log" This codeunit provides functions for logging error, warning, and informational messages to the Retention Policy Log Entry table.
Codeunit System.DataAdministration."Retention Policy Setup" This codeunit contains helper methods for retention policy setups.

Table

Name Summary
Table System.DataAdministration."Reten. Pol. Deleting Param" The table is used as a parameter table for the DeleteRecords method on the Reten. Pol Deleting interface. if "Indirect Permission Required" is true and the implementation does not have the required indirect permissions, then "Skip Event Indirect Perm. Req." should be set to false. This will allow a subscriber to handle the deletion. if there are more records to be deleted than as indicated by "Max. Number of Rec. to Delete", then only a number of records equal to "Max. Number of Rec. to Delete" should be deleted. In the case where not all records were deleted, "Skip Event Rec. Limit Exceeded" should be set to false. This will allow either a subscriber or the user to schedule another run to delete the remaining records. "Total Max. Nr. of Rec. to Del." is provided for information only. This is the maximum number of records recommended to delete in a single run of Apply Retention Policies. "User Invoked Run" is provided for information only.
Table System.DataAdministration."Reten. Pol. Filtering Param" The table is used as a parameter table for the ApplyRetentionPolicyAllRecordFilters and ApplyRetentionPolicySubSetFilters methods on the Reten. Pol Filtering interface.
Table System.DataAdministration."Retention Period" The Retention Periods table is used to define retention periods. You define a retention period by selecting one of the default values in the Retention Period field, or by selecting the Custom value and providing a date formula. The date formula must result in a date that is at least two days before the current date.
Table System.DataAdministration."Retention Policy Setup" This table stores the retention policy setup records.
Table System.DataAdministration."Retention Policy Setup Line" This table stores the filter used to apply retention policies to subsets of records in a table.

Page

Name Summary
Page System.DataAdministration."Detached Media Cleanup"
Page System.DataAdministration."Media Cleanup FactBox"
Page System.DataAdministration."Company Size Cache Part" The Company Size Cache Part page shows information about company sizes.
Page System.DataAdministration."Table Information" The Table Information page shows information about database tables.
Page System.DataAdministration."Table Information Cache Part" The Table Information Cache Part page shows information about database tables.
Page System.DataAdministration."Retention Periods" List page that contains all of the retention periods that have been defined.
Page System.DataAdministration."Retention Policy Log Entries" Lists the entries in the Retention Policy Log.
Page System.DataAdministration."Reten. Policy Setup ListPart" This page lists all of the retention policies that have been defined.
Page System.DataAdministration."Retention Policy Setup Card" This page shows the retention policy setup.
Page System.DataAdministration."Retention Policy Setup Lines" This page shows the retention policy setup lines. Each line defines a subset of records in a table for which you can set a separate retention period.
Page System.DataAdministration."Retention Policy Setup List" This page lists all of the retention policies that have been defined.

Enum

Name Summary
Enum System.DataAdministration."Environment Type" Environment type
Enum System.DataAdministration."Reten. Pol. Deleting" This enum is used to determine the implementation codeunit called to delete expired records when applying a retention policy.
Enum System.DataAdministration."Reten. Pol. Filtering" This enum is used to determine the implementation codeunit called when filtering a table for expired records when applying a retention policy.
Enum System.DataAdministration."Retention Period Enum" Enum that defines standard retention periods.
Enum System.DataAdministration."Retention Policy Log Category" The Retention Policy Log Category is used to categorize log entries by area.
Enum System.DataAdministration."Retention Policy Log Message Type" Specifies the type of log message.

Interface

Name Summary
Interface System.DataAdministration."Data Archive Provider" Exposes an interface for Data Archive. Data Archive is called from application objects to store data.
Interface System.DataAdministration."Reten. Pol. Deleting" The Reten. Pol. Deleting interface is used to set filters on the table for which a retention policy is applied.
Interface System.DataAdministration."Reten. Pol. Filtering" The Reten. Pol. Filtering interface is used to set filters on the table for which a retention policy is applied.
Interface System.DataAdministration."Retention Period" The retention period interface provides functions to retrieve the date formula and calculate the expiration date based on a retention period record.

PermissionSet

Name Summary
PermissionSet System.DataAdministration."Environment Cleanup - Read"
PermissionSet System.DataAdministration."Retention Pol. Admin"
PermissionSet System.DataAdministration."Retention Policy - Admin"
PermissionSet System.DataAdministration."Retention Policy - View" this is the minimum permission set needed to install an extension that adds a retention policy.
PermissionSet System.DataAdministration."Retention Pol. View" this is the minimum permission set needed to install an extension that adds a retention policy.

Events

Name Summary
OnDataArchiveImplementationExists Checks if there is an implementation of an IDataArchiveProvider
OnDataArchiveImplementationBind Asks for an implementation of an IDataArchiveProvider
OnClearCompanyConfig Subscribe to this event to clean up company-specific data when copying to a new environment.
OnClearDatabaseConfig Subscribe to this event to clean up environment-specific data when copying to a new environment.
OnApplyRetentionPolicyRecordLimitExceeded This event is raised once the maximum number of records which can be deleted in a single run is reached. The limit is defined internally and cannot be changed. The event can be used to schedule a new run to delete the remaining records.
OnApplyRetentionPolicyIndirectPermissionRequired This event is raised when the user applying the retention policy has indirect permissions to delete records in the table. A subscriber to this event with indirect permissions can delete the records on behalf of the user.
OnRefreshAllowedTables This event is called when the user chooses to refresh the allowed tables.