Overview

Adding a quality document associates quality metadata to a document (an identifier, effective dates, etc.) and makes it available in the Quality app to users with access to the category.  This article covers adding new quality documents and adding an updated version of an existing quality document.

Adding a New Quality Document

To add a new quality document, perform the following steps:

  1. Create a draft document that is in the folder (or one of its subfolders) associated with the document category you would like the quality document to reside within
  2. Complete and approve a review and approval workflow that includes an approval step
  3. A Category manager will see an option at the bottom of the workflow to Mark Approved Version as Effective

    mceclip0.png

  4. Make document effective dialog will be shown with a form with document metadata fields.  All fields are required.

    mceclip1.png

    1. Keep the default "New effective document" to create a new document with a new identifier.
    2. The Document Category is read-only and based on the folder that the file belongs to.
    3. Choose one of the Document Subcategories associated with the category.
    4. The system will provide a default document identifier based on the next available number for the prefix.  You can change this to another number as long as that identifier isn't already being used for another document.
    5. By default, the Document Version name is set to the file name without the extension.  You can change this to any other value.
    6. The Effective document version has a default of 1.0 but can be changed to another number in the X.Y format, e.g., 1.0, 2.0, 2.1, etc.
    7. The Effective on date controls when the document will become effective.  You can choose any day in the future, but not the current day or previous days.
    8. The Effective until date controls when the document's effectiveness will end.  You can set this for a time period (e.g., a year) and then later choose to extend this date after periodic review before the expiration.  If a document passes its effective until date, the document will move to an Obsolete status.
  5. Click "Make Effective" to save the metadata.

After adding the document, it will be added to the Quality app and will be in a Future Effective state.  Once the Effective on date is reached, the document status will automatically be changed to Effective.

Adding a New Version of a Quality Document

To update an existing quality document to a new version (e.g., version 1.0 to version 2.0), perform the following steps:

  1. Create a draft document in the folder (or one of its subfolders) associated with the document category you would like the quality document to reside within.  This document can either be a separate file on the file system from the original document or a new version of the same file.
  2. Complete and approve a review and approval workflow that includes an approval step
  3. A Category manager will see an option at the bottom of the workflow to Mark Approved Version as Effective.
  4. Make document effective dialog will be shown with a form with document metadata fields.  All fields are required.
    1. Choose the "New version of an existing effective document" to start the process.
    2. In the Document field, find the document you'd like to update.  You can type to search by the identifier or document name.  The dropdown only shows documents from the category associated with the folder the document resides in.
    3. By default, the Document Version name is set to the current value of the existing effective document.  You can change this to any other value.
    4. Choose an Effective document version that is a higher number than the existing number.  The existing version number is shown for reference.
    5. The Effective on date controls when the document will become effective.  The effective until date of the existing effective document is shown for reference.  You can choose to set the effective date to the day after it expires or to another date.  If you choose a date earlier than the expiration date of the existing document, the existing document's effective until date will be reduced.  If you choose a date more than 1 day after the expiration date, there will be a period where there is no effective version of the document.
    6. The Effective until date controls when the document's effectiveness will end.  You can set this for a time period (e.g., a year) and then later choose to extend this date after periodic review before the expiration.  If a document passes its effective until date, the document will move to an Obsolete status.
  5. Click "Make Effective" to save the metadata.

After adding the document, it will be added to the Quality app and will be in a Future Effective state.  Once the Effective on date is reached, the document status will automatically be changed to Effective, and the previous version will be changed to Obsolete.

 

Learn more about Quality Document Management by watching a Quick Tip on Egnyte University: Quality Document Management