What are Permissions?

Quick Docket includes a flexible permissions system that allows you to control exactly which features each user can access.

Permission systems can often become overly complex and difficult to manage. Quick Docket aims to strike a balance by providing enough flexibility to cover most business requirements while keeping the system easy to understand and maintain.

Admin

Users can be marked as Admin using a simple toggle.

Admin users have unrestricted access to all features within Quick Docket.

This permission should only be granted to users who require full system access and are trusted to manage the system.

Permission Keys

Non-admin users begin with no permissions. Access is granted by assigning permission keys, which control what actions a user can perform.

Examples:

line_items.view.all
contacts.delete.managing
orders.report.assigned.deliverable

Permission keys can be assigned in several ways, including:

• Through one or more roles
• Directly to an individual user

Understanding Permission Keys

The following sections describe each permission key in detail, but most permission keys follow a consistent naming pattern that makes them easy to understand.

A permission key is generally made up of three parts:

• Feature or Table – The feature or table the permission applies to.
• Action – The action being performed, such as list, view, new, edit, or delete.
• Scope – The subset of records the action applies to (not always required).

Examples:

line_items.list.all
<table>.<action>.<scope>

line_items.new.managing
<table>.<action>.<scope>

orders.edit.assigned.deliverable
<table>.<action>.<scope>.<scope>

users.license.add.all
<table>.<feature>.<action>.<scope>

global.costs
<feature>.<action>

TIP

Don't want to spend time setting up permissions? Quick Docket includes a robust set of default roles that cover the needs of most businesses. You can use them as they are or customise them to suit your requirements.