Knowledge Center

603 - Archive Locations and Path Structure

Updated on

Archive Locations and Path Structure

Where archived content goes, how the path is assembled, and why it cannot be moved afterwards.

The configuration tables

ArchiveLocations

One row per registered destination. A rule points at one by ArchiveLocationId; a Work 10 user picks one when more than one exists.

Column
Purpose

FileSystemLocation
UNC root for on-premises archiving
AzureBlobUrlAzure Blob endpoint
AzureBlobContainerNameAzure container
AliasThe label users see
PrefixPrepended to the stored path. Appears on the request as LocationPrefix.

Note There is no AWS S3 column in this build, although the Quick Reference Guide lists S3 as a supported target. Confirm with GDSI how an S3 destination is registered before promising one to a firm.

The only enforced foreign key

ArchiveRules.ArchiveLocationId to ArchiveLocations.UID is the single enforced foreign key in the whole Archive schema. A rule pointing at a location that does not exist will fail at the constraint rather than silently.

How a stored path is assembled

FileSystemLocation + Prefix + ArchiveLocationFormat + file name

\\PSL-FS01\Archive \ 836162 \ 3439 \ JUDGEMENT \ 9084.1-Consent Judgment.pdf

The default format is Custom1\Custom2\Class — client, matter, document class. The finished path is written to Documents.ArchivedFilePath, and the location and prefix are also copied onto the request as ArchiveLocation and LocationPrefix.

Warning Once documents are archived this shape is effectively permanent. Restores read the stored ArchivedFilePath, so moving or renaming an archive location breaks every restore that depends on it.

Stub and email templates

Three files live in the StubFiles folder under the service install directory. They are customisable by administrators only; users cannot reach them.

File
Used for

archived-template.txt
The stub written in place of each archived document
isArchived.pdfThe PDF stub for archived Acrobat documents
request-restore-email-template.txtThe Request to Restore notification email
Previous Article 602 - Rights and Groups