FlightTracker-Publication-Validator

Source code on GitHub.

README

FlightTracker-Publication-Validator

• Rename the folder to include a version number (for example: _v1.0.0) if it does not already have a version or it will not be recognized by REDCap.

Configuration

Once the module is enabled for a project, make sure to select Manage on the left-hand control panel for the project in the External Modules tab. Then select Configure for Flight Tracker Publication Validator - vx.x.x to begin the configuration process as follows.

• Input the instrument name for the validation form. The project will otherwise assume the form is titled "pub_validation".
• Add an API key for a cohort of Flight Tracker data. These cohorts were generated by University of Kentucky CCTS and are publications of users who made Service Requests to CCTS in that year.
• Repeat step 2 for as many cohorts as you require.
• Save the configuration

Now with these steps enabled, a user should be able to access the survey and select which of their publications were made possible given a service request.

How Does It Work?

The Validator uses pre-filled form values and API linked projects to populate data dynamically for the end-user. The survey is intercepted using built-in hooks to provide customized options for each user based on their publications in Flight Tracker repositories. This was done with specific formatting in mind based on University of Kentucky's use case. Future additions are intended to make working with this module easier for other institutions.

The Services form all the fields to follow a similar format to what is provided. In place of 'year1' you could instead use the numerical year (say, 2019) and the project will know how to handle it. The UK ID field is named "linkblue", for other institutions using a different name for an identifier, you should change this field both in the code and in the form.

Currently, there are two surveys with specific formatting. These are included in the templates folder. These can be expanded to include additional years and doing so should not affect functionality. The Pub Validation form will require text box fields with the field name supported_pubs_xxxx where 'xxxx' would be publication year. Any other field in this form is suitable for change.

With these two forms in place, when a user moves to complete the Pub Validation form, they will be presented with a loading screen while API linked projects are queried for publications for the given user. These are then built into multiple choice panes for the researcher to select publications from. When the form is completed, these values are saved in a tab separated format so that they are easily processed for export via a custom CSV export view. This is accessible on the lefthand side of the project interface under External Modules on a page titled Custom CSV ...