Configure REDCap Server

Before associating a REDCap project with a Collection Protocol in OpenSpecimen, the user must first configure the REDCap server. This configuration allows OpenSpecimen to pull data from REDCap projects hosted on the configured server using API tokens.

Once configured, the same REDCap server setup can be reused to add and link multiple REDCap projects, eliminating the need to repeat the server configuration.

Steps to Add a REDCap Server

Navigate to the required CP overview page → Click on the 'Settings' tab on the left sidebar.
Select ‘REDCap Project Configuration' and click on the 'Add Project’ button.

Click on the ‘Add Server’, provide details on server name, host base URL, plugin path, and time zone, and click on the ‘save’ button.

If the configuration was already done, the server will appear in the dropdown.

Data Dictionary for Server Configuration

Field Name	Mandatory?	Description

Field Name	Mandatory?	Description
Server Name	Yes	Free text to enter a name for the REDCap server. For example, OpenSpecimen REDCap QA Server
Host URL	Yes	The base URL for the REDCap server. For example, https://www.project-redcap.org
Plugin Path	No	The relative path for the PHP plugin installed on the REDCap server. To check all the plugins installed on the REDCap server, add ‘/plugins’ at the end of your REDCap base URL. For example, https://www.project-redcap.org /plugins
Time Zone	No	The timezone of the REDCap server.