QualityDocs users often require a way to track specific content copies outside of Vault, or prepare copies with specific overlays for specialized use. QualityDocs Vaults provide special user actions to assist with these use cases, supporting download and distribution of controlled copies.
When downloaded, Vault assigns each controlled copy a unique identification number and creates a Controlled Copy Trace object record, allowing you to track the status of those copies outside of the Vault. With a dedicated lifecycle for these object records, you can manage both the distribution and the reconciliation of these copies according to your organization’s needs. Your Vault may also apply specialized overlays or attach signature pages on the content when you download controlled copies. Depending on the document lifecycle state, there may be zero, one, or many controlled copy actions, for example, Request Laboratory Reference Copy and Request Facility Posting Copy.
Note: The functionality in this article refers to object-based Extensible Controlled Copy. See Distributing Controlled Copies for information on working with legacy document-based controlled copies.
Enabling Extensible Controlled Copies
For you to download controlled copies for a document, your Admin must enable Extensible Controlled Copy and configure various objects, page layouts, security, and overlays in your Vault. For QualityDocs Vaults, see Extensible Controlled Copy Configuration (QualityDocs).
How Vault Downloads Extensible Controlled Copies
With object-based Extensible Controlled Copies, Vault collects controlled copy information via configurable object records instead of through a static form. Capturing controlled copy information in object records allows for much more robust data collection, security, processes, and reporting options.
When you download a controlled copy, Vault opens the form to create a new Controlled Copy User Input record within the dialog. In this dialog, you can enter data about the controlled copy request in the fields configured by your Admin. When you submit the controlled copy request, Vault generates a ZIP file containing your requested controlled copy and an associated manifest file. Vault also creates an associated Controlled Copy Trace record for each controlled copy you requested, and copies data from the fields on the Controlled Copy User Input record to each Controlled Copy Trace record. You’ll see a banner alerting you that the job is in progress, and you’ll receive a Vault notification when the ZIP file is ready to download.
See details below about potential errors you may encounter while downloading a controlled copy.
Downloading Controlled Copies
To download a controlled copy:
- From the document’s All Actions menu, select a controlled copy action. These actions vary based on your organization’s configuration and may not contain “controlled copy” in the name.
- Vault opens the Controlled Copy User Input dialog. The dialog title and fields that appear here will vary depending on your Admin’s configuration.
- Fill in fields as needed.
- Click Continue. Vault asynchronously generates a ZIP file containing your requested copies. The ZIP file also includes a manifest PDF file listing the copy type, document name, and the requestor’s name, followed by all user-entered fields in alphabetical order. You can download the file from your Notifications page.
Download Controlled Copies Bulk Action
To request controlled copies from multiple documents via a bulk action, see Using Bulk Document Actions.
Reporting
Legacy controlled copy Distribution with Document type reports are not applicable for Extensible Controlled Copies. To report on Extensible Controlled Copy data, configure a report referencing Controlled Copy Trace object records.
Errors & Limitations
In some cases, Vault may not be able to download controlled copies:
- If there is a configuration error between the Controlled Copy User Input and the Controlled Copy Trace object types or records, Vault cannot successfully download controlled copies.
- In most cases, Vault will create the Controlled Copy Trace record even if there is an error downloading a copy or preparing the manifest file. In this case, Vault does not set the checkbox in the Released from Vault field on the Controlled Copy Trace record.
- Vault reports any errors encountered when downloading a controlled copy in the delivered manifest file.
- During the controlled copy bulk action, if Vault cannot create the Controlled Copy User Input record, Vault will inform you on the Confirmation page of the bulk action wizard.
- Vault cannot download Extensible Controlled Copies for documents with password-protected source files.
Related Permissions
The following permissions control the ability to download controlled copies:
| Type | Permission | Controls |
|---|---|---|
| Security Profile | Objects: Controlled Copy User Input: Read, Create | Ability to create the Controlled Copy User Input record when downloading a controlled copy. |
| Security Profile | Objects: Controlled Copy Trace: Read | Ability to view the Controlled Copy Trace record Vault creates from the data entered in the Controlled Copy User Input dialog and record. |
| Document Role | Distribute Controlled Copy | Ability to access user actions from the document All Actions menu to download controlled copies. This permission also controls the ability to download controlled copies in bulk. |