How to Manage Documents in the SMS

How to Manage Documents in the SMS

Idea
Overview
This guide explains how to manage documents using the Documents module, including creating, editing, reviewing, and editing document access and permissions. It also covers the tabbed document layout, and document permissions to help users efficiently organise and maintain document records.

Notes
Step Tutorial
How to Add a Document
  1. Navigate to Documents.
  2. Click Add.
  3. Complete the required information across each tab.


Details Tab

Use the Details tab to enter the document's primary information.

Complete the following fields as required:

  • Document Information – Enter the document details.
  • File Upload – Upload the document file(s).
  • Status – Select the current document status.
  • Category – Select the document category.
  • Added By – Displays the user who added the document.

Click Save once all relevant fields are filled in. 

QMS Tab

Use the QMS tab to classify the document against the Quality Management System framework.

Complete the following fields:

  • Quality Area – Select the quality area that the document relates to (e.g. Training and Assessment, VET Student Support, VET Workforce, or Governance).
  • Division – Select the applicable division. The available options are filtered based on the selected Quality Area.
  • Relevant RTO Standards – Select the applicable RTO Standard(s). The available options are filtered based on the selected Division.
  • Performance Indicators – Select one or more performance indicators that the document supports. The available options are filtered based on the selected Relevant RTO Standard(s).


Review Information Tab

Use this tab to manage the document review schedule and review history.

Complete the following fields:

  • Next Review Date – Select the next scheduled review date.
  • Date Reviewed – Select the date the document was reviewed.
  • Reviewed By – Select the user who reviewed the document.
  • Notes – Enter any notes relating to the review.


Access and Permissions Tab

Select the Access and Permissions tab to manage who can access the document.

This tab allows you to configure document permissions for individual users or roles.

Note:

  • The Access and Permissions tab is only available when editing an existing document.


  • It is not displayed when creating a new document.

Once all fields are finalised, click on the Save button.
How to Edit Documents
  1. Navigate to Documents.
  2. Look for the Document that you want to edit then click on the 3-dot icon > Edit Details
  3. Edit the Document information as needed.


Details Tab

Use the Details tab to edit the document's primary information. The tab shows an Icon depending on the type of document version is currently active, it goes along with the Document Name, Date Uploaded and the Name of the user who uploaded the document.

Edit the following fields as required:

  • Document Information – Enter the document details.
  • File Upload – Upload the document file(s).
  • Status – Select the current document status.
  • Category – Select the document category.
  • Added By – Displays the user who added the document.
  • Add New Version – Use to upload document versions for the Document record

Click Save once all relevant fields are filled in. 

QMS Tab

Use the QMS tab to classify the document against the Quality Management System framework.

Edit the following fields:

  • Quality Area – Select the quality area that the document relates to (e.g. Training and Assessment, VET Student Support, VET Workforce, or Governance).
  • Division – Select the applicable division. The available options are filtered based on the selected Quality Area.
  • Relevant RTO Standards – Select the applicable RTO Standard(s). The available options are filtered based on the selected Division.
  • Performance Indicators – Select one or more performance indicators that the document supports. The available options are filtered based on the selected Relevant RTO Standard(s).


Review Information Tab

Use this tab to manage the document review schedule and review history.

Complete the following fields:

  • Next Review Date – Select the next scheduled review date.
  • Date Reviewed – Select the date the document was reviewed.
  • Reviewed By – Select the user who reviewed the document.
  • Notes – Enter any notes relating to the review.

Version History Tab

This allows users to manage Document Versions within the Document record.
  1. An Active Document display will also show on this tab like in details tab
  2. If a document record has a document version pending approval, it will be displayed beside the Active Document area along with the document version details.
  3. A table is also displayed containing a list of historical versions available for each document record.
  4. If a document record is a newly uploaded document and has no historical records yet, there will nothing to display on the table. The Active document area also will not show.
Info
Note: The badge beside "Edit Document"  provides information regarding the active version a document record currently have.

If a pending approval document version is existing on a document record, a separate badge will show beside the Actove version badge.


Access and Permissions Tab

Select the Access and Permissions tab to manage who can access the document.

This tab allows you to configure document permissions for individual users or roles.

Note:

  • The Permissions tab is only available when editing an existing document.


  • It is not displayed when creating a new document.

Once all fields are finalised, click on the Save button.
How to Edit Document Permissions (Category Level)

The Documents menu is displayed only when the logged-in user has permission to view at least one document or document category.

To display the Documents menu, ensure the user has View permission for either a document category, subcategory, or sub-subcategory.

  • Go to Administration > Templates
  • Go to the System tab
  • Go to the sub tab for Document Categories
  • Look for the Document Category that you want to edit then click on the 3-dot icon > Permissions


  • Look for the Role that you want to edit permissions to then click on the 3-dot icon > Edit 


  • Toggle the preferred permissions for this role that will apply to the selected Document Category from step #4.
    Note: Inherit all permissions to child categories – Enable this option to apply the selected permissions to all child categories automatically.


  • Click Save

NOTE: If the user does not have View permission for any document or document category, the Documents menu will not be displayed.

How to Set Document Permissions (Document Level)

The Documents menu is displayed only when the logged-in user has permission to view at least one document or document category.

To display the Documents menu, ensure the user has View permission for the specific document;

  1. Go to Documents
  2. Click on the 3-dot icon > Edit Details


  3. Go to Access & Permissions tab
  4. Under Permissions, click the Plus icon


  5. Users - Select from any of the following dropdown lists on who to assign permission/s to:
    1. Role
    2. Org Unit
    3. Individual Staff Member
  6. Permissions - Select the specific permission that will be granted to the selected user.

NOTE: If the user does not have View permission for any document or document category, the Documents menu will not be displayed.


How to Delete Document

The Delete action is displayed when the logged-in user has Delete permission for either:

  • The document itself; or
  • The document's Category, Subcategory, or Sub-subcategory.

The user can delete documents only when one of these permission requirements is met.


How to Add Document Version
1.  Navigate to Documents.
2. Look for the Document that you want to edit then click on the 3-dot icon > Edit Details.

3. Under Details tab, click Add New Version.

4. Select from the two options:
  1. Minor Upgrade
  2. Major Upgrade

5. Fill out the details.
6. Click Save once all relevant fields are filled in. 
InfoNote: Users can only upload one version at a time. If a Pending Approval version exists. Upload button is disabled and a message will show upon hovering on the button: "A version is already pending approval". 


How to Restore Document Version
Users can also restore Approved document versions on the Version History tab on Edit Document modal.
When no Pending version exists on the Document Record, a Restore option is available on the Actions related to an Approved document version.

1. Click on the 3 dots icon and select Restore.



2. Upon clicking on Restore, a Restore version modal will show: 

AlertA message will show at the top of the modal below the modal Header: This will submit a request to restore version {Version number on which we are restoring from} for approval. The current active version will remain live until the request is approved.

3. Upon saving the Restore Version modal, it will automatically create a Pending version on Version History tab. 

Info
Note: Users can Restore Approved Versions even if they are not the who uploaded the version they are trying to restore. 

How to Resubmit Rejected Document Version
Users can also Resubmit rejected document versions on the Version History tab on Edit Document modal.
When no Penging version exists on the Document Record, an Edit and Resubmit option is available on the Actions related to a rejected version.
1. Click on the 3 dots icon relevant to the rejected document version.
2. Select Edit & Resubmit.

3. Fill out the relevant fields.

Rejection details section: This will show the reason why the version was rejected and the user who rejected it.
New File Section: Allows user to change the document related to the version. If a new file is uploaded, the original file for the rejected version will be replaced otherwise it will stay.
Version section: 
Major: auto filled with current major version.
Minor: auto filled with current minor version + 1
User can still change the value on the fields but can only save when the version number is greater than the current version number.
Version Change Notes: Free text field used to supply additional related details.


Info
Note: Users can only Edit and Resubmit pending document versions that they own. Edit and Resubmit action will not show on a document version that a user does not own. 


NotesUsers can also Withdraw Pending document versions on the Version History tab on Edit Document modal. When a Pending version exists on the Document Record, a Withdraw button is available on the Pending Approval section.

This button is only available to the User who submitted the pending document version. This will not show for other users.

 

Info
NOTE: The Allow Admin Access for Other Pages option in the system grants a role additional access to pages or features beyond the standard administrative dashboard.
Changes are automatically saved once you toggle the switch on or off.

Warning
IMPORTANT: Before enabling or disabling modules for a role, make sure it is necessary for the role to access them. This ensures that security and integrity are fully maintained.

Congratulations on completing this tutorial. We hope this has been helpful to you and your organisation. For any questions or concerns regarding this function, please reach out to the contact support via email.