Editing Generic Reporting Framework (section)

==For Users==

The Generic Reporting Framework adds a new link to the key tools bar (alongside links such as 'Manage Deposits' and 'Admin') called 'Reports', that is only shown to administrator users.

===Generating a Report===
This link displays the Reports splash page from which any available reports may be selected. 

[[File:reports_splash.png|800px|thumb|none]]

The Reports splash page shows both 'Preset Reports' and 'Custom Reports' depending on the reports available. 'Preset Reports' display records that match predefined criteria and are typically added to the repository through the installation of other plugins such as REF CC or ORCID Support. 'Custom Reports' displays a dropdown of available reports, and a search form for the selected report. This can used to generate a report comprised of records which match the given search criteria. Generic Reporting Framework v3.0+ offers two custom reports by default, one for EPrints and another for Users.

[[File:custom_report_search_form.png|800px|thumb|none]] 

===Viewing a Report===
Once a report has been selected the page will reload to display the results of that report. This process may take a short while if there are lots of records to process. 

Next to each record is a coloured bar. For reports which indicate some form of validation (e.g. the REF CC compliance reports) this bar will indicate the status of the record, e.g. green for compliant, red for non-compliant. For reports which do not make use of compliance, this bar will be set to a default colour (which can be customised - see [[#For_Developers|For Developers]] section below.

Each record may also be accompanied by some bullet points offering further information about the record (e.g. why it might not meet compliance criteria).

Reports may also be exported using the 'Export' button at the top of the page. Some reports support custom exports and where available a number of fields will be listed alongside checkboxes. Each checked field will be included in the exported report.

[[File:export_field_options.png|800px|thumb|none]]

Reports may also be grouped and sorted by different fields using the 'Group by' and 'Sort by' links. Grouping recors has the affect of breaking down the page in to a number of different sections with a header to represent each group. Sorting records results in the records being reordered based on the selected field. If the records have already been grouped the records will be sorted within each group. The fields that are available for a given report's 'Group by' and 'Sort by' links may be set in the report's configuration - see [[#For_Developers|For Developers]] for more details.

[[File:report_group_sort.png|800px|thumb|none]]

===Exporting a Report===
====HTML Export====
The HTML report reproduces the report as an HTML page, with each record's citation displaying followed by a list of fields, as chosen from the export options. A 'Print' button at the top of the screen allows you to print the report, which may also be used to turn the report into a PDF document depending upon browser functionality.

Custom templates can be applied to each report's configuration to alter the look and feel of the HTML export (see [[#For_Developers|For Developers]] for more details).

[[File:html_export.png|800px|thumb|none]]

====CSV Export====
The CSV export displays the fields selected from the export options in a multi-line CSV format, i.e. each field is separated by a comma, with fields that contain multiple values, such as the Creators, field being displayed one per row when viewed as a spreadsheet.

The value in the first column of the CSV is repeated for every row. For this reason it is often useful to use an ID field as the first column (e.g. EPrint ID).

====JSON Export====
The JSON export represents the fields selected from the export options, in JSON format.