Generic Reporting Framework - Revision history

Rwf1v07@soton.ac.uk: /* Set Export Field Checkbox Orderng (v3.1+ only) */

2019-03-05T14:16:01Z

Set Export Field Checkbox Orderng (v3.1+ only)

← Older revision		Revision as of 14:16, 5 March 2019
Line 477:		Line 477:
	</pre>		</pre>

	===Set Export ~~Field Checkbox Orderng~~ (v3.1+ only)===		===Set Available Export Plugins (v3.1+ only)===
	The ordering and presence of export plugins presented in the 'Export Options' box at the top of a report screen, may be configured for each report, e.g.		The ordering and presence of export plugins presented in the 'Export Options' box at the top of a report screen, may be configured for each report, e.g.

Rwf1v07@soton.ac.uk: /* Set Export Field Checkbox Orderng (v3.1+ only) */

2019-03-05T14:04:52Z

Set Export Field Checkbox Orderng (v3.1+ only)

← Older revision		Revision as of 14:04, 5 March 2019
Line 447:		Line 447:
	The export functions (which may also be used to override existing fields in the dataset), receive both the dataobject and the report plugin as parameters, which may be used when generating the value that is to be exported.		The export functions (which may also be used to override existing fields in the dataset), receive both the dataobject and the report plugin as parameters, which may be used when generating the value that is to be exported.

	===Set Export Field Checkbox ~~Orderng~~ (v3.1+ only)===		===Set Export Field Checkbox Ordering (v3.1+ only)===
	The fields which may be included in an export are displayed as columns of checkboxes, as defined by the 'exportfields' value, e.g.:		The fields which may be included in an export are displayed as columns of checkboxes, as defined by the 'exportfields' value, e.g.:

Rwf1v07@soton.ac.uk: /* For Developers */

2019-03-01T13:33:18Z

For Developers

@@ Line 469: / Line 469: @@
 <pre>
 $c->{my_report}->{exportfield_order} = [ qw( eprint_core eprint_metadata )];
 </pre>

Rwf1v07@soton.ac.uk: /* For Developers */

2019-03-01T13:27:08Z

For Developers

← Older revision		Revision as of 13:27, 1 March 2019
Line 446:		Line 446:

	The export functions (which may also be used to override existing fields in the dataset), receive both the dataobject and the report plugin as parameters, which may be used when generating the value that is to be exported.		The export functions (which may also be used to override existing fields in the dataset), receive both the dataobject and the report plugin as parameters, which may be used when generating the value that is to be exported.

			===Set Export Field Checkbox Orderng (v3.1+ only)===
			The fields which may be included in an export are displayed as columns of checkboxes, as defined by the 'exportfields' value, e.g.:

			<pre>
			$c->{my_report}->{exportfields} = {
			eprint_core => [ qw(
			eprintid
			title
			abstract
			)],
			eprint_metadata => [ qw(
			publication
			divisions
			subjects
			)]
			};
			</pre>

			The order in which these columns are displayed may be set by providing a list of the keys of this hash, e.g.:

			<pre>
			$c->{my_report}->{exportfield_order} = [ qw( eprint_core eprint_metadata )];
			</pre>

	==Change Log==		==Change Log==

Rwf1v07@soton.ac.uk: /* Change Log */

2019-03-01T13:19:25Z

Change Log

← Older revision		Revision as of 13:19, 1 March 2019
Line 481:		Line 481:
	* Grouping of items within a report based on fields specified in report config		* Grouping of items within a report based on fields specified in report config
	* Sorting of items within a report based on fields specified in report config		* Sorting of items within a report based on fields specified in report config

			====3.1 (01 March 2019)====
			* Add 'New search' and 'Refine search' links when viewing a report generated by a search
			* Fix bug with 'Reset the form' button not working
			* Add "Select/Deselect All" button to export field interface
			* Allow ordering and appearance of export plugin options to be configurable at a report level
			* Allow ordering of export field checkboxes to be configurable at a report level
			* Update CSV export to render subject names rather than values
			* Update CSV export to render virtual fields
			* Remove 'counter' from list of fields included in the user reports
			* Fix bug with JSON export not working when no custom export functions defined

Rwf1v07@soton.ac.uk: /* Export Virtual Report Fields (v3.0+ only) */

2019-02-07T14:48:35Z

Export Virtual Report Fields (v3.0+ only)

← Older revision		Revision as of 14:48, 7 February 2019
Line 438:		Line 438:
	virtual_field_foo => sub {		virtual_field_foo => sub {
	my( $dataobj, $plugin ) = @_;		my( $dataobj, $plugin ) = @_;
	return "My exported value"; ~~#return an array of values to present over mulitple rows in a multiline CSV export~~		return "My exported value";
	}		}
	};		};
	</pre>		</pre>

			To return values over multiple rows in the multiline CSV export, we can simply return an array of the values we want to return.

	The export functions (which may also be used to override existing fields in the dataset), receive both the dataobject and the report plugin as parameters, which may be used when generating the value that is to be exported.		The export functions (which may also be used to override existing fields in the dataset), receive both the dataobject and the report plugin as parameters, which may be used when generating the value that is to be exported.

Rwf1v07@soton.ac.uk: /* Export Virtual Report Fields (v3.0+ only) */

2019-02-07T14:47:51Z

Export Virtual Report Fields (v3.0+ only)

← Older revision		Revision as of 14:47, 7 February 2019
Line 438:		Line 438:
	virtual_field_foo => sub {		virtual_field_foo => sub {
	my( $dataobj, $plugin ) = @_;		my( $dataobj, $plugin ) = @_;
	return "My exported value";		return "My exported value"; #return an array of values to present over mulitple rows in a multiline CSV export
	}		}
	};		};
	</pre>		</pre>

	The export functions (which may also be used to override existing fields in the dataset, receive both the dataobject and the report plugin as parameters, which may be used when generating the value that is to be exported.		The export functions (which may also be used to override existing fields in the dataset), receive both the dataobject and the report plugin as parameters, which may be used when generating the value that is to be exported.

	==Change Log==		==Change Log==

Rwf1v07@soton.ac.uk: /* Returning Report Bullet Points (v1.1+ only) */

2018-12-21T10:09:30Z

Returning Report Bullet Points (v1.1+ only)

← Older revision		Revision as of 10:09, 21 December 2018
Line 75:		Line 75:
	else		else
	{		{
	push @bullets, EPrints::XML::to_string( $repo->html_phrase( "creator_no_orcid", creator => $repo->xml->create_text_node(EPrints::Utils::make_name_string( $creator->{name} ) ) ) );		push @bullets,
			EPrints::XML::to_string( $repo->html_phrase(
			"creator_no_orcid",
			creator => $repo->xml->create_text_node(EPrints::Utils::make_name_string( $creator->{name} ) )
			) );
	}		}
	}		}

Rwf1v07@soton.ac.uk: /* Returning Report Bullet Points (v1.1+ only) */

2018-12-21T10:08:44Z

Returning Report Bullet Points (v1.1+ only)

← Older revision		Revision as of 10:08, 21 December 2018
Line 66:		Line 66:
	if( EPrints::Utils::is_set( $creator->{orcid} ) )		if( EPrints::Utils::is_set( $creator->{orcid} ) )
	{		{
	push @bullets, EPrints::XML::to_string( $repo->html_phrase( "creator_with_orcid", creator => $repo->xml->create_text_node(EPrints::Utils::make_name_string( $creator->{name} ) ), orcid => $repo->xml->create_text_node( $creator->{orcid} ) ) );		push @bullets,
			EPrints::XML::to_string( $repo->html_phrase(
			"creator_with_orcid",
			creator => $repo->xml->create_text_node(EPrints::Utils::make_name_string( $creator->{name} ) ),
			orcid => $repo->xml->create_text_node( $creator->{orcid} )
			) );
	}		}
	else		else

Rwf1v07@soton.ac.uk at 10:06, 21 December 2018

2018-12-21T10:06:55Z

← Older revision		Revision as of 10:06, 21 December 2018
Line 408:		Line 408:
	The 'template' parameter is used to specify the name of a template XML file that the report should use instead of default.xml.		The 'template' parameter is used to specify the name of a template XML file that the report should use instead of default.xml.

			===Export Virtual Report Fields (v3.0+ only)===
			The list of fields to be included in a report export, may now also include virtual report fields. These fields do not need to be defined anywhere else in the dataset configuration.

			To define a virtual report field, first include it in the list of the 'exportfields', e.g.

			<pre>
			$c->{eprint_report}->{exportfields} = {
			eprint_report_core => [ qw(
			eprintid
			title
			virtual_field_foo
			)]
			};
			</pre>

			For the field to be exported successfully, we must define a function that generates a value to be included in the export. E.g.

			<pre>
			$c->{eprint_report}->{custom_export} = {
			virtual_field_foo => sub {
			my( $dataobj, $plugin ) = @_;
			return "My exported value";
			}
			};
			</pre>

			The export functions (which may also be used to override existing fields in the dataset, receive both the dataobject and the report plugin as parameters, which may be used when generating the value that is to be exported.

	==Change Log==		==Change Log==