Skip to main content

System-level User Settings

Settings related to Project Creation and Project Status Changes

Allow normal users to create new projects?
Setting it to 'no' will allow only Administrators to create new projects and will provide a 'Request New Project' feature to users, where they can send a request to an admin that a project be created for them.
Allow normal users to move projects to production?
Setting it to 'no' will allow only Administrators to move projects to production and will provide a 'Request To Move to Production' option to users, where they can request to an admin that a project be moved to production.
Default instrument-level user access set for all project users' Data Viewing Rights and Data Export Rights whenever a new instrument is created while in production status.
If a user creates a new instrument while a project is in production, you may choose whether all users in the project will have 'No Access' rights to the new instrument(s) by default or if they will instead have 'View & Edit/Full Data Set' rights to the new instrument(s) by default. NOTE: This applies to ALL projects, and the user access right selected above gets set automatically after the draft mode changes are approved.

Email Notification Settings

Notify the REDCap admin via email when a new account is created (excluding Table-based user accounts)?
This setting can be used to notify admins whenever new users enter the system. Table-based users are not included because their accounts are created by an administrator.
Send a "welcome" email to new users when they create a REDCap account (excluding Table-based user accounts) - i.e., when they log in the first time using an external authentication method?
The "welcome" email will consist of the following stock text:
You have successfully created an account in REDCap at https://chi-redcap.dshs.texas.gov/redcap/. Your REDCap username is "USERNAME". Please note that REDCap does not manage your password. If you have difficulty logging in, you should contact your local IT department. Welcome to REDCap!
Custom Surveys for Project Status Transitions (optional):
The fields below allow you to utilize public surveys to capture custom information from users when projects transition to a new status (i.e., project creation, copy project, move to Production status, move to Analysis/Cleanup status, mark as Completed). This allows administrators to create custom surveys to capture all the info they desire from users during these project transitions. The survey will be presented inside an iframe on the page, in which the user must complete the survey before completing the process on the page. You may use any or none of these fields. NOTE: Administrators will not be forced to complete any of the public surveys set below but will be exempt from this process.
TIP: As users are completing the public surveys identified below, you may track which survey response corresponds to the user's project. This is done by adding the field variable project_id to any of the projects identified below (if longitudinal, the field must exist in the first event of the first arm in the project). If the 'project_id' field exists, then when the user completes a project transition survey below, the PID of the project for which they are completing the survey will then be saved in the 'project_id' field of those identified below. This allows you to know which survey response applies to which project of the user that is completing the survey.
'Create/Copy Project' survey:
Force users to complete this public survey before creating a new project.
PID of project with a public survey
'Move to Production status' survey:
Force users to complete this public survey before moving a project to Production status.
PID of project with a public survey
'Move to Analysis/Cleanup status' survey: Force users to complete this public survey before moving a project to Analysis/Cleanup status. PID of project with a public survey
'Mark project as Completed' survey:
Force users to complete this public survey before marking a project as Completed.
PID of project with a public survey

General User Settings

Allow normal users to auto-generate API tokens for their projects?
If the option is set to allow only selected users to generate API tokens, then any given user can be given this privilege on the Browse Users page when modifying their user account settings.
Auto-suspend users after period of inactivity
Period of inactivity: Days
Notify user via email when suspended?
If enabled, users that have not logged into REDCap or used the API in the past X number of days (specified above) will automatically have their account suspended and (if set to Yes above) will be notified via email of their suspension. If the user has a sponsor (i.e., secondary contact) listed on their account, the sponsor will be CC'd on the email so that they are aware. Please note that if a user has been UNsuspended by an administrator within the period of inactivity, then the user will NOT get auto-suspended.
NOTE: If using 'LDAP & Table-based' authentication, there will appear an additional choice above to enable auto-suspension only for Table-based users.
Sponsor Dashboard
If this module is enabled, any user that is listed as a User Sponsor for another REDCap user will be able to access their sponsored users using a link displayed near the top of the My Projects page. On their dashboard, sponsors will be able to make requests to administrators regarding their users, such as suspending users, setting/extending user expiration times, resetting passwords, and more.
Default amount to set/extend user expiration times:
Days
Regarding user expiration times, if a sponsor requests to extend a user's expiration time for their account, it will add the amount of days above to their existing expiration time. And if the sponsor is setting the expiration time (as opposed to extending it), then it will calculate the expiration time using the value above added to today's date.
User Access Dashboard
Display notifications and/or send emails to prompt users to periodically view the User Access Dashboard, which allows users to review all their projects to assess if any users should be removed from them or have their access rights expired.
NOTE: If the user does not have access to the User Rights page in any project, then they will not see these notifications and will not receive any emails regarding visiting the UAD.
How is the custom text used?
This can be used to modify the text notification displayed to users on the My Projects page. If notification text box is left empty, then the following text will be used by default: "It is recommended that you access the User Access Dashboard at least once each calendar month to review which users still have access to your projects."
Options for enabling the UAD:
(Optional) Custom notification text:

Expand 
Explanation of options for enabling the UAD:
Disabled - UAD page is hidden and not accessible to users.
Enabled: Notification on page - Displays text on the My Projects page to remind users to visit the UAD page periodically.
Enabled: Notification and warning on page - Displays text on the My Projects page to remind users to visit the UAD page periodically, and if the user has not visited the UAD during the current calendar month, it will display the notification in red to alert them to visit the UAD soon.
Enabled: Notification and warning on page + Monthly email reminder - Displays text on the My Projects page to remind users to visit the UAD page periodically, and if the user has not visited the UAD during the current calendar month, it will display the notification in red to alert them to visit the UAD soon. This option will also send an email reminder on the first weekday of every month to remind users to visit the UAD.
Allow users to edit survey responses?
If enabled, users can be granted privileges (via the User Rights page) to edit survey responses that have been either partially or fully completed by a survey respondent.
Allow production Draft Mode changes to be approved automatically under certain conditions?
This refers to when users submit their changes made in Draft Mode to a REDCap admin for approval. If certain conditions are met regarding their changes, REDCap will approve those changes automatically without an admin having to approve them.
And also ONLY IF no new fields have labels or variables with matching keywords from the 'Check For Identifiers' page
NOTE: For all options above, a REDCap administrator is still required to review changes made in Draft Mode if any critical issues exist AND the project contains one or more records.
Explanation of options above:
The options above go from most strict to least strict (top to bottom) with regard to when they allow automatical approval. If option 1 is selected, REDCap admins will always have to review and approve all production changes made by users. Option 2 will permit auto-approval ONLY if new fields are being added to the project (or if fields are simply reordered), while Option 3 will permit auto-approval if the project has no records OR if only new fields are being added (i.e. no existing fields were modified). Option 4 will NOT permit automatic approval if any critical issues exist (e.g., fields deleted, multiple choice options deleted, field type changed), while Option 5 will NOT permit automatic approval if BOTH the project has records AND critical issues exist. NOTE: If a project has no records, then the auto-approval process will behave just the same if using either option 3 or 5; however, options 3 and 5 behave very differently if a project does contain one or more records.
Allow normal users to modify the 'Repeating Instruments & Events' settings for projects while in production status?
Allow normal users to add or modify events and arms on the Define My Events page for longitudinal projects while in production status?
NOTE: Even if set to 'Yes', Administrators will still be the only ones who can delete events while in production. Additionally, if set to 'Yes', normal users will be able to designate instruments to events on the 'Designate Instruments For My Events' page that have not yet been designated, but they will not be able to un-designate any instruments that are already designated.
Domain allowlist for user email addresses
You may limit the kinds of email addresses that users associate with their REDCap account 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.

Expand 
Separate each domain on a different line. See example below.
vanderbilt.edu
mc.vanderbilt.edu
mmc.edu
Allow normal users to edit their first name and last name on their Profile page once those values have been set?
This feature may be used in environments that restrict users in certain ways (e.g., 21 CRF Part 11 environment). Normal users will still be able to edit their email address or (when using Table-based authentication) reset their password, and Administrators will still be able to edit their first/last name regardless.
Allow normal users to edit their primary email address on their Profile page?
This feature may be used in environments that restrict users in certain ways (e.g., 21 CRF Part 11 environment). Normal users will still be able to (when using Table-based authentication) reset their password, and Administrators will still be able to edit their primary email address regardless.
Display the 'variable auto-naming' feature in the Add Field popup in the Online Designer?

Default Settings for New Users

By default, allow new users to create projects or request that projects be created for them? (applies to all authentication methods)
NOTE: Tabled-based users will have their individual value set manually by an administrator when their account is created, so this primarily applies to external authentication methods (e.g., LDAP, Shibboleth).
Date and time format:
(e.g., 12/31/2004 22:57 or 31/12/2004 10:57pm)
Number format - decimal character:
(e.g., 3.14 or 3,14)
Number format - thousands separator:
(e.g., 1,000,000 or 1.000.000 or 1 000 000)
Delimiter for CSV file downloads:
(e.g., "record,age,bmi" or "record;age;bmi")

Public Reports, Project Dashboards, Smart Charts, Smart Tables, and Smart Functions

Allow reports to be made 'public'?
If a report is made public, it can be accessed at a unique URL that does not require any authentication. Users must have 'User Rights' privileges in the project in order to make a report public or to request an admin to do so. Once a report has been made public, the public link to the report will only be accessible to users in the project with 'User Rights' privileges. Note: administrators will always have the ability to make a report public regardless of the setting here.
Before a user or admin (depending on the selection above) makes a report public, they must do and agree to ALL of the following:
  1. Must view the report being made public beforehand.
  2. Must acknowledge that they understand that making the report public means that all data in the report will be fully accessible to anyone with the public link to the report.
  3. Must acknowledge that they are responsible if any private, sensitive, or identifying data in the report is exposed to persons who should not have access to such data.
Allow project dashboards to be made 'public'?
If a project dashboard is made public, it can be accessed at a unique URL that does not require any authentication.
If set to allow public dashboards after approval by an admin, the admin will receive the request from the user via the To-Do List page (or via email, if setting is enabled), and after the admin approves/disapproves the request, the user will receive an email regarding the response to their request.
Minimum number of data points required to display Smart Charts, Smart Tables, or Smart Functions on a *public* Project Dashboard, *public* report instructions, survey queue custom text, or any place on a survey page.
This setting represents the system-level value applied to all projects. However, you may override this setting for an individual project on the 'Edit Project Settings' page.
For privacy reasons, you may adjust the minimum amount of data points required when viewing a public project dashboard, public report, or survey page that contains Smart Charts, Smart Tables, or Smart Functions. Thus if any given Smart Chart, Smart Table, or Smart Function on a public project dashboard, public report, or survey page does not meet the minimum requirements, it will not output the chart, table, or value, respectively, but will instead output the text '[INSUFFICIENT AMOUNT OF DATA FOR DISPLAY]'. Note: This privacy setting does not apply to dashboards or reports being viewed from inside a REDCap project but only when viewing them via their public link.

Account Expiration: Email Templates (optional)

You may optionally provide custom email text in the two editors below for any emails sent to users regarding the upcoming expiration of their REDCap account. You may specify this for users that do not have a sponsor and also for users that do have a sponsor. These emails serve as reminders 2 days before and also 14 days before a user's account will expire. NOTICE: If no custom text is provided below, REDCap will simply use stock email text for the account expiration emails to users.
Custom Account Expiration Email (Users without a Sponsor)
Enter the custom email text below for users who do not have a sponsor. You may utilize the Dynamic Variable menu to personalize the email content, if you wish. These variables will be automatically replaced with corresponding user's information when the email is sent.
Custom Account Expiration Email (Users with a Sponsor)
Enter the custom email text below for users who have a sponsor. You may utilize the Dynamic Variable menu to personalize the email content, if you wish. These variables will be automatically replaced with corresponding user's information when the email is sent.