dr01d3r / redcap-em-samples

A repository of tutorials and sample code for learning how to build REDCap External Modules, Plugins, and Hooks.

Templates and Guides for building External Modules within REDCap

Table of Contents

Hooks

• Basic Hook (link)
  • Displays HTML on standard REDCap pages
  • Simple module configuration
• Save Data Hook (link)
  • Takes action when record data is saved (data entry forms & surveys)

Plugins

• Basic Plugin (link)
  • Demonstrates some basic methods of pulling data from REDCap and displaying it on a plugin page
  • No module configuration
• Basic Framework Plugin (link)
  • Same idea as the previous plugin, but using the framework property
    • The "Framework" is a fairly new concept that was added to External Modules ~v9.0.0. See the official documentation here for more info.
• Advanced Plugin (link)
  • Goes beyond the basics, creating an infrastructure for providing complex solutions
    • Traits & Utility classes
    • CSS & JavaScript files
    • Bringing in external libraries through Composer
• Autoloader Plugin (link)
  • Focuses on a singular feature of Composer, psr-4, that makes class management easier in your module

Sept 2019 Curriculum

• Developer tools: Tools we use as a REDCap EM developers
• Common Gotchas
• EMs vs plugins vs hooks
• External Module Framework
• EMs from scratch
  • manually coding json
  • starting with the templater
• Repository of External Modules
• Notes from meeting:
  • Google Doc