Document History

What is Document History?

Each Document has a list of "History" records associated with it which are used to record any major Status change events and anything else the user chooses to manually record.

"History" records are generared by the application during the following events:

  • Document initially created upon Project creation.
  • An Approval submission by an Approver.
  • Document Status changed manually via Project Settings.

Additionally users have the option to manually create a History record to describe their own significant event.

A History count is displayed in the top right corner of Documents, this can be clicked to open the Document History child window where the current Document's History can be viewed. History records displayed are sorted in ascending order by Date and paged to 10 items per page.

History Properties

Name Description Possible Values
Date Date the History was created. Date - Generated by the application.
Description Full description of the event. Rich Text (for manual creation) or generated by the application.
Author The person who manually created or generated the History. User - Generated by the application.

Create a new History

Clicking on the button will modify the child window to include an area at the bottom to create a new History record.

Once the Description property is set the new History record can be saved by clicking the Save button at the bottom of the child window. If any validation errors are encountered they will display at the bottom of the child window and must be rectified before the new History record can be successfully saved.

Upon successful completion of creating a new History record the bottom area of the child window used to describe the new History record will disappear and a success message will display at the bottom of the child window.

If the Cancel button is clicked, the bottom area of the child window used to describe the new History record will disappear and any changes will not be saved.