Working with Documents

The Documents Register makes working with documents easy. You can perform a number of actions on documents after they are uploaded into the Documents Register.

See the links below for information on how to work with documents.

The check out functionality can be used for various reasons, such as when documents need to be placed on hold if they have been released too early. This prevents other users from downloading the document while it is being updated.

After any changes are completed the document can be checked in, meaning users can download it again.

Checking Out And Checking In Documents

To check out a document:

  1. Select the document.

  2. Click Actions and select Check out.

    Check Out selection in Actions Menu

  3. Enter a reason for checking out the document.

  4. If you want to completely remove access to the document (and while it’s checked out, select the Remove Access check box.

    Check Out selections and remove access pane

  5. Click Check out.

  6. Click Yes to confirm.

To check in a document:

  1. Select the document in the Register.

  2. Click Actions and select Check in.

    Check In selection in Actions Menu

  3. Enter the reason for checking in the document.

    Check In selection and enter document pane

  4. Click Check in.

  5. Click Yes to confirm.

  • Documents that are checked out will have a padlock icon displayed next to them in the Register.
  • Documents can also be checked out from the document details window.

Deleting Documents

There are times where documents may need to be deleted from the Document Register. You can delete documents through the Admin menu if you have access to this function.

To delete a document:

  1. Select the document.

  2. Click Actions.

  3. In the Admin menu, select Delete.

    Delete document selection in Actions menu

  4. Enter a reason for the deletion.

    Reason for deletion field in Document Deletion pane

  5. If you want to apply the same reason to all documents, select the first check box.

  6. If you want to notify all users who have access to the document, select the second check box.

  7. Click Delete.

  8. Click Yes to confirm.

  • The View history link can be used to see if the document has been transmitted to anyone or included in any packages.
  • Use the reports module to view a full audit history of any deleted documents. The report will show who deleted the document, when and why.

Restore Deleted View Files and Comments

There are times when a deleted document needs to be restored to the Documents register. If you have the proper security group permissions, you can restore deleted files and comments. If a document has been deleted within the last 30 days, the document is restored with comments. If it is after 30 days, it is uploaded to the Documents register as a new document.

Restore deleted documents

You can restore a deleted document if a document was deleted accidentally or if you find you need a document that was deleted.

You must have the applicable permissions to restore documents. If you do not have the proper security group permission, see your system administrator.

  1. From the module navigation, go to Documents > Deleted items.

    Deleted items in Documents menu

    The Manage deleted documents register opens.

  2. Select the documents you want to restore, and then click Actions > Restore.

    Restore document selection in Actions menu

    If the document had been deleted in the last 30 days, the document and any comments are returned to the Documents register. The document history shows that the document has been restored.

If a document you restored was deleted more than 30 days ago, the New document upload screen is shown with the relevant metadata and the view files. You must add the document as new. The newly added document does not have any previous comments or other associations.


Adding Comments to Documents


You can add comments to documents and control who can view them.

To add comments to a document:

  1. Select the document in the Register.

  2. Click Actions and select Comments.

    Comments selection in Actions menu

  3. Enter the comment details.

    Enter new comment details pane

  4. Click Save.

  • From the New Comment screen, you can select additional options such as:
    • The category of the comment.
    • The company and person raising the comment.
    • The recipients of the comment.
  • You can also attach additional files or download the current files attached to the document.

Comparing Documents

To compare two documents:

  1. Select the documents.

  2. Click Actions and select Compare.

    Compare documents selection in Action menu


Stamping Documents

If the Vendor Data module is enabled, you can apply pre-review and post-review stamps to documents.

To post-stamp a document:

  1. Click Actions.

  2. In the Manage Stamp menu, select Post-Stamp.

    Post stamp selection - Manage Stamp in Action menu

  3. Select the date.
     Post Stamp pane

  4. Click Save.

To pre-stamp a document:

  1. Click Actions.

  2. In the Manage Stamp menu, select Pre-Stamp. The pre-stamp will be applied to the document.

    Pre Stamp selection - Manage Stamp in Action menu


Printing Document View Files

Print document view files directly from the Documents Register.

To print document view files from the Register:

  1. Click Actions and select Print selected view files.

    Print selected view files in Action menu

  2. Select the view files you want to print.

    Select-tick View files to print

  3. Click Print.


Resubmitting a Document for Review

Resubmit documents for review directly from the Documents Register.

To resubmit a document for review:

  1. Click Actions and select Resubmit for review.

    Resubmit for review selection in Action menu

  2. Click Yes.

    Resubmit dialogue prompt

Favoriting Documents

Favorite documents to easily access them.

To access the favorites column:

  1. Click Manage columns.

    Manage columns button

  2. Select Favorites and click the arrow icon.

    Favorites arrow icon in Manage column

  3. Click Apply.

To favorite a document:

  1. In the Register, find the document you want to favorite.

  2. Click the favorite icon.

    Favorite star icons in register view