Newer Version Available

This content describes an older version of this product. View Latest

ArchiveActivity

Represents metadata retrieved for a single Archive process initiated by an action. Retrieved metadata can include status tracking, start and end times, record counts, and monitoring and auditing outcomes. This object is available in API version 65.0 and later.

Supported Calls

describeSObjects(), query()

Special Access Rules

This object is Read-Only and can't be deleted. Storage consumed by this object doesn't count toward your org's data storage limits.

Fields

Field Details
ArchivePolicyId
Type
reference
Properties
Filter, Group, Sort
Description
ID of the associated policy that triggered the process. Links each execution back to its configuration.
AttemptedRootRecordsCount
Type
int
Properties
Filter, Sort
Description
The number of root records that the action tried to process. Excludes records that were filtered out before processing began.
EndTime
Type
dateTime
Properties
Filter, Sort
Description
The date and time that the process executed successfully, or was terminated due to error.
FailedCount
Type
int
Properties
Filter, Sort
Description
The number of records that failed to process due to errors such as validation failures, missing references, or system exceptions.
FailureReason
Type
string
Properties
Filter, Group, Sort
Description
Description of why process failed or only partially completed. Can include system error messages or policy-level failures.
Name
Type
string
Properties
Filter, Group, Sort
Description
The autogenerated name of the action instance.
ProgressPercentage
Type
double
Properties
Filter, Sort
Description
The percentage of records that were successfully processed.
RecordsSizeInMb
Type
double
Properties
Filter, Sort
Description
Estimated total size, in megabytes (MB), of the records processed during an action, including metadata and payload.
SkippedRootRecordsCount
Type
int
Properties
Filter, Sort
Description
The number of root records skipped due to validation errors, exclusion filters, or data protection thresholds.
StartTime
Type
dateTime
Properties
Filter, Sort
Description
The date and time that the action started.
Status
Type
picklist
Properties
Filter, Group, Sort
Description
Status of the current activity.

Valid values are:

  • Aborted—Policy manually aborted during policy run.
  • AbortingAborted process has started.
  • Archive Timeout—Process automatically stopped because it took too long to execute a specific task, or the entire run.
  • Completed—Process completed successfully, and all records were processed.
  • Ended with Delete Failures—Process finished its run, but failed to delete one or more designated items.
  • Ended With Errors—Process finished successfully, but some records weren't processed. A CSV of the failed records can be downloaded from the Execution Details‌ page.
  • Failed—Process failed, and no records were archived. A CSV of the failed records is available on the Activities tab.
  • No Records—Process ran successfully but found no records matching the policy criteria.
  • Pending—Process is in a queue waiting to be executed.
  • Process Exceeds 23h—Activity started and ran successfully until it reached a time limit. When a policy is set to run daily, this status indicates partial success before exceeding the time limit.
  • Process Exceeds 120h—Activity started and ran successfully until it reached a time limit. When a policy is set to run one time in a five-day period, this status indicates partial success before exceeding the time limit.
  • Process Exceeds 168h—Activity started and ran successfully until it reached a time limit. When a policy is set to run weekly, this status indicates partial success before exceeding the time limit.
  • Query Timeout—Process stopped because database query took too long to execute.
  • Running—Process is actively executing its tasks.
  • Started—Process has been initiated and is currently in progress.
  • Too Many Failures—Process was abandoned after too many records failed to read or delete.
SucceededCount
Type
int
Properties
Filter, Sort
Description
The number of records processed successfully.
TotalRecordCount
Type
int
Properties
Filter, Sort
Description
The total number of records initially selected for processing, including successful, failed, and skipped records.
Type
Type
picklist
Properties
Filter, Group, Sort
Description
Specifies the type of archive process to be executed. This static enum categorizes the purpose or mode of the run.

Valid values are:

  • Analyzer
  • Archive
  • Archive-fail-to-delete
  • Estimate
  • Export
  • Export-and-download
  • Export-to-external-bucket
  • Import-data-archive
  • Import-data-load
  • Index-request
  • None
  • Purge
  • Purge-by-retention
  • Purge-estimation
  • RTBF-SDK
  • Unarchive
  • Unarchive-retry
  • Unarchive-sdk