User Permission Reference

ERPNext Manual Page

ERPNext Documentation

About

User permissions are a way of restricting user access to particular Documents.

There are two main ways of restricting access to Documents in ERPNext.

1. Role based permissions.
   • Allow setting default access by DocType, granting or denying access to all Documents of that DocType.
2. User based permissions.
   • Restrict access to select Documents based on Link Field values in the particular Document. This setting can be applied globaly (restrict access to any Documents that use that Link Field), or to a particular DocType that uses the Link Field.

Usage Examples:

• Grant a user access to data belonging to a specific Company.
• Grant a user access to data belonging to a specific Territory.

Buttons

View Permitted Documents

Opens a page that allows you to see accessible documents for the user by DocType.

User Permission Form

Fields marked with an aserisk (*) are required

Top Section

User*

This is the user to whom the permissions grant will apply.

Allow*

This is the Link Field that the restriction will be based on.

For Value*

The value of the Link Field that is permitted for access.

Is Default

Selecting this checkbox will cause the value in this field to be used by default when creating documents, rather than the default value set up on the form.

Advanced Control Section

Apply To All Document Types

When this field is selected, the permissions apply to all DocTypes using the indicated Link Field. Deselecting this checkbox allows you to restrict the permissions grant to a specific DocType instead.

Applicable For

DescriptionProperties

Restricts the permissions grant to a specific DocType.

• Hidden, unless "Apply To All Document Types" is unchecked.
• Required if shown.

Hide Descendents

DescriptionProperties

Checking this checkbox will ignore child Documents of the Document in the "For Value" field for purposes of the permissions grant.

For example, suppose you have a Territory Tree View that looks like this:

• All Territories
  • United States
    • California
    • Texas
  • Canada

If this field is checked and "United States" appears in the "For Value" field, the user could not view Documents with "California" or "Texas" chosen as their Territory. However, if this field was unchecked, they could.

• Hidden, unless the DocType selected for "Allow" has a Tree View.