Document Categories#

Document categories and sub categories that are available when adding a new document to a users account.

Tip

Some categories and sub categories are created, you won’t be able to change these as they’re required for functionality to work.

Managing Categories#

Create a Category#

To create a new category navigate to the Categories option from the Reference Documents section of the Academic side bar. This will open the categories page showing the current categories.

Click the Add button from the tables action bar to add a new category. Enter the desired configuration before clicking the create button.

Name Required
The name of the category.

Description
An optional description for the category.

Is Deletion Restricted Required
Should documents in this category be prevented from being deleted or not. If set to Yes then you won’t be able to delete the document once it’s added.

Once you create the new category you’ll be taken back to the categories index screen showing the existing categories including the new one.

Edit a Category#

To edit an existing category navigate to the Categories option from the Documents section of the side bar. This will open the categories page showing the current categories.

If the category is editable you’ll be able to edit the information by clicking the relevant field in the table and updating the information. A green popup will confirm the change was saved successfully.

Delete a Category#

To delete an existing category navigate to the Categories option from the Documents section of the side bar. This will open the categories page showing the current categories.

Select the desired category using the checkbox on the corresponding row of the table and then click the Delete button on the tables action bar. You’ll be asked to confirm your choice before the category is deleted.

A green popup message will confirm the deletion was successful.

Managing Sub Categories#

To view a categories sub categories click the corresponding checkbox on the table row and click the Edit button on the tables action bar (or double click the table row of the desired category).

Create a Sub Category#

You can add a new sub category by clicking the Add button on the tables action bar. You’ll then need to enter the sub categories configuration before clicking the Create button.

Name Required
The name of the sub category.

Description The description of the sub category.

Is Deletion Restricted Required
Should documents in this sub category be prevented from being deleted or not. If set to Yes then you won’t be able to delete the document once it’s added.

Management Group Required
The group containing users that should be able to create, edit and delete documents that are added with this sub category. When a user is in this group and has the Manage Linked Documents permission they will be able to add new documents and edit existing documents with this sub category assigned.

User Roles
The user roles that are allowed to view the documents in this sub category. For example, selecting Students will allow students to view the documents.

Once you create the new sub category you’ll be taken back to the sub categories index page showing the existing sub categories including the new one.

Tip

All categories are automatically available to staff with permission, this cannot be changed.

Edit a Sub Category#

To edit a sub category, click the checkbox next to the corresponding sub category and click the Edit button on the tables action bar (or double click the row). This will open the edit view.

You can then edit the desired information and click the Save button to save the changes. You’ll be taken back to the index page and green popup message will confirm the edit was successful.

Delete a Sub Category#

To delete a sub category, click the checkbox next to the corresponding sub category and click the Delete button on the tables action bar. You’ll be asked to confirm your choice before the sub category is deleted.

A green popup message will confirm the deletion was successful.

Permissions#

This page is protected by the following permissions:

  • Delete Document Categories

  • Manage Document Categories

This page is available to users with the following roles:

  • Staff Members

    • Available with permission