Archiving Data

Last verified with: 10.8.6.0

Overview #

The Data Archive screen is used to monitor completed, queued, in-progress, failed, and cancelled data archive activity. It gives administrators a central place to review what archive job ran, what date range was processed, what data period was affected, and whether archive files were produced for download.

This screen is primarily operational. It is useful when you need to confirm that an archive completed successfully, understand what was archived or purged, review the time period covered by the job, or download generated archive files when they are available.

Selecting a record from the list displays its details on the right.

Available Archive Objects #

The following archive objects are defined in the current product data model for version 10.8.6.0. The default action type and duration below reflect the shipped configuration defaults. These defaults can be adjusted by configuration, but they provide a practical baseline for understanding how each archive object is intended to be used.

Object	What It Is Used For	Default Archive Type	Default Duration	Reason
Tax	Archives tax batch and tax-vendor log data, including related tax error details.	Archive and Purge	92 days	Helps retain historical tax-processing detail for audit and troubleshooting while removing older tax log volume from the live system.
Processed Usage Exceptions	Removes usage exceptions that have already been processed and no longer need to remain in the active exception set.	Purge	1 day	Keeps exception-processing tables smaller once the exception has already been worked and resolved.
JSON API Log	Removes older JSON API request and response log records.	Purge	5 days	Limits growth of high-volume API logging data while still keeping recent records available for troubleshooting.
Rerated Usage	Removes rerated usage records and related rerate output after rerating activity has been completed.	Purge	1 day	Helps clean up rerate-generated data after the rerate process has completed.
Unprocessed Usage Exceptions	Archives and purges unresolved usage exception records together with supporting mediated usage detail.	Archive and Purge	92 days	Preserves unresolved exception history for operational review while still controlling live-table growth.
DataImport Request Tracking	Removes historical import-request tracking records.	Purge	92 days	Keeps request-tracking history available for a limited operational period without retaining it indefinitely.
Webhook Log	Archives and purges webhook log records and related request-history details.	Purge	92 days	Preserves operational webhook history long enough for troubleshooting and auditing while reducing live log size.
DataImport Request Batch Tracking	Removes older batch-level import tracking records.	Purge	92 days	Keeps import-batch monitoring data available for review without allowing the tracking tables to grow indefinitely.
Usage	Archives and purges rated and mediated usage data, including related tax, consistency, and tier records.	Archive and Purge	92 days	Supports long-term management of high-volume usage data while preserving an archive copy before removal from active tables.
Complete Schedule	Removes completed schedule records that no longer need to remain in the active schedule history.	Purge	92 days	Reduces operational history volume for completed schedules after a reasonable review period.
Audit Log	Archives and purges audit history and related audit-detail records.	Archive and Purge	92 days	Retains audit history for governance and review while preventing long-term growth of audit tables.
Purged Usage Exceptions	Removes records related to usage exceptions that have already moved into the purged-exception flow.	Purge	1 day	Helps clean up transitional exception data once it is no longer needed operationally.
Error Queue Message	Removes older queue-error message records.	Purge	92 days	Keeps failed-message history available for support review while controlling error-queue table growth.
Account Delta Export	Produces export files for changed account-related data such as accounts, contacts, notes, packages, services, hierarchy, and related address information.	Delta Export	0 days	Supports downstream synchronization or external delivery of changed account data instead of long-term in-platform archival retention.
Billing Delta Export	Produces export files for changed billing data such as invoices, invoice items, payments, taxes, discounts, and general-ledger entries.	Delta Export	0 days	Supports downstream financial or reporting integrations that need recently changed billing data.
Usage Delta Export	Produces export files for changed usage and rating data such as mediated usage, rated usage, usage exceptions, usage classes, usage rates, and usage rate plans.	Delta Export	0 days	Supports downstream analytics, data-lake, or external processing scenarios that need recent usage and rating data.

Notes About Duration #

• 92 days is the common default retention period for long-running operational and audit-style archive objects.
• 1 day is used for short-lived cleanup-oriented archive objects where the goal is to remove transient processing data quickly.
• 0 days is used by the delta export objects because they are export-oriented rather than retention-oriented. These objects are intended to generate outbound data files rather than hold archived data inside the active platform for a retention window.

Data Archive Panel #

The Data Archive Panel on the left allows you to select an archive history record so that you can review its details on the panel to the right.

Each row shows the archive name together with its current status and archive period start date. The status badge helps you quickly identify whether the archive completed successfully, is still processing, failed, or was cancelled.

Actions #

• Cancel: requests cancellation of the selected archive job when the job is still queued or currently in progress.

Data Archive Details #

The information in this section reflects the currently selected archive history record. These fields are read-only and are used to review what the selected archive job did.

Fields #

• Archive Action: shows the type of archive operation that was run, such as an archive/export process or a purge-oriented process.
• Status: shows the current outcome or processing state of the selected archive job.
• Archive Name: shows the name of the archive configuration or archive job that produced this history record.
• Start Date: shows when processing of the selected archive job started.
• End Date: shows when processing completed.
• First Record Date: shows the earliest data date included in the archived data set for this run.
• Last Record Date: shows the latest data date included in the archived data set for this run.
• Archive Period Start: shows the beginning of the archive period that this history record covers.
• Archive Period End: shows the end of the archive period that this history record covers.
• Total: shows how many items were exported or archived by the selected job.
• Purged: shows how many items were purged as part of the selected job.

File Tab #

The File tab lists archive output files that were produced by the selected archive history record.

This tab is most useful when the archive process generates downloadable output, such as files written to a storage location for retention, transfer, or downstream use. Each row in the list represents a generated archive asset.

File List Fields #

• Target: identifies the target table or archive target associated with the file.
• Destination Location: shows where the generated archive file was stored.
• Sequence: shows the sequence number of the file when multiple files were generated for the same archive run.

File Actions #

• Download: downloads the selected archive file when the archive action supports downloadable assets and the selected archive history record completed successfully.

If no archive files are available for the selected record, the tab shows an empty-state message instead of a list.

Cancelling A Data Archive #

Use Cancel when an archive job is still waiting to run or is currently processing and you need to stop it before completion.

1. Select the archive history record from the Data Archive Panel.
2. Click Cancel.
3. Confirm the cancellation request.

After the request is submitted, the system queues the cancellation for that archive configuration. Review the status of the selected record in the Data Archive Panel and in the details area to confirm the final outcome.

Downloading Archived Files #

Use the File tab when the selected archive history record produced downloadable output files.

1. Select a completed archive history record from the Data Archive Panel.
2. Open the File tab.
3. Review the available file rows.
4. Click Download on the file you want to retrieve.

If the selected record represents a purge action, or if the archive did not generate downloadable assets, the File tab will not provide download options.