Skip to content
Closed
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
97 changes: 35 additions & 62 deletions docs/modules/admin/pages/permissions.adoc
Original file line number Diff line number Diff line change
@@ -1,87 +1,60 @@
= User and Group Permissions =
= Permissions =
:toc:

It is essential to understand how user and group permissions can be used to allow
staff to fulfill their roles while ensuring that they only have access to the
appropriate level.
The *Permissions*, or *Permissions List*, interface is where individual permissions can be managed from the staff client. The interface is accessed through *Administration* > *Server Administration* > *Permissions*. It displays the permissions available through your default installation of Evergreen along with any custom permissions that have been created locally.

Permissions in Evergreen are applied to a specific location and system depth
based on the home library of the user. The user will only have that permission
within the scope provided by the Depth field in relation to his/her working
locations.
The table of permissions includes three columns:

Evergreen provides group application permissions in order to restrict which
staff members have the ability to assign elevated permissions to a user, and
which staff members have the ability to edit users in particular groups.
. *ID*: Displays the permission’s ID as it appears in the Evergreen database.
. *Code*: Displays the name of the permission as it appears in the Evergreen database.
. *Description*: States what action the permission allows the user to do.

== Staff Accounts ==
The xref:appendix:permissions_list.adoc[Permissions List] in the appendix provides a list of available permissions with their descriptions.

New staff accounts are created in much the same way as patron accounts, using
_Circulation -> Register Patron_ or *Shift+F1*. Select one of the staff
profiles from the _Profile Group_ drop-down menu.
== Creating a New Permission ==

image::permissions/permissions_1a.png[Permission Group dropdown in patron account]
To create a new permission:

Each new staff account must be assigned a _Working Location_ which determines
its access level in staff client interfaces.

. To assign a working location, open the newly created staff account using *F1*
(retrieve patron) or *F4* (patron search).
. Select _Other -> User Permission Editor_
. Click the *New Permission List* button.
+
image::permissions/permissions_new_list.png[New permission list entry]
+
image::permissions/permissions_1.png[Click User Permission Editor in the Patron's Other menu]
. Input the code and description for the permission and click *Save*.
+
. Place a check in the box next to the desired working location, then scroll to
the bottom of the display and click _Save_.
image::permissions/permissions_record editor.png[Permission entry record editor]
+
NOTE: In multi-branch libraries it is possible to assign more than one working
location

=== Staff Account Permissions ===
Once the permission is created, it will show up in the _Add Mapping_ options in the xref:admin:permission_groups.adoc[Permissions Group] interface, as well as the permissions list in the User Permission Editor.

To view a detailed list of permissions for a particular Evergreen account go to
_Administration -> User Permission Editor_ in the staff client.

=== Granting Additional Permissions ===
== Editing a Permission ==

A _Local System Administrator (LSA)_ may selectively grant _LSA_ permissions to
other staff accounts. In the example below a _Circ +Full Cat_ account is granted
permission to process offline transactions, a function which otherwise requires
an _LSA_ login.
To edit a permission:

. Log in as a Local System Administrator.
. Select _Administration -> User Permission Editor_ and enter the staff account
barcode when prompted
+
OR
+
Retrieve the staff account first, then select _Other -> User Permission
Editor_
+
. The User Permission Editor will load (this may take a few seconds). Greyed-out
permissions cannot be edited because they are either a) already granted to the
account, or b) not available to any staff account, including LSAs.
+
image::permissions/profile-5.png[profile-5]
. Click on the line of the permission entry and click *Edit Selected* from the *Actions* menu. You can also right-click on the permission entry and make the selection from the dropdown menu.
+
1) List of permission names.
image::permissions/permissions_edit_selected.png[Edit permission list entry]
+
2) If checked the permission is granted to this account.
+
3) Depth limits application to the staff member's library and should be left at
the default.
+
4) If checked this staff account will be able to grant the new privilege to
other accounts (not recommended).
. Make any necessary edits and click *Save*.


== Deleting a Permission ==

To delete a permission:

. Click on the line of the permission entry and click *Delete Selected* from the *Actions* menu. You can also right-click on the permission entry and make the selection from the dropdown menu.
+
. To allow processing of offline transactions check the Applied column next to
_OFFLINE_EXECUTE_.
image::permissions/permissions_delete_selected.png[Delete permission list entry]
+
image::permissions/profile-6.png[profile-6]
. A dialog box will appear to confirm if you would like to delete the permission. Click *Confirm*.
+
. Scroll down and click Save to apply the changes.
image::permissions/permissions_delete_confirm.png[Confirm deletion of permission list entry]
+
image::permissions/profile-7.png[profile-7]


== Permissions ==

* CREATE_PERM
* DELETE_PERM
* UPDATE_PERM
* VIEW_PERMISSION