Integrations

The 'Integrations' menu item has study-specific information about integrations with other software. Current options are REDCap "Import Survey"; REDCap "Import Participants" and Elsa data API key.

• REDCap "Import Survey" opens the REDCap import survey page. Importing a survey from REDCap overwrites the current draft survey. There are two options "Upload Survey File" and "Import from REDCap API"
  • Upload Survey File has an upload file button to select a local survey file downloaded from REDCap. There is a 'Need Help? How to export surveys from REDCap' that opens a modal with instructions and screenshots for how to export a survey form from REDCap. Selecting a local file and pressing "Confirm" opens another modal with a warning that this action will overwrite the current draft survey, with options to cancel or proceed. If the import was not successful an error message is shown.
  • Import from REDCap API requires that REDCap URL and API Token are configured in the 'Manage Studies' advanced options page (described below). If they are not set up there is a message "Redcap API is not set up" and a link to take you to the REDCap settings. If the API configuration has been set up, then a form is shown to type in a Form Name (REDCap instrument) for import, and 'Import from API' button. When this button is pressed, if the API is able to successfully fetch the information from that REDCap instrument, the consent survey form editor is opened with as much information from the REDCap instrument as possible added to the consent survey form editor. For free text fields (which are not supported in CTRL) a Subheading is added with the text: "Question is a text or notes field - not currently supported by CTRL". Other parsing errors result in a Subheading with the text: "Unrecognized question type". Currently there is no support for importing REDCap instruments with branching logic.
• REDCap "Import Participants" opens a similar page to the import survey page, with the similar options "Upload Participants File" and "Import from REDCap API"
  • Upload Participants File opens the CSV participant import modal described above. Completing this CSV parsing flow opens the "Participants" page with the email invite modal opened and with emails (and optional ID) from the csv pre-populated, and other invitee details (Name, Date of birth etc) saved in order to pre-fill the registration page. There is a 'Need Help? How to export participants from REDCap' that opens a modal with instructions and screenshots for how to export participant information from REDCap.
  • Import from REDCap API requires that the REDCap URL and API Token are configured in the 'Manage Studies' advanced options page (described below). If they are not set up there is a message "Redcap API is not set up" and a link to take you to the REDCap settings. If the API configuration has been set up, then an 'Import from API' button is shown. When this button is pressed, if the API is able to successfully fetch the information from the associated REDCap study, the email invite modal is opened with as much information from REDCap as possible added to the prefill associated with each invitee.