REDCap: External Modules (EMs)
 External Module Overview |
 Available External Modules |
 Enable a Module |
 New External Module Requests |
REDCap External Module Overview
REDCap External Modules (EMs) are software packages that can be downloaded and installed by a REDCap administrator. Modules can extend REDCap's current functionality, and can also provide customizations and enhancements for REDCap's existing behavior and appearance at the system level or project level.
Only REDCap administrators are able to enable or disable modules within a project. However, if you have Project Setup and Design permissions you may request a module to be activated which will create a request for REDCap administrator to enable the module for you.
REDCap users with Project Setup and Design privileges can modify the configuration (if applicable) of any enabled module after added by a REDCap administrator.
Available External Modules
Below is a list of all available external modules. These are modules that can be enabled for any project and requested directly by a project team using the steps outline below.
Instance Table
Instance Table is an external module that allows you to use a descriptive text field to include a table showing data from repeat instances of repeating form.
There are several available action tags that allow you to control the content of the table. For example, use the action tag @INSTANCETABLE=form_name to display a table based of a form named Form Name. If the project is longitudinal, use @INSTANCETABLE=event_name:form_name to specify the event and form (must be a repeating form or a form in a repeating event).
Other action tags are available for controlling certain properties of the tables and their contents.
The Instance Table module can be useful for quickly viewing an organized list of instances and reviewing data of many repeated form instances in a single place. It also will allow you to click on instance numbers to jump to a specific instance quickly.
Orca Search
Orca Search is an external module that allows for enhanced searching within REDCap records and can replace the search query option currently accessed from the Add/Edit Records page.
Orca Search can not only search your fields quicker, but it also allows searching in multiple choice fields - which the search query function cannot do. In addition, you will be able to select what fields show up, and how they are ordered, in the search results. It is highly recommended to use Orca Search for projects that have more than 1,000 records.
Shazam
Shazam is an external module used for applying HTML and CSS to create fully custom layouts and design of instruments. This external module was historically used to give users the most flexibility over the layout and appearance of their data entry forms.
REDCap now allows Field Embedding, HTML editing, and custom CSS classes natively. This module is not needed for new projects, but may be available in older projects in which it was previously enabled. New projects may submit a request for Shazam, but we highly recommend using REDCap's built-in features instead.
If you have any questions about using Shazam in an existing project or if you have questions about using CSS directly using the latest built-in REDCap features, please reach out to our support team.
Image Map
Image Map is an external module that allows you to replace standard data entry fields (like text boxes, radio buttons, or checkboxes) with an interactive, clickable image. Users can click specific regions on an image to select values, which is particularly useful for clinical assessments such as body pain maps, dental charts, or smiley-face pain scales.
There is a predetermined list of images available that can use the mapping. These require use of Image Map specific action tags and pre-defined multiple choice fields.
Enable a Module
If you have Project Design and Setup access in a project, then you can enable a module by selecting "Manage" in the left-side External Modules menu. There is an option to "Enable a module" on this page.
After selecting to add a new module a window will appear with a list of the available modules. Identify the module you need and select "Request Activation". This will send a notification to REDCap support that you would like a module to be enabled for your project. You will be notified once the request has been accepted or if support has additional questions about your use.
The EM management page also will include additional information, settings, and logging after an EM has been enabled.
New External Module Requests
If you have a request for an External Module that is not currently available, submit your request to the REDCap Support Team using our Support Portal.
Since modules have the potential to impact the entire REDCap platform, modules are reviewed on a case by case basis and added with caution. Factors such as system security, broad usability, support requirements, and quality of module are used in determining if a module can be added to the WISC REDCap system. Review may take several weeks to months to fully process.
It is not guaranteed that an external module request will be accepted.
If you plan to use a module that is not available, you must reach out to support for approval prior to submitting a research proposal that requires the new module.