Building a DataSet - Revision history

Alan.stiles@open.ac.uk: Added '_dark' to correctly link icon file with action

2013-03-06T11:40:14Z

Added '_dark' to correctly link icon file with action

← Older revision		Revision as of 11:40, 6 March 2013
Line 59:		Line 59:
	{ place => "eprint_item_actions", action => "move_dark_archive", position => 400, },		{ place => "eprint_item_actions", action => "move_dark_archive", position => 400, },
	];		];
	#$self->{action_icon} = { ~~move_archive~~ => "action_approve.png" };		#$self->{action_icon} = { move_dark_archive => "action_approve.png" }; #un-comment this line to use image button rather than text button

	return $self;		return $self;

Alan.stiles@open.ac.uk: Undo revision 10742 by Alan.stiles@open.ac.uk (Talk)

2013-03-06T11:37:57Z

Undo revision 10742 by Alan.stiles@open.ac.uk (Talk)

← Older revision		Revision as of 11:37, 6 March 2013
Line 59:		Line 59:
	{ place => "eprint_item_actions", action => "move_dark_archive", position => 400, },		{ place => "eprint_item_actions", action => "move_dark_archive", position => 400, },
	];		];
	#$self->{action_icon} = { ~~move_dark_archive~~ => "action_approve.png" }; ~~#enable this line to use tick-image button rather than text button~~		#$self->{action_icon} = { move_archive => "action_approve.png" };

	return $self;		return $self;

Alan.stiles@open.ac.uk: /* Build a screen to move an object to the archive */

2013-03-06T10:49:57Z

Build a screen to move an object to the archive

← Older revision		Revision as of 10:49, 6 March 2013
Line 59:		Line 59:
	{ place => "eprint_item_actions", action => "move_dark_archive", position => 400, },		{ place => "eprint_item_actions", action => "move_dark_archive", position => 400, },
	];		];
	#$self->{action_icon} = { ~~move_archive~~ => "action_approve.png" };		#$self->{action_icon} = { move_dark_archive => "action_approve.png" }; #enable this line to use tick-image button rather than text button

	return $self;		return $self;

Alan.stiles@open.ac.uk: /* add note regarding counter page in 3.3.10 */

2013-01-31T09:34:37Z

add note regarding counter page in 3.3.10

← Older revision		Revision as of 09:34, 31 January 2013
Line 33:		Line 33:

	Now we reload the configuration. Check the http://repository.name.ac.uk/cgi/counter to check the dark_archive dataset exists. You should see the dark_archive listed with 0 items.		Now we reload the configuration. Check the http://repository.name.ac.uk/cgi/counter to check the dark_archive dataset exists. You should see the dark_archive listed with 0 items.

			'''NOTE - in 3.3.10 (and possibly earlier) dark_archive will not show on the counter page until there is at least one eprint with that status'''

	==Build a screen to move an object to the archive==		==Build a screen to move an object to the archive==

Pm705: /* Build a screen to move an object to the archive */

2011-03-31T08:54:21Z

Build a screen to move an object to the archive

← Older revision		Revision as of 08:54, 31 March 2011
Line 35:		Line 35:

	==Build a screen to move an object to the archive==		==Build a screen to move an object to the archive==
	Now that our we have our dataset we should move things into it. We do this by building a screen plugin which can set the eprint_status field to "dark_archive". Some simple code is bellow. Some obvious expansions to this code would be to change the allow_move_dark_archive method so that it uses roles to check if a user is allowed to move items into the dark archive. You may also want to add an icon for the plugin.		Now that our we have our dataset we should move things into it. We do this by building a screen plugin which can set the eprint_status field to "dark_archive". Some simple code is bellow. Some obvious expansions to this code would be to change the allow_move_dark_archive method so that it uses roles to check if a user is allowed to move items into the dark archive. You may also want to add an icon for the plugin. As in previous excercises you will need to add the appropriate phrases.
	<pre>		<pre>
	package EPrints::Plugin::Screen::EPrint::MoveToDarkArchive;		package EPrints::Plugin::Screen::EPrint::MoveToDarkArchive;
Line 122:		Line 122:

	</pre>		</pre>


	==Modify my first bazaar package to show the contents of dark_archive==		==Modify my first bazaar package to show the contents of dark_archive==
	Finally we modify the screen plugin we made in the [[Using_the_new_API\|API excercise]] so that searches the dark_archive not the eprint dataset. You could also change the render method to add the move_to_buffer plugin so that a user can move an item out of the dark archive into the buffer. There are a number of ways to improve the user interface produced by this excercise, these are left for the reader to experiment with.		Finally we modify the screen plugin we made in the [[Using_the_new_API\|API excercise]] so that searches the dark_archive not the eprint dataset. You could also change the render method to add the move_to_buffer plugin so that a user can move an item out of the dark archive into the buffer. There are a number of ways to improve the user interface produced by this excercise, these are left for the reader to experiment with.

Pm705: /* Modify my first bazaar package to show the contents of dark_archive */

2011-03-31T08:50:54Z

Modify my first bazaar package to show the contents of dark_archive

← Older revision		Revision as of 08:50, 31 March 2011
Line 125:		Line 125:

	==Modify my first bazaar package to show the contents of dark_archive==		==Modify my first bazaar package to show the contents of dark_archive==
	Finally we modify the screen plugin we made in the API excercise so that searches the ~~dark archive~~ not the eprint dataset ~~and~~ add the move_to_buffer plugin so that a user can move an item out of the dark archive into the buffer. There are a number of ways to improve the user interface produced by this excercise, these are left for the reader to experiment with.		Finally we modify the screen plugin we made in the [[Using_the_new_API\|API excercise]] so that searches the dark_archive not the eprint dataset. You could also change the render method to add the move_to_buffer plugin so that a user can move an item out of the dark archive into the buffer. There are a number of ways to improve the user interface produced by this excercise, these are left for the reader to experiment with.

Pm705: /* Add the dark archive dataset definition */

2011-03-31T08:34:52Z

Add the dark archive dataset definition

← Older revision		Revision as of 08:34, 31 March 2011
Line 19:		Line 19:

	<pre>		<pre>
	dark_archive => {		$c->{datasets}->{dark_archive} = {
	sqlname => "eprint",		sqlname => "eprint",
	virtual => 1,		virtual => 1,
Line 29:		Line 29:
	dataset_id_field => "eprint_status",		dataset_id_field => "eprint_status",
	datestamp => "lastmod",		datestamp => "lastmod",
	},		};
	</pre>		</pre>

Pm705: /* Add the dark archive dataset definition */

2011-03-31T07:55:42Z

Add the dark archive dataset definition

← Older revision		Revision as of 07:55, 31 March 2011
Line 32:		Line 32:
	</pre>		</pre>

	Now we reload the configuration. Check the ~~Admin>System Tools>Status~~ to check the dark_archive dataset exists		Now we reload the configuration. Check the http://repository.name.ac.uk/cgi/counter to check the dark_archive dataset exists. You should see the dark_archive listed with 0 items.
	~~epadmin update_database_structure <repoid>~~


	==Build a screen to move an object to the archive==		==Build a screen to move an object to the archive==

Pm705: /* Modify EPrint Status Field */

2011-03-31T07:53:47Z

Modify EPrint Status Field

← Older revision		Revision as of 07:53, 31 March 2011
Line 4:		Line 4:
	==Modify EPrint Status Field==		==Modify EPrint Status Field==

	Since our dark archive will contain eprints we will be making a new virtual dataset. A virtual dataset is a sub set of an existing dataset. Values of metadata fields on an object can be used to determine which virtual datasets it is in. The inbox, archive and buffer are all virtual datasets of the eprint dataset. The field which defines these virtual datasets is the "eprint_status" field. We must modify this field so it has an extra value "dark_archive". To do this add the following code to the postins method of your plugin configuation file from the workflow excercise.		Since our dark archive will contain eprints we will be making a new virtual dataset. A virtual dataset is a sub set of an existing dataset. Values of metadata fields on an object can be used to determine which virtual datasets it is in. The inbox, archive and buffer are all virtual datasets of the eprint dataset. The field which defines these virtual datasets is the "eprint_status" field. We must modify this field so it has an extra value "dark_archive". To do this add the following code to the postins method of your plugin configuation file from the workflow excercise. (Note you should not add the coresponding remove_dataset_field)

	<pre>		<pre>

Pm705: /* Modify EPrint Status Field */

2011-03-31T07:50:28Z

Modify EPrint Status Field

← Older revision		Revision as of 07:50, 31 March 2011
Line 4:		Line 4:
	==Modify EPrint Status Field==		==Modify EPrint Status Field==

	Since our dark archive will contain eprints we will be making a new virtual dataset. A virtual dataset is a sub set of an existing dataset. Values of metadata fields on an object can be used to determine which virtual datasets it is in. The inbox, archive and buffer are all virtual datasets of the eprint dataset. The field which defines these virtual datasets is the "eprint_status" field. We must modify this field so it has an extra value "dark_archive".		Since our dark archive will contain eprints we will be making a new virtual dataset. A virtual dataset is a sub set of an existing dataset. Values of metadata fields on an object can be used to determine which virtual datasets it is in. The inbox, archive and buffer are all virtual datasets of the eprint dataset. The field which defines these virtual datasets is the "eprint_status" field. We must modify this field so it has an extra value "dark_archive". To do this add the following code to the postins method of your plugin configuation file from the workflow excercise.

	<pre>		<pre>
	~~push( @{~~$c->~~{fields}~~->{eprint}}, {		$repository->config->add_dataset_field( "eprint", {
	name=>"eprint_status", type=>"set", required=>1,		name=>"eprint_status", type=>"set", required=>1,
	options=>[qw/ inbox buffer archive deletion dark_archive /],		options=>[qw/ inbox buffer archive deletion dark_archive /],
	replace_core=>1 #this flag must be used with EXTREME caution, it makes is very easy to break things		replace_core=>1 #this flag must be used with EXTREME caution, it makes is very easy to break things
	});		}, reuse => 1 );

	</pre>		</pre>