User roles.pl - Revision history

Drn@ecs.soton.ac.uk: Listing link typo

2022-08-30T16:26:45Z

Listing link typo

← Older revision		Revision as of 16:26, 30 August 2022
Line 322:		Line 322:
	== See Also ==		== See Also ==
	* [[User Roles and Privileges]]		* [[User Roles and Privileges]]
	* [[~~Listing~~ of User Roles and Privileges]]		* [[Listings of User Roles and Privileges]]

Drn@ecs.soton.ac.uk: Added see also

2022-08-30T16:24:47Z

Added see also

← Older revision		Revision as of 16:24, 30 August 2022
Line 319:		Line 319:

	</pre>		</pre>

			== See Also ==
			* [[User Roles and Privileges]]
			* [[Listing of User Roles and Privileges]]

Drn@ecs.soton.ac.uk: Removed usage of roles/privs to move to own manual page

2022-08-30T16:22:52Z

Removed usage of roles/privs to move to own manual page

← Older revision		Revision as of 16:22, 30 August 2022
Line 4:		Line 4:
	'''user_roles.pl''' controls various aspects of what a user can do in eprints. By default there are 4 categories of user: Administrator, Editor, User, and minimal User. user_roles.pl controls what each class of user can do. You can also make your own classes of user in this file.		'''user_roles.pl''' controls various aspects of what a user can do in eprints. By default there are 4 categories of user: Administrator, Editor, User, and minimal User. user_roles.pl controls what each class of user can do. You can also make your own classes of user in this file.

	A role in EPrints is made up of 1 or more privileges. Giving a user a role gives them all the privileges associated with that role. You can also give users additional privileges without giving them the full role.

	~~==Creating a role==~~
	~~To create the role <code>approve-hat</code> you would do the following:~~
	~~<pre>~~
	~~$c->{roles}->{"approve-hat"} = [~~
	~~"eprint/buffer/view:editor",~~
	~~"eprint/buffer/summary:editor",~~
	~~"eprint/buffer/details:editor",~~
	~~"eprint/buffer/move_archive:editor",~~
	];
	~~</pre>~~
	The privileges listed above means the users given the <code>approve-hat</code> role can see the View, Summary, Details and Move to archive screen as an editor. Note because they cannot edit items [[Standard names \|in the buffer]] they can't correct any mistakes they find. However they do have the power to move items to the archive. This means the <code>approve-hat</code> allows a user to see the metadata of an item and if they think it is correct move it to the archive. They cannot return it to the user or edit the metadata themselves.

	~~The quoting around the role name approve-hat is required, eprints will generate an error if the text is simply {approve-hat}.~~


	~~Tip: Ensure the role is in {roles} not {user_roles}!~~

	~~== Creating a privilege ==~~

	~~There is no special step to creating a privilege, simply define it where you would like it tested for. Equally, there is no specified format for privileges tying them to (for example) screens.~~

	~~As a result the following are all valid:~~

	* "eprint/coindoi"
	* "eprint/coindoiffff"
	* "eprint/coindoi:editor"

	~~==Assigning a role==~~
	~~Now that you have created a role you want to give that to class of users. To give every regular user of the repository the <code>approve-hat</code> you add it to the list of roles for the user.~~

	~~<pre>~~
	~~$c->{user_roles}->{user} = [~~
	~~'general',~~
	~~'edit-own-record',~~
	~~'saved-searches',~~
	~~'set-password',~~
	~~'deposit',~~
	~~'change-email',~~
	~~'approve-hat',~~
	],
	~~</pre>~~

	~~Rather than giving every user the role you can give it to individual users. Administer a users profile and add the name of the role to their list of additional roles.~~

	~~[[File:Approve-hat.jpg]]~~

	~~==Assigning a user privilege==~~
	You do not have to give a user a full role you can give them a privilege. The syntax is slightly different. Add the name of the privilege prefixed with a '+' to the list of roles. You can remove a privilege by prefixing it with a '-'.

	~~<pre>~~
	~~$c->{user_roles}->{user} = [~~
	~~'general',~~
	~~'edit-own-record',~~
	~~'saved-searches',~~
	~~'set-password',~~
	~~'deposit',~~
	~~'change-email',~~
	~~'approve-hat',~~
	~~'+eprint/archive/edit:owner',~~
	],
	~~</pre>~~

	~~You can also assign privileges to individual users through the web interface in the same way you can assign a role, remembering they will be listed as "roles". (remember the '+' or '-')~~

	~~There is no need for users to log in again following a privilege change, eprints will pick it up automatically.~~

	~~==List of Roles and privileges==~~
	This is a full list of privileges defined in EPrints 3.3.15. They are just strings so you create your own when you create a role in user roles.pl		This is a full list of privileges defined in EPrints 3.3.15. They are just strings so you create your own when you create a role in user roles.pl

Drn@ecs.soton.ac.uk at 08:55, 31 January 2022

2022-01-31T08:55:34Z

← Older revision		Revision as of 08:55, 31 January 2022
Line 2:		Line 2:
	{{cfgd}}		{{cfgd}}

	'''user_roles.pl'' controls various aspects of what a user can do in eprints. By default there are 4 categories of user: Administrator, Editor, User, and minimal User. user_roles.pl controls what each class of user can do. You can also make your own classes of user in this file.		'''user_roles.pl''' controls various aspects of what a user can do in eprints. By default there are 4 categories of user: Administrator, Editor, User, and minimal User. user_roles.pl controls what each class of user can do. You can also make your own classes of user in this file.

	A role in EPrints is made up of 1 or more privileges. Giving a user a role gives them all the privileges associated with that role. You can also give users additional privileges without giving them the full role.		A role in EPrints is made up of 1 or more privileges. Giving a user a role gives them all the privileges associated with that role. You can also give users additional privileges without giving them the full role.

Drn@ecs.soton.ac.uk: Added cfgd and dirs templates

2022-01-31T08:55:22Z

Added cfgd and dirs templates

← Older revision		Revision as of 08:55, 31 January 2022
Line 1:		Line 1:
			{{dirs}}
			{{cfgd}}

	'''user_roles.pl'' controls various aspects of what a user can do in eprints. By default there are 4 categories of user: Administrator, Editor, User, and minimal User. user_roles.pl controls what each class of user can do. You can also make your own classes of user in this file.		'''user_roles.pl'' controls various aspects of what a user can do in eprints. By default there are 4 categories of user: Administrator, Editor, User, and minimal User. user_roles.pl controls what each class of user can do. You can also make your own classes of user in this file.

Drn@ecs.soton.ac.uk: Added actually file name in bold.

2022-01-31T08:54:56Z

Added actually file name in bold.

← Older revision		Revision as of 08:54, 31 January 2022
Line 1:		Line 1:
	~~User roles control~~ various aspects of what a user can do in eprints. By default there are 4 categories of user: Administrator, Editor, User, and minimal User. user_roles.pl controls what each class of user can do. You can also make your own classes of user in this file.		'''user_roles.pl'' controls various aspects of what a user can do in eprints. By default there are 4 categories of user: Administrator, Editor, User, and minimal User. user_roles.pl controls what each class of user can do. You can also make your own classes of user in this file.

	A role in EPrints is made up of 1 or more privileges. Giving a user a role gives them all the privileges associated with that role. You can also give users additional privileges without giving them the full role.		A role in EPrints is made up of 1 or more privileges. Giving a user a role gives them all the privileges associated with that role. You can also give users additional privileges without giving them the full role.

	==Creating a role==		==Creating a role==

	To create the role <code>approve-hat</code> you would do the following:		To create the role <code>approve-hat</code> you would do the following:
	<pre>		<pre>

Kgoetz: link 'buffer' to standard names which describes the four buffers available.

2018-10-03T01:27:11Z

link 'buffer' to standard names which describes the four buffers available.

← Older revision		Revision as of 01:27, 3 October 2018
Line 14:		Line 14:
	];		];
	</pre>		</pre>
	The privileges listed above means the users given the <code>approve-hat</code> role can see the View, Summary, Details and Move to archive screen as an editor. Note because they cannot edit items in the buffer they can't correct any mistakes they find. However they do have the power to move items to the archive. This means the <code>approve-hat</code> allows a user to see the metadata of an item and if they think it is correct move it to the archive. They cannot return it to the user or edit the metadata themselves.		The privileges listed above means the users given the <code>approve-hat</code> role can see the View, Summary, Details and Move to archive screen as an editor. Note because they cannot edit items [[Standard names \|in the buffer]] they can't correct any mistakes they find. However they do have the power to move items to the archive. This means the <code>approve-hat</code> allows a user to see the metadata of an item and if they think it is correct move it to the archive. They cannot return it to the user or edit the metadata themselves.

	The quoting around the role name approve-hat is required, eprints will generate an error if the text is simply {approve-hat}.		The quoting around the role name approve-hat is required, eprints will generate an error if the text is simply {approve-hat}.

Kgoetz: I just made a role in the wrong namespace...

2018-09-25T00:53:49Z

I just made a role in the wrong namespace...

← Older revision		Revision as of 00:53, 25 September 2018
Line 17:		Line 17:

	The quoting around the role name approve-hat is required, eprints will generate an error if the text is simply {approve-hat}.		The quoting around the role name approve-hat is required, eprints will generate an error if the text is simply {approve-hat}.


			Tip: Ensure the role is in {roles} not {user_roles}!

	== Creating a privilege ==		== Creating a privilege ==

Kgoetz: wording tweak

2018-09-25T00:42:21Z

wording tweak

← Older revision		Revision as of 00:42, 25 September 2018
Line 16:		Line 16:
	The privileges listed above means the users given the <code>approve-hat</code> role can see the View, Summary, Details and Move to archive screen as an editor. Note because they cannot edit items in the buffer they can't correct any mistakes they find. However they do have the power to move items to the archive. This means the <code>approve-hat</code> allows a user to see the metadata of an item and if they think it is correct move it to the archive. They cannot return it to the user or edit the metadata themselves.		The privileges listed above means the users given the <code>approve-hat</code> role can see the View, Summary, Details and Move to archive screen as an editor. Note because they cannot edit items in the buffer they can't correct any mistakes they find. However they do have the power to move items to the archive. This means the <code>approve-hat</code> allows a user to see the metadata of an item and if they think it is correct move it to the archive. They cannot return it to the user or edit the metadata themselves.

	The quoting around approve-hat is required, eprints will generate an error if the text is simply {approve-hat}.		The quoting around the role name approve-hat is required, eprints will generate an error if the text is simply {approve-hat}.

	== Creating a privilege ==		== Creating a privilege ==

Kgoetz: mention quoting needed.

2018-09-25T00:40:54Z

mention quoting needed.

← Older revision		Revision as of 00:40, 25 September 2018
Line 16:		Line 16:
	The privileges listed above means the users given the <code>approve-hat</code> role can see the View, Summary, Details and Move to archive screen as an editor. Note because they cannot edit items in the buffer they can't correct any mistakes they find. However they do have the power to move items to the archive. This means the <code>approve-hat</code> allows a user to see the metadata of an item and if they think it is correct move it to the archive. They cannot return it to the user or edit the metadata themselves.		The privileges listed above means the users given the <code>approve-hat</code> role can see the View, Summary, Details and Move to archive screen as an editor. Note because they cannot edit items in the buffer they can't correct any mistakes they find. However they do have the power to move items to the archive. This means the <code>approve-hat</code> allows a user to see the metadata of an item and if they think it is correct move it to the archive. They cannot return it to the user or edit the metadata themselves.

			The quoting around approve-hat is required, eprints will generate an error if the text is simply {approve-hat}.

	== Creating a privilege ==		== Creating a privilege ==