IRUS-UK

IRUS Widget

About the widget

The IRUS-UK widget enables IRUS-UK COUNTER-conformant statistics to be embedded into institutional repository pages. This user requested development offers greater flexibility to access and use IRUS-UK statistics.

By default, the widget provides summary level download statistics for a repository, for the last 12 months, broken down by item type. There a number of options available to tailor the display, which are described below.

Embedding the widget

Copy and paste this code into your web page where you want the widget to appear:

Change the RID (IRUS-UK Repository IDentifier) to your organization's RID. If you don't know your RID, you can find it on the IRUS-UK participants page: https://irus.jisc.ac.uk/about/participants/

Configuring the default display

It is possible to configure the default display by providing a number of additional optional query parameters in the call to irus_pr_widget.js:

Parameter	Description	Example	Default if omitted
startDate	Specify start of date range for the statistics you want to display. Format yyyy-mm	startDate=2019-01	12 months previous to the latest available date
endDate	Specify end of date range for the statistics you want to display. Format yyyy-mm	endDate=2019-06	Latest available date
headerTable	Specify whether to display header (status) table or not. Valid values are 'true' or 'false'.	headerTable=true	false
summaryTotals	Specify whether to display summary totals or not. Valid values are 'Show', 'Hide' or 'Only'.	summaryTotals=Only	Show

Additional parameters, if supplied, should be separated by an ampersand, e.g.
https://irus.jisc.ac.uk/js/irus_pr_widget.js?RID=108&headerTable=true&summaryTotals=Only

Configuration options within the widget

Controls within the displayed widget allow for:

Configuring the required date range
Limiting to a selected item type
Selecting overall totals or a breakdown per month
Displaying or hiding the header table
Displaying or hiding summary totals

Click the 'Submit' button to see the updated display.

See the working example below.

Styling the widget

You can, of course, style the widget to meet your own requirements. The working example, below, uses the iruswidget.css file. You can reference the stylesheet in your own web pages, inside the <link> element, which goes inside the <head> section: