Auto Downloads V2 Admin and Technical Guide

  • Page Views 3851


This guide will walk through utilizing CITI Program Auto Downloads V2 for your organization. 
 
 

Organizational Admin Guide

Administrator Role

CITI Program organizational admins need Autodownload Administrator Role activated to utilize the Auto Downloads V2 features. To check your Administrator Role:

Log into your CITI Program account and click on the Admin tab.


image.png


​​​​​​From your Admin menu, locate the Manage Institution heading and click on Institutional Administrators.

image.png

The Administrator Roles are listed for each admin. If you do not have Autodownloads activated for your account please contact CITI Program Support at 888.529.5929.

Screen Shot 2021-05-10 at 11.01.44 AM.png

Custom Reports

With the Autodownloads Admin Role activated you can create custom reports:

From your admin menu click on Manage My Downloads under the Reports tab.


image.png

If you are an Autodownload Admin at multiple organizations, you will need to select the organization to include in the report.

Select a report type under Create a Download Report.

 
Screen Shot 2021-05-10 at 12.26.05 PM.png


Select the parameters for the report and click Submit.

2021-05-10_12-59-55.jpg

Select the research categories or groups to include in the report and click Submit. 

Screen Shot 2021-05-10 at 1.13.20 PM.png
 

The new custom report will now be listed on the Manage my Downloads page. 
Edit the report parameters by clicking on the report name.
Edit the groups or research categories by clicking on Edit Research Categories.

If the parameters you selected will result in more than 100,000 records begin returned you will need to change your parameters. Note: if the estimated number of records is less than 100,000, but you are unable to download the report, you may have selected too many fields.  Try selecting fewer fields and test the download again.

Screen Shot 2021-05-10 at 1.16.57 PM.png


To update the fields included in the report click on Edit under Information Included in Report.
Then click the Select Fields Included in Report link.


Screen Shot 2021-05-10 at 1.34.03 PM.png

 
After selecting the fields, you can change the order in which they are presented and the names of the columns.
 
If the parameters you selected will result in more than 100,000 records begin returned you will need to change your parameters. Note: if the estimated number of records is less than 100,000, but you are unable to download the report, you may have selected too many fields.  Try selecting fewer fields and test the download again.
 
Run the report by clicking on Get Report from the Manage my Downloads page.

Screen Shot 2021-05-10 at 4.17.06 PM.png
 

 

 

Technical Guide

Updating the URL to automatically download a report

Each time a report is downloaded, the URL is updated.

When a CITI Program organizational admin is logged in to CITI Program and uses the Get Report link to download a report, the URL is updated when the admin clicks Get Report.


If the organizational admin is not logged in to CITI Program, they must update the URL. The institution’s IT staff would do this to automate report downloads.

A sample url is:
https:// www.citiprogram .org/adl/download.asp?ID=752&requestdatetime=2020-03-02T14:52:04&startdatetime=2015-01-01T00:00:00&enddatetime=2017-01-01T00:00:00&hash=c957bf5e0e4d13542c4a43127936ab84&durlid=32

URL querystring values:

ID: Download ID for the administrator. Each administrator has a unique ID.
durlid: Download ID for the report. Each report has a unique ID.
requestDateTime: current time (yyyy-mm-ddThh:mm:ss ET) . URL is only valid +/- 5 minutes of request date/time. This will need to be updated for each download.

startdate: start date and time (yyyy-mm-ddThh:mm:ss ET)  for data in the report. This value is optional and defaults to the value saved in the report. The following reports include the start date/time:
  • passed completion reports
  • passed completion reports with modules completed and exams
  • completion reports that are expiring (start time is ignored for this report)

enddate: end date and time (yyyy-mm-ddThh:mm:ss ET)  for data in the report. This value is optional and defaults to the value saved in the report. The following reports include the end date/time:
  • passed completion reports
  • passed completion reports with modules completed and exams
  • completion reports that are expiring (end time is ignored for this report)

hash:  MD5 hash of (ID + durlid + requestDateTime + Shared Secret). The Shared Secret used in the hash is available on the administrator’s Download Manager Menu. This will need to be updated for each download.

Example:

00009992042-03-17T12:58:431A151DF6-0131-4301-AC96-C0C31C3121FB
(Admin unique ID)(custom report ID)(request date time)(shared secret)


 
For questions or more information call 888.529.5929.