Altering the 'Request a copy' function - Revision history

Th.lauke@arcor.de: typos corrected

2019-09-24T07:58:16Z

typos corrected

← Older revision		Revision as of 07:58, 24 September 2019
Line 3:		Line 3:
	The ''Request a copy'' function allows for some restricted items to be requested by a visitor to the repository.		The ''Request a copy'' function allows for some restricted items to be requested by a visitor to the repository.

	If you want someone requesting an item to provide more information ~~that~~ the default email address and reason, you can add additional fields to the request form using the methods outlined below.		If you want someone requesting an item to provide more information than the default email address and reason, you can add additional fields to the request form using the methods outlined below.

	== Adding additional fields to the request dataset ==		== Adding additional fields to the request dataset ==
Line 61:		Line 61:

	Restart Apache (this command depends on which operating system you use - you may need to do something slightly different!)		Restart Apache (this command depends on which operating system you use - you may need to do something slightly different!)
	> sudo service httpd graceful		> sudo service httpd graceful

	This should have added the fields to the 'Request a copy' workflow.		This should have added the fields to the 'Request a copy' workflow.
Line 77:		Line 77:
	Make a copy:		Make a copy:
	> mkdir [EPRINTS_ROOT]/archives/[ARCHIVE_ID]/cfg/citations/request/		> mkdir [EPRINTS_ROOT]/archives/[ARCHIVE_ID]/cfg/citations/request/
	> cp [EPRINTS_ROOT]/lib/citations/~~reuqest~~/requester.xml [EPRINTS_ROOT]/archives/[ARCHIVE_ID]/cfg/citations/request/		> cp [EPRINTS_ROOT]/lib/citations/request/requester.xml [EPRINTS_ROOT]/archives/[ARCHIVE_ID]/cfg/citations/request/

	==== Edit requester citation ====		==== Edit requester citation ====

Libjlrs: /* Method A: Editing the 'requester' citation (For EPrints v3.3.12 and above) */

2018-08-06T08:47:40Z

Method A: Editing the 'requester' citation (For EPrints v3.3.12 and above)

← Older revision		Revision as of 08:47, 6 August 2018
Line 69:		Line 69:
	There are two ways this can be achieved - depending on your version of EPrints.		There are two ways this can be achieved - depending on your version of EPrints.

	=== Method A: Editing the 'requester' citation (~~For~~ EPrints v3.3.12 and above) ===		=== Method A: Editing the 'requester' citation (EPrints v3.3.12 and above?) ===

	If you are using a recent version of EPrints, and the file <code>[EPRINTS_ROOT]/lib/citations/request/requester.xml</code> exists, there is a simple way to include the new fields in the email to the contact_email address. Your version of EPrints uses a citation to include some information from the request dataobject in the request email.		If you are using a recent version of EPrints, and the file <code>[EPRINTS_ROOT]/lib/citations/request/requester.xml</code> exists, there is a simple way to include the new fields in the email to the contact_email address. Your version of EPrints uses a citation to include some information from the request dataobject in the request email.

Libjlrs: /* Method A: Editing the 'requester' citation */

2018-08-06T08:47:20Z

Method A: Editing the 'requester' citation

← Older revision		Revision as of 08:47, 6 August 2018
Line 69:		Line 69:
	There are two ways this can be achieved - depending on your version of EPrints.		There are two ways this can be achieved - depending on your version of EPrints.

	=== Method A: Editing the 'requester' citation ===		=== Method A: Editing the 'requester' citation (For EPrints v3.3.12 and above) ===

	If you are using a recent version of EPrints, and the file <code>[EPRINTS_ROOT]/lib/citations/request/requester.xml</code> exists, there is a simple way to include the new fields in the email to the contact_email address. Your version of EPrints uses a citation to include some information from the request dataobject in the request email.		If you are using a recent version of EPrints, and the file <code>[EPRINTS_ROOT]/lib/citations/request/requester.xml</code> exists, there is a simple way to include the new fields in the email to the contact_email address. Your version of EPrints uses a citation to include some information from the request dataobject in the request email.

Libjlrs: /* Method A: Editing the 'requester' citation */

2018-08-03T10:47:43Z

Method A: Editing the 'requester' citation

← Older revision		Revision as of 10:47, 3 August 2018
Line 90:		Line 90:
	</cite:citation>		</cite:citation>
	</source>		</source>

			==== Test the config, restart Apache ====
			Run the <code>epadmin test</code> to check everything is OK, and then restart Apache.

			EPrints will pick up changes within an existing XML file when you edit it, but it will not detect a new XML file (such as the local requester.xml citation) by default - so a restart (or a reload) is needed.

	=== Method B: Overriding EPrints::Plugin::Screen::Public::RequestCopy ===		=== Method B: Overriding EPrints::Plugin::Screen::Public::RequestCopy ===

Libjlrs: /* Altering the email sent to the contact_email address */

2018-08-03T10:45:21Z

Altering the email sent to the contact_email address

@@ Line 67: / Line 67: @@
 == Altering the email sent to the <code>contact_email</code> address ==
-If you are using a recent version of EPrints, and the file <code>[EPRINTS_ROOT]/lib/citations/request/requester.xml</code> exists, ignore this section and see [[other bit]].
+There are two ways this can be achieved - depending on your version of EPrints.
-If your version of EPrints doesn't have the above file, or you need to do something more complex than just addin the fields, follow these instructions!
+=== Method A: Editing the 'requester' citation ===
 The screen that processes the request being made (not the response to the request) is <code>EPrints::Plugin::Screen::Public::RequestCopy</code>.
@@ Line 77: / Line 100: @@
 The correct 'EPrints' way to do this for a plugin is outlined here: https://wiki.eprints.org/w/Instructions_for_local_plugins
-=== Understand how the current script works ===
+==== Understand how the current script works ====
 Take a look at <code>EPrints::Plugin::Screen::Public::RequestCopy</code> and try to understand it (a bit at least).
 Work out which of the methods you need to work differently.
-=== Make a local copy of the plugin ===
+==== Make a local copy of the plugin ====
   mkdir -p [EPRINTS_ROOT]/archives/[ARCHIVE_ID]/cfg/plugins/EPrints/Plugins/Screen/Public/RequestCopy/
   cp [EPRINTS_ROOT]/perl_lib/EPrints/Plugins/Screen/Public/RequestCopy.pm [EPRINTS_ROOT]/archives/[ARCHIVE_ID]/cfg/plugins/EPrints/Plugins/Screen/Public/RequestCopy/LocalRequestCopy.pm
-=== Edit the local copy of the plugin ===
+==== Edit the local copy of the plugin ====
 The package name and 'isa' need to be updated as this is a subclass of the existing plugin.
@@ Line 162: / Line 185: @@
 		requester => $request->render_citation( "requester" ),
 ### INSERTED CODE ###
+# this checks whether the value is set, and returns either the rendered value, or an empty document fragment
 ### END INSERTED CODE ###
 		reason => $request->is_set( "reason" ) ? $request->render_value( "reason" )
@@ Line 272: / Line 299: @@
 </source>
-=== Add phrase ===
+==== Add phrase ====
-=== Enable plugin (map) ===
+The changes to the perl module add two new pins to the phrase. We have to update a local copy of the phrase and add places for these pins to be inserted.
-=== INstruction when request/requestor.xml exists ===
+==== Test everything and restart apache ====
-UNDER CONSTRUCTION!
+If the <code>epadmin test</code> returns no errors, restart Apache, and try requesting something!

Libjlrs: Add details of overriding plugin

2018-08-03T09:51:02Z

Add details of overriding plugin

Show changes

Libjlrs at 08:49, 2 August 2018

2018-08-02T08:49:30Z

← Older revision		Revision as of 08:49, 2 August 2018
Line 68:		Line 68:

	UNDER CONSTRUCTION!		UNDER CONSTRUCTION!
			Will follow this process: https://wiki.eprints.org/w/Instructions_for_local_plugins for the Screen::Public::RequestCopy plugin, overriding the 'action_request' method.

Libjlrs: Create page after request on mailing list

2018-08-02T08:41:42Z

Create page after request on mailing list

New page

[[Category:Howto]]

The ''Request a copy'' function allows for some restricted items to be requested by a visitor to the repository.

If you want someone requesting an item to provide more information that the default email address and reason, you can add additional fields to the request form using the methods outlined below.

== Adding additional fields to the request dataset ==

The 'requests' are dataobjects - very similar to an eprint, or a user, so you can add fields in the same way.

=== Add configuration for new fields ===

In a config file e.g. <code>[EPRINTS_ROOT]/archives/[ARCHIVE_ID]/cfg/cfg.d/z_request_fields.pl</code>
<source lang="perl">
## Additional fields for 'Request a copy'
push @{$c->{fields}->{request}},
{
name => "contact_num",
type => "text",
},
{
name => "id_num",
type => "text",
};
</source>

After adding this file, test the config is OK (avoid syntax errors):
> [EPRINTS_ROOT]/bin/epadmin test [ARCHIVE_ID]

=== Add phrases for new fields ===

Add the phrases to e.g. <code>[EPRINTS_ROOT]/archives/[ARCHIVE_ID]/cfg/lang/en/phrases/z_request_fields.xml</code>:

<source lang="xml">
<?xml version="1.0" encoding="utf-8" standalone="no"?>
<!DOCTYPE phrases SYSTEM "entities.dtd">
<epp:phrases xmlns="http://www.w3.org/1999/xhtml" xmlns:epp="http://eprints.org/ep3/phrase" xmlns:epc="http://eprints.org/ep3/control">
<epp:phrase id="request_fieldname_contact_num">Contact number</epp:phrase>
<epp:phrase id="request_fieldhelp_contact_num">A number that we can contact you on to discuss your request if necessary </epp:phrase>

<epp:phrase id="request_fieldname_id_num">ID number</epp:phrase>
<epp:phrase id="request_fieldhelp_id_num">The identification number from your staff/student card</epp:phrase>
</epp:phrases>
</source>

Then run:
> [EPRINTS_ROOT]/bin/epadmin update [ARCHIVE_ID]

This will add the columns to the database.

=== Adding fields to the workflow ===

By default the workflow is in the global configuration. It can be customised by copying the default request workflow to the repository config:
> mkdir [EPRINTS_ROOT]/archives/[ARCHIVE_ID]/cfg/workflows/request
> cp [EPRINTS_ROOT]/lib/workflows/request/default.xml [EPRINTS_ROOT]/archives/[ARCHIVE_ID]/cfg/workflows/request

=== Reload Apache ===

Test the config again:
> [EPRINTS_ROOT]/bin/epadmin test [ARCHIVE_ID]

Restart Apache (this command depends on which operating system you use - you may need to do something slightly different!)
> sudo service httpd graceful

This should have added the fields to the 'Request a copy' workflow.

== Altering the email sent to the <code>contact_email</code> address ==

UNDER CONSTRUCTION!