Referee REF Paper Ranking Service

Tim Colles

Revision History
Revision 1.1December 2018TC

Dedication

Copyright © 2018, Tim Colles.

Permission is granted to copy, distribute and/or modify this document under the terms of the GNU Free Documentation License, Version 1.3 or any later version published by the Free Software Foundation; with no Invariant Sections, no Front-Cover Texts, and no Back-Cover Texts. A copy of the license is included in the appendix entitled "GNU Free Documentation License".

Table of Contents

Preface
I. Overview
1. Introduction
2. Web Browser Interface for all Users, Raters and Moderaters
3. Web Browser Interface for Institute (Deputy) Director Users
4. Web Browser Interface for Administrative Users
5. RESTful API for all Users, Raters and Moderaters
6. RESTful API for Institute (Deputy) Director Users
7. RESTful API for Administrative Users
II. Referee Database Technical Reference
Preface
8. Sequence
8.1. moderater_id_seq
8.2. paper_id_seq
8.3. person_id_seq
8.4. rater_id_seq
9. Table
9.1. institute
9.2. moderater
9.3. paper
9.4. person
9.5. pure_paper_feed
9.6. pure_paper_file_feed
9.7. pure_staff_feed
9.8. rater
10. Type
11. View
11.1. dualrater
11.2. moderater_access
11.3. moderater_institute_access
11.4. moderaterupdate
11.5. paper_access
11.6. paper_institute_access
11.7. paperupdate
11.8. person_institute_access
11.9. person_stats
11.10. ppfunq
11.11. psfsplit
11.12. rater_access
11.13. rater_institute_access
11.14. raterupdate
11.15. status_institute_access
12. Function
13. TheonCoupler Function
13.1. _th_pure1ac_person_couple
13.2. _th_pure2_paper_couple
14. Eventfunction
14.1. dualrater_update_171152136
14.2. moderater_update_1686167270
14.3. paper_update_184621051
14.4. rater_update_917830668
15. TheonCoupler Eventfunction
15.1. _th_coupler_paper_check
15.2. _th_coupler_person_check
16. Tablefunction
17. Clusters
17.1. TheonGW Interfaces
17.2. TheonUI Reduced Desktops
18. Roles
18.1. rootclient
18.2. userclient
19. Streams
19.1. pure1ac
19.2. pure2
19.3. pure2ef
III. Referee UI Desktop Technical Reference
Preface
20. Desktops
20.1. API
20.2. REF (Admin)
20.3. REF (Institute)
20.4. REF (User)
20.5. REF (User) [Reduced]
21. Panels
21.1. Institute
21.2. InstitutePapers
21.3. Institutes
21.4. Moderaters
21.5. MyInstitutePapers
21.6. MyPapers
21.7. Overview
21.8. Overview
21.9. Paper
21.10. Papers
21.11. Papers
21.12. Papers to Moderate
21.13. Papers to Rate
21.14. Papers2Rate[R]
21.15. PapersToModerate
21.16. PapersToRate
21.17. Person
21.18. Raters
21.19. Staff
21.20. Submitter
21.21. Submitters
IV. Referee Gateway REST API Technical Reference
Preface
22. Interfaces
22.1. API
22.2. REF (Admin)
22.3. REF (Institute)
22.4. REF (User)
22.5. REF (User) [Reduced]
23. Resources
23.1. Institute
23.2. InstitutePapers
23.3. Institutes
23.4. Moderaters
23.5. MyInstitutePapers
23.6. MyPapers
23.7. Overview
23.8. Overview
23.9. Paper
23.10. Papers
23.11. Papers
23.12. Papers to Moderate
23.13. Papers to Rate
23.14. Papers2Rate[R]
23.15. PapersToModerate
23.16. PapersToRate
23.17. Person
23.18. Raters
23.19. Staff
23.20. Submitter
23.21. Submitters
A. GNU Free Documentation License
Index

Preface

The complete guide to the Referee service. This book covers everything at both a user level and a techincal level.

Part I. Overview

Chapter 1. Introduction

The Referee system holds a copy of the details of all papers submitted for the REF. The relevant data is extracted automatically from PURE on a regular (once daily) basis. The copy is not locally editable, if there is anything wrong the corrections must be made by updating the data held in PURE.

The Referee system allows administrators to assign raters and moderaters to each paper. Those raters and moderaters can then review and give a rating (from 0 to 4 in 13 steps) to each of the papers they have been assigned. They can also provide a freeform comment. Moderaters also have access to an aggregated list of the ratings made by each of the raters for each paper they are moderating. Administrators can then choose papers for submission based on these rankings.

Two interfaces are provided to the system. There is a web browser user interface provided for both ordinary users and admin users. There is also a RESTful API that provides access to complete functionality. The API may be preferred over the web interface by some due to the possibilty it offers for scripting and managing bulk updates. The API can also be used to make adhoc extractions of data (e.g. to load into a Spreadsheet to produce custom reports) for offline manipulation and subsequent re-entry.

Both interfaces require pre-authentication using a DICE account and are accessable from outside EdLAN.

Chapter 2. Web Browser Interface for all Users, Raters and Moderaters

Go to the URL:

above (you may be bounced via DICE weblogin authentication).

The Choose Desktop menu has three desktop options (ignore the first two):

  • REF (Admin)
  • REF (Institute)
  • REF (User)

The first, REF (Admin) is for Admin users only. You can open it but will get an insufficient privilige error unless you have the necessary administrative priviliges.

The second, REF (Institute) is only for users that are Institute Directors or Deputy Directors. You can open it but will not see any data unless you have been assigned an Institute Directorship role by the Admin users.

The second, REF (User), is for all other users (submitters and/or raters and/or moderaters). What you can do will depend on what roles you have been assigned.

Choose the REF (User) desktop from the menu.

You will get a desktop open with three tabs:

  • MyPapers
  • PapersToRate
  • PapersToModerate

The first tab MyPapers will be open. This lists the papers you have personally put forward for the REF (ordered by Rank). Nothing on here is editable.

Click on the PapersToRate tab. This panel contains a table that lists the papers you have been assigned to review including rank and URL. You can click on any paper on the table to select that paper and you can use the cursor keys to navigate up and down papers, or use the scrollbar at the right. Above the table are two fields showing the Reason for Submission and the Abstract for the current paper selected in the table. These can be expanded if necessary using the browser widget at the bottom right corner of each field.

The default ordering of the table is Lastname, Rank but you can change that. On the table only the MyRating and MyComment columns are editable, you will get an error if you try to change anything else. To make changes simply click on either the MyRating or MyComment cell on the appropriate row and enter something in either or both fields. Then click on the Save Changes button at the bottom right of the screen. The table should reload with your changes made. You can redo the changes, enter ratings for more than one paper at once before saving the changes, etc.

You can enter restrictive queries rather than listing all papers. For example, to just show unrated papers: click on the New Query button at the bottom right of the screen and the table will switch to showing a blank row and the cell background of that row will be green in colour; click on the MyRating cell, enter =, click on ToolBox tab at top right and change Choose Pattern to Exact Match; click on the Search button at the bottom right.

Click on the PapersToModerate tab. This lists the papers you have been assigned to moderate. The behaviour and usage is identical to above - in this case the MyRating field is the moderated/agreed rating though. There are however a couple of additional fields: Raters: Done/Count and Raters: Rating. The former indicates how many raters have been assigned to the paper and how many have actually entered a rating. For example, you might see "0/2" meaning two have been assigned but neither have yet rated the paper, or you might see "2/2" meaning both have done their job. The latter field is a list of all the ratings the raters have made, e.g. "2" and "3" would be shown as "2(Bloggs)/3(Doe)" where the lastname of the rater is included in brackets.

Chapter 3. Web Browser Interface for Institute (Deputy) Director Users

Go to the URL:

above (you may be bounced via DICE weblogin authentication).

Choose the REF (Institute) desktop from the menu. If you don’t see any data you probably have not been assigned as an Institute Director or Deputy Director within the Referee system - contact an Admin user to fix this.

You will get a desktop open with two tabs:

  • MyInstitutePapers
  • Overview

The first tab (open by default) lists ALL papers proposed for the REF associated with your institute (submitted by members of your institute). All data on this panel is is read only and any attempt to change data will result in an error. You can scroll through papers using the scroll bar at the right of the panel. This can be inefficient when there are a lot of papers in which case querying for a few at a time is beneficial. For example, to view just Joe Blogg’s papers click on the New Query button at bottom right, click in the Submitter Lastname field and enter "bloggs" then click on the Search button at bottom right. You should then just see the papers submitted by Joe Bloggs.

The Status box has some management stats. The Raters: Done/Count, Rater1: Rating (Name) and Rater2: Rating (Name) fields are the same as on the PapersToModerate panel on the REF (User) desktop. If the first and second rater assigned ratings differ the Raters field will have the value "Disagree", otherwise if they are they same this will be "Agree". If one of the raters has not entered a rating yet this will be blank. The Moderaters: Done/Count and Moderaters: Rating (Name) do exactly the same job except for the moderaters assigned to the paper. Note that any number of raters and any number of moderaters can be assigned to a paper. The Moderater field will be "Differs" when the average value (as a floating point number) of the ratings given by the raters is distinct from the average value (as a floating point number) given by the moderater, and will be "Average" otherwise. It will be empty if one or both raters have not entered a rank or if the moderater has not entered a rank. This field can be used to show where the moderation process has resulted in a rating divergent from the original rating. Following completion of review th Result field value will indicate the best rated paper (based on moderated rating) for each submitter. Where a submitter has multiple papers rated the same then the one that the submitter ranked highest will be indicated as the best. Where the submitter has used the same ranking more than once then the one indicated as the best will be effectively random. Further information about all fields can be found in the DDL Documentation.

Now click on the Overview tab. This has largely identical content to MyInstitutePapers however it is presented in a tabular format which can be easier to use to get an overall or filtered view. You can search on this in the same way as the other panel. For example, to see just the best submitted papers for each author in your institute click on the New Query button at bottom right, click in the first row under the column Result and enter "best" then click on the Search button at bottom right. You should then just see the best papers submitted.

Chapter 4. Web Browser Interface for Administrative Users

Go to the URL:

above (you may be bounced via DICE weblogin authentication).

Choose the REF (Admin) desktop from the Choose Desktop menu. If you get an insufficient privilige error you don’t have the necessary administrative role - if you think you should contact support.

You will get a desktop open with five tabs:

  • Paper
  • Person
  • Submitter
  • Institute
  • Overview

For now ignore the open Paper one and click on the Person one instead. This will bring up a list of all REF eligible staff (including those not necessarily affiliated with the local Unit). Note however that any external staff that need access to the system (as a Rater for example) will need to have a DICE account. This can be done by setting them as a local Visitor.

For each person only the last three cells in the row are editable - Eligible, Rater and Moderater. To make changes click the appropriate checkbox to toggle the state and then click on the Save Changes button at the bottom right. By default all listed staff will be eligible, so you shouldn’t normally need to change the Eligible value (those that aren’t eligible are not listed by default). If a person has Rater set then they will be available for assignment to rate papers, if a person has Moderater set then they will be available for assignment to moderate papers. Changes made on this panel may not be reflected immediately on the Paper panel - you can force the update at any time by re-opening the whole desktop from Choose Desktop.

Now click on the Paper tab. This lists ALL papers proposed for the REF. In the top part nothing is editable apart from the Chosen field which allows you to set that paper to be put forward for the REF submission. You can scroll through papers using the scroll bar at the right of the panel. This can be inefficient when there are a lot of papers in which case querying for a few at a time is beneficial. For example, to view just Joe Blogg’s papers click on the New Query button at bottom right, click in the Submitter Lastname field and enter "bloggs" then click on the Search button at bottom right. You should then just see the papers submitted by Joe Bloggs.

The Status box has some management stats (all of these are read only). The Raters: Done/Count, Rater1: Rating (Name) and Rater2: Rating (Name) are the same as on the PapersToModerate panel on the REF (User) desktop. If the first and second rater assigned ratings differ the Raters field will have the value "Disagree", otherwise if they are they same this will be "Agree". If one of the raters has not entered a rating yet this will be blank. The Moderaters: Done/Count and Moderaters: Rating (Name) do exactly the same job except for the moderaters assigned to the paper. Note that any number of raters and any number of moderaters can be assigned to a paper. The Moderater field will be "Differs" when the average value (as a floating point number) of the ratings given by the raters is distinct from the average value (as a floating point number) given by the moderater, and will be "Average" otherwise. It will be empty if one or both raters have not entered a rank or if the moderater has not entered a rank. This field can be used to show where the moderation process has resulted in a rating divergent from the original rating. Following completion of review th Result field value will indicate the best rated paper (based on moderated rating) for each submitter. Where a submitter has multiple papers rated the same then the one that the submitter ranked highest will be indicated as the best. Where the submitter has used the same ranking more than once then the one indicated as the best will be effectively random. Further information about all fields can be found in the DDL Documentation.

The final two boxes are used to assign raters and moderaters to papers, although if assignment is being done by submitter (i.e. raters or moderaters are assigned to all papers of a submitter) then the Submitter panel should be used instead (see below). For any given paper do as follows to add a Rater (adding a Moderater is identical). Click on the little green plus icon at the bottom right of the Rater table to get a new row. Click on the Lastname field in the new row to get a drop-down menu. This will be a list of possible names (those that have the Rater checkbox set on the Person panel). Then start typing the surname (DO NOT USE MOUSE/TRACKPAD TO SELECT) by lookahead, e.g. if I type b the selected menu option shown will move down to and highlight Bloggs. Then hit Return to close the drop down menu and click on the Save Changes button at bottom right. You have now added Bloggs as a rater to whatever paper you had in view at the time. Note that you can add multiple raters and moderators before saving. With practice you can get very fast at doing this.

More than one rater (or moderater) can be added as above. To delete one click in the relevant row, then click on the red X button at bottom right of table then Save Changes. Note that if you delete an assignment then all the ratings and comments made by the rater for the paper will also be deleted so make sure the values shown are empty (or confirm you don’t mind any being lost).

To re-assign you can click on a row, select a new rater from the drop-down menu (using the keyboard) then Save Changes). Note that any ratings and comments made by the previous rater will then be attributed to the new rater, so make sure the values shown are empty (or confirm you don’t mind the attribution shifting).

In each entry the Rank and Comment fields will show what that rater/moderater has actually entered (these can also be edited, although that might not be necessary). These fields can be used to constrain the query used on the Paper panel so as to just show raters or moderaters who haven’t finished done their reviews yet for example.

Now click on the Submitter tab. This lists ALL submitters that have proposed papers for the REF. Only the two ? Rater columns and the ? Moderater column are editable. Use these drop-downs, as on the Rater box and Moderater box in the Paper panel (see above) to choose the first and second rater and moderater for a submitter. Done this way then the raters and moderater will be assigned to all the papers proposed by that submitter in one step.

Now click on the Institute tab. This is a configuration table that should only need to be used once. This holds organisation names (exactly as they are defined in PURE) and a short local abbreviation. The data is used to map from organisation affiliations held in PURE so that they can be shown easily against each submitter where relevant. The Include checkbox also needs to be set for this to happen. For each institute you can select a Director and a Deputy Director from the drop-down options. These control the institute directorship access via the REF (Institute) desktop.

Now click on the Overview tab. This has largely identical content to Papers however it is presented in a tabular format which can be easier to use to get an overall or filtered view. You can search on this in the same way as the other panel. For example, to see just the best submitted papers for each author click on the New Query button at bottom right, click in the first row under the column Result and enter "best" then click on the Search button at bottom right. You should then just see the best papers submitted.

Chapter 5. RESTful API for all Users, Raters and Moderaters

The following describes the API calls and functionality implemented. The examples below are all run from a DICE machine and use some support tools to get and manage credentials. As long as you have a valid (unexpired) authentication cookie you can run these calls from anywhere using whatever tools are appropriate.

All the operations that can be done via the web browser interface can also be done via the API. The access levels and what is read only etc are all identical.

authGET https://gw.referee.inf.ed.ac.uk/api/v1/my_papers
{
    "my_papers": [
        {
            "abstract": "Quite amazing stuff worth a Nobel",
            "double_weight": true,
            "id": 3,
            "pure_url": "news.bbc.co.uk",
            "rank": "2nd",
            "reason": "unbeatable stuff",
            "title": "Test Paper 2",
            "uri": "/api/v1/my_papers/3"
        },
        {
            "abstract": "Tim wrote this first",
            "double_weight": false,
            "id": 4,
            "pure_url": "www.google.com",
            "rank": "3rd",
            "reason": "its soooo good",
            "title": "Test Paper 1",
            "uri": "/api/v1/my_papers/4"
        },
        {
            "abstract": "Who would have though it but we prove",
            "double_weight": false,
            "id": 5,
            "pure_url": "www.ed.ac.uk",
            "rank": "1st",
            "reason": "astounding what more can I say",
            "title": "Test Paper 3",
            "uri": "/api/v1/my_papers/5"
        }
    ]
}

Above obtains authentication and returns all papers I have submitted (just using test data in the example above). This is normally however just a copy of the data that has been fed in from PURE. If you have not submitted any papers this will return an empty array. Nothing can be updated via this call (you will get an entirely unhelpful error).

You can use some simple command line tools to convert the above, or any of the JSON output from these API calls, to CSV (to load into Excel or Libreoffice for example):

authGET https://gw.referee.inf.ed.ac.uk/api/v1/my_papers | \
  jq -r '.my_papers[] | [.id, .rank, .pure_url, .title, .reason, .abstract, .double_weight | tostring] | @csv'
"3","2nd","news.bbc.co.uk","Test Paper 2","unbeatable stuff","Quite amazing stuff worth a Nobel","true"
"4","3rd","www.google.com","Test Paper 1","its soooo good","Tim wrote this first","false"
"5","1st","www.ed.ac.uk","Test Paper 3","astounding what more can I say","Who would have though it but we prove","false"

Since the JSON output will always use the UTF-8 character encoding, so some characters may not be correctly shown using tools like authGET or curl. One way to fix this is to use jq. as above, for example:

authGET https://gw.referee.inf.ed.ac.uk/api/v1/my_papers
{
    "my_papers": [
        {
            "abstract": "wibble \u201cmilestone paper\u201d wibble blah.",
            "double_weight": false,
            "id": 88,
            "pure_url": "https://no.where.com/",
            "rank": "1st",
            "reason": null,
            "title": "Blah de Blah",
            "uri": "/api/v1/papers/88"
        }
    ]
}
authGET https://gw.referee.inf.ed.ac.uk/api/v1/my_papers | jq
{
  "my_papers": [
    {
      "abstract": "wibble “milestone paper” wibble blah.",
      "double_weight": false,
      "id": 88,
      "pure_url": "https://no.where.com/",
      "rank": "1st",
      "reason": null,
      "title": "Blah de Blah",
      "uri": "/api/v1/papers/88"
    }
  ]
}

This:

authGET https://gw.referee.inf.ed.ac.uk/api/v1/my_papers2rate

returns the list of papers I have to rate, e.g. abbreviated output of some test data:

authGET https://gw.referee.inf.ed.ac.uk/api/v1/my_papers2rate
...
     {
         "abstract": "Incontrovertible Evidence the Earth is Flat",
         "comment": null,
         "double_weight": false,
         "firstname": "Joe",
         "id": 14,
         "lastname": "Bloggs",
         "paper_id": 7,
         "pure_url": "www.the-earth-sure-is-flat.com",
         "rank": "1st",
         "rating": null,
         "reason": "sheer brilliance",
         "title": "Yes, The Earth IS Flat",
         "uri": "/api/v1/my_papers2rate/14"
     },
...

The same call can be used to update both the rating and the comment for that rating. To do this it is easiest to first save the authentication cookie:

export COSIGN_COOKIEFILE=~/.cookies.txt
rm -f $COSIGN_COOKIEFILE
touch $COSIGN_COOKIEFILE
chmod 0700 $COSIGN_COOKIEFILE
authGET https://gw.referee.inf.ed.ac.uk/api/v1/my_papers2rate
export SESSION_COOKIE=`awk '/cosign-gw/{print$5"="$6}' $COSIGN_COOKIEFILE`

Now I can make the update:

curl -X PUT --cookie "$SESSION_COOKIE" \
"https://gw.referee.inf.ed.ac.uk/api/v1/my_papers2rate/14?rating=2*&comment=changed"
{
 "my_papers2rate": {
     "abstract": "Incontrovertible Evidence the Earth is Flat",
     "comment": "changed",
     "double_weight": false,
     "firstname": "Joe",
     "id": 14,
     "lastname": "Bloggs",
     "paper_id": 7,
     "pure_url": "www.the-earth-sure-is-flat.com",
     "rank": "1st",
     "rating": "2*",
     "reason": "sheer brilliance",
     "title": "Yes, The Earth IS Flat",
     "uri": "/api/v1/my_papers2rate/14"
 }
}

You will need to ensure any parameter values are correctly encoded to URI specification.

This one works identically to above:

authGET https://gw.referee.inf.ed.ac.uk/api/v1/my_papers2moderate

but lists the papers I have to moderate and can be used exactly as above to set the moderated rating and comment for that paper.

Chapter 6. RESTful API for Institute (Deputy) Director Users

The API also exposes all of the institute directorship functionality.

authGET https://gw.referee.inf.ed.ac.uk/api/v1/my_institute_papers
{
    "my_institute_papers": [
        {
            "abstract": "Quite amazing stuff worth a Nobel",
            "apa": "",
            "chosen": false,
            "doi_url": null,
            "double_weight": false,
            "ere_url": "",
            "firstname": "Joe",
            "id": 615,
            "lastname": "Bloggs",
            "moderated_rank": null,
            "moderaters_done": "1/1",
            "moderaters_rating": "4",
            "moderaters_comment": "",
            "pure_url": "",
            "rank": "2nd",
            "rater1_rating": "3 (Doe)",
            "rater1_comment": "",
            "rater2_rating": "2 (Anon)",
            "rater2_comment": "",
            "raters": "Differ",
            "raters_done": "2/2",
            "reason": "TBC",
            "result": "Not Best",
            "title": "Test Paper 2",
            "uri": "/api/v1/my_institute_papers/615"
        }, ...
    ]
}

Above obtains authentication and returns all papers that have been submitted by members of the institute you are a director or deputy director of (just using test data in the example above). If you have not been assigned an institute directorship role in the Referee system this will return an empty array. Nothing can be updated via this call (you will get an entirely unhelpful error).

Chapter 7. RESTful API for Administrative Users

The API also exposes all of the administrative functionality, you need to have the necessary administrative rights to make these calls. So following on from the last section:

authGET https://gw.referee.inf.ed.ac.uk/api/v1/papers

returns a list of ALL papers, and I can set a paper (ID=13) to be chosen for our REF submission by doing:

curl -X PUT --cookie "$SESSION_COOKIE" \
"https://gw.referee.inf.ed.ac.uk/api/v1/papers/13?chosen=true"

I can get all the staff entries:

authGET https://gw.referee.inf.ed.ac.uk/api/v1/staff

Then I can set the eligibility, rater and moderater flags for any member of staff (ID=123):

curl -X PUT --cookie "$SESSION_COOKIE" \
 "https://gw.referee.inf.ed.ac.uk/api/v1/staff/123?eligible=true&rater=true&moderater=false"
{
 "staff": {
     "eligible": true,
     "firstname": "Jane",
     "id": 123,
     "lastname": "Doe",
     "moderater": false,
     "rater": true,
     "uri": "/api/v1/staff/123",
     "uun": "jdoe"
 }
}

I can also allocate raters/moderaters to papers. This can be done under the context of a paper or under the context of a staff member. So for the former I can get all the raters of a paper (for example with ID=3):

authGET https://gw.referee.inf.ed.ac.uk/api/v1/papers/3/raters
{
    "raters": [
        {
            "comment": null,
            "id": 2,
            "paper_id": 3,
            "papers_uri": "/api/v1/papers/3",
            "person_id": 48,
            "rank": null,
            "uri": "/api/v1/raters/2"
        },
        {
            "comment": null,
            "id": 3,
            "paper_id": 3,
            "papers_uri": "/api/v1/papers/3",
            "person_id": 285,
            "rank": null,
            "uri": "/api/v1/raters/3"
        }
    ]
}

Then add a new rater to that paper using the staff ID (123 for Doe above):

curl -X POST --cookie "$SESSION_COOKIE" \
 "https://gw.referee.inf.ed.ac.uk/api/v1/papers/3/raters?person_id=123"
{
    "raters": [
        {
            "comment": null,
            "id": 34,
            "paper_id": 3,
            "papers_uri": "/api/v1/papers/3",
            "person_id": 123,
            "rank": null,
            "uri": "/api/v1/raters/34"
        }
    ]
}

Or the other way around, I can get the papers that a particular staff member (for example with ID=123) is rating:

authGET https://gw.referee.inf.ed.ac.uk/api/v1/staff/123/rating

Then add a new paper for that person to rate by paper ID (for example with ID=6):

curl -X POST --cookie "$SESSION_COOKIE" \
 "https://gw.referee.inf.ed.ac.uk/api/v1/staff/123/rating?paper_id=6"
{
    "rating": [
        {
            "comment": null,
            "id": 36,
            "paper_id": 6,
            "person_id": 123,
            "rank": null,
            "staff_uri": "/api/v1/staff/123",
            "uri": "/api/v1/rating/36"
        }
    ]
}

The same can be done for moderater assignment but by using these calls instead:

https://gw.referee.inf.ed.ac.uk/api/v1/papers/3/moderaters
https://gw.referee.inf.ed.ac.uk/api/v1/staff/123/moderating

Existing rater/moderater assignments can also be deleted by using calls below where <ID> is the number of the assignment (the id field returned in the calls above):

curl -X DELETE --cookie "$SESSION_COOKIE" \
 https://gw.referee.inf.ed.ac.uk/api/v1/rating/<ID>
curl -X DELETE --cookie "$SESSION_COOKIE" \
 https://gw.referee.inf.ed.ac.uk/api/v1/moderating/<ID>

Or allocation by submitter can be done using:

authGET https://gw.referee.inf.ed.ac.uk/api/v1/submitters

returns a list of ALL submitters, and I can set the first and second rater and moderater of all papers (from submitter ID=13 in the example below) by doing:

curl -X PUT --cookie "$SESSION_COOKIE" \
"https://gw.referee.inf.ed.ac.uk/api/v1/submitters/13?rater1_id=87&rater2_id=24&moderater_id=51"

where the relevant rater ID can be established from the api/v1/staff call.

Finally the institute mappings are available via:

authGET https://gw.referee.inf.ed.ac.uk/api/v1/institutes

New entries can be added and existing entries can be modified/deleted as necessary.

Part II. Referee Database Technical Reference

Preface

The Referee database holds all the papers for rating, the assignment and rating results of raters and moderaters of each paper. This part contains the full technical reference for this database which has been automatically generated from the corresponding ModelLibrary.

Chapter 8. Sequence

8.1. moderater_id_seq

UUID

ent-56476904-c9ad-442d-8217-e20a029a08db

Relation Type

SEQUENCE

Relation Name

Moderater (Sequence)

Sequence Name

moderater_id_seq

Sequence Signature

moderater_id_seq

Explicit Cluster Membership

NONE

Explicit Dependencies

NONE

Export Element Instance

entity:moderater_id_seq

Derive Fragment Instance

relation:moderater_id_seq

Description

This is the serial number generator for the identifier field in the Moderater table.

8.1.1. Properties

The following are the deviant properties associated with this sequence.

Name Value

CYCLE

0

INCREMENT

1

MAXVALUE

9223372036854775807

MINVALUE

1

8.1.2. Roles

The following are the roles controlling access to this sequence.

Role Name Group Name Allowing Description

???

8.2. paper_id_seq

UUID

ent-a28a413a-dd03-47ea-b03b-d22e4ef24ddd

Relation Type

SEQUENCE

Relation Name

Paper (Sequence)

Sequence Name

paper_id_seq

Sequence Signature

paper_id_seq

Explicit Cluster Membership

NONE

Explicit Dependencies

NONE

Export Element Instance

entity:paper_id_seq

Derive Fragment Instance

relation:paper_id_seq

Description

This is the serial number generator for the identifier field in the Paper table.

8.2.1. Properties

The following are the deviant properties associated with this sequence.

Name Value

CYCLE

0

INCREMENT

1

MAXVALUE

9223372036854775807

MINVALUE

1

8.2.2. Roles

There are no roles controlling access to this sequence.

8.3. person_id_seq

UUID

ent-72bf82d4-846f-4118-906e-024457b02680

Relation Type

SEQUENCE

Relation Name

Person (Sequence)

Sequence Name

person_id_seq

Sequence Signature

person_id_seq

Explicit Cluster Membership

NONE

Explicit Dependencies

NONE

Export Element Instance

entity:person_id_seq

Derive Fragment Instance

relation:person_id_seq

Description

This is the serial number generator for the identifier field in the Person table.

8.3.1. Properties

The following are the deviant properties associated with this sequence.

Name Value

CYCLE

0

INCREMENT

1

MAXVALUE

9223372036854775807

MINVALUE

1

8.3.2. Roles

There are no roles controlling access to this sequence.

8.4. rater_id_seq

UUID

ent-78dba8ec-7d4d-4bb6-afd4-478a9f374d85

Relation Type

SEQUENCE

Relation Name

Rater (Sequence)

Sequence Name

rater_id_seq

Sequence Signature

rater_id_seq

Explicit Cluster Membership

NONE

Explicit Dependencies

NONE

Export Element Instance

entity:rater_id_seq

Derive Fragment Instance

relation:rater_id_seq

Description

This is the serial number generator for the identifier field in the Rater table.

8.4.1. Properties

The following are the deviant properties associated with this sequence.

Name Value

CYCLE

0

INCREMENT

1

MAXVALUE

9223372036854775807

MINVALUE

1

8.4.2. Roles

The following are the roles controlling access to this sequence.

Role Name Group Name Allowing Description

???

Chapter 9. Table

9.1. institute

UUID

ent-2b13ae62-70fa-41c5-9d9c-508ac336314e

Relation Type

TABLE

Relation Name

Institute

Table Name

institute

Table Signature

institute

Explicit Cluster Membership

NONE

Explicit Dependencies

person

Export Element Instance

entity:institute

Derive Fragment Instance

relation:institute

Description

The Institute table holds the PURE organisation names and local labels to attribute to them. The contents of this table can be used to set up the names relevant to the local unit by listing them here and marking them by setting the research flag. These will then be included against the submitter names where relevant.

9.1.1. Properties

There are no deviant properties associated with this table.

9.1.2. Columns

The following are the columns in this table in positional order.

Attribute Name Column Name Type Properties Default Description

Organisation

organisation

TEXT

NONE

Full name of the organisation as it is defined in PURE. Must match as used to determine affiliations automatically,

Abbreviation

label

TEXT

NONE

Short acronym for the institute.

Research?

research

BOOLEAN

NONE

Flag indicating that this organisation is a research institute. More generally it indicates whether this organisation is included in any display of affiliated institutes for a submitter.

DirectorPersonID

person_id

INTEGER

NONE

The unique person identifier for the person that is the Director of the Institute, taken from the Person table.

DeputyDirectorID

dep_person_id

INTEGER

NONE

The unique person identifier for the person that is the Deputy Director of the Institute, taken from the Person table.

9.1.3. TheonCoupler Columns

There are no automatically maintained TheonCoupler columns in this table.

9.1.4. Keys

There are no primary keys in this table.

There are no unique keys in this table.

The following are the foreign keys in this table.

Key Name Constraint Name Constituent Columns Description

Institute Deputy Director

institute_deputy_director_person

dep_person_id

This relationship enforces the optional connection that an institute can be associated with one and only one person who is the deputy director of that institute. Conversely a person can optionally have any number (including zero) institute deputy directorships. A person cannot be deleted while they have a one or more institute deputy directorships.

Institute Director

institute_director_person

person_id

This relationship enforces the optional connection that an institute can be associated with one and only one person who is the director of that institute. Conversely a person can optionally have any number (including zero) institute directorships. A person cannot be deleted while they have a one or more institute directorships.

9.1.5. Links

There are no forward links from this table.

The following are the reverse links from this table.

Link Name Up to Table With Foreign Key Constraint Cardinality Ordinality Type Description

Institute Deputy Director

person

institute_deputy_director_person

1:N

1:0

Straight

This relationship enforces the optional connection that an institute can be associated with one and only one person who is the deputy director of that institute. Conversely a person can optionally have any number (including zero) institute deputy directorships. A person cannot be deleted while they have a one or more institute deputy directorships.

Institute Director

person

institute_director_person

1:N

1:0

Straight

This relationship enforces the optional connection that an institute can be associated with one and only one person who is the director of that institute. Conversely a person can optionally have any number (including zero) institute directorships. A person cannot be deleted while they have a one or more institute directorships.

9.1.6. Events

There are no events preceeding content change in this table.

There are no events instead of content change in this table.

There are no events following content change in this table.

9.1.7. TheonCoupler Couples

There are no TheonCoupler couples pushing content into this table.

There are no TheonCoupler couples pulling content from this table.

9.1.8. Roles

The following are the roles controlling access to this table.

Role Name Group Name Allowing Description

???

9.2. moderater

UUID

ent-59b98c9e-9942-491d-9ce5-8afb7d4fb936

Relation Type

TABLE

Relation Name

Moderater

Table Name

moderater

Table Signature

moderater

Explicit Cluster Membership

NONE

Explicit Dependencies

person paper

Export Element Instance

entity:moderater

Derive Fragment Instance

relation:moderater

Description

Holds who is assigned to moderate a paper as well as the result. This is the base table and ordinary users have no access to this, instead going through views. Administrative users have almost full access.

9.2.1. Properties

There are no deviant properties associated with this table.

9.2.2. Columns

The following are the columns in this table in positional order.

Attribute Name Column Name Type Properties Default Description

PaperID

paper_id

INTEGER

WITHOUT_EMPTY

NONE

The unique paper identifier for the paper the person has been assigned to rate, taken from the Paper table.

RaterPersonID

person_id

INTEGER

WITHOUT_EMPTY

NONE

The unique person identifier for the person assigned to rate the paper, taken from the Person table.

Rating

rank

TEXT

NONE

Rating assigned to the paper after review. This will be a value of 0, 1, 1-, 1+, 2, 2-, 2+, 3, 3-, 3+, 4, 4- or 4+. Do not use N*. Any value other than a number between 0 and 4 (where 1 to 4 can optionally be suffixed with plus or minus) entered in this field will be rejected with a check constraint error.

Comment

comment

TEXT

NONE

Free form comment from the rater - this might be to explain the reasoning behind a particular rating or to suggest changes to the paper proposal reason.

ModeraterID

id

SERIAL(moderater_id_seq)

WITHOUT_EMPTY

NONE

Unique identifier for the moderater/paper association within the Referee system. This identifier is automatically generated and read only.

9.2.3. TheonCoupler Columns

There are no automatically maintained TheonCoupler columns in this table.

9.2.4. Keys

There are no primary keys in this table.

The following are the unique keys in this table.

Key Name Constraint Name Constituent Columns Description

ModeraterPaperPerson

moderater_paper_id_person_id_key

paper_id person_id

Ensures that a paper cannot be moderated by the same person more than once and makes each row of the table unique.

The following are the foreign keys in this table.

Key Name Constraint Name Constituent Columns Description

Moderater Paper

moderater_paper

paper_id

This relationship enforces the mandatory connection that a moderater instance (person moderating a paper) must be associated with one and only one paper. Conversely a paper can optionally have any number (including zero) moderater instances. A paper cannot be deleted while there is one or more moderater instances.

Moderater Person

moderater_person

person_id

This relationship enforces the mandatory connection that a moderater instance (person moderating a paper) must be associated with one and only one person. Conversely a person can optionally have any number (including zero) moderater instances. A person cannot be deleted while there is one or more moderater instances.

9.2.5. Links

There are no forward links from this table.

The following are the reverse links from this table.

Link Name Up to Table With Foreign Key Constraint Cardinality Ordinality Type Description

Moderater Paper

paper

moderater_paper

1:N

1:0

Straight

This relationship enforces the mandatory connection that a moderater instance (person moderating a paper) must be associated with one and only one paper. Conversely a paper can optionally have any number (including zero) moderater instances. A paper cannot be deleted while there is one or more moderater instances.

Moderater Person

person

moderater_person

1:N

1:0

Straight

This relationship enforces the mandatory connection that a moderater instance (person moderating a paper) must be associated with one and only one person. Conversely a person can optionally have any number (including zero) moderater instances. A person cannot be deleted while there is one or more moderater instances.

9.2.6. Events

There are no events preceeding content change in this table.

There are no events instead of content change in this table.

There are no events following content change in this table.

9.2.7. TheonCoupler Couples

There are no TheonCoupler couples pushing content into this table.

There are no TheonCoupler couples pulling content from this table.

9.2.8. Roles

The following are the roles controlling access to this table.

Role Name Group Name Allowing Description

???

9.3. paper

UUID

ent-6d54a373-19ef-4b32-ba0e-0752580ee3b0

Relation Type

TABLE

Relation Name

Paper

Table Name

paper

Table Signature

paper

Explicit Cluster Membership

NONE

Explicit Dependencies

person paperupdate

Export Element Instance

entity:paper

Derive Fragment Instance

relation:paper

Description

The Paper table holds all the key details on papers that have been proposed for the REF submission. This data is expected to be fed in and maintained via the PURE stream. Most of the content is read only but one field with service relevant meta data can be edited by users with administrative access to the system.

9.3.1. Properties

There are no deviant properties associated with this table.

9.3.2. Columns

The following are the columns in this table in positional order.

Attribute Name Column Name Type Properties Default Description

PaperID

id

SERIAL(paper_id_seq)

WITHOUT_EMPTY

NONE

Unique identifier for the paper within the Referee system. This identifier is automatically generated and read only. It does not correspond to any other paper identifier.

PURENumber

pure_id

TEXT

WITHOUT_EMPTY

NONE

The unique PURE paper number used as a handle for the PURE2 stream.

Title

title

TEXT

NONE

The full title of the paper.

Abstract

abstract

TEXT

NONE

The full textual abstract of the paper. Any non-textual content will likely be lost or mangled in some way.

Paper URL

pure_url

TEXT

NONE

Direct link to the online copy of the paper. This is a URL which is a direct link to the local copy of the paper held in PURE, and is what is used as the paper download link from the corresponding entry on Edinburgh Research Explorer. This copy of the paper should always be accessible to local staff for review, unlike the DOI URL or published location which may not always be open access.

DOI URL

doi_url

TEXT

NONE

Link to the copy of the paper held in the ACM Digital Library for Edinburgh.

Reason

reason

TEXT

NONE

Reason given by the submitter for proposing the paper be added to the REF submission.

Rank

rank

TEXT

NONE

Rating given to the paper by the submitter on proposal. This value of this will be from 1st to 6th or Alternate.

Double Weighted?

double_weight

BOOLEAN

false

Flag indicating whether the proposed paper should be double weighted for the REF submission.

Chosen?

chosen

BOOLEAN

false

This value should be set (checked) by administrative users after the paper has been reviewed (by raters and moderaters) and it has been decided that it should be in included in the REF submission.

SubmitterPersonID

person_id

INTEGER

WITHOUT_EMPTY

NONE

The unique person identifier for the person assigned to rate the paper, taken from the Person table.

Publisher

publisher

TEXT

NONE

The short abbreviation name of the publisher.

Publication Date

pubdate

DATE

NONE

The publication date.

APA

apa

TEXT

NONE

The APA (American Psychological Association) formatted citation string for the paper. This contains more detail then seems to be available otherwise in individual fields in terms of publisher and year.

Filename

filename

TEXT

NONE

The filename of the PURE held copy of the paper. The URL appears to then become: https://www.pure.ed.ac.uk/admin/files/ID/FILE. Note however that this filename is useless without the holding directory ID number which is not the paper ID number or the REF2 submission ID number and does not seem to be available.

ERE URL

ere_url

TEXT

NONE

Direct link to the web page for the paper in Edinburgh Research Explorer. This page (and download link) for the paper should always be accessible to local staff for review, unlike the DOI URL or published location which may not always be open access.

9.3.3. TheonCoupler Columns

The following are the automatically maintained TheonCoupler columns in this table in pseudo positional order.

Attribute Name Column Name Type Properties Default Description

NONE (USING COLUMN NAME)

_th_abstract_changedat

TIMESTAMP

NONE

NONE

NONE (USING COLUMN NAME)

_th_abstract_changedby

TEXT

NONE

NONE

NONE (USING COLUMN NAME)

_th_apa_changedat

TIMESTAMP

NONE

NONE

NONE (USING COLUMN NAME)

_th_apa_changedby

TEXT

NONE

NONE

NONE (USING COLUMN NAME)

_th_createdat

TIMESTAMP

NONE

NONE

NONE (USING COLUMN NAME)

_th_deletedat

TIMESTAMP

NONE

NONE

NONE (USING COLUMN NAME)

_th_doi_url_changedat

TIMESTAMP

NONE

NONE

NONE (USING COLUMN NAME)

_th_doi_url_changedby

TEXT

NONE

NONE

NONE (USING COLUMN NAME)

_th_double_weight_changedat

TIMESTAMP

NONE

NONE

NONE (USING COLUMN NAME)

_th_double_weight_changedby

TEXT

NONE

NONE

NONE (USING COLUMN NAME)

_th_ere_url_changedat

TIMESTAMP

NONE

NONE

NONE (USING COLUMN NAME)

_th_ere_url_changedby

TEXT

NONE

NONE

NONE (USING COLUMN NAME)

_th_filename_changedat

TIMESTAMP

NONE

NONE

NONE (USING COLUMN NAME)

_th_filename_changedby

TEXT

NONE

NONE

NONE (USING COLUMN NAME)

_th_increment

INTEGER

NONE

NONE

NONE (USING COLUMN NAME)

_th_pubdate_changedat

TIMESTAMP

NONE

NONE

NONE (USING COLUMN NAME)

_th_pubdate_changedby

TEXT

NONE

NONE

NONE (USING COLUMN NAME)

_th_publisher_changedat

TIMESTAMP

NONE

NONE

NONE (USING COLUMN NAME)

_th_publisher_changedby

TEXT

NONE

NONE

NONE (USING COLUMN NAME)

_th_pure2_changeset

TEXT

NONE

NONE

NONE (USING COLUMN NAME)

_th_pure_url_changedat

TIMESTAMP

NONE

NONE

NONE (USING COLUMN NAME)

_th_pure_url_changedby

TEXT

NONE

NONE

NONE (USING COLUMN NAME)

_th_rank_changedat

TIMESTAMP

NONE

NONE

NONE (USING COLUMN NAME)

_th_rank_changedby

TEXT

NONE

NONE

NONE (USING COLUMN NAME)

_th_reason_changedat

TIMESTAMP

NONE

NONE

NONE (USING COLUMN NAME)

_th_reason_changedby

TEXT

NONE

NONE

NONE (USING COLUMN NAME)

_th_title_changedat

TIMESTAMP

NONE

NONE

NONE (USING COLUMN NAME)

_th_title_changedby

TEXT

NONE

NONE

9.3.4. Keys

The following are the primary keys in this table.

Key Name Constraint Name Constituent Columns Description

PaperKey

paper_pkey

id

Primary unique key for the Paper table.

The following are the unique keys in this table.

Key Name Constraint Name Constituent Columns Description

Paper PURE Number

paper_pure_id_key

pure_id

The Paper table is also unique on the PURE paper number. This acts as a validation check - any accidental duplication in the feed will therefore result in an error (otherwise data may be altered in an unhelpful way).

The following are the foreign keys in this table.

Key Name Constraint Name Constituent Columns Description

Paper Status

paper_status

id

Workaround a forward link always resulting in a connector even whwn 1:1 so browser grid won’t work. Provide a reverse equivalent.

Paper Person

paper_submitter_person

person_id

This relationship enforces the mandatory connection that a paper must be associated with one and only one person who was the proposed of that paper. Conversely a person can optionally have any number (including zero) proposed papers. A person cannot be deleted while they have one or more proposed papers.

9.3.5. Links

The following are the forward links from this table.

Link Name Down to Table With Foreign Key Constraint Cardinality Ordinality Type Description

Moderater Paper

moderater

moderater_paper

1:N

1:0

Straight

This relationship enforces the mandatory connection that a moderater instance (person moderating a paper) must be associated with one and only one paper. Conversely a paper can optionally have any number (including zero) moderater instances. A paper cannot be deleted while there is one or more moderater instances.

Rater Paper

rater

rater_paper

1:N

1:0

Straight

This relationship enforces the mandatory connection that a rater instance (person rating a paper) must be associated with one and only one paper. Conversely a paper can optionally have any number (including zero) rater instances. A paper cannot be deleted while there is one or more rater instances.

PaperUpdate/Paper

paperupdate

paperupdate_paper

1:1

1:1

Straight

Unrealised virtual relationship for TheonUI desktop so as to access some of the View data in addition to the basic Paper data.

The following are the reverse links from this table.

Link Name Up to Table With Foreign Key Constraint Cardinality Ordinality Type Description

Paper Status

paperupdate

paper_status

1:1

1:0

Straight

Workaround a forward link always resulting in a connector even whwn 1:1 so browser grid won’t work. Provide a reverse equivalent.

Paper Person

person

paper_submitter_person

1:N

1:0

Straight

This relationship enforces the mandatory connection that a paper must be associated with one and only one person who was the proposed of that paper. Conversely a person can optionally have any number (including zero) proposed papers. A person cannot be deleted while they have one or more proposed papers.

9.3.6. Events

There are no events preceeding content change in this table.

There are no events instead of content change in this table.

There are no events following content change in this table.

9.3.7. TheonCoupler Couples

The following are the TheonCoupler couples pushing content into this table.

Couple Name Owning Stream Source Entity Handle Columns Paired Columns Description

Paper

PURE2

Paper Feed (PURE) (Unique)

pure_id

rank

This stream manages the flow of Paper data into the system. The source content of the stream is taken from report run against REF2 in PURE. It provides details for all the proposed papers in the REF submission including rating and reason for submission.

There are no TheonCoupler couples pulling content from this table.

9.3.8. Roles

The following are the roles controlling access to this table.

Role Name Group Name Allowing Description

???

9.4. person

UUID

ent-56eb8804-7fb6-4fd7-8779-b8977c070756

Relation Type

TABLE

Relation Name

Person

Table Name

person

Table Signature

person

Explicit Cluster Membership

NONE

Explicit Dependencies

NONE

Export Element Instance

entity:person

Derive Fragment Instance

relation:person

Description

The Person table holds basic details on all staff members that might be contributing to the REF submission. This data is expected to be fed in and maintained via the PROM stream. Most of the content is read only but some fields with service relevant meta data can be edited by users with administrative access to the system.

9.4.1. Properties

There are no deviant properties associated with this table.

9.4.2. Columns

The following are the columns in this table in positional order.

Attribute Name Column Name Type Properties Default Description

PersonID

id

SERIAL(person_id_seq)

WITHOUT_EMPTY

NONE

Unique identifier for the person within the Referee system. This identifier is automatically generated and read only. It does not correspond to any other person identifier.

UUN

uun

VARCHAR(8)

NONE

The UUN (Unique Username) for the member of staff. The Referee system makes this field read only to all users as it is expected to be fed in by the PURE1AC stream.

Firstname

firstname

TEXT

WITHOUT_EMPTY

NONE

The first name (given name or known-as name) for the member of staff. The Referee system makes this field read only to all users as it is expected to be fed in by the PURE1AC stream.

Lastname

lastname

TEXT

WITHOUT_EMPTY

NONE

The last name (surname) for the member of staff. The Referee system makes this field read only to all users as it is expected to be fed in by the PURE1AC stream.

Eligible?

eligible

BOOLEAN

true

Use this field to mark up exactly which members of staff are REF eligible (will be proposing and/or rating and/or moderating papers). By default all staff will be set as eligible so normally this field should only be manually unset for all those staff that are not eligible (e.g. support staff) if these have been fed in.

Rater?

rater

BOOLEAN

NONE

This value should be set when the person is one of those who can be assigned as a Rater of papers. People with this flag set are included on the available names on the drop-down used to assign raters to papers. Note that this field only affects the UI behaviour, any person can be assigned as a rater through the GW (irrespective of the setting of this flag). By default no person has this flag set.

Moderater?

moderater

BOOLEAN

NONE

This value should be set when the person is one of those who can be assigned as a Moderater of papers. People with this flag set are included on the available names on the drop-down used to assign moderaters to papers. Note that this field only affects the UI behaviour, any person can be assigned as a moderater through the GW (irrespective of the setting of this flag). By default no person has this flag set.

Employee#

empnum

INTEGER

WITHOUT_EMPTY

NONE

Unique employee (personnel) number for REF eligible staff member.

Email Address

email

TEXT

NONE

Email address of REF eligible staff member.

Institute

institute

TEXT

NONE

List of institute abbreviations that the person is affiliated with (only those defined to be included through the Institute table).

9.4.3. TheonCoupler Columns

The following are the automatically maintained TheonCoupler columns in this table in pseudo positional order.

Attribute Name Column Name Type Properties Default Description

NONE (USING COLUMN NAME)

_th_createdat

TIMESTAMP

NONE

NONE

NONE (USING COLUMN NAME)

_th_deletedat

TIMESTAMP

NONE

NONE

NONE (USING COLUMN NAME)

_th_email_changedat

TIMESTAMP

NONE

NONE

NONE (USING COLUMN NAME)

_th_email_changedby

TEXT

NONE

NONE

NONE (USING COLUMN NAME)

_th_firstname_changedat

TIMESTAMP

NONE

NONE

NONE (USING COLUMN NAME)

_th_firstname_changedby

TEXT

NONE

NONE

NONE (USING COLUMN NAME)

_th_increment

INTEGER

NONE

NONE

NONE (USING COLUMN NAME)

_th_institute_changedat

TIMESTAMP

NONE

NONE

NONE (USING COLUMN NAME)

_th_institute_changedby

TEXT

NONE

NONE

NONE (USING COLUMN NAME)

_th_lastname_changedat

TIMESTAMP

NONE

NONE

NONE (USING COLUMN NAME)

_th_lastname_changedby

TEXT

NONE

NONE

NONE (USING COLUMN NAME)

_th_pure1ac_changeset

TEXT

NONE

NONE

NONE (USING COLUMN NAME)

_th_uun_changedat

TIMESTAMP

NONE

NONE

NONE (USING COLUMN NAME)

_th_uun_changedby

TEXT

NONE

NONE

9.4.4. Keys

The following are the primary keys in this table.

Key Name Constraint Name Constituent Columns Description

PersonKey

person_pkey

id

Primary unique key for the Person table.

The following are the unique keys in this table.

Key Name Constraint Name Constituent Columns Description

Person Employee Number Key

person_empnum_key

empnum

The Person table is also unique on Employee number. This acts as a validation check - any accidental duplication in the feed will therefore result in an error (otherwise data may be altered in an unhelpful way).

There are no foreign keys in this table.

9.4.5. Links

The following are the forward links from this table.

Link Name Down to Table With Foreign Key Constraint Cardinality Ordinality Type Description

Moderater Person

moderater

moderater_person

1:N

1:0

Straight

This relationship enforces the mandatory connection that a moderater instance (person moderating a paper) must be associated with one and only one person. Conversely a person can optionally have any number (including zero) moderater instances. A person cannot be deleted while there is one or more moderater instances.

Rater Person

rater

rater_person

1:N

1:0

Straight

This relationship enforces the mandatory connection that a rater instance (person rating a paper) must be associated with one and only one person. Conversely a person can optionally have any number (including zero) rater instances. A person cannot be deleted while there is one or more rater instances.

Paper Person

paper

paper_submitter_person

1:N

1:0

Straight

This relationship enforces the mandatory connection that a paper must be associated with one and only one person who was the proposed of that paper. Conversely a person can optionally have any number (including zero) proposed papers. A person cannot be deleted while they have one or more proposed papers.

DualRater/ModeraterPerson

dualrater

dualrater_moderaterperson

1:N

0:1

Straight

This relationship enforces the optional connection that a dualrater instance (person rating a set of papers) can be associated with one and only one person as a moderater. Conversely a person as a moderater can optionally have any number (including zero) dualrater instances. A person cannot be deleted while there is one or more dualrater instances.

DualRater/Rater1Person

dualrater

dualrater_rater1person

1:N

0:1

Straight

This relationship enforces the optional connection that a dualrater instance (person rating a set of papers) can be associated with one and only one person as a first rater. Conversely a person as a first rater can optionally have any number (including zero) dualrater instances. A person cannot be deleted while there is one or more dualrater instances.

DualRater/Rater2Person

dualrater

dualrater_rater2person

1:N

0:1

Straight

This relationship enforces the optional connection that a dualrater instance (person rating a set of papers) can be associated with one and only one person as a second rater. Conversely a person as a second rater can optionally have any number (including zero) dualrater instances. A person cannot be deleted while there is one or more dualrater instances.

Institute Deputy Director

institute

institute_deputy_director_person

1:N

1:0

Straight

This relationship enforces the optional connection that an institute can be associated with one and only one person who is the deputy director of that institute. Conversely a person can optionally have any number (including zero) institute deputy directorships. A person cannot be deleted while they have a one or more institute deputy directorships.

Institute Director

institute

institute_director_person

1:N

1:0

Straight

This relationship enforces the optional connection that an institute can be associated with one and only one person who is the director of that institute. Conversely a person can optionally have any number (including zero) institute directorships. A person cannot be deleted while they have a one or more institute directorships.

Person Stats

person_stats

stats_person

1:1

1:1

Straight

Unrealised virtual relationship so the UI can make a connector from the person table table to the corresponding stats data on a desktop panel.

There are no reverse links from this table.

9.4.6. Events

There are no events preceeding content change in this table.

There are no events instead of content change in this table.

There are no events following content change in this table.

9.4.7. TheonCoupler Couples

The following are the TheonCoupler couples pushing content into this table.

Couple Name Owning Stream Source Entity Handle Columns Paired Columns Description

Person

PURE1AC

Staff Feed (PURE) (Processed)

empnum

firstname

This stream manages the flow of Staff data into the system. The source content of the stream is taken from report run against REF1AC in PURE. It provides details for all the eligible staff in the REF submission.

There are no TheonCoupler couples pulling content from this table.

9.4.8. Roles

The following are the roles controlling access to this table.

Role Name Group Name Allowing Description

???

9.5. pure_paper_feed

UUID

ent-b2f5b2ff-c3b0-4f6e-9631-2fbd93115b67

Relation Type

TABLE

Relation Name

Paper Feed (PURE)

Table Name

pure_paper_feed

Table Signature

pure_paper_feed

Explicit Cluster Membership

NONE

Explicit Dependencies

NONE

Export Element Instance

entity:pure_paper_feed

Derive Fragment Instance

relation:pure_paper_feed

Description

Holds the raw feed data of REF submitted paper details taken daily from PURE. This table is (through the ppfunq view) loaded and subsequently processed using the PURE2 stream agent. The raw source of data is a report that is run from any user account on the administrative interface of PURE. The report is configured on an automatic schedule to email the results every weekday morning as an Excel file attachment into the postfix/procmail receiver on the service host. Note that automated email scheduling has to be enabled on an account by account basis in PURE by IS support. The current report definition in XML is held here in the content of this entity and should be manually saved as a file and then loaded into PURE by creating a report and importing the saved file when initially setting up this data source.

9.5.1. Properties

There are no deviant properties associated with this table.

9.5.2. Columns

The following are the columns in this table in positional order.

Attribute Name Column Name Type Properties Default Description

Paper UUID

uuid

TEXT

NONE

The UUID of the paper. This can be used to construct the handle URL for ERE which is: http://hdl.handle.net/ORGID/UUID where UUID is the value of this column and ORGID is 20.500.11820 which is the institutional identifier.

Submitter

submitter_name

TEXT

NONE

Name and email address of the user who proposed the paper for the REF submission. Normally the original paper author but may not be the principal author if the paper has many.

UUN

submitter_uun

TEXT

NONE

Unique Username of the user who proposed the paper for the REF submission. Normally the original paper author but may not be the principal author if the paper has many. The submitter UUN must exist in the Person table or the paper will be silently dropped from the feed update.

Rank

rank

TEXT

NONE

Rating given to the paper by the submitter on proposal. This value of this will be from 1st to 6th or Alternate.

Type

type

TEXT

NONE

The type of the paper as originally published, for example Journal Article or Chapter in Book. This field is not used anywhere within the Referee service but is part of the data fed from PURE.

PaperNumber

paper_num

TEXT

NONE

The unique paper number assigned in PURE. This number is used as the stream handle to tie papers held in the referee service to the upstream instance held in PURE.

Title

title

TEXT

NONE

The full title of the paper.

Abstract

abstract

TEXT

NONE

The full textual abstract of the paper which should be an exact content of what is in PURE, however any non-textual content may well be lost or mangled due to the feed process.

Reason

reason

TEXT

NONE

Reason given by the submitter for proposing the paper be added to the REF submission.

Paper URL

local_url

TEXT

NONE

Direct link to online version of paper, generally this is the original publication location but can also replicate the DOI location.

DOI

direct_url

TEXT

NONE

Code number for the paper URL as held in the ACM Digital Library for Edinburgh. This is automatically prefixed with dx.doi.org to get the direct link.

Double Weighted?

doubleweight

TEXT

NONE

Flag indicating whether the proposed paper should be double weighted for the REF submission.

Publisher

publisher

TEXT

NONE

The short abbreviation name of the publisher.

Publication Date

pub_date

TEXT

NONE

The publication date.

APA

apa

TEXT

NONE

The APA (American Psychological Association) formatted citation string for the paper. This contains more detail then seems to be available otherwise in individual fields in terms of publisher and year.

Filename

filename

TEXT

NONE

The filename of the PURE held copy of the paper. The URL appears to then become: https://www.pure.ed.ac.uk/admin/files/ID/FILE. Note however that this filename is useless without the holding directory ID number which is not the paper ID number or the REF2 submission ID number and does not seem to be available.

9.5.3. TheonCoupler Columns

There are no automatically maintained TheonCoupler columns in this table.

9.5.4. Keys

There are no primary keys in this table.

There are no unique keys in this table.

There are no foreign keys in this table.

9.5.5. Links

There are no forward links from this table.

There are no reverse links from this table.

9.5.6. Events

There are no events preceeding content change in this table.

There are no events instead of content change in this table.

There are no events following content change in this table.

9.5.7. TheonCoupler Couples

There are no TheonCoupler couples pushing content into this table.

There are no TheonCoupler couples pulling content from this table.

9.5.8. Roles

There are no roles controlling access to this table.

9.6. pure_paper_file_feed

UUID

ent-7ea75d27-236d-48f5-80cf-1ccdf0c5af7d

Relation Type

TABLE

Relation Name

Paper File Feed (PURE)

Table Name

pure_paper_file_feed

Table Signature

pure_paper_file_feed

Explicit Cluster Membership

NONE

Explicit Dependencies

NONE

Export Element Instance

entity:pure_paper_file_feed

Derive Fragment Instance

relation:pure_paper_file_feed

Description

Holds the raw feed data of REF submitted paper download file details taken daily from PURE. This table is (through the ppfunq view) loaded and subsequently processed using the PURE2 stream agent. The raw source of data is a report that is run from any user account on the administrative interface of PURE. The report is configured on an automatic schedule to email the results every weekday morning as an Excel file attachment into the postfix/procmail receiver on the service host. Note that automated email scheduling has to be enabled on an account by account basis in PURE by IS support. The current report definition in XML is held here in the content of this entity and should be manually saved as a file and then loaded into PURE by creating a report and importing the saved file when initially setting up this data source. This feed is separated from the main PURE paper feed as a paper can contain multiple download file links (e.g. for original submission, final published article, etc) but may also contain none (which breaks the main report when included directly from that by removing the entire paper from the output). This report is scheduled to run slightly before the main PURE paper report so that this ancillary data is uptodate when combined in the ppfunq view and subsequently processed by the PURE2 stream agent.

9.6.1. Properties

There are no deviant properties associated with this table.

9.6.2. Columns

The following are the columns in this table in positional order.

Attribute Name Column Name Type Properties Default Description

Paper UUID

uuid

TEXT

NONE

The UUID of the paper. This can be used to construct the handle URL for ERE which is: http://hdl.handle.net/ORGID/UUID where UUID is the value of this column and ORGID is 20.500.11820 which is the institutional identifier.

Paper FileID

file_id

TEXT

NONE

The file identifier of the PURE held copy of the paper. The URL appears to then become: https://www.pure.ed.ac.uk/admin/files/ID/FILE, where ID is the value of this column and FILE is the value in the PURE FileName column.

Paper FileName

file_name

TEXT

NONE

The filename of the PURE held copy of the paper. The URL appears to then become: https://www.pure.ed.ac.uk/admin/files/ID/FILE, where FILE is the value of this column and ID is the value in the PURE FileID column.

PaperID

paper_id

TEXT

NONE

The unique paper number assigned in PURE under the REF2. This number is used as the stream handle to tie papers held in the referee service to the upstream instance held in PURE.

PersonID

person_id

TEXT

NONE

PURE identifier for the person who proposed the paper for the REF submission (this is the person identifier as placed within the REF1AC). Normally the original paper author but may not be the principal author if the paper has many.

9.6.3. TheonCoupler Columns

There are no automatically maintained TheonCoupler columns in this table.

9.6.4. Keys

There are no primary keys in this table.

There are no unique keys in this table.

There are no foreign keys in this table.

9.6.5. Links

There are no forward links from this table.

There are no reverse links from this table.

9.6.6. Events

There are no events preceeding content change in this table.

There are no events instead of content change in this table.

There are no events following content change in this table.

9.6.7. TheonCoupler Couples

There are no TheonCoupler couples pushing content into this table.

There are no TheonCoupler couples pulling content from this table.

9.6.8. Roles

There are no roles controlling access to this table.

9.7. pure_staff_feed

UUID

ent-4b8371f6-40dc-40cc-990a-1cfd1eea0570

Relation Type

TABLE

Relation Name

Staff Feed (PURE)

Table Name

pure_staff_feed

Table Signature

pure_staff_feed

Explicit Cluster Membership

NONE

Explicit Dependencies

NONE

Export Element Instance

entity:pure_staff_feed

Derive Fragment Instance

relation:pure_staff_feed

Description

Holds the raw feed data of REF staff details taken daily from PURE. This table is (through the psfsplit view) loaded and subsequently processed using the PURE1AC stream agent. The raw source of data is a report that is run from any user account on the administrative interface of PURE. The report is configured on an automatic schedule to email the results every weekday morning as an Excel file attachment into the postfix/procmail receiver on the service host. Note that automated email scheduling has to be enabled on an account by account basis in PURE by IS support. The current report definition in XML is held here in the content of this entity and should be manually saved as a file and then loaded into PURE by creating a report and importing the saved file when initially setting up this data source.

9.7.1. Properties

There are no deviant properties associated with this table.

9.7.2. Columns

The following are the columns in this table in positional order.

Attribute Name Column Name Type Properties Default Description

Employee#

employee_num

INTEGER

NONE

Unique employee (personnel) number for REF eligible staff member.

Firstname

firstname

TEXT

NONE

The first name (given name or known-as name) for the member of staff. The Referee system makes this field read only to all users as it is expected to be fed in by the PURE1AC stream.

Lastname

lastname

TEXT

NONE

The last name (surname) for the member of staff. The Referee system makes this field read only to all users as it is expected to be fed in by the PURE1AC stream.

UUN and Email

uunemail

TEXT

NONE

What seems to be the only way to get UUN from PURE is to use this embedded field which has the format "UUN - Lastname, Firstname - EMAIL.

Organisations

organisations

TEXT

NONE

Aggregated (comma separated) list of affiliated organisations this REF eligible staff member has. This field is in many ways useless since some of our organisation names include the list separator (comma) so making automated extraction impossible.

PersonID

id

TEXT

NONE

PURE identifier for this person within the REF1AC dataset.

9.7.3. TheonCoupler Columns

There are no automatically maintained TheonCoupler columns in this table.

9.7.4. Keys

There are no primary keys in this table.

There are no unique keys in this table.

There are no foreign keys in this table.

9.7.5. Links

There are no forward links from this table.

There are no reverse links from this table.

9.7.6. Events

There are no events preceeding content change in this table.

There are no events instead of content change in this table.

There are no events following content change in this table.

9.7.7. TheonCoupler Couples

There are no TheonCoupler couples pushing content into this table.

There are no TheonCoupler couples pulling content from this table.

9.7.8. Roles

There are no roles controlling access to this table.

9.8. rater

UUID

ent-d4d569c9-40d0-4a4d-8fcf-57b5b2f2c1e4

Relation Type

TABLE

Relation Name

Rater

Table Name

rater

Table Signature

rater

Explicit Cluster Membership

NONE

Explicit Dependencies

person paper

Export Element Instance

entity:rater

Derive Fragment Instance

relation:rater

Description

Holds who is assigned to rate a paper as well as the result. This is the base table and ordinary users have no access to this, instead going through views. Administrative users have almost full access.

9.8.1. Properties

There are no deviant properties associated with this table.

9.8.2. Columns

The following are the columns in this table in positional order.

Attribute Name Column Name Type Properties Default Description

PaperID

paper_id

INTEGER

WITHOUT_EMPTY

NONE

The unique paper identifier for the paper the person has been assigned to rate, taken from the Paper table.

RaterPersonID

person_id

INTEGER

WITHOUT_EMPTY

NONE

The unique person identifier for the person assigned to rate the paper, taken from the Person table.

Rating

rank

TEXT

NONE

Rating assigned to the paper after review. This will be a value of 0, 1, 1-, 1+, 2, 2-, 2+, 3, 3-, 3+, 4, 4- or 4+. Do not use N*. Any value other than a number between 0 and 4 (where 1 to 4 can optionally be suffixed with plus or minus) entered in this field will be rejected with a check constraint error.

Comment

comment

TEXT

NONE

Free form comment from the rater - this might be to explain the reasoning behind a particular rating or to suggest changes to the paper proposal reason.

RaterID

id

SERIAL(rater_id_seq)

WITHOUT_EMPTY

NONE

Unique identifier for the rater/paper association within the Referee system. This identifier is automatically generated and read only.

9.8.3. TheonCoupler Columns

There are no automatically maintained TheonCoupler columns in this table.

9.8.4. Keys

There are no primary keys in this table.

The following are the unique keys in this table.

Key Name Constraint Name Constituent Columns Description

RaterPaperPerson

rater_paper_id_person_id_key

paper_id person_id

Ensures that a paper cannot be rated by the same person more than once and makes each row of the table unique.

The following are the foreign keys in this table.

Key Name Constraint Name Constituent Columns Description

Rater Paper

rater_paper

paper_id

This relationship enforces the mandatory connection that a rater instance (person rating a paper) must be associated with one and only one paper. Conversely a paper can optionally have any number (including zero) rater instances. A paper cannot be deleted while there is one or more rater instances.

Rater Person

rater_person

person_id

This relationship enforces the mandatory connection that a rater instance (person rating a paper) must be associated with one and only one person. Conversely a person can optionally have any number (including zero) rater instances. A person cannot be deleted while there is one or more rater instances.

9.8.5. Links

There are no forward links from this table.

The following are the reverse links from this table.

Link Name Up to Table With Foreign Key Constraint Cardinality Ordinality Type Description

Rater Paper

paper

rater_paper

1:N

1:0

Straight

This relationship enforces the mandatory connection that a rater instance (person rating a paper) must be associated with one and only one paper. Conversely a paper can optionally have any number (including zero) rater instances. A paper cannot be deleted while there is one or more rater instances.

Rater Person

person

rater_person

1:N

1:0

Straight

This relationship enforces the mandatory connection that a rater instance (person rating a paper) must be associated with one and only one person. Conversely a person can optionally have any number (including zero) rater instances. A person cannot be deleted while there is one or more rater instances.

9.8.6. Events

There are no events preceeding content change in this table.

There are no events instead of content change in this table.

There are no events following content change in this table.

9.8.7. TheonCoupler Couples

There are no TheonCoupler couples pushing content into this table.

There are no TheonCoupler couples pulling content from this table.

9.8.8. Roles

The following are the roles controlling access to this table.

Role Name Group Name Allowing Description

???

Chapter 10. Type

Chapter 11. View

11.1. dualrater

UUID

ent-8780579a-388b-423a-a534-f1b18247a5e4

Relation Type

VIEW

Relation Name

DualRater

View Name

dualrater

View Signature

dualrater

Explicit Cluster Membership

NONE

Explicit Dependencies

person moderater paper dualrater_update rater

Export Element Instance

entity:dualrater

Derive Fragment Instance

relation:dualrater

Description

Used to assign one or two raters to all papers of a single submitter. Changes made here are mapped back to the base table.

11.1.1. Properties

There are no deviant properties associated with this view.

11.1.2. Columns

The following are the columns in this view in positional order.

Attribute Name Column Name Type Properties Default Description

ObjectID

oid

INTEGER

NONE

Any entity used on a Desktop Panel in TheonUI must have an OID value which is used as a unique row identifier. Since a View does not have an OID column by default (like a Table) one must be artificially constructed. Any integer value can be used as long as uniqueness across all rows in the view is guaranteed.

SubmitterID

submitter_id

INTEGER

NONE

Unique identifier of this submitter (person who has proposed at least one paper).

Lastname

lastname

TEXT

NONE

The last name (surname) for the member of staff. The Referee system makes this field read only to all users as it is expected to be fed in by the PURE1AC stream.

Firstname

firstname

TEXT

NONE

The first name (given name or known-as name) for the member of staff. The Referee system makes this field read only to all users as it is expected to be fed in by the PURE1AC stream.

Institute(s)

institute

TEXT

NONE

List of institute abbreviations that the person is affiliated with (only those defined to be included through the Institute table).

Submitted Papers

submitted

CUSTOM(bigint)

NONE

The total number of proposed papers this submitter has made.

Rater1ID

rater1_id

INTEGER

NONE

Unique identifier of the first rater.

Rater2ID

rater2_id

INTEGER

NONE

Unique identifier of the second rater.

ModeraterID

moderater_id

INTEGER

NONE

Unique identifier of the moderater.

Unassigned Papers

unassigned

CUSTOM(bigint)

NONE

The total number of papers proposed by this person for the REF that have not yet been assigned to someone to rate, irrespective of whether the rating has been done or not. This value is useful to track changes from upstream where new papers have been submitted and a rater needs to be assigned, for example by searching for non zero entries.

Unmoderated Papers

unmoderated

CUSTOM(bigint)

NONE

The total number of papers proposed by this person for the REF that have not yet been assigned to someone to moderate, irrespective of whether the rating has been done or not. This value is useful to track changes from upstream where new papers have been submitted and a moderater needs to be assigned, for example by searching for non zero entries.

11.1.3. TheonCoupler Columns

There are no automatically maintained TheonCoupler columns in this view.

11.1.4. TheonCoupler Couples

There are no TheonCoupler couples pushing content into this view.

There are no TheonCoupler couples pulling content from this view.

11.1.5. Roles

The following are the roles controlling access to this view.

Role Name Group Name Allowing Description

???

11.2. moderater_access

UUID

ent-4ae4af24-0b3f-4167-8a32-80454cf56724

Relation Type

VIEW

Relation Name

ModeraterPapers (Access)

View Name

moderater_access

View Signature

moderater_access

Explicit Cluster Membership

NONE

Explicit Dependencies

person moderater paper moderater_update rater

Export Element Instance

entity:moderater_access

Derive Fragment Instance

relation:moderater_access

Description

Principal view of papers for moderaters. Contains read only paper details with submitter name, raters results summary and editable rating and comment for moderater. The view is constrained to show just those papers the current session user has been allocated to moderate.

11.2.1. Properties

There are no deviant properties associated with this view.

11.2.2. Columns

The following are the columns in this view in positional order.

Attribute Name Column Name Type Properties Default Description

ModeraterID

id

INTEGER

NONE

Unique identifier for the moderater/paper association within the Referee system. This identifier is automatically generated and read only.

PaperID

paper_id

INTEGER

NONE

The unique paper identifier for the paper the person has been assigned to rate, taken from the Paper table.

Title

title

TEXT

NONE

The full title of the paper.

Abstract

abstract

TEXT

NONE

The full textual abstract of the paper. Any non-textual content will likely be lost or mangled in some way.

Paper URL

pure_url

TEXT

NONE

Direct link to online copy of the paper. Normally this would be a link to where the paper is online as originally published, but it may also just replicate the ACM DL link.

Reason

reason

TEXT

NONE

Reason given by the submitter for proposing the paper be added to the REF submission.

Rank

rank

TEXT

NONE

Rating given to the paper by the submitter on proposal. This value of this will be from 1st to 6th or Alternate.

Double Weighted?

double_weight

BOOLEAN

NONE

Flag indicating whether the proposed paper should be double weighted for the REF submission.

Rating

rating

TEXT

NONE

Rating assigned to the paper after review. This will be a value of 0, 1, 2, 3 or 4. Do not use N*. Any value other than a number between 0 and 4 entered in this field will be rejected with a check constraint error.

Comment

comment

TEXT

NONE

Free form comment from the rater - this might be to explain the reasoning behind a particular rating or to suggest changes to the paper proposal reason.

Raters Rating

raters_rating

TEXT

NONE

Calculated value which shows a list (slash separated) all the ratings assigned to a paper and the corresponding rater surnames, subsequently used in the moderation process. For example "1(Bloggs)/3(Doe)" shows that "Bloggs" rated the paper "1" and "Doe" rated the paper "3". Only raters that have entered a rating will be listed so the value will be blank if none have done so.

Raters Done

raters_done

TEXT

NONE

Calculated value which shows the number of raters that have been assigned to review and rate the paper (normally 2) and of those the number that have actually entered a rating value for the paper. This is presented as "X/Y" where X is the number of raters that have rated the paper and Y is the number of raters the paper has. For example: "0/0" is no raters assigned; "0/2" is 2 raters assigned but none have given a rating yet; "1/2" means one rater has given a rating; "2/2" is both (all) raters have given a rating. Normally a moderation would not take place until this state has been reached (when X = Y != 0).

Firstname

firstname

TEXT

NONE

The first name (given name or known-as name) for the member of staff. The Referee system makes this field read only to all users as it is expected to be fed in by the PURE1AC stream.

Lastname

lastname

TEXT

NONE

The last name (surname) for the member of staff. The Referee system makes this field read only to all users as it is expected to be fed in by the PURE1AC stream.

ObjectID

oid

INTEGER

NONE

Any entity used on a Desktop Panel in TheonUI must have an OID value which is used as a unique row identifier. Since a View does not have an OID column by default (like a Table) one must be artificially constructed. Any integer value can be used as long as uniqueness across all rows in the view is guaranteed.

APA

apa

TEXT

NONE

The APA (American Psychological Association) formatted citation string for the paper. This contains more detail then seems to be available otherwise in individual fields in terms of publisher and year.

ERE URL

ere_url

TEXT

NONE

Direct link to the web page for the paper in Edinburgh Research Explorer. This page (and download link) for the paper should always be accessible to local staff for review, unlike the DOI URL or published location which may not always be open access.

DOI URL

doi_url

TEXT

NONE

Link to the copy of the paper held in the ACM Digital Library for Edinburgh.

11.2.3. TheonCoupler Columns

There are no automatically maintained TheonCoupler columns in this view.

11.2.4. TheonCoupler Couples

There are no TheonCoupler couples pushing content into this view.

There are no TheonCoupler couples pulling content from this view.

11.2.5. Roles

The following are the roles controlling access to this view.

Role Name Group Name Allowing Description

???

11.3. moderater_institute_access

UUID

ent-d5d62eda-1f07-4cbe-bff5-c0f79a31f1a3

Relation Type

VIEW

Relation Name

Moderater (Institute Access)

View Name

moderater_institute_access

View Signature

moderater_institute_access

Explicit Cluster Membership

NONE

Explicit Dependencies

paper_institute_access institute person moderater person_institute_access paper

Export Element Instance

entity:moderater_institute_access

Derive Fragment Instance

relation:moderater_institute_access

Description

Holds who is assigned to moderate a paper as well as the result. This is a view which ordinary users have read only access to but constrained to papers submitted by people who are members of the institute that the user is a director or deputy director of.

11.3.1. Properties

There are no deviant properties associated with this view.

11.3.2. Columns

The following are the columns in this view in positional order.

Attribute Name Column Name Type Properties Default Description

PaperID

paper_id

INTEGER

NONE

The unique paper identifier for the paper the person has been assigned to rate, taken from the Paper table.

RaterPersonID

person_id

INTEGER

NONE

The unique person identifier for the person assigned to rate the paper, taken from the Person table.

Rating

rank

TEXT

NONE

Rating assigned to the paper after review. This will be a value of 0, 1, 1-, 1+, 2, 2-, 2+, 3, 3-, 3+, 4, 4- or 4+. Do not use N*. Any value other than a number between 0 and 4 (where 1 to 4 can optionally be suffixed with plus or minus) entered in this field will be rejected with a check constraint error.

Comment

comment

TEXT

NONE

Free form comment from the rater - this might be to explain the reasoning behind a particular rating or to suggest changes to the paper proposal reason.

ModeraterID

id

INTEGER

NONE

Unique identifier for the moderater/paper association within the Referee system. This identifier is automatically generated and read only.

11.3.3. TheonCoupler Columns

There are no automatically maintained TheonCoupler columns in this view.

11.3.4. TheonCoupler Couples

There are no TheonCoupler couples pushing content into this view.

There are no TheonCoupler couples pulling content from this view.

11.3.5. Roles

The following are the roles controlling access to this view.

Role Name Group Name Allowing Description

???

11.4. moderaterupdate

UUID

ent-d0b33109-a3c4-4fb7-b4ad-64e4af31ed75

Relation Type

VIEW

Relation Name

ModeraterPapers (Update)

View Name

moderaterupdate

View Signature

moderaterupdate

Explicit Cluster Membership

NONE

Explicit Dependencies

person moderater

Export Element Instance

entity:moderaterupdate

Derive Fragment Instance

relation:moderaterupdate

Description

Updateable view of the Moderater table. The view is constrained to include just those papers the current session user has been allocated to moderate and is used to allow updates to the paper rating and comment by corresponding moderaters. This view is not directly exposed, instead it is used by the handler function for updates on the Papers for Modeaters view.

11.4.1. Properties

There are no deviant properties associated with this view.

11.4.2. Columns

The following are the columns in this view in positional order.

Attribute Name Column Name Type Properties Default Description

PaperID

paper_id

INTEGER

NONE

The unique paper identifier for the paper the person has been assigned to rate, taken from the Paper table.

RaterPersonID

person_id

INTEGER

NONE

The unique person identifier for the person assigned to rate the paper, taken from the Person table.

Rank

rank

TEXT

NONE

Rating given to the paper by the submitter on proposal. This value of this will be from 1st to 6th or Alternate.

Comment

comment

TEXT

NONE

Free form comment from the rater - this might be to explain the reasoning behind a particular rating or to suggest changes to the paper proposal reason.

ModeraterID

id

INTEGER

NONE

Unique identifier for the moderater/paper association within the Referee system. This identifier is automatically generated and read only.

11.4.3. TheonCoupler Columns

There are no automatically maintained TheonCoupler columns in this view.

11.4.4. TheonCoupler Couples

There are no TheonCoupler couples pushing content into this view.

There are no TheonCoupler couples pulling content from this view.

11.4.5. Roles

The following are the roles controlling access to this view.

Role Name Group Name Allowing Description

???

11.5. paper_access

UUID

ent-f2b60942-8506-4a24-b57b-75e7bbfe0c27

Relation Type

VIEW

Relation Name

SubmitterPapers (Access)

View Name

paper_access

View Signature

paper_access

Explicit Cluster Membership

NONE

Explicit Dependencies

person paper

Export Element Instance

entity:paper_access

Derive Fragment Instance

relation:paper_access

Description

Principal view of papers for submitters. Contains read only paper details. The view is constrained to show just those papers the current session user has proposed for the REF submission.

11.5.1. Properties

There are no deviant properties associated with this view.

11.5.2. Columns

The following are the columns in this view in positional order.

Attribute Name Column Name Type Properties Default Description

PaperID

id

INTEGER

NONE

Unique identifier for the paper within the Referee system. This identifier is automatically generated and read only. It does not correspond to any other paper identifier.

Title

title

TEXT

NONE

The full title of the paper.

Abstract

abstract

TEXT

NONE

The full textual abstract of the paper. Any non-textual content will likely be lost or mangled in some way.

Paper URL

pure_url

TEXT

NONE

Direct link to the online copy of the paper. This is a URL which is a direct link to the local copy of the paper held in PURE, and is what is used as the paper download link from the corresponding entry on Edinburgh Research Explorer. This copy of the paper should always be accessible to local staff for review, unlike the DOI URL or published location which may not always be open access.

Reason

reason

TEXT

NONE

Reason given by the submitter for proposing the paper be added to the REF submission.

Rank

rank

TEXT

NONE

Rating given to the paper by the submitter on proposal. This value of this will be from 1st to 6th or Alternate.

Double Weighted?

double_weight

BOOLEAN

NONE

Flag indicating whether the proposed paper should be double weighted for the REF submission.

ObjectID

oid

INTEGER

NONE

Any entity used on a Desktop Panel in TheonUI must have an OID value which is used as a unique row identifier. Since a View does not have an OID column by default (like a Table) one must be artificially constructed. Any integer value can be used as long as uniqueness across all rows in the view is guaranteed.

APA

apa

TEXT

NONE

The APA (American Psychological Association) formatted citation string for the paper. This contains more detail then seems to be available otherwise in individual fields in terms of publisher and year.

ERE URL

ere_url

TEXT

NONE

Direct link to the web page for the paper in Edinburgh Research Explorer. This page (and download link) for the paper should always be accessible to local staff for review, unlike the DOI URL or published location which may not always be open access.

DOI URL

doi_url

TEXT

NONE

Link to the copy of the paper held in the ACM Digital Library for Edinburgh.

11.5.3. TheonCoupler Columns

There are no automatically maintained TheonCoupler columns in this view.

11.5.4. TheonCoupler Couples

There are no TheonCoupler couples pushing content into this view.

There are no TheonCoupler couples pulling content from this view.

11.5.5. Roles

The following are the roles controlling access to this view.

Role Name Group Name Allowing Description

???

11.6. paper_institute_access

UUID

ent-123a8383-7180-4844-92c7-cd7035933e31

Relation Type

VIEW

Relation Name

Paper (Institute Access)

View Name

paper_institute_access

View Signature

paper_institute_access

Explicit Cluster Membership

NONE

Explicit Dependencies

institute person person_institute_access paper status_institute_access

Export Element Instance

entity:paper_institute_access

Derive Fragment Instance

relation:paper_institute_access

Description

The Paper table holds all the key details on papers that have been proposed for the REF submission. This is a view which ordinary users have read only access to but constrained to papers that have been submitted by people who are members of the institute that the user is a director or deputy director of.

11.6.1. Properties

There are no deviant properties associated with this view.

11.6.2. Columns

The following are the columns in this view in positional order.

Attribute Name Column Name Type Properties Default Description

PaperID

id

INTEGER

NONE

Unique identifier for the paper within the Referee system. This identifier is automatically generated and read only. It does not correspond to any other paper identifier.

PureID

pure_id

TEXT

NONE

The unique PURE paper number used as a handle for the PURE2 stream.

SubmitterPersonID

person_id

INTEGER

NONE

The unique person identifier for the person assigned to rate the paper, taken from the Person table.

Title

title

TEXT

NONE

The full title of the paper.

Abstract

abstract

TEXT

NONE

The full textual abstract of the paper. Any non-textual content will likely be lost or mangled in some way.

Paper URL

pure_url

TEXT

NONE

Direct link to the online copy of the paper. This is a URL which is a direct link to the local copy of the paper held in PURE, and is what is used as the paper download link from the corresponding entry on Edinburgh Research Explorer. This copy of the paper should always be accessible to local staff for review, unlike the DOI URL or published location which may not always be open access.

Reason

reason

TEXT

NONE

Reason given by the submitter for proposing the paper be added to the REF submission.

Rank

rank

TEXT

NONE

Rating given to the paper by the submitter on proposal. This value of this will be from 1st to 6th or Alternate.

Double Weighted?

double_weight

BOOLEAN

NONE

Flag indicating whether the proposed paper should be double weighted for the REF submission.

ObjectID

oid

INTEGER

NONE

Any entity used on a Desktop Panel in TheonUI must have an OID value which is used as a unique row identifier. Since a View does not have an OID column by default (like a Table) one must be artificially constructed. Any integer value can be used as long as uniqueness across all rows in the view is guaranteed.

APA

apa

TEXT

NONE

The APA (American Psychological Association) formatted citation string for the paper. This contains more detail then seems to be available otherwise in individual fields in terms of publisher and year.

ERE URL

ere_url

TEXT

NONE

Direct link to the web page for the paper in Edinburgh Research Explorer. This page (and download link) for the paper should always be accessible to local staff for review, unlike the DOI URL or published location which may not always be open access.

DOI URL

doi_url

TEXT

NONE

Link to the copy of the paper held in the ACM Digital Library for Edinburgh.

Chosen?

chosen

BOOLEAN

NONE

This value should be set (checked) by administrative users after the paper has been reviewed (by raters and moderaters) and it has been decided that it should be in included in the REF submission.

11.6.3. TheonCoupler Columns

There are no automatically maintained TheonCoupler columns in this view.

11.6.4. TheonCoupler Couples

There are no TheonCoupler couples pushing content into this view.

There are no TheonCoupler couples pulling content from this view.

11.6.5. Roles

The following are the roles controlling access to this view.

Role Name Group Name Allowing Description

???

11.7. paperupdate

UUID

ent-a7eded9e-0cd5-4292-a248-9ecef4237575

Relation Type

VIEW

Relation Name

AdminPaper (Access)

View Name

paperupdate

View Signature

paperupdate

Explicit Cluster Membership

NONE

Explicit Dependencies

person moderater paper rater paper_update

Export Element Instance

entity:paperupdate

Derive Fragment Instance

relation:paperupdate

Description

Principal view of papers for administrative users. Contains read only paper details with submitter name, raters results summary, moderaters result summary and editable chosen flag. The view includes all papers that have been proposed for the REF submission.

11.7.1. Properties

There are no deviant properties associated with this view.

11.7.2. Columns

The following are the columns in this view in positional order.

Attribute Name Column Name Type Properties Default Description

PaperID

id

INTEGER

NONE

Unique identifier for the paper within the Referee system. This identifier is automatically generated and read only. It does not correspond to any other paper identifier.

Title

title

TEXT

NONE

The full title of the paper.

Abstract

abstract

TEXT

NONE

The full textual abstract of the paper. Any non-textual content will likely be lost or mangled in some way.

Paper URL

pure_url

TEXT

NONE

Direct link to the online copy of the paper. This is a URL which is a direct link to the local copy of the paper held in PURE, and is what is used as the paper download link from the corresponding entry on Edinburgh Research Explorer. This copy of the paper should always be accessible to local staff for review, unlike the DOI URL or published location which may not always be open access.

Reason

reason

TEXT

NONE

Reason given by the submitter for proposing the paper be added to the REF submission.

Rank

rank

TEXT

NONE

Rating given to the paper by the submitter on proposal. This value of this will be from 1st to 6th or Alternate.

Double Weighted?

double_weight

BOOLEAN

NONE

Flag indicating whether the proposed paper should be double weighted for the REF submission.

SubmitterPersonID

person_id

INTEGER

NONE

The unique person identifier for the person assigned to rate the paper, taken from the Person table.

Firstname

firstname

TEXT

NONE

The first name (given name or known-as name) for the member of staff. The Referee system makes this field read only to all users as it is expected to be fed in by the PURE1AC stream.

Lastname

lastname

TEXT

NONE

The last name (surname) for the member of staff. The Referee system makes this field read only to all users as it is expected to be fed in by the PURE1AC stream.

Raters Done

raters_done

TEXT

NONE

Calculated value which shows the number of raters that have been assigned to review and rate the paper (normally 2) and of those the number that have actually entered a rating value for the paper. This is presented as "X/Y" where X is the number of raters that have rated the paper and Y is the number of raters the paper has. For example: "0/0" is no raters assigned; "0/2" is 2 raters assigned but none have given a rating yet; "1/2" means one rater has given a rating; "2/2" is both (all) raters have given a rating. Normally a moderation would not take place until this state has been reached (when X = Y != 0).

Rater1 Rating

rater1_rating

TEXT

NONE

Calculated value which shows the first raters rating assigned to a paper and the corresponding rater surname, subsequently used in the moderation process. For example "1 (Bloggs)" shows that "Bloggs" rated the paper "1". Only if the first rater has entered a rating will they be listed so the value will be blank if they have not done so.

Rater2 Rating

rater2_rating

TEXT

NONE

Calculated value which shows the second raters rating assigned to a paper and the corresponding rater surname, subsequently used in the moderation process. For example "1 (Bloggs)" shows that "Bloggs" rated the paper "1". Only if the second rater has entered a rating will they be listed so the value will be blank if they have not done so.

Rater1 Comment

rater1_comment

TEXT

NONE

NONE

Rater2 Comment

rater2_comment

TEXT

NONE

NONE

Raters Result

raters

SET( _raters_enum) The following are the only non-empty values allowed. Agree Disagree

NONE

If the first and second rater assigned ratings differ this will be "Disagree", otherwise if they are they same this will be "Agree". If one of the raters has not entered a rating yet this will be blank.

Moderaters Done

moderaters_done

TEXT

NONE

Calculated value which shows the number of moderaters that have been assigned to review and rate the paper (normally 1) and of those the number that have actually entered a rating value for the paper. This is presented as "X/Y" where X is the number of moderaters that have rated the paper and Y is the number of moderaters the paper has. For example: "0/0" is no moderaters assigned; "0/2" is 2 moderaters assigned but none have given a rating yet; "1/2" means one moderater has given a rating; "2/2" is both (all) moderaters have given a rating. Normally a paper should not be chosen for submission until this last state has been reached (when X = Y != 0).

Moderaters Rating

moderaters_rating

TEXT

NONE

Calculated value which shows a list (slash separated) all the ratings assigned to a paper and the corresponding moderater surnames. For example "1(Bloggs)/3(Doe)" shows that "Bloggs" rated the paper "1" and "Doe" rated the paper "3". Only moderaters that have entered a rating will be listed so the value will be blank if none have done so.

Moderaters Comment

moderaters_comment

TEXT

NONE

NONE

Review Result

result

SET( _result_enum) The following are the only non-empty values allowed. Best Not Best

NONE

Following completion of review this value will indicate the best rated paper (based on moderated rating) for each submitter. Where a submitter has multiple papers rater the same then the one that the submitter ranked highest will be indicated as the best. Where the submitter has used the same ranking more than once then the one indicated as the best will be effectively random.

Chosen?

chosen

BOOLEAN

NONE

This value should be set (checked) by administrative users after the paper has been reviewed (by raters and moderaters) and it has been decided that it should be in included in the REF submission.

Moderater Result

moderated_rank

SET( _moderated_rank_enum) The following are the only non-empty values allowed. Average Differs

NONE

This will be "Differs" when the average value (as a floating point number) of the ratings given by the raters is distinct from the average value (as a floating point number) given by the moderater, and will be "Average" otherwise. It will be empty if one or both raters have not entered a rank or if the moderater has not entered a rank. This field can be used to show where the moderation process has resulted in a rating divergent from the original rating for subsequent cross checking prior to choosing the paper for submission. The rater ranks are mapped to a number in order to calculate the average. This is based on thirds, so 1 is 1, 1- is (1 - 1/3) and 1+ is (1 + 1/3), 0 is mapped to 1/3.

ObjectID

oid

INTEGER

NONE

Any entity used on a Desktop Panel in TheonUI must have an OID value which is used as a unique row identifier. Since a View does not have an OID column by default (like a Table) one must be artificially constructed. Any integer value can be used as long as uniqueness across all rows in the view is guaranteed.

APA

apa

TEXT

NONE

The APA (American Psychological Association) formatted citation string for the paper. This contains more detail then seems to be available otherwise in individual fields in terms of publisher and year.

ERE URL

ere_url

TEXT

NONE

Direct link to the web page for the paper in Edinburgh Research Explorer. This page (and download link) for the paper should always be accessible to local staff for review, unlike the DOI URL or published location which may not always be open access.

DOI URL

doi_url

TEXT

NONE

Link to the copy of the paper held in the ACM Digital Library for Edinburgh.

11.7.3. TheonCoupler Columns

There are no automatically maintained TheonCoupler columns in this view.

11.7.4. TheonCoupler Couples

There are no TheonCoupler couples pushing content into this view.

There are no TheonCoupler couples pulling content from this view.

11.7.5. Roles

The following are the roles controlling access to this view.

Role Name Group Name Allowing Description

???

11.8. person_institute_access

UUID

ent-5b8970f6-cf1f-40bc-a2f3-824b4d16ab9e

Relation Type

VIEW

Relation Name

Person (Institute Access)

View Name

person_institute_access

View Signature

person_institute_access

Explicit Cluster Membership

NONE

Explicit Dependencies

institute person

Export Element Instance

entity:person_institute_access

Derive Fragment Instance

relation:person_institute_access

Description

The Person table holds basic details on all staff members that might be contributing to the REF submission. This is a view which ordinary users have read only access to but constrained to people that have submitted papers who are members of the institute that the user is a director or deputy director of.

11.8.1. Properties

There are no deviant properties associated with this view.

11.8.2. Columns

The following are the columns in this view in positional order.

Attribute Name Column Name Type Properties Default Description

PersonID

id

INTEGER

NONE

Unique identifier for the person within the Referee system. This identifier is automatically generated and read only. It does not correspond to any other person identifier.

UUN

uun

TEXT

NONE

The UUN (Unique Username) for the member of staff. The Referee system makes this field read only to all users as it is expected to be fed in by the PURE1AC stream.

Firstname

firstname

TEXT

NONE

The first name (given name or known-as name) for the member of staff. The Referee system makes this field read only to all users as it is expected to be fed in by the PURE1AC stream.

Lastname

lastname

TEXT

NONE

The last name (surname) for the member of staff. The Referee system makes this field read only to all users as it is expected to be fed in by the PURE1AC stream.

Eligible?

eligible

BOOLEAN

NONE

Use this field to mark up exactly which members of staff are REF eligible (will be proposing and/or rating and/or moderating papers). By default all staff will be set as eligible so normally this field should only be manually unset for all those staff that are not eligible (e.g. support staff) if these have been fed in.

Rater?

rater

BOOLEAN

NONE

This value should be set when the person is one of those who can be assigned as a Rater of papers. People with this flag set are included on the available names on the drop-down used to assign raters to papers. Note that this field only affects the UI behaviour, any person can be assigned as a rater through the GW (irrespective of the setting of this flag). By default no person has this flag set.

Moderater?

moderater

BOOLEAN

NONE

This value should be set when the person is one of those who can be assigned as a Moderater of papers. People with this flag set are included on the available names on the drop-down used to assign moderaters to papers. Note that this field only affects the UI behaviour, any person can be assigned as a moderater through the GW (irrespective of the setting of this flag). By default no person has this flag set.

Email Address

email

TEXT

NONE

Email address of REF eligible staff member.

Institute

institute

TEXT

NONE

List of institute abbreviations that the person is affiliated with (only those defined to be included through the Institute table).

11.8.3. TheonCoupler Columns

There are no automatically maintained TheonCoupler columns in this view.

11.8.4. TheonCoupler Couples

There are no TheonCoupler couples pushing content into this view.

There are no TheonCoupler couples pulling content from this view.

11.8.5. Roles

The following are the roles controlling access to this view.

Role Name Group Name Allowing Description

???

11.9. person_stats

UUID

ent-e8523c4e-0846-4d67-97a4-9ae88d120730

Relation Type

VIEW

Relation Name

Person Specific Statistics

View Name

person_stats

View Signature

person_stats

Explicit Cluster Membership

NONE

Explicit Dependencies

person moderater paper rater

Export Element Instance

entity:person_stats

Derive Fragment Instance

relation:person_stats

Description

Generated statistics per person. Provides overview of number of papers submitted, to rate, actually rated, to moderate and actually moderated.

11.9.1. Properties

There are no deviant properties associated with this view.

11.9.2. Columns

The following are the columns in this view in positional order.

Attribute Name Column Name Type Properties Default Description

ObjectID

oid

INTEGER

NONE

Any entity used on a Desktop Panel in TheonUI must have an OID value which is used as a unique row identifier. Since a View does not have an OID column by default (like a Table) one must be artificially constructed. Any integer value can be used as long as uniqueness across all rows in the view is guaranteed.

PersonID

person_id

INTEGER

NONE

The unique person identifier for the person assigned to rate the paper, taken from the Person table.

#Proposed

submitted

CUSTOM(bigint)

NONE

Total number of papers proposed by this person for the REF.

#Rated

r_done

CUSTOM(bigint)

NONE

Total number of papers that have so far been rated by this person (count of papers where the rated value is non-empty).

#ToRate

r_todo

CUSTOM(bigint)

NONE

Total number of papers that have been assigned to this person for rating.

Rated Summary

rated

TEXT

NONE

Calculated value which shows the number of papers that have been assigned to review and rate and of those the number that have actually been given a rating value. This is presented as "X/Y" where X is the number of papers that have been rated (a non-empty value) and Y is the number of paper the person has to rate in total. For example: "0/0" is no papers assigned; "0/34" is 34 papers assigned but none have been given a rating yet; "8/34" means 8 papers have been given a rating; "34/34" means all papers assigned have been given a rating.

Rated Percentage

rated_per

DECIMAL(5,2)

NONE

Percentage of papers that have been rated so far out of the total number of papers assigned to this person to rate - indicates progress.

#Moderated

m_done

CUSTOM(bigint)

NONE

Total number of papers that have so far been moderated by this person (count of papers where the moderated value is non-empty).

#ToModerate

m_todo

CUSTOM(bigint)

NONE

Total number of papers that have been assigned to this person for moderating.

Moderated Summary

moderated

TEXT

NONE

Calculated value which shows the number of papers that have been assigned to moderate and of those the number that have actually been given a rating value. This is presented as "X/Y" where X is the number of papers that have been moderated (a non-empty value) and Y is the number of paper the person has to moderate in total. For example: "0/0" is no papers assigned; "0/34" is 34 papers assigned but none have been given a rating yet; "8/34" means 8 papers have been given a rating; "34/34" means all papers assigned have been given a rating.

Moderated Percentage

moderated_per

DECIMAL(5,2)

NONE

Percentage of papers that have been moderated so far out of the total number of papers assigned to this person to moderate - indicates progress.

11.9.3. TheonCoupler Columns

There are no automatically maintained TheonCoupler columns in this view.

11.9.4. TheonCoupler Couples

There are no TheonCoupler couples pushing content into this view.

There are no TheonCoupler couples pulling content from this view.

11.9.5. Roles

The following are the roles controlling access to this view.

Role Name Group Name Allowing Description

???

11.10. ppfunq

UUID

ent-9e3e57af-b312-4ee7-b60a-4b5077e727f5

Relation Type

VIEW

Relation Name

Paper Feed (PURE) (Unique)

View Name

ppfunq

View Signature

ppfunq

Explicit Cluster Membership

NONE

Explicit Dependencies

pure_paper_file_feed pure_paper_feed

Export Element Instance

entity:ppfunq

Derive Fragment Instance

relation:ppfunq

Description

Holds the raw feed data of REF submitted paper details taken daily from PURE modified so that only unique papers are included. Any paper in the raw data that has been included more than once (generally when joint authors have independently proposed the same paper incorrectly) is suppressed (removed from the data set). Since the target table is unique on the paper number, since a paper can only be submitted to the REF once, without doing this the feed will generate an error and fail. The excluded papers must be subsequently referred back to the owners so that only one instance is proposed for the REF.

11.10.1. Properties

There are no deviant properties associated with this view.

11.10.2. Columns

The following are the columns in this view in positional order.

Attribute Name Column Name Type Properties Default Description

Paper UUID

uuid

TEXT

NONE

The UUID of the paper. This can be used to construct the handle URL for ERE which is: http://hdl.handle.net/ORGID/UUID where UUID is the value of this column and ORGID is 20.500.11820 which is the institutional identifier.

Paper FileID

pure_file_id

TEXT

NONE

The file identifier of the PURE held copy of the paper. The URL appears to then become: https://www.pure.ed.ac.uk/admin/files/ID/FILE, where ID is the value of this column and FILE is the value in the PURE FileName column.

Paper FileName

pure_file_name

TEXT

NONE

The filename of the PURE held copy of the paper. The URL appears to then become: https://www.pure.ed.ac.uk/admin/files/ID/FILE, where FILE is the value of this column and ID is the value in the PURE FileID column.

DOI

doi

TEXT

NONE

Code number for the paper URL as held in the ACM Digital Library for Edinburgh. This should be automatically prefixed with dx.doi.org to get the direct link.

Submitter

submitter_name

TEXT

NONE

Name and email address of the user who proposed the paper for the REF submission. Normally the original paper author but may not be the principal author if the paper has many.

UUN

submitter_uun

TEXT

NONE

Unique Username of the user who proposed the paper for the REF submission. Normally the original paper author but may not be the principal author if the paper has many. The submitter UUN must exist in the Person table or the paper will be silently dropped from the feed update.

Rank

rank

TEXT

NONE

Rating given to the paper by the submitter on proposal. This value of this will be from 1st to 6th or Alternate.

Type

type

TEXT

NONE

The type of the paper as originally published, for example Journal Article or Chapter in Book. This field is not used anywhere within the Referee service but is part of the data fed from PURE.

PaperNumber

paper_num

TEXT

NONE

The unique paper number assigned in PURE. This number is used as the stream handle to tie papers held in the referee service to the upstream instance held in PURE.

Title

title

TEXT

NONE

The full title of the paper.

Abstract

abstract

TEXT

NONE

The full textual abstract of the paper which should be an exact content of what is in PURE, however any non-textual content may well be lost or mangled due to the feed process.

Reason

reason

TEXT

NONE

Reason given by the submitter for proposing the paper be added to the REF submission.

Paper URL

local_url

TEXT

NONE

Direct link to online version of paper, generally this is the original publication location but can also replicate the DOI location.

DOI

direct_url

TEXT

NONE

Code number for the paper URL as held in the ACM Digital Library for Edinburgh. This is automatically prefixed with dx.doi.org to get the direct link.

Double Weighted?

doubleweight

TEXT

NONE

Flag indicating whether the proposed paper should be double weighted for the REF submission.

Publisher

publisher

TEXT

NONE

The short abbreviation name of the publisher.

Publication Date

pub_date

TEXT

NONE

The publication date.

APA

apa

TEXT

NONE

The APA (American Psychological Association) formatted citation string for the paper. This contains more detail then seems to be available otherwise in individual fields in terms of publisher and year.

Filename

filename

TEXT

NONE

The filename of the PURE held copy of the paper. The URL appears to then become: https://www.pure.ed.ac.uk/admin/files/ID/FILE. Note however that this filename is useless without the holding directory ID number which is not the paper ID number or the REF2 submission ID number and does not seem to be available.

11.10.3. TheonCoupler Columns

There are no automatically maintained TheonCoupler columns in this view.

11.10.4. TheonCoupler Couples

There are no TheonCoupler couples pushing content into this view.

The following are the TheonCoupler couples pulling content from this view.

Couple Name Owning Stream Target Table Handle Columns Paired Columns Description

Paper

PURE2

Paper

paper_num

rank submitter_uun

This stream manages the flow of Paper data into the system. The source content of the stream is taken from report run against REF2 in PURE. It provides details for all the proposed papers in the REF submission including rating and reason for submission.

11.10.5. Roles

There are no roles controlling access to this view.

11.11. psfsplit

UUID

ent-192df04b-2500-4d96-8fca-f549b7a5cd05

Relation Type

VIEW

Relation Name

Staff Feed (PURE) (Processed)

View Name

psfsplit

View Signature

psfsplit

Explicit Cluster Membership

NONE

Explicit Dependencies

institute pure_staff_feed

Export Element Instance

entity:psfsplit

Derive Fragment Instance

relation:psfsplit

Description

Holds the raw feed data of REF staff details taken daily from PURE modified so that UUN’s, email address and research institute affiliation have been extracted.

11.11.1. Properties

There are no deviant properties associated with this view.

11.11.2. Columns

The following are the columns in this view in positional order.

Attribute Name Column Name Type Properties Default Description

Employee#

empnum

INTEGER

NONE

Unique employee (personnel) number for REF eligible staff member.

Firstname

firstname

TEXT

NONE

The first name (given name or known-as name) for the member of staff. The Referee system makes this field read only to all users as it is expected to be fed in by the PURE1AC stream.

Lastname

lastname

TEXT

NONE

The last name (surname) for the member of staff. The Referee system makes this field read only to all users as it is expected to be fed in by the PURE1AC stream.

UUN

uun

TEXT

NONE

The UUN (Unique Username) for the member of staff. The Referee system makes this field read only to all users as it is expected to be fed in by the PURE1AC stream.

Email Address

email

TEXT

NONE

Email address of REF eligible staff member.

Institute

institute

TEXT

NONE

List of institute abbreviations that the person is affiliated with (only those defined to be included through the Institute table).

11.11.3. TheonCoupler Columns

There are no automatically maintained TheonCoupler columns in this view.

11.11.4. TheonCoupler Couples

There are no TheonCoupler couples pushing content into this view.

The following are the TheonCoupler couples pulling content from this view.

Couple Name Owning Stream Target Table Handle Columns Paired Columns Description

Person

PURE1AC

Person

empnum

firstname

This stream manages the flow of Staff data into the system. The source content of the stream is taken from report run against REF1AC in PURE. It provides details for all the eligible staff in the REF submission.

11.11.5. Roles

There are no roles controlling access to this view.

11.12. rater_access

UUID

ent-ae4430a7-b062-430b-abf3-e7cc7fce027b

Relation Type

VIEW

Relation Name

RaterPapers (Access)

View Name

rater_access

View Signature

rater_access

Explicit Cluster Membership

NONE

Explicit Dependencies

rater_update person paper rater

Export Element Instance

entity:rater_access

Derive Fragment Instance

relation:rater_access

Description

Principal view of papers for raters. Contains read only paper details with submitter name and editable rating and comment for rater. The view is constrained to show just those papers the current session user has been allocated to rate.

11.12.1. Properties

There are no deviant properties associated with this view.

11.12.2. Columns

The following are the columns in this view in positional order.

Attribute Name Column Name Type Properties Default Description

RaterID

id

INTEGER

NONE

Unique identifier for the rater/paper association within the Referee system. This identifier is automatically generated and read only.

PaperID

paper_id

INTEGER

NONE

The unique paper identifier for the paper the person has been assigned to rate, taken from the Paper table.

Title

title

TEXT

NONE

The full title of the paper.

Abstract

abstract

TEXT

NONE

The full textual abstract of the paper. Any non-textual content will likely be lost or mangled in some way.

Paper URL

pure_url

TEXT

NONE

Direct link to the online copy of the paper. This is a URL which is a direct link to the local copy of the paper held in PURE, and is what is used as the paper download link from the corresponding entry on Edinburgh Research Explorer. This copy of the paper should always be accessible to local staff for review, unlike the DOI URL or published location which may not always be open access.

Reason

reason

TEXT

NONE

Reason given by the submitter for proposing the paper be added to the REF submission.

Rank

rank

TEXT

NONE

Rating given to the paper by the submitter on proposal. This value of this will be from 1st to 6th or Alternate.

Double Weighted?

double_weight

BOOLEAN

NONE

Flag indicating whether the proposed paper should be double weighted for the REF submission.

Rating

rating

TEXT

NONE

Rating assigned to the paper after review. This will be a value of 0, 1, 1-, 1+, 2, 2-, 2+, 3, 3-, 3+, 4, 4- or 4+. Do not use N*. Any value other than a number between 0 and 4 (where 1 to 4 can optionally be suffixed with plus or minus) entered in this field will be rejected with a check constraint error.

Comment

comment

TEXT

NONE

Free form comment from the rater - this might be to explain the reasoning behind a particular rating or to suggest changes to the paper proposal reason.

Firstname

firstname

TEXT

NONE

The first name (given name or known-as name) for the member of staff. The Referee system makes this field read only to all users as it is expected to be fed in by the PURE1AC stream.

Lastname

lastname

TEXT

NONE

The last name (surname) for the member of staff. The Referee system makes this field read only to all users as it is expected to be fed in by the PURE1AC stream.

ObjectID

oid

INTEGER

NONE

Any entity used on a Desktop Panel in TheonUI must have an OID value which is used as a unique row identifier. Since a View does not have an OID column by default (like a Table) one must be artificially constructed. Any integer value can be used as long as uniqueness across all rows in the view is guaranteed.

APA

apa

TEXT

NONE

The APA (American Psychological Association) formatted citation string for the paper. This contains more detail then seems to be available otherwise in individual fields in terms of publisher and year.

ERE URL

ere_url

TEXT

NONE

Direct link to the web page for the paper in Edinburgh Research Explorer. This page (and download link) for the paper should always be accessible to local staff for review, unlike the DOI URL or published location which may not always be open access.

DOI URL

doi_url

TEXT

NONE

Link to the copy of the paper held in the ACM Digital Library for Edinburgh.

11.12.3. TheonCoupler Columns

There are no automatically maintained TheonCoupler columns in this view.

11.12.4. TheonCoupler Couples

There are no TheonCoupler couples pushing content into this view.

There are no TheonCoupler couples pulling content from this view.

11.12.5. Roles

The following are the roles controlling access to this view.

Role Name Group Name Allowing Description

???

11.13. rater_institute_access

UUID

ent-31ae06e5-5288-4c40-9e79-7d531750744a

Relation Type

VIEW

Relation Name

Rater (Institute Access)

View Name

rater_institute_access

View Signature

rater_institute_access

Explicit Cluster Membership

NONE

Explicit Dependencies

paper_institute_access institute person person_institute_access paper rater

Export Element Instance

entity:rater_institute_access

Derive Fragment Instance

relation:rater_institute_access

Description

Holds who is assigned to rate a paper as well as the result. This is a view which ordinary users have read only access to but constrained to papers submitted by people who are members of the institute that the user is a director or deputy director of.

11.13.1. Properties

There are no deviant properties associated with this view.

11.13.2. Columns

The following are the columns in this view in positional order.

Attribute Name Column Name Type Properties Default Description

PaperID

paper_id

INTEGER

NONE

The unique paper identifier for the paper the person has been assigned to rate, taken from the Paper table.

RaterPersonID

person_id

INTEGER

NONE

The unique person identifier for the person assigned to rate the paper, taken from the Person table.

Rating

rank

TEXT

NONE

Rating assigned to the paper after review. This will be a value of 0, 1, 1-, 1+, 2, 2-, 2+, 3, 3-, 3+, 4, 4- or 4+. Do not use N*. Any value other than a number between 0 and 4 (where 1 to 4 can optionally be suffixed with plus or minus) entered in this field will be rejected with a check constraint error.

Comment

comment

TEXT

NONE

Free form comment from the rater - this might be to explain the reasoning behind a particular rating or to suggest changes to the paper proposal reason.

RaterID

id

INTEGER

NONE

Unique identifier for the rater/paper association within the Referee system. This identifier is automatically generated and read only.

11.13.3. TheonCoupler Columns

There are no automatically maintained TheonCoupler columns in this view.

11.13.4. TheonCoupler Couples

There are no TheonCoupler couples pushing content into this view.

There are no TheonCoupler couples pulling content from this view.

11.13.5. Roles

The following are the roles controlling access to this view.

Role Name Group Name Allowing Description

???

11.14. raterupdate

UUID

ent-4ace9f03-656f-4d37-a9d7-0e717fbd5d92

Relation Type

VIEW

Relation Name

RaterPapers (Update)

View Name

raterupdate

View Signature

raterupdate

Explicit Cluster Membership

NONE

Explicit Dependencies

person rater

Export Element Instance

entity:raterupdate

Derive Fragment Instance

relation:raterupdate

Description

Updateable view of the Rater table. The view is constrained to include just those papers the current session user has been allocated to rate and is used to allow updates to the paper rating and comment by corresponding raters. This view is not directly exposed, instead it is used by the handler function for updates on the Papers for Raters view.

11.14.1. Properties

There are no deviant properties associated with this view.

11.14.2. Columns

The following are the columns in this view in positional order.

Attribute Name Column Name Type Properties Default Description

PaperID

paper_id

INTEGER

NONE

The unique paper identifier for the paper the person has been assigned to rate, taken from the Paper table.

RaterPersonID

person_id

INTEGER

NONE

The unique person identifier for the person assigned to rate the paper, taken from the Person table.

Rank

rank

TEXT

NONE

Rating given to the paper by the submitter on proposal. This value of this will be from 1st to 6th or Alternate.

Comment

comment

TEXT

NONE

Free form comment from the rater - this might be to explain the reasoning behind a particular rating or to suggest changes to the paper proposal reason.

RaterID

id

INTEGER

NONE

Unique identifier for the rater/paper association within the Referee system. This identifier is automatically generated and read only.

11.14.3. TheonCoupler Columns

There are no automatically maintained TheonCoupler columns in this view.

11.14.4. TheonCoupler Couples

There are no TheonCoupler couples pushing content into this view.

There are no TheonCoupler couples pulling content from this view.

11.14.5. Roles

The following are the roles controlling access to this view.

Role Name Group Name Allowing Description

???

11.15. status_institute_access

UUID

ent-7b3d971a-5c23-4a1e-b868-f051acf87a98

Relation Type

VIEW

Relation Name

Status (Institute Access)

View Name

status_institute_access

View Signature

status_institute_access

Explicit Cluster Membership

NONE

Explicit Dependencies

paper_institute_access institute person paperupdate

Export Element Instance

entity:status_institute_access

Derive Fragment Instance

relation:status_institute_access

Description

Principal view of papers for administrative users. Contains read only paper details with submitter name, raters results summary, moderaters result summary and chosen flag. This is a view which ordinary users have read only access to but constrained to papers that have been submitted by people who are members of the institute that the user is a director or deputy director of.

11.15.1. Properties

There are no deviant properties associated with this view.

11.15.2. Columns

The following are the columns in this view in positional order.

Attribute Name Column Name Type Properties Default Description

PaperID

id

INTEGER

NONE

Unique identifier for the paper within the Referee system. This identifier is automatically generated and read only. It does not correspond to any other paper identifier.

Title

title

TEXT

NONE

The full title of the paper.

Abstract

abstract

TEXT

NONE

The full textual abstract of the paper which should be an exact content of what is in PURE, however any non-textual content may well be lost or mangled due to the feed process.

Paper URL

pure_url

TEXT

NONE

Direct link to the online copy of the paper. This is a URL which is a direct link to the local copy of the paper held in PURE, and is what is used as the paper download link from the corresponding entry on Edinburgh Research Explorer. This copy of the paper should always be accessible to local staff for review, unlike the DOI URL or published location which may not always be open access.

Reason

reason

TEXT

NONE

Reason given by the submitter for proposing the paper be added to the REF submission.

Rating

rank

TEXT

NONE

Rating assigned to the paper after review. This will be a value of 0, 1, 1-, 1+, 2, 2-, 2+, 3, 3-, 3+, 4, 4- or 4+. Do not use N*. Any value other than a number between 0 and 4 (where 1 to 4 can optionally be suffixed with plus or minus) entered in this field will be rejected with a check constraint error.

Double Weighted?

double_weight

BOOLEAN

NONE

Flag indicating whether the proposed paper should be double weighted for the REF submission.

SubmitterPersonID

person_id

INTEGER

NONE

The unique person identifier for the person assigned to rate the paper, taken from the Person table.

Firstname

firstname

TEXT

NONE

The first name (given name or known-as name) for the member of staff. The Referee system makes this field read only to all users as it is expected to be fed in by the PURE1AC stream.

Lastname

lastname

TEXT

NONE

The last name (surname) for the member of staff. The Referee system makes this field read only to all users as it is expected to be fed in by the PURE1AC stream.

Raters Done

raters_done

TEXT

NONE

Calculated value which shows the number of raters that have been assigned to review and rate the paper (normally 2) and of those the number that have actually entered a rating value for the paper. This is presented as "X/Y" where X is the number of raters that have rated the paper and Y is the number of raters the paper has. For example: "0/0" is no raters assigned; "0/2" is 2 raters assigned but none have given a rating yet; "1/2" means one rater has given a rating; "2/2" is both (all) raters have given a rating. Normally a moderation would not take place until this state has been reached (when X = Y != 0).

Rater1 Rating

rater1_rating

TEXT

NONE

Calculated value which shows the first raters rating assigned to a paper and the corresponding rater surname, subsequently used in the moderation process. For example "1 (Bloggs)" shows that "Bloggs" rated the paper "1". Only if the first rater has entered a rating will they be listed so the value will be blank if they have not done so.

Rater2 Rating

rater2_rating

TEXT

NONE

Calculated value which shows the second raters rating assigned to a paper and the corresponding rater surname, subsequently used in the moderation process. For example "1 (Bloggs)" shows that "Bloggs" rated the paper "1". Only if the second rater has entered a rating will they be listed so the value will be blank if they have not done so.

Rater1 Comment

rater1_comment

TEXT

NONE

Value which shows the first raters comment assigned to a paper. Only if the first rater has entered a comment will they be listed so the value will be blank if they have not done so.

Rater2 Comment

rater2_comment

TEXT

NONE

Value which shows the second raters comment assigned to a paper. Only if the second rater has entered a comment will they be listed so the value will be blank if they have not done so.

Raters Result

raters

TEXT

NONE

If the first and second rater assigned ratings differ this will be "Disagree", otherwise if they are they same this will be "Agree". If one of the raters has not entered a rating yet this will be blank.

Moderaters Done

moderaters_done

TEXT

NONE

Calculated value which shows the number of moderaters that have been assigned to review and rate the paper (normally 1) and of those the number that have actually entered a rating value for the paper. This is presented as "X/Y" where X is the number of moderaters that have rated the paper and Y is the number of moderaters the paper has. For example: "0/0" is no moderaters assigned; "0/2" is 2 moderaters assigned but none have given a rating yet; "1/2" means one moderater has given a rating; "2/2" is both (all) moderaters have given a rating. Normally a paper should not be chosen for submission until this last state has been reached (when X = Y != 0).

Moderaters Rating

moderaters_rating

TEXT

NONE

Calculated value which shows a list (slash separated) all the ratings assigned to a paper and the corresponding moderater surnames. For example "1(Bloggs)/3(Doe)" shows that "Bloggs" rated the paper "1" and "Doe" rated the paper "3". Only moderaters that have entered a rating will be listed so the value will be blank if none have done so.

Moderaters Comment

moderaters_comment

TEXT

NONE

Value which shows the moderaters comment assigned to a paper. Only if the moderater has entered a comment will they be listed so the value will be blank if they have not done so.

Review Result

result

TEXT

NONE

Following completion of review this value will indicate the best rated paper (based on moderated rating) for each submitter. Where a submitter has multiple papers rater the same then the one that the submitter ranked highest will be indicated as the best. Where the submitter has used the same ranking more than once then the one indicated as the best will be effectively random.

Chosen?

chosen

BOOLEAN

NONE

This value should be set (checked) by administrative users after the paper has been reviewed (by raters and moderaters) and it has been decided that it should be in included in the REF submission.

Moderater Result

moderated_rank

TEXT

NONE

This will be "Differs" when the average value (as a floating point number) of the ratings given by the raters is distinct from the average value (as a floating point number) given by the moderater, and will be "Average" otherwise. It will be empty if one or both raters have not entered a rank or if the moderater has not entered a rank. This field can be used to show where the moderation process has resulted in a rating divergent from the original rating for subsequent cross checking prior to choosing the paper for submission. The rater ranks are mapped to a number in order to calculate the average. This is based on thirds, so 1 is 1, 1- is (1 - 1/3) and 1+ is (1 + 1/3), 0 is mapped to 1/3.

ObjectID

oid

INTEGER

NONE

Any entity used on a Desktop Panel in TheonUI must have an OID value which is used as a unique row identifier. Since a View does not have an OID column by default (like a Table) one must be artificially constructed. Any integer value can be used as long as uniqueness across all rows in the view is guaranteed.

APA

apa

TEXT

NONE

The APA (American Psychological Association) formatted citation string for the paper. This contains more detail then seems to be available otherwise in individual fields in terms of publisher and year.

DOI URL

doi_url

TEXT

NONE

Link to the copy of the paper held in the ACM Digital Library for Edinburgh.

ERE URL

ere_url

TEXT

NONE

Direct link to the web page for the paper in Edinburgh Research Explorer. This page (and download link) for the paper should always be accessible to local staff for review, unlike the DOI URL or published location which may not always be open access.

11.15.3. TheonCoupler Columns

There are no automatically maintained TheonCoupler columns in this view.

11.15.4. TheonCoupler Couples

There are no TheonCoupler couples pushing content into this view.

There are no TheonCoupler couples pulling content from this view.

11.15.5. Roles

The following are the roles controlling access to this view.

Role Name Group Name Allowing Description

???

Chapter 12. Function

Chapter 13. TheonCoupler Function

13.1. _th_pure1ac_person_couple

UUID

ent-de254dd9-a45a-4202-abab-8b08cbaca9dd

Relation Type

FUNCTION

Relation Name

NONE (USING FUNCTION NAME)

Function Name

_th_pure1ac_person_couple

Function Signature

_th_pure1ac_person_couple

Explicit Cluster Membership

NONE

Explicit Dependencies

NONE

Export Element Instance

entity:_th_pure1ac_person_couple

Derive Fragment Instance

process:_th_pure1ac_person_couple

Description

NONE

13.1.1. Properties

There are no deviant properties associated with this function.

13.1.2. Parameters

The following are the parameters for this function in positional order.

Attribute Name Parameter Name Type Default

Employee#

empnum

INTEGER

NULL

13.1.3. Returning

There is no returning value from this function.

13.1.4. Roles

There are no roles controlling access to this function.

13.2. _th_pure2_paper_couple

UUID

ent-f8bd66ff-2ffd-43eb-a184-eb99f7356dc2

Relation Type

FUNCTION

Relation Name

NONE (USING FUNCTION NAME)

Function Name

_th_pure2_paper_couple

Function Signature

_th_pure2_paper_couple

Explicit Cluster Membership

NONE

Explicit Dependencies

NONE

Export Element Instance

entity:_th_pure2_paper_couple

Derive Fragment Instance

process:_th_pure2_paper_couple

Description

NONE

13.2.1. Properties

There are no deviant properties associated with this function.

13.2.2. Parameters

The following are the parameters for this function in positional order.

Attribute Name Parameter Name Type Default

PaperNumber

paper_num

TEXT

NULL

13.2.3. Returning

There is no returning value from this function.

13.2.4. Roles

There are no roles controlling access to this function.

Chapter 14. Eventfunction

14.1. dualrater_update_171152136

UUID

ent-a861f1a3-5dd4-425e-995c-8411fc22731d

Relation Type

EVENTFUNCTION

Relation Name

DualRater (Update)

Eventfunction Name

dualrater_update

Eventfunction Signature

dualrater_update_171152136

Explicit Cluster Membership

NONE

Explicit Dependencies

NONE

Export Element Instance

entity:dualrater_update_171152136

Derive Fragment Instance

process:dualrater_update_171152136

Description

Function handles any updates made by an administrative user on the DualRater view making the necessary updates to the underlying Rater table.

14.1.1. Properties

There are no deviant properties associated with this eventfunction.

14.1.2. Roles

There are no roles controlling access to this eventfunction.

14.2. moderater_update_1686167270

UUID

ent-a2a52442-bb48-4eb7-aaca-8237a476908a

Relation Type

EVENTFUNCTION

Relation Name

Moderater (Update)

Eventfunction Name

moderater_update

Eventfunction Signature

moderater_update_1686167270

Explicit Cluster Membership

NONE

Explicit Dependencies

NONE

Export Element Instance

entity:moderater_update_1686167270

Derive Fragment Instance

process:moderater_update_1686167270

Description

Function handles any updates made by a user on the Papers for Moderaters view by mapping the update to the corresponding update view, as updates cannot be made directly otherwise.

14.2.1. Properties

There are no deviant properties associated with this eventfunction.

14.2.2. Roles

There are no roles controlling access to this eventfunction.

14.3. paper_update_184621051

UUID

ent-fe866f5c-0038-47a2-8c0d-7ce836e9a93f

Relation Type

EVENTFUNCTION

Relation Name

Paper (Update)

Eventfunction Name

paper_update

Eventfunction Signature

paper_update_184621051

Explicit Cluster Membership

NONE

Explicit Dependencies

NONE

Export Element Instance

entity:paper_update_184621051

Derive Fragment Instance

process:paper_update_184621051

Description

Function handles any updates made by an administrative user on the Papers view by mapping the update to the corresponding update view, as updates cannot be made directly otherwise.

14.3.1. Properties

There are no deviant properties associated with this eventfunction.

14.3.2. Roles

There are no roles controlling access to this eventfunction.

14.4. rater_update_917830668

UUID

ent-4523ef94-638d-4c25-9e2e-5922b21612f6

Relation Type

EVENTFUNCTION

Relation Name

Rater (Update)

Eventfunction Name

rater_update

Eventfunction Signature

rater_update_917830668

Explicit Cluster Membership

NONE

Explicit Dependencies

NONE

Export Element Instance

entity:rater_update_917830668

Derive Fragment Instance

process:rater_update_917830668

Description

Function handles any updates made by a user on the Papers for Raters view by mapping the update to the corresponding update view, as updates cannot be made directly otherwise.

14.4.1. Properties

There are no deviant properties associated with this eventfunction.

14.4.2. Roles

There are no roles controlling access to this eventfunction.

Chapter 15. TheonCoupler Eventfunction

15.1. _th_coupler_paper_check

UUID

ent-38366a95-6f2c-4f1a-870e-feaf20e1cbb8

Relation Type

EVENTFUNCTION

Relation Name

NONE (USING EVENTFUNCTION NAME)

Eventfunction Name

_th_coupler_paper_check

Eventfunction Signature

_th_coupler_paper_check

Explicit Cluster Membership

NONE

Explicit Dependencies

NONE

Export Element Instance

entity:_th_coupler_paper_check

Derive Fragment Instance

process:_th_coupler_paper_check

Description

NONE

15.1.1. Properties

There are no deviant properties associated with this eventfunction.

15.1.2. Roles

There are no roles controlling access to this eventfunction.

15.2. _th_coupler_person_check

UUID

ent-47a7f94b-613f-44ef-9e15-28d0bb159970

Relation Type

EVENTFUNCTION

Relation Name

NONE (USING EVENTFUNCTION NAME)

Eventfunction Name

_th_coupler_person_check

Eventfunction Signature

_th_coupler_person_check

Explicit Cluster Membership

NONE

Explicit Dependencies

NONE

Export Element Instance

entity:_th_coupler_person_check

Derive Fragment Instance

process:_th_coupler_person_check

Description

NONE

15.2.1. Properties

There are no deviant properties associated with this eventfunction.

15.2.2. Roles

There are no roles controlling access to this eventfunction.

Chapter 16. Tablefunction

Chapter 17. Clusters

17.1. TheonGW Interfaces

UUID

clu-29fa3dab-efa2-4298-ad3b-26ab478f2f87

Cluster Name

TheonGW Interfaces

Cluster Type

SCHEME

Description

Cluster for grouping the desktops that need to just be exposed under the TheonGW service.

17.1.1. Relations

There are no relations in this cluster.

17.1.2. Processes

There are no processes in this cluster.

17.2. TheonUI Reduced Desktops

UUID

clu-9bc1fa09-69bb-426c-b983-31c9d898b77c

Cluster Name

TheonUI Reduced Desktops

Cluster Type

SCHEME

Description

Cluster for grouping desktops specifically designed for use on smaller screen sizes.

17.2.1. Relations

There are no relations in this cluster.

17.2.2. Processes

There are no processes in this cluster.

Chapter 18. Roles

18.1. rootclient

UUID

rol-4f500c8c-4638-42a9-93bb-215f73f4f363

Role Name

Root

Group Name

rootclient

Description

This role should be assigned to users that our accessing the system to perform administrative tasks. This role allows these users to assign raters and moderaters to papers, review the overall status and choose papers for REF submission.

18.1.1. Capabilities

The following are the capabilities allowed in this role.

Entity Name Entity Type Reading Records Adding Records Updating Records Deleting Records

dualrater

VIEW

YES

NO

NO Except: moderater_id rater2_id rater1_id

NO

institute

TABLE

YES

YES

YES

NO

moderater

TABLE

YES

YES

YES Except: id

NO

moderater_id_seq

SEQUENCE

NO

NO

YES

NO

paper

TABLE

YES

NO

NO Except: chosen

NO

paperupdate

VIEW

YES

NO

NO Except: chosen

NO

person

TABLE

YES

NO

NO Except: rater moderater eligible

NO

person_stats

VIEW

YES

NO

NO

NO

rater

TABLE

YES

YES

YES Except: id

NO

rater_id_seq

SEQUENCE

NO

NO

YES

NO

18.2. userclient

UUID

rol-1b82d0c9-cbf2-4b44-9abf-539b45057361

Role Name

User

Group Name

userclient

Description

This role should be assigned to users that our accessing the system to perform REF related tasks. This role allows these users to view the papers they have proposed and assign ratings to papers in their capacity as a rater or moderater.

18.2.1. Capabilities

The following are the capabilities allowed in this role.

Entity Name Entity Type Reading Records Adding Records Updating Records Deleting Records

moderater_access

VIEW

YES

NO

NO Except: rating comment

NO

moderater_institute_access

VIEW

YES

NO

NO

NO

moderaterupdate

VIEW

YES

NO

NO Except: rank comment

NO

paper_access

VIEW

YES

NO

NO

NO

paper_institute_access

VIEW

YES

NO

NO

NO

person_institute_access

VIEW

YES

NO

NO

NO

rater_access

VIEW

YES

NO

NO Except: rating comment

NO

rater_institute_access

VIEW

YES

NO

NO

NO

raterupdate

VIEW

YES

NO

NO Except: rank comment

NO

status_institute_access

VIEW

YES

NO

NO

NO

Chapter 19. Streams

19.1. pure1ac

UUID

str-63bca74a-0145-46fe-b31b-77eb4571c22f

Stream Name

PURE1AC

Serial Number

Origin Handle

PURE1AC

Source Type

Pipe

Source Format

CSV

Properties

Description

This stream manages the flow of Staff data into the system. The source content of the stream is taken from report run against REF1AC in PURE. It provides details for all the eligible staff in the REF submission.

19.1.1. Couples

The following are the couples in this stream in execution order.

Name Parameters Source Target Properties

Person

Handle: empnum :: INTEGER

psfsplit

person

WITHOUT_CASCADE WITHOUT_DELTRAP

The following are bonds for each couple in this stream.

Name Handle Bond Column Bonds

Person

SOURCE → TARGET empnum → empnum

SOURCE → TARGET

firstname → firstname lastname → lastname uun → uun email → email institute → institute

19.2. pure2

UUID

str-53f37745-839a-4527-9700-de8eba094317

Stream Name

PURE2

Serial Number

Origin Handle

PURE2

Source Type

Pipe

Source Format

CSV

Properties

Description

This stream manages the flow of Paper data into the system. The source content of the stream is taken from report run against REF2 in PURE. It provides details for all the proposed papers in the REF submission including rating and reason for submission.

19.2.1. Couples

The following are the couples in this stream in execution order.

Name Parameters Source Target Properties

Paper

Handle: paper_num :: TEXT

ppfunq

paper

WITHOUT_CASCADE WITHOUT_DELTRAP

The following are bonds for each couple in this stream.

Name Handle Bond Column Bonds

Paper

SOURCE → TARGET paper_num → pure_id

SOURCE → TARGET

rank → rank title → title `direct_url{ https://dx.doi.org/

@ } → doi_url` `local_url{ https://www.pure.ed.ac.uk/admin/files/

@@pure_file_id

/

@@pure_file_name } → pure_url` reason → reason abstract → abstract doubleweight{ @::BOOLEAN } → double_weight publisher → publisher pub_date{ @::DATE } → pubdate apa → apa filename → filename `uuid{ http://hdl.handle.net/20.500.11820/

19.3. pure2ef

UUID

str-e04936f7-dcdf-465c-a833-606df1129304

Stream Name

PURE2EF

Serial Number

Origin Handle

PURE2EF

Source Type

Pipe

Source Format

CSV

Properties

Description

This stream manages the flow of Paper Download File data into the system. The source content of the stream is taken from report REF2EF run against REF2020 in PURE. It provides details for all the download files for each paper in the REF submission including rating and reason for submission. The data from this stream feed is not coupled but contributes to the underlying view used by the PURE2 stream.

19.3.1. Couples

There are no couples in this stream.

There are no couples in this stream.

Part III. Referee UI Desktop Technical Reference

Preface

The Referee database holds all the papers for rating, the assignment and rating results of raters and moderaters of each paper. This part contains the technical reference of the TheonUI interface to this database and has been automatically generated from the corresponding ModelLibrary.

Chapter 20. Desktops

20.1. API

UUID

des-5648a643-1c67-44a0-8bd8-5c3f4134e5d9

Desktop Name

API

Explicit Cluster Membership

TheonGW Interfaces

Description

This desktop is a TheonGW desktop and encapsulates the API to the Referee service. It will be accessable on the path "/api/v1/" at the service host gateway address.

20.1.1. Panels

The following are the panels on this desktop in presentational order.

Name Parent Related By Description

Papers

NONE

NONE

This call returns for the current authenticated user the papers that they have proposed for the REF submission. It is entirely read only (GET), the PUT, POST and DELETE methods are not available.

Papers to Rate

NONE

NONE

This call returns for the current authenticated user all the papers that they have been assigned to review and rate. This call can be used with paper ID to change (PUT) the content of the Rating and Comment fields, the updated record is returned. The POST and DELETE methods are not available.

Papers to Moderate

NONE

NONE

This call returns for the current authenticated user all the papers that they have been assigned to moderated. This call can be used with paper ID to change (PUT) the content of the Rating and Comment fields, the updated record is returned. The POST and DELETE methods are not available.

Papers

NONE

NONE

This call returns for the current authenticated user if they have an administrative role all the papers that have been proposed for the REF. This call can be used with paper ID to change (PUT) the content of the Chosen field, the updated record is returned. The POST and DELETE methods are not available.

Staff

NONE

NONE

This call returns for the current authenticated user if they have an administrative role all the staff for the local unit. This call can be used with person ID to change (PUT) the content of the Eligible, Rater and Moderater fields, the updated record is returned. The POST and DELETE methods are not available.

Raters

Staff

rater_person

This call returns for the current authenticated user if they have an administrative role all the rater instances of the governing context. The governing context can be a paper (so returning list of rater instances for that paper) or staff (so returning list of rater instances for that member of staff). This call can be used with paper ID (paper context) to change (PUT) the content of the person ID field (and also the Rating or Comment field) or to add (POST) an entirely new instance for a person ID, the updated record is returned. This call can be used with person ID (staff context) to change (PUT) the content of the paper ID field (and also the Rating or Comment field) or to add (POST) an entirely new instance for a paper ID, the updated record is returned. The DELETE method can be used with the rater instance ID outside of any governing context.

Moderaters

Staff

moderater_person

This call returns for the current authenticated user if they have an administrative role all the moderater instances of the governing context. The governing context can be a paper (so returning list of moderater instances for that paper) or staff (so returning list of moderater instances for that member of staff). This call can be used with paper ID (paper context) to change (PUT) the content of the person ID field (and also the Rating or Comment field) or to add (POST) an entirely new instance for a person ID, the updated record is returned. This call can be used with person ID (staff context) to change (PUT) the content of the paper ID field (and also the Rating or Comment field) or to add (POST) an entirely new instance for a paper ID, the updated record is returned. The DELETE method can be used with the moderater instance ID outside of any governing context.

Raters

Papers

rater_paper

This call returns for the current authenticated user if they have an administrative role all the rater instances of the governing context. The governing context can be a paper (so returning list of rater instances for that paper) or staff (so returning list of rater instances for that member of staff). This call can be used with paper ID (paper context) to change (PUT) the content of the person ID field (and also the Rating or Comment field) or to add (POST) an entirely new instance for a person ID, the updated record is returned. This call can be used with person ID (staff context) to change (PUT) the content of the paper ID field (and also the Rating or Comment field) or to add (POST) an entirely new instance for a paper ID, the updated record is returned. The DELETE method can be used with the rater instance ID outside of any governing context.

Moderaters

Papers

moderater_paper

This call returns for the current authenticated user if they have an administrative role all the moderater instances of the governing context. The governing context can be a paper (so returning list of moderater instances for that paper) or staff (so returning list of moderater instances for that member of staff). This call can be used with paper ID (paper context) to change (PUT) the content of the person ID field (and also the Rating or Comment field) or to add (POST) an entirely new instance for a person ID, the updated record is returned. This call can be used with person ID (staff context) to change (PUT) the content of the paper ID field (and also the Rating or Comment field) or to add (POST) an entirely new instance for a paper ID, the updated record is returned. The DELETE method can be used with the moderater instance ID outside of any governing context.

Submitters

NONE

NONE

This call returns for the current authenticated user if they have an administrative role all the submitters of papers. This call can be used to change (PUT) the first and second rater for a submitter. In this context the raters are then assigned to all that submitters papers. The POST and DELETE methods are not applicable.

Institutes

NONE

NONE

This call returns for the current authenticated user if they have an administrative role all the organisations that can be associated with submitters. This call can be used to change (PUT) the local label (usually a short acronym) to use for the organisation and to indicate whether the organisation is relevant and to be shown where appropriate against that user (for example the submitter School is not normally shown but the submitter research institute affiliation would be). The POST method can be used to add an entirely new organisation and the DELETE methods can be used to remove organisations that are no longer applicable.

InstitutePapers

NONE

NONE

This call returns for the current authenticated user if they have an institute access role all the papers that have been proposed for the REF for their institute. The PUT, POST and DELETE methods are not available.

20.1.2. Templates

There are no templates used on this desktop.

20.1.3. Sequences

There are no sequences used on this desktop.

20.1.4. Locks

There are no locks used on this desktop.

20.2. REF (Admin)

UUID

des-94a24a74-a0c3-4c53-82fd-30eb7ba1ed95

Desktop Name

REF (Admin)

Explicit Cluster Membership

NONE

Description

This desktop is a TheonUI desktop and encapsulates the administrative functionality of the Referee service.

20.2.1. Panels

The following are the panels on this desktop in presentational order.

Name Parent Related By Description

Paper

NONE

NONE

This panel lists for the current authenticated user if they have an administrative role all the proposed papers for the REF. This panel can be used to update the content of the Chosen field. This panel can also be used to assign raters and moderaters to each paper and to review the overall status.

Person

NONE

NONE

This panel lists for the current authenticated user if they have an administrative role all the staff for the local unit. This panel can be usedto update the content of the Eligible, Rater and Moderater fields. Only staff that have Eligible set/checked are shown by default. The list is ordered by Lastname.

Submitter

NONE

NONE

This panel lists for the current authenticated user if they have an administrative role all the submitters of papers for the REF. This panel can be used to update the first and second rater and the moderater for all of the submitters papers.

Institute

NONE

NONE

This panel lists for the current authenticated user if they have an administrative role all the organisations submitters of papers for the REF can be associated with. This panel can be used to add specific organisations to recognise with a local abbreviation for the organisation and to flag whether the organisation is relevant to include in other places.

Overview

NONE

NONE

This panel lists for the current authenticated user if they have an administrative role all the proposed papers for the REF. This panel can be used to review the overall status.

20.2.2. Templates

The following are the templates used on this desktop.

Desktop Panel Type Field Rule Value Slice Properties

Submitter

COMPARISON OF

9 - Eligible?

IS EQ TO

TRUE

AT ALL TIMES

Submitter

COMPARISON OF

10 - Rater?

IS EQ TO

TRUE

AT ALL TIMES

Submitter

COMPARISON OF

14 - Eligible?

IS EQ TO

TRUE

AT ALL TIMES

Submitter

COMPARISON OF

15 - Rater?

IS EQ TO

TRUE

AT ALL TIMES

Submitter

COMPARISON OF

20 - Eligible?

IS EQ TO

TRUE

AT ALL TIMES

Submitter

COMPARISON OF

21 - Moderater?

IS EQ TO

TRUE

AT ALL TIMES

Paper

COMPARISON OF

26 - Eligible?

IS EQ TO

TRUE

IN LOOKUP

Paper

COMPARISON OF

27 - Rater?

IS EQ TO

TRUE

IN LOOKUP

Paper

COMPARISON OF

33 - Eligible?

IS EQ TO

TRUE

IN LOOKUP

Paper

COMPARISON OF

34 - Moderater?

IS EQ TO

TRUE

IN LOOKUP

Person

COMPARISON OF

6 - Eligible?

IS EQ TO

TRUE

AT ALL TIMES

20.2.3. Sequences

The following are the sequences used on this desktop.

Desktop Panel Type Field Slice Tier

Overview

UP ORDERING OF

6 - Lastname

AT ALL TIMES

1

Submitter

UP ORDERING OF

1 - Submitter Lastname

AT ALL TIMES

1

Submitter

UP ORDERING OF

8 - ? Rater

IN LOOKUP

NONE

Submitter

UP ORDERING OF

13 - ? Rater

IN LOOKUP

NONE

Submitter

UP ORDERING OF

19 - ? Moderater

IN LOOKUP

NONE

Paper

UP ORDERING OF

2 - Submitter Lastname

AT ALL TIMES

1

Paper

UP ORDERING OF

25 - ? Lastname

IN LOOKUP

NONE

Paper

UP ORDERING OF

32 - ? Lastname

IN LOOKUP

NONE

Person

UP ORDERING OF

3 - Lastname

AT ALL TIMES

1

Institute

UP ORDERING OF

1 - Organisation Name

AT ALL TIMES

1

Institute

UP ORDERING OF

6 - ? Director

IN LOOKUP

NONE

Institute

UP ORDERING OF

9 - ? Deputy Director

IN LOOKUP

NONE

20.2.4. Locks

There are no locks used on this desktop.

20.3. REF (Institute)

UUID

des-7f05635f-1cb8-40b9-a74e-56df19ec7af5

Desktop Name

REF (Institute)

Explicit Cluster Membership

NONE

Description

This desktop is a TheonUI desktop and encapsulates the institute directorship user functionality of the Referee service.

20.3.1. Panels

The following are the panels on this desktop in presentational order.

Name Parent Related By Description

MyInstitutePapers

NONE

NONE

This read only panel lists for the current authenticated user if they have an institute director role all the proposed papers for the REF for their institute.

Overview

NONE

NONE

This panel lists for the current authenticated user if they have an administrative role all the proposed papers for the REF for the institute they are a director or deputy director of. This panel can be used to review the overall status.

20.3.2. Templates

There are no templates used on this desktop.

20.3.3. Sequences

The following are the sequences used on this desktop.

Desktop Panel Type Field Slice Tier

MyInstitutePapers

UP ORDERING OF

2 - Submitter Lastname

AT ALL TIMES

1

Overview

UP ORDERING OF

4 - Lastname

AT ALL TIMES

1

20.3.4. Locks

There are no locks used on this desktop.

20.4. REF (User)

UUID

des-061b4dd9-2699-46cf-9f6a-367dad366b7b

Desktop Name

REF (User)

Explicit Cluster Membership

NONE

Description

This desktop is a TheonUI desktop and encapsulates the ordinary REF eligible user functionality of the Referee service.

20.4.1. Panels

The following are the panels on this desktop in presentational order.

Name Parent Related By Description

MyPapers

NONE

NONE

This panel lists for the current authenticated user the papers that they have proposed for the REF submission. It is entirely read only.

PapersToRate

NONE

NONE

This panel lists for the current authenticated user all the papers that they have been assigned to review and rate. It is entirely read only apart from the MyRating and MyComment fields.

PapersToModerate

NONE

NONE

This panel lists for the current authenticated user all the papers that they have been assigned to moderated. It is entirely read only apart from the MyRating and MyComment fields.

20.4.2. Templates

There are no templates used on this desktop.

20.4.3. Sequences

The following are the sequences used on this desktop.

Desktop Panel Type Field Slice Tier

PapersToRate

UP ORDERING OF

4 - Lastname

AT ALL TIMES

1

PapersToRate

UP ORDERING OF

7 - Rank

AT ALL TIMES

2

MyPapers

UP ORDERING OF

2 - Rank

AT ALL TIMES

1

PapersToModerate

UP ORDERING OF

6 - Lastname

AT ALL TIMES

1

PapersToModerate

UP ORDERING OF

9 - Rank

AT ALL TIMES

2

20.4.4. Locks

There are no locks used on this desktop.

20.5. REF (User) [Reduced]

UUID

des-bbbfcf94-f5fa-4865-95b1-3adabaa09ff2

Desktop Name

REF (User) [Reduced]

Explicit Cluster Membership

TheonUI Reduced Desktops

Description

This desktop is a TheonUI desktop and encapsulates the ordinary REF eligible user functionality of the Referee service. This desktop is specifically designed for smaller screens.

20.5.1. Panels

The following are the panels on this desktop in presentational order.

Name Parent Related By Description

Papers2Rate[R]

NONE

NONE

This panel lists for the current authenticated user all the papers that they have been assigned to review and rate. It is entirely read only apart from the MyRating and MyComment fields. This panel has been designed specifically for reduced screen sizes,

20.5.2. Templates

There are no templates used on this desktop.

20.5.3. Sequences

The following are the sequences used on this desktop.

Desktop Panel Type Field Slice Tier

Papers2Rate[R]

UP ORDERING OF

4 - Lastname

AT ALL TIMES

1

Papers2Rate[R]

UP ORDERING OF

7 - Rank

AT ALL TIMES

2

20.5.4. Locks

There are no locks used on this desktop.

Chapter 21. Panels

21.1. Institute

UUID

pan-e435bce1-97e3-46e8-9a3d-10da68fd736e

Panel Name

Institute

Base Entity

Institute

Base Selector

NONE

Properties

Desktop Usage

REF (Admin)

Description

This panel lists for the current authenticated user if they have an administrative role all the organisations submitters of papers for the REF can be associated with. This panel can be used to add specific organisations to recognise with a local abbreviation for the organisation and to flag whether the organisation is relevant to include in other places.

21.1.1. Connectors

The following are the connectors used on this panel in depth first order.

Name Type From On Connector To Using Selector Properties

0.1 - Director

REVERSELOOKUP

Institute

NONE

Person

institute_director_person

0.2 - DeputyDirector

REVERSELOOKUP

Institute

NONE

Person

institute_deputy_director_person

21.1.2. Presenters

The following are the presenters used on this panel in presentational order.

Type Span Field Reference Forced Width Row Tag Tier Properties Description

PANELGRID

ALL(9)

Field

Reference

Forced Width

Row Tag Tier

Properties

Description

1 - Organisation Name

institute.organisation

80

NONE

Full name of the organisation as it is defined in PURE. Must match as used to determine affiliations automatically,

2 - Abbreviation

institute.label

20

NONE

Short acronym for the institute.

3 - Include?

institute.research

NONE

NONE

Flag indicating that this organisation is a research institute. More generally it indicates whether this organisation is included in any display of affiliated institutes for a submitter.

4 - DirectorPersonID

institute.person_id

NONE

NONE

WITH_HIDDEN

The unique person identifier for the person that is the Director of the Institute, taken from the Person table.

5 - PersonID

{0.1 - Director}:person.id

NONE

NONE

WITH_HIDDEN WITH_PRESERVE

Unique identifier for the person within the Referee system. This identifier is automatically generated and read only. It does not correspond to any other person identifier.

6 - ? Director

{0.1 - Director}:person.lastname

NONE

NONE

WITH_CHOICE_DROPDOWN

The last name (surname) for the member of staff. The Referee system makes this field read only to all users as it is expected to be fed in by the PURE1AC stream.

7 - DeputyDirectorPersonID

institute.dep_person_id

NONE

NONE

WITH_HIDDEN

The unique person identifier for the person that is the Deputy Director of the Institute, taken from the Person table.

8 - PersonID

{0.2 - DeputyDirector}:person.id

NONE

NONE

WITH_HIDDEN WITH_PRESERVE

Unique identifier for the person within the Referee system. This identifier is automatically generated and read only. It does not correspond to any other person identifier.

9 - ? Deputy Director

{0.2 - DeputyDirector}:person.lastname

NONE

NONE

WITH_CHOICE_DROPDOWN

The last name (surname) for the member of staff. The Referee system makes this field read only to all users as it is expected to be fed in by the PURE1AC stream.

21.2. InstitutePapers

UUID

pan-0bfd3622-bdeb-489d-bdfd-d59047dcd95d

Panel Name

InstitutePapers

Base Entity

Status (Institute Access)

Base Selector

Properties

WITHOUT_APPEND WITHOUT_DELETE

Desktop Usage

API

Description

This call returns for the current authenticated user if they have an institute access role all the papers that have been proposed for the REF for their institute. The PUT, POST and DELETE methods are not available.

21.2.1. Connectors

There are no connectors used on this panel.

21.2.2. Presenters

The following are the presenters used on this panel in presentational order.

Type Span Field Reference Forced Width Row Tag Tier Properties Description

CELL

ONE(1)

1 - Abstract

status_institute_access.abstract

NONE

NONE

The full textual abstract of the paper which should be an exact content of what is in PURE, however any non-textual content may well be lost or mangled due to the feed process.

CELL

ONE(1)

2 - Chosen?

status_institute_access.chosen

NONE

NONE

This value should be set (checked) by administrative users after the paper has been reviewed (by raters and moderaters) and it has been decided that it should be in included in the REF submission.

CELL

ONE(1)

3 - Double Weighted?

status_institute_access.double_weight

NONE

NONE

Flag indicating whether the proposed paper should be double weighted for the REF submission.

CELL

ONE(1)

4 - Firstname

status_institute_access.firstname

NONE

NONE

The first name (given name or known-as name) for the member of staff. The Referee system makes this field read only to all users as it is expected to be fed in by the PURE1AC stream.

CELL

ONE(1)

5 - PaperID

status_institute_access.id

NONE

NONE

Unique identifier for the paper within the Referee system. This identifier is automatically generated and read only. It does not correspond to any other paper identifier.

CELL

ONE(1)

6 - Lastname

status_institute_access.lastname

NONE

NONE

The last name (surname) for the member of staff. The Referee system makes this field read only to all users as it is expected to be fed in by the PURE1AC stream.

CELL

ONE(1)

7 - Moderaters Result

status_institute_access.moderated_rank

NONE

NONE

This will be "Differs" when the average value (as a floating point number) of the ratings given by the raters is distinct from the average value (as a floating point number) given by the moderater, and will be "Average" otherwise. It will be empty if one or both raters have not entered a rank or if the moderater has not entered a rank. This field can be used to show where the moderation process has resulted in a rating divergent from the original rating for subsequent cross checking prior to choosing the paper for submission. The rater ranks are mapped to a number in order to calculate the average. This is based on thirds, so 1 is 1, 1- is (1 - 1/3) and 1+ is (1 + 1/3), 0 is mapped to 1/3.

CELL

ONE(1)

8 - Moderaters Done

status_institute_access.moderaters_done

NONE

NONE

Calculated value which shows the number of moderaters that have been assigned to review and rate the paper (normally 1) and of those the number that have actually entered a rating value for the paper. This is presented as "X/Y" where X is the number of moderaters that have rated the paper and Y is the number of moderaters the paper has. For example: "0/0" is no moderaters assigned; "0/2" is 2 moderaters assigned but none have given a rating yet; "1/2" means one moderater has given a rating; "2/2" is both (all) moderaters have given a rating. Normally a paper should not be chosen for submission until this last state has been reached (when X = Y != 0).

CELL

ONE(1)

9 - Moderaters Rating and Name

status_institute_access.moderaters_rating

NONE

NONE

Calculated value which shows a list (slash separated) all the ratings assigned to a paper and the corresponding moderater surnames. For example "1(Bloggs)/3(Doe)" shows that "Bloggs" rated the paper "1" and "Doe" rated the paper "3". Only moderaters that have entered a rating will be listed so the value will be blank if none have done so.

CELL

ONE(1)

10 - Moderaters Comment

status_institute_access.moderaters_comment

NONE

NONE

Value which shows the moderaters comment assigned to a paper. Only if the moderater has entered a comment will they be listed so the value will be blank if they have not done so.

CELL

ONE(1)

11 - Result

status_institute_access.result

NONE

NONE

Following completion of review this value will indicate the best rated paper (based on moderated rating) for each submitter. Where a submitter has multiple papers rater the same then the one that the submitter ranked highest will be indicated as the best. Where the submitter has used the same ranking more than once then the one indicated as the best will be effectively random.

CELL

ONE(1)

12 - Paper URL

status_institute_access.pure_url

NONE

NONE

Direct link to the online copy of the paper. This is a URL which is a direct link to the local copy of the paper held in PURE, and is what is used as the paper download link from the corresponding entry on Edinburgh Research Explorer. This copy of the paper should always be accessible to local staff for review, unlike the DOI URL or published location which may not always be open access.

CELL

ONE(1)

13 - ERE URL

status_institute_access.ere_url

NONE

NONE

Direct link to the web page for the paper in Edinburgh Research Explorer. This page (and download link) for the paper should always be accessible to local staff for review, unlike the DOI URL or published location which may not always be open access.

CELL

ONE(1)

14 - DOI URL

status_institute_access.doi_url

NONE

NONE

Link to the copy of the paper held in the ACM Digital Library for Edinburgh.

CELL

ONE(1)

15 - Rank

status_institute_access.rank

NONE

NONE

Rating assigned to the paper after review. This will be a value of 0, 1, 1-, 1+, 2, 2-, 2+, 3, 3-, 3+, 4, 4- or 4+. Do not use N*. Any value other than a number between 0 and 4 (where 1 to 4 can optionally be suffixed with plus or minus) entered in this field will be rejected with a check constraint error.

CELL

ONE(1)

16 - Raters Done

status_institute_access.raters_done

NONE

NONE

Calculated value which shows the number of raters that have been assigned to review and rate the paper (normally 2) and of those the number that have actually entered a rating value for the paper. This is presented as "X/Y" where X is the number of raters that have rated the paper and Y is the number of raters the paper has. For example: "0/0" is no raters assigned; "0/2" is 2 raters assigned but none have given a rating yet; "1/2" means one rater has given a rating; "2/2" is both (all) raters have given a rating. Normally a moderation would not take place until this state has been reached (when X = Y != 0).

CELL

ONE(1)

17 - Rater1 Rating and Name

status_institute_access.rater1_rating

NONE

NONE

Calculated value which shows the first raters rating assigned to a paper and the corresponding rater surname, subsequently used in the moderation process. For example "1 (Bloggs)" shows that "Bloggs" rated the paper "1". Only if the first rater has entered a rating will they be listed so the value will be blank if they have not done so.

CELL

ONE(1)

18 - Rater1 Comment

status_institute_access.rater1_comment

NONE

NONE

Value which shows the first raters comment assigned to a paper. Only if the first rater has entered a comment will they be listed so the value will be blank if they have not done so.

CELL

ONE(1)

19 - Rater2 Rating and Name

status_institute_access.rater2_rating

NONE

NONE

Calculated value which shows the second raters rating assigned to a paper and the corresponding rater surname, subsequently used in the moderation process. For example "1 (Bloggs)" shows that "Bloggs" rated the paper "1". Only if the second rater has entered a rating will they be listed so the value will be blank if they have not done so.

CELL

ONE(1)

20 - Rater2 Comment

status_institute_access.rater2_comment

NONE

NONE

Value which shows the second raters comment assigned to a paper. Only if the second rater has entered a comment will they be listed so the value will be blank if they have not done so.

CELL

ONE(1)

21 - Raters Result

status_institute_access.raters

NONE

NONE

If the first and second rater assigned ratings differ this will be "Disagree", otherwise if they are they same this will be "Agree". If one of the raters has not entered a rating yet this will be blank.

CELL

ONE(1)

22 - Reason

status_institute_access.reason

NONE

NONE

Reason given by the submitter for proposing the paper be added to the REF submission.

CELL

ONE(1)

23 - Title

status_institute_access.title

NONE

NONE

The full title of the paper.

CELL

ONE(1)

24 - APA

status_institute_access.apa

NONE

NONE

The APA (American Psychological Association) formatted citation string for the paper. This contains more detail then seems to be available otherwise in individual fields in terms of publisher and year.

21.3. Institutes

UUID

pan-c1251310-190d-43fe-a082-7ed9e222e98d

Panel Name

Institutes

Base Entity

Institute

Base Selector

Properties

Desktop Usage

API

Description

This call returns for the current authenticated user if they have an administrative role all the organisations that can be associated with submitters. This call can be used to change (PUT) the local label (usually a short acronym) to use for the organisation and to indicate whether the organisation is relevant and to be shown where appropriate against that user (for example the submitter School is not normally shown but the submitter research institute affiliation would be). The POST method can be used to add an entirely new organisation and the DELETE methods can be used to remove organisations that are no longer applicable.

21.3.1. Connectors

There are no connectors used on this panel.

21.3.2. Presenters

The following are the presenters used on this panel in presentational order.

Type Span Field Reference Forced Width Row Tag Tier Properties Description

CELL

ONE(1)

1 - Organisation

institute.organisation

NONE

NONE

Full name of the organisation as it is defined in PURE. Must match as used to determine affiliations automatically,

CELL

ONE(1)

2 - Label

institute.label

NONE

NONE

Short acronym for the institute.

CELL

ONE(1)

3 - Research?

institute.research

NONE

NONE

Flag indicating that this organisation is a research institute. More generally it indicates whether this organisation is included in any display of affiliated institutes for a submitter.

CELL

ONE(1)

4 - DirectorPersonID

institute.person_id

NONE

NONE

The unique person identifier for the person that is the Director of the Institute, taken from the Person table.

CELL

ONE(1)

5 - DeputyDirectorPersonID

institute.dep_person_id

NONE

NONE

The unique person identifier for the person that is the Deputy Director of the Institute, taken from the Person table.

21.4. Moderaters

UUID

pan-e8222d9b-66db-43a5-b953-f4284692fdeb

Panel Name

Moderaters

Base Entity

Moderater

Base Selector

Properties

Desktop Usage

API

Description

This call returns for the current authenticated user if they have an administrative role all the moderater instances of the governing context. The governing context can be a paper (so returning list of moderater instances for that paper) or staff (so returning list of moderater instances for that member of staff). This call can be used with paper ID (paper context) to change (PUT) the content of the person ID field (and also the Rating or Comment field) or to add (POST) an entirely new instance for a person ID, the updated record is returned. This call can be used with person ID (staff context) to change (PUT) the content of the paper ID field (and also the Rating or Comment field) or to add (POST) an entirely new instance for a paper ID, the updated record is returned. The DELETE method can be used with the moderater instance ID outside of any governing context.

21.4.1. Connectors

There are no connectors used on this panel.

21.4.2. Presenters

The following are the presenters used on this panel in presentational order.

Type Span Field Reference Forced Width Row Tag Tier Properties Description

CELL

ONE(1)

1 - Comment

moderater.comment

NONE

NONE

Free form comment from the rater - this might be to explain the reasoning behind a particular rating or to suggest changes to the paper proposal reason.

CELL

ONE(1)

2 - ModeraterID

moderater.id

NONE

NONE

Unique identifier for the moderater/paper association within the Referee system. This identifier is automatically generated and read only.

CELL

ONE(1)

3 - PaperID

moderater.paper_id

NONE

NONE

The unique paper identifier for the paper the person has been assigned to rate, taken from the Paper table.

CELL

ONE(1)

4 - PersonID

moderater.person_id

NONE

NONE

The unique person identifier for the person assigned to rate the paper, taken from the Person table.

CELL

ONE(1)

5 - Rank

moderater.rank

NONE

NONE

Rating assigned to the paper after review. This will be a value of 0, 1, 1-, 1+, 2, 2-, 2+, 3, 3-, 3+, 4, 4- or 4+. Do not use N*. Any value other than a number between 0 and 4 (where 1 to 4 can optionally be suffixed with plus or minus) entered in this field will be rejected with a check constraint error.

21.5. MyInstitutePapers

UUID

pan-20ff2b38-8ad2-4f27-91c9-fac5ff6d84a5

Panel Name

MyInstitutePapers

Base Entity

Paper (Institute Access)

Base Selector

SCROLL

Properties

WITHOUT_APPEND WITHOUT_DELETE

Desktop Usage

REF (Institute)

Description

This read only panel lists for the current authenticated user if they have an institute director role all the proposed papers for the REF for their institute.

21.5.1. Connectors

The following are the connectors used on this panel in depth first order.

Name Type From On Connector To Using Selector Properties

0.1 - Submitter

REVERSE

Paper (Institute Access)

NONE

Person (Institute Access)

institutepaper_submitter_person

0.2 - Status

FORWARD

Paper (Institute Access)

NONE

Status (Institute Access)

status_institutepaper

21.5.2. Presenters

The following are the presenters used on this panel in presentational order.

Type Span Field Reference Forced Width Row Tag Tier Properties Description

CELL

ONE(1)

1 - PaperID

paper_institute_access.id

10

NONE

WITH_READONLY

Unique identifier for the paper within the Referee system. This identifier is automatically generated and read only. It does not correspond to any other paper identifier.

CELL

ONE(1)

2 - Submitter Lastname

{0.1 - Submitter}:person_institute_access.lastname

40

NONE

WITH_READONLY

The last name (surname) for the member of staff. The Referee system makes this field read only to all users as it is expected to be fed in by the PURE1AC stream.

CELL

ONE(1)

3 - Submitter Firstname

{0.1 - Submitter}:person_institute_access.firstname

40

NONE

WITH_READONLY

The first name (given name or known-as name) for the member of staff. The Referee system makes this field read only to all users as it is expected to be fed in by the PURE1AC stream.

CELL

ONE(1)

4 - PURE ID

paper_institute_access.pure_id

5

NONE

WITH_READONLY

The unique PURE paper number used as a handle for the PURE2 stream.

CELL

ONE(1)

5 - Paper Title

paper_institute_access.title

80

NONE

WITH_READONLY

The full title of the paper.

CELL

ONE(1)

6 - APA Citation

paper_institute_access.apa

120

NONE

WITH_READONLY

The APA (American Psychological Association) formatted citation string for the paper. This contains more detail then seems to be available otherwise in individual fields in terms of publisher and year.

CELL

ONE(1)

7 - Paper Abstract

paper_institute_access.abstract

120

NONE

WITH_READONLY

The full textual abstract of the paper. Any non-textual content will likely be lost or mangled in some way.

CELL

ONE(1)

8 - Rank

paper_institute_access.rank

5

NONE

WITH_READONLY

Rating given to the paper by the submitter on proposal. This value of this will be from 1st to 6th or Alternate.

CELL

ONE(1)

9 - Reason

paper_institute_access.reason

120

NONE

WITH_READONLY

Reason given by the submitter for proposing the paper be added to the REF submission.

CELL

ONE(1)

10 - PURE URL

paper_institute_access.pure_url

80

NONE

WITH_READONLY

Direct link to the online copy of the paper. This is a URL which is a direct link to the local copy of the paper held in PURE, and is what is used as the paper download link from the corresponding entry on Edinburgh Research Explorer. This copy of the paper should always be accessible to local staff for review, unlike the DOI URL or published location which may not always be open access.

CELL

ONE(1)

11 - ERE URL

paper_institute_access.ere_url

80

NONE

WITH_READONLY

Direct link to the web page for the paper in Edinburgh Research Explorer. This page (and download link) for the paper should always be accessible to local staff for review, unlike the DOI URL or published location which may not always be open access.

CELL

ONE(1)

12 - DOI URL

paper_institute_access.doi_url

80

NONE

WITH_READONLY

Link to the copy of the paper held in the ACM Digital Library for Edinburgh.

CELL

ONE(1)

13 - Chosen?

paper_institute_access.chosen

NONE

NONE

WITH_READONLY

This value should be set (checked) by administrative users after the paper has been reviewed (by raters and moderaters) and it has been decided that it should be in included in the REF submission.

CELL

ONE(1)

14 - Raters: Done/Count

{0.2 - Status}:status_institute_access.raters_done

5

NONE

WITH_READONLY

Calculated value which shows the number of raters that have been assigned to review and rate the paper (normally 2) and of those the number that have actually entered a rating value for the paper. This is presented as "X/Y" where X is the number of raters that have rated the paper and Y is the number of raters the paper has. For example: "0/0" is no raters assigned; "0/2" is 2 raters assigned but none have given a rating yet; "1/2" means one rater has given a rating; "2/2" is both (all) raters have given a rating. Normally a moderation would not take place until this state has been reached (when X = Y != 0).

CELL

ONE(1)

15 - Rater1: Rating (Name)

{0.2 - Status}:status_institute_access.rater1_rating

5

NONE

WITH_READONLY

Calculated value which shows the first raters rating assigned to a paper and the corresponding rater surname, subsequently used in the moderation process. For example "1 (Bloggs)" shows that "Bloggs" rated the paper "1". Only if the first rater has entered a rating will they be listed so the value will be blank if they have not done so.

CELL

ONE(1)

16 - Rater1: Comment

{0.2 - Status}:status_institute_access.rater1_comment

80

NONE

WITH_READONLY

Value which shows the first raters comment assigned to a paper. Only if the first rater has entered a comment will they be listed so the value will be blank if they have not done so.

CELL

ONE(1)

17 - Rater2: Rating (Name)

{0.2 - Status}:status_institute_access.rater2_rating

5

NONE

WITH_READONLY

Calculated value which shows the second raters rating assigned to a paper and the corresponding rater surname, subsequently used in the moderation process. For example "1 (Bloggs)" shows that "Bloggs" rated the paper "1". Only if the second rater has entered a rating will they be listed so the value will be blank if they have not done so.

CELL

ONE(1)

18 - Rater2: Comment

{0.2 - Status}:status_institute_access.rater2_comment

80

NONE

WITH_READONLY

Value which shows the second raters comment assigned to a paper. Only if the second rater has entered a comment will they be listed so the value will be blank if they have not done so.

CELL

ONE(1)

19 - Raters:

{0.2 - Status}:status_institute_access.raters

5

NONE

WITH_READONLY

If the first and second rater assigned ratings differ this will be "Disagree", otherwise if they are they same this will be "Agree". If one of the raters has not entered a rating yet this will be blank.

CELL

ONE(1)

20 - Moderaters: Done/Count

{0.2 - Status}:status_institute_access.moderaters_done

5

NONE

WITH_READONLY

Calculated value which shows the number of moderaters that have been assigned to review and rate the paper (normally 1) and of those the number that have actually entered a rating value for the paper. This is presented as "X/Y" where X is the number of moderaters that have rated the paper and Y is the number of moderaters the paper has. For example: "0/0" is no moderaters assigned; "0/2" is 2 moderaters assigned but none have given a rating yet; "1/2" means one moderater has given a rating; "2/2" is both (all) moderaters have given a rating. Normally a paper should not be chosen for submission until this last state has been reached (when X = Y != 0).

CELL

ONE(1)

21 - Moderaters: Rating (Name)

{0.2 - Status}:status_institute_access.moderaters_rating

5

NONE

WITH_READONLY

Calculated value which shows a list (slash separated) all the ratings assigned to a paper and the corresponding moderater surnames. For example "1(Bloggs)/3(Doe)" shows that "Bloggs" rated the paper "1" and "Doe" rated the paper "3". Only moderaters that have entered a rating will be listed so the value will be blank if none have done so.

CELL

ONE(1)

22 - Moderaters: Comment

{0.2 - Status}:status_institute_access.moderaters_comment

80

NONE

WITH_READONLY

Value which shows the moderaters comment assigned to a paper. Only if the moderater has entered a comment will they be listed so the value will be blank if they have not done so.

CELL

ONE(1)

23 - Moderaters:

{0.2 - Status}:status_institute_access.moderated_rank

5

NONE

WITH_READONLY

This will be "Differs" when the average value (as a floating point number) of the ratings given by the raters is distinct from the average value (as a floating point number) given by the moderater, and will be "Average" otherwise. It will be empty if one or both raters have not entered a rank or if the moderater has not entered a rank. This field can be used to show where the moderation process has resulted in a rating divergent from the original rating for subsequent cross checking prior to choosing the paper for submission. The rater ranks are mapped to a number in order to calculate the average. This is based on thirds, so 1 is 1, 1- is (1 - 1/3) and 1+ is (1 + 1/3), 0 is mapped to 1/3.

CELL

ONE(1)

24 - Result

{0.2 - Status}:status_institute_access.result

16

NONE

WITH_READONLY

Following completion of review this value will indicate the best rated paper (based on moderated rating) for each submitter. Where a submitter has multiple papers rater the same then the one that the submitter ranked highest will be indicated as the best. Where the submitter has used the same ranking more than once then the one indicated as the best will be effectively random.

21.6. MyPapers

UUID

pan-cee24f66-cc86-4216-9930-e1e7e0137e47

Panel Name

MyPapers

Base Entity

SubmitterPapers (Access)

Base Selector

NONE

Properties

WITHOUT_APPEND WITHOUT_DELETE

Desktop Usage

REF (User)

Description

This panel lists for the current authenticated user the papers that they have proposed for the REF submission. It is entirely read only.

21.6.1. Connectors

There are no connectors used on this panel.

21.6.2. Presenters

The following are the presenters used on this panel in presentational order.

Type Span Field Reference Forced Width Row Tag Tier Properties Description

PANELGRID

ALL(10)

Field

Reference

Forced Width

Row Tag Tier

Properties

Description

1 - PaperID

paper_access.id

5

NONE

WITH_READONLY

Unique identifier for the paper within the Referee system. This identifier is automatically generated and read only. It does not correspond to any other paper identifier.

2 - Rank

paper_access.rank

5

NONE

WITH_READONLY

Rating given to the paper by the submitter on proposal. This value of this will be from 1st to 6th or Alternate.

3 - Title

paper_access.title

80

NONE

WITH_READONLY

The full title of the paper.

4 - URL

paper_access.pure_url

80

NONE

WITH_READONLY

Direct link to the online copy of the paper. This is a URL which is a direct link to the local copy of the paper held in PURE, and is what is used as the paper download link from the corresponding entry on Edinburgh Research Explorer. This copy of the paper should always be accessible to local staff for review, unlike the DOI URL or published location which may not always be open access.

5 - DblWt?

paper_access.double_weight

5

NONE

WITH_READONLY

Flag indicating whether the proposed paper should be double weighted for the REF submission.

6 - Reason for Submission

paper_access.reason

120

NONE

WITH_READONLY

Reason given by the submitter for proposing the paper be added to the REF submission.

7 - APA Citation

paper_access.apa

120

NONE

WITH_READONLY

The APA (American Psychological Association) formatted citation string for the paper. This contains more detail then seems to be available otherwise in individual fields in terms of publisher and year.

8 - Abstract

paper_access.abstract

120

NONE

WITH_READONLY

The full textual abstract of the paper. Any non-textual content will likely be lost or mangled in some way.

9 - ERE URL

paper_access.ere_url

80

NONE

WITH_READONLY

Direct link to the web page for the paper in Edinburgh Research Explorer. This page (and download link) for the paper should always be accessible to local staff for review, unlike the DOI URL or published location which may not always be open access.

10 - DOI URL

paper_access.doi_url

80

NONE

WITH_READONLY

Link to the copy of the paper held in the ACM Digital Library for Edinburgh.

21.7. Overview

UUID

pan-b9fc9d0f-958c-4885-bf9b-69a8a952c620

Panel Name

Overview

Base Entity

Paper (Institute Access)

Base Selector

NONE

Properties

WITHOUT_APPEND WITHOUT_DELETE

Desktop Usage

REF (Institute)

Description

This panel lists for the current authenticated user if they have an administrative role all the proposed papers for the REF for the institute they are a director or deputy director of. This panel can be used to review the overall status.

21.7.1. Connectors

The following are the connectors used on this panel in depth first order.

Name Type From On Connector To Using Selector Properties

0.1 - Submitter

REVERSE

Paper (Institute Access)

NONE

Person (Institute Access)

institutepaper_submitter_person

0.2 - Status

REVERSE

Paper (Institute Access)

NONE

Status (Institute Access)

institutepaper_status

21.7.2. Presenters

The following are the presenters used on this panel in presentational order.

Type Span Field Reference Forced Width Row Tag Tier Properties Description

PANELGRID

ALL(17)

Field

Reference

Forced Width

Row Tag Tier

Properties

Description

1 - PaperID

paper_institute_access.id

5

NONE

WITH_READONLY

Unique identifier for the paper within the Referee system. This identifier is automatically generated and read only. It does not correspond to any other paper identifier.

2 - PureID

paper_institute_access.pure_id

5

NONE

WITH_READONLY

The unique PURE paper number used as a handle for the PURE2 stream.

3 - Email Address

{0.1 - Submitter}:person_institute_access.email

40

NONE

WITH_READONLY

Email address of REF eligible staff member.

4 - Lastname

{0.1 - Submitter}:person_institute_access.lastname

30

NONE

WITH_READONLY

The last name (surname) for the member of staff. The Referee system makes this field read only to all users as it is expected to be fed in by the PURE1AC stream.

5 - Firstname

{0.1 - Submitter}:person_institute_access.firstname

20

NONE

WITH_READONLY

The first name (given name or known-as name) for the member of staff. The Referee system makes this field read only to all users as it is expected to be fed in by the PURE1AC stream.

6 - Rank

paper_institute_access.rank

5

NONE

WITH_READONLY

Rating given to the paper by the submitter on proposal. This value of this will be from 1st to 6th or Alternate.

7 - Raters Done/Count

{0.2 - Status}:status_institute_access.raters_done

5

NONE

WITH_READONLY

Calculated value which shows the number of raters that have been assigned to review and rate the paper (normally 2) and of those the number that have actually entered a rating value for the paper. This is presented as "X/Y" where X is the number of raters that have rated the paper and Y is the number of raters the paper has. For example: "0/0" is no raters assigned; "0/2" is 2 raters assigned but none have given a rating yet; "1/2" means one rater has given a rating; "2/2" is both (all) raters have given a rating. Normally a moderation would not take place until this state has been reached (when X = Y != 0).

8 - Rater1 Rating (Name)

{0.2 - Status}:status_institute_access.rater1_rating

5

NONE

WITH_READONLY

Calculated value which shows the first raters rating assigned to a paper and the corresponding rater surname, subsequently used in the moderation process. For example "1 (Bloggs)" shows that "Bloggs" rated the paper "1". Only if the first rater has entered a rating will they be listed so the value will be blank if they have not done so.

9 - Rater2 Rating (Name)

{0.2 - Status}:status_institute_access.rater2_rating

5

NONE

WITH_READONLY

Calculated value which shows the second raters rating assigned to a paper and the corresponding rater surname, subsequently used in the moderation process. For example "1 (Bloggs)" shows that "Bloggs" rated the paper "1". Only if the second rater has entered a rating will they be listed so the value will be blank if they have not done so.

10 - Raters

{0.2 - Status}:status_institute_access.raters

5

NONE

WITH_READONLY

If the first and second rater assigned ratings differ this will be "Disagree", otherwise if they are they same this will be "Agree". If one of the raters has not entered a rating yet this will be blank.

11 - Mod Done/Count

{0.2 - Status}:status_institute_access.moderaters_done

5

NONE

WITH_READONLY

Calculated value which shows the number of moderaters that have been assigned to review and rate the paper (normally 1) and of those the number that have actually entered a rating value for the paper. This is presented as "X/Y" where X is the number of moderaters that have rated the paper and Y is the number of moderaters the paper has. For example: "0/0" is no moderaters assigned; "0/2" is 2 moderaters assigned but none have given a rating yet; "1/2" means one moderater has given a rating; "2/2" is both (all) moderaters have given a rating. Normally a paper should not be chosen for submission until this last state has been reached (when X = Y != 0).

12 - Mod Rating (Name)

{0.2 - Status}:status_institute_access.moderaters_rating

5

NONE

WITH_READONLY

Calculated value which shows a list (slash separated) all the ratings assigned to a paper and the corresponding moderater surnames. For example "1(Bloggs)/3(Doe)" shows that "Bloggs" rated the paper "1" and "Doe" rated the paper "3". Only moderaters that have entered a rating will be listed so the value will be blank if none have done so.

13 - Mod Result

{0.2 - Status}:status_institute_access.moderated_rank

5

NONE

WITH_READONLY

This will be "Differs" when the average value (as a floating point number) of the ratings given by the raters is distinct from the average value (as a floating point number) given by the moderater, and will be "Average" otherwise. It will be empty if one or both raters have not entered a rank or if the moderater has not entered a rank. This field can be used to show where the moderation process has resulted in a rating divergent from the original rating for subsequent cross checking prior to choosing the paper for submission. The rater ranks are mapped to a number in order to calculate the average. This is based on thirds, so 1 is 1, 1- is (1 - 1/3) and 1+ is (1 + 1/3), 0 is mapped to 1/3.

14 - Result

{0.2 - Status}:status_institute_access.result

5

NONE

WITH_READONLY

Following completion of review this value will indicate the best rated paper (based on moderated rating) for each submitter. Where a submitter has multiple papers rater the same then the one that the submitter ranked highest will be indicated as the best. Where the submitter has used the same ranking more than once then the one indicated as the best will be effectively random.

15 - Chosen?

{0.2 - Status}:status_institute_access.chosen

NONE

NONE

This value should be set (checked) by administrative users after the paper has been reviewed (by raters and moderaters) and it has been decided that it should be in included in the REF submission.

16 - DOI URL

paper_institute_access.doi_url

60

NONE

WITH_READONLY

Link to the copy of the paper held in the ACM Digital Library for Edinburgh.

17 - Title

paper_institute_access.title

360

NONE

WITH_READONLY

The full title of the paper.

21.8. Overview

UUID

pan-4b091dde-b8e4-40a4-bf91-88f463ae6355

Panel Name

Overview

Base Entity

Paper

Base Selector

NONE

Properties

WITHOUT_APPEND WITHOUT_DELETE

Desktop Usage

REF (Admin)

Description

This panel lists for the current authenticated user if they have an administrative role all the proposed papers for the REF. This panel can be used to review the overall status.

21.8.1. Connectors

The following are the connectors used on this panel in depth first order.

Name Type From On Connector To Using Selector Properties

0.1 - Submitter

REVERSE

Paper

NONE

Person

paper_submitter_person

0.2 - Status

REVERSE

Paper

NONE

AdminPaper (Access)

paper_status

21.8.2. Presenters

The following are the presenters used on this panel in presentational order.

Type Span Field Reference Forced Width Row Tag Tier Properties Description

PANELGRID

ALL(20)

Field

Reference

Forced Width

Row Tag Tier

Properties

Description

1 - PaperID

paper.id

5

NONE

WITH_READONLY

Unique identifier for the paper within the Referee system. This identifier is automatically generated and read only. It does not correspond to any other paper identifier.

2 - PureID

paper.pure_id

5

NONE

WITH_READONLY

The unique PURE paper number used as a handle for the PURE2 stream.

3 - Created

paper._th_createdat

15

NONE

WITH_READONLY

NONE

4 - Deleted

paper._th_deletedat

15

NONE

WITH_READONLY

NONE

5 - Email Address

{0.1 - Submitter}:person.email

40

NONE

WITH_READONLY

Email address of REF eligible staff member.

6 - Lastname

{0.1 - Submitter}:person.lastname

30

NONE

WITH_READONLY

The last name (surname) for the member of staff. The Referee system makes this field read only to all users as it is expected to be fed in by the PURE1AC stream.

7 - Firstname

{0.1 - Submitter}:person.firstname

20

NONE

WITH_READONLY

The first name (given name or known-as name) for the member of staff. The Referee system makes this field read only to all users as it is expected to be fed in by the PURE1AC stream.

8 - Institute(s)

{0.1 - Submitter}:person.institute

10

NONE

WITH_READONLY

List of institute abbreviations that the person is affiliated with (only those defined to be included through the Institute table).

9 - Rank

paper.rank

5

NONE

WITH_READONLY

Rating given to the paper by the submitter on proposal. This value of this will be from 1st to 6th or Alternate.

10 - Raters Done/Count

{0.2 - Status}:paperupdate.raters_done

5

NONE

WITH_READONLY

Calculated value which shows the number of raters that have been assigned to review and rate the paper (normally 2) and of those the number that have actually entered a rating value for the paper. This is presented as "X/Y" where X is the number of raters that have rated the paper and Y is the number of raters the paper has. For example: "0/0" is no raters assigned; "0/2" is 2 raters assigned but none have given a rating yet; "1/2" means one rater has given a rating; "2/2" is both (all) raters have given a rating. Normally a moderation would not take place until this state has been reached (when X = Y != 0).

11 - Rater1 Rating (Name)

{0.2 - Status}:paperupdate.rater1_rating

5

NONE

WITH_READONLY

Calculated value which shows the first raters rating assigned to a paper and the corresponding rater surname, subsequently used in the moderation process. For example "1 (Bloggs)" shows that "Bloggs" rated the paper "1". Only if the first rater has entered a rating will they be listed so the value will be blank if they have not done so.

12 - Rater2 Rating (Name)

{0.2 - Status}:paperupdate.rater2_rating

5

NONE

WITH_READONLY

Calculated value which shows the second raters rating assigned to a paper and the corresponding rater surname, subsequently used in the moderation process. For example "1 (Bloggs)" shows that "Bloggs" rated the paper "1". Only if the second rater has entered a rating will they be listed so the value will be blank if they have not done so.

13 - Raters

{0.2 - Status}:paperupdate.raters

5

NONE

WITH_READONLY

If the first and second rater assigned ratings differ this will be "Disagree", otherwise if they are they same this will be "Agree". If one of the raters has not entered a rating yet this will be blank.

14 - Mod Done/Count

{0.2 - Status}:paperupdate.moderaters_done

5

NONE

WITH_READONLY

Calculated value which shows the number of moderaters that have been assigned to review and rate the paper (normally 1) and of those the number that have actually entered a rating value for the paper. This is presented as "X/Y" where X is the number of moderaters that have rated the paper and Y is the number of moderaters the paper has. For example: "0/0" is no moderaters assigned; "0/2" is 2 moderaters assigned but none have given a rating yet; "1/2" means one moderater has given a rating; "2/2" is both (all) moderaters have given a rating. Normally a paper should not be chosen for submission until this last state has been reached (when X = Y != 0).

15 - Mod Rating (Name)

{0.2 - Status}:paperupdate.moderaters_rating

5

NONE

WITH_READONLY

Calculated value which shows a list (slash separated) all the ratings assigned to a paper and the corresponding moderater surnames. For example "1(Bloggs)/3(Doe)" shows that "Bloggs" rated the paper "1" and "Doe" rated the paper "3". Only moderaters that have entered a rating will be listed so the value will be blank if none have done so.

16 - Mod Result

{0.2 - Status}:paperupdate.moderated_rank

5

NONE

WITH_READONLY

This will be "Differs" when the average value (as a floating point number) of the ratings given by the raters is distinct from the average value (as a floating point number) given by the moderater, and will be "Average" otherwise. It will be empty if one or both raters have not entered a rank or if the moderater has not entered a rank. This field can be used to show where the moderation process has resulted in a rating divergent from the original rating for subsequent cross checking prior to choosing the paper for submission. The rater ranks are mapped to a number in order to calculate the average. This is based on thirds, so 1 is 1, 1- is (1 - 1/3) and 1+ is (1 + 1/3), 0 is mapped to 1/3.

17 - Result

{0.2 - Status}:paperupdate.result

5

NONE

WITH_READONLY

Following completion of review this value will indicate the best rated paper (based on moderated rating) for each submitter. Where a submitter has multiple papers rater the same then the one that the submitter ranked highest will be indicated as the best. Where the submitter has used the same ranking more than once then the one indicated as the best will be effectively random.

18 - Chosen?

{0.2 - Status}:paperupdate.chosen

NONE

NONE

This value should be set (checked) by administrative users after the paper has been reviewed (by raters and moderaters) and it has been decided that it should be in included in the REF submission.

19 - DOI URL

paper.doi_url

60

NONE

WITH_READONLY

Link to the copy of the paper held in the ACM Digital Library for Edinburgh.

20 - Title

paper.title

360

NONE

WITH_READONLY

The full title of the paper.

21.9. Paper

UUID

pan-a3436e75-2eec-4b79-b09b-c6f4160d6ec3

Panel Name

Paper

Base Entity

Paper

Base Selector

SCROLL

Properties

WITHOUT_APPEND WITHOUT_DELETE

Desktop Usage

REF (Admin)

Description

This panel lists for the current authenticated user if they have an administrative role all the proposed papers for the REF. This panel can be used to update the content of the Chosen field. This panel can also be used to assign raters and moderaters to each paper and to review the overall status.

21.9.1. Connectors

The following are the connectors used on this panel in depth first order.

Name Type From On Connector To Using Selector Properties

0.1 - Submitter

REVERSE

Paper

NONE

Person

paper_submitter_person

0.2 - Status

FORWARD

Paper

NONE

AdminPaper (Access)

paperupdate_paper

0.3 - Raters

FORWARDNORMAL

Paper

NONE

Rater

rater_paper

0.3.1 - Rater Person

REVERSELOOKUP

Rater

0.3 - Raters

Person

rater_person

0.4 - Moderaters

FORWARDNORMAL

Paper

NONE

Moderater

moderater_paper

0.4.1 - Moderater Person

REVERSELOOKUP

Moderater

0.4 - Moderaters

Person

moderater_person

21.9.2. Presenters

The following are the presenters used on this panel in presentational order.

Type Span Field Reference Forced Width Row Tag Tier Properties Description

CELL

ONE(1)

1 - PaperID

paper.id

10

NONE

WITH_READONLY

Unique identifier for the paper within the Referee system. This identifier is automatically generated and read only. It does not correspond to any other paper identifier.

CELL

ONE(1)

2 - Submitter Lastname

{0.1 - Submitter}:person.lastname

40

NONE

WITH_READONLY

The last name (surname) for the member of staff. The Referee system makes this field read only to all users as it is expected to be fed in by the PURE1AC stream.

CELL

ONE(1)

3 - Submitter Firstname

{0.1 - Submitter}:person.firstname

40

NONE

WITH_READONLY

The first name (given name or known-as name) for the member of staff. The Referee system makes this field read only to all users as it is expected to be fed in by the PURE1AC stream.

CELL

ONE(1)

4 - Submitter UUN

{0.1 - Submitter}:person.uun

15

NONE

WITH_HIDDEN WITH_READONLY

The UUN (Unique Username) for the member of staff. The Referee system makes this field read only to all users as it is expected to be fed in by the PURE1AC stream.

CELL

ONE(1)

5 - PURE ID

paper.pure_id

5

NONE

WITH_READONLY

The unique PURE paper number used as a handle for the PURE2 stream.

CELL

ONE(1)

6 - Paper Title

paper.title

80

NONE

WITH_READONLY

The full title of the paper.

CELL

ONE(1)

7 - APA Citation

paper.apa

120

NONE

WITH_READONLY

The APA (American Psychological Association) formatted citation string for the paper. This contains more detail then seems to be available otherwise in individual fields in terms of publisher and year.

CELL

ONE(1)

8 - Paper Abstract

paper.abstract

120

NONE

WITH_READONLY

The full textual abstract of the paper. Any non-textual content will likely be lost or mangled in some way.

CELL

ONE(1)

9 - Rank

paper.rank

5

NONE

WITH_READONLY

Rating given to the paper by the submitter on proposal. This value of this will be from 1st to 6th or Alternate.

CELL

ONE(1)

10 - Reason

paper.reason

120

NONE

WITH_READONLY

Reason given by the submitter for proposing the paper be added to the REF submission.

CELL

ONE(1)

11 - PURE URL

paper.pure_url

80

NONE

WITH_READONLY

Direct link to the online copy of the paper. This is a URL which is a direct link to the local copy of the paper held in PURE, and is what is used as the paper download link from the corresponding entry on Edinburgh Research Explorer. This copy of the paper should always be accessible to local staff for review, unlike the DOI URL or published location which may not always be open access.

CELL

ONE(1)

12 - ERE URL

paper.ere_url

80

NONE

WITH_READONLY

Direct link to the web page for the paper in Edinburgh Research Explorer. This page (and download link) for the paper should always be accessible to local staff for review, unlike the DOI URL or published location which may not always be open access.

CELL

ONE(1)

13 - DOI URL

paper.doi_url

80

NONE

WITH_READONLY

Link to the copy of the paper held in the ACM Digital Library for Edinburgh.

CELL

ONE(1)

14 - Chosen?

paper.chosen

NONE

NONE

This value should be set (checked) by administrative users after the paper has been reviewed (by raters and moderaters) and it has been decided that it should be in included in the REF submission.

CELL

ONE(1)

15 - Raters: Done/Count

{0.2 - Status}:paperupdate.raters_done

5

NONE

WITH_READONLY

Calculated value which shows the number of raters that have been assigned to review and rate the paper (normally 2) and of those the number that have actually entered a rating value for the paper. This is presented as "X/Y" where X is the number of raters that have rated the paper and Y is the number of raters the paper has. For example: "0/0" is no raters assigned; "0/2" is 2 raters assigned but none have given a rating yet; "1/2" means one rater has given a rating; "2/2" is both (all) raters have given a rating. Normally a moderation would not take place until this state has been reached (when X = Y != 0).

CELL

ONE(1)

16 - Rater1: Rating (Name)

{0.2 - Status}:paperupdate.rater1_rating

5

NONE

WITH_READONLY

Calculated value which shows the first raters rating assigned to a paper and the corresponding rater surname, subsequently used in the moderation process. For example "1 (Bloggs)" shows that "Bloggs" rated the paper "1". Only if the first rater has entered a rating will they be listed so the value will be blank if they have not done so.

CELL

ONE(1)

17 - Rater2: Rating (Name)

{0.2 - Status}:paperupdate.rater2_rating

5

NONE

WITH_READONLY

Calculated value which shows the second raters rating assigned to a paper and the corresponding rater surname, subsequently used in the moderation process. For example "1 (Bloggs)" shows that "Bloggs" rated the paper "1". Only if the second rater has entered a rating will they be listed so the value will be blank if they have not done so.

CELL

ONE(1)

18 - Raters:

{0.2 - Status}:paperupdate.raters

5

NONE

WITH_READONLY

If the first and second rater assigned ratings differ this will be "Disagree", otherwise if they are they same this will be "Agree". If one of the raters has not entered a rating yet this will be blank.

CELL

ONE(1)

19 - Moderaters: Done/Count

{0.2 - Status}:paperupdate.moderaters_done

5

NONE

WITH_READONLY

Calculated value which shows the number of moderaters that have been assigned to review and rate the paper (normally 1) and of those the number that have actually entered a rating value for the paper. This is presented as "X/Y" where X is the number of moderaters that have rated the paper and Y is the number of moderaters the paper has. For example: "0/0" is no moderaters assigned; "0/2" is 2 moderaters assigned but none have given a rating yet; "1/2" means one moderater has given a rating; "2/2" is both (all) moderaters have given a rating. Normally a paper should not be chosen for submission until this last state has been reached (when X = Y != 0).

CELL

ONE(1)

20 - Moderaters: Rating (Name)

{0.2 - Status}:paperupdate.moderaters_rating

5

NONE

WITH_READONLY

Calculated value which shows a list (slash separated) all the ratings assigned to a paper and the corresponding moderater surnames. For example "1(Bloggs)/3(Doe)" shows that "Bloggs" rated the paper "1" and "Doe" rated the paper "3". Only moderaters that have entered a rating will be listed so the value will be blank if none have done so.

CELL

ONE(1)

21 - Moderaters:

{0.2 - Status}:paperupdate.moderated_rank

5

NONE

WITH_READONLY

This will be "Differs" when the average value (as a floating point number) of the ratings given by the raters is distinct from the average value (as a floating point number) given by the moderater, and will be "Average" otherwise. It will be empty if one or both raters have not entered a rank or if the moderater has not entered a rank. This field can be used to show where the moderation process has resulted in a rating divergent from the original rating for subsequent cross checking prior to choosing the paper for submission. The rater ranks are mapped to a number in order to calculate the average. This is based on thirds, so 1 is 1, 1- is (1 - 1/3) and 1+ is (1 + 1/3), 0 is mapped to 1/3.

CELL

ONE(1)

22 - Result

{0.2 - Status}:paperupdate.result

16

NONE

WITH_READONLY

Following completion of review this value will indicate the best rated paper (based on moderated rating) for each submitter. Where a submitter has multiple papers rater the same then the one that the submitter ranked highest will be indicated as the best. Where the submitter has used the same ranking more than once then the one indicated as the best will be effectively random.

GRID(5)

ALL(7)

Field

Reference

Forced Width

Row Tag Tier

Properties

Description

23 - PersonID

{0.3 - Raters}:rater.person_id

NONE

NONE

WITH_HIDDEN

The unique person identifier for the person assigned to rate the paper, taken from the Person table.

24 - RaterPersonID

{0.3.1 - Rater Person}:person.id

NONE

NONE

WITH_HIDDEN WITH_PRESERVE

Unique identifier for the person within the Referee system. This identifier is automatically generated and read only. It does not correspond to any other person identifier.

25 - ? Lastname

{0.3.1 - Rater Person}:person.lastname

30

NONE

WITH_CHOICE_DROPDOWN

The last name (surname) for the member of staff. The Referee system makes this field read only to all users as it is expected to be fed in by the PURE1AC stream.

26 - Eligible?

{0.3.1 - Rater Person}:person.eligible

NONE

NONE

WITH_HIDDEN

Use this field to mark up exactly which members of staff are REF eligible (will be proposing and/or rating and/or moderating papers). By default all staff will be set as eligible so normally this field should only be manually unset for all those staff that are not eligible (e.g. support staff) if these have been fed in.

27 - Rater?

{0.3.1 - Rater Person}:person.rater

NONE

NONE

WITH_HIDDEN

This value should be set when the person is one of those who can be assigned as a Rater of papers. People with this flag set are included on the available names on the drop-down used to assign raters to papers. Note that this field only affects the UI behaviour, any person can be assigned as a rater through the GW (irrespective of the setting of this flag). By default no person has this flag set.

28 - Rank

{0.3 - Raters}:rater.rank

5

NONE

Rating assigned to the paper after review. This will be a value of 0, 1, 1-, 1+, 2, 2-, 2+, 3, 3-, 3+, 4, 4- or 4+. Do not use N*. Any value other than a number between 0 and 4 (where 1 to 4 can optionally be suffixed with plus or minus) entered in this field will be rejected with a check constraint error.

29 - Comment

{0.3 - Raters}:rater.comment

360

NONE

Free form comment from the rater - this might be to explain the reasoning behind a particular rating or to suggest changes to the paper proposal reason.

GRID(5)

ALL(7)

Field

Reference

Forced Width

Row Tag Tier

Properties

Description

30 - PersonID

{0.4 - Moderaters}:moderater.person_id

NONE

NONE

WITH_HIDDEN

The unique person identifier for the person assigned to rate the paper, taken from the Person table.

31 - ModeraterPersonID

{0.4.1 - Moderater Person}:person.id

NONE

NONE

WITH_HIDDEN WITH_PRESERVE

Unique identifier for the person within the Referee system. This identifier is automatically generated and read only. It does not correspond to any other person identifier.

32 - ? Lastname

{0.4.1 - Moderater Person}:person.lastname

30

NONE

WITH_CHOICE_DROPDOWN

The last name (surname) for the member of staff. The Referee system makes this field read only to all users as it is expected to be fed in by the PURE1AC stream.

33 - Eligible?

{0.4.1 - Moderater Person}:person.eligible

NONE

NONE

WITH_HIDDEN

Use this field to mark up exactly which members of staff are REF eligible (will be proposing and/or rating and/or moderating papers). By default all staff will be set as eligible so normally this field should only be manually unset for all those staff that are not eligible (e.g. support staff) if these have been fed in.

34 - Moderater?

{0.4.1 - Moderater Person}:person.moderater

NONE

NONE

WITH_HIDDEN

This value should be set when the person is one of those who can be assigned as a Moderater of papers. People with this flag set are included on the available names on the drop-down used to assign moderaters to papers. Note that this field only affects the UI behaviour, any person can be assigned as a moderater through the GW (irrespective of the setting of this flag). By default no person has this flag set.

35 - Rank

{0.4 - Moderaters}:moderater.rank

5

NONE

Rating assigned to the paper after review. This will be a value of 0, 1, 1-, 1+, 2, 2-, 2+, 3, 3-, 3+, 4, 4- or 4+. Do not use N*. Any value other than a number between 0 and 4 (where 1 to 4 can optionally be suffixed with plus or minus) entered in this field will be rejected with a check constraint error.

36 - Comment

{0.4 - Moderaters}:moderater.comment

360

NONE

Free form comment from the rater - this might be to explain the reasoning behind a particular rating or to suggest changes to the paper proposal reason.

21.10. Papers

UUID

pan-be13cdbf-9605-451c-9303-7098e1dbc955

Panel Name

Papers

Base Entity

SubmitterPapers (Access)

Base Selector

Properties

WITHOUT_APPEND WITHOUT_DELETE

Desktop Usage

API

Description

This call returns for the current authenticated user the papers that they have proposed for the REF submission. It is entirely read only (GET), the PUT, POST and DELETE methods are not available.

21.10.1. Connectors

There are no connectors used on this panel.

21.10.2. Presenters

The following are the presenters used on this panel in presentational order.

Type Span Field Reference Forced Width Row Tag Tier Properties Description

CELL

ONE(1)

1 - Abstract

paper_access.abstract

NONE

NONE

The full textual abstract of the paper. Any non-textual content will likely be lost or mangled in some way.

CELL

ONE(1)

2 - Double Weighted?

paper_access.double_weight

NONE

NONE

Flag indicating whether the proposed paper should be double weighted for the REF submission.

CELL

ONE(1)

3 - PaperID

paper_access.id

NONE

NONE

Unique identifier for the paper within the Referee system. This identifier is automatically generated and read only. It does not correspond to any other paper identifier.

CELL

ONE(1)

4 - Paper URL

paper_access.pure_url

NONE

NONE

Direct link to the online copy of the paper. This is a URL which is a direct link to the local copy of the paper held in PURE, and is what is used as the paper download link from the corresponding entry on Edinburgh Research Explorer. This copy of the paper should always be accessible to local staff for review, unlike the DOI URL or published location which may not always be open access.

CELL

ONE(1)

5 - ERE URL

paper_access.ere_url

NONE

NONE

Direct link to the web page for the paper in Edinburgh Research Explorer. This page (and download link) for the paper should always be accessible to local staff for review, unlike the DOI URL or published location which may not always be open access.

CELL

ONE(1)

6 - DOI URL

paper_access.doi_url

NONE

NONE

Link to the copy of the paper held in the ACM Digital Library for Edinburgh.

CELL

ONE(1)

7 - Rank

paper_access.rank

NONE

NONE

Rating given to the paper by the submitter on proposal. This value of this will be from 1st to 6th or Alternate.

CELL

ONE(1)

8 - Reason

paper_access.reason

NONE

NONE

Reason given by the submitter for proposing the paper be added to the REF submission.

CELL

ONE(1)

9 - Title

paper_access.title

NONE

NONE

The full title of the paper.

CELL

ONE(1)

10 - APA

paper_access.apa

NONE

NONE

The APA (American Psychological Association) formatted citation string for the paper. This contains more detail then seems to be available otherwise in individual fields in terms of publisher and year.

21.11. Papers

UUID

pan-4416a14f-9bcb-438e-98f3-aeafecc0c3d2

Panel Name

Papers

Base Entity

AdminPaper (Access)

Base Selector

Properties

WITHOUT_APPEND WITHOUT_DELETE

Desktop Usage

API

Description

This call returns for the current authenticated user if they have an administrative role all the papers that have been proposed for the REF. This call can be used with paper ID to change (PUT) the content of the Chosen field, the updated record is returned. The POST and DELETE methods are not available.

21.11.1. Connectors

There are no connectors used on this panel.

21.11.2. Presenters

The following are the presenters used on this panel in presentational order.

Type Span Field Reference Forced Width Row Tag Tier Properties Description

CELL

ONE(1)

1 - Abstract

paperupdate.abstract

NONE

NONE

The full textual abstract of the paper. Any non-textual content will likely be lost or mangled in some way.

CELL

ONE(1)

2 - Chosen?

paperupdate.chosen

NONE

NONE

This value should be set (checked) by administrative users after the paper has been reviewed (by raters and moderaters) and it has been decided that it should be in included in the REF submission.

CELL

ONE(1)

3 - Double Weighted?

paperupdate.double_weight

NONE

NONE

Flag indicating whether the proposed paper should be double weighted for the REF submission.

CELL

ONE(1)

4 - Firstname

paperupdate.firstname

NONE

NONE

The first name (given name or known-as name) for the member of staff. The Referee system makes this field read only to all users as it is expected to be fed in by the PURE1AC stream.

CELL

ONE(1)

5 - PaperID

paperupdate.id

NONE

NONE

Unique identifier for the paper within the Referee system. This identifier is automatically generated and read only. It does not correspond to any other paper identifier.

CELL

ONE(1)

6 - Lastname

paperupdate.lastname

NONE

NONE

The last name (surname) for the member of staff. The Referee system makes this field read only to all users as it is expected to be fed in by the PURE1AC stream.

CELL

ONE(1)

7 - Moderaters Result

paperupdate.moderated_rank

NONE

NONE

This will be "Differs" when the average value (as a floating point number) of the ratings given by the raters is distinct from the average value (as a floating point number) given by the moderater, and will be "Average" otherwise. It will be empty if one or both raters have not entered a rank or if the moderater has not entered a rank. This field can be used to show where the moderation process has resulted in a rating divergent from the original rating for subsequent cross checking prior to choosing the paper for submission. The rater ranks are mapped to a number in order to calculate the average. This is based on thirds, so 1 is 1, 1- is (1 - 1/3) and 1+ is (1 + 1/3), 0 is mapped to 1/3.

CELL

ONE(1)

8 - Moderaters Done

paperupdate.moderaters_done

NONE

NONE

Calculated value which shows the number of moderaters that have been assigned to review and rate the paper (normally 1) and of those the number that have actually entered a rating value for the paper. This is presented as "X/Y" where X is the number of moderaters that have rated the paper and Y is the number of moderaters the paper has. For example: "0/0" is no moderaters assigned; "0/2" is 2 moderaters assigned but none have given a rating yet; "1/2" means one moderater has given a rating; "2/2" is both (all) moderaters have given a rating. Normally a paper should not be chosen for submission until this last state has been reached (when X = Y != 0).

CELL

ONE(1)

9 - Moderaters Rating and Name

paperupdate.moderaters_rating

NONE

NONE

Calculated value which shows a list (slash separated) all the ratings assigned to a paper and the corresponding moderater surnames. For example "1(Bloggs)/3(Doe)" shows that "Bloggs" rated the paper "1" and "Doe" rated the paper "3". Only moderaters that have entered a rating will be listed so the value will be blank if none have done so.

CELL

ONE(1)

10 - Result

paperupdate.result

NONE

NONE

Following completion of review this value will indicate the best rated paper (based on moderated rating) for each submitter. Where a submitter has multiple papers rater the same then the one that the submitter ranked highest will be indicated as the best. Where the submitter has used the same ranking more than once then the one indicated as the best will be effectively random.

CELL

ONE(1)

11 - Paper URL

paperupdate.pure_url

NONE

NONE

Direct link to the online copy of the paper. This is a URL which is a direct link to the local copy of the paper held in PURE, and is what is used as the paper download link from the corresponding entry on Edinburgh Research Explorer. This copy of the paper should always be accessible to local staff for review, unlike the DOI URL or published location which may not always be open access.

CELL

ONE(1)

12 - ERE URL

paperupdate.ere_url

NONE

NONE

Direct link to the web page for the paper in Edinburgh Research Explorer. This page (and download link) for the paper should always be accessible to local staff for review, unlike the DOI URL or published location which may not always be open access.

CELL

ONE(1)

13 - DOI URL

paperupdate.doi_url

NONE

NONE

Link to the copy of the paper held in the ACM Digital Library for Edinburgh.

CELL

ONE(1)

14 - Rank

paperupdate.rank

NONE

NONE

Rating given to the paper by the submitter on proposal. This value of this will be from 1st to 6th or Alternate.

CELL

ONE(1)

15 - Raters Done

paperupdate.raters_done

NONE

NONE

Calculated value which shows the number of raters that have been assigned to review and rate the paper (normally 2) and of those the number that have actually entered a rating value for the paper. This is presented as "X/Y" where X is the number of raters that have rated the paper and Y is the number of raters the paper has. For example: "0/0" is no raters assigned; "0/2" is 2 raters assigned but none have given a rating yet; "1/2" means one rater has given a rating; "2/2" is both (all) raters have given a rating. Normally a moderation would not take place until this state has been reached (when X = Y != 0).

CELL

ONE(1)

16 - Rater1 Rating and Name

paperupdate.rater1_rating

NONE

NONE

Calculated value which shows the first raters rating assigned to a paper and the corresponding rater surname, subsequently used in the moderation process. For example "1 (Bloggs)" shows that "Bloggs" rated the paper "1". Only if the first rater has entered a rating will they be listed so the value will be blank if they have not done so.

CELL

ONE(1)

17 - Rater2 Rating and Name

paperupdate.rater2_rating

NONE

NONE

Calculated value which shows the second raters rating assigned to a paper and the corresponding rater surname, subsequently used in the moderation process. For example "1 (Bloggs)" shows that "Bloggs" rated the paper "1". Only if the second rater has entered a rating will they be listed so the value will be blank if they have not done so.

CELL

ONE(1)

18 - Raters Result

paperupdate.raters

NONE

NONE

If the first and second rater assigned ratings differ this will be "Disagree", otherwise if they are they same this will be "Agree". If one of the raters has not entered a rating yet this will be blank.

CELL

ONE(1)

19 - Reason

paperupdate.reason

NONE

NONE

Reason given by the submitter for proposing the paper be added to the REF submission.

CELL

ONE(1)

20 - Title

paperupdate.title

NONE

NONE

The full title of the paper.

CELL

ONE(1)

21 - APA

paperupdate.apa

NONE

NONE

The APA (American Psychological Association) formatted citation string for the paper. This contains more detail then seems to be available otherwise in individual fields in terms of publisher and year.

21.12. Papers to Moderate

UUID

pan-d8d42d9e-20f3-4bff-98bf-d383a593f58b

Panel Name

Papers to Moderate

Base Entity

ModeraterPapers (Access)

Base Selector

Properties

WITHOUT_APPEND WITHOUT_DELETE

Desktop Usage

API

Description

This call returns for the current authenticated user all the papers that they have been assigned to moderated. This call can be used with paper ID to change (PUT) the content of the Rating and Comment fields, the updated record is returned. The POST and DELETE methods are not available.

21.12.1. Connectors

There are no connectors used on this panel.

21.12.2. Presenters

The following are the presenters used on this panel in presentational order.

Type Span Field Referenc