Reports: HEI report

 DCS users may run a HEI report to see an overview of all of their DCS requests. This article will detail how to run a DCS request, and what the different columns are. See the column name in brackets.  


  • (A) NG account number: Your institution's CLA account number
  • (B) Active request ID: The request ID. Search for this from the dashboard to find your request
  • (C) Licence type: The licence type used for each request

Course information:

  • (D) Course Code: The DCS course code
  • (E) Course Name: The DCS course name
  • (F) Lead Lecturer: The name of the lecturer added as lead lecturer for the course this request is assigned to
  • (G) Lead Lecturer Email: The email address added for the lecturer assigned as lead lecturer for the course this request is assigned to 
  • (H) Requesting Lecturer: The name of the lecturer assigned to the request by the DCS user actioning it
  • (I) Requesting Lecturer Email: The email of the lecturer assigned to the request by the DCS user actioning it
  • (J) Subject: The subject as added to the course page
  • (K) Department: The department as added to the course page
  • (L) Number of students: The student number for the course linked to the request
  • (M) Number of weeks: The number of weeks added to the course page

Item metadata (all as seen in the requests):

  • (N) ISN
  • (O) DOI
  • (P) Title
  • (Q) Extract Title
  • (R) Author
  • (S) Extract Author
  • (T) Publisher
  • (U) Place of Publication
  • (V) Edition
  • (W) Total number of pages
  • (X) Year
  • (Y) Issue
  • (Z) Volume

Other request information:

  • (AA) Page range: The page range added when creating the request
  • (AB) Total number of pages copied: The total number of pages used in the request 
  • (AC) Ownership: The ownership status selected in the request
  • (AD) Status: The current status of the request. 'Released' means the link has been generated. 
  • (AE) Number of views: The number of times the content link has been clicked on
  • (AF) Date received: This field is only populated for requests that have come in via another request route than the DCS itself. Included request routes can be the Academic request form, integration with an RLMS or use of our API
  • (AG) Date Request Created: The date the request was originally created. This does no longer change when the request is rolled over. Even though your requests are given new request IDs after rollover, this date will remain the same as the system will know when the original request was created. 
  • (AH) Date link generated: The date the link was originally generated (i.e. the date the DCS user clicked the 'generate link' button). This date no longer changes with rollover. 
  • (AI) HEI user: The DCS user who created the request
  • (AJ) Academic year: The academic year of the request
  • (AK) Link: The content URL. Where the link is unavailable the link will have been created earlier than May 2017 
  • (AL) Notes: Any notes added to the request. Deleted notes will not be included here.  
  • (AM) Request route: See below for details. 


Request route in the HEI report

We’ve added a new field to the HEI report and Rejected Requests Report, called Request Route (column AM). This will indicate the request route of all academic requests.

This means that if the request came from a third-party integration, the request route shown would be the subscription icon. This can be found under ‘My Institution’ – API User Configuration. For example for KeyLinks customers this is

For an individual HEI integration, they create this field when they sign up to the CLA API Portal, so it could for example be

Any request from the Academic Request  Form will list the requestor email in this column. So for lecturer Jane Smith, all her submitted Academic Requests will show her email address in this column.

This way users can now check where their request traffic is coming from, which is especially useful if HEIs decide to mix their request workflow by for example using the Request Form alongside a third-party integration.

If you want to see all of your requests which has come from an academic request of any kind, filter out the blanks in this column.


Was this article helpful?
0 out of 0 found this helpful
Have more questions? Submit a request


Please sign in to leave a comment.