Skip to main content

pVault Help

Retention

Business documents go through a long life cycle. pVault® provides the tools to manage documents throughout that life cycle.

Document retention is based on the document type as well as external factors such as federal, state and local requirements. pVault enables you to securely store your documents by archiving them. This way, they are not unnecessarily included in document searches, but they are within easy access should you need them.

A major part of this life cycle is managing the retention of the documents. This includes when to archive the documents and when to purge the documents permanently.

SageThe_Document_Lifecycle_Retention.png
Archive Documents

pVault® includes the functionality to move older files to an “archived” state.

When documents are archived, they are marked as such. Physical document files may be moved to a new storage location and documents are no longer included in the “production” searches in Document Search.

The primary reason for archiving documents is because older files from previous years may “clog up” searches. Archiving older documents removes them from Production Only searches. Users can specifically choose when to search (and view) archived files.

Important

  • Archiving only impacts document data; it does not impact invoice data.

  • When the archive job runs, the files do not move but the document data is modified to indicate the document is "archived."

Document archiving can be run manually or on an automated schedule. (For more information, see Manual Archiving and Automatic Archiving). Complete the following steps to access the Archive Documents page and view any currently scheduled archive jobs.

  1. From My Paperless, click Vault Settings.

  2. In the Vault Settings navigation bar, click Retention.

  3. From the Retention dropdown, click Archive Documents.

    The Archive Documents page displays.

    VaultArchiveDocuments.png
  4. Proceed to the sections below to edit existing archive jobs or set up a new archive job.

pVault® performs an “automatic” archive function every night based on retention settings set on individual document types in Global Settings > Documents > Document Types. See Edit Document Types for more information on configuring automatic archive schedules.

The Archive Documents page lists the completed and upcoming document archives.

VaultArchiveDocuments.png

Note

Administrators can view the documents chosen for the upcoming automatic archive job by clicking the Edit pencil_edit_icon.png icon

You can manually add a document archive job and manually select the documents they want to include in the job.

Note

You must be a System Administrator to add a document archive job.

  1. From the Archive Documents page, click Add

    VaultArchiveDocuments.png
  2. In the Create Archive page that displays, enter a name and archive date.

    CreateArchiveBlank.png
  3. Click Add.

    The following Add Documents to Archive dialog displays with the Criteria tab active:

    PVCVaultRetentionArchiveDocumentsNewArchiveCreateArchivepageAddDocumentstoArchivedialog-mh.PNG
  4. In the Keyword field, enter the appropriate search criteria to locate the documents you want to archive.

  5. (Optional) Click the Advanced Search dropdown arrow to display additional fields to help narrow down your search.

    1. The Criteria radio button within Search Options is selected by default. You can also select Specific Documents if you would like to narrow your search by document ID.

      Note

      If you select Specific Documents, your Advanced Search options are reduced to the Document IDs field. In this field you can enter specific identification numbers or leave the field blank to include all.

    2. In the Document Type(s) field, use the dropdown to search for documents suitable for archiving. If using several index criteria in the search, an And / Or option is available. AND allows the combination of several index criteria in the search. All index criteria must be met to return a result. OR allows any one of the index criteria to return a result.

      PVCRetrieveDocumentSearchpageAdditionalAdvancedSearchOptionsAndOr-mh.PNG
    3. You can scroll through the Indexed by User(s) list or start typing a name to populate the field and select one or more users. If you do not know who indexed the document(s) you are searching for, leave this field blank.

    4. In the Indexed fields, click the calendar icons to select the date range.

    5. In the Types section, select either All, Archive or Production. The Production radio button is clicked by default.

  6. When finished entering archive document criteria, click Search.

    The Add Documents to Archive dialog re-displays with the Results tab active:

    PVCVaultRetentionArchiveDocumentsNewArchiveCreateArchivepageAddDocumentstoarchivedialogResultstab-mh.PNG
  7. To further review your search results and determine if a document should be included in the archive, click the associated check box In the Document Information pane to view document information and a visual in the Preview section:

    PVCVaultRetentionArchiveDocumentsNewArchiveCreateArchivepageAddDocumentstoarchivedialogResultstabcomplete-mh.PNG
  8. To select any of these identified documents for archiving, click the associated check box(es). If all displaying documents should be included, select the check box located in the header.

  9. Once the documents to be archived list is complete, click Add.

    The Create Archive page re-displays:

    Note

    More documents can be added (or removed) by clicking either Add or Remove as appropriate.

    PVCVaultRetentionArchiveDocumentsNewArchiveCreateArchivepagecomplete-mh.PNG
  10. Click Save.

Purge Documents

Document types can be set up to have a pre-determined amount of time (in months or years) before the document types are eligible for purging.

All purging is performed on a manual basis. There is no job that automatically purges documents from the system.

When you purge a document:

  • The document image is deleted.

  • All database records are deleted for that document.

  • A purged document audit entry is created in a database table providing the Document ID, Vault ID, Document Type, Document Description, User ID (person performing the purge), and Purge Date.

Important

Deleted documents are not physically deleted from the pVault® system until they are purged. Deleted documents are marked Inactive.

  1. From My Paperless, click Vault Settings.

  2. In the Vault Settings navigation bar, click Retention.

  3. From the Retention dropdown, click Purge.

    The Purge Documents page displays.

    VaultPurgeScreen.png
  4. Click Add to select which documents to purge.

  5. In the Create Purge page that displays, use the calendar icon to select the date the purge should occur.

    NewPurgeSetScreen.png
  6. Click Add.

    The following Add Documents to Purge dialog displays with the Criteria tab active:

    AddDocumentsToPurge.png
  7. In the Keyword field, enter the appropriate search criteria to locate the documents you want to purge.

  8. (Optional) Click the Advanced Search dropdown arrow to display additional fields to help narrow down your search.

    1. The Criteria radio button within Search Options is selected by default. You can also select Specific Documents if you would like to narrow your search by document ID.

      Note

      If you select Specific Documents, your Advanced Search options are reduced to the Document IDs field. In this field you can enter specific identification numbers or leave the field blank to include all.

    2. In the Document Type(s) field, use the dropdown to search for documents suitable for archiving. If using several index criteria in the search, an And / Or option is available. AND allows the combination of several index criteria in the search. All index criteria must be met to return a result. OR allows any one of the index criteria to return a result.

      PVCRetrieveDocumentSearchpageAdditionalAdvancedSearchOptionsAndOr-mh.PNG
    3. You can scroll through the Indexed by User(s) list or start typing a name to populate the field and select one or more users. If you do not know who indexed the document(s) you are searching for, leave this field blank.

    4. In the Indexed fields, click the calendar icons to select the date range.

    5. In the Types section, select either All, Archive or Production. The Production radio button is clicked by default.

  9. When finished entering document search criteria, click Search.

    The Add Documents to Purge dialog re-displays with the Results tab active:

    AddDocumentsToPurgeSearchResults.png
  10. To further review your search results and determine if a document should be included in the purge, click the associated check box In the Document Information pane to view document information and a visual in the Preview section:

    AddDocumentsToPurgeSearchResults2.png
  11. To select any of these identified documents for purging, click the associated check box(es). If all displaying documents should be included, select the check box located in the header.

  12. Once the documents to be purged list is complete, click Add.

    The Create Purge page re-displays:

    Note

    More documents can be added (or removed) by clicking either Add or Remove as appropriate.

    PurgeListing.png
  13. Manually enter a date or click the calendar icon to populate the Purge Date field.

  14. Click Save.