Table of Contents

Configuration overview

Paperweight uses one administrator-managed JSON policy. It links sources to output profiles and destinations by ID. The Configuration tab displays policy/source information and provides Reload configuration; it is not a policy editor.

Policy fields

The Default column shows what happens when you omit an optional setting. Include every field marked required; explicit null is valid only where documented. Unknown setting names are rejected. Use the spelling and capitalization shown in the tables.

Option Default Accepted values Behavior
schemaVersion required 1 Required configuration schema; other versions fail
profiles required Array of output profiles Policies available to source references; do not use null
destinations required Array of destinations Publication and staging paths; do not use null
sources required Array of sources Workstation/user workflow assignments; do not use null
limits null Limits object or null Null/omitted uses the default resource limits
archiveDays 7 7 only Fixed successful-archive retention policy
historyDays 90 90 only Fixed activity-history retention policy
clinicalMode false true, false Requires protectedStorageConfirmed: true and validatedForClinicalUse: true on every profile
protectedStorageConfirmed false true, false Records the administrator's confirmation that storage meets the organization's protection requirements
revision 1 Integer >= 1 Revision included in each job's configuration snapshot

IDs and references

Profile, destination, and source IDs must contain 1-64 ASCII letters, digits, underscores, or hyphens. IDs are unique within each collection, ignoring case. Source references must match the profile/destination ID exactly, including case. Use stable IDs and increment revisions when behavior changes.

All configured paths must be absolute and non-overlapping, including the local data root. Existing reparse points are rejected. Extended device paths and alternate data stream paths are not accepted. Keep input, staging, final destination, and local job data in separate directory trees.

Changes and snapshots

The app checks for policy file changes while running and reloads at an idle boundary. An active capture or operation delays reload. Reload configuration can also request an explicit refresh. Invalid replacement policy leaves the running process's previous valid configuration active; it does not silently apply some fields.

Each job keeps a copy of its settings and profile revision. Updating machine policy does not change queued or held jobs. Retrying a job uses its original settings. Let operators know when settings will change and record the revision deployed.

Clinical mode

clinicalMode: true requires two administrator confirmations: working storage meets your organization's protection requirements, and each output profile preserves the information your staff need from their clinical documents.

Record those confirmations with protectedStorageConfirmed: true and validatedForClinicalUse: true on every configured profile. These values record your team's review of storage and document quality. Paperweight checks that they are set; it does not assess storage protection or clinical readability itself.

See Output profiles, Sources, Destinations, and Limits and retention. Start from the complete example, with workflows disabled until ready.