Retention and Legal Hold
Retention governs how long a document must be kept. Disposition governs what happens when that period ends. Legal hold prevents changes or deletion while a matter requires preservation. Backups protect recovery; they are not a substitute for these controls.
These commercial capabilities require the relevant backend services and governance permissions. A custom attribute named Retention or Hold does not itself enforce either control.
Retention policies
In Orchestration → Document lifecycle → Retention, configure a policy's date source, retention period, and optional disposition date. A policy can retain without disposing, or dispose without a retention period. If the RetentionPolicy entity type is missing, a platform administrator can prepare it through Administration → Workspaces → Processes.
Use Retention Policy Assignment Rules to match folders (including subfolders) or exact attribute values. Preview before reconciling existing documents. Documents already carrying a different policy are reported separately instead of being silently overwritten.
In Web v4.3.8, assignment rules run for supported uploads, moves, and metadata changes in the browser and during reconciliation. Direct API changes are picked up at the next reconciliation. If retention must apply immediately to every client, design and validate backend assignment for that ingestion path.
Use the document's Governance panel and Set Retention Policy action to inspect or change assignment where permitted. Check the resulting native document state and dates rather than relying only on a custom business field.
Disposition and trash
Workspace disposition settings choose SOFT_DELETE or DELETE. Soft deletion moves content out of the ordinary document list into Trash where it can be restored. Permanent deletion is not an undoable business status.
The v1.19.2 configuration's softDeleteRetentionInDays controls removal of soft-deleted documents. -1 keeps them until trash is cleared manually. A positive retention interval can make deletion automatic; review its effect on existing trash before saving.
Test disposal with disposable documents and an intentionally short test policy. Verify the actual retention boundary, processing results, Trash visibility, and restoration. Do not shorten a production retention policy merely to test the scheduler.
Legal hold
Use Place legal hold from a document's actions when you hold the required governance permission. Supply the matter reference and reason requested by the client. Hold blocks edits, deletion, and checkout until an authorized user removes it; it does not schedule destruction.
The API operations are PUT /documents/{documentId}/legalHold and DELETE /documents/{documentId}/legalHold. Include the correct siteId, and see Versioning, Checkout, and Legal Hold for the version-specific request headers and examples. The API operation IDs contain CheckoutLegalHold, but checkout and legal hold have different business purposes.
Review hold status before a bulk purge or an agreement lifecycle transition. Removing a hold does not establish that deletion is legally permitted. Restore the ordinary retention and authorization checks before proceeding.
Application controls and AWS storage controls
FormKiQ governance checks, Amazon S3 versioning, S3 Object Lock, DynamoDB recovery, and customer backup retention are separate layers. Do not assume that an application hold configures immutable storage, or that deleting a document immediately removes every backup copy. Inventory all content versions, artifacts, indexes, exports, and backups when implementing retention or an erasure process.
See Backup and Recovery, Document Storage, and the compliance control map.