Modules/Services Configuration

Settings pertaining to the External Module Framework
Enable the built-in process for users to request that an External Module be activated for a project?
NOTE: Enabling this setting will only display the button for modules that have been made 'Discoverable' in the system.

Settings for various modules and services. NOTE: 'Modules' here does *not* refer to External Modules, which you may learn more about by clicking its link on the left-hand menu.
Enable the use of surveys in projects?
Google reCAPTCHA option for protecting public surveys
To enable the option for users to use Google reCAPTCHA on their public surveys, you must first establish a Google reCAPTCHA API site key and secret for your REDCap server. Choose the 'reCAPTCHA v2' and 'Checkbox' options when registering your site, and then enter both keys in the two text boxes here. Once both are set, users on the Public Survey page will be provided with the option to enable reCAPTCHA in that project. Note: Google reCAPTCHA is only employed on public surveys.
Site key:
Secret key: Show secret key
Create Google reCAPTCHA API key
URL shortening service
When enabled, REDCap provides the option to use the URL shortening service named REDCAP.LINK to shorten or customize public survey links, links for public project dashboards, and public report links. This service is hosted by Vanderbilt on AWS. If your server is behind a firewall and cannot make outbound HTTP requests to websites on the web, then you should disable this service.
Randomization
When enabled, it will display the option to utilize the Randomization module for new or existing projects. When disabled, the option will remain completely hidden, and the Randomization module will stay hidden in each project and cannot be used.
REDCap Shared Library
Allows users to download forms from the REDCap Shared Library to import those forms into their project on the Online Designer page.
REDCap Messenger
REDCap Messenger is a communication platform built directly into REDCap. It allows REDCap users to communicate easily and efficiently with each other in a secure manner. At its core, REDCap Messenger is a chat application that enables REDCap users to send one-on-one direct messages or to organize group conversations with other REDCap users.
REDCap API
The REDCap API is an interface that allows external applications to connect to REDCap remotely, and is used for programmatically retrieving or modifying data or settings within REDCap, such as performing automated data imports/exports from a specified REDCap project. For details on the capabilities of the REDCap API and how to use it, please see the REDCap API help page.
REDCap Mobile App
The REDCap Mobile App is an app that can be downloaded onto a tablet or mobile device to allow REDCap data to be collected locally on that device without the need for an internet connection (either wifi or cellular signal). If a user downloads the app, they must explicitly be given mobile app privileges in a given REDCap project in order to set up the project on the app. Once a project has been set up on the app, data can be collected in an offline fashion and then later synced back to the REDCap server.
External Modules:
Alternate module directories (optional)
If you are developing external modules and wish to store your modules in another directory (not just in the redcap/modules/ directory), you may set one or more directories here. They do not need to be located under the REDCap web root (e.g., 'redcap' directory), and you must provide the full path of the directory. To define multiple alternative directories, separate them with a pipe |.
e.g., /var/www/redcap/modules_staging/|/var/www/redcap/modules_internal/
e.g., C:\xampp\htdocs\redcap\modules2\
Enable the File Version History for 'File Upload' fields?
The File Version History allows users to maintain previous versions of a file for a File Upload field on a form or survey. If a new version of a file needs to be uploaded for the field, instead of deleting the current file before uploading the new one, a user may simply upload a new file, in which all older versions will be kept and will be accessible for viewing/download in the Data History popup for the field.

If disabled here, then users will not be able to utilize this feature in their projects. If enabled, then users may enable it for a project via the Additional Customizations popup on the Project Setup page.
Enable the Field Bank in the Online Designer?
The Field Bank allows users to import fields from various standardized catalogs when building their instruments via the Online Designer.

If disabled here, the 'Import from Field Bank' button will be hidden in the Online Designer for all users.
Allow embedding of videos on data entry forms and survey pages?

If enabled, the Online Designer will allow users to supply a video URL for a Descriptive field on a form or survey, in which it will provide a button that, when clicked, will play the embedded video inside a popup dialog. This features allows any video URL to be used from any video hosting website (although it is most compatible with YouTube and Vimeo).
Allow text-to-speech functionality to be enabled for surveys?

This features allows users to enable text-to-speech functionality in any given survey, in which text on the survey page can be read out loud audibly by the computer. This service utilizes a service hosted at Vanderbilt University that utilizes the IBM Watson Text-to-Speech API service, and thus will send all displayed survey text (e.g., survey instructions, field labels, choice labels) from the REDCap server to the Vanderbilt-hosted service. This means that the REDCap web server must be able to make outbound HTTP requests to https://redcap.vanderbilt.edu in order for this service to work.
Allow auto-suggest functionality for searching biomedical ontologies for fields on data entry forms and surveys?
BioPortal Token:
This service utilizes the BioPortal API web service (see documentation at http://bioportal.bioontology.org). For this feature to work, the REDCap web server must be able to make outbound HTTP requests to https://data.bioontology.org/. If you do not yet have a BioPortal API token, you can obtain a token here. The service will not function without a valid API token.
Enable the Data Entry Trigger for all projects?
If enabled here, users can set this up in the Additional Customizations pop-up on their project's Project Setup page.

The Data Entry Trigger is an advanced feature. It provides a way for REDCap to trigger a call to a remote web address (URL), in which it will send a HTTP POST request to the specified URL whenever *any* record or survey response has been created or modified on *any* data collection instrument or survey in this project (it is *not* triggered by data imports - including API imports and Mobile App imports - but only by normal data entry on surveys and data entry forms). Its main purpose is for notifying other remote systems outside REDCap at the very moment a record/response is created or modified, whose purpose may be to trigger some kind of action by the remote website, such as making a call to the REDCap API. View more details
Enable the project XML export functionality (i.e., project backup)?

If enabled (default), users will be able to download a backup of their entire project as a single XML file (CDISC ODM format), which could be used to create a clone of the project (including its data, optionally). This option will be shown on the Other Functionality tab of the 'Project Setup' page and also on the Other Export Options tab of the 'Data Exports, Reports, and Stats' page.
Protected Email Mode
Prevent identifying data (PHI/PII) from being sent in outgoing emails for alerts, survey invitations, and survey confirmation emails.

This setting prevents identifying data (PHI/PII) from being sent in outgoing emails for alerts, survey invitations, and survey confirmation emails. If enabled here at the system-level, users will see an option in the Additional Customizations dialog on the Project Setup page to allow them to enable the Protected Email Mode in their project. If this feature is then enabled in a project, either A) all alerts, survey invitations, and survey confirmation emails or B) those whose email body is attempting to pipe data from Identifier fields will be affected, in which it will not send the full email text to the recipient but will instead send a surrogate email containing a link that leads them to a secure REDCap page to view their original email. The recipient clicking the link allows them to navigate to a secure REDCap page where they may view the original email. If they are accessing an email in the Protected Email Mode for the first time (or in more than a month), it will send a security code to their inbox that will allow the recipient to view any protected emails for up to 30 days on that same device.
Email Logging
Enable the Email Logging page in all projects for users with User Rights privileges in the project.

If enabled, users with User Rights privileges in a project will be able to opt-in to using the Email Logging page, which will allow them to search and access all outgoing emails for the project. This can be useful for troubleshooting potential issues related to emails. If this feature is disabled here, all outgoing emails will still be stored in the backend database, but they will not be accessible to users via the user interface.
DTS (Data Transfer Services)
The REDCap DTS module allows data to be pushed into REDCap projects from external systems (e.g., electronic medical record system, electronic data warehouse) and provides an adjudication process whereby REDCap users approve all incoming data from DTS before it is officially saved in their REDCap project. DTS must be installed and configured beforehand in order for it to function when enabled on this page. Once enabled globally here, DTS can then be enabled for individual REDCap projects on the Edit Project Settings page. For installation and setup instructions, please contact the developers at Oregon Health & Science University that created DTS.
Computer adaptive tests (CATs)
and Auto-scoring instruments
If enabled, users will be able to download CATs and Auto-scoring instruments from the REDCap Shared Library, and then use them in their project as a survey that is driven by a third-party service (i.e., another web server). If not enabled, users that navigate to the Shared Library will have all these types of instruments hidden, thus preventing users from downloading them. These include PROMIS instruments and Neuro-QoL instruments, among others, and are provided by the Assessment Center API.
Test the service:   
If the test above fails, then it means your server cannot make contact with the CAT server hosted by Vanderbilt University. If you have a firewall that is blocking outbound requests, you may need to have it allow outbound requests for the following URL: https://www.redcap-cats.org/promis_api/
The CATs are generated dynamically using the API software developed by the Assessment Center. NOTE: The data sent from REDCap to the Assessment Center API service hosted by Vanderbilt University is de-identified and cannot be connected back to any individual respondent.

Twilio SMS and Voice Call services for surveys and alerts

Enable Twilio web service for voice calls and SMS services?
This will allow Twilio services to be utilized in REDCap projects, such as for sending survey invitations and taking surveys via SMS or as voice calls.
Test the service:   
Note: In order to use the Twilio service, the REDCap web server must be able to make outbound HTTP/HTTPS requests to the following URL: https://api.twilio.com. Additionally, your REDCap server must be publicly available to the web (in the DMZ) so Twilio's web servers can make requests to it. Otherwise, Twilio cannot completely function. For more information on Twilio, see https://www.twilio.com.
Who can enable Twilio services in a given project?
If 'Only Administrators' is selected, then normal users will not even see the setting on the project's Project Setup page (only Administrators will be able to see it and enable it). If 'All users' is selected, then any user with Project Design/Setup privileges in that project can see the setting and can also enable it on their own to utilize Twilio services in their project.
Display information about Twilio services to all users on Project Setup page in a project?
NOTE: This setting is only applicable if the 'Only Administrators' option is selected for the setting immediately above.
If 'No' is selected, then Twilio SMS and voice call services will not be advertised to users on the Project Setup page, and all information about Twilio will never be displayed anywhere in a project. Setting it to 'No' is preferable if you wish to make Twilio services known to only a limited number of users without advertising it to all users.

Settings for graphical data and statistics display:

Enable the Graphical Data View & Stats module for ALL projects?
Enable the service for displaying plots and generating statistics for this project module, or disable the module altogether.
NOTE: This option enables the module for every REDCap project.
Allow survey respondents to view aggregate survey results?
When this option is enabled, users creating a survey can set the option for survey respondents to view ALL survey results in aggregate graphical format and/or as descriptive statistics after the respondent has completed the survey. This option appears when a user clicks the Set Up Survey or Modify Survey Settings button on the Project Setup page.

e-Consent Framework for PDF Auto-Archiver

The PDF Auto-Archiver survey setting may optionally be expanded to also have an 'e-Consent Framework' option, which includes end-of-survey certification & archival of the PDF consent form. It is recommended to hide this option only if you will not be using e-Consent in any projects on this REDCap installation.
Display 'e-Consent Framework' option for ALL surveys:
(option will be located on Survey Settings page for a given instrument)
Capture the IP address of survey participants that certify the e-Consent process, and store their IP in the File Repository table.
Custom message for e-Consent Framework settings (optional)
Additional text to display on the Survey Settings page of *every* project at the bottom of the e-Consent Framework section. This may be utilized for informing your users of some information surrounding the use of the e-Consent Framework at your institution, for example.
Expand 
HTML may be used in order to adjust the style of the text or to display links, images, etc.

Alerts & Notifications

The settings below can be used to restrict the ability for users to send alerts to certain email addresses on the Alerts & Notifications page in all projects. This allows some institutions to be more restrictive if they have concerns about users using this functionality (intentionally or maliciously) in a way that might threaten regulatory compliance or privacy laws/regulations, such as piping sensitive data into an alert's email message and sending it to a non-project user.
Email-related options:
Allow normal users to use project variables for email fields in the project for an alert's To, CC, or BCC?
If set to 'Yes', then users will be able to choose email-validated text fields in the multi-select when setting an alert's To, CC, or BCC. Administrators will always be able to do this in a project regardless of this setting.
Allow normal users to manually enter email addresses as freeform text for an alert's To, CC, or BCC?
If set to 'Yes', then users will be able to manually type *any* email address for an alert's To, CC, or BCC. Administrators will always be able to do this in a project regardless of this setting.
Optional: Domain allowlist for email addresses that are manually entered as freeform text (via option above)
If the option immediately above is set to 'Yes', you may optionally limit the kinds of email addresses that can be entered as an alert's To, CC, or BCC by specifying one or more domain names (e.g., vanderbilt.edu) that will serve as an allowlist of the only acceptable domains that email addresses may have for an alert. If an email with another domain is entered by a user, it will display an error and will not accept it.

Expand 
Separate each domain on a different line. See example below.
vanderbilt.edu
mc.vanderbilt.edu
mmc.edu
Phone-related options (only used if Twilio telephony services are enabled in the project):
Allow normal users to use project variables for phone fields and integer fields in the project for an alert's recipient phone numbers?
If set to 'Yes', then users will be able to choose phone-validated and integer-validated text fields in the multi-select when setting an alert's recipient phone numbers. Administrators will always be able to do this in a project regardless of this setting.
Allow normal users to manually enter phone numbers as freeform text for an alert's recipient phone numbers?
If set to 'Yes', then users will be able to manually type *any* phone number for an alert's recipient phone numbers. Administrators will always be able to do this in a project regardless of this setting.

 'File Upload' field enhancement: Password verification & automatic external file storage

This feature allows any given project to utilize extra functionality regarding the use of File Upload fields in the project. When enabled below and also in a project, any user that is uploading a file for a File Upload field on a data entry form or survey will be asked to confirm that the file is the correct file. And when on data entry forms specifically, it will additionally ask the user to enter their REDCap password as part of the verification process. Once confirmed/verified, the file will successfully upload, and in addition to saving the file normally in REDCap, it will also store a duplicate copy of the file on a secure, external server using the configuration settings defined below. This feature may be utilized for projects wishing to adhere to certain regulatory compliance, such as 21 CFR Part 11 for FDA trials. Note: This feature is disabled by default for all projects, but users with 'Project Setup & Design' rights can enable it for a project in the Additional Customizations popup on a project's Project Setup page.
Enable this system-level setting for password verification for File Upload fields AND enable the external storage device? Choose storage method (SFTP, WebDAV, Azure, S3):
Note: By enabling this, it will NOT be auto-enabled in any projects. It is disabled by default for all projects. Users with 'Project Setup & Design' rights will need to enable this feature in the Additional Customizations popup on a project's Project Setup page.

Azure/S3-only settings:
Bucket/container name:

SFTP/WebDAV-only settings:
Server hostname:
For WebDAV, the hostname must begin with http:// or https:// (e.g., https://ebldav.mc.vanderbilt.edu), but not for SFTP (e.g., sftp.vumc.org). SFTP always assumes port 22, while WebDAV is port 80 or 443.
Server username:
Server password:
Server directory to store files: e.g., /redcap/files/
Path to Private Key file (SFTP only): e.g., /credentials/redcap_sftp.pem
Authentication type (WebDAV-only):

 Record-level Locking Enhancement: PDF confirmation & automatic external file storage

This feature allows any given project to utilize extra functionality regarding the use of the Record-Level Locking feature in a project. When enabled below and also in a project, any user that is locking an ENTIRE record (as opposed to instrument-level locking) will be asked to review a PDF copy of the entire record to confirm it is the correct record and/or file. Once the PDF has been reviewed and confirmed, the record will be locked, after which the PDF file will be stored in the project's File Repository and a duplicate copy will be stored on a secure, external server using the configuration settings defined below. This feature may be utilized for projects wishing to adhere to certain regulatory compliance, such as 21 CFR Part 11 for FDA trials. Note: This feature is disabled by default for all projects, but users with 'Project Setup & Design' rights can enable it for a project in the Additional Customizations popup on a project's Project Setup page.
Enable the external storage device and choose storage method (SFTP, WebDAV, Azure, S3):
Note: By enabling this, it will NOT be auto-enabled in any projects. It is disabled by default for all projects. Users with 'Project Setup & Design' rights will need to enable this feature in the Additional Customizations popup on a project's Project Setup page.

Azure/S3-only settings:
Bucket/container name:

SFTP/WebDAV-only settings:
Server hostname:
For WebDAV, the hostname must begin with http:// or https:// (e.g., https://ebldav.mc.vanderbilt.edu), but not for SFTP (e.g., sftp.vumc.org). SFTP always assumes port 22, while WebDAV is port 80 or 443.
Server username:
Server password:
Server directory to store files: e.g., /redcap/files/
Path to Private Key file (SFTP only): e.g., /credentials/redcap_sftp.pem
Authentication type (WebDAV-only):

 e-Consent Framework: PDF External Storage Settings (for all projects)

If the 'e-Consent Framework' option is enabled for the PDF Auto-Archiver setting on any survey, the e-Consent PDF files that are archived in the File Repository can additionally be stored on an external file server if enabled using the settings below. This might be desirable for certain regulatory compliance requirements, such as 21 CFR Part 11 studies where the PDFs must be stored in a Part 11 compliant environment. Note: If enabled, then *all* surveys in this entire REDCap installation that have the 'e-Consent Framework' option enabled will automatically have those PDFs stored on the external server whose credentials/settings are defined below.
Enable the external storage device and choose storage method (SFTP, WebDAV, Azure, S3):

Azure/S3-only settings:
Bucket/container name:

SFTP/WebDAV-only settings:
Server hostname:
For WebDAV, the hostname must begin with http:// or https:// (e.g., https://ebldav.mc.vanderbilt.edu), but not for SFTP (e.g., sftp.vumc.org). SFTP always assumes port 22, while WebDAV is port 80 or 443.
Server username:
Server password:
Server directory to store files: e.g., /redcap/files/
Path to Private Key file (SFTP only): e.g., /credentials/redcap_sftp.pem
Authentication type (WebDAV-only):


The Data Entry Trigger is an advanced feature. It provides a way for REDCap to trigger a call to a remote web address (URL), in which it will send a HTTP POST request to the specified URL whenever *any* record or survey response has been created or modified on *any* data collection instrument or survey in this project (it is *not* triggered by data imports - including API imports and Mobile App imports - but only by normal data entry on surveys and data entry forms). Its main purpose is for notifying other remote systems outside REDCap at the very moment a record/response is created or modified, whose purpose may be to trigger some kind of action by the remote website, such as making a call to the REDCap API.

In the HTTP Post request, the following parameters will be sent by REDCap in order to provide a context for the record that has just been created/modified:
• project_id - The unique ID number of the REDCap project (i.e. the 'pid' value found in the URL when accessing the project in REDCap).
• username - The username of the REDCap user that is triggering the Data Entry Trigger. Note: If it is triggered by a survey page (as opposed to a data entry form), then the username that will be reported will be '[survey respondent]'.
• instrument - The unique name of the current data collection instrument (all your project's unique instrument names can be found in column B in the data dictionary).
• record - The name of the record being created or modified, which is the record's value for the project's first field.
• redcap_event_name - The unique event name of the event for which the record was modified (for longitudinal projects only).
• redcap_data_access_group - The unique group name of the Data Access Group to which the record belongs (if the record belongs to a group).
• [instrument]_complete - The status of the record for this particular data collection instrument, in which the value will be 0, 1, or 2. For data entry forms, 0=Incomplete, 1=Unverified, 2=Complete. For surveys, 0=partial survey response and 2=completed survey response. This parameter's name will be the variable name of this particular instrument's status field, which is the name of the instrument + '_complete'.
• redcap_repeat_instance - The repeat instance number of the current instance of a repeating event OR repeating instrument. Note: This parameter is only sent in the request if the project contains repeating events/instruments *and* is currently saving a repeating event/instrument.
• redcap_repeat_instrument - The unique instrument name of the current repeating instrument being saved. Note: This parameter is only sent in the request if the project contains repeating instruments *and* is currently saving a repeating instrument. Also, this parameter will not be sent for repeating events (as opposed to repeating instruments).
• redcap_url - The base web address to REDCap (URL of REDCap's home page).
i.e., https://webresearch.id.lv/redcap/
• project_url - The base web address to the current REDCap project (URL of its Project Home page).
i.e., https://webresearch.id.lv/redcap/redcap_v12.2.0/index.php?pid=XXXX
NOTE: If the names of your records (i.e. the values of your first field) are considered identifiers (e.g., SSN, MRN, name), for security's sake it is highly recommended that you use an encrypted connection (i.e. SSL/HTTPS) for the URL you provide for the Data Entry Trigger.