Using Internal IDs for Staff Browse Views - Revision history

Drn@ecs.soton.ac.uk: Added render_internalid to render number rather than name when appropriate.

2017-06-21T13:49:03Z

Added render_internalid to render number rather than name when appropriate.

← Older revision		Revision as of 13:49, 21 June 2017
Line 124:		Line 124:
	input_cols => 10,		input_cols => 10,
	allow_null => 1,		allow_null => 1,
			render_single_value => 'render_internalid',
	},		},
	],		],
Line 148:		Line 149:

	$c->{internalid_to_name}->{format} = 0; # family, given		$c->{internalid_to_name}->{format} = 0; # family, given

			$c->{render_internalid} = sub
			{
			my( $session, $field, $value, $obj ) = @_;

			my $fragment = $session->make_doc_fragment;
			$fragment->appendChild($session->xml->create_text_node($value));
			return $fragment;
			}

	5. Run EPrints database update command to add these new sub-fields:		5. Run EPrints database update command to add these new sub-fields:

Drn@ecs.soton.ac.uk at 13:30, 21 June 2017

2017-06-21T13:30:02Z

← Older revision		Revision as of 13:30, 21 June 2017
Line 67:		Line 67:
	return $session->render_name( $name, $format ) if defined $name;		return $session->render_name( $name, $format ) if defined $name;
	}		}

	return;		return;
	}		}

Drn@ecs.soton.ac.uk: Added different method for converting internalid to name in browse view.

2017-06-21T13:22:48Z

Added different method for converting internalid to name in browse view.

← Older revision		Revision as of 13:22, 21 June 2017
Line 39:		Line 39:

	=== Add Internal ID to creators/editors/contributors fields for an EPrint ===		=== Add Internal ID to creators/editors/contributors fields for an EPrint ===
	1. Edit your archive's '''cfg/cfg.d/eprint_fields.pl'''. Under the field named '''creators''', you will see a block labelled '''fields'''. Copy and paste the block that has the '''sub_name''' '''id''' and copy and paste it just before the end '''fields''' block, ensuring to add a comma a comma prior to this. Then modify the '''sub_name'' from '''id''' to ''internalid'''. The creators block should then look something like below:		1. Add the following code the a file at '''/opt/eprints3/lib/plugins/EPrints/MetaField/Internalidname.pm''':

			package EPrints::MetaField::Internalidname;

			use strict;
			use warnings;

			use EPrints::MetaField::Text;

			BEGIN
			{
			our( @ISA );
			@ISA = qw( EPrints::MetaField::Text );
			}

			sub _get_name
			{
			my( $self, $session, $internalid ) = @_;

			my $format = $session->config( 'internalid_to_name', 'format' );

			return unless defined $format;

			if( $session->can_call( 'internalid_to_name', 'parser' ) )
			{
			my $name = $session->call( [ 'internalid_to_name', 'parser' ], $session, $internalid );
			return $session->render_name( $name, $format ) if defined $name;
			}

			return;
			}

			sub get_value_label
			{
			my( $self, $session, $value ) = @_;

			my $name = $self->_get_name( $session, $value );
			return $name if defined $name;

			return $session->make_text( $value );
			}

			sub ordervalue_basic
			{
			my( $self, $value, $session, $langid ) = @_;

			my $name = $self->_get_name( $session, $value );
			return EPrints::Utils::tree_to_utf8( $name ) if defined $name;

			return $value;
			}

			sub render_single_value
			{
			my( $self, $session, $value ) = @_;
			return $self->get_value_label( $session, $value );
			}

			1;

			2. Edit your archive's '''cfg/cfg.d/eprint_fields.pl'''. Under the field named '''creators''', you will see a block labelled '''fields'''. Copy and paste the block that has the '''sub_name''' '''id''' and copy and paste it just before the end '''fields''' block, ensuring to add a comma a comma prior to this. Then modify the '''sub_name'' from '''id''' to ''internalid'''. The creators block should then look something like below:

	{		{
Line 61:		Line 121:
	{		{
	sub_name => 'internalid',		sub_name => 'internalid',
	type => '~~text~~',		type => 'internalidname',
	input_cols => 10,		input_cols => 10,
	allow_null => 1,		allow_null => 1,
	~~render_single_value => 'render_internalid',~~
	},		},
	],		],
	},		},

	2. Repeat this change with the '''contributors''' and '''editors'' fields.		3. Repeat this change with the '''contributors''' and '''editors'' fields.

	~~3. Create a file called '''render_internalid.pl''' in '''cfg/cfg.d/''' of you archive, with the following contents:~~

	$c->{~~render_internalid~~} = sub		4. Create a file called '''internalid_to_name.pl''' in '''cfg/cfg.d/''' of your archive, with the following contents:

			$c->{internalid_to_name}->{parser} = sub
	{		{
	my( $session, $~~field, $value, $obj~~ ) = @_;		my( $session, $internalid ) = @_;
			return unless EPrints::Utils::is_set( $internalid );

	my $user_ds = $session->~~dataset~~( "user" );		my $user_ds = $session->get_repository->get_dataset( "user" );
	my $~~userexp~~ = EPrints::Search~~->new~~(		my $user_search = new EPrints::Search( session => $session, dataset => $user_ds );
	session => $session,		$user_search->add_field( $user_ds->get_field( "internalid" ), $internalid );
	dataset => $user_ds		my $users = $user_search->perform_search;
	);		return unless $users->count() > 0;
	$~~userexp~~->add_field( $user_ds->get_field( "internalid" ), $~~value~~ );
	my $~~results~~ = $~~userexp~~->perform_search;
	my $~~user = $results~~->~~item~~( 0 );

	return $~~field~~->~~render_single_value~~( ~~$session, $session->render_name( $user~~->get_value('name~~') )~~ );		return $users->item( 0 )->get_value("name");
	}		};

			$c->{internalid_to_name}->{format} = 0; # family, given

	4. Run EPrints database update command to add these new ~~subfields~~:		5. Run EPrints database update command to add these new sub-fields:

	/opt/eprints3/bin/epadmin update ARCHIVENAME		/opt/eprints3/bin/epadmin update ARCHIVENAME

	5. Assuming the above has been successful add the phrases required for this new field to '''cfg/lang/en/phrases/local.xml'''		6. Assuming the above has been successful add the phrases required for this new field to '''cfg/lang/en/phrases/local.xml'''

	<epp:phrase id="eprint_fieldname_creators_internalid">Internal ID</epp:phrase>		<epp:phrase id="eprint_fieldname_creators_internalid">Internal ID</epp:phrase>
Line 102:		Line 162:
	<epp:phrase id="eprint_fieldhelp_editors_internalid">Unique ID used to identify a user, used by <epc:phrase ref="archive_name" /></epp:phrase>		<epp:phrase id="eprint_fieldhelp_editors_internalid">Unique ID used to identify a user, used by <epc:phrase ref="archive_name" /></epp:phrase>

	6. Test that EPrints is happy with these changes and if so reload Apache:		7. Test that EPrints is happy with these changes and if so reload Apache:
	/opt/eprints3/bin/epadmin test ARCHIVENAME		/opt/eprints3/bin/epadmin test ARCHIVENAME
	apachectl graceful		apachectl graceful

Drn@ecs.soton.ac.uk: Added phrase for creators_internalid browse view name.

2017-06-21T10:23:29Z

Added phrase for creators_internalid browse view name.

← Older revision		Revision as of 10:23, 21 June 2017
Line 249:		Line 249:
	});		});

	2. Test that EPrints is happy with these changes and if so reload Apache:		2. Add the following phrase to your archives's '''cfg/lang/en/phrases/local.xml''':

			<epp:phrase id="viewname_eprint_creators_internalid">Internal Creators</epp:phrase>

			3. Test that EPrints is happy with these changes and if so reload Apache:
	/opt/eprints3/bin/epadmin test ARCHIVENAME		/opt/eprints3/bin/epadmin test ARCHIVENAME
	apachectl graceful		apachectl graceful

	3. Request the path '''/views/creators_internalid''' under your repository's hostname in a web browser (e.g. http://example.eprints.org/views/creators_internalid).		4. Request the path '''/views/creators_internalid''' under your repository's hostname in a web browser (e.g. http://example.eprints.org/views/creators_internalid).

Drn@ecs.soton.ac.uk: Fixed missing email field from @fields in autocomplete script.

2017-06-21T10:18:34Z

Fixed missing email field from @fields in autocomplete script.

← Older revision		Revision as of 10:18, 21 June 2017
Line 132:		Line 132:
	my $id_field = $dataset->get_field( $id_fieldname );		my $id_field = $dataset->get_field( $id_fieldname );

	my @fields = ($name_field->get_sql_names, $id_field->get_sql_names, $internalid_field->get_sql_names);		my @fields = ($name_field->get_sql_names, $id_field->get_sql_names, $email_field->get_sql_names, $internalid_field->get_sql_names);

	my $Q_table = $database->quote_identifier($dataset->get_sql_table_name);		my $Q_table = $database->quote_identifier($dataset->get_sql_table_name);

Drn@ecs.soton.ac.uk: Added instruction about updated workflows/eprint/default.xml

2017-06-21T10:08:22Z

Added instruction about updated workflows/eprint/default.xml

← Older revision		Revision as of 10:08, 21 June 2017
Line 216:		Line 216:
	$session->terminate;		$session->terminate;


			2. Edit your archive's '''cfg/workflows/eprint/default.xml''' and replace '''/users/lookup/name''' with '''/users/lookup/staffinternal''' where it appears as the '''input_lookup_url''' for '''creators''', '''editors''', and '''contributors'''. N.B. each of these fields may appear more than once in this file due to the use of conditional statements.

			3. Now test the configuration and although it should not be necessary ,it is worth gracefully reloading Apache to make sure the latest configuration is loaded.
			/opt/eprints3/bin/epadmin test ARCHIVENAME
			apachectl graceful

	=== Create Browse View based on Internal IDs ===		=== Create Browse View based on Internal IDs ===

Drn@ecs.soton.ac.uk: Added my to $user and $user_ds definitions

2017-06-21T09:57:17Z

Added my to $user and $user_ds definitions

← Older revision		Revision as of 09:57, 21 June 2017
Line 77:		Line 77:
	my( $session, $field, $value, $obj ) = @_;		my( $session, $field, $value, $obj ) = @_;

	$user_ds = $session->dataset( "user" );		my $user_ds = $session->dataset( "user" );
	my $userexp = EPrints::Search->new(		my $userexp = EPrints::Search->new(
	session => $session,		session => $session,
Line 84:		Line 84:
	$userexp->add_field( $user_ds->get_field( "internalid" ), $value );		$userexp->add_field( $user_ds->get_field( "internalid" ), $value );
	my $results = $userexp->perform_search;		my $results = $userexp->perform_search;
	$user = $results->item( 0 );		my $user = $results->item( 0 );

	return $field->render_single_value( $session, $session->render_name( $user->get_value('name') ) );		return $field->render_single_value( $session, $session->render_name( $user->get_value('name') ) );

Drn@ecs.soton.ac.uk: Added quotes round 'render_internalid'

2017-06-21T09:55:36Z

Added quotes round 'render_internalid'

← Older revision		Revision as of 09:55, 21 June 2017
Line 64:		Line 64:
	input_cols => 10,		input_cols => 10,
	allow_null => 1,		allow_null => 1,
	render_single_value => render_internalid,		render_single_value => 'render_internalid',
	},		},
	],		],

Drn@ecs.soton.ac.uk: Added file extension to render_internalid

2017-06-21T09:54:35Z

Added file extension to render_internalid

← Older revision		Revision as of 09:54, 21 June 2017
Line 71:		Line 71:
	2. Repeat this change with the '''contributors''' and '''editors'' fields.		2. Repeat this change with the '''contributors''' and '''editors'' fields.

	3. Create a file called '''render_internalid''' in '''cfg/cfg.d/''' of you archive, with the following contents:		3. Create a file called '''render_internalid.pl''' in '''cfg/cfg.d/''' of you archive, with the following contents:

	$c->{render_internalid} = sub		$c->{render_internalid} = sub

Drn@ecs.soton.ac.uk at 10:12, 19 June 2017

2017-06-19T10:12:37Z

← Older revision		Revision as of 10:12, 19 June 2017
Line 82:		Line 82:
	dataset => $user_ds		dataset => $user_ds
	);		);
	$userexp->add_field( $user_ds->get_field( "internalid" ), $value);		$userexp->add_field( $user_ds->get_field( "internalid" ), $value );
	my $results = $userexp->perform_search;		my $results = $userexp->perform_search;
	$user = $results->item( 0 );		$user = $results->item( 0 );