Overall Requirements - adammoore/corda GitHub Wiki

Overarching User Story

As a Research Institution

I want to be able to access a simple dashboard which tells me which members of my institution have registered ORCID ids

I want this simple dashboard to include a downloadable report on which members of my institution have registered for ORCID ids

So that I can effectively report on uptake across the institution, and know which members of my institution to target with advocacy programs

Realising these requirements are in the Developers requirements document

Appendix 1 - Requirements as gathered in previous ORCID UK community activites

This Appendix pulls together information recorded during the various previous activities, run by Jisc between 2016-2018 with the UK ORCID consortium community, which are relevant to the dashboard, with links to the source of the information.

On 30th September 2016, attendees at a Jisc UK ORCID consortium workshop considered a compilation of over 100 user stories[1], and voted on the most important. What became known as the ‘Dashboard’ was the top voted story, and was developed into a use case[2].

Dashboard User Story

As a Faculty Research lead, Faculty administrator, Impact and engagement officer, Research administrator or member of the library research support team, I want to be able to access an institutional ORCiD dashboard, in order to see how many researchers in my institution have registered for an ORCiD ID and an overview of their activity (e.g. number of publications), and report on this to senior staff in the institution.

Dashboard Use Case

From https://docs.google.com/document/d/19sXCUh5R4xcRpwOf_ez1pCaNxDdkyCnYYrweHJRBli8/edit#heading=h.fafvrufck6lt

Summary: We have a central point to monitor adoption and engagement with various systems that can be filtered using various criteria. It allows admins to drill down into the data to inform future advocacy. Visualisation of the data and export functions can feed into reports to senior management.

Rationale

We (as institutions) need to measure ORCiD for HESA, REF, some funders or publishers.
We as institutions don’t want to target researchers that already have an ORCiD.
We want to see which researchers are already engaging and whom we have to target with our advocacy programs

The use case includes list of users and actors, systems and applications that may be involved, Pre and Post conditions and variations to standard flow (not repeated here).

The standard flow is described as

Log onto the dashboard
Alert system for newly connected ORCIDs

Feeds

Feed from HR system for new staff to target for future advocacy
Feed for people that have left and still have ORCIDs connected to the institution
Feed for people that revoked “trusted party” permissions
I can report/see charts on (clickable and interactive)
Report/filter on faculties/schools
Report/Filter on public profiles/researchers that made “us” a trusted party
Report/Filter on staff categories (PhD students, funded researchers)
Report/Filter on funders/grants (to allow Wellcome compliance reporting)
Provide an overview of systems the ORCID is connected to (both internal systems as well as Scopus etc.)
Report on frequency of interactions/updates to ORCID record
Report on “inactive ORCIDs”

Export functions (csv, xml, json)

Variations on the top-voted user story

These are included for completeness and the many variations illustrate the extent of demand for this feature. There is much overlap. We may want to consider if there are any elements that surface through these variations that need to be included to enhance the original use case.

As a research admin, I want a discipline/institutional dashboard, so I can see which researchers DO NOT have an ORCID ID (linked to symplectic)
As a research admin, I want to have a dashboard to monitor adoption and usage, so I can target those who don't have/use their ORCID or haven't told us they have one
As a research administrator, I want a dashboard to monitor ORCID adoption and usage in various systems owned/used/run by my university,
As a solutions architect, I want to ensure that integration with other IT systems can be done effectively, so that reporting can be done in real time and accurately without duplication of data
As a research admin, I want to know which academics have more than one ORCID, so that I can merge the records
As an Institutional administrator, I want to get periodic reports on membership linked to my institution, so I can track how many current researchers have linked their ORCIDs to my institution
As a research admin, I want to know which academics do not have an ORCID, so I can encourage them to get one
As a repository administrator, I want to be able to monitor how many people are signed up to ORCID with a Leeds Beckett address, so I can record and report uptake
As a repository manager/research lead, I want to know who has not got an ORCID, so I can target and improve numbers/integrate into institution
As a research admin/repository manager, I want to know who has given the university permission to access their ORCID list, so I can ask those who haven't why
As a research information system administrator, I want to see who from the university has an ORCID, so I can target those who haven't/haven't told us in communications
As a librarian, I want to see how many ORCID IDs are registered at my institution and others, so I can benchmark progress/assess communications

Member’s event 2017

A session was dedicated to questions that institutions would like to answer using the API, and common queries[3]. The questions (and answers provided by ORCID) relevant to the topic are extracted.

[TODO extract relevant Qs and A if needed]

From hackday 2018 report

There were two strands of work that looked at the information or reports that institutions wanted to be able to access in relation to ORCID.

Firstly a specific piece of work looked at the regular "member report" institutions which are members of ORCID are able to get. This work looked at how these reports could be retrieved automatically and then visualised to help show trends over time and to have a way of exploring the data in an interative and visual way. This was achieved by using a single sample report, enhanced with some dummy data (as those working on the project didn't have direct access to the real reports). The data was accessed through a CSV file on a Google Drive (which is how the reports are made available to institutions), and then visualised using a Javascript API, with a focus on showing trends over time.

The second strand of work was a more general discussion about the sort of information that institutions want to see from ORCID. A common issue seems to be institutions often struggle to find out which (or how many) of their researchers are already using ORCID - this is a question that has been raised at previous ORCID events in the UK, including the Jisc ORCID support workshop in June 2017. The ORCID member report may provide at least a partial solution to this perennial problem, although it cannot overcome the fact that if researchers do not share information on ORCID that links them to an institution, it is not possible to know which institutions, if any, they are affiliated with.”

User quotes

These are quoted verbatim and are provided for enhancement to bring the application to life and remind us of the end users who need to use this tool.

As an institution, I want to be able to access an institutional ORCiD dashboard, which will tell me how many researchers in my institution have registered for an ORCiD ID with results displayed by:

institutional email address

by current institutional affiliation (denoted by a persistent, unique identifier, such as ISNI) and secondary affiliation (e.g. research group or academic department within the institution)

I want to be able to see an overview of activity by institutional ORCiD account holders, with access to data like,

total number of publications (and within that, articles, books, chapters, etc.)

most active institutional ORCiD accounts (e.g. number of publications added in the last month)

inactive institutional ORCiD accounts

which ORCiD accounts are public

And I would like to be able to export this information

This information would help us identify which researchers we need to engage in our ORCiD rollout, and help us understand areas of activity or compliance. In addition, it will help inform us about academic profile management by our researchers, so that the University can help develop staff training and guidance around the effective use of social media tools and academic networks for maximising research impact. Improved ORCiD integrations with University and 3rd party platforms (such as CRIS systems and tools like Kudos, or Researchfish), allowing pull of data feeds from ORCiD, and push of data back into an ORCiD account, would also help us put ORCiD close to the centre of researcher’s ability to manage their own output profile, without the need for them to engage with keeping multiple systems and environments up to date.

From Community mailing list, 28/03/18

I was wondering if anyone else would be interested in using the Member Reports to see progress with ORCID takeup over time. We’d like some sort of visualisation of our total number of user interactions each month, particularly new ORCID authorisations for our integration (Symplectic Elements). We currently extract from Elements a snapshot of current numbers of linked ORCIDs. I realise I could easily use this to put together something on data over time, but since the monthly data is in the Member Reports, I was thinking that it might be nice to enhance it for everyone. I think this is the data we’d be interested in (from UCL’s latest report):

From Google Doc